GET /api/v2/company/{id}/smsoptout
Requires a company admin API key.
Rate limit: 250 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
ID of the requested company. This is required and must be specified in the URL path. The value must match the id from the company linked to the API key. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
opt_out_state |
String | Yes |
Required opt-out state to filter results by. Only results matching this state will be returned. Possible values:
|
a2p_campaign_id |
Integer | No |
Optional company A2P campaign entity id to filter results by. Note, if set, then the parameter 'opt_out_state' must be also set to the value 'opted_out'. |
cursor |
String | No |
Optional token used to return the next page of a previous request. Use the cursor provided in the previous response. |
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.