Criar formulário
POST/api/forms
- Auth
- Requires a token
- Who can call it:
- owner
- admin
- 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 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).
Headers
| Name | Type | Description |
|---|---|---|
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 |
|---|---|
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`). |
curl example
curl -X POST "https://api.memberfy.net/api/forms" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'