Leads

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

Create a new lead for the specified organization

post

Creates a new lead with the provided details. The request must include either a valid bearer token or an x-org-api-key for authentication. The response will contain the details of the created lead.

Authorizations

bearer-keyx-org-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

Body

application/json

crm_idstringRequired

first_namestringRequired

last_namestringOptional

phone_numberstringRequired

opt_in_dateinteger · int64Optional

Responses

200

Successfully created lead

application/json

lead_idstringOptional

crm_idstringOptional

first_namestringOptional

last_namestringOptional

phone_numberstringOptional

opt_in_dateinteger · int64Optional

401

Unauthorized - Authentication is required

application/json

403

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

application/json

404

Org not found

application/json

422

Invalid request payload

application/json

429

Lead with this crm_id already exists

application/json

500

Failed to create lead

application/json

post/v4/orgs/{orgId}/leads

HTTPcURLJavaScriptPython

POST /v4/orgs/{orgId}/leads HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "crm_id": "text",
  "first_name": "text",
  "last_name": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "phone_number": "text",
  "opt_in_date": 1
}

{
  "lead_id": "text",
  "crm_id": "text",
  "first_name": "text",
  "last_name": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "phone_number": "text",
  "opt_in_date": 1
}

Assign a lead to a user

put

Assigns the specified lead to a user. The request must include either a valid bearer token or an x-org-api-key for authentication. The request body should contain either the ID or the email of the user to assign the lead to.

Authorizations

bearer-keyx-org-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

leadIdstringRequired

Saleschat-generated lead ID (UUID) or the lead's CRM ID — both are resolved.

Body

application/json

user_idstringOptional

user_emailstringOptional

Responses

202

Successfully assigned lead

No content

401

Unauthorized - Authentication is required

application/json

403

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

application/json

404

Org or lead not found

application/json

422

Invalid request payload

application/json

500

Failed to assign lead

application/json

put/v4/orgs/{orgId}/leads/{leadId}/assign

HTTPcURLJavaScriptPython

PUT /v4/orgs/{orgId}/leads/{leadId}/assign HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "user_id": "text",
  "user_email": "text"
}

No content

Add an event for a lead

put

Records a custom event for the specified lead. If the event type matches a known automation trigger it will be enqueued for processing. Uses distinct_id for idempotency — duplicate requests with the same distinct_id are silently accepted.

Authorizations

bearer-keyx-org-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

leadIdstringRequired

Saleschat-generated lead ID (UUID) or the lead's CRM ID — both are resolved.

Body

application/json

distinct_idstring · max: 36Optional

eventstring · max: 256Required

Responses

202

Event accepted

No content

401

Unauthorized - Authentication is required

application/json

403

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

application/json

404

Org or lead not found

application/json

422

Invalid request payload

application/json

500

Failed to process event

application/json

put/v4/orgs/{orgId}/leads/{leadId}/events

HTTPcURLJavaScriptPython

PUT /v4/orgs/{orgId}/leads/{leadId}/events HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "distinct_id": "text",
  "event": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

No content