Brands

Trigger Brand SMS OTP

Changed on

Trigger or re-trigger an SMS OTP (One-Time Password) for Sole Proprietor brand verification.

Important Notes:

  • Only allowed for Sole Proprietor (SOLE_PROPRIETOR) brands
  • Triggers generation of a one-time password sent to the mobilePhone number in the brand's profile
  • Campaigns cannot be created until OTP verification is complete
  • US/CA numbers only for real OTPs; mock brands can use non-US/CA numbers for testing
  • Returns a referenceId that can be used to check OTP status via the GET /10dlc/brand/smsOtp/{referenceId} endpoint

Use Cases:

  • Initial OTP trigger after Sole Proprietor brand creation
  • Re-triggering OTP if the user didn't receive or needs a new code
post/10dlc/brand/{brandId}/smsOtp

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/10dlc/brand/{brandId}/smsOtp
  • Auth: HTTP bearer

Path parameters

brandIdstring required
Example:4b20019b-043a-78f8-0657-b3be3f4b4002

The Brand ID for which to trigger the OTP

Request body

pinSmsstring required

SMS message template to send the OTP. Must include @OTP_PIN@ placeholder which will be replaced with the actual PIN

successSmsstring required

SMS message to send upon successful OTP verification

Example request

{
  "pinSms": "Your PIN is @OTP_PIN@",
  "successSms": "Verification successful!"
}

Response

Successful Response

brandIdstring required

The Brand ID for which the OTP was triggered

referenceIdstring required

The reference ID that can be used to check OTP status

Example response

{
  "brandId": "4b20019b-043a-78f8-0657-b3be3f4b4002",
  "referenceId": "OTP4B2001"
}

Changes

  • 19db5ee4ec59Revision changes
    • breaking

      the // response's property type changed from integer to string, and format from int32 to no format for status

    • info

      added the optional property // to the response with the status

  • a6a61a29ecddRevision changes
    • breaking

      the // response's property type changed from string to integer, and format from no format to int32 for status

    • info

      added the optional property // to the response with the status