Tasks

Update task status

Changed on

Use when updating task status (e.g. marking complete or failed from a worker). Typically called by backend processors.

put/tasks/{id}/status

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/tasks/{id}/status
  • Auth
    API key in header x-api-key

Path parameters

idstring required

Task ID

Request body

task_status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'FAILED' required

Response

OK

messagestring

Changes

  • f8ecf435d25dRevision changes
    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status

  • 7d57386313c7Revision changes
    • breaking

      request property was restricted to a list of enum values

    • breaking

      the request property type changed from no type to string

    • info

      added the new COMPLETED enum value to the request property

    • info

      added the new FAILED enum value to the request property

    • info

      added the new PENDING enum value to the request property

    • info

      added the new PROCESSING enum value to the request property