API ReferenceConnections

Create Partner Shared Connection

Beta
Shares a connection with another organization in the caller's partner account. The parent connection must belong to the partner owner organization, and the target child organization must belong to that same partner. The endpoint does not share arbitrary connections across unrelated organizations. If you need to check whether a shared copy already exists before creating one, call [`GET /api/organizations/{org_id}/connections/{connection_id}/shared`](../../../../../../api-reference/connections/list-shared-connections-for-partner) first.

Authentication

AuthorizationBearer
Bearer partner API key

Path parameters

org_idstringRequiredformat: "uuid"
Unique identifier of the organization that owns the parent connection.
connection_idstringRequiredformat: "uuid"
Unique identifier of the parent connection to share.

Headers

X-Polytomic-VersionstringRequired

Request

This endpoint expects an object.
child_organization_idstringRequiredformat: "uuid"
Unique identifier of the child organization that should receive the shared connection.
namestringOptional
Optional name for the shared copy. Defaults to the parent connection name.

Response

OK
dataobject

Errors

403
Forbidden Error
404
Not Found Error
500
Internal Server Error