Skip to main content
POST
Create an app install connection

Authorizations

X-API-KEY
string
header
required

Path Parameters

installId
string
required

Unique identifier of the manual app install

Body

application/json

Connection to create

content
string
required

Content is the embed code (for embed connections) or the destination URL (for link connections).

Example:

"https://app.example.com/embed"

type
enum<string>
required

Type is the kind of connection to create.

Available options:
embed,
link
Example:

"link"

autoSizeEmbed
boolean

AutoSizeEmbed controls whether an embed connection auto-sizes its iframe; defaults to true.

Example:

true

clientIds
string[]

ClientIDs are the clients the connection should be scoped to; all must belong to the same company.

Example:
companyId
string<uuid>

CompanyID scopes the connection to a company; required when no clients are provided.

Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

membershipType
enum<string>

MembershipType overrides how the connection's membership is interpreted (individual, group, or company).

Available options:
individual,
group,
company
Example:

"company"

Response

OK

clientIds
string[] | null

external facing root fields

companyId
string | null
content
string
createdAt
string
creatorId
string
data
string
domainMetadata
object
id
string
identityId
string
installId
string
membershipType
enum<string>
Available options:
individual,
group,
company
object
string
previousAttributes
object
ref
string
type
enum<string>
Available options:
embed,
link
updatedAt
string