Scheduled Tasks

Trigger force run

Changed on

Use when you need to run a scheduled export immediately (e.g. on-demand report or catch-up). Supports optional custom time range.

post/tasks/scheduled/{id}/run

Request

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

Path parameters

idstring required

Scheduled Task ID

Request body

end_timestring date-time
start_timestring date-time

Response

Returns workflow details and time range

end_timestring date-time
messagestring
modestring

"custom" or "automatic"

start_timestring date-time
workflow_idstring

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

  • 646d6658479bRevision changes
    • breaking

      the request property format changed from no format to date-time

    • breaking

      the request property format changed from no format to date-time