metadata and external_id your app keeps on it. An account can also list the apps installed on it, and a developer every installation of their app. Only the app and its developer see metadata and external_id, and only the app can change them.
Endpoints
Attributes
string
required
App installation ID, prefixed
aag_.object
required
object
required
App that is installed.
Properties
Properties
string
required
App ID, prefixed
app_.object
required
object
required
App icon. Falls back to the default app icon when none is uploaded.
Properties
Properties
string
required
Icon image URL. Always present — the default app icon when none is uploaded.
string
required
App display name.
string
required
When the app was first installed on the account, as an ISO 8601 timestamp.
Installing the app again later keeps the original time.
string | null
required
Your app’s own identifier for this installation, such as the ID of the linked
account in another system, or
null when none is set. At most 255 characters
and unique across your app’s installations, so you can find an installation
with GET /app_installations?external_id=; setting one another installation
already has returns a 409. Only the app and its developer see it; for the
account the app is installed on it is always null.object | null
required
String keys and values your app stores about this installation, such as a sync
cursor or the ID of the linked account in another system. Empty until your app
sets a key, and kept if the account removes the app and installs it again. At
most 50 keys; keys are at most 100 characters and values at most 500. Only the
app can change it. Only the app and its developer see it; for the account the
app is installed on it is always
null.boolean
required
Whether the app now asks for permissions the account hasn’t approved yet.
string
required
When the installation last changed, such as a
metadata update or the account
changing the app’s permissions, as an ISO 8601 timestamp.AppInstallation