Skip to content

Edita, desativa ou reativa um valor da comunidade

PUT/api/recognitions/values/{valueId}

Auth
Requires a token
API key:
No API key accepted
X-CommunityId
X-CommunityId Send the X-CommunityId of the community the operation happens in.
Endpoint descriptions come straight from the API specification and are in Portuguese for now. The interface around them is translated.

Owner e admin. `active: false` desativa: some da escolha ao reconhecer, mas continua nos reconhecimentos que já o usaram. Valor nunca é apagado.

Parameters

NameInTypeDescription
valueIdrequiredpathstring (uuid)

Headers

NameTypeDescription
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

NameTypeDescription
nameoptionalstringmax 80
descriptionoptionalstringmax 300
activeoptionalboolean

Responses

StatusDescription
200O valor.
400Requisição inválida — falha de validação.
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.
422Nome vazio ou texto acima do limite.
500Erro interno do servidor.

curl example

curl -X PUT "https://api.memberfy.net/api/recognitions/values/<valueId>" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -H "Content-Type: application/json" \
  -d '{}'