Skip to main content

Update Sms Channel Status

PUT 

/api/channels/:channel_id/sms-status

Enable or disable an SMS channel.

This endpoint enables or disables the messaging profile for an SMS channel, which controls whether the channel can send/receive SMS messages.

Only works for SMS channels. For other channel types, use the regular PUT /api/channels/{channel_id} endpoint to update status.

Sample API Call:

PUT /api/channels/123e4567-e89b-12d3-a456-426614174000/sms-status
Content-Type: application/json

{
"enabled": true
}

Sample Response:

{
"success": true,
"channel_id": "123e4567-e89b-12d3-a456-426614174000",
"channel_status": "available",
"sms_status": "enabled",
"messaging_profile_id": "msg_profile_123"
}

Request

Responses

Successful Response