Skip to main content
GET
Custom-hostname onboarding nudge

Authorizations

X-API-Key
string
header
required

Query Parameters

organization_id
string<shortuuid>

Organization to act on. Omit it: an API key acts on its own organization, and a session or OAuth caller on its single organization. Required only for a session or OAuth caller that belongs to more than one organization (400 without it).

Required string length: 22
Pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$

Response

OK

Whether to surface the custom-hostname recommendation.

headline
string | null

Short nudge headline, or null when not recommended.

rationale
string | null

Why a custom hostname matters, or null.

exit_story
string | null

The anti-lock-in framing, or null.