API referenceDEL

Delete keyword

Permanently delete a keyword in any status, together with every mention it produced.

DELETEhttps://ai.redreplier.com/ai-app/api/v1/keywords/{keywordId}

Permanently delete a keyword in any status, together with every mention it produced.

Bearer Token (RedReplier API token)

Parameters

  • keywordId (path, UUID, required): Keyword to delete, in any status.

Request body

This endpoint does not require a JSON body.

Response

Returns a deletion confirmation.

  • deleted (boolean): Always true when the delete operation succeeds.

Notes

Permanent: the keyword and every mention it produced are deleted, whatever its status. Deleting an active keyword frees its slot on the plan, and the oldest pending keyword that fits then becomes active and starts monitoring. To stop monitoring and keep the mentions, use Disable keyword instead.

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.
Example request (curl)
curl --request DELETE \
  --url https://ai.redreplier.com/ai-app/api/v1/keywords/73a3c9b6-3e5f-4a53-a2c6-70c5ef7f2f6d \
  --header 'Authorization: Bearer redreplier_test_1234567890'
200
{
  "deleted": true
}