form-publications

Criar publicação

Changed on

Publica um formulário em um link aberto, com token gerado automaticamente. Com create_project, cada resposta cria um projeto na etapa escolhida, gravando as respostas no conteúdo ou como formulário avulso. Ver Publicações de formulários.

post/api/management/form-publications

Request

  • Base URL: https://api.olie.ai
  • URL: https://api.olie.ai/api/management/form-publications
  • Auth: HTTP bearer

Request body

titlestring required

Título exibido no formulário público (até 255 caracteres).

descriptionstring

Descrição exibida dentro do formulário (até 255 caracteres).

background_colorstring

Cor de fundo em hexadecimal, com 3 ou 6 dígitos (ex.: #1E40AF). Nulo usa a cor padrão.

starts_atstring

Início da janela de publicação. Nulo: vale imediatamente.

ends_atstring

Fim da janela de publicação; igual ou posterior a starts_at. Nulo: não expira.

redirect_urlstring uri

URL para onde quem responde é levado após enviar (até 2048 caracteres).

status'published' | 'unpublished' required

published liga o link público; unpublished o desliga.

form_idinteger required

ID do formulário a publicar.

create_projectboolean

Se cada resposta cria um projeto. Quando não é true, os campos de criação de projeto abaixo são descartados.

link_as_mediaboolean

Grava as respostas no conteúdo do projeto criado. Com create_project, este ou link_as_loose_form precisa ser true.

link_as_loose_formboolean

Grava as respostas como formulário avulso do projeto criado.

project_namestring

Nome fixo do projeto criado (até 255 caracteres). Ignorado quando form_edge_id é enviado.

form_edge_idinteger

Campo do formulário cuja resposta vira o nome do projeto. Precisa ser do formulário publicado e respondível em link público.

project_template_idstring uuid

Modelo de projeto usado para criar o projeto.

funnel_step_idinteger

Etapa de funil em que o projeto criado é vinculado.

Response

Sucesso

responseboolean

Indicador de sucesso da requisição. Sempre true nas respostas bem-sucedidas.

Changes

  • fbae0c094507Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

  • d8fb547e20a2Revision changes
    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      added the new required request property

    • breaking

      the request's body type changed from array to object

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      response property form_publication/create_project list-of-types was widened by adding types integer to media type application/json of response 201

    • breaking

      the / response's property format changed from color to no format for status

    • breaking

      the / response's property type changed from no type to string, and format from no format to date-time for status

    • breaking

      the / response's property type changed from no type to integer for status

    • breaking

      the / response's property type changed from no type to integer for status

    • breaking

      the / response's property type changed from no type to string for status

    • breaking

      the / response's property type changed from no type to string, and format from no format to uuid for status

    • breaking

      the / response's property format changed from uri to no format for status

    • breaking

      the / response's property type changed from no type to string, and format from no format to date-time for status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      removed the optional property / from the response with the status

    • warning

      added the new publication enum value to the / response property for the response status

    • warning

      added the new published enum value to the / response property for the response status

    • warning

      added the new unpublished enum value to the / response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property