Skip to main content
POST
/
v1
/
contacts
Create a contact
curl --request POST \
  --url https://app.chatbotx.io/api/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "phoneNumber": "<string>",
  "email": "<unknown>",
  "firstName": "<string>",
  "lastName": "<string>"
}
'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "avatar": "<string>",
  "phoneNumber": "<string>",
  "email": "<string>",
  "emailVerified": true,
  "emailOptIn": true,
  "firstName": "<string>",
  "lastName": "<string>",
  "fullName": "<string>",
  "lastReadAt": "2023-11-07T05:31:56Z",
  "ref": "<string>",
  "country": "<string>",
  "state": "<string>",
  "city": "<string>",
  "location": "<string>",
  "locale": "<string>",
  "timezone": "<string>",
  "subscribedAt": "2023-11-07T05:31:56Z",
  "broadcastSubscribedAt": "2023-11-07T05:31:56Z",
  "blockedAt": "2023-11-07T05:31:56Z",
  "workspaceId": "<string>",
  "contactCustomFields": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "value": "<string>",
      "contactId": "<string>",
      "customFieldId": "<string>"
    }
  ],
  "tags": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "deletedAt": "2023-11-07T05:31:56Z",
      "folderId": "<string>",
      "workspaceId": "<string>"
    }
  ],
  "contactNotes": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "text": "<string>",
      "contactId": "<string>",
      "createdById": "<string>"
    }
  ],
  "contactInboxes": [
    {
      "id": "<string>",
      "contactId": "<string>",
      "inboxId": "<string>",
      "channel": "<string>",
      "inbox": {
        "id": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "name": "<string>",
        "channel": "<string>",
        "sourceId": "<string>",
        "workspaceId": "<string>",
        "status": "<string>"
      }
    }
  ],
  "conversation": {
    "id": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "botEnabled": true,
    "botResumeAt": "2023-11-07T05:31:56Z",
    "archivedAt": "2023-11-07T05:31:56Z",
    "additionalAttributes": "<string>",
    "contactLastReadAt": "2023-11-07T05:31:56Z",
    "agentLastReadAt": "2023-11-07T05:31:56Z",
    "lastActivityAt": "2023-11-07T05:31:56Z",
    "followed": true,
    "workspaceId": "<string>",
    "contactId": "<string>",
    "adminRepliedAt": "2023-11-07T05:31:56Z",
    "contactRepliedAt": "2023-11-07T05:31:56Z",
    "aiContextLastMessageId": null,
    "assignedUserId": null,
    "assignedInboxTeamId": null,
    "assignedUser": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "email": "<string>",
      "emailVerified": true,
      "image": "<string>",
      "isAnonymous": true
    },
    "assignedInboxTeam": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "workspaceId": "<string>",
      "name": "<string>"
    },
    "inbox": {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "channel": "<string>",
      "sourceId": "<string>",
      "workspaceId": "<string>",
      "status": "<string>"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
phoneNumber
string
required
Required string length: 10 - 20
Pattern: \+?\d{10,20}
​
email
required
​
gender
enum<string>
required
Available options:
male,
female,
unknown
​
firstName
string
Maximum string length: 100
​
lastName
string
Maximum string length: 100

Response

200 - application/json

OK

​
id
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
avatar
string | null
required
​
phoneNumber
string | null
required
​
email
string | null
required
​
emailVerified
boolean
required
​
emailOptIn
boolean
required
​
firstName
string | null
required
​
lastName
string | null
required
​
fullName
string | null
required
​
gender
enum<string> | null
required
Available options:
male,
female,
unknown
​
lastReadAt
string<date-time> | null
required
​
ref
string | null
required
​
country
string | null
required
​
state
string | null
required
​
city
string | null
required
​
location
required
​
locale
string | null
required
​
timezone
string | null
required
​
subscribedAt
string<date-time> | null
required
​
broadcastSubscribedAt
string<date-time> | null
required
​
blockedAt
string<date-time> | null
required
​
workspaceId
string
required
​
contactCustomFields
object[]
​
tags
object[]
​
contactNotes
object[]
​
contactInboxes
object[]
​
conversation
object