Editar formulário

PATCH/api/forms/{id}

Auth: Exige token
Chave de API:: Não aceita chave de API
X-CommunityId: X-CommunityId Envie o X-CommunityId da comunidade em que a operação acontece.

Quem criou, a equipe e os responsáveis, em qualquer estado (cada envio guarda a cópia do que foi enviado). `acceptVisitors` e `saveAsMember` só a equipe liga (membro: 403). Trocar a senha invalida os acessos já liberados.

Parâmetros

Nome	Onde	Tipo	Descrição
`id`obrigatório	path	`string (uuid)`

Headers

Nome	Tipo	Descrição
`If-Unmodified-Since`opcional	`string`	Opcional: a versão lida (`updatedAt` do `GET`), como data HTTP, se não vier `updatedAt` no corpo. Outra gravação depois dela responde 409.
`X-CommunityId`opcional	`string (uuid)`	ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Corpo da requisição `application/json`

Nome	Tipo	Descrição
`spaceId`opcional	`string (uuid)`	Obrigatório na criação. Um espaço `forms` da comunidade do header. Num espaço "Um formulário" que já tem um, 409.
`title`opcional	`string`	max 200
`description`opcional	`string`	max 5000
`acceptMembers`opcional	`boolean`
`acceptVisitors`opcional	`boolean`
`saveAsMember`opcional	`boolean`
`sendConfirmation`opcional	`boolean`
`thankYouMessage`opcional	`string`	max 2000
`redirectUrl`opcional	`string`	Só `https`.
`privacyPolicyUrl`opcional	`string`	Só `https`.
`accessPassword`opcional	`string`	Define a senha de acesso; `null` remove. Guardada com hash. · min 6, max 100
`closesAt`opcional	`string (date-time)`
`maxSubmissions`opcional	`integer`	≥ 1
`responderIds`opcional	`string (uuid)[]`	Membros da comunidade. Na criação, sem a lista, quem criou.
`sections`opcional	`object[]`
`sections[].id`opcional	`string (uuid)`
`sections[].position`opcional	`integer`
`sections[].title`obrigatório	`string`	max 200
`sections[].description`opcional	`string`	max 2000
`sections[].fields`opcional	`object[]`
`sections[].fields[].id`opcional	`string (uuid)`
`sections[].fields[].sectionId`opcional	`string (uuid)`
`sections[].fields[].position`opcional	`integer`
`sections[].fields[].type`obrigatório	`NAME \| EMAIL \| PHONE \| COMPANY \| JOB_TITLE \| SHORT_TEXT \| LONG_TEXT \| SINGLE_CHOICE \| MULTIPLE_CHOICE \| NUMBER \| DATE \| URL \| CONSENT`
`sections[].fields[].label`obrigatório	`string`	max 1000
`sections[].fields[].help`opcional	`string`	max 1000
`sections[].fields[].placeholder`opcional	`string`	max 200
`sections[].fields[].required`opcional	`boolean`
`sections[].fields[].options`opcional	`object[]`
`sections[].fields[].min`opcional	`number`
`sections[].fields[].max`opcional	`number`
`sections[].fields[].lockToProfile`opcional	`boolean`

Respostas

Código	Descrição
`200`	O formulário editado.
`403`	Autenticado, mas sem permissão para esta operação.
`404`	Recurso não encontrado.
`409`	Outra gravação veio antes da versão enviada (`updatedAt` no corpo ou `If-Unmodified-Since`); `data.updatedAt` é a versão atual: recarregue e repita. Cada gravação avisa os editores abertos (`item.saved`, ver `POST /api/realtime/ticket`).
`422`	Campos inválidos (com cada caminho em `errors`).

Exemplo com curl

curl -X PATCH "https://api.memberfy.net/api/forms/<id>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'

Parâmetros

Headers

Corpo da requisição application/json

Respostas

Exemplo com curl

Corpo da requisição `application/json`