Skip to main content

Partner Onboarding

Goal​

Onboard an external user from a partner system and get tenant-scoped readiness for messaging flows.

Required scope​

partner:onboard

Core endpoints​

  • POST /api/thirdparty/v1/partner/onboard
  • GET /api/thirdparty/v1/partner/onboard/status/{externalUserId}

Example flow​

  1. Create partner app and sandbox credential in partners.nautix.io
  2. Call onboard endpoint with your external user details
  3. Poll status endpoint until onboarding state is complete
  4. Continue to template and webhook setup