Used by Admins or Executives to send SMS containing generated onboarding link.
API reference, Interview
Send SMS with the link for onboarding
POST
https://demo-api.incodesmile.com/omni/external/send-smsQuery parameters
Id of onboarding session for which link is being generated.
Headers
Request body
application/json
Text to be shown with URL. Needs to have {0} placeholder inside for URL.
Indicates whether the link should be shortened. If set to true, the link will be converted to a shortened version.
Additional onboarding url query params allowed: lang
Optional UUID to be reused for linking the onboarding session. If not provided or invalid, a new one will be generated.
Responses
Response body (application/json)
Flag indicating request passed successfully.
Session status
enum
AliveClosedDeletedResponse body (application/json)
UTC timestamp in milliseconds
Custom error code or HTTP status code
HTTP status error
Custom error message
Endpoint path
Custom error details