Connections

Delete connection

Archive a connection (move to trash). Archived connections can be restored from the trash in the connection settings UI.

A connection that is already archived returns 410.

delete/api/v1/connections/{id}

Request

  • Base URL
    https://omniapp.co (the document declares no server; this is the origin it was published from)
  • URL
    https://omniapp.co/api/v1/connections/{id}
  • Auth
    HTTP bearer

Path parameters

idstring uuid required

Connection ID

Example:550e8400-e29b-41d4-a716-446655440000

Response

Connection moved to trash

messagestring required

Status message describing the result

successboolean required

True when the connection was archived

Example response

{
  "message": "Connection moved to trash.",
  "success": true
}

Changes

No recorded changes to this operation across all 97 revisions of this API.