Contact (Deprecated)

This page provides API documentation for creating a contact in Saleschat.pro, including the required parameters and sample responses for successful contact creation.

Contact APIs are being deprecated and Saleschat will stop supporting it from Sept 1st, 2026. Kindly use the Leads documentation.

Deprecated

Create a contact

post

• Roles Allowed: ADMIN

• Impersonated User Allowed: False

• Partner Allowed: True

• Error Codes : Error Message

• 4030001 : FORBIDDEN

• 4090001 : UQ_CONSTRAINT_FAILED

Authorizations

bearer-keyx-org-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

Body

application/json

crm_idstring · max: 128Required

opt_in_datestring · date-timeRequired

epoch in seconds

first_namestring · max: 128OptionalPattern: ^(?!.*\*).*$

last_namestring · max: 128OptionalPattern: ^(?!.*\*).*$

governance_level_idstring · max: 128Optional

is_inboundbooleanOptional

sourcestring · enumOptionalPossible values:

Responses

200

Successfully registered contact

application/json

idstringOptional

crm_idstringOptional

opt_in_datestring · date-timeOptional

epoch in seconds

create_datestring · date-timeOptional

epoch in seconds

first_namestringOptional

last_namestringOptional

is_expiredbooleanOptional

401

Unauthorized - Authentication is required

application/json

403

User or Partner is not allowed to create a contact

application/json

409

Conflicting entry in DB

application/json

422

Invalid format or bad input

application/json

500

Internal Exception

application/json

post/v2/org/{orgId}/contact

HTTPcURLJavaScriptPython

POST /v2/org/{orgId}/contact HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 192

{
  "crm_id": "text",
  "phone_number": "[phone]",
  "opt_in_date": "2026-07-13T02:48:02.641Z",
  "first_name": "text",
  "last_name": "text",
  "governance_level_id": "text",
  "is_inbound": true,
  "source": "BTRIX"
}

{
  "id": "text",
  "crm_id": "text",
  "opt_in_date": "2026-07-13T02:48:02.641Z",
  "create_date": "2026-07-13T02:48:02.641Z",
  "first_name": "text",
  "last_name": "text",
  "governance_level": {
    "id": "text",
    "name": "text"
  },
  "is_expired": true
}

Deprecated

Assign a contact to a user

post

• Roles Allowed: ADMIN

• Impersonated User Allowed: False

• Partner Allowed: True

• API will assign a contact to a user or a group from which the user can be selected. Only one of them is required, if both are provided, user_id will be used

• assign_on_handover is a boolean flag to indicate if the user should be assigned to the chatroom after the lead has responded

Authorizations

bearer-keyx-org-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

contactIdstringRequired

Body

application/json

user_idstringOptional

group_idstringOptional

remote_waba_idstringOptional

remote_phone_idstringOptional

assign_on_handoverbooleanOptional

Responses

202

User will be assigned to the room

No content

401

Unauthorized - Authentication is required

application/json

403

Cannot make this request

application/json

404

User / Group not found

application/json

422

Required fields are missing or invalid values are provided

application/json

429

Rate limit exceeded. Allows 1 request per 10 seconds per contact

application/json

500

Internal Exception

application/json

post/v3/orgs/{orgId}/contacts/{contactId}/assign

HTTPcURLJavaScriptPython

POST /v3/orgs/{orgId}/contacts/{contactId}/assign HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "user_id": "text",
  "group_id": "text",
  "remote_waba_id": "text",
  "remote_phone_id": "text",
  "assign_on_handover": true
}

No content

Deprecated

Update a contact

put

• Roles Allowed: ADMIN

• Impersonated User Allowed: FALSE

• Partner Allowed: TRUE

• Update contact crmID, first name, last name and chatroom name will be automatically updated

Authorizations

bearer-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

contactIdstringRequired

Body

application/json

crm_idstring · max: 128Required

first_namestring · max: 128OptionalPattern: ^(?!.*\*).*$

last_namestring · max: 128OptionalPattern: ^(?!.*\*).*$

Responses

200

Successfully updated contact

application/json

idstringOptional

crm_idstringOptional

opt_in_datestring · date-timeOptional

epoch in seconds

create_datestring · date-timeOptional

epoch in seconds

first_namestringOptional

last_namestringOptional

is_expiredbooleanOptional

400

Bad request

application/json

401

Unauthorized - Authentication is required

application/json

403

User does not belong to org

application/json

404

Contact not found

application/json

422

Required fields are missing or invalid values are provided

application/json

500

Failed to update contact due to internal error

application/json

put/v1/orgs/{orgId}/contact/{contactId}

HTTPcURLJavaScriptPython

PUT /v1/orgs/{orgId}/contact/{contactId} HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "crm_id": "text",
  "first_name": "text",
  "last_name": "text"
}

{
  "id": "text",
  "crm_id": "text",
  "opt_in_date": "2026-07-13T02:48:02.641Z",
  "create_date": "2026-07-13T02:48:02.641Z",
  "first_name": "text",
  "last_name": "text",
  "governance_level": {
    "id": "text",
    "name": "text"
  },
  "is_expired": true
}

Deprecated

Update disposition & stage for a contact

put

• Roles Allowed: ADMIN

• Impersonated User Allowed: True

• Partner Allowed: TRUE

Authorizations

bearer-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

contactIdstringRequired

Body

application/json

stagestringRequired

dispositionstringOptional

Responses

200

Successfully updated contact disposition

application/json

stringOptional

400

Bad request

application/json

401

Unauthorized - Authentication is required

application/json

403

User does not belong to org

application/json

404

Contact not found

application/json

422

Required fields are missing or invalid values are provided

application/json

500

Failed to add contact disposition due to internal error

application/json

put/v2/orgs/{orgId}/contact/{contactId}/disposition

HTTPcURLJavaScriptPython

PUT /v2/orgs/{orgId}/contact/{contactId}/disposition HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 95

{
  "additionalAttributes": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "stage": "text",
  "disposition": "text"
}

text

Get Contact by Phone Number

get

• Roles Allowed: MEMBER

• Impersonated User Allowed: True

• Partner Allowed: True

• PhoneNumber should be in E164 format

• The result will contain all contacts for a given pn.

Authorizations

bearer-keyx-org-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

phoneNumberstringRequired

e164 format

Example: [phone]

Responses

200

Successfully responding with list of all contacts for a pn

application/json

idstringOptional

crm_idstringOptional

opt_in_datestring · date-timeOptional

epoch in seconds

create_datestring · date-timeOptional

epoch in seconds

first_namestringOptional

last_namestringOptional

is_expiredbooleanOptional

expiry_tsstring · date-timeOptional

401

Unauthorized - Authentication is required

application/json

403

Forbidden - You don't have permission to access this resource

application/json

422

Phone Number not in the correct format or required fields are missing or invalid values are provided

application/json

500

Internal Server Error - Something went wrong on the server

application/json

get/v2/org/{orgId}/contact/pn/{phoneNumber}

HTTPcURLJavaScriptPython

GET /v2/org/{orgId}/contact/pn/{phoneNumber} HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "crm_id": "text",
    "opt_in_date": "2026-07-13T02:48:02.641Z",
    "create_date": "2026-07-13T02:48:02.641Z",
    "first_name": "text",
    "last_name": "text",
    "is_expired": true,
    "expiry_ts": "2026-07-13T02:48:02.641Z"
  }
]