Skip to main content
POST
Create Or Update Apple

Authorizations

X-EntityToken
string
header
required

This API requires an Entity Session Token, available from the Entity GetEntityToken method.

Body

application/json
AppBundleId
string
required

iOS App Bundle ID obtained after setting up your app in the App Store.

AllowProduction
boolean

Allow validation of receipts from the Apple production environment. Required for app releases.

AllowSandbox
boolean

Allow validation of receipts from the Apple sandbox environment. Typically used while testing.

AppId
string

AppId obtained after setting up your app in the App Store.

AppSharedSecret
string

iOS App Shared Secret obtained after setting up your app in the App Store.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Entity
object

The optional entity to perform this action on. Defaults to the currently logged in entity.

ErrorIfExists
boolean

If an error should be returned if the addon already exists.

IgnoreExpirationDate
boolean

Ignore expiration date for identity tokens. Be aware that when set to true this can invalidate expired tokens in the case where Apple rotates their signing keys.

IssuerId
string

IssuerId obtained after setting up your app in the App Store.

KeyId
string

KeyId obtained after setting up your app in the App Store.

PrivateKey
string

PrivateKey obtained after setting up your app in the App Store.

RequireSecureAuthentication
boolean

Require secure authentication only for this app.

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Last modified on October 2, 2026