API docs by Redocly

Telecrm Async APIs (1.0.0)

Download OpenAPI specification:

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.
Array of AsyncInputCustomAction (object) or InputPaymentAction (object) (AsyncInputLeadAction)

Request samples

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