Editar anotação

Developing

PATCH

https://api.bestfy.io/public-api/transactions/{financialTransactionId}/notes/{noteId}

Substitui o texto de uma anotação existente.

A edição é total, não incremental: o content enviado passa a ser o texto completo da anotação. A resposta traz o objeto atualizado, com updatedAt refletindo a edição.

A chave de API pode editar qualquer anotação da própria empresa, inclusive as criadas manualmente no painel (source: "DASHBOARD"). A anotação precisa pertencer ao pedido informado.

A edição não altera o autor nem o source originais: uma anotação criada no painel e editada pela API continua com source: "DASHBOARD" e com o autor que a escreveu.

Formatação do texto

Mesmas regras de POST: markdown restrito a **negrito**, ~~tachado~~, [link](https://...) e quebra de linha, com limite de 2000 caracteres. HTML, imagens e links fora de http/https são recusados.

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200Anotação atualizada

application/json

Bodyapplication/json

🟠400Conteudo invalido

🟠400ID da transação malformado

🟠401API Key inválida ou ausente

🟠403API Key revogada

🟠404Transação não encontrada

🟠404Anotação não encontrada

Request Example

Shell

JavaScript

Java

Swift

curl --location --globoff --request PATCH 'https://api.bestfy.io/public-api/transactions/{{$string.uuid}}/notes/{{$string.uuid}}' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
  "content": "Troca confirmada para **tamanho M**. Etiqueta reemitida."
}'

Response Example

200 - Anotação criada

{
  "id": "0199a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "financialTransactionId": "019c009b-ae07-2c60-cf14-abc48d02ca1d",
  "authorUserId": "0199a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
  "author": {
    "id": "0199a1b2-c3d4-7e5f-8a9b-0c1d2e3f4a5b",
    "name": "Renato"
  },
  "source": "API",
  "content": "Troca confirmada para **tamanho M**. Etiqueta reemitida.",
  "createdAt": "2026-10-06T14:32:10.000Z",
  "updatedAt": "2026-10-06T16:05:44.000Z"
}

Modified at 2026-10-06 15:55:28

Buscar anotação

Remover anotação

Editar anotação

Formatação do texto#

Request

Responses

Formatação do texto