Accounts

Connect destinations from an operator-installed connector

post/accounts/connectors/{installation_id}/connections

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/accounts/connectors/{installation_id}/connections
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Path parameters

installation_idstring required

Operator connector installation ID

Request body

$schemastring uri

A URL to the JSON Schema for this object.

workspace_idstring required

Workspace receiving the connected destinations

Example request

{
  "$schema": "https://example.com/api/v1/schemas/ConnectConnectorInputBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

account_idstring required

OpenPost destination account ID

account_idsstring[] nullable required

All connected OpenPost account IDs

open_fresh_composerboolean required

Whether this is the Workspace's first connected destination

workspace_idstring required

Workspace receiving the connected destination

Example response

{
  "$schema": "https://example.com/api/v1/schemas/AccountConnectionResponse.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.