flow

Creates new flow

post/flows

Request

  • Base URL: https://headless.dataddo.com/customer-api/v1
  • URL: https://headless.dataddo.com/customer-api/v1/flows
  • Auth: none declared

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "charset": "utf8mb4"
}

Response

Creates new flow

external_idstring nullable

The id of the document in external systems. By setting external_id you can link document with external systems id.

is_lockedboolean

You may mark the document as locked to prevent accidental changes. When locked, the document cannot be modified or deleted.

flow_type'fetch' | 'write'
labelstring
customer_idstring
preceding_actions_policy'strict' | 'liberal'
fetch_public_idstring nullable
created_atinteger
updated_atinteger
fdr_allowedboolean
destination_idstring
streamboolean

Example response

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

Changes

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