Saltar al contenido

Remove um badge do catálogo

DELETE/api/badges/{id}

Auth
Requiere token
Quién puede:
owner
admin
Clave de API:
gamification:delete
X-CommunityId
X-CommunityId Envía el X-CommunityId de la comunidad en la que ocurre la operación.
Las descripciones de los endpoints vienen de la especificación de la API y, por ahora, están en portugués. La interfaz alrededor está traducida.

Só owner e admin. Exclusão lógica: o badge some do catálogo, dos perfis e do ranking, e as concessões ficam no histórico (ninguém é avisado). O "Badge ao concluir" ou "ao fazer check-in" que apontava para ele para de valer. `data.holders` é quantas pessoas tinham o badge (o app pergunta antes com `GET /api/badges/{id}`). `data.unlocks` (`{ spaces, sections }`) diz quantos espaços e seções o badge abria em "Quem tem acesso": esse acesso fecha na hora (a concessão fica guardada, mas um badge apagado não abre nada).

Parámetros

NombreDóndeTipoDescripción
idobligatoriopathstring (uuid)

Headers

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

Respuestas

CódigoDescripción
200Removido.
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.
404Recurso não encontrado.

Ejemplo con curl

curl -X DELETE "https://api.memberfy.net/api/badges/<id>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID"