OrgsSDK Invites
sendSdkInviteSms
Send the SDK invite to a phone number by SMS so the recipient can onboard a mobile SDK client.
Authorization<token>
Preferred authentication method for automation and integrations. Send the API token in the HTTP Authorization header.
Format:
Authorization: Token {apitoken}
Notes:
- An API token generated for a specific admin has the same privileges as that admin
- An API token is automatically removed if it is not used for more than 90 days
- SSO admins cannot generate admin API tokens. Use organization API tokens when scoped Org/Site privileges are needed.
In: header
Path Parameters
org_id*string
Format
uuidsdkinvite_id*string
Format
uuidRequest Body
application/json
Request Body
Request body for sending an SDK invite by SMS
number*string
Destination phone number for the SDK invite SMS
Response Body
curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/sdkinvites/000000ab-00ab-00ab-00ab-0000000000ab/sms" \ -H "Content-Type: application/json" \ -d '{ "number": "14081234567" }'Empty
sendSdkInviteEmail POST
Send the SDK invite to a recipient email address so the recipient can onboard a mobile SDK client.
listSdkTemplates GET
List SDK templates configured for the organization. SDK templates define visual customization for the mobile SDK experience, including branding images, colors, header text, and welcome messages.