API by router
Customer identities
GET
HTTPBearerheader
AuthorizationBearer <token>channel*ChannelChannel type
external_id*External IdExternal ID to look up
instance_id?|Optional instance scope
X-Api-Key?string|nullSuccessful Response
application/json- response
Response for reverse lookup: channel + external_id → customer.
channel*Channelcustomer_email?string|nullcustomer_id*Customer IdFormat
uuiddisplay_name?string|nullexternal_id*External Ididentity_id*Identity IdFormat
uuidrole_override?string|nullverified*Verifiedcurl -X GET 'https://example.com/v1/customers/lookup/identity?channel=string&external_id=string'Example Response
{ "channel": "string", "customer_email": "string", "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e", "display_name": "string", "external_id": "string", "identity_id": "011a42b9-62d7-49eb-8328-c2e454af88a1", "role_override": "string", "verified": true}GET
HTTPBearerheader
AuthorizationBearer <token>customer_id*Customer IdFormat
uuidchannel?|Filter by channel
X-Api-Key?string|nullSuccessful Response
application/json- response
[index: integer]?curl -X GET 'https://example.com/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/identities'Example Response
[ { "channel": "string", "created_at": "2019-08-24T14:15:22Z", "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e", "display_name": "string", "external_id": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "metadata": {}, "role_override": "string", "updated_at": "2019-08-24T14:15:22Z", "verified": true, "verified_at": "2019-08-24T14:15:22Z" }]POST
HTTPBearerheader
AuthorizationBearer <token>customer_id*Customer IdFormat
uuidX-Api-Key?string|nullapplication/json- body
channel*ChannelChannel type: telegram, whatsapp, slack, etc.
display_name?|nullexternal_id*External IdExternal ID (chat_id, phone, etc.)
Length
1 <= length <= 255instance_id?|Optional: scope to a specific instance
metadata?|nullrole_override?|Override channel default role: 'owner' for elevated access, null for default
Successful Response
application/json- response
channel*Channelcreated_at*Created AtFormat
date-timecustomer_id*Customer IdFormat
uuiddisplay_name?string|nullexternal_id*External Idid*IdFormat
uuidinstance_id?|nullmetadata?|nullrole_override?string|nullupdated_at*Updated AtFormat
date-timeverified*Verifiedverified_at?|nullcurl -X POST 'https://example.com/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/identities' \ -H 'Content-Type: application/json' \ -d '{ "channel": "string", "external_id": "string"}'Example Response
{ "channel": "string", "created_at": "2019-08-24T14:15:22Z", "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e", "display_name": "string", "external_id": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "metadata": {}, "role_override": "string", "updated_at": "2019-08-24T14:15:22Z", "verified": true, "verified_at": "2019-08-24T14:15:22Z"}PATCH
HTTPBearerheader
AuthorizationBearer <token>customer_id*Customer IdFormat
uuididentity_id*Identity IdFormat
uuidX-Api-Key?string|nullapplication/json- body
display_name?string|nullmetadata?|nullrole_override?string|nullverified?boolean|nullSuccessful Response
application/json- response
channel*Channelcreated_at*Created AtFormat
date-timecustomer_id*Customer IdFormat
uuiddisplay_name?string|nullexternal_id*External Idid*IdFormat
uuidinstance_id?|nullmetadata?|nullrole_override?string|nullupdated_at*Updated AtFormat
date-timeverified*Verifiedverified_at?|nullcurl -X PATCH 'https://example.com/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/identities/497f6eca-6276-4993-bfeb-53cbbbba6f08' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "channel": "string", "created_at": "2019-08-24T14:15:22Z", "customer_id": "160c0c4b-9966-4dc1-a916-8407eb10d74e", "display_name": "string", "external_id": "string", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "instance_id": "06587974-2dbe-4e10-8bf9-38cce0f5a366", "metadata": {}, "role_override": "string", "updated_at": "2019-08-24T14:15:22Z", "verified": true, "verified_at": "2019-08-24T14:15:22Z"}DELETE
HTTPBearerheader
AuthorizationBearer <token>customer_id*Customer IdFormat
uuididentity_id*Identity IdFormat
uuidX-Api-Key?string|nullSuccessful Response
curl -X DELETE 'https://example.com/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/identities/497f6eca-6276-4993-bfeb-53cbbbba6f08'Example Response
Empty
POST
HTTPBearerheader
AuthorizationBearer <token>customer_id*Customer IdFormat
uuididentity_id*Identity IdFormat
uuidX-Api-Key?string|nullSuccessful Response
application/json- response
Response when a claim code is generated for an identity.
code*Codeexpires_in_seconds?Expires In SecondsDefault
900identity_id*Identity IdFormat
uuidinstructions*Instructionscurl -X POST 'https://example.com/v1/customers/497f6eca-6276-4993-bfeb-53cbbbba6f08/identities/497f6eca-6276-4993-bfeb-53cbbbba6f08/claim-code'Example Response
{ "code": "string", "expires_in_seconds": 900, "identity_id": "011a42b9-62d7-49eb-8328-c2e454af88a1", "instructions": "string"}