API reference

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:write

Request

Authorization

Send your API key as a Bearer token in the Authorization header.

Headers

Idempotency-Keystringoptional

A unique key so a retried request is not applied twice. Stored for 24 hours.

Request body

platformenumrequired

Social platform identifier.

One of:facebookinstagram

profileIdstringoptional

Profile to act on. Defaults to the profile the API key was created in.

redirectUrlstringoptional

HTTPS URL to return the user to once they finish.

Response

Returns 201.

authUrlstringrequired
statestringrequired
ConnectSessionrequired

Errors

Failures use the standard error format.

StatusCodeWhen it happens
400invalid_requestThe request body or query string failed validation. The message names the offending field.
401invalid_api_keyThe key does not exist, was revoked, or is malformed. Keys start with cdyn_live_.
403profile_not_accessibleThe requested profile is outside this key’s scope, or belongs to another account.
429rate_limit_exceededToo many requests for this key. Honour the Retry-After header before retrying.
500internal_errorSomething failed on our side. Retry with the same Idempotency-Key; report the requestId if it persists.