PATCH
/
transform
/
v1
/
workflows
/
{id}
cURL
curl --request PATCH \
  --url https://api.invopop.com/transform/v1/workflows/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "description": "<string>",
  "draft": true,
  "name": "<string>",
  "rescue": [
    {
      "action": "email.send",
      "config": {},
      "id": "186522a6-e697-4e34-8498-eee961bcb845",
      "name": "<string>",
      "next": [
        {
          "code": "<string>",
          "status": "OK",
          "step_id": "186522a6-e697-4e34-8498-eee961bcb845",
          "steps": [
            {}
          ],
          "stop": true
        }
      ],
      "notes": "<string>",
      "summary": "<string>"
    }
  ],
  "steps": [
    {
      "action": "email.send",
      "config": {},
      "id": "186522a6-e697-4e34-8498-eee961bcb845",
      "name": "<string>",
      "next": [
        {
          "code": "<string>",
          "status": "OK",
          "step_id": "186522a6-e697-4e34-8498-eee961bcb845",
          "steps": [
            {}
          ],
          "stop": true
        }
      ],
      "notes": "<string>",
      "summary": "<string>"
    }
  ]
}'
{
  "country": "<string>",
  "created_at": "<string>",
  "description": "<string>",
  "disabled": true,
  "draft": true,
  "hash": "<string>",
  "id": "186522a6-e697-4e34-8498-eee961bcb845",
  "name": "<string>",
  "rescue": [
    {
      "action": "email.send",
      "config": {},
      "id": "186522a6-e697-4e34-8498-eee961bcb845",
      "name": "<string>",
      "next": [
        {
          "code": "<string>",
          "status": "OK",
          "step_id": "186522a6-e697-4e34-8498-eee961bcb845",
          "steps": [
            {}
          ],
          "stop": true
        }
      ],
      "notes": "<string>",
      "summary": "<string>"
    }
  ],
  "schema": "<string>",
  "steps": [
    {
      "action": "email.send",
      "config": {},
      "id": "186522a6-e697-4e34-8498-eee961bcb845",
      "name": "<string>",
      "next": [
        {
          "code": "<string>",
          "status": "OK",
          "step_id": "186522a6-e697-4e34-8498-eee961bcb845",
          "steps": [
            {}
          ],
          "stop": true
        }
      ],
      "notes": "<string>",
      "summary": "<string>"
    }
  ],
  "updated_at": "<string>",
  "version": "<string>",
  "versions": [
    {
      "created_at": "<string>",
      "hash": "<string>",
      "name": "<string>",
      "src": "<string>",
      "src_id": "<string>",
      "version": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Use the Bearer scheme with a valid JWT token to authenticate requests. Example: Authorization: Bearer <token>

Path Parameters

​
id
string
required

UUID of the workflow to update.

Example:

"186522a6-e697-4e34-8498-eee961bcb845"

Body

application/json
​
description
string

Updated description.

​
draft
boolean

When true, the current version of the workflow will not be published.

​
name
string

New name for the workflow.

​
rescue
Rescue · object[] | null

Array of steps to execute en case of an unmanaged KO.

​
steps
Steps · object[] | null

Array of Steps to use for this workflow.

Response

200 - application/json

OK

​
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.

​
draft
boolean

When true, this workflow is still in draft mode and will not be used in jobs.

​
hash
string

Partial SHA256 hash of the workflow's contents.

​
id
string

The UUID (any version) of the workflow.

Example:

"186522a6-e697-4e34-8498-eee961bcb845"

​
name
string

Name of the workflow

​
rescue
Rescue · object[] | null

List of steps to execute when a KO status is returned by a previous step and not explicitly managed.

​
schema
string

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

​
steps
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.

​
versions
Versions · object[]

List of previously published versions of this workflow, only provided when requesting the primary workflow.