Profile Groups

Initialize connection

Generates a URL to connect a new social media profile to a profile group via OAuth. Bluesky uses an app-password flow and Telegram uses a bring-your-own-bot flow; both authenticate synchronously and create the profile in one call.

post/api/profile_groups/{id}/initialize_connection

Request

  • Base URL
    https://api.postproxy.dev
  • URL
    https://api.postproxy.dev/api/profile_groups/{id}/initialize_connection
  • Auth
    HTTP bearer

Path parameters

idstring required

Profile group id

Query parameters

profile_group_idstring

Profile group context for the request. Optional when the API key is scoped to a profile group (that group is used automatically); with a full-access key, defaults to the first profile group in the account.

Headers

Idempotency-Keystring

Optional idempotency key (up to 255 characters; a UUID is ideal). Retrying a successful write with the same key replays the original response (with an Idempotent-Replay: true header) instead of executing again. Stored responses are kept for 24 hours; only 2xx responses are stored.

Request body

platform'facebook' | 'instagram' | 'tiktok' | 'linkedin' | 'youtube' | 'twitter' | 'threads' | 'pinterest' | 'bluesky' | 'telegram' | 'whatsapp' required

Platform to connect.

redirect_urlstring

URL to redirect to after OAuth completes. Required for all platforms except bluesky and telegram.

refresh_connectionboolean

Re-authorize a profile already connected to this group, to renew tokens or re-pick pages. Skips the already-connected check for that platform: the same account is updated in place, a different account is still rejected with account_is_already_connected.

identifierstring

Bluesky handle (e.g. yourname.bsky.social). Required for bluesky. The .bsky.social suffix is added automatically if missing; custom domains are accepted as-is.

app_passwordstring

Bluesky app password, not the account password. Required for bluesky. Generate at https://bsky.app/settings/app-passwords.

bot_tokenstring

Telegram bot token from @BotFather. Required for telegram.

onboarding'instagram' | 'facebook' | 'business_app' | 'api'

Optional, whatsapp and instagram only. instagram: which login to use — "instagram" (default) for Instagram Login, or "facebook" for Facebook Login, for an account linked to a Facebook Page the user manages. whatsapp: where the number lives — "business_app" for coexistence with the WhatsApp Business app, or "api" for a number already on the Cloud API or a fresh API-only number. Omit it and the connect page asks the user.

Response

Connection URL (OAuth platforms) or the created profile (bluesky, telegram)

OR

Changes

No recorded changes to this operation across all 1 revision of this API.