HOhookdeck
Connections

Disable a connection

Changed on

This endpoint disables a connection. Notice that a connection is enabled by default when created. A disabled connection will no longer receive or deliver any events.

put/connections/{id}/archive

Request

  • Base URL
    https://api.hookdeck.com/2025-07-01
  • Auth
    • HTTP bearer
    • or HTTP basic

Path parameters

idstring required

Connection ID

Response

A single connection

idstring required

ID of the connection

namestring nullable required

Unique name of the connection for this source

full_namestring nullable required

Full name of the connection concatenated from source, connection and desitnation name

descriptionstring nullable required

Description of the connection

team_idstring required

ID of the project

disabled_atstring date-time nullable required

Date the connection was disabled

paused_atstring date-time nullable required

Date the connection was paused

updated_atstring date-time required

Date the connection was last updated

created_atstring date-time required

Date the connection was created

Changes

  • 9bebff6c68f9Revision changes
    • breaking

      added subschema #4 to the ////// response property oneOf list for the response status

    • breaking

      added to the / response property oneOf list for the response status

    • breaking

      removed the required property /////// from the response with the status

    • warning

      added the new SENDGRID_INBOUND enum value to the ////// response property for the response status

    • warning

      added the new SENDGRID_INBOUND enum value to the / response property for the response status

    • info

      added the optional property ////// to the response with the status

    • info

      removed from the ////// response property oneOf list for the response status

  • 8e3ce7869510Revision changes
    • breaking

      added to the ////// response property oneOf list for the response status

    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new QUO enum value to the ////// response property for the response status

    • warning

      added the new QUO enum value to the / response property for the response status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status

    • info

      the response property /////// became required for the status