Skip to main content
PATCH
Update App Installation

Yetkilendirmeler

Authorization
string
header
gerekli

An App API key. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

developer:app_installation:update

Başlıklar

Api-Version-Date
string

Pins the request to a dated API version.

Örnek:

"2026-11-17"

Yol Parametreleri

id
string
gerekli

App installation ID, prefixed aag_.

Gövde

application/json
external_id
string | null

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.

Örnek:

"acme-store"

metadata
object

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.

Örnek:

Yanıt

app installation updated

account
object
gerekli

Account the app is installed on.

app
object
gerekli

App that is installed.

created_at
string
gerekli

When the app was first installed on the account, as an ISO 8601 timestamp. Installing the app again later keeps the original time.

Örnek:

"2026-01-01T12:00:00.000Z"

external_id
string | null
gerekli

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.

Örnek:

"acme-books"

id
string
gerekli

App installation ID, prefixed aag_.

Örnek:

"aag_xxxxxxxxxxxxxx"

metadata
object | null
gerekli

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.

Örnek:
requesting_reauthorization
boolean
gerekli

Whether the app now asks for permissions the account hasn't approved yet.

Örnek:

false

updated_at
string
gerekli

When the installation last changed, such as a metadata update or the account changing the app's permissions, as an ISO 8601 timestamp.

Örnek:

"2026-01-01T12:00:00.000Z"