Skip to navigation
API ReferenceApps

Connect App

Starts signing an inbox in to an app. Returns a single-use magic_url, valid for five minutes, to open in the client that will hold the sign-in; the client enrolls as the inbox and continues to the app. A 404 names the missing resource: App or Inbox. A 403 AppSignupLimitError means the app accepts no more sign-ups from your organization; sign in with an inbox that already has an account there.

Authentication

AuthorizationBearer

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

Path parameters

app_idUUIDRequired
ID of app.

Request

This endpoint expects an optional object.
inbox_idstringOptional
Inbox to sign in as. Required unless the API key is scoped to an inbox.
accept_disclosurebooleanOptional

Accept the app's disclosure on the agent's behalf, skipping the first-use disclosure page. Requires app_share_owner when owner scopes are involved.

Response

This endpoint returns an object.
api_key_idstring
ID of api key.
magic_urlstring

Single-use URL to open in the client that will hold the key.

expires_atdatetime
Time at which api key expires. Omitted when it does not expire.

Errors

400
Validation Error
403
App Signup Limit Error
404
Not Found Error