RedShipRedShip| DOCUMENTATIONDashboard

Delete a keyword

DELETE/api/v1/keywords/:id

Stops matching right away and frees the slot on your plan. Past alerts for that keyword stay readable. Creating the same text again later restores it.

Request

Path parameters

idstring

Keyword id.

Response

Returns a JSON object with a data field containing the result.

Response fields

deletedboolean

Always true on success.

idstring

The deleted keyword id.

curl -X DELETE https://redship.io/api/v1/keywords/5b2c7d1e-… \
-H "Authorization: Bearer rsp_your_key"
Success response200
{ "deleted": true, "id": "5b2c7d1e-…" }