Disconnect a channel

DELETE

Disconnect one (address, type). sms_oneway, telegram and voice can be disconnected here. The others answer 409 disconnect_unavailable saying what to do instead: whatsapp, instagram, messenger and email can be switched off with .../deactivate (they stay connected); two-way sms comes with the address's number.

Authorization

Authorizationheaderrequired
Bearer YOUR_API_KEY. Create a key in the dashboard.

Path parameters

addressstringrequired
typestringrequired
A transport a message travels on.
One ofsmssms_onewaywhatsapptelegramemailinstagrammessengervoice

Responses

204Disconnected.

400Unknown `type`.

codestringrequired
messagestringrequired
detailsobject
Machine-readable context. Keys that mean the same thing everywhere: - errors: present on every 400 invalid_request for an invalid body or query parameter, [{path, message, ...}], path naming the field (["to"], ["contacts", 2, "recipient"], ["limit"]). - recommendation: one sentence saying what to do next. - dashboardUrl: the dashboard screen that fixes it. - connect: on 409 no_channel, the channels this project can connect to reach the recipient, each {type, request, note, available, dashboardUrl?}; request is the exact call (POST /v2/channels with its body, or POST /v2/numbers), or null for a channel connected from the dashboard (WhatsApp, Instagram, Messenger). available: false says why in note (one-way SMS closed until business verification is approved). - address / from: the address the error is about, under the name the request used for it.
1 properties
- errorsobject[]
  3 properties
  - pathobject[]required
  - messagestringrequired
  - codestring

401Unauthorized.

codestringrequired
messagestringrequired
detailsobject
Machine-readable context. Keys that mean the same thing everywhere: - errors: present on every 400 invalid_request for an invalid body or query parameter, [{path, message, ...}], path naming the field (["to"], ["contacts", 2, "recipient"], ["limit"]). - recommendation: one sentence saying what to do next. - dashboardUrl: the dashboard screen that fixes it. - connect: on 409 no_channel, the channels this project can connect to reach the recipient, each {type, request, note, available, dashboardUrl?}; request is the exact call (POST /v2/channels with its body, or POST /v2/numbers), or null for a channel connected from the dashboard (WhatsApp, Instagram, Messenger). available: false says why in note (one-way SMS closed until business verification is approved). - address / from: the address the error is about, under the name the request used for it.
1 properties
- errorsobject[]
  3 properties
  - pathobject[]required
  - messagestringrequired
  - codestring

404No channel of this project has the address, or it has no channel of this `type` (`details.types` lists what it has).

codestringrequired
messagestringrequired
detailsobject
Machine-readable context. Keys that mean the same thing everywhere: - errors: present on every 400 invalid_request for an invalid body or query parameter, [{path, message, ...}], path naming the field (["to"], ["contacts", 2, "recipient"], ["limit"]). - recommendation: one sentence saying what to do next. - dashboardUrl: the dashboard screen that fixes it. - connect: on 409 no_channel, the channels this project can connect to reach the recipient, each {type, request, note, available, dashboardUrl?}; request is the exact call (POST /v2/channels with its body, or POST /v2/numbers), or null for a channel connected from the dashboard (WhatsApp, Instagram, Messenger). available: false says why in note (one-way SMS closed until business verification is approved). - address / from: the address the error is about, under the name the request used for it.
1 properties
- errorsobject[]
  3 properties
  - pathobject[]required
  - messagestringrequired
  - codestring

409`disconnect_unavailable`, or `ambiguous_from` when two channel groups share the address for this type.

codestringrequired
messagestringrequired
detailsobject
Machine-readable context. Keys that mean the same thing everywhere: - errors: present on every 400 invalid_request for an invalid body or query parameter, [{path, message, ...}], path naming the field (["to"], ["contacts", 2, "recipient"], ["limit"]). - recommendation: one sentence saying what to do next. - dashboardUrl: the dashboard screen that fixes it. - connect: on 409 no_channel, the channels this project can connect to reach the recipient, each {type, request, note, available, dashboardUrl?}; request is the exact call (POST /v2/channels with its body, or POST /v2/numbers), or null for a channel connected from the dashboard (WhatsApp, Instagram, Messenger). available: false says why in note (one-way SMS closed until business verification is approved). - address / from: the address the error is about, under the name the request used for it.
1 properties
- errorsobject[]
  3 properties
  - pathobject[]required
  - messagestringrequired
  - codestring