Skip to main content
POST
Connect one of my accounts

Authorizations

Authorization
string
header
required

Use JWT token for authentication

Headers

origin
string

Sent by the browser. Used to validate returnTo.

Path Parameters

app
string
required

App slug

Query Parameters

assistantId
string

Assistant this applies to. Send exactly one of assistantId or agentId.

agentId
string

Agent this applies to. Send exactly one of assistantId or agentId.

tenantId
string

End-user tenant. Ignored when the call carries a signed tenant session, which already names the tenant.

subtenantId
string

Subtenant within the tenant.

returnTo
string

Origin the OAuth popup posts its result back to. Must match the request origin.

Body

application/json
authScheme
string

Which scheme to connect through, from GET /:app/auth

Example:

"API_KEY"

accountFields
object

What this account supplies, keyed by the scheme's accountFields

Example:

Response

Success

connected
boolean
required

True when the account is connected already — API-key apps have nothing to authorise, so no browser is involved

authorizationUrl
string

Open this URL in a browser to authorise the account. Absent when connected is already true