Fully update a task

curl --request PUT \ --url https://data.us.algolia.com/2/tasks/6c02aeb1-775e-418e-870b-1faccd4b2c0f \ --header 'accept: application/json' \ --header 'content-type: application/json' \ --header 'x-algolia-api-key: ALGOLIA_API_KEY' \ --header 'x-algolia-application-id: ALGOLIA_APPLICATION_ID' \ --data ' { "destinationID": "6c02aeb1-775e-418e-870b-1faccd4b2c0f", "action": "replace", "subscriptionAction": "replace", "cron": "* * 1 * *", "enabled": true, "failureThreshold": 0, "input": { "mapping": { "format": "mappingkit/v1", "actions": [ { "id": "lorem", "enabled": true, "trigger": "lorem", "fieldDirectives": [ { "fieldKey": "lorem", "value": {} } ] } ] } }, "cursor": "lorem", "notifications": { "email": { "enabled": true } }, "policies": { "criticalThreshold": 1 } } '

Authorizations

x-algolia-application-id

string

header

required

Your Algolia application ID.

x-algolia-api-key

string

header

required

Your Algolia API key with the necessary permissions to make the request. Permissions are controlled through access control lists (ACL) and access restrictions. The required ACL to make a request is listed in each endpoint's reference.

Path Parameters

taskID

string

required

Unique identifier of a task. Universally unique identifier (UUID) of a task.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

Body

application/json

API request body for updating a task.

action

enum<string>

required

Action to perform on the Algolia index.

Available options:

replace,

save,

partial,

partialNoCreate,

append

destinationID

string

required

Universally unique identifier (UUID) of a destination resource.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

cron

string

Cron expression for the task's schedule.

Example:

"* * 1 * *"

cursor

string

Date and time when the last cursor was created, in RFC 3339 format.

enabled

boolean

Whether the task is enabled.

failureThreshold

integer

Maximum accepted percentage of failures for a task run to finish successfully.

Required range: 0 <= x <= 100

input

Streaming input · object

Configuration of the task, depending on its type.

Streaming input
Docker streams
Shopify input

Show child attributes

notifications

object

Notifications settings for a task.

Show child attributes

policies

object

Set of rules for a task.

Show child attributes

subscriptionAction

enum<string>

Action to perform on the Algolia index.

Available options:

replace,

save,

partial,

partialNoCreate,

append

Response

API response for updating a task.

taskID

string

required

Universally unique identifier (UUID) of a task.

Example:

"6c02aeb1-775e-418e-870b-1faccd4b2c0f"

updatedAt

string

required

Date and time when the resource was last updated, in RFC 3339 format.