Send SMS with the link for onboarding

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

id

string

required

Id of onboarding session for which link is being generated.

smsText

string

length between 0 and 160

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

clientId

string

required

length ≥ 1

shortUrl

boolean

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

truefalse

queryParams

object

Additional onboarding url query params allowed: lang

queryParamsobject

uuid

string

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

api-version

string

required

Defaults to 1.0

``200 OK

``400 Custom error status: - 4004: Could not find user

Updated 3 months ago

ShellNodeRubyPHPPython


xxxxxxxxxx

curl --request POST \

--url https://demo-api.incodesmile.com/omni/external/send-sms \

--header 'accept: application/json' \

--header 'api-version: 1.0' \

--header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200400

Updated3 months ago