Bulk Profile Upload API
The Bulk Profile Upload API provides asynchronous import of large profile datasets from a presigned URL — designed for high-volume datasets beyond what fits in a single direct upload call.
API Endpoint
POST /api/v3/profile/bulkupload
Headers
| Header | Value | Required |
|---|---|---|
x-api-key | {{api_key}} | Yes |
Content-Type | application/json | Yes |
Request Syntax
POST /api/v3/profile/bulkupload
x-api-key: {{api_key}}
Content-Type: application/json
{
"url": "https://your-bucket.s3.ap-south-1.amazonaws.com/exports/customers-2026-09-15.json?X-Amz-Signature=..."
}
Request Parameters
| Property | Type | Required | Description |
|---|---|---|---|
url | string | Yes | Public or presigned S3/storage HTTPS URL containing the JSON export file. |
Response Syntax
200 OK Response (Initiated)
{
"status": "success",
"message": "bulk upload initiated successfully",
"transactionId": "8f3b2a19-c6e2-4114-b620-302ef39d23ab"
}
Response Fields
| Field | Type | Description |
|---|---|---|
status | string | "success" confirming that the bulk import job was successfully queued. |
message | string | Confirmation message. |
transactionId | string | Unique tracking ID for the background worker task. |