Update App Installation
Updates the metadata and external_id your app keeps on an installation. Only the metadata keys you send change, so separate jobs can each keep their own keys.
Authorizations
An App API key. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Headers
Pins the request to a dated API version.
"2026-10-15-1"
Path Parameters
App installation ID, prefixed aag_.
Body
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.
"acme-store"
Metadata keys to set, as string values. A key set to null is removed and keys you leave out don't change; an empty object clears every key. At most 50 keys; keys are at most 100 characters and values at most 500.
Response
app installation updated
Account the app is installed on.
App that is installed.
When the app was first installed on the account, as an ISO 8601 timestamp. Installing the app again later keeps the original time.
"2026-01-01T12:00:00.000Z"
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.
"acme-books"
App installation ID, prefixed aag_.
"aag_xxxxxxxxxxxxxx"
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.
Whether the app now asks for permissions the account hasn't approved yet.
false
When the installation last changed, such as a metadata update or the account changing the app's permissions, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"

