customerEmailMarketingConsentUpdate
mutation

Choose a version:

Requires write_customers access scope. Also: User needs customers permission.

Update a customer's email marketing information information.

Anchor to section titled 'Arguments'

Arguments

Anchor to input input CustomerEmailMarketingConsentUpdateInput! required: Specifies the input fields to update a customer's email marketing consent information.

Was this section helpful?

Anchor to section titled 'CustomerEmailMarketingConsentUpdatePayload returns'

CustomerEmailMarketingConsentUpdatePayload returns

Anchor to CustomerEmailMarketingConsentUpdatePayload.customer customer Customer: The updated customer.
Anchor to CustomerEmailMarketingConsentUpdatePayload.userErrors userErrors [CustomerEmailMarketingConsentUpdateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: customerEmailMarketingConsentUpdate

Query Reference for MUTATION: customerEmailMarketingConsentUpdate

"mutation customerEmailMarketingConsentUpdate($input: CustomerEmailMarketingConsentUpdateInput!) {\n  customerEmailMarketingConsentUpdate(input: $input) {\n    customer {\n      # Customer fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: customerEmailMarketingConsentUpdate

"{\n  \"input\": {\n    \"customerId\": \"gid://shopify/<objectName>/10079785100\",\n    \"emailMarketingConsent\": {\n      \"consentUpdatedAt\": \"2019-09-07T15:50:00Z\",\n      \"marketingOptInLevel\": \"CONFIRMED_OPT_IN\",\n      \"marketingState\": \"INVALID\"\n    }\n  }\n}"

Schema Reference for MUTATION: customerEmailMarketingConsentUpdate

"input CustomerEmailMarketingConsentUpdateInput {\n  customerId: ID!\n  emailMarketingConsent: CustomerEmailMarketingConsentInput!\n}\n\ninput CustomerEmailMarketingConsentInput {\n  consentUpdatedAt: DateTime\n  marketingOptInLevel: CustomerMarketingOptInLevel\n  marketingState: CustomerEmailMarketingState!\n}\n"

Display Examples for MUTATION: customerEmailMarketingConsentUpdate

[]

customerEmailMarketingConsentUpdatemutation

Arguments

CustomerEmailMarketingConsentUpdatePayload returns

customerEmailMarketingConsentUpdate
mutation