API docs by Redocly

Telecrm Async APIs (1.0.0)

The Telecrm Async API can be used to push lead data to Telecrm from any source. These are fire-and-forget operations suitable for high-volume.

Features:

  • Cost effective for bulk operations
  • 18,000 req/hour
  • No immediate response data

Leads are identified by their unique identifier field setup in the workspace (default: phone).

If a lead with the unique identifier field already exists, it is updated.

Authentication

All requests to the API must include an authentication token as a Bearer Token in the request headers. Follow the steps below to generate the token:

  1. Go to the Integration Page in Telecrm.
  2. Open Website/API Integration.
  3. Click on "Create new token"
  4. Enter a unique token name
  5. Select "Async"
  6. Once the token is created, click on "Copy Token" to copy the token to the clipboard. It is recommended to also download the token and keep it secure. Note: You are only allowed to create a maximum of 3 tokens

API Names

Find the API names of fields in the "Lead Fields" section of the Telecrm app:

  1. Click a field.
  2. Click the "Information" dropdown to view its API name.

Create/Update Lead

Use this API to create new leads or update existing ones.

Authorizations:
BearerAuth
path Parameters
enterpriseId
required
string

Id of the enterprise

Request Body schema: application/json
required

Autoupdate lead body

required
object (InputLeadFields)
  • One of the fields must be the unique identifier field (default: phone)
  • Only lead fields defined in the workspace will be processed.
name
string (TextField)

Text field with optional length constraints

phone
string (PhoneField)

Phone number with international country code (e.g. +91 for India). If country code is not specified, enterprise's default country code will be used.

email
string <email> (EmailField)

Valid email address

rating
integer (RatingField) [ 1 .. 5 ]

Rating value between 1 and 5

status
string (StatusField)

Lead status value. Must be one of the statuses defined in the workspace's lead stage pipeline. Defaults to 'Fresh'.

assignee
string <email> (EmailField)

Email address should be of an employee in the workspace

additional property
PhoneField (string) or EmailField (string) or RatingField (integer) or StatusField (string) or MoneyField (string) or Array of TagsField (strings) or TextField (string) or DateField (string) or DropdownField (string) or NumberField (number) or WebsiteField (string) or LostReasonField (string)
  • All those fields that are defined in the workspace. Defined as api name of the field, and it's corresponding valid value based on type.
Any of
string (PhoneField)

Phone number with international country code (e.g. +91 for India). If country code is not specified, enterprise's default country code will be used.

Array of CustomActionWithCreatedOn (object) or InputPaymentAction (object) (InputLeadAction)
Array
Any of
type
required
string

Custom action code defined in Workspace Settings -> Custom Actions

object
additional property
TextField (string) or DateField (string) or DropdownField (string) or NumberField (number) or ActiveUsersField (string) or MedialinkField (string)
  • All custom fields defined in the custom action. Defined as api name of the field, and its corresponding valid value based on type.
Any of
string (TextField)

Text field with optional length constraints

created_on
string <date-time> (CreatedOnField)

Unix timestamp or date-time in DD/MM/YYYY HH:mm:ss format. Time component defaults to 00:00:00 if omitted. Values in other formats may not be processed correctly.

If not specified, the current timestamp is set.

Field is ignored for non-predated actions.

Request samples

Content type
application/json
{
  • "fields": {
    },
  • "actions": [
    ]
}