Skip to main content
POST
Start a connect flow

Path Parameters

platform
enum<string>
required

Supported platforms. tiktok is currently in App Review — connect requests return platform_not_enabled until approval lands.

Available options:
bluesky,
facebook,
instagram,
linkedin,
pinterest,
threads,
tiktok,
twitter

Body

application/json
profileId
string<uuid>

Land the resulting account in this profile. Falls back to the org's default profile when omitted.

Response

Connect descriptor.

Describes how to finish a connect for :platform. OAuth platforms return an authorizationUrl; Bluesky returns a form schema for the credentials surface.

platform
enum<string>
required

Supported platforms. tiktok is currently in App Review — connect requests return platform_not_enabled until approval lands.

Available options:
bluesky,
facebook,
instagram,
linkedin,
pinterest,
threads,
tiktok,
twitter
state
enum<string>
required

Platform enablement state. live is production-ready; trial connects but the upstream is sandboxed or rate-capped; pending rejects connect with platform_not_enabled.

Available options:
live,
trial,
pending
descriptor
object
required

Provider-specific connect descriptor — OAuth URL for OAuth platforms, form schema for credential platforms.