SmsDeleteWebhook¶

DELETE sms/webhook

Deletes a webhook. Events that still arrive at that URL are answered with WEBHOOK_NOT_FOUND and ignored.

Remove the URL from the provider dashboard as well. A profile in WEBHOOK mode without a live webhook stops receiving delivery reports, and its messages sit in SENT until they expire.

Access Control¶

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

Request¶

RESTTCPSDK

DELETE request

DELETE https://{broker_domain}/sms/webhook?id=2
Authorization: <JWT_TOKEN>

{
  "command": "SmsDeleteWebhook",
  "extID": "1",
  "data": {
    "id": 2
  }
}

const res = await platform.SmsDeleteWebhook({
  id: 2
});

Request Data¶

Field	Type	Required	Description
`id`	int	Yes	Webhook id

Response Data¶

{
  "id": 2,
  "deleted": true,
  "message": "Webhook with ID 2 has been deleted"
}

Errors¶

Code	Error	Description
`404`	`NOT_FOUND`	Webhook not found in the brand