API Reference

Fax Event -- Update

patch
https://dialpad.com/api/v2/subscriptions/fax/

Updates a fax event subscription by id.

Added on Jan 12th, 2024 for API v2.

Requires scope: fax_message

Rate limit: 1200 per minute.

Path Params
int64
required

The event subscription's ID, which is generated after creating an event subscription successfully.

Body Params
string | null
enum

The fax direction this event subscription subscribes to.

Allowed:
boolean | null

Whether or not the fax event subscription is enabled.

int64 | null

The logging endpoint's ID, which is generated after creating a webhook or websocket successfully. If you plan to pair this event subscription with another logging endpoint, please provide a valid webhook ID here.

boolean | null

Whether or not to update on each fax message status.

int64 | null

The ID of the specific target for which events should be sent.

string | null
enum

The target's type.

Allowed:
Response

Updated 5 months ago

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago