Skip to main content
POST
/
v1
/
workflows
/
{workflow}
Atualizar workflow
curl --request POST \
  --url https://api.base39.io/v1/workflows/{workflow} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "status": "draft",
  "content": {
    "trigger": {
      "id": "<string>",
      "name": "<string>",
      "type": "webhook-base39",
      "parameters": {
        "enabled": true,
        "event": "loan.created"
      }
    },
    "actions": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "conditional",
        "parameters": {
          "conditions": [
            [
              "<string>"
            ]
          ],
          "default": "<string>"
        }
      }
    ],
    "subflows": {}
  }
}'
{
  "id": "<any>",
  "name": "<string>",
  "status": "draft",
  "content": {
    "trigger": {
      "id": "<string>",
      "name": "<string>",
      "type": "webhook-base39",
      "parameters": {
        "enabled": true,
        "event": "loan.created"
      }
    },
    "actions": [
      {
        "id": "<string>",
        "name": "<string>",
        "type": "conditional",
        "parameters": {
          "conditions": [
            [
              "<string>"
            ]
          ],
          "default": "<string>"
        }
      }
    ],
    "subflows": {}
  },
  "createdAt": "2023-08-25T22:38:41.134Z",
  "updatedAt": "2023-08-25T22:38:41.134Z",
  "deleted": false,
  "createdBy": {
    "clientId": "key_643969122d598f5b62d15fbc",
    "externalClientId": "optr_643969122d598f5b62d15fbd"
  },
  "updatedBy": {
    "clientId": "key_643969122d598f5b62d15fbc",
    "externalClientId": "optr_643969122d598f5b62d15fbd"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workflow
string
required

ID do workflow

Body

application/json

Este objeto representa um workflow. Ele permite que você crie fluxos de trabalho dinâmicos.

​
name
string

Nome do workflow

​
status
enum<string>

Status do workflow

Available options:
draft,
modified,
deployed
Example:

"draft"

​
content
object

Este objeto representa o conteúdo de um workflow, contém as declarações dos Nodes de fluxos e subfluxos de trabalho.

Response

200 - application/json

Retorna o objeto Workflow se a atualização for bem-sucedida. Retorna um erro se os parâmetros de criação forem inválidos (por exemplo, especificar um documento inválido).

Este objeto representa um workflow. Ele permite que você crie fluxos de trabalho dinâmicos.

​
id
any
​
name
string

Nome do workflow

​
status
enum<string>

Status do workflow

Available options:
draft,
modified,
deployed
Example:

"draft"

​
content
object

Este objeto representa o conteúdo de um workflow, contém as declarações dos Nodes de fluxos e subfluxos de trabalho.

​
createdAt
string<date-time>

Data de criação do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
updatedAt
string<date-time>

Data de alteração do objeto

Example:

"2023-08-25T22:38:41.134Z"

​
deleted
boolean
default:false

Identifica se o objeto foi excluído. Se verdadeiro, o objeto foi excluído.

Example:

false

​
createdBy
object

Esta estrutura de dados descreve a auditoria das operações de criação de faturas (invoices).

​
updatedBy
object

Esta estrutura de dados descreve a auditoria das operações de alteração de faturas (invoices).

⌘I