In App Messages

In-app notifications and announcements.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

typestring · enumOptionalPossible values:

Responses

200Success

No content

get/in-app-messages

GET /apis/v2/in-app-messages HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

No content

patch

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

Body

lastReadstring · date-time · nullableRequired

Responses

200Success

No content

patch/in-app-messages/{id}

PATCH /apis/v2/in-app-messages/{id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "lastRead": "2026-01-01T00:00:00.000Z"
}

200Success

No content