List the channels that open leads

Lists every inbound channel the workspace has (each number, each email address, WhatsApp, SMS and web chat) with whether a new conversation on it opens a lead, and the source such a lead gets. Answers 403 desk.sales_off while Sales is switched off.

Requires: desk.admin scope, workspace owner or admin, Pro plan.

Authorization

bearerAuth

AuthorizationBearer <token>

A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.

In: header

Response

Example

{  "data": [    {      "kind": "billing",      "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37",      "label": "Amina Wanjiru",      "opens_leads": false,      "lead_source_id": "27abce66-467f-40f5-9726-6c93ba4b3e43"    }  ],  "next_cursor": {},  "has_more": false}

FieldTypeDescription

datarequiredobject[]

kindrequiredstringWhat kind it is.

idstring

labelrequiredstringA short name to recognise it by.

opens_leadsrequiredboolean

lead_source_idrequiredstring (uuid) | null

next_cursorrequiredany

has_morerequiredany

curl -X GET "https://api.sautidesk.com/v1/desk/lead-channels"

List the channels that open leads

AuthorizationCopy Anchor Link

Response

Authorization