Skip to main content
POST
/
tasks
Create a new task
curl --request POST \
  --url https://api.cloud.flexprice.io/v1/tasks \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "entity_type": "EVENTS",
  "file_name": "<string>",
  "file_type": "CSV",
  "file_url": "<string>",
  "metadata": {},
  "task_type": "IMPORT"
}'
{
  "completed_at": "<string>",
  "created_at": "<string>",
  "created_by": "<string>",
  "entity_type": "EVENTS",
  "environment_id": "<string>",
  "error_summary": "<string>",
  "failed_at": "<string>",
  "failed_records": 123,
  "file_name": "<string>",
  "file_type": "CSV",
  "file_url": "<string>",
  "id": "<string>",
  "metadata": {},
  "processed_records": 123,
  "scheduled_task_id": "<string>",
  "started_at": "<string>",
  "status": "published",
  "successful_records": 123,
  "task_status": "PENDING",
  "task_type": "IMPORT",
  "tenant_id": "<string>",
  "total_records": 123,
  "updated_at": "<string>",
  "updated_by": "<string>",
  "workflow_id": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Task configuration

​
entity_type
enum<string>
required
Available options:
EVENTS,
PRICES,
CUSTOMERS
​
file_type
enum<string>
required
Available options:
CSV,
JSON
​
file_url
string
required
​
task_type
enum<string>
required
Available options:
IMPORT,
EXPORT
​
file_name
string
​
metadata
object

Response

Accepted

​
completed_at
string
​
created_at
string
​
created_by
string
​
entity_type
enum<string>
Available options:
EVENTS,
PRICES,
CUSTOMERS
​
environment_id
string
​
error_summary
string
​
failed_at
string
​
failed_records
integer
​
file_name
string
​
file_type
enum<string>
Available options:
CSV,
JSON
​
file_url
string
​
id
string
​
metadata
object
​
processed_records
integer
​
scheduled_task_id
string
​
started_at
string
​
status
enum<string>
Available options:
published,
deleted,
archived
​
successful_records
integer
​
task_status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
​
task_type
enum<string>
Available options:
IMPORT,
EXPORT
​
tenant_id
string
​
total_records
integer
​
updated_at
string
​
updated_by
string
​
workflow_id
string