Skip to main content
POST
SDK

Authorizations

Authorization
string
header
required

Provide either a static platform API key or an OAuth2 access token (from /connect/v1/oauth/token) as Authorization: Bearer <token>. Scopes are connect:* (e.g. connect:bookings:write).

Path Parameters

operatorId
string
required

Operator id.

Body

application/json
supplierName
string
required
Example:

"Viking Cruises"

providerKey
string
Example:

"viking"

market
string
Example:

"US"

commercialClassification
enum<string>
default:private_external

Defaults to private_external. Network and native_network may only be set by trusted internal provisioning for eligible published operators.

Available options:
network,
native_network,
private_external
credentials
object

Provider-specific credentials, validated before activation.

metadata
object

Response

A connection.

id
string
required
operatorId
string
required
supplierName
string
required
status
enum<string>
required
Available options:
pending,
active,
paused,
errored
commercialClassification
enum<string>
required

Who owns and approves distribution for this connection. Set at creation (or via staff promote). Not inferred from the provider auth model.

Available options:
network,
native_network,
private_external
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
providerKey
string | null
providerRegistrationId
string | null
market
string | null
Example:

"US"

webhookSigningSecretLast4
string | null
metadata
object | null