Send SMS with the link for onboarding

Used by Admins or Executives to send SMS containing generated onboarding link.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
required

Id of onboarding session for which link is being generated.

Body Params
string
length between 0 and 160

Text to be shown with URL. Needs to have {0} placeholder inside for URL.

string
required
length ≥ 1
boolean

Indicates whether the link should be shortened. If set to true, the link will be converted to a shortened version.

queryParams
object

Additional onboarding url query params allowed: lang

string

Optional UUID to be reused for linking the onboarding session. If not provided or invalid, a new one will be generated.

Headers
string
required
Defaults to 1.0
Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json