Update Account Integration

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

This endpoint is idempotent. Learn more

Updates an account integration's name and active status.

Omitted fields are left unchanged. Credentials cannot be changed with this endpoint; to rotate credentials, call Create Account Integration again with the same integration code.

idstring

Account integration ID.

nameoptional string

Display name of the integration.

statusoptional stringenumValues:activeinactive

Lifecycle status of the integration.

Set to inactive to deactivate the integration without deleting its stored credentials.

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 Update Account Integration