OnboardingStatus

Schema

Fields

· 13
id string required
status string · enum required

values

  • pending_activation
  • activated
  • live
  • expired
  • blocked
siteName string required
siteUrl string · uri required
activationSentTo string required
expiresAt string · date-time required
pollAfterSeconds integer

Present while pending_activation or activated.

dashboardUrl string · uri

Once live.

trial string · enum

Once live. active: the 7-day free trial is running. not_started_already_used: this address or Notion page already had a trial, so the site is on the Basic limits and needs a plan by planRequiredBy. none: no trial (a paid plan, or a lapsed subscription's grace window).

values

  • active
  • not_started_already_used
  • none
trialEndsAt string · date-time· nullable

Once live; null when no trial is running.

planRequiredBy string · date-time· nullable

Once live: when the site is archived unless a plan is picked; null on a paid plan.

pageTree object

Once live: progress of the page addresses.

blockedReason string · enum

When blocked: site_limit means the person's team is at its plan's site limit, so no site was created; they can upgrade in the dashboard.

values

  • site_limit
  • abuse

Used by

· 1 operation