Skip to content

Sobe a arte própria de um tipo de reconhecimento

POST/api/recognitions/types/{type}/art

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 (moderador, financeiro e membro: 403). Campo `art` em multipart: PNG, JPG ou WebP, até 5 MB, com pelo menos 1200 px de largura (fora disso, 400 com a mensagem traduzida: `artInvalidType`, `artTooLarge`, `artTooSmall`, `artFileRequired`). Tamanho recomendado: 1800×600 (3:1), com a metade esquerda mais calma, onde o Cartão escreve a frase. A imagem é regravada em 1800×600, recortada ao centro, sem metadados (EXIF), e nunca recolorida. Vale para o tipo em todos os espaços de Reconhecimento da comunidade, inclusive nos reconhecimentos antigos (a arte é do tipo). A arte própria anterior é apagada do armazenamento.

Parameters

NameInTypeDescription
typerequiredpathAPPRECIATION | WELCOME | MILESTONE | AWARD | EVENT | GRADUATION | WORK_ANNIVERSARY

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 multipart/form-data

NameTypeDescription
artrequiredstring (binary)PNG, JPG ou WebP, até 5 MB, mínimo 1200 px de largura; recomendado 1800×600 (3:1).

Responses

StatusDescription
200O tipo com a arte nova (`RecognitionTypeInfo`, `hasCustomArt: true`).
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.
500Erro interno do servidor.

curl example

curl -X POST "https://api.memberfy.net/api/recognitions/types/<type>/art" \
  -H "Authorization: Bearer $TOKEN" \
  -H "X-CommunityId: $COMMUNITY_ID" \
  -F "file=@caminho/do/arquivo"