Skip to Content
API ReferencePATCH Update Inbox Item
PATCH/api/v1/inbox/:id

Update the state of an inbox item. All fields in the request body are optional.

Parameters

NameTypeRequiredDescription
idstringYesThe inbox item UUID (path parameter)
is_readbooleanNoMark as read or unread
is_savedbooleanNoSave or unsave the item
is_declinedbooleanNoDecline (hide) the item

Example request

curl -X PATCH \
-H "Authorization: Bearer rsp_your_key" \
-H "Content-Type: application/json" \
-d '{"is_read": true, "is_saved": true}' \
"https://redship.io/api/v1/inbox/550e8400-e29b-41d4-a716-446655440000"

Response

200
{
"data": {
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "post_title": "Looking for a tool to automate Reddit outreach",
  "is_read": true,
  "is_saved": true,
  "is_declined": false,
  "read_at": "2024-01-15T12:00:00Z",
  "created_at": "2024-01-15T10:30:00Z"
}
}
Last updated on