Pages

Buscar Página do Formulário por ID

get

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

formIdstringObrigatório

ID do formulário

pageIdstringObrigatório

ID da página

Respostas

200

OK

application/json

idstringOpcional

titlestringOpcional

orderinteger · int32Opcional

404

Form was not found

application/json

500

An internal server error was thrown

application/json

get/forms/{formId}/pages/{pageId}

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

{
  "id": "text",
  "title": "text",
  "order": 1
}

Atualizar Página 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

pageIdstringObrigatório

ID da página

Corpo

titlestringOpcional

orderinteger · int32Opcional

Respostas

200

OK

application/json

idstringOpcional

titlestringOpcional

orderinteger · int32Opcional

404

Form Page was not found

application/json

500

An internal server error was thrown

application/json

put/forms/{formId}/pages/{pageId}

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

{
  "title": "text",
  "order": 1
}

{
  "id": "text",
  "title": "text",
  "order": 1
}

Excluir Página 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

pageIdstringObrigatório

ID da página

Respostas

204

Form page deleted successfully

Sem conteúdo

404

Form page was not found

500

An internal server error was thrown

delete/forms/{formId}/pages/{pageId}

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

Sem conteúdo

Atualizar Parcialmente Página do Formulário

patch

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

formIdstringObrigatório

ID do formulario

pageIdstringObrigatório

ID da página

Corpo

titlestringOpcional

Respostas

200

OK

application/json

idstringOpcional

titlestringOpcional

orderinteger · int32Opcional

404

Form was not found

*/*

500

An internal server error was thrown

*/*

patch/forms/{formId}/pages/{pageId}

PATCH /api/b2b/forms/{formId}/pages/{pageId} HTTP/1.1
Host: api.zydon.com.br
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 16

{
  "title": "text"
}

{
  "id": "text",
  "title": "text",
  "order": 1
}

Listar Páginas do Formulário

get

Autorizações

AuthorizationstringObrigatório

Bearer authentication header of the form Bearer <token>.

Parâmetros de rota

formIdstringObrigatório

ID do formulário

Parâmetros de consulta

searchstringOpcionalDefault: ""

pageinteger · int32OpcionalDefault: 0

perPageinteger · int32OpcionalDefault: 25

sortstringOpcionalDefault: order

dirstringOpcionalDefault: desc

Respostas

200

Pages listed

application/json

idstringOpcional

titlestringOpcional

orderinteger · int32Opcional

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}/pages

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

[
  {
    "id": "text",
    "title": "text",
    "order": 1
  }
]

Criar Página 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

titlestringOpcional

Respostas

201

Criado

application/json

idstringOpcional

titlestringOpcional

orderinteger · int32Opcional

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}/pages

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

{
  "title": "text"
}

{
  "id": "text",
  "title": "text",
  "order": 1
}