GTM - Onboarding

Bootstrap

Create onboarding + 8 touchpoints for a new customer. Idempotent.

post/api/v1/gtm/onboarding/bootstrap

Request

  • Base URL: https://api.gemstoneaiapp.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.gemstoneaiapp.com/api/v1/gtm/onboarding/bootstrap
  • Auth: none declared

Headers

x-admin-keystring nullable

Request body

dealer_customer_idstring required
prospect_idinteger nullable
plan_tierstring nullable
mrrnumber nullable

Response

Successful Response

idinteger required
dealer_customer_idstring required
prospect_idinteger nullable
onboarding_started_atstring date-time required
milestones_hitobject[]
onboarding_completed_atstring date-time nullable
churn_risk_scorenumber nullable
churn_risk_updated_atstring date-time nullable
plan_tierstring nullable
mrrstring nullable
nps_scoreinteger nullable
testimonial_statusstring nullable

Changes

No recorded changes to this operation across all 1 revision of this API.