Editar formulário
PATCH/api/forms/{id}
- Auth
- Requiere token
- Clave de API:
- No acepta clave de API
- X-CommunityId
X-CommunityIdEnvía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.
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
| Nombre | Dónde | Tipo | Descripción |
|---|---|---|---|
idobligatorio | path | string (uuid) |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
If-Unmodified-Sinceopcional | 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-CommunityIdopcional | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Cuerpo de la solicitud application/json
| Nombre | Tipo | Descripción |
|---|---|---|
spaceIdopcional | 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. |
titleopcional | string | max 200 |
descriptionopcional | string | max 5000 |
acceptMembersopcional | boolean | |
acceptVisitorsopcional | boolean | |
saveAsMemberopcional | boolean | |
sendConfirmationopcional | boolean | |
thankYouMessageopcional | string | max 2000 |
redirectUrlopcional | string | Só `https`. |
privacyPolicyUrlopcional | string | Só `https`. |
accessPasswordopcional | string | Define a senha de acesso; `null` remove. Guardada com hash. · min 6, max 100 |
closesAtopcional | string (date-time) | |
maxSubmissionsopcional | integer | ≥ 1 |
responderIdsopcional | string (uuid)[] | Membros da comunidade. Na criação, sem a lista, quem criou. |
sectionsopcional | object[] | |
sections[].idopcional | string (uuid) | |
sections[].positionopcional | integer | |
sections[].titleobligatorio | string | max 200 |
sections[].descriptionopcional | string | max 2000 |
sections[].fieldsopcional | object[] | |
sections[].fields[].idopcional | string (uuid) | |
sections[].fields[].sectionIdopcional | string (uuid) | |
sections[].fields[].positionopcional | integer | |
sections[].fields[].typeobligatorio | NAME | EMAIL | PHONE | COMPANY | JOB_TITLE | SHORT_TEXT | LONG_TEXT | SINGLE_CHOICE | MULTIPLE_CHOICE | NUMBER | DATE | URL | CONSENT | |
sections[].fields[].labelobligatorio | string | max 1000 |
sections[].fields[].helpopcional | string | max 1000 |
sections[].fields[].placeholderopcional | string | max 200 |
sections[].fields[].requiredopcional | boolean | |
sections[].fields[].optionsopcional | object[] | |
sections[].fields[].minopcional | number | |
sections[].fields[].maxopcional | number | |
sections[].fields[].lockToProfileopcional | boolean |
Respuestas
| Código | Descripción |
|---|---|
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`). |
Ejemplo con 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 '{}'