POST
/
customerbase
/
v1
/
contacts
/
bulk
curl --request POST \
  --url https://api.customeros.ai/customerbase/v1/contacts/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-CUSTOMER-OS-API-KEY: <api-key>' \
  --data '[
  {
    "contactId": "<string>",
    "email": "<string>",
    "linkedinUrl": "<string>"
  }
]'
{
  "details": {
    "description": "<string>",
    "value": "<string>"
  },
  "requestId": "1234567890abcdef",
  "status": "success",
  "summary": {
    "failed": 123,
    "success": 123,
    "total": 123
  }
}

Authorizations

X-CUSTOMER-OS-API-KEY
string
header
required

Body

application/json · object[]
Array of contacts to create
contactId
string

Contact's unique identifier example: contact-123

email
string

Contact's email address example: john@example.com

linkedinUrl
string

Contact's LinkedIn profile URL example: https://linkedin.com/in/john-doe

Response

201
application/json
All contacts created successfully

Response structure for bulk operations with single error detail

details
object

Error details if any

requestId
string
Example:

"1234567890abcdef"

status
string

Status indicates the result of the operation ("success" or "error")

Example:

"success"

summary
object

Summary of the bulk operation