Automations

Atualizar Automação do Formulário

put

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

formIdstringObrigatório

ID do formulário

automationIdstringObrigatório

ID da automação

Corpo

activebooleanOpcional

database_idstringOpcional

Respostas

201

Criado

application/json

idstringOpcional

activebooleanOpcional

database_idstringOpcional

404

Form was not found

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

put/forms/{formId}/automations/{automationId}

PUT /api/b2b/forms/{formId}/automations/{automationId} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "active": true,
  "database_id": "text",
  "fields": [
    {
      "id": "text",
      "type": "FIXED_VALUE",
      "value": "text"
    }
  ]
}

{
  "id": "text",
  "active": true,
  "database_id": "text",
  "fields": [
    {
      "id": "text",
      "type": "CALCULATION",
      "value": "text"
    }
  ]
}

Excluir Automação do Formulário

delete

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

formIdstringObrigatório

ID do formulário

automationIdstringObrigatório

ID da automação

Respostas

204

Form automation deleted successfully

Sem conteúdo

404

Form automation was not found

500

An internal server error was thrown

delete/forms/{formId}/automations/{automationId}

DELETE /api/b2b/forms/{formId}/automations/{automationId} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

Sem conteúdo

Listar Automações do Formulário

get

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

formIdstringObrigatório

ID do formulario

Parâmetros de consulta

sortstringOpcionalDefault: createdAt

dirstringOpcionalDefault: desc

Respostas

200

Automations listed

application/json

idstringOpcional

activebooleanOpcional

database_idstringOpcional

404

Form was not found

application/json

422

A query param was invalid

application/json

500

An internal server error was thrown

application/json

get/forms/{formId}/automations

GET /api/b2b/forms/{formId}/automations HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "text",
    "active": true,
    "database_id": "text",
    "fields": [
      {
        "id": "text",
        "type": "CALCULATION",
        "value": "text"
      }
    ]
  }
]

Criar Automação do Formulário

post

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

formIdstringObrigatório

ID do formulário

Corpo

activebooleanOpcional

database_idstringOpcional

Respostas

201

Criado

application/json

idstringOpcional

activebooleanOpcional

database_idstringOpcional

404

Form was not found

application/json

422

A validation error was thrown

application/json

500

An internal server error was thrown

application/json

post/forms/{formId}/automations

POST /api/b2b/forms/{formId}/automations HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 97

{
  "active": true,
  "database_id": "text",
  "fields": [
    {
      "id": "text",
      "type": "FIXED_VALUE",
      "value": "text"
    }
  ]
}

{
  "id": "text",
  "active": true,
  "database_id": "text",
  "fields": [
    {
      "id": "text",
      "type": "CALCULATION",
      "value": "text"
    }
  ]
}