Connections

Disconnect a connection

Archives the connection and stops its continuous DNS monitoring, then emits one connection.disconnected webhook. It is not a row delete — delivery history and metering are preserved. Idempotent: a repeat returns the ORIGINAL disconnectedAt with alreadyDisconnected: true and emits nothing, so a caller's own retry loop can never double-emit. 200 rather than 204 precisely so those two fields survive.

delete/api/v1/connections/{connectionId}

Request

  • Base URL: https://app.dodomain.io
  • URL: https://app.dodomain.io/api/v1/connections/{connectionId}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://app.dodomain.io/api/auth/oauth2/authorize, token URL https://app.dodomain.io/api/auth/oauth2/token, scopes: connections:write)

Path parameters

connectionIdstring required

The connection id from GET /api/v1/connections, or the connectionId on a connection.* webhook payload.

Headers

DoDomain-Teamstring

The id of the team this call acts on, from GET /api/v1/teams. Needed only when the credential can use more than one team (an OAuth connection granted several); a secret key has exactly one. A team the credential cannot use is refused 404 TEAM_NOT_FOUND — the same answer whether the team exists or not.

Response

Success.

alreadyDisconnectedboolean required
disconnectedAtstring date-time required
idstring required

Changes

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