Editar formulário
PATCH/api/forms/{id}
- Auth
- Jeton requis
- Clé d’API:
- Clé d’API non acceptée
- X-CommunityId
X-CommunityIdEnvoyez le X-CommunityId de la communauté où l’opération a lieu.
Les descriptions des endpoints viennent directement de la spécification de l’API et sont en portugais pour l’instant. L’interface autour est traduite.
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.
Paramètres
| Nom | Emplacement | Type | Description |
|---|---|---|---|
idobligatoire | path | string (uuid) |
En-têtes
| Nom | Type | Description |
|---|---|---|
If-Unmodified-Sincefacultatif | 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-CommunityIdfacultatif | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corps de la requête application/json
| Nom | Type | Description |
|---|---|---|
spaceIdfacultatif | 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. |
titlefacultatif | string | max 200 |
descriptionfacultatif | string | max 5000 |
acceptMembersfacultatif | boolean | |
acceptVisitorsfacultatif | boolean | |
saveAsMemberfacultatif | boolean | |
sendConfirmationfacultatif | boolean | |
thankYouMessagefacultatif | string | max 2000 |
redirectUrlfacultatif | string | Só `https`. |
privacyPolicyUrlfacultatif | string | Só `https`. |
accessPasswordfacultatif | string | Define a senha de acesso; `null` remove. Guardada com hash. · min 6, max 100 |
closesAtfacultatif | string (date-time) | |
maxSubmissionsfacultatif | integer | ≥ 1 |
responderIdsfacultatif | string (uuid)[] | Membros da comunidade. Na criação, sem a lista, quem criou. |
sectionsfacultatif | object[] | |
sections[].idfacultatif | string (uuid) | |
sections[].positionfacultatif | integer | |
sections[].titleobligatoire | string | max 200 |
sections[].descriptionfacultatif | string | max 2000 |
sections[].fieldsfacultatif | object[] | |
sections[].fields[].idfacultatif | string (uuid) | |
sections[].fields[].sectionIdfacultatif | string (uuid) | |
sections[].fields[].positionfacultatif | integer | |
sections[].fields[].typeobligatoire | NAME | EMAIL | PHONE | COMPANY | JOB_TITLE | SHORT_TEXT | LONG_TEXT | SINGLE_CHOICE | MULTIPLE_CHOICE | NUMBER | DATE | URL | CONSENT | |
sections[].fields[].labelobligatoire | string | max 1000 |
sections[].fields[].helpfacultatif | string | max 1000 |
sections[].fields[].placeholderfacultatif | string | max 200 |
sections[].fields[].requiredfacultatif | boolean | |
sections[].fields[].optionsfacultatif | object[] | |
sections[].fields[].minfacultatif | number | |
sections[].fields[].maxfacultatif | number | |
sections[].fields[].lockToProfilefacultatif | boolean |
Réponses
| Statut | 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`). |
Exemple 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 '{}'