organizationDomains

Remove a claimed email domain

Gives up a domain claim, pending or verified. Users already in the organization keep their membership; the domain simply stops auto-joining anyone and becomes available for another organization to claim. Only the authenticated organization's own claims can be removed; any other id is reported as not found.

delete/v1/organization-domains/{organization_domain_id}

Request

  • Base URL: https://api.vitablehealth.com
  • URL: https://api.vitablehealth.com/v1/organization-domains/{organization_domain_id}
  • Auth: HTTP bearer

Path parameters

organization_domain_idstring required

Unique organization domain claim identifier (orgdom_*)

Headers

X-Vitable-Organizationstring

Organization to act as for this request (e.g. org_SGVsbG8gV29ybGQ). Optional when your credentials reach a single organization. Required when they reach several — omitting it then returns 400 organization_required. A malformed value returns 400 invalid_organization_header, and naming an organization you do not have access to returns 403 organization_access_denied.

Response

Domain claim removed.

object required

Changes

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