Skip to main content
POST
The caller's holding of one platform as it stands: whether Dally holds a live connection, which permissions are missing, the account's handle, and the rows of its first sync while they land. The connect card asks this after the person leaves for the platform and while the sync runs; it opens no authorization and paints nothing.

Authorizations

Authorization
string
header
required

A WorkOS-dashboard-issued internal API key on Authorization: Bearer.

Body

application/json
platform
enum<string>
required

The platform a row belongs to. v1 supports instagram; more platforms will be added to this enum additively — treat unknown values as new platforms, never as errors.

Available options:
instagram

Response

Success. request_id is present on every response.

platform
enum<string>
required

The platform a row belongs to. v1 supports instagram; more platforms will be added to this enum additively — treat unknown values as new platforms, never as errors.

Available options:
instagram
state
enum<string>
required

absent when this room has never connected the platform, connected while Dally holds a live connection, degraded when the connection stands but a permission was withheld, invalid when every connection this room opened is dead.

Available options:
absent,
connected,
degraded,
invalid
connected
boolean
required

Whether Dally holds a live connection right now.

handle
string | null
required

The connected account's handle, for display only; null when nothing is connected or the platform never named one.

missing_permissions
string[]
required

The permissions the platform withheld, named as the person will recognize them; empty unless the state is degraded.

sync
object[] | null
required

The five rows of this account's first sync, in the order the card prints them; null when nothing is connected or the sync cannot be read.

request_id
string
required

Server-minted id for this request. Present on every response, success and error — quote it when reporting a problem.

Minimum string length: 1