Platform API reference

Platform API · Me

put/v1/me/hidden-guides/{key}Auth

Hide a getting-started guide for the caller.

Idempotent: hiding a guide that is already hidden returns it unchanged, with its first `hidden_at`. At most 200 are kept; hiding one more drops the oldest.

Path parameters

key*string

The guide: a surface name, optionally followed by `:` and a resource id, e.g. `dashboard:<workspace id>` or `all`.

Response · 200 The guide is hidden.

key*string

The guide: a surface name, optionally followed by `:` and the id of the resource the guide belongs to. The console uses `dashboard:<workspace id>`, `auth_app:<app id>`, `waitlist_quickstart:<waitlist id>`, `waitlist_steps:<workspace id>`, `community_quickstart:<community id>`, `trawl_quickstart:<workspace id>`, `flags_quickstart:<workspace id>`, `notify_quickstart:<workspace id>`, `mail_quickstart:<workspace id>`, and `all` for "never show getting-started guides".

Example: "auth_app:3f2c9a4e-8b1d-4c6e-9f2a-1b2c3d4e5f60"

hidden_at*string · date-time

When the guide was first hidden.

Example

Request

PUT https://api.platform-auth.productcraft.co/v1/me/hidden-guides/{key}
Authorization: Bearer YOUR_TOKEN

Response

{
  "key": "auth_app:3f2c9a4e-8b1d-4c6e-9f2a-1b2c3d4e5f60",
  "hidden_at": "2026-01-01T00:00:00.000Z"
}