Skip to main content
POST
Request app installation

Body

application/json
appId
string
required
Pattern: ^pho_app_[0-7][0-9a-hjkmnp-tv-z]{25}$
clientAssertion
string
required
Required string length: 1 - 16384
redirectUri
string
required
Maximum string length: 4096
state
string
required
Maximum string length: 4096

Response

Installation request metadata. No customer credential or access is issued.

appId
string
required
Pattern: ^pho_app_[0-7][0-9a-hjkmnp-tv-z]{25}$
appVersion
string
required
Pattern: ^[1-9][0-9]*$
createdAt
string<date-time>
required
Example:

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

redirectUri
string
required
Maximum string length: 4096
requestId
string
required
Pattern: ^pho_air_[0-7][0-9a-hjkmnp-tv-z]{25}$
state
string
required
Maximum string length: 4096
{key}
any