Skip to main content
PATCH
Partial update. Omitted fields stay unchanged. Send "channels": null to clear number filters.

Authorizations

Authorization
string
header
required

OAuth2 Authorization Grant

Scopes

all
oauth2

for now when a user grants permission, all grants will be permitted

fax:all:edit
personal_access_token
fax:webhook:edit
personal_access_token

Path Parameters

endpoint_id
string
required

Body

application/json

Partial webhook endpoint update. Omitted fields are unchanged. channels: null clears number filters.

url
string
filter_types
enum<string>[] | null

Webhook event type for /webhooks endpoints

Available options:
fax_received,
fax_sent,
fax_page_received
channels
string[] | null

Fax number in E.164 format

description
string
disabled
boolean
throttle_rate
integer | null

Response

Endpoint was successfully updated. Body is an empty object.

The response is of type object.