Skip to main content
POST
Create a connection

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
application_id
string<uuid>
required

The application to connect.

Example:

"4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a"

name
string
required

The connection's display name.

Example:

"Work Gmail"

description
string | null

What the connection is for.

Example:

"The support inbox."

tags
string[]

Labels given to the connection.

Example:
type
enum<string>

private connections are usable by their owner only; shared ones by the whole organization. Defaults to private.

Available options:
private,
shared
Example:

"private"

Response

Created

data
object
required