flow

Updates the write action status

put/flows/{flowId}/write/status

Request

  • Base URL: https://headless.dataddo.com/customer-api/v1
  • URL: https://headless.dataddo.com/customer-api/v1/flows/{flowId}/write/status
  • Auth: none declared

Path parameters

flowIdstring required

Request body

status'live' | 'broken' | 'retrying' | 'running' | 'inactive' | 'cancelling' | 'cancelled'

Response

Updates the write action status

typestring
object_idstring
object_typestring
status'live' | 'broken' | 'retrying' | 'running' | 'inactive' | 'cancelling' | 'cancelled'
status_detailstring
last_executioninteger nullable

Last execution timestamp

next_executioninteger nullable

Next execution timestamp. Makes sense only for actions with schedule, otherwise it is null. It is computed and updated based on the schedule change or when action is executed.

error_countinteger

Error iteration count

is_being_processedboolean

Is the action currently being processed?

on_error_retry_timeoutinteger

After how many seconds the action should be retried after failure. the value 0 means run retry just after.

Example: set to 60602 to retry action not earlier than 2hrs after failure

scheduleobject nullable

Action Schedule settings

created_atinteger
updated_atinteger
durationstring nullable

Duration

write_mode'insert' | 'insert_ignore' | 'truncate_insert' | 'upsert' | 'update' | 'update_ignore' | 'delete' | 'cdc'
unique_columnsstring[]

Array of strings.

setup_instructionsstring

Example response

{
  "unique_columns": [
    "np1NErz7B4",
    "rPMOx7EOp9"
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.