PUT /api/v2/deletion_schedules/{deletion_schedule_id}
Updates a deletion schedule by its id.
Note: Updating a condition updates the conditions array, clearing all existing values of the array. Include all your conditions when updating any condition.
Allowed For
- Admins
Servers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
deletion_schedule_id |
Integer | Yes |
The id of the deletion schedule |
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 |
|---|---|---|---|
deletion_schedule |
Object | No | |
deletion_schedule.id |
Integer | No |
The id of the deletion schedule |
deletion_schedule.active |
Boolean | No |
Whether the deletion schedule is active |
deletion_schedule.description |
String | No |
The description of the deletion schedule |
deletion_schedule.default |
Boolean | No |
Whether the deletion schedule is the default |
deletion_schedule.url |
String | No |
Url for obtaining the deletion schedule JSON |
deletion_schedule.conditions |
Object | No |
An object that describes the conditions under which the automation will execute. See Conditions reference |
deletion_schedule.conditions.any[] |
Array | No |
Logical OR. Tickets may satisfy any of the conditions to be considered matching |
deletion_schedule.conditions.any[].field |
String | No |
The name of a ticket field |
deletion_schedule.conditions.any[].operator |
String | No |
A comparison operator |
deletion_schedule.conditions.any[].value |
String | No |
The value of a ticket field |
deletion_schedule.conditions.all[] |
Array | No |
Logical AND. Tickets must fulfill all of the conditions to be considered matching |
deletion_schedule.conditions.all[].field |
String | No |
The name of a ticket field |
deletion_schedule.conditions.all[].operator |
String | No |
A comparison operator |
deletion_schedule.conditions.all[].value |
String | No |
The value of a ticket field |
deletion_schedule.title |
String | No |
The title of the deletion schedule |
deletion_schedule.created_at |
String | No |
The time the deletion schedule was created |
deletion_schedule.updated_at |
String | No |
The time the deletion schedule was last updated |
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.