POST /api/v2/users/{user_id}/group_memberships
Assigns an agent to a given group.
Allowed For
- Admins
- Agents assigned to a custom role with permissions to manage group memberships (Enterprise only)
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
user_id |
Integer | Yes |
The id of the user |
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 |
|---|---|---|---|
group_membership |
Object | Yes |
Group membership object. Note that user_id is derived from the URL path parameter and should not be included in the request body |
group_membership.default |
Boolean | No |
If true, tickets assigned directly to the agent will assume this membership's group |
group_membership.group_id |
Integer | Yes |
The id of a group |
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.