PUT
/
transform
/
v1
/
workflows
/
{id}
curl --request PUT \
  --url https://api.invopop.com/transform/v1/workflows/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "country": "ES",
  "description": "<string>",
  "name": "<string>",
  "schema": "bill/invoice",
  "steps": [
    {
      "config": "<any>",
      "id": "186522a6-e697-4e34-8498-eee961bcb845",
      "name": "<string>",
      "next": [
        {
          "status": "OK",
          "step_id": "186522a6-e697-4e34-8498-eee961bcb845",
          "stop": true
        }
      ],
      "notes": "<string>",
      "provider": "provider"
    }
  ]
}'
{
  "country": "<string>",
  "created_at": "<string>",
  "description": "<string>",
  "disabled": true,
  "id": "186522a6-e697-4e34-8498-eee961bcb845",
  "name": "<string>",
  "schema": "<string>",
  "steps": [
    {
      "config": "<any>",
      "id": "186522a6-e697-4e34-8498-eee961bcb845",
      "name": "<string>",
      "next": [
        {
          "status": "OK",
          "step_id": "186522a6-e697-4e34-8498-eee961bcb845",
          "stop": true
        }
      ],
      "notes": "<string>",
      "provider": "provider"
    }
  ],
  "updated_at": "<string>",
  "version": "<string>"
}

Path Parameters

id
string
required

The UUID (any version) of the workflow to create.

Query Parameters

name
string

Name of the workflow.

description
string

Description of the workflow.

schema
string

Short schema name that the workflow will be allowed to process.

country
string

ISO country code the workflow will be used in.

steps
object[]

Array of Steps to use for this workflow.

Body

country
string

ISO country code the workflow will be used in.

description
string

Description of the workflow.

name
string

Name of the workflow.

schema
string

Short schema name that the workflow will be allowed to process.

steps
object[] | null

Array of Steps to use for this workflow.

Response

200 - application/json
country
string

ISO country code the workflow will be used for.

created_at
string

When the workflow was created.

description
string

Description of the workflow

disabled
boolean

When true, this workflow can no longer be used.

id
string

The UUID (any version) of the workflow.

name
string

Name of the workflow

schema
string

Short schema name that the workflow will be allowed to process.

steps
object[] | null

List of steps to execute

updated_at
string

When the workflow was last updated.

version
string

Version of the workflow's contents currently defined.

Fetch all workflowsFetch a workflow