Enable or disable employee SMS
PATCHhttps://platform.docana.com/api/v1/employees/:id/channels/sms/
Requires employee write access. Enabling requires a published employee and routes SMS to its primary agent. New channels default to public access; isPublic=false limits access to application members with a matching phone number. Omit isPublic to preserve a saved choice. Enabling without a number provisions a paid US toll-free number on the Docana Twilio account and requires acknowledgeNumberPurchase=true; the number cannot send until Twilio approves its toll-free verification, which the returned verificationStatus tracks. Disabling pauses the channel without releasing its number.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 409
- 500
Updated channel state
Number purchase not acknowledged or invalid settings
The API key or session is missing, expired, or malformed.
No write access
A resource referenced by the path does not exist or is not visible to the caller.
Employee not published or setup already running
Unexpected server error.