---
title: "Send SMS with the link for onboarding"
method: POST
path: "/omni/external/send-sms"
tags: ["Interview"]
---

# Send SMS with the link for onboarding

`POST /omni/external/send-sms`

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

## Query parameters

- `id` string, required

## Headers

- `api-version` string, required

## Request body

- SendExternalSmsRequest
  - `smsText` string — Text to be shown with URL. Needs to have {0} placeholder inside for URL.
  - `clientId` string, required
  - `shortUrl` boolean — Indicates whether the link should be shortened. If set to true, the link will be converted to a shortened version.
  - `queryParams` SendSmsExternalUrlParams
    - `lang` string
  - `uuid` string — Optional UUID to be reused for linking the onboarding session. If not provided or invalid, a new one will be generated.

## Response `200`

OK

- BasicResponse
  - `success` boolean — Flag indicating request passed successfully.
  - `sessionStatus` 'Alive' | 'Closed' | 'Deleted' — Session status

## Other responses

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

---

[API](https://skmtc.net/incode/apis/incode-omni-api.md) · [All operations](https://skmtc.net/incode/apis/incode-omni-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/incode/incode-omni-api/versions/30cd6d926ea3/schema)