API reference

Notices

2 operations, generated from the OpenAPI document.

Service notices (Terms, privacy, price and plan changes) the caller hasn't dismissed

GET /api/me/notices

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Responses

  • 200 Success
    • notices array of object required
      • id string (uuid) required
      • kind "terms" | "privacy" | "price" | "plan" | "service" required
      • title string required
      • summary string required
      • url string (uri) required
      • effectiveAt string (date-time) required
      • publishedAt string (date-time) required
  • 401 Not signed in
  • 429 Too many requests: a rate limit was reached (see Retry-After)

Dismiss a service notice's banner for the caller

POST /api/me/notices/{noticeId}/dismiss

Access: any signed-in user, for their own data; signed-in session only (no personal access tokens).

Parameters

NameInTypeRequired
noticeIdpathstring (uuid)yes

Responses

  • 204 Success, no content
  • 401 Not signed in
  • 429 Too many requests: a rate limit was reached (see Retry-After)