Skip to content

Async API Overview ​

The Async API is a single-purpose interface for ingesting leads at high volume. "Async" describes its role — a lightweight ingestion endpoint for sources that don't drive a decision flow — not the response: the call completes the create-or-update before replying, and tells you which of the two happened.

What it does not report is field-level detail. Individual fields and actions that fail validation are dropped silently, with no remarks array to inspect.

When to use the Async API ​

The Async API is the right choice for ingesting leads from sources where the response does not drive any decision flow:

  • Website and landing-page forms
  • Ad platform webhooks (Facebook, Google, LinkedIn)
  • Third-party integrations pushing leads into telecrm
  • Batch jobs and bulk uploads

For interactive flows that need confirmation of each operation — or for any read, search, or non-lead resource — use the Sync API instead.

Characteristics ​

  • Lead-level outcome, not field-level. The response reports Created / Updated / Error and the affected lead IDs. It does not report which fields were accepted.
  • Lead-only. The Async API exposes a single endpoint: create-or-update a lead. It cannot read, search, or operate on actions/team members/metadata directly.
  • Plain-text errors. Unlike the Sync API, failures come back as bare strings and use 403 rather than 401 for auth.
  • High throughput. 18,000 requests per hour per token.
  • Cost-efficient. Designed for bulk ingestion at the lowest cost per request.

Behavior ​

  • Leads are matched against the workspace's lead identifier. A matching lead is updated; otherwise a new lead is created.
  • Existing fields not present in the request are left unchanged on update.
  • Any actions in the request are appended to the lead's timeline in the order provided.
  • Field- and action-level validation failures are not surfaced to the caller. Misconfigured payloads can result in silently dropped fields or actions — see Pitfalls. Use the Sync API when you need per-field remarks.

Endpoint ​

MethodURL
POSThttps://next-api.telecrm.in/enterprise/{enterpriseId}/autoupdatelead

See Create or Update Lead for the full reference.

Authentication ​

Every request must include an Async-typed bearer token in the Authorization header. Sync tokens are rejected with 403 and the plain-text body NOT_AUTHORIZED. See Authentication.

Limits ​

  • Rate limit: 18,000 requests/hour per token. Exceeding the limit returns 429.
  • Token cap: maximum 3 Async tokens per workspace.