Campaigns

Change a webhook of a campaign

PATCH /api/v1/campaigns/{uid}/webhooks/{webhook_uid}

A field left out keeps its value. Switching on a webhook that was turned off after repeated failures gives it a fresh start.

Parameters
uid string required path
The campaign's uid.
webhook_uid string required path
The webhook's uid.
Request body application/x-www-form-urlencoded
type string
One of: open, click, unsubscribe, bounce, complaint.
endpoint string (uri)
is_active boolean
Responses
200 The webhook.
401 The token is missing or wrong (Unauthenticated.), or its user may not act on this object (Unauthorized). Without the Accept: application/json header, a missing or wrong token answers with a redirect to the sign-in page instead.
403 The campaign is not the token's.
404 No campaign has this uid, or it has no webhook with this uid.
422 A field is wrong. The first message, then every one.
Change a webhook of a campaign
1 2 3 4 5 6
curl -X PATCH 'https://your-domain/api/v1/campaigns/6adaabd2b4753/webhooks/6af7d91dd5d06' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  --data-urlencode 'type=click' \
  --data-urlencode 'endpoint=https://crm.example.com/hooks/click' \
  --data-urlencode 'is_active=1'
Response
{
    "uid": "6af7d91dd5d06",
    "type": "bounce",
    "endpoint": "https://crm.example.com/hooks/bounce",
    "secret": "3f1c9a0b7e2d4c6f8a1b3c5d7e9f0a2b",
    "is_active": true,
    "consecutive_failures": 0,
    "last_attempt_at": "2026-11-14T10:00:00+00:00",
    "last_status_code": 500,
    "last_error": "Server error",
    "created_at": "2026-11-10T08:00:00+00:00",
    "updated_at": "2026-11-14T10:05:00+00:00"
}