Editar formulário
PATCH/api/forms/{id}
- Auth
- Requires a token
- API key:
- No API key accepted
- X-CommunityId
X-CommunityIdSend the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.
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.
Parameters
| Name | In | Type | Description |
|---|---|---|---|
idrequired | path | string (uuid) |
Headers
| Name | Type | Description |
|---|---|---|
If-Unmodified-Sinceoptional | 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-CommunityIdoptional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Request body application/json
| Name | Type | Description |
|---|---|---|
spaceIdoptional | 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. |
titleoptional | string | max 200 |
descriptionoptional | string | max 5000 |
acceptMembersoptional | boolean | |
acceptVisitorsoptional | boolean | |
saveAsMemberoptional | boolean | |
sendConfirmationoptional | boolean | |
thankYouMessageoptional | string | max 2000 |
redirectUrloptional | string | Só `https`. |
privacyPolicyUrloptional | string | Só `https`. |
accessPasswordoptional | string | Define a senha de acesso; `null` remove. Guardada com hash. · min 6, max 100 |
closesAtoptional | string (date-time) | |
maxSubmissionsoptional | integer | ≥ 1 |
responderIdsoptional | string (uuid)[] | Membros da comunidade. Na criação, sem a lista, quem criou. |
sectionsoptional | object[] | |
sections[].idoptional | string (uuid) | |
sections[].positionoptional | integer | |
sections[].titlerequired | string | max 200 |
sections[].descriptionoptional | string | max 2000 |
sections[].fieldsoptional | object[] | |
sections[].fields[].idoptional | string (uuid) | |
sections[].fields[].sectionIdoptional | string (uuid) | |
sections[].fields[].positionoptional | integer | |
sections[].fields[].typerequired | NAME | EMAIL | PHONE | COMPANY | JOB_TITLE | SHORT_TEXT | LONG_TEXT | SINGLE_CHOICE | MULTIPLE_CHOICE | NUMBER | DATE | URL | CONSENT | |
sections[].fields[].labelrequired | string | max 1000 |
sections[].fields[].helpoptional | string | max 1000 |
sections[].fields[].placeholderoptional | string | max 200 |
sections[].fields[].requiredoptional | boolean | |
sections[].fields[].optionsoptional | object[] | |
sections[].fields[].minoptional | number | |
sections[].fields[].maxoptional | number | |
sections[].fields[].lockToProfileoptional | boolean |
Responses
| Status | Description |
|---|---|
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`). |
curl example
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 '{}'