v1

latestOpenAPI 3.1.0Apache 2.02026-07-24113269342.0 KB

Interview

Send SMS with the link for onboarding

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

post/omni/external/send-sms

idstring required

Id of onboarding session for which link is being generated.

api-versionstring required

smsTextstring

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

clientIdstring required

shortUrlboolean

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

uuidstring

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

{
  "smsText": "Here is the link to finish onboarding {0}",
  "clientId": "incode",
  "queryParams": {
    "lang": "lang"
  }
}

successboolean

Flag indicating request passed successfully.

sessionStatus'Alive' | 'Closed' | 'Deleted'

Session status