ePost Digital Letterbox

Update the READ/UNREAD status for selected letters. The default status is READ.

post/epost/v2/letters/read

Request

  • Base URL: https://api.klara.ch
  • URL: https://api.klara.ch/epost/v2/letters/read
  • Auth: one of:
    • API key in header X-API-KEY
    • HTTP bearer

Request body

readStatus'READ' | 'UNREAD' required

Marked the given letters as READ/UNREAD status. Default is READ

letterIdsstring[] required

Letter ids

Example request

{
  "readStatus": "READ",
  "letterIds": [
    "65e7e536aae6544ca8dce48f",
    "65e7e4d2aae6544ca8dce485"
  ]
}

Response

Successful operation

processed_countinteger
skipped_countinteger
failed_countinteger

Changes

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