PATCH /api/v2/subscriptions/contact/{id}

Updates a contact event subscription by id.

Added on April 23rd, 2021 for API v2.

NOTE: See https://developers.dialpad.com/v1.0-archive/reference for APIs that can operate on subscriptions that were created via the deprecated APIs.

Requires a company admin API key.

Rate limit: 1200 per minute.

Servers

Path parameters

Name Type Required Description
id Integer Yes

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

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
contact_type String Yes

The contact type this event subscription subscribes to.

Possible values:

  • "local"
  • "shared"
endpoint_id Integer No

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.

enabled Boolean No

Whether or not the contact event subscription is enabled.

Default value: true

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.