Zum Inhalt springen

Cria um badge

POST/api/badges

Auth
Token erforderlich
Wer darf:
owner
admin
API-Schlüssel:
gamification:write
X-CommunityId
X-CommunityId Sende die X-CommunityId der Community, in der die Operation stattfindet.
Die Beschreibungen der Endpoints stammen aus der API-Spezifikation und sind vorerst auf Portugiesisch. Die Oberfläche drumherum ist übersetzt.

Só owner e admin. `imageUrl` obrigatório, de uma imagem enviada antes em `POST /api/badges/image` desta mesma comunidade (outra URL: 422 em `imageUrl`). Nome obrigatório, até 60 caracteres, único na comunidade entre os badges vivos, sem diferenciar maiúsculas (repetido: **409** em `name`). Descrição até 300. `visibility` `public` (padrão) ou `private`. Erros de campo: **422** com o `param`.

Header

NameTypBeschreibung
X-CommunityIdoptionalstring (uuid)ID da comunidade em que a operação acontece. Obrigatório na maioria dos endpoints com escopo de comunidade.

Request-Body application/json

NameTypBeschreibung
namePflichtstringmax 60
descriptionoptionalstringmax 300
imageUrlPflichtstring
visibilityoptionalpublic | private
ruleoptionalobjectOpcional. Campo inválido → 422 com `errors[].param` (`rule.trigger`, `rule.minCount`, `rule.spaceId`, `rule.window`, `rule.minMemberDays`); passar de 50 regras na comunidade → 400 (`badges.ruleLimit`).

Antworten

StatusBeschreibung
201Criado.
401Token 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`).
403Autenticado, mas sem permissão para esta operação.
409Já existe um badge com este nome na comunidade.
422Campo inválido (nome, descrição, imagem ou visibilidade).

curl-Beispiel

curl -X POST "https://api.memberfy.net/api/badges" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","imageUrl":"string"}'