POST /api/v2/accesscontrolpolicies/{id}/unassign
Unassigns one or all target groups associated with the user for an access control policy.
Requires a company admin API key.
Rate limit: 1200 per minute.
Servers
- https://dialpad.com/
- https://sandbox.dialpad.com/
Path parameters
Name | Type | Required | Description |
---|---|---|---|
id |
Integer | Yes |
The access control policy's id. |
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 |
---|---|---|---|
unassign_all |
Boolean | No |
Unassign all associated target groups from the user for a policy. Default value: false |
target_id |
Integer | No |
Required if the policy is associated with a target (Office or Contact Center). Not required for a company level policy or if unassign_all is True. |
target_type |
String | No |
Policy permissions applied at this target level. Defaults to company target type. Possible values:
Default value: "company" |
user_id |
Integer | Yes |
The user's id to be assigned to the policy. |
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.