POST /api/v2/routing/agents/instance_values/job
Adds, replaces or removes multiple attributes for up to 100 agents.
Allowed For
- Admins
- Agents in custom role with permission to manage skills
Available Parameters
The request takes a data object with the following properties: | Name | Type | Required | Description | | ---------- | ------ | -------- | ------------------------------------------------------------------------------------------------- | | action | string | true | The action to perform on the attribute values. One of the following: "upsert", "update", "delete" | | attributes | object | true | The attribute values to update. See Attribute Values | | items | array | true | The list of agent ids |
Action can be one of the following:
- upsert: Adds new attribute values to the agents
- update: Replaces all the current attribute values of the agents with the new values
- delete: Removes specified attribute values from the agents
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 |
|---|---|---|---|
job |
Object | No | |
job.attributes |
Object | Yes |
The attribute values to update. See Attribute Values |
job.attributes.attribute_values[] |
Array | No | |
job.attributes.attribute_values[].id |
String | No |
Automatically assigned when an attribute value is created |
job.attributes.attribute_values[].name |
String | No |
The name of the attribute value |
job.attributes.attribute_values[].url |
String | No |
URL of the attribute value |
job.attributes.attribute_values[].attribute_id |
String | No |
Id of the associated attribute |
job.attributes.attribute_values[].created_at |
String | No |
When this record was created |
job.attributes.attribute_values[].updated_at |
String | No |
When this record was last updated |
job.action |
String | Yes |
The action to perform on the attribute values. One of the following: "upsert", "update", "delete" |
job.items[] |
Array | Yes |
The list of agent ids |
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.