API Reference

SMS Event -- Update

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

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.

Path Params
int64
required

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

Body Params
string | null
enum

The SMS direction this event subscription subscribes to.

Allowed:
boolean | null
Defaults to true

Whether or not the SMS 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
Defaults to false

Whether or not to trigger SMS events for SMS sent between two users from the same company.

boolean | null
Defaults to false

Whether or not to update on each SMS delivery status.

int64 | null

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

string | null
enum

The target's type.

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