Disable keyword

Parameters

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

Request body

This endpoint does not require a JSON body.

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

Disabling stops monitoring immediately and does not consume the edit allowance. Disabling an active keyword frees its slot on the plan, so the oldest pending keyword that fits becomes active and starts monitoring.

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.