---
title: webPixelUpdate - GraphQL Admin
description: |-
  Activate a [web pixel extension](https://shopify.dev/docs/apps/build/marketing-analytics/build-web-pixels)
  by updating a web pixel record on the store where you installed your app.

  When you run the `webPixelUpdate` mutation, Shopify validates it
  against the settings definition in `shopify.extension.toml`. If the `settings` input field doesn't match
  the schema that you defined, then the mutation fails. Learn how to
  define [web pixel settings](https://shopify.dev/docs/apps/build/marketing-analytics/build-web-pixels#step-2-define-your-web-pixel-settings).
api_version: 2025-10
api_name: admin
type: mutation
api_type: graphql
source_url:
  html: https://shopify.dev/docs/api/admin-graphql/latest/mutations/webpixelupdate
  md: https://shopify.dev/docs/api/admin-graphql/latest/mutations/webpixelupdate.md
---

# web​Pixel​Update

mutation

Requires `write_pixels` access scope. Also: The app requires read\_customer\_events access scope and user access permission.

Activate a [web pixel extension](https://shopify.dev/docs/apps/build/marketing-analytics/build-web-pixels) by updating a web pixel record on the store where you installed your app.

When you run the `webPixelUpdate` mutation, Shopify validates it against the settings definition in `shopify.extension.toml`. If the `settings` input field doesn't match the schema that you defined, then the mutation fails. Learn how to define [web pixel settings](https://shopify.dev/docs/apps/build/marketing-analytics/build-web-pixels#step-2-define-your-web-pixel-settings).

## Arguments

* id

  [ID!](https://shopify.dev/docs/api/admin-graphql/latest/scalars/ID)

  required

  The ID of the web pixel to update.

* web​Pixel

  [Web​Pixel​Input!](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/WebPixelInput)

  required

  The web pixel settings in JSON format.

***

## Web​Pixel​Update​Payload returns

* user​Errors

  [\[Errors​Web​Pixel​User​Error!\]!](https://shopify.dev/docs/api/admin-graphql/latest/objects/ErrorsWebPixelUserError)

  non-null

  The list of errors that occurred from executing the mutation.

* web​Pixel

  [Web​Pixel](https://shopify.dev/docs/api/admin-graphql/latest/objects/WebPixel)

  The updated web pixel settings.

***

## Examples

* ### webPixelUpdate reference

## Mutation Reference

```graphql
mutation webPixelUpdate($id: ID!, $webPixel: WebPixelInput!) {
  webPixelUpdate(id: $id, webPixel: $webPixel) {
    userErrors {
      field
      message
    }
    webPixel {
      # WebPixel fields
    }
  }
}
```

## Input

```json
{
  "id": "gid://shopify/<objectName>/10079785100",
  "webPixel": {
    "settings": "{ \"name\": \"Size\", \"values\": [\"M\", \"L\"] }"
  }
}
```

##### Variables

```
{
  "id": "gid://shopify/<objectName>/10079785100",
  "webPixel": {
    "settings": "{ \"name\": \"Size\", \"values\": [\"M\", \"L\"] }"
  }
}
```

##### Schema

```
input WebPixelInput {
  settings: JSON!
}
```