Skip to main content
POST
/
contacts
/
bulk
Bulk Create Contacts
curl --request POST \
  --url https://api.kejue.co/api/v1/contacts/bulk \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "contacts": [
    {
      "phone": "<string>",
      "whatsapp_number": "<string>",
      "email": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "company": "<string>",
      "job_title": "<string>",
      "country": "<string>",
      "timezone": "<string>",
      "language": "<string>",
      "tags": [
        "<string>"
      ],
      "metadata": {}
    }
  ],
  "skip_duplicates": true,
  "duplicate_field": "phone"
}
'
{
  "created": 123,
  "skipped": 123,
  "errors": [
    {
      "index": 123,
      "error": "<string>"
    }
  ]
}

Authorizations

X-API-Key
string
header
required

Workspace API key (e.g. kej_live_...)

Body

application/json

Bulk create contacts.

contacts
CreateContact · object[]
required

Contacts to create (max 1000)

Maximum array length: 1000
skip_duplicates
boolean
default:true

Skip contacts with duplicate phone numbers

duplicate_field
enum<string>
default:phone

Field to check for duplicates

Available options:
phone,
email,
whatsapp_number

Response

Successful Response

Bulk create result.

created
integer
required

Number of contacts successfully created

skipped
integer
required

Number of contacts skipped (duplicates)

errors
BulkImportError · object[]

Errors for contacts that failed