PATCH /api/v2/subscriptions/sms/{id}
Updates a SMS event subscription by id.
Added on April 9th, 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.
Rate limit: 1200 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
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 |
|---|---|---|---|
direction |
String | No |
The SMS direction this event subscription subscribes to. Possible values:
|
include_internal |
Boolean | No |
Whether or not to trigger SMS events for SMS sent between two users from the same company. Default value: false |
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 SMS event subscription is enabled. Default value: true |
status |
Boolean | No |
Whether or not to update on each SMS delivery status. Default value: false |
target_id |
Integer | No |
The ID of the specific target for which events should be sent. |
target_type |
String | No |
The target's type. Possible values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- 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.
- Click Test request to test run your request to the API and see the API's response.