| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Adiciona uma etiqueta a um card específico utilizando o identificador único do card (idCard) e o identificador único da etiqueta (idTag).
Este endpoint permite classificar, organizar ou sinalizar cards dentro de um Board através de etiquetas previamente cadastradas na plataforma.
É recomendado para integrações que necessitam categorizar cards automaticamente, indicar status visuais, segmentar processos ou aplicar marcações específicas conforme regras externas.
Após a execução da requisição, a etiqueta informada será vinculada ao card correspondente.
Parâmetros utilizados
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
idCard | string | Sim | Identificador único do card que receberá a etiqueta. |
idTag | string | Sim | Identificador único da etiqueta que será adicionada ao card. |
idCard
idCardIdentificador único do card onde a etiqueta será adicionada.
O ID deve ser informado diretamente na rota da requisição.
idTag
idTagIdentificador único da etiqueta que será vinculada ao card.
A etiqueta deve existir na plataforma e estar disponível para uso no contexto do Board.
Exemplo de requisição
POST https://api.goalfy.com.br/api/cards/12345/addTag/67890Neste exemplo:
| Parâmetro | Valor |
|---|---|
idCard | 12345 |
idTag | 67890 |
Exemplo com cURL
curl --request POST \
--url https://api.goalfy.com.br/api/cards/12345/addTag/67890 \
--header 'Authorization: Token SEU_TOKEN'Body da requisição
Este endpoint não exige envio de body.
A operação é realizada utilizando apenas os parâmetros informados na rota.
Exemplo de resposta
[
{
"color":"#FFFFF",
"deleted":false,
"id":"{{idTag}}",
"text":"Teste"
}
]
Respostas esperadas
Sucesso 200Adiciona a etiqueta informada ao card especificado.
Após a execução bem-sucedida, o card passará a possuir a etiqueta vinculada.
Possíveis erros
400 Bad RequestRetornado quando algum parâmetro foi enviado em formato inválido ou a requisição não pôde ser processada.
404 Not FoundRetornado quando o card ou a etiqueta informada não existe ou não foi localizada.
401 UnauthorizedRetornado quando o token de autenticação é inválido ou não foi enviado corretamente.
403 ForbiddenRetornado quando o usuário não possui permissão para adicionar etiquetas ao card informado.
409 ConflictPode ser retornado quando a etiqueta já está vinculada ao card, dependendo das regras de validação da plataforma.
Observações
ImportanteA etiqueta será adicionada diretamente ao card informado na rota.
O
idCarddeve corresponder a um card válido existente na plataforma.O
idTagdeve corresponder a uma etiqueta válida.A etiqueta precisa estar disponível no contexto do Board relacionado ao card.
Dependendo das permissões do usuário autenticado, algumas etiquetas podem não estar disponíveis para uso.
Caso a etiqueta já esteja aplicada ao card, o comportamento da API pode variar conforme as regras da plataforma.
A adição de etiquetas pode ser utilizada para organização visual, filtros, automações e integrações externas.
Fluxo recomendado
- Consultar ou localizar o ID do card.
- Identificar o ID da etiqueta desejada.
- Executar este endpoint informando
idCardeidTag.- Consultar o card novamente para validar se a etiqueta foi aplicada corretamente.