Skip to main content
POST
social.account.connect.status

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
ref
string
required

The ref returned by social.account.connect.start.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
flow
string

The flow value from the connect redirect, when the person came back with one: the result then says whether a choice is still needed and which.

Required string length: 1 - 16384

Response

The result

status
enum<string>
required

pending until the person finishes signing in; then connected.

Available options:
pending,
connected
accounts
object[]
required

Accounts connected since the flow started. Empty while pending.

needsSelection
boolean

True when the connection is holding for a choice (a page, organization, board, location, profile or phone number). Present when the call passes flow.

selection
string

Which choice the connection is waiting for: page, account, organization, board, location, profile or phone_number.