Webhooks

Detach Webhook

Detach a webhook from one or more senders (phone numbers or RCS agent IDs) to stop receiving event notifications. <br>

The webhook itself is not deleted and remains available for use with other senders. Works regardless of webhook status. Supports bulk operations with up to 50 senders per request.

post/webhooks/detach

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/webhooks/detach
  • Auth: API key in header PINNACLE-API-KEY

Request body

webhookIdstring required

Webhook ID to detach (starts with wh_). Must be a webhook owned by your team.

sendersstring[] required

Array of senders to detach the webhook from. Can be phone numbers in E.164 format or RCS agent IDs.

Response

Successfully detached webhook from the specified senders. <br>

Senders that could not be found are returned in the failed array with error details.

webhookIdstring required

The webhook that was detached from the senders.

sendersstring[] required

Senders that were successfully detached (phone numbers in E.164 format or RCS agent IDs).

Changes

No recorded changes to this operation across all 1 revision of this API.