relay-inbox

Star/Unstar Inbox Email

Set the starred (pin) state of an owned inbox email. starred: true stamps starredAt = now; starred: false clears it. Scoped to the user's own relay rows.

patch/relay-inbox/{id}/star

Request

  • Base URL: https://api.aiapplyd.com/api/v1
  • URL: https://api.aiapplyd.com/api/v1/relay-inbox/{id}/star
  • Auth: HTTP bearer

Path parameters

idstring required

synced_email row id (the inbox message)

Example:1

Request body

starredboolean required

true → star/pin (stamp starredAt = now); false → unstar (clear starredAt).

Example request

{
  "starred": true
}

Response

Star state updated

successtrue required

Example response

{
  "data": {
    "id": 9001
  },
  "meta": {
    "duration": 150,
    "requestId": "req_abc123",
    "timestamp": "2026-10-13T10:27:20.268Z",
    "version": "v1"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.