Adicionar palavras-chave

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. Envie X-Workspace-Id para agir em um workspace diferente do padrão; veja Listar workspaces.

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. As que cabem na cota do plano ficam ACTIVE na hora. O restante fica em PENDING até o plano ter espaço.

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.