shopPolicyUpdate mutation

Updates a shop policy.

Required access

write_legal_policies access scope.

On this page

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

mutation shopPolicyUpdate($shopPolicy: ShopPolicyInput!) { shopPolicyUpdate(shopPolicy: $shopPolicy) { 
  1. <font style="color:#1F61A0;">shopPolicy</font> <font style="color:#555555;">{</font>
  3.   <font style="color:#1F61A0;">id</font>
  5. <font style="color:#555555;">}</font>
  7. <font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  9.   <font style="color:#1F61A0;">code</font>
  11.   <font style="color:#1F61A0;">field</font>
  13.   <font style="color:#1F61A0;">message</font>
  15. <font style="color:#555555;">}</font>
} } { “shopPolicy”: { 
  1. <font style="color:#8B2BB9;">"type"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font><font style="color:#555555;">,</font>
  3. <font style="color:#8B2BB9;">"body"</font><font style="color:#555555;">:</font> <font style="color:#D64292;">"placeholder"</font>
} }

Arguments

Argument Description
shopPolicy
(
[ShopPolicyInput!](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/shoppolicyinput)

) REQUIRED		 The properties to use when updating the shop policy.

ShopPolicyInput fields

  • body ([String!](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01)) REQUIRED
    Policy text, maximum size of 512kb.
  • type ([ShopPolicyType!](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/shoppolicytype)) REQUIRED
    The shop policy type.

Return fields

  • shopPolicy ([ShopPolicy](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/shoppolicy))
    The shop policy that has been updated.
  • userErrors ([[ShopPolicyUserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/store-properties/shoppolicyusererror))
    List of errors that occurred executing the mutation.