Skip to main content
POST
/
contacts
/
create-bulk
Create multiple contacts
curl --request POST \
  --url https://api.cleartalk.ai/contacts/create-bulk \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "listName": "<string>",
  "tag": "<string>",
  "data": [
    {
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "date_of_birth": "<string>",
      "contact_source": "<string>",
      "clear_talk_notes": "<string>",
      "disposition": "<string>",
      "custom_field": {}
    }
  ]
}
'
{
  "id": 123,
  "userId": 123,
  "listName": "<string>",
  "tag": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "dateOfBirth": "<string>",
  "contactSource": "<string>",
  "clearTalkNotes": "<string>",
  "customField": {},
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

API Key for authentication

Body

application/json
listName
string
required

List name for the contacts

tag
string
required

Tag for the contacts

data
object[]
required

Array of contact data

Response

201 - application/json

Contacts created successfully

id
number
required

Contact ID

userId
number
required

User ID

listName
string
required

List name for the contact

tag
string
required

Tag for the contact

firstName
string
required

First name of the contact

lastName
string
required

Last name of the contact

email
string
required

Email of the contact

phone
string
required

Phone number of the contact

dateOfBirth
string
required

Date of birth of the contact

contactSource
string
required

Source of the contact

clearTalkNotes
string
required

Notes for the contact

customField
object
required

Custom fields for the contact

createdAt
string<date-time>
required

Creation date

updatedAt
string<date-time>
required

Last update date