Execute one explicit retry-safe onboarding action for the selected product.

Sends target only the authorizing user's verified signup address. Journeys stay inactive and Broadcasts stay unsent. Existing migration approval boundaries apply.

post/v1/workspaces/{workspaceId}/onboarding/guided

Request

  • Base URL: https://api.bangermail.com
  • URL: https://api.bangermail.com/v1/workspaces/{workspaceId}/onboarding/guided
  • Auth: HTTP bearer

Request body

action'begin_guidance' | 'save_business' | 'discover_brand' | 'skip_business' | 'choose_identity' | 'defer_identity' | 'skip_domain' | 'choose_delivery' | 'setup_receiving' | 'defer_receiving' | 'setup_sending' | 'dns_applied' | 'verify_dns' | 'continue_domain' | 'add_inboxes' | 'skip_inboxes' | 'finish_for_now' | 'finish' required
dataobject

Business fields company_name, primary_goal, website_url and brand; draft fields name, subject, preview_text, body_text and edit; identity fields domain and local_part. Recipient input is never accepted.

Response

Refreshed canonical state after the requested operation.

Changes

No recorded changes to this operation across all 2 revisions of this API.