Skip to main content
POST
/
v1
/
contacts
/
import
Import contacts from a file
curl --request POST \
  --url https://app.chatbotx.io/api/v1/contacts/import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fileId": "<string>",
  "inboxId": "<string>",
  "countryCode": "<string>",
  "phoneNumber": "<string>",
  "contactId": "<string>",
  "email": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "tagId": "<string>",
  "fieldMapping": [
    {
      "column": "<string>",
      "customFieldId": "<string>"
    }
  ]
}
'
"<unknown>"

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
fileId
string
required
Pattern: \d+
​
channel
enum<string>
required
Available options:
omnichannel,
webchat,
messenger,
whatsapp,
zalo,
smtp,
telegram,
instagram,
tiktok
​
inboxId
string
required
Pattern: \d+
​
countryCode
string
Pattern: ^\+\d{1,4}$
​
phoneNumber
string
Maximum string length: 255
​
contactId
string
Maximum string length: 255
​
email
string
Maximum string length: 255
​
firstName
string
Maximum string length: 255
​
lastName
string
Maximum string length: 255
​
tagId
string
Pattern: \d+
​
fieldMapping
object[]
Maximum array length: 10

Response

201 - application/json

OK

The response is of type any.