themePublish

mutation

Requires The user needs write_themes and an exemption from Shopify to modify themes. If you think that your app is eligible for an exemption and should have access to this API, then you can submit an exception request.

Publishes a theme.

Arguments

Anchor to idid • ID!required: ID of the theme to be published.

Was this section helpful?

Anchor to ThemePublishPayload returnsThemePublishPayload returns

Anchor to themetheme • OnlineStoreTheme: The theme that was published.
Anchor to userErrorsuserErrors • [ThemePublishUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Modify an existing Theme
Publish a theme
themePublish reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation themePublish($id: ID!) {
6    themePublish(id: $id) {
7      theme {
8        id
9      }
10      userErrors {
11        code
12        field
13        message
14      }
15    }
16  }`,
17  {
18    variables: {
19      "id": "gid://shopify/OnlineStoreTheme/908009861"
20    },
21  },
22);
23
24const data = await response.json();
25

mutation themePublish($id: ID!) {
  themePublish(id: $id) {
    theme {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-04/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation themePublish($id: ID!) { themePublish(id: $id) { theme { id } userErrors { code field message } } }",
 "variables": {
    "id": "gid://shopify/OnlineStoreTheme/908009861"
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  mutation themePublish($id: ID!) {
    themePublish(id: $id) {
      theme {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/OnlineStoreTheme/908009861"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation themePublish($id: ID!) {
      themePublish(id: $id) {
        theme {
          id
        }
        userErrors {
          code
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/OnlineStoreTheme/908009861"
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation themePublish($id: ID!) {
    themePublish(id: $id) {
      theme {
        id
      }
      userErrors {
        code
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/OnlineStoreTheme/908009861"
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "id": "gid://shopify/OnlineStoreTheme/908009861"
3}

Response

JSON

1{
2  "themePublish": {
3    "theme": {
4      "id": "gid://shopify/OnlineStoreTheme/908009861"
5    },
6    "userErrors": []
7  }
8}