POST /api/v2/group_memberships/create_many
Assigns up to 100 agents to given groups.
Allowed For
- Admins
- Agents assigned to a custom role with permissions to manage group memberships (Enterprise only)
Response
This endpoint returns a job_status JSON object and queues a background job to do the work. Use the Show Job Status endpoint to check for the job's completion.
Servers
- https://{subdomain}.{domain}.com
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_memberships[] |
Array | Yes |
An array of group membership objects to create. Maximum 100 items |
group_memberships[].default |
Boolean | No |
If true, tickets assigned directly to the agent will assume this membership's group |
group_memberships[].group_id |
Integer | Yes |
The id of a group |
group_memberships[].user_id |
Integer | Yes |
The id of an agent |
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.