Delete Portal Domain

Beta

DELETE/v1/settings/portal-domains/{id}

This endpoint is idempotent. Learn more

Disconnects the custom domain from the account's customer portal.

The domain is detached from the serving infrastructure and immediately stops serving the portal; buyers must go back to the account's default slug-based portal address. Because an account may only hold one custom domain, this is how you free it up to connect a different one. The DNS records you published can then be removed.

Permissions requiredValues:self:update

The role behind your API key or agent must grant every one of these permissions.

idstring

Portal domain ID.

Responses

200

Successful response for Delete Portal Domain

Delete Portal Domain

import OpenMRP from '@openmrp/sdk';

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

const portalDomain = await client.settings.portalDomains.delete('podn_ml44z5ggf169');

console.log(portalDomain);

import OpenMRP from '@openmrp/sdk';

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

const portalDomain = await client.settings.portalDomains.delete('podn_ml44z5ggf169');

console.log(portalDomain);

200 example

{}

{}

Delete Portal Domain

Authorization

Path Parameters

Responses