---
title: "Deactivate a Connection"
method: POST
path: "/connect/connections/{connection-id}/deactivate"
tags: ["connect"]
---

# Deactivate a Connection

`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

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.

## Path parameters

- `connection-id` string, required

## Headers

- `Key-Inflection` 'camel' | 'kebab' | 'snake'
- `Idempotency-Key` string
- `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](https://docs.withpersona.com/versioning).

## Response `200`

This endpoint returns a Connection.

- ConnectDeactivateAConnectConnectionResponse200
  - `data` ConnectConnection, required: A Connect Connection object. This object represents a connection between organizations for sharing access to Persona objects.
    - `type` 'connect/connection'
    - `id` string
    - `attributes` ConnectConnectionAttributes
      - `status` string: The current status of the connection. One of `pending`, `active`, `inactive`, or `archived`. An `archived` connection is never listed or retrievable directly; it only appears as the connection of an existing share token.
      - `destination-organization-id` string: The organization authorized to access objects through this connection.
      - `source-organization-id` string: The organization that created and owns this connection.
      - `created-at` string, date-time: The date and time when this connection was created
      - `updated-at` string, date-time: The date and time when this connection was last updated
    - `relationships` ConnectConnectionRelationships
      - `creator` ConnectConnectionRelationshipsCreator
        - `data` ConnectConnectionRelationshipsCreatorData, required
          - `id` string, required
          - `type` string, required: The type of the creator entity

## Other responses

- `400`: The request was unacceptable, often due to invalid parameters.
- `401`: An invalid API key was provided.
- `403`: The given API key doesn’t have permissions to perform the request or a quota has been exceeded.
- `404`: The requested resource doesn’t exist.
- `409`: The request conflicts with another request, often due to attempting to create a duplicate resource.
- `422`: The request modifies the resource in an unacceptable way, often due to an invalid action or parameter.
- `429`: Your organization’s rate limit has been exceeded. We recommend an exponential backoff on requests.

---

[API](https://skmtc.dev/withpersona/apis/withpersona-3.md) - [All operations](https://skmtc.dev/withpersona/apis/withpersona-3/llms.txt) - [OpenAPI document](https://skmtc.dev/withpersona/apis/withpersona-3/revisions/0a3310d5046f?raw)