curl -X PATCH https://restapi.fax.plus/v3/webhooks/{endpoint_id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-d '{
"url": "https://example.com/fax-webhooks",
"filter_types": ["fax_sent"],
"channels": null
}'
import requests
resp = requests.patch(
"https://restapi.fax.plus/v3/webhooks/{endpoint_id}",
headers={"Authorization": "Bearer {access-token}", "Content-Type": "application/json"},
json={"url": "https://example.com/fax-webhooks", "channels": None},
)
print(resp.status_code)
{}
{
"error": "bad_request",
"description": "Invalid phone number: not-a-number"
}
{
"error": "plan_not_eligible"
}
{
"error": "bad_request",
"description": "hook_not_found"
}
{
"error": "server_error",
"description": "server_error"
}
Webhooks
Update a webhook endpoint
Partially update a webhook endpoint. Omitted fields stay unchanged; channels: null clears number filters. (Permitted scopes: fax:all:edit, fax:webhook:edit)
PATCH
/
webhooks
/
{endpoint_id}
curl -X PATCH https://restapi.fax.plus/v3/webhooks/{endpoint_id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-d '{
"url": "https://example.com/fax-webhooks",
"filter_types": ["fax_sent"],
"channels": null
}'
import requests
resp = requests.patch(
"https://restapi.fax.plus/v3/webhooks/{endpoint_id}",
headers={"Authorization": "Bearer {access-token}", "Content-Type": "application/json"},
json={"url": "https://example.com/fax-webhooks", "channels": None},
)
print(resp.status_code)
{}
{
"error": "bad_request",
"description": "Invalid phone number: not-a-number"
}
{
"error": "plan_not_eligible"
}
{
"error": "bad_request",
"description": "hook_not_found"
}
{
"error": "server_error",
"description": "server_error"
}
Partial update. Omitted fields stay unchanged. Send
"channels": null to clear number filters.curl -X PATCH https://restapi.fax.plus/v3/webhooks/{endpoint_id} \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-d '{
"url": "https://example.com/fax-webhooks",
"filter_types": ["fax_sent"],
"channels": null
}'
import requests
resp = requests.patch(
"https://restapi.fax.plus/v3/webhooks/{endpoint_id}",
headers={"Authorization": "Bearer {access-token}", "Content-Type": "application/json"},
json={"url": "https://example.com/fax-webhooks", "channels": None},
)
print(resp.status_code)
{}
{
"error": "bad_request",
"description": "Invalid phone number: not-a-number"
}
{
"error": "plan_not_eligible"
}
{
"error": "bad_request",
"description": "hook_not_found"
}
{
"error": "server_error",
"description": "server_error"
}
Authorizations
oauth2personal_access_token
OAuth2 Authorization Grant
Path Parameters
Body
application/json
Partial webhook endpoint update. Omitted fields are unchanged. channels: null clears number filters.
Response
Endpoint was successfully updated. Body is an empty object.
The response is of type object.