AdeliAPI
Dashboard
Documentation menu
Connect

Start connection

Start a hosted OAuth connection and get the URL to send your customer to.

POSThttps://app.tryadeli.com/api/v1/profiles/{profileId}/connect
AuthorizationBearer <API key>How keys work

Body

platform"instagram" | "tiktok" | "facebook" | "youtube" | "x" | "bluesky"Required
X returns 402 x_billing_required until the workspace has a card on file; see X API pricing. WhatsApp and Google Business Profile are accepted by the schema but return 422 provider_not_supported. A business connects its WhatsApp number itself, through Embedded Signup on the dashboard's Accounts page.
redirectUrlstring
Where to send the browser when authorization finishes. Its origin must be allowlisted on the server, and it must use HTTPS unless the host is localhost or 127.0.0.1. Omit it to poll only.
authMethod"instagram_login" | "facebook_login"
Instagram only, and optional. instagram_login (the default) signs in on Instagram; facebook_login signs in with Facebook and connects the Instagram account linked to one of your customer's Pages. See Instagram login methods. Sending it with any other platform returns 400 invalid_request.
handlestring
Bluesky only, and optional: your customer's handle, such as alice.example.com, or their DID. The connect then starts at the server their account lives on. Leave it out for accounts hosted on Bluesky itself (*.bsky.social and most custom domains), which sign in at bsky.social. See Bluesky. Sending it with any other platform returns 400 invalid_request.

A successful start returns 201.

Instagram sessions also carry the authMethod they were started with.

Errors — 401 unauthorized, 400 invalid_request, 400 invalid_redirect_uri, 404 profile_not_found, 402 billing_required (past the workspace's free accounts with no card on file; see Billing), 409 auth_method_conflict, 422 provider_not_supported, 422 provider_not_configured, 502 database_error.