POST
/
v3
/
contacts
curl --request POST \
  --url https://api4.kinbox.com.br/v3/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "_id": "<string>",
  "customFields": {},
  "name": "<string>",
  "email": "<string>",
  "externalId": "<string>",
  "origin": "<string>",
  "phone": "<string>",
  "location": "<string>",
  "avatar": "<string>",
  "facebookId": "<string>",
  "instagramId": "<string>",
  "telegramId": "<string>",
  "notes": "<string>",
  "isImported": true,
  "hasConversation": true,
  "newContact": true,
  "crmData": {},
  "CustomerCustomField": {},
  "isPrivate": true
}'
{
  "id": "<string>",
  "_id": "<string>",
  "customFields": {},
  "name": "<string>",
  "email": "<string>",
  "externalId": "<string>",
  "origin": "<string>",
  "phone": "<string>",
  "location": "<string>",
  "avatar": "<string>",
  "facebookId": "<string>",
  "instagramId": "<string>",
  "telegramId": "<string>",
  "notes": "<string>",
  "isImported": true,
  "hasConversation": true,
  "newContact": true,
  "crmData": {},
  "CustomerCustomField": {},
  "isPrivate": true,
  "workspaceId": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "lastUpdateAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

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

Body

application/json
_id
string
customFields
object
name
string
Maximum length: 128
email
string
Maximum length: 100
externalId
string
origin
string
phone
string
location
string
avatar
string
facebookId
string
instagramId
string
telegramId
string
notes
string
isImported
boolean
hasConversation
boolean
newContact
boolean
crmData
object
CustomerCustomField
object
isPrivate
boolean

Response

201 - application/json
id
string
required
workspaceId
number
required
createdAt
string
required
lastUpdateAt
string
required
_id
string
customFields
object
name
string
Maximum length: 128
email
string
Maximum length: 100
externalId
string
origin
string
phone
string
location
string
avatar
string
facebookId
string
instagramId
string
telegramId
string
notes
string
isImported
boolean
hasConversation
boolean
newContact
boolean
crmData
object
CustomerCustomField
object
isPrivate
boolean
updatedAt
string