v1

latestOpenAPI 3.1.02026-07-24770322.0 KB

Create App Connection

This endpoint creates an app connection for a manual app install. One of <b>companyId</b> or <b>clientIds</b> must be non-null, specifying the client(s)/company who will receive the specified content.

post/v1/installs/{installId}/connections

Path parameters

installIdstring required

The manual app install id to connect

Request body

companyIdstring

The company ID to create the connection for if creating a company membership type connection. Also required when creating individual or group connections where the specified clients belong to multiple companies

clientIdsstring[]

The client users to be included as members of the app connection if creating a group membership type connection. Client users must be part of same company.

typestring required

The type of connection to create, this will affect how clients view the connection within the workspace. One of: embed or link.

contentstring required

The content that should be seen by the members of the app connection. Can be a public URL or iframe.

Response

200

clientIdsstring[]

companyIdstring

contentstring

createdAtstring

idstring

installIdstring

membershipTypestring

objectstring

typestring

updatedAtstring

Example response

{
  "clientIds": [
    "57a675da-063c-4eed-8a04-214d91e4b2e8"
  ],
  "content": "https://embed-content.com",
  "createdAt": "2024-05-06T23:20:01.280062546Z",
  "id": "f298a3f6-d982-4032-a139-8194fb16a991",
  "installId": "21e21a4e-6bbb-47d0-a9bd-c4e99a3ca9a2",
  "membershipType": "group",
  "object": "appConnection",
  "type": "embed"
}