Referência da APIPATCH

Editar palavra-chave

Altera o texto de uma palavra-chave existente.

PATCHhttps://ai.redreplier.com/ai-app/api/v1/keywords/{keywordId}

Altera o texto de uma palavra-chave existente.

Token Bearer (token de API do RedReplier)

Autenticação

Envie um token de API do RedReplier como Bearer token em cada requisição. Os tokens começam com redreplier_; o RedReplier resolve a conta a partir do token.

Authorization: Bearer redreplier_test_1234567890
Content-Type: application/json

Parâmetros

  • keywordId (caminho, UUID, obrigatório): Palavra-chave a ser editada.

Corpo da requisição

  • value (string, obrigatório, máximo 255): Novo texto da palavra-chave.

Resposta

Retorna um objeto Keyword público.

  • id (string): UUID da palavra-chave.
  • websiteId (string): UUID do site principal.
  • value (string): Texto da palavra-chave, até 255 caracteres.
  • status (string): PENDING, ACTIVE, DISABLED ou SUSPENDED.
  • createdAt, updatedAt (ISO string | null): Carimbos de criação e atualização em formato ISO 8601, ou null.

Exemplo de requisição

curl -X PATCH https://ai.redreplier.com/ai-app/api/v1/keywords/22222222-2222-4222-8222-222222222222 \
  -H 'Authorization: Bearer redreplier_test_1234567890' \
  -H 'Content-Type: application/json' \
  -d '{"value":"agency CRM recommendations"}'

Notas

Editar palavras-chave ativas pode contar contra a cota mensal de edição. Editar uma palavra-chave SUSPENDED é a forma normal de corrigir termos ruidosos.

Erros

  • 400 Bad Request: Entrada, URL, UUID, enum, parâmetro de consulta ou corpo inválido.
  • 401 Unauthorized: Bearer token ausente ou inválido.
  • 404 Not Found: O recurso não existe para a conta do token.
  • 500 Internal Server Error: Erro inesperado do servidor.
Exemplo de solicitação (curl)
curl --request PATCH \
  --url https://ai.redreplier.com/ai-app/api/v1/keywords/73a3c9b6-3e5f-4a53-a2c6-70c5ef7f2f6d \
  --header 'Authorization: Bearer redreplier_test_1234567890' \
  --header 'Content-Type: application/json' \
  --data '{"value": "CRM for agencies"}'
200
{
  "id": "73a3c9b6-3e5f-4a53-a2c6-70c5ef7f2f6d",
  "websiteId": "9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10",
  "value": "agency CRM",
  "status": "ACTIVE",
  "createdAt": "2026-05-22T10:16:00.000Z",
  "updatedAt": "2026-05-29T14:02:11.000Z"
}