FAfax
Webhooks

Update a webhook endpoint

Changed on

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}

Request

  • Base URL
    https://restapi.fax.plus/v3
  • URL
    https://restapi.fax.plus/v3/webhooks/{endpoint_id}
  • Auth
    • OAuth 2
      Authorization code: https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all
      Token URL: https://accounts.fax.plus/token scopes: all
    • or HTTP bearer

Path parameters

endpoint_idstring required

Request body

urlstring
filter_typesWebhookFilterType[] nullable
channelsstring[] nullable
descriptionstring
disabledboolean
throttle_rateinteger nullable

Response

Endpoint was successfully updated. Body is an empty object.

object required

Changes