PATCH /api/v2/users/{id}/togglednd
Toggle DND status on or off for the given user.
Added on Oct 14, 2021 for API v2.
Rate limit: 1200 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
The user's id. ('me' can be used if you are using a user level API key) |
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 |
|---|---|---|---|
do_not_disturb |
Boolean | Yes |
Determines if DND is ON or OFF. |
group_id |
Integer | No |
The ID of the group which the user's DND status will be updated for. |
group_type |
String | No |
The type of the group which the user's DND status will be updated for. 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.