Criar formulário
POST/api/forms
- Auth
- Richiede un token
- Chi può:
- owner
- admin
- Chiave API:
- Non accetta chiavi API
- X-CommunityId
X-CommunityIdInvia l’X-CommunityId della community in cui avviene l’operazione.
Le descrizioni degli endpoint provengono dalla specifica dell’API e per ora sono in portoghese. L’interfaccia intorno è tradotta.
Quem o "Quem pode postar" (`canCreate`) do espaço permite; owner e admin sempre. Os demais, 403. Nasce em rascunho, com uma seção vazia se `sections` não vier, e com quem criou como responsável. Num espaço "Um formulário" que já tem um, 409. `acceptVisitors` e `saveAsMember` só a equipe liga (membro: 403).
Header
| Nome | Tipo | Descrizione |
|---|---|---|
X-CommunityIdfacoltativo | string (uuid) | ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade. |
Corpo della richiesta application/json
| Nome | Tipo | Descrizione |
|---|---|---|
spaceIdfacoltativo | 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. |
titlefacoltativo | string | max 200 |
descriptionfacoltativo | string | max 5000 |
acceptMembersfacoltativo | boolean | |
acceptVisitorsfacoltativo | boolean | |
saveAsMemberfacoltativo | boolean | |
sendConfirmationfacoltativo | boolean | |
thankYouMessagefacoltativo | string | max 2000 |
redirectUrlfacoltativo | string | Só `https`. |
privacyPolicyUrlfacoltativo | string | Só `https`. |
accessPasswordfacoltativo | string | Define a senha de acesso; `null` remove. Guardada com hash. · min 6, max 100 |
closesAtfacoltativo | string (date-time) | |
maxSubmissionsfacoltativo | integer | ≥ 1 |
responderIdsfacoltativo | string (uuid)[] | Membros da comunidade. Na criação, sem a lista, quem criou. |
sectionsfacoltativo | object[] | |
sections[].idfacoltativo | string (uuid) | |
sections[].positionfacoltativo | integer | |
sections[].titleobbligatorio | string | max 200 |
sections[].descriptionfacoltativo | string | max 2000 |
sections[].fieldsfacoltativo | object[] | |
sections[].fields[].idfacoltativo | string (uuid) | |
sections[].fields[].sectionIdfacoltativo | string (uuid) | |
sections[].fields[].positionfacoltativo | integer | |
sections[].fields[].typeobbligatorio | NAME | EMAIL | PHONE | COMPANY | JOB_TITLE | SHORT_TEXT | LONG_TEXT | SINGLE_CHOICE | MULTIPLE_CHOICE | NUMBER | DATE | URL | CONSENT | |
sections[].fields[].labelobbligatorio | string | max 1000 |
sections[].fields[].helpfacoltativo | string | max 1000 |
sections[].fields[].placeholderfacoltativo | string | max 200 |
sections[].fields[].requiredfacoltativo | boolean | |
sections[].fields[].optionsfacoltativo | object[] | |
sections[].fields[].minfacoltativo | number | |
sections[].fields[].maxfacoltativo | number | |
sections[].fields[].lockToProfilefacoltativo | boolean |
Risposte
| Codice | Descrizione |
|---|---|
201 | Criado. |
401 | Token ausente, inválido ou expirado; token de outra comunidade (o `X-CommunityId` ou o `communityId` do corpo não é o do token); token antigo ou de uma sessão encerrada (troca de senha, convite aceito). Nesses casos a mensagem pede para entrar de novo (`auth.signInAgain`). |
403 | O espaço não deixa esta pessoa criar, ou membro tentou ligar uma opção da equipe. |
409 | Espaço "Um formulário" que já tem um. |
422 | Árvore, título, URL, senha ou responsáveis inválidos (com cada caminho em `errors`). |
Esempio con curl
curl -X POST "https://api.memberfy.net/api/forms" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'