PATCH /2/tasks/{taskID}
Updates a task by its ID.
Servers
- https://data.{region}.algolia.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
taskID |
String | Yes |
Unique identifier of a task. |
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 |
|---|---|---|---|
subscriptionAction |
String | No |
Action to perform on the Algolia index. Possible values:
|
failureThreshold |
Integer | No |
Maximum accepted percentage of failures for a task run to finish successfully. |
input |
No |
Configuration of the task, depending on its type. |
|
enabled |
Boolean | No |
Whether the task is enabled. |
destinationID |
String | No |
Universally unique identifier (UUID) of a destination resource. |
notifications |
Object | No |
Notifications settings for a task. |
notifications.email |
Object | Yes | |
notifications.email.enabled |
Boolean | No |
Whether to send email notifications, note that this doesn't prevent the task from being blocked. |
cron |
String | No |
Cron expression for the task's schedule. |
policies |
Object | No |
Set of rules for a task. |
policies.criticalThreshold |
Integer | No |
The number of critical failures in a row before blocking the task and sending a notification. |
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.