Criar formulário
POST/api/forms
- Auth
- Jeton requis
- Qui peut l’appeler:
- owner
- admin
- 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 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).
En-têtes
| Nom | Type | Description |
|---|---|---|
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 |
|---|---|
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`). |
Exemple 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 '{}'