Skip to main content
POST
/
v1
/
contacts
Create a contact
curl --request POST \
  --url https://api4.kinbox.com.br/v1/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "customFields": {},
  "name": "<string>",
  "avatar": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "origin": "<string>",
  "location": "<string>",
  "notes": "<string>",
  "isPrivate": true,
  "externalId": "<string>"
}
'
{
  "id": "<string>",
  "externalId": "<string>",
  "origin": "<string>",
  "location": "<string>",
  "facebookId": "<string>",
  "instagramId": "<string>",
  "telegramId": "<string>",
  "isImported": true,
  "hasConversation": true,
  "newContact": true,
  "customFields": {
    "cpf": {
      "value": "060.715.303-54"
    }
  },
  "crmData": {
    "utmCampaigns": {},
    "referrals": {
      "_bg": "<string>",
      "_bt": "<string>",
      "gclid": "<string>",
      "offer": "<string>",
      "utm_ad": "<string>",
      "utm_term": "<string>",
      "source_id": "<string>",
      "gad_source": "<string>",
      "media_type": "<string>",
      "source_url": "<string>",
      "utm_medium": "<string>",
      "utm_source": "<string>",
      "source_type": "<string>",
      "utm_ad_name": "<string>",
      "utm_campaign": "<string>",
      "utm_ad_collection": "<string>",
      "utm_campaign_name": "<string>",
      "utm_ad_collection_name": "<string>"
    },
    "hubspotId": "<string>",
    "zohoId": "<string>",
    "zohoType": "<string>",
    "cloud_api": {}
  },
  "name": "João Silva",
  "email": "joaosilva@gmail.com",
  "phone": "5585997281648",
  "avatar": "<string>",
  "notes": "<string>",
  "isPrivate": true
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
customFields
object
required
​
name
string

The contact’s full name or business name

​
avatar
string

Url of the contact image

​
email
string

The contact’s email address

​
phone
string

The contact’s phone number

​
origin
string
​
location
string
​
notes
string

The contact’s notes

​
isPrivate
boolean

Private contacts can only be seen by users who have the permission to view private contacts

​
externalId
string

An external id to integrate with external systems

Response

201 - application/json
​
id
string
required
​
externalId
string
required
​
origin
string
required
​
location
string
required
​
facebookId
string
required
​
instagramId
string
required
​
telegramId
string
required
​
isImported
boolean
required
​
hasConversation
boolean
required
​
newContact
boolean
required
​
customFields
object
required
Example:
{ "cpf": { "value": "060.715.303-54" } }
​
crmData
object
required
​
name
string

The contact’s full name or business name

Example:

"João Silva"

​
email
string

The contact’s email address

Example:

"joaosilva@gmail.com"

​
phone
string

The contact’s phone number

Example:

"5585997281648"

​
avatar
string

Url of the contact image

​
notes
string

The contact’s notes

​
isPrivate
boolean

Private contacts can only be seen by users who have the permission to view private contacts