Deactivate a Connection
Deactivates a Connection. Either the source or destination organization may deactivate a connection that is currently pending or active. Deactivation prevents further access through the connection but maintains the connection record. Connections that are already inactive cannot be deactivated again.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
connection-id
ID of the connect connection
Headers
Key-Inflection
Determines casing for the API response.
Allowed values:
Idempotency-Key
Ensures the request is idempotent.
Persona-Version
Server API version. More info on versioning can be found [here](https://docs.withpersona.com/versioning).
Response headers
RateLimit-Limit
The maximum number of requests permitted in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response.
RateLimit-Remaining
The number of requests remaining in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response.
RateLimit-Reset
The number of seconds until the current rate limit window resets. Returned on every authenticated response.
Request-Id
The unique identifier of the API log entry that recorded this request. Starts with req_. Include this value when reaching out to Persona support. Present on every authenticated response, including error responses.
Persona-Environment-Id
The token of the Persona environment that handled the request. Returned on every authenticated response, including most error responses.
Persona-Organization-Id
The token of the Persona organization that handled the request. Returned on every authenticated response, including most error responses.
Response
This endpoint returns a Connection.
data
A Connect Connection object.
This object represents a connection between organizations for sharing access to Persona objects.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error