Sign in

v4

OpenAPI 3.0.0MIT2026-07-311494532.1 MB
Integrations

Issue a URL to link a subscriber chat identity

Returns a provider-specific URL the subscriber opens to link their chat identity. The integration provider is resolved from integrationIdentifier; Telegram returns a deep link.

post/v1/integrations/channel-endpoints/link

Headers

idempotency-keystring

A header for idempotency purposes

Request body

integrationIdentifierstring required

Integration identifier for the chat provider integration

subscriberIdstring required

External subscriber identifier to link to their chat identity

contextobject

Example request

{
  "integrationIdentifier": "telegram-bot",
  "subscriberId": "subscriber-123"
}

Response

OK

urlstring required

URL the subscriber opens to link their chat identity (OAuth URL or deep link)

providerMetadataobject

Provider-specific metadata returned alongside the link URL

Example response

{
  "url": "https://t.me/MyBot?start=AbCdEfGhIjKlMnOpQrStUvWxYz012345",
  "providerMetadata": {
    "botUsername": "MyBot",
    "expiresAt": "2026-06-23T12:00:00.000Z"
  }
}