Referência da APIPATCH

Atualizar site

Atualiza o nome de exibição ou a descrição usada na pontuação de relevância.

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

Atualiza o nome de exibição ou a descrição usada na pontuação de relevância.

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 a ser atualizado.

Corpo da requisição

  • name (string, opcional): Novo nome de exibição.
  • description (string, opcional, máximo 5000): Nova descrição usada na pontuação de relevância.

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 PATCH https://ai.redreplier.com/ai-app/api/v1/websites/11111111-1111-4111-8111-111111111111 \
  -H 'Authorization: Bearer redreplier_test_1234567890' \
  -H 'Content-Type: application/json' \
  -d '{"name":"Acme CRM","description":"CRM and client portal for B2B agencies."}'

Notas

Mantenha a descrição precisa; ela afeta a pontuação de relevância de IA.

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/websites/9b0f2b8d-4a76-4f59-9f0b-6b4b6f6c2a10 \
  --header 'Authorization: Bearer redreplier_test_1234567890' \
  --header 'Content-Type: application/json' \
  --data '{"name": "Acme CRM","description": "CRM for small agencies that need pipeline tracking and follow-up reminders."}'
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"
    }
  ]
}