Configura as boas-vindas
PUT/api/welcome/settings
- 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.
Só owner e admin. Parcial: o que não vem fica como está; `screens` substitui a lista (de 1 a 5 telas para ligar; as missões dos "Primeiros passos" vêm nos campos `missions*` e `finalBadgeId`; mantenha o `id` de cada tela ao editar). Ligar (`enabled: true` quando estava desligada) marca `enabledAt` e grava `applyToExisting` como veio (falso se não vier). Desligar deixa os pendentes entrarem direto; ligar de novo não pede de novo a quem já concluiu ou pulou. Erros por campo com 422 em `screens[i].<campo>`.
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 |
|---|---|---|
enabledfacultatif | boolean | |
modefacultatif | REQUIRED | SKIPPABLE | |
applyToExistingfacultatif | boolean | |
missionsEnabledfacultatif | boolean | |
missionsShowExistingfacultatif | boolean | |
finalBadgeIdfacultatif | string (uuid) | |
missionsfacultatif | object[] | Substitui a lista (de 1 a 6 para ligar). Mantenha o `id` ao editar: a missão com o mesmo tipo e item continua cumprida por quem já fez; uma nova ou alterada conta a partir de agora. |
missions[].idfacultatif | string (uuid) | |
missions[].kindobligatoire | profile_completed | first_post | form_submitted | event_registered | course_completed | |
missions[].titleobligatoire | string | max 80 |
missions[].spaceIdfacultatif | string (uuid) | |
missions[].formIdfacultatif | string (uuid) | |
missions[].eventIdfacultatif | string (uuid) | |
missions[].courseIdfacultatif | string (uuid) | |
missions[].pointsfacultatif | integer | ≥ 0, ≤ 10000 |
missions[].badgeIdfacultatif | string (uuid) | |
screensfacultatif | object[] | |
screens[].idfacultatif | string (uuid) | |
screens[].titlefacultatif | string | max 120 |
screens[].bodyfacultatif | string | |
screens[].videofacultatif | object | |
screens[].video.mediaIdfacultatif | string (uuid) | |
screens[].video.urlfacultatif | string | |
screens[].video.requireFinishfacultatif | boolean | |
screens[].rulesfacultatif | object | |
screens[].rules.textfacultatif | string | |
screens[].fieldIdsfacultatif | string (uuid)[] |
Réponses
| Statut | Description |
|---|---|
200 | A configuração salva. |
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 | Autenticado, mas sem permissão para esta operação. |
422 | Tela inválida (título, texto, vídeo, regras, campo de outra comunidade), mais de 5 telas, ou ligar sem tela; missão inválida em `missions[i].<campo>` (tipo, título, item de outra comunidade, pontos, badge), mais de 6, ou ligar sem missão. |
Exemple curl
curl -X PUT "https://api.memberfy.net/api/welcome/settings" \
-H "Authorization: Bearer $TOKEN" \
-H "X-CommunityId: $COMMUNITY_ID" \
-H "Content-Type: application/json" \
-d '{}'