Skip to main content
PATCH
/
v2
/
webhooks
/
{id}
curl --location --request PATCH 'https://api.audienceful.com/v2/webhooks/wYt3nKq8Zs4pLm9vRb2xJc' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <your-api-key>' \
--data-raw '{
    "events": ["person.created", "person.updated", "audience.member_added"],
    "is_active": true
}'

import requests

url = "https://api.audienceful.com/v2/webhooks/wYt3nKq8Zs4pLm9vRb2xJc"
headers = {
    "Content-Type": "application/json",
    "X-Api-Key": "<your-api-key>",
}
payload = {
    "events": ["person.created", "person.updated", "audience.member_added"],
    "is_active": True,
}

response = requests.patch(url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://api.audienceful.com/v2/webhooks/wYt3nKq8Zs4pLm9vRb2xJc", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    "X-Api-Key": "<your-api-key>",
  },
  body: JSON.stringify({
    "events": [
      "person.created",
      "person.updated",
      "audience.member_added"
    ],
    "is_active": true
  }),
});
const data = await response.json();
console.log(data);

{
  "id": "wYt3nKq8Zs4pLm9vRb2xJc",
  "url": "https://example.com/webhooks/audienceful",
  "events": ["person.created", "person.updated", "audience.member_added"],
  "is_active": true,
  "disabled_reason": null,
  "disabled_at": null,
  "consecutive_failures": 0,
  "created_at": "2026-07-04T12:00:00Z",
  "updated_at": "2026-07-04T13:15:00Z"
}
Requires the webhooks:write scope. Send only the fields you want to change.

​
Path parameters

​
id
string
required
The id of the webhook endpoint.

​
Body

​
url
string
A new HTTPS URL for deliveries.
​
events
array[string]
Replace the events this endpoint is subscribed to. Must be a non-empty list of valid event names.
​
is_active
boolean
Enable or disable the endpoint. Setting is_active: true on a disabled endpoint re-enables it and clears its failure state (disabled_reason, disabled_at, and consecutive_failures are reset).

​
Response

Returns the updated endpoint. The secret is not returned.
​
id
string
The webhook endpoint's unique id.
​
url
string
The HTTPS URL deliveries are POSTed to.
​
events
array[string]
The events this endpoint is subscribed to.
​
is_active
boolean
Whether the endpoint is currently active. A disabled endpoint receives no deliveries.
​
disabled_reason
string or null
Why the endpoint was disabled, if it is. One of manual, 410_gone, or too_many_failures. null when active.
​
disabled_at
string or null
The datetime (UTC) the endpoint was disabled, if it is.
​
consecutive_failures
number
The number of consecutive failed deliveries. Resets to 0 on a successful delivery or when the endpoint is re-enabled.
​
created_at
string
The datetime (UTC) the endpoint was created.
​
updated_at
string
The datetime (UTC) the endpoint was last updated.
curl --location --request PATCH 'https://api.audienceful.com/v2/webhooks/wYt3nKq8Zs4pLm9vRb2xJc' \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <your-api-key>' \
--data-raw '{
    "events": ["person.created", "person.updated", "audience.member_added"],
    "is_active": true
}'

import requests

url = "https://api.audienceful.com/v2/webhooks/wYt3nKq8Zs4pLm9vRb2xJc"
headers = {
    "Content-Type": "application/json",
    "X-Api-Key": "<your-api-key>",
}
payload = {
    "events": ["person.created", "person.updated", "audience.member_added"],
    "is_active": True,
}

response = requests.patch(url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://api.audienceful.com/v2/webhooks/wYt3nKq8Zs4pLm9vRb2xJc", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    "X-Api-Key": "<your-api-key>",
  },
  body: JSON.stringify({
    "events": [
      "person.created",
      "person.updated",
      "audience.member_added"
    ],
    "is_active": true
  }),
});
const data = await response.json();
console.log(data);

{
  "id": "wYt3nKq8Zs4pLm9vRb2xJc",
  "url": "https://example.com/webhooks/audienceful",
  "events": ["person.created", "person.updated", "audience.member_added"],
  "is_active": true,
  "disabled_reason": null,
  "disabled_at": null,
  "consecutive_failures": 0,
  "created_at": "2026-07-04T12:00:00Z",
  "updated_at": "2026-07-04T13:15:00Z"
}