customerWhatsAppMarketingConsentUpdate

Updates a customer's WhatsApp marketing consent information. Shopify identifies the customer's WhatsApp account by their phone number.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the customerWhatsAppMarketingConsentUpdate action (under Customer).
Fill in the fields below, then reference the result from later steps as {{customerwhatsappmarketingconsentupdate.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation CustomerWhatsAppMarketingConsentUpdate($input: CustomerWhatsAppMarketingConsentUpdateInput!) {
  customerWhatsAppMarketingConsentUpdate(input: $input) {
    customerPhoneNumber {
      marketingCollectedFrom
      marketingOptInLevel
      marketingState
      marketingUpdatedAt
      phoneNumber
      sourceLocation {
        activatable
        address
        addressVerified
        createdAt
        deactivatable
        deactivatedAt
        deletable
        fulfillmentService
        fulfillsOnlineOrders
        hasActiveInventory
        hasUnfulfilledOrders
        id
        isActive
        isFulfillmentService
        isPrimary
        legacyResourceId
        localPickupSettingsV2
        name
        shipsInventory
        suggestedAddresses
        updatedAt
      }
      whatsAppMarketingConsent {
        collectedFrom
        optInLevel
        sourceLocation
        state
        updatedAt
      }
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

inputobjectrequired

Specifies the input fields to update a customer's WhatsApp marketing consent information.

customerIdstringrequired

whatsAppMarketingConsentobjectrequired4 fields

json

{
  "input": {
    "customerId": "string",
    "whatsAppMarketingConsent": {
      "state": "NEVER_SUBSCRIBED",
      "optInLevel": "SINGLE_OPT_IN",
      "updatedAt": "string",
      "sourceLocationId": "string"
    }
  }
}

Response

Read the result with {{customerwhatsappmarketingconsentupdate.response.data.data.customerWhatsAppMarketingConsentUpdate}}. If the API returns errors, the step fails and they are at {{customerwhatsappmarketingconsentupdate.response.data.errors}}.

customerPhoneNumberobject

marketingCollectedFromstring

One ofSHOPIFYOTHER

marketingOptInLevelstring

One ofSINGLE_OPT_INCONFIRMED_OPT_INUNKNOWN

marketingStatestring

One ofNOT_SUBSCRIBEDPENDINGSUBSCRIBEDUNSUBSCRIBEDREDACTED

marketingUpdatedAtstring

phoneNumberstring

sourceLocationobject21 fields

whatsAppMarketingConsentobject5 fields

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?