Skip to main content
function linkSms(phoneNumber: string, options?: {
  idempotencyKey?: string;
}): Promise<{
  flowId: string;
  message: string;
}>;
Links a SMS account to the current user.

​
Parameters

ParameterTypeDescription
phoneNumberstringThe phone number to link.
options?{ idempotencyKey?: string; }Optional options for the link operation.
options.idempotencyKey?stringOptional idempotency key for safe retries.

​
Returns

Promise<{ flowId: string; message: string; }> The result of the link SMS initiation.