Skip to main content
POST
Skip an onboarding step

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

Idempotency-Key
string

Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.

Required string length: 1 - 255
X-Test-Mode
enum<string>

Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.

Available options:
true,
false

Body

application/json
stepId
enum<string>
required

One of the nine canonical onboarding step ids (e.g. first_number_purchased).

Available options:
email_verified,
org_created,
org_named,
payment_method_added,
trial_credit_granted,
first_number_purchased,
first_message_sent,
first_contact_created,
first_agent_or_campaign_or_team_invite

Response

Echo payload in the standard { data, meta } envelope: data.stepId (the validated step id) and data.action ("skipped").

Echo payload in the standard { data, meta } envelope: data.stepId (the validated step id) and data.action ("skipped").