OrgsSDK Invites
updateSdkInvite
Update an SDK invite's onboarding settings, such as its display name, enabled state, expiration time, quota, or site association.
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
SDK invite configuration used to onboard mobile SDK clients to an organization
enabled?boolean
Whether the SDK invite can currently be used
Default
trueexpire_time?integer
Expiration time for the SDK invite, in epoch seconds
name*string
Display name shown for the SDK invite in the mobile experience
quota?integer
Number of times this SDK invite can be used
quota_limited?boolean
Whether use of the SDK invite is limited by the quota value
Default
falseResponse Body
curl -X PUT "https://example.com/api/v1/orgs/000000ab-00ab-00ab-00ab-0000000000ab/sdkinvites/000000ab-00ab-00ab-00ab-0000000000ab" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{ "created_time": 1428954000, "enabled": true, "expire_time": 1428954000, "id": "5034b980-b49e-501c-66e0-9de4c38f18a2", "name": "Macy's", "quota": -1}