v52

latestOpenAPI 3.0.1AGPL-3.0raw.githubusercontent.com2026-08-01255473862.7 KB
Tasks

Create a new task

Use when submitting a file or job for async processing (e.g. export or import). Returns task ID to poll for status and result.

post/tasks

Request body

entity_type'EVENTS' | 'PRICES' | 'CUSTOMERS' | 'FEATURES' required
file_namestring
file_type'CSV' | 'JSON' required
file_urlstring required
metadataobject
task_type'IMPORT' | 'EXPORT' required

Response

Accepted

completed_atstring date-time
created_atstring date-time
created_bystring
entity_type'EVENTS' | 'PRICES' | 'CUSTOMERS' | 'FEATURES'
environment_idstring
error_summarystring
failed_atstring date-time
failed_recordsinteger
file_namestring
file_type'CSV' | 'JSON'
file_urlstring
idstring
metadataobject
processed_recordsinteger
scheduled_task_idstring
started_atstring date-time
status'published' | 'deleted' | 'archived'
successful_recordsinteger
task_status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED'
task_type'IMPORT' | 'EXPORT'
tenant_idstring
total_recordsinteger
updated_atstring date-time
updated_bystring
workflow_idstring