Skip to main content
POST
Create Email Task

Authorizations

X-API-Key
string
header
required

API key authentication. Include your API key in the X-API-Key header as: X-API-Key YOUR_API_KEY

Example:

Authorization
string
header
required

JWT Bearer token authentication. Include your access token in the Authorization header as: Bearer YOUR_ACCESS_TOKEN

Example:

Body

application/json

Request to create an email task.

name
string
required

Task name

description
string | null

Task description

flow_id
string | null

Flow ID for deduplication

task_name
string | null

Task name for deduplication

Response

Successful Response

Response from email task creation.

email_address
string
required

Generated email address

name
string
required

Task name

task_id
string
required

Unique task identifier

description
string | null

Task description

status
string
default:active

Task status