Skip to main content
POST
Connect an EmailOctopus audience account

Authorizations

Authorization
string
header
required

Dashboard access token. Send as Authorization: Bearer .

Headers

X-Whitelabel-Slug
string

Optional tenant context for admin-key operations without an organization target, such as creating an organization. Defaults to the master tenant. Must match an explicit target organization when both are supplied. Does not limit the key’s platform authority.

Required string length: 1 - 100
X-Organization-Id
string<uuid>

Target organization for admin-key requests on organization-context routes, including Data API, intent audiences and dashboard routes without an organization path parameter. Required on those routes. When supplied with an organization path parameter, both must identify the same organization; conflicting targets return 400. Does not grant access to customer credentials.

Body

application/json
apiKey
string
required

Private EmailOctopus API key; stored encrypted and never returned.

Required string length: 10 - 500
Example:

"synthetic-emailoctopus-key"

connectedAccountId
string<uuid>

Existing account in this organization whose authorization should be replaced.

Example:

"66666666-6666-4666-8666-666666666666"

Response

Connected native account

data
object
required
meta
object
required