Update Account Integration

Beta

PUT/v1/settings/integrations/{id}

This endpoint is idempotent. Learn more

Renames an account integration, or activates or deactivates it.

Omitted fields are left unchanged. Credentials cannot be changed here; to rotate them, call Create Account Integration again with the same provider.

Role type requiredValues:admin

Only API keys or agents whose role has this type can call this endpoint.

idstring

Account integration ID.

nameoptional string

Display name of the integration.

statusoptional stringenumValues:activeinactive

Lifecycle status of the integration.

Set to inactive to stop the provider being used while keeping its stored credentials, and back to active to resume without re-entering them.

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

Update Account Integration

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const accountIntegration = await client.settings.integrations.update('acig_5ilahyezrs63', {
  name: 'Updated Stripe Integration',
  status: 'active',
});

console.log(accountIntegration.id);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const accountIntegration = await client.settings.integrations.update('acig_5ilahyezrs63', {
  name: 'Updated Stripe Integration',
  status: 'active',
});

console.log(accountIntegration.id);

200 example

{
  "id": "acig_5ilahyezrs63",
  "object": "account_integration",
  "name": "My Stripe Integration",
  "provider": "stripe",
  "status": "active",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

{
  "id": "acig_5ilahyezrs63",
  "object": "account_integration",
  "name": "My Stripe Integration",
  "provider": "stripe",
  "status": "active",
  "created_at": "2026-05-10T00:00:00Z",
  "updated_at": "2026-05-10T00:23:00Z"
}

Update Account Integration

Authorization

Path Parameters

Request Body

Returns

Responses