Skip to main content
PATCH

Authorizations

Authorization
string
header
required

The tenant API key that POST /bootstrap returned.

Path Parameters

id
string
required

The app ID.

Body

application/json
delivery_mode
enum<string>

An empty string makes the app use the gateway default. Omit to keep the current mode.

Available options:
,
provisional,
always_push
managed_refresh_push
enum<string>

An empty string makes the app use the gateway default. Omit to keep the current setting.

Available options:
,
on,
off
name
string

The app's new name. An empty string removes the name, so log lines show the bundle ID. Omit to keep the current name.

Maximum string length: 64
vapid_subject
string

A web app's new mailto: or https: contact URI.

vapid_private_key_pem
string
write-only

Always refused with 400. A web app's key can't change.

Response

The updated app.

id
string
required
platform
enum<string>
required
Available options:
ios,
android,
web
bundle_id
string
required
delivery_mode
enum<string>
required

Empty when the app uses the gateway default.

Available options:
,
provisional,
always_push
managed_refresh_push
enum<string>
required

Empty when the app uses the gateway default.

Available options:
,
on,
off
created_at
string<date-time>
required
name
string

Absent when the app has no name.

apns_team_id
string
apns_key_id
string
apns_environment
enum<string>
Available options:
production,
sandbox
fcm_project_id
string
fcm_project_number
string
vapid_public_key
string

A web app's VAPID public key, in unpadded base64url. Browsers subscribe with it.

vapid_subject
string