Referência da APIPATCH

Editar palavra-chave

Altera o texto de uma palavra-chave existente, com até 255 caracteres, sem perder o status atual.

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

Altera o texto de uma palavra-chave existente, com até 255 caracteres, sem perder o status atual.

Token Bearer (token de API do RedReplier)

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.

Notas

As edições são ilimitadas e mantêm a vaga paga que a palavra-chave já ocupa: uma palavra-chave ACTIVE continua ACTIVE, e qualquer outra passa a ACTIVE se o plano tiver vaga livre; caso contrário, PENDING. Uma mudança só de maiúsculas e minúsculas não faz nada, e um valor que duplica outra palavra-chave do mesmo site retorna 400. 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, ou code: "token_issuer_lost_access" quando a pessoa que criou a chave API foi desativada ou saiu do workspace.
  • 403 Forbidden: code: "subscription_required" quando o plano do workspace não inclui acesso à API, code: "workspace_access_denied" quando X-Workspace-Id indica um workspace que esta credencial não pode alcançar, ou code: "permission_denied" quando seu papel no workspace não tem a permissão redreplier.write (Admin e Editor têm).
  • 404 Not Found: O recurso não existe para a conta do token.
  • 429 Too Many Requests: Limite de requisições excedido. Aguarde os segundos indicados em Retry-After.
  • 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"
}