Update a keyword

PATCH/api/v1/keywords/:id

Changes the match mode, what it tracks, or pauses and resumes it. The text itself cannot change: delete and create instead.

Request

Path parameters

idstring

Keyword id.

Body parameters

modestring

exact, proximity or broad.

activeboolean

false pauses the keyword; true resumes it (counts against your plan limit).

track_postsboolean

Match new posts.

track_commentsboolean

Match new comments. At least one of the two must stay true.

Response

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

Response fields

dataobject

The updated keyword.

curl -X PATCH https://redship.io/api/v1/keywords/5b2c7d1e-… \
-H "Authorization: Bearer rsp_your_key" \
-H "Content-Type: application/json" \
-d '{"mode":"exact","active":true}'

Success response200

{
"data": {
  "id": "5b2c7d1e-…",
  "text": "notion alternative",
  "mode": "exact",
  "active": true,
  "track_posts": true,
  "track_comments": true,
  "created_at": "2026-08-26T09:00:00+00:00",
  "updated_at": "2026-08-26T10:12:00+00:00"
}
}

Errors: 404 not_found, 422 invalid_body, 403 keyword_limit_reached when resuming would exceed the plan.