Mutations

Your project endpoint exposes GraphQL mutations you can use to modify the contents of your project. The mutations API allows you to interact with content ouside of the GraphCMS UI using GraphQL.

It's not recommended you enable Public API Permissions for mutations, but instead use a Permanent Auth Token for mutating data.

Auto-generated mutations

When a new model is added to your project, so are custom GraphQL mutations.

For example, if you created a Product model, these mutations would also be generated inside your GraphQL schema:

createProduct
updateProduct
deleteProduct
upsertProduct
publishProduct
unpublishProduct
updateManyProductsConnection
deleteManyProductsConnection
publishManyProductsConnection
unpublishManyProductsConnection

All of these mutations accept input types that are specific to your projects GraphQL schema.

Create entries

When creating new content entries, the data argument will have an associated input type that is specific to your content model.

For example, if your project contains the model Product, you will have:

Mutation	Argument	Input Type
`createProduct`	`data`	`ProductCreateInput!`

mutation {
  createProduct(data: { name: "Face Mask", slug: "face-mask", price: 1000 }) {
    id
    name
    slug
    price
  }
}

{
  "data": {
    "createProduct": {
      "id": "ckgcd5hzc01wd0a446vd3kqrs",
      "name": "Face Mask",
      "slug": "face-mask",
      "price": 1000
    }
  }
}

The id is a default system field that is automatically generated for all new entries.

Update entries

When updating single content entry, you must specify the unique where criteria of which you want to update, as well as the new data.

For example, if your project contains the model Product, you will have:

Argument	Input Type
`where`	`ProductWhereUniqueInput!`
`data`	`ProductUpdateInput!`

mutation {
  updateProduct(
    where: { id: "ckgcd5hzc01wd0a446vd3kqrs" }
    data: { price: 100 }
  ) {
    id
    name
    price
  }
}

{
  "data": {
    "updateProduct": {
      "id": "ckgcd5hzc01wd0a446vd3kqrs",
      "name": "Face Mask",
      "price": 100
    }
  }
}

You can also update any unique field on your model.

Upsert entries

The upsert mutation allows you to create, or update a content entry based on whether the unique where values exist.

For example, if your project contains the model Product, you will have:

Argument	Input Type
`where`	`ProductWhereUniqueInput!`
`upsert`	`ProductUpsertInput!`
`upsert` > `create`	`ProductCreateInput!`
`upsert` > `update`	`ProductUpdateInput!`

You must provide both create, and update to the upsert argument.

mutation {
  upsertProduct(
    where: { slug: "face-mask" }
    upsert: {
      create: { name: "Face Mask", slug: "face-mask", price: 1000 }
      update: { name: "Face Mask", slug: "face-mask", price: 1000 }
    }
  ) {
    id
    name
    slug
    price
  }
}

{
  "data": {
    "upsertProduct": {
      "id": "ckgcf201401cz0a56wyon4fj8",
      "name": "Face Mask",
      "slug": "face-mask",
      "price": 1000
    }
  }
}

Delete entries

Similar to updating, and upserting entries, you can specify using where the entries you want to delete.

For example, if your project contains the model Product, you will have:

Argument	Input Type
`where`	`ProductWhereUniqueInput!`

mutation {
  deleteProduct(where: { id: "..." }) {
    id
    name
    slug
    price
  }
}

{
  "data": {
    "deleteProduct": {
      "id": "ckgcf201401cz0a56wyon4fj8",
      "name": "Face Mask",
      "slug": "face-mask",
      "price": 1000
    }
  }
}

Nested mutations

create: Create and relate entries
connect: Connect additional existing entries by unique field
update: Update the connected entries
upsert: Create or update connected entries
disconnect: Disconnect connected relations by unique field
delete: Delete all connected entries
set: Override all connected entries

Create

mutation {
  createProduct(
    data: {
      name: "Test"
      slug: "test"
      price: 1000
      category: { create: { name: "Accessories", slug: "accessories" } }
    }
  ) {
    id
    name
    category {
      name
    }
  }
}

