Edit keyword

Parameters

• keywordId (path, UUID, required): Keyword to edit.

Request body

• value (string, required, max 255): New keyword text.

Response

Returns one public 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

Edits are unlimited and keep any paid slot the keyword already holds: an ACTIVE keyword stays ACTIVE, and any other keyword becomes ACTIVE when the plan has a free slot, otherwise PENDING. A change that only alters letter case is a no-op, and a value that duplicates another keyword on the same website returns 400. Editing a SUSPENDED keyword is the normal way to fix noisy terms.

Errors

• 400 Bad Request: Invalid input, URL, UUID, enum, query parameter, or body.
• 401 Unauthorized: Missing or invalid Bearer token, or code: "token_issuer_lost_access" when the person who created the API key was deactivated or left the workspace.
• 403 Forbidden: code: "subscription_required" when the workspace plan does not include API access, code: "workspace_access_denied" when X-Workspace-Id names a workspace this credential cannot reach, or code: "permission_denied" when your role in the workspace does not hold redreplier.write (Admin and Editor hold it).
• 404 Not Found: The resource does not exist for the token account.
• 429 Too Many Requests: Rate limit exceeded. Wait the seconds in Retry-After.
• 500 Internal Server Error: Unexpected server error.