COconvoy
integration

Deactivate a broker integration

Deactivate a broker integration. API client credentials associated with a deactivated broker integration will no longer be able to be used to access the Convoy API.

post/integration/deactivateBrokerIntegration

Request

  • Base URL
    https://demo-developer.convoy.com/broker
  • Auth
    HTTP bearer

Headers

X-Convoy-API-Versionstring required

The Convoy API version

Request body

integratorBrokerIdstring required

A unique identifier for the broker provided by the external integrator.

Response

The request has succeeded.

status'SUCCESS' | 'ALREADY_DEACTIVATED' required

Changes

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