Create website

Parameters

This endpoint does not take path or query parameters.

Request body

• url (string, URL, required): Website URL.
• name (string, optional): Display name.
• keywords (string[], optional): Initial keyword values; each value can be up to 255 characters.
• description (string, optional, max 5000): Manual website description. When omitted, RedReplier can scrape or analyze the URL.

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

Initial keywords start as PENDING; keywords that fit the plan can become ACTIVE.

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.