Referência da APIPOST

Adicionar palavras-chave

Adiciona uma ou mais palavras-chave a um site monitorado.

POSThttps://ai.redreplier.com/ai-app/api/v1/websites/{websiteId}/keywords

Adiciona uma ou mais palavras-chave a um site monitorado.

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

  • websiteId (caminho, UUID, obrigatório): Site que receberá as palavras-chave.

Corpo da requisição

  • keywords (string[], obrigatório, não vazio): Valores de palavras-chave a adicionar; cada valor pode ter até 255 caracteres.

Resposta

Retorna um objeto Website público.

Objeto Website

  • id (string): UUID do site.
  • accountGroupId (string): Grupo de conta resolvido a partir do token.
  • domain (string): Domínio normalizado do site.
  • url (string): URL do site.
  • name (string | null): Nome de exibição.
  • description (string | null): Contexto usado para pontuação de relevância.
  • createdAt, updatedAt (ISO string | null): Carimbos de criação e atualização em formato ISO 8601, ou null.
  • keywords (Keyword[]): Objetos Keyword deste site.

Objeto Keyword

  • 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 POST https://ai.redreplier.com/ai-app/api/v1/websites/11111111-1111-4111-8111-111111111111/keywords \
  -H 'Authorization: Bearer redreplier_test_1234567890' \
  -H 'Content-Type: application/json' \
  -d '{"keywords":["agency CRM","client onboarding software"]}'

Notas

Adicionar palavras-chave é diferente de editar. Novas palavras-chave começam como PENDING e podem ser ativadas automaticamente se a capacidade do plano permitir.

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 POST \
  --url https://ai.redreplier.com/ai-app/api/v1/websites/9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10/keywords \
  --header 'Authorization: Bearer redreplier_test_1234567890' \
  --header 'Content-Type: application/json' \
  --data '{"keywords":["agency CRM","client follow-up software","sales pipeline for agencies"]}'
200
{
  "id": "9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10",
  "accountGroupId": "acct_7dK9pQ2",
  "domain": "acmecrm.io",
  "url": "https://acmecrm.io",
  "name": "Acme CRM",
  "description": "CRM for small agencies that need pipeline tracking and client follow-up reminders.",
  "createdAt": "2026-05-22T10:15:30.000Z",
  "updatedAt": "2026-05-29T14:02:11.000Z",
  "keywords": [
    {
      "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"
    }
  ]
}