Create a taxonomy term

To create a new taxonomy term, createTaxonomyTerm mutation should be used. If a parent should be set, an appropriate term can be found with getTaxonomyTermByName query

Note: vocabulary will not be created with an API, it should be created on the site manually.

Access policy:

The API user context should have permission to create a taxonomy term in the given vocabulary. Otherwise, access denied response will be returned.
The given vocabulary should exist on the site.
If parent ID is not 0, a term with this ID should exist.

The only argument that can be used in this mutation is termData that is the object with the following properties:

Argument	Type	Description	Default
`vocabulary`	`String`	Required. Represents a machine name of the taxonomy vocabulary to create a term.	—
`name`	`String`	Required. A name (label) of the taxonomy term that should be created.	—
`parentId`	`ID`	The parent term ID. By default the term will be created without a parent, as a first-level item.	0

For example, let’s create a new term in LP Domain vocabulary under the “Onboarding” item.

mutation createTaxonomyTerm {
  createTaxonomyTerm(termData: {
    vocabulary: "lp_domain",
    name: "API domain",
    parentId: "9"
  }) {
    errors
    response {
      id
      name
      parent {
        id
        name
      }
      vocabulary
      weight
    }
  }
}

{
  "data": {
    "createTaxonomyTerm": {
      "errors": [],
      "response": {
        "id": "11",
        "name": "API domain",
        "parent": {
          "id": "9",
          "name": "Onboarding"
        },
        "vocabulary": "lp_domain",
        "weight": 0
      }
    }
  }
}

After the mutation execution, the term should be created in the given vocabulary. Before:

After:

Get taxonomy term Update a taxonomy term

⌘I

Getting started

Integration & Concepts

Use cases

Hierarchy Management

Zapier Integration

Mobile application

Create a taxonomy term