POST
/
tasks
/
batch-create
curl --request POST \
  --url https://api.mergent.co/v2/tasks/batch-create \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '[
  {
    "name": "4cf95241-fa19-47ef-8a67-71e483747649",
    "queue": "default",
    "request": {
      "url": "https://example.com",
      "headers": {
        "Authorization": "8BOHec9yUJMJ4sJFqUuC5w==",
        "Content-Type": "application/json"
      },
      "body": "Hello, world!"
    },
    "scheduled_for": "2021-10-01T15:53:05Z",
    "delay": "5m"
  }
]'
[
  {
    "id": "4cf95241-fa19-47ef-8a67-71e483747649",
    "name": "4cf95241-fa19-47ef-8a67-71e483747649",
    "queue": "default",
    "status": "queued",
    "request": {
      "url": "https://example.com",
      "headers": {
        "Authorization": "8BOHec9yUJMJ4sJFqUuC5w==",
        "Content-Type": "application/json"
      },
      "body": "Hello, world!"
    },
    "scheduled_for": "2021-10-01T15:53:05Z",
    "created_at": "2021-10-01T15:53:05Z"
  }
]

Authorizations

​
Authorization
string
header
required

The Mergent API uses API keys to authenticate requests. Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Body

application/json · object[]
​
name
string | null

The name of the task.

Example:

"4cf95241-fa19-47ef-8a67-71e483747649"

​
queue
string
default:default

The name of the of the task queue.

Example:

"default"

​
request
object

The params for creating or updating a task request.

​
scheduled_for
string | null

The ISO 8601 timestamp for when the task is scheduled to be executed.

Example:

"2021-10-01T15:53:05Z"

​
delay
string

A duration string containing numbers and a unit suffix of "s" for seconds, "m" for minutes, and "h" for hours. Examples: "5s"; "1.5h"; "2h45m" When both delay and scheduled_for are present, delay will be added to scheduled_for.

Example:

"5m"

Response

201
application/json
A list of tasks in sorted order, with the most recent tasks appearing first.
​
id
string
required

The unique ID for the task.

Example:

"4cf95241-fa19-47ef-8a67-71e483747649"

​
queue
string
default:default
required

The name of the of the task queue.

Example:

"default"

​
status
enum<string>
required

The status of the task. Additional statuses may be added over time.

Available options:
queued,
working,
success,
failure
Example:

"queued"

​
request
object
required

A task request.

​
created_at
string
required

The ISO 8601 timestamp representing when the task was created.

Example:

"2021-10-01T15:53:05Z"

​
name
string | null

The name of the task.

Example:

"4cf95241-fa19-47ef-8a67-71e483747649"

​
scheduled_for
string | null

The ISO 8601 timestamp for when the task is scheduled to be executed.

Example:

"2021-10-01T15:53:05Z"

Was this page helpful?