PUT /api/v2/custom_objects/{custom_object_key}/triggers/update_many
Updates the position or the active status of multiple object triggers. Any additional properties are ignored.
Note: You can only bulk-update triggers associated with one object at a time, specified by the custom_object_key
in the request.
Allowed For
- Administrators
- Agents in custom roles with the
manage_triggers
permission (Enterprise only)
Request Parameters
The PUT request expects a triggers
object that lists the object triggers to update. All of the specified object trigger ids
must be associated with a single object.
You can specify the following properties for each object trigger you're updating:
Name | Mandatory | Description |
---|---|---|
id | yes | The ID of the object trigger to update |
position | no | The new position of the object trigger |
active | no | The active status of the object trigger (true or false) |
Example Request
{
"triggers": [
{"id": 25, "position": 3},
{"id": 23, "active": true},
{"id": 27, "position": 9, "active": false},
{"id": 22, "position": 7}
]
}
Servers
- https://{subdomain}.{domain}.com
Path parameters
Name | Type | Required | Description |
---|---|---|---|
custom_object_key |
String | Yes |
The key of a custom object |
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 |
---|---|---|---|
triggers[] |
Array | No | |
triggers[].id |
Integer | Yes |
The id of the object trigger to update |
triggers[].active |
Boolean | No |
Whether an object trigger is active |
triggers[].position |
Integer | No |
The new position of the object trigger |
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.