---
title: "CustomerSmsMarketingState"
description: "Sms subscription status enum"
doc_type: graphql
doc_category: adminGraphQL
doc_version: v20270301
source_url:
  html: 'https://developer.shopline.com/docs/admin-graph-ql-api/customers/enums/customer-sms-marketing-state'
  md: 'https://developer.shopline.com/docs/admin-graph-ql-api/customers/enums/customer-sms-marketing-state.md'
---
# CustomerSmsMarketingState

Sms subscription status enum

- **API Version:** v20270301
- **API Type:** Admin
- **API Protocol:** GraphQL
- **Operation Type:** Enum

## Type Signature

`CustomerSmsMarketingState`

## Values

* `PENDING`

  On subscription confirmation

* `REDACTED`

  Customer data is deleted, the value is only viewed internally and is read-only

* `SUBSCRIBED`

  Subscribe

* `UNSUBSCRIBED`

  Cancel the subscription

* `NOT_SUBSCRIBED`

  Not on subscription

## Schema Definition

```graphql
enum CustomerSmsMarketingState { 
	PENDING 
	REDACTED 
	SUBSCRIBED 
	UNSUBSCRIBED 
	NOT_SUBSCRIBED  
}
```

## Field from

* [CustomerSmsMarketingConsentState](https://developer.shopline.com/docs/admin-graph-ql-api/customers/objects/customer-sms-marketing-consent-state.md).marketingState

  Subscription status

* [CustomerPhoneNumber](https://developer.shopline.com/docs/admin-graph-ql-api/customers/objects/customer-phone-number.md).marketingState

  Customer SMS subscription status

## Input field from

* [CustomerSmsMarketingConsentInput](https://developer.shopline.com/docs/admin-graph-ql-api/customers/inputs/customer-sms-marketing-consent-input.md).marketingState

  SMS Subscription Status

## Error Handling

For detailed information about common codes, see [Status and error codes](https://developer.shopline.com/docs/apps/api-instructions-for-use/graph-ql-admin-api/overview.md#status-and-error-codes).