---
title: CustomerPhoneNumber - Customer API
description: |-
  Defines the phone number of the customer. Apps using the Customer Account API
  must meet the protected customer data
  [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data).
api_version: 2026-10
source_url:
  html: 'https://shopify.dev/docs/api/customer/latest/objects/CustomerPhoneNumber'
  md: 'https://shopify.dev/docs/api/customer/latest/objects/CustomerPhoneNumber.md'
api_name: customer
api_type: graphql
type: object
---

# Customer​Phone​Number

object

Requires `customer_read_customers` access scope.

Defines the phone number of the customer. Apps using the Customer Account API must meet the protected customer data [requirements](https://shopify.dev/docs/apps/launch/protected-customer-data).

## Fields

* phone​Number

  [String!](https://shopify.dev/docs/api/customer/latest/scalars/String)

  non-null

  The customer's phone number.

* sms​Marketing​Consent

  [Customer​Sms​Marketing​Consent!](https://shopify.dev/docs/api/customer/latest/objects/CustomerSmsMarketingConsent)

  non-null

  The [SMS marketing consent](https://shopify.dev/docs/api/customer/latest/objects/CustomerSmsMarketingConsent) information for the customer's phone number.

* whats​App​Marketing​Consent

  [Customer​Whats​App​Marketing​Consent!](https://shopify.dev/docs/api/customer/latest/objects/CustomerWhatsAppMarketingConsent)

  non-null

  The [WhatsApp marketing consent](https://shopify.dev/docs/api/customer/latest/objects/CustomerWhatsAppMarketingConsent) information for the customer's phone number. Update it with the [`customerWhatsAppMarketingConsentUpdate`](https://shopify.dev/docs/api/customer/latest/mutations/customerWhatsAppMarketingConsentUpdate) mutation.

* marketing​State

  [Sms​Marketing​State!](https://shopify.dev/docs/api/customer/latest/enums/SmsMarketingState)

  non-nullDeprecated

***

## Map

### Fields with this object

* [Customer.phoneNumber](https://shopify.dev/docs/api/customer/latest/objects/Customer#field-Customer.fields.phoneNumber)

***

## Mutations

* [customer​Whats​App​Marketing​Consent​Update](https://shopify.dev/docs/api/customer/latest/mutations/customerWhatsAppMarketingConsentUpdate)

  mutation

  Updates the current customer's WhatsApp marketing consent information. Shopify identifies the customer's WhatsApp account by their [phone number](https://shopify.dev/docs/api/customer/latest/objects/CustomerPhoneNumber).

  You can subscribe or unsubscribe the customer from WhatsApp marketing.

  * input

    [Customer​Whats​App​Marketing​Consent​Update​Input!](https://shopify.dev/docs/api/customer/latest/input-objects/CustomerWhatsAppMarketingConsentUpdateInput)

    required

    ### Arguments

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

  ***

***

## CustomerPhoneNumber Mutations

### Mutated by

* [customer​Whats​App​Marketing​Consent​Update](https://shopify.dev/docs/api/customer/latest/mutations/customerWhatsAppMarketingConsentUpdate)