Skip to main content
POST
Connect a social account

Authorizations

Authorization
string
header
required

Prefix your API key with "Bearer ". Example: Authorization: Bearer sapi_key_...

Body

application/json

Platform and metadata

brand_id
string

BrandID optionally specifies which brand to attach the account to. If omitted, a new brand is auto-created.

Example:

"b_01HZ9X3Q4R5M6N7P8V2K0W1J"

metadata
object

Metadata contains platform-specific connection data

platform
string

Platform identifies the social platform to connect (e.g. instagram, facebook, google, threads, tiktok, linkedin).

Example:

"instagram"

redirect_uri
string

RedirectURI is the customer's URL to redirect the user to after OAuth completes. If you have registered redirect URIs in the dashboard, the value must match one of them. If you have none registered, any valid https URI is accepted. If omitted, the default HTML success page is shown.

Example:

"https://app.acme.com/oauth/done"

state
string

CustomerState is an opaque value echoed back to the customer's redirect URI. Max 512 chars.

Example:

"session_abc123"

Response

Account connected (direct auth)

account_id
string
Example:

"acc_01HZ9X3Q4R5M6N7P8V2K0W1J"

display_name
string
Example:

"Acme Corp"

platform
string
Example:

"instagram"

username
string
Example:

"acmecorp"