Direct Profile Upload API

The Direct Profile Upload API provides synchronous upload of one or more profiles directly in the request body (up to 1,000 profiles per call).

Run in Postman

---

API Endpoint

POST /api/v3/profile/upload

Headers

Header	Value	Required
x-api-key	{{api_key}}	Yes
Content-Type	application/json	Yes

---

Request Syntax

POST /api/v3/profile/upload
x-api-key: {{api_key}}
Content-Type: application/json

{
  "profile": [
    {
      "phone": "917415908519",
      "countrycode": "IN",
      "name": "Aarav Sharma",
      "age": 29,
      "gender": "male",
      "dob": 27/03/2000,
      "businesssubscriberid": "CUST-98712",
      "city": "Mumbai"
    }
  ]
}

---

Response Syntax

200 OK Response (Success)

{
  "status": "success",
  "total": 1,
  "uploaded": 1,
  "rejected": 0
}

Response Fields

Field	Type	Description
status	string	Execution result ("success" or "success with errors").
total	integer	Total number of records submitted in the call.
uploaded	integer	Number of successfully processed/upserted profiles.
rejected	integer	Number of rejected records due to invalid data (e.g., invalid phone format).

---

Run in Postman