hydrogenStorefrontEnvironmentUpdate

mutation

Requires Request must be initiated from the Shopify CLI and user must have full access to apps or access to the Hydrogen channel.

Updates whether a Hydrogen storefront environment is public. A private environment can only be visited with an access token; a public one serves anyone at its URL.

Making an environment public counts toward the shop's limit of public environments. Preview environments can't be updated.

Learn more about Hydrogen environments.

Anchor to Arguments

Arguments

Anchor to environmentIdenvironmentId •ID! required: The ID of the environment to update.
Anchor to publicpublic •Boolean! required: Whether the environment can be visited without an access token.
Anchor to storefrontIdstorefrontId •ID! required: The ID of the storefront.

Was this section helpful?

Anchor to HydrogenStorefrontEnvironmentUpdatePayload returnsHydrogenStorefrontEnvironmentUpdatePayload returns

Anchor to userErrorsuserErrors •[HydrogenStorefrontEnvironmentUpdateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

hydrogenStorefrontEnvironmentUpdate reference

Mutation Reference

mutation hydrogenStorefrontEnvironmentUpdate($environmentId: ID!, $public: Boolean!, $storefrontId: ID!) {

hydrogenStorefrontEnvironmentUpdate(environmentId: $environmentId, public: $public, storefrontId: $storefrontId) {

userErrors {

field

message

}

Input

{

"environmentId": "gid://shopify/<objectName>/10079785100",

"public": true,

"storefrontId": "gid://shopify/<objectName>/10079785100"

}