SmsDeleteProfile

DELETE sms/providerProfile

Soft-deletes a provider profile and takes it out of routing. Message history keeps pointing at it.

The deletion is refused while the profile still has unsent messages: dropping it would leave them with no way out of the queue.

Access Control

Allowed role: admin, within the brand of the caller.

Request

RESTTCPSDK

DELETE request

DELETE https://{broker_domain}/sms/providerProfile?id=3
Authorization: <JWT_TOKEN>

{
  "command": "SmsDeleteProfile",
  "extID": "1",
  "data": {
    "id": 3
  }
}

const res = await platform.SmsDeleteProfile({
  id: 3
});

Request Data

Field	Type	Required	Description
id	int	Yes	Profile id

Response Data

{
  "id": 3,
  "deleted": true,
  "message": "Profile with ID 3 has been deleted"
}

Errors

Code	Error	Description
404	NOT_FOUND	Profile not found in the brand
409	PROFILE_IN_USE	The profile still has messages in the queue