---
title: CustomerPhoneNumber - GraphQL Admin
description: A phone number.
api_version: 2026-10
source_url:
  html: >-
    https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerPhoneNumber
  md: >-
    https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerPhoneNumber.md
api_name: admin
api_type: graphql
type: object
---

# Customer​Phone​Number

object

Requires `read_customers` access scope.

A phone number.

## Fields

* phone​Number

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

  non-null

  A customer's phone number.

* sms​Marketing​Consent

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

  non-null

  The [SMS marketing consent](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerSmsMarketingConsent) information for the customer's phone number. Update with the [`customerSmsMarketingConsentUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerSmsMarketingConsentUpdate) mutation.

* whats​App​Marketing​Consent

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

  non-null

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

### Deprecated fields

* marketing​Collected​From

  [Customer​Consent​Collected​From](https://shopify.dev/docs/api/admin-graphql/latest/enums/CustomerConsentCollectedFrom)

  Deprecated

* marketing​Opt​In​Level

  [Customer​Marketing​Opt​In​Level](https://shopify.dev/docs/api/admin-graphql/latest/enums/CustomerMarketingOptInLevel)

  Deprecated

* marketing​State

  [Customer​Sms​Marketing​State!](https://shopify.dev/docs/api/admin-graphql/latest/enums/CustomerSmsMarketingState)

  non-nullDeprecated

* marketing​Updated​At

  [Date​Time](https://shopify.dev/docs/api/admin-graphql/latest/scalars/DateTime)

  Deprecated

* source​Location

  [Location](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location)

  Deprecated

***

## Map

### Fields with this object

* [Customer.defaultPhoneNumber](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer#field-Customer.fields.defaultPhoneNumber)
* [CustomerMergePreviewAlternateFields.phoneNumber](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerMergePreviewAlternateFields#field-CustomerMergePreviewAlternateFields.fields.phoneNumber)
* [CustomerMergePreviewDefaultFields.phoneNumber](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerMergePreviewDefaultFields#field-CustomerMergePreviewDefaultFields.fields.phoneNumber)
* [CustomerSegmentMember.defaultPhoneNumber](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerSegmentMember#field-CustomerSegmentMember.fields.defaultPhoneNumber)

***

## Mutations

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

  mutation

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

  You can subscribe or unsubscribe the customer from WhatsApp marketing and specify the [opt-in level](https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerWhatsAppMarketingConsentUpdate#arguments-input.fields.whatsAppMarketingConsent.optInLevel). You can also include when and [where](https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerWhatsAppMarketingConsentUpdate#arguments-input.fields.whatsAppMarketingConsent.sourceLocationId) the consent was collected.

  * input

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

    required

    ### Arguments

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

  ***

***

## CustomerPhoneNumber Mutations

### Mutated by

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