API referencePOST

Add keywords

Add one or more keywords to a monitored website.

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

Add one or more keywords to a monitored website.

Bearer Token (RedReplier API token)

Parameters

  • websiteId (path, UUID, required): Website receiving keywords.

Request body

  • keywords (string[], required, non-empty): Keyword values to add; each value can be up to 255 characters.

Response

Returns one public Website object.

Website object

  • id (string): Website UUID.
  • accountGroupId (string): Account group resolved from the token.
  • domain (string): Normalized website domain.
  • url (string): Website URL.
  • name (string | null): Display name.
  • description (string | null): Context used for relevance scoring.
  • createdAt, updatedAt (ISO string | null): Creation and update timestamps in ISO 8601 format, or null.
  • keywords (Keyword[]): Keyword objects for this website.

Keyword object

  • id (string): Keyword UUID.
  • websiteId (string): Parent website UUID.
  • value (string): Keyword text, up to 255 characters.
  • status (string): PENDING, ACTIVE, DISABLED, or SUSPENDED.
  • createdAt, updatedAt (ISO string | null): Creation and update timestamps in ISO 8601 format, or null.

Notes

Adding keywords is separate from editing. New keywords are PENDING first and may auto-activate if plan capacity allows.

Errors

  • 400 Bad Request: Invalid input, URL, UUID, enum, query parameter, or body.
  • 401 Unauthorized: Missing or invalid Bearer token.
  • 404 Not Found: The resource does not exist for the token account.
  • 500 Internal Server Error: Unexpected server error.
Example request (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"
    }
  ]
}