agent-onboarding-v2

post/v2/agent-onboarding

Request

  • Base URL: https://api.tracklysms.com/api
  • URL: https://api.tracklysms.com/api/v2/agent-onboarding
  • Auth: none required

Request body

emailstring required

Email to verify during browser signup

namestring required

Name of the new business account

Response

Inert enrollment intent created; no account, email or API key created

poll_tokenstring required

Status-only capability; never a login or sending credential

verification_urlstring required

Trackly page with a status capability in its fragment

Example response

{
  "onboarding": {
    "next_step": "complete_signup",
    "status": "pending"
  }
}

Changes

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