Delete Account Integration

Beta
DELETE/v1/settings/integrations/{id}

This endpoint is idempotent. Learn more

Disconnects a third-party provider from the account and returns the deleted integration.

The stored credentials go with it, so any feature that relies on the provider stops working until the integration is created again. Deleting an integration that is already deleted returns an error rather than succeeding silently. To pause a provider without discarding its credentials, set the integration's status to inactive instead.

Role type requiredValues:admin
Only API keys or agents whose role has this type can call this endpoint.
idstring

Account integration ID.

idstring

Account integration ID.

objectstringenumValues:account_integration

Resource type identifier.

namestring

Display name of the integration.

providerstringenumValues:stripeshippohubspot

Integration provider code.

  • stripe: Stripe payment processing.
  • shippo: Shippo shipping and label generation.
  • hubspot: HubSpot CRM.
statusstringenumValues:activeinactive

Lifecycle status of the integration.

Integrations are created active. Setting an integration to inactive keeps its stored credentials but stops it from being used (for example, the Stripe publishable key cannot be retrieved while the Stripe integration is inactive).

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Delete Account Integration