connect

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.

post/connect/connections/{connection-id}/deactivate

Request

  • Base URL: https://api.withpersona.com/api/v1
  • URL: https://api.withpersona.com/api/v1/connect/connections/{connection-id}/deactivate
  • Auth: HTTP bearer

Path parameters

connection-idstring required

ID of the connect connection

Headers

Key-Inflection'camel' | 'kebab' | 'snake'

Determines casing for the API response.

Idempotency-Keystring

Ensures the request is idempotent.

Persona-Version'2026-09-29' | '2025-12-08' | '2025-10-27' | '2023-01-05' | '2022-09-01' | '2021-08-18' | '2021-07-05' | '2021-02-21' | '2020-05-18'

Server API version. More info on versioning can be found here.

Response

This endpoint returns a Connection.

Changes

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