Accounts
Create a connect session
Starts an OAuth flow for one profile and returns the URL to redirect your customer to.
Required permission: `connections:write`
Accepts `profileId` to target a specific profile. Omit it to use the key’s home profile.
POST
/v1/connect/sessionsconnections:writeRequest
Authorization
Send your API key as a Bearer token in the Authorization header.
Headers
Idempotency-KeystringoptionalA unique key so a retried request is not applied twice. Stored for 24 hours.
Request body
platformenumrequiredSocial platform identifier.
One of:facebookinstagram
profileIdstringoptionalProfile to act on. Defaults to the profile the API key was created in.
redirectUrlstringoptionalHTTPS URL to return the user to once they finish.
Response
Returns 201.
authUrlstringrequiredstatestringrequiredConnectSessionrequired
Errors
Failures use the standard error format.
| Status | Code | When it happens |
|---|---|---|
| 400 | invalid_request | The request body or query string failed validation. The message names the offending field. |
| 401 | invalid_api_key | The key does not exist, was revoked, or is malformed. Keys start with cdyn_live_. |
| 403 | profile_not_accessible | The requested profile is outside this key’s scope, or belongs to another account. |
| 429 | rate_limit_exceeded | Too many requests for this key. Honour the Retry-After header before retrying. |
| 500 | internal_error | Something failed on our side. Retry with the same Idempotency-Key; report the requestId if it persists. |