form-publications

Criar publicação

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 body

titlestring required

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

descriptionstring nullable

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

background_colorstring nullable

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

starts_atstring nullable

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

ends_atstring nullable

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

redirect_urlstring uri nullable

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 nullable

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

link_as_mediaboolean nullable

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 nullable

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

project_namestring nullable

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

form_edge_idinteger nullable

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 nullable

Modelo de projeto usado para criar o projeto.

funnel_step_idinteger nullable

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

Changed in 2 of the 98 revisions of this API.17914

  • d8fb547e20a216912See the full diff
    • ▲

      added the new required request property

      new-required-request-property

    • ▲

      added the new required request property

      new-required-request-property

    • ▲

      added the new required request property

      new-required-request-property

    • ▲

      the request's body type changed from array to object

      request-body-type-changed

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

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

      response-property-list-of-types-widened

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ▲

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

      response-property-type-changed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ●

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

      response-property-enum-value-added

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

  • d71b18b1685d12See the full diff
    • ▲

      removed the success response with the status

      response-success-status-removed

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the success response with the status

      response-success-status-added