Domains

Update a domain

Rename a draft or replace its whole taxonomy. A published domain and the platform's can't be changed: duplicate it and edit the copy. Free.

patch/v1/domains/{id}

Request

Base URL
https://console.nace.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nace/apis/drex-api/docs/v1/domains/:id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

The domain's domain_id.

Request body

display_namestring

Example request

{
  "taxonomy": {
    "classes": [
      {
        "group": "leases",
        "subgroup": "amendments",
        "description": "Amendments to a signed lease.",
        "aliases": [
          "lease amendment"
        ]
      }
    ],
    "allow_other": true
  }
}

Response

The draft as updated, and its validation.

Example response

{
  "domain": {
    "taxonomy": {
      "classes": [
        {
          "group": "leases",
          "subgroup": "amendments",
          "description": "Amendments to a signed lease.",
          "aliases": [
            "lease amendment"
          ]
        }
      ],
      "allow_other": true
    }
  }
}

Changes

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