Projects
Events
Campaigns
Subscriptions
- PATCHBulk toggle the current contact’s subscription states
- GETList subscription types
- POSTCreate a subscription type
- GETGet a subscription type
- PATCHUpdate a subscription type
- POSTBulk toggle subscription states across many contacts
- GETList a contact’s subscription states
- PATCHBulk toggle a contact’s subscription states
Journeys
Templates
Contacts
API keys
Organisation
curl --request POST \
--url https://apix.spotzee.com/api/client/projects/{projectId}/onboarding-metadata \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"wants_consultation": false,
"marketing_emails": true
}
'{
"project_id": 42,
"wants_consultation": true,
"marketing_emails": true,
"created_at": "<string>",
"updated_at": "<string>",
"plans_shopify_woocommerce": true,
"industry": "ecommerce_retail",
"referral_source": "google_search"
}Submit project onboarding metadata
Records the onboarding survey for a project. Idempotent — repeated calls overwrite the existing record. The caller must have at least admin role on the organisation owning the project. Required after creating the first project so the dashboard can finalise first-run setup.
curl --request POST \
--url https://apix.spotzee.com/api/client/projects/{projectId}/onboarding-metadata \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"wants_consultation": false,
"marketing_emails": true
}
'{
"project_id": 42,
"wants_consultation": true,
"marketing_emails": true,
"created_at": "<string>",
"updated_at": "<string>",
"plans_shopify_woocommerce": true,
"industry": "ecommerce_retail",
"referral_source": "google_search"
}Documentation Index
Fetch the complete documentation index at: https://docs.spotzee.com/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Organisation-scoped admin API key (ok_…). Pass in the Authorization: Bearer <key> header. Used to manage projects and other organisation-level resources.
Path Parameters
Numeric project identifier.
42
Body
Submit (or replace) the onboarding survey for a project. Idempotent — repeated calls with the same project upsert the existing record.
Required. Set to true to request a setup consultation; false otherwise.
false
Required. Set to true to opt in to product marketing emails; false otherwise.
true
Self-reported intent to integrate with a popular ecommerce platform.
Self-reported industry classification for the organisation behind this project.
ecommerce_retail, saas_technology, marketing_agency, healthcare, education, financial_services, real_estate, hospitality_travel, manufacturing, media_entertainment, nonprofit, professional_services, other How the organisation discovered the platform.
google_search, social_media, linkedin, youtube, friend_referral, blog_article, podcast, newsletter, paid_ad, conference_event, other Response
The persisted onboarding metadata record.
Onboarding survey responses captured during a project’s first-run wizard.
Numeric project identifier this onboarding record belongs to.
42
When true, the organisation has requested a setup consultation.
When true, the organisation has opted in to receive product marketing emails.
Time the onboarding record was created. ISO 8601.
Time the onboarding record was last modified. ISO 8601.
Self-reported intent to integrate with a popular ecommerce platform.
Self-reported industry classification for the organisation behind this project.
ecommerce_retail, saas_technology, marketing_agency, healthcare, education, financial_services, real_estate, hospitality_travel, manufacturing, media_entertainment, nonprofit, professional_services, other How the organisation discovered the platform.
google_search, social_media, linkedin, youtube, friend_referral, blog_article, podcast, newsletter, paid_ad, conference_event, other Was this page helpful?