---
title: "Issue a URL to link a subscriber chat identity"
method: POST
path: "/v1/integrations/channel-endpoints/link"
tags: ["Integrations"]
---

# Issue a URL to link a subscriber chat identity

`POST /v1/integrations/channel-endpoints/link`

## Request

- Base URL: `https://api.notifly.io`
- URL: `https://api.notifly.io/v1/integrations/channel-endpoints/link`
- Auth: API key in header `Authorization`

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.

## Request body

- LinkChannelEndpointRequestDto
  - `integrationIdentifier` string, required: Integration identifier for the chat provider integration
  - `subscriberId` string, required: External subscriber identifier to link to their chat identity
  - `context` object
  - `contextHash` string: HMAC-SHA256 of the canonicalized `context`, signed with the tenant environment secret key (the same "Inbox with context" signing scheme). Required when the integration has HMAC validation enabled.

## Response `200`

OK

- object
  - `data` LinkChannelEndpointResponseDto
    - `url` string, required: URL the subscriber opens to link their chat identity (OAuth URL or deep link)
    - `providerMetadata` object: Provider-specific metadata returned alongside the link URL

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `405`: Method Not Allowed
- `409`: Conflict
- `413`: Payload Too Large
- `414`: URI Too Long
- `415`: Unsupported Media Type
- `422`: Unprocessable Entity
- `429`: The client has sent too many requests in a given amount of time.
- `500`: Internal Server Error
- `503`: The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay.

---

[API](https://skmtc.dev/notifly/apis/notifly-api.md) · [All operations](https://skmtc.dev/notifly/apis/notifly-api/llms.txt) · [OpenAPI document](https://skmtc.dev/notifly/apis/notifly-api/revisions/af909b9e1e57?raw)