mutation {
  createProduct(
    data: {
      name: "Test"
      slug: "test"
      price: 1000
      category: { connect: { slug: "accessories" } }
    }
  ) {
    id
    name
    category {
      name
    }
  }
}

Update

mutation {
  updateProduct(
    where: { id: "..." }
    data: { category: { create: { name: "Accessories", slug: "accessories" } } }
  ) {
    id
    category {
      name
    }
  }
}

mutation {
  updateProduct(
    where: { id: "..." }
    data: {
      category: {
        update: {
          where: { slug: "accessories" }
          data: { name: "All Accessories" }
        }
      }
    }
  ) {
    id
    category {
      name
    }
  }
}

mutation {
  updateProduct(
    where: { id: "..." }
    data: {
      category: {
        upsert: {
          where: { slug: "accessories" }
          data: {
            create: { name: "Accessories", slug: "accessories" }
            update: { name: "Accessories", slug: "accessories" }
          }
        }
      }
    }
  ) {
    id
    category {
      name
    }
  }
}

mutation {
  updateProduct(
    where: { id: "..." }
    data: { category: { connect: { id: "..." } } }
  ) {
    id
    category {
      name
    }
  }
}

mutation {
  updateProduct(
    where: { id: "..." }
    data: { category: { disconnect: true } }
  ) {
    id
    category {
      name
    }
  }
}

mutation {
  updateProduct(where: { id: "..." }, data: { category: { delete: true } }) {
    id
    category {
      name
    }
  }
}

mutation {
  updateCategory(
    where: { id: "..." }
    data: { products: { set: [{ slug: "..." }, { id: "..." }] } }
  ) {
    name
    products {
      name
    }
  }
}

Insert at position

When inserting related entries, you can connect entries at a given position. The position of entries reflects that fetching relations.

The position input accepts the following values:

Field	Type	Definition
`before`	`ID`	The ID of the entry you want to insert before
`after`	`ID`	The ID of the entry you want to insert after
`start`	`Boolean`	Set to `true` if you want to insert at the start
`end`	`Boolean`	Set to `true` if you want to insert at the end

You must only provide one of these values.

Before

mutation {
  updateAuthor(
    where: { id: "..." }
    data: { posts: { connect: { position: { before: "..." } } } }
  ) {
    id
  }
}

After

mutation {
  updateAuthor(
    where: { id: "..." }
    data: { posts: { connect: { position: { after: "..." } } } }
  ) {
    id
  }
}

Start

mutation {
  updateAuthor(
    where: { id: "..." }
    data: { posts: { connect: { position: { start: true } } } }
  ) {
    id
  }
}

End

mutation {
  updateAuthor(
    where: { id: "..." }
    data: { posts: { connect: { position: { end: true } } } }
  ) {
    id
  }
}

Publishing content mutations

GraphCMS automatically generates publish, and unpublish mutations for each of your content models, including the asset model.

Learn more about publishing and unpublishing content.

Batch mutations

GraphCMS supports batch mutations that can be applied to "many" entries at once. You may wish to update, or delete many entries at once that fit given criteria.

Batch mutations comply with the Relay connection type specification.

Update many

To update many entries at once, you must use the updateMany[Model]Connection mutation. You can use where, or pagination filters to set the criteria you wish to update.

Argument	Input Type	Description
`where`	`ProductManyWhereInput`	Filtering criteria for entries you want to update.
`data`	`CreateInput!`	An object that specifies the data you'd like to update matching entries with.
`first`	`Int`	Seek forwards from end of result set.
`last`	`Int`	Seek backwards from start of result set.
`skip`	`Int`	Skip result set by given amount.
`before`	`ID`	Seek backwards before specific ID.
`after`	`ID`	Seeks forwards after specific ID.

If you do not pass any filters, then the first 100 entries will be updated. See Pagination for updating pages.

For example, let's update all products where featured: true, to be featured: false.

mutation {
  updateManyProductsConnection(
    where: { featured: true }
    data: { featured: false }
  ) {
    edges {
      node {
        featured
      }
    }
  }
}

{
  "data": {
    "updateManyProductsConnection": {
      "edges": [
        {
          "node": {
            "featured": true
          }
        },
        {
          "node": {
            "featured": true
          }
        },
        {
          "node": {
            "featured": true
          }
        }
      ]
    }
  }
}

