createSdkInvite
Create an SDK invite that mobile SDK clients can use to onboard into the organization. The invite can be enabled or disabled, limited by usage quota, and associated with a site.
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
uuidRequest Body
application/json
Request Body
SDK invite configuration used to onboard mobile SDK clients to an organization
Whether the SDK invite can currently be used
trueExpiration time for the SDK invite, in epoch seconds
Display name shown for the SDK invite in the mobile experience
Number of times this SDK invite can be used
Whether use of the SDK invite is limited by the quota value
falseResponse Body
curl -X POST "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/sdkinvites" \ -H "Content-Type: application/json" \ -d '{ "enabled": true, "name": "string", "quota": 0, "quota_limited": true }'{ "created_time": 1428954000, "enabled": true, "expire_time": 1428954000, "id": "5034b980-b49e-501c-66e0-9de4c38f18a2", "name": "Macy's", "quota": -1}listSdkInvites GET
List SDK invites configured for the organization. SDK invites are used to onboard mobile SDK clients and can define whether an invite is enabled, limited by usage quota, or scoped to a site.
getSdkInvite GET
Return the configuration and status of an SDK invite, including enablement, expiration time, usage quota, and site scope.