Configura as boas-vindas
PUT/api/welcome/settings
- Auth
- Richiede un token
- Chi può:
- owner
- admin
- 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.
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>`.
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 |
|---|---|---|
enabledfacoltativo | boolean | |
modefacoltativo | REQUIRED | SKIPPABLE | |
applyToExistingfacoltativo | boolean | |
missionsEnabledfacoltativo | boolean | |
missionsShowExistingfacoltativo | boolean | |
finalBadgeIdfacoltativo | string (uuid) | |
missionsfacoltativo | 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[].idfacoltativo | string (uuid) | |
missions[].kindobbligatorio | profile_completed | first_post | form_submitted | event_registered | course_completed | |
missions[].titleobbligatorio | string | max 80 |
missions[].spaceIdfacoltativo | string (uuid) | |
missions[].formIdfacoltativo | string (uuid) | |
missions[].eventIdfacoltativo | string (uuid) | |
missions[].courseIdfacoltativo | string (uuid) | |
missions[].pointsfacoltativo | integer | ≥ 0, ≤ 10000 |
missions[].badgeIdfacoltativo | string (uuid) | |
screensfacoltativo | object[] | |
screens[].idfacoltativo | string (uuid) | |
screens[].titlefacoltativo | string | max 120 |
screens[].bodyfacoltativo | string | |
screens[].videofacoltativo | object | |
screens[].video.mediaIdfacoltativo | string (uuid) | |
screens[].video.urlfacoltativo | string | |
screens[].video.requireFinishfacoltativo | boolean | |
screens[].rulesfacoltativo | object | |
screens[].rules.textfacoltativo | string | |
screens[].fieldIdsfacoltativo | string (uuid)[] |
Risposte
| Codice | Descrizione |
|---|---|
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. |
Esempio con 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 '{}'