Delete many

To delete many entries at once, you must use the deleteMany[Model]Connection mutation. You can use where, or pagination filters to set the criteria you wish to delete.

Argument	Input Type	Description
`where`	`ProductManyWhereInput`	Filtering criteria for entries you want to delete.
`first`	`Int`	Seek forwards from end of result set.
`last`	`Int`	Seek backwards from start of result set.
`skip`	`Int`	Skip result set by given amount.
`before`	`ID`	Seek backwards before specific ID.
`after`	`ID`	Seeks forwards after specific ID.

If you do not pass any filters, then the first 100 entries will be deleted. See Pagination for updating pages.

mutation {
  deleteManyProductsConnection(where: { featured: true }) {
    edges {
      node {
        id
      }
    }
  }
}

{
  "data": {
    "deleteManyProductsConnection": {
      "edges": [
        {
          "node": {
            "id": "ckdt46o2w029u0156q124e0x4"
          }
        },
        {
          "node": {
            "id": "ckdt47uio02al01044grc4ehf"
          }
        },
        {
          "node": {
            "id": "ckdt4c9gw02cu01026bzkok1b"
          }
        }
      ]
    }
  }
}

Publish many

Just like you can publish content, you can also batch publish.

Argument	Input Type	Description
`where`	`ProductManyWhereInput`	Filtering criteria finding entries.
`from`	`Stage = DRAFT`	The content stage to find entries from.
`to`	`[Stage!]! = [PUBLISHED]`	The target published content stage.
`first`	`Int`	Seek forwards from end of result set.
`last`	`Int`	Seek backwards from start of result set.
`skip`	`Int`	Skip result set by given amount.
`before`	`ID`	Seek backwards before specific ID.
`after`	`ID`	Seeks forwards after specific ID.

For example, we could publish the first 5 products to the PUBLISHED stage.

mutation {
  publishManyProductsConnection(first: 5, to: PUBLISHED) {
    edges {
      node {
        id
      }
    }
  }
}

{
  "data": {
    "publishManyProductsConnection": {
      "edges": [
        {
          "node": {
            "id": "ckdt46o2w029u0156q124e0x4"
          }
        },
        {
          "node": {
            "id": "ckdt47uio02al01044grc4ehf"
          }
        },
        {
          "node": {
            "id": "ckdt4c9gw02cu01026bzkok1b"
          }
        }
      ]
    }
  }
}

Unpublish many

Just like you can batch publish, you can also batch unpublish.

Argument	Input Type	Description
`where`	`ProductManyWhereInput`	Filtering criteria for entries you want to find.
`stage`	`Stage = DRAFT`	The content stage to find entries in.
`to`	`[Stage!]! = [PUBLISHED]`	The target published content stage.
`first`	`Int`	Seek forwards from end of result set.
`last`	`Int`	Seek backwards from start of result set.
`skip`	`Int`	Skip result set by given amount.
`before`	`ID`	Seek backwards before specific ID.
`after`	`ID`	Seeks forwards after specific ID.

mutation {
  unpublishManyProductsConnection(stage: PUBLISHED) {
    edges {
      node {
        id
      }
    }
  }
}

{
  "data": {
    "unpublishManyProductsConnection": {
      "edges": [
        {
          "node": {
            "id": "ckdt46o2w029u0156q124e0x4"
          }
        },
        {
          "node": {
            "id": "ckdt47uio02al01044grc4ehf"
          }
        },
        {
          "node": {
            "id": "ckdt4c9gw02cu01026bzkok1b"
          }
        }
      ]
    }
  }
}

Localized content mutations

Depending on whether or not you have localized fields in your schema, you will be able to mutate each of the localized content entries.

Learn more about mutating localized content.

Mutations

Auto-generated mutations

Create entries

Update entries

Upsert entries

Delete entries

Nested mutations

Create

Update

Insert at position

Before

After

Start

End

Publishing content mutations

Batch mutations

Update many

Delete many

Publish many

Unpublish many

Localized content mutations

Did you find this page useful?