Deactivate a Connect Connection

Deactivates an active Connect Connection. This action prevents further access through the connection but maintains the connection record. Only active connections can be deactivated.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

connection-idstringRequired
ID of the connect connection

Headers

Key-InflectionenumOptional
Determines casing for the API response.
Allowed values:
Idempotency-KeystringOptional
Ensures the request is idempotent.
Persona-VersionenumOptionalDefaults to 2023-01-05
Allowed values:

Response

This endpoint returns a Connect Connection.
dataobject
A Connect Connection object. This object represents a connection between organizations for sharing access to Persona objects.

Errors