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

Authorizations

x-api-key
string
header
required

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

Path Parameters

id
string
required

Task ID

Body

application/json

New status

The body is of type object.

Response

200
application/json

OK

The response is of type object.