> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# smsKeywordUpdate

> Change an SMS keyword's text or tags, or pause or resume it with `status`. Returns null if no keyword in this store has the id.

**Required scopes:** [`campaigns_write`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-campaigns_write)

**Store must have one of:** `EMAIL_SMS`

## Arguments

**id** `ID!` *required*

The keyword's `id`.

**input** `[SmsKeywordUpdateInput!](/docs/api-reference/v3/reference/marketing/sms-keyword-update-input)` *required*

The fields to change.

**fields**

**keyword** `String`

New keyword text: 3 to 20 letters or digits, stored uppercase, not reserved and not used by another keyword in the store.

**status** `[SmsKeywordStatus](/docs/api-reference/v3/reference/marketing/sms-keyword-status)`

PAUSED to pause the keyword, ACTIVE to resume it.

**tagIds** `[ID!]`

The `id` (or `legacyId`) of each customer tag to add to customers who subscribe with this keyword, at most 100. Replaces the keyword's tags; pass an empty list to clear them.

## Returns

**smsKeywordUpdate** `[SmsKeyword](/docs/api-reference/v3/reference/marketing/sms-keyword)`

A word customers text to the store's number to subscribe to SMS marketing, set under Settings > Keywords.

**fields**

**createdAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the keyword was created.

**id** `ID!` *required*

The id of this keyword.

**keyword** `String!` *required*

The text a customer sends to subscribe: 3 to 20 uppercase letters or digits. Matching ignores case.

**status** `[SmsKeywordStatus!](/docs/api-reference/v3/reference/marketing/sms-keyword-status)` *required*

Whether texting this keyword subscribes the sender.

**tags** `[\[CustomerTag!\]!](/docs/api-reference/v3/reference/marketing/customer-tag)` *required*

Customer tags added to each customer who subscribes with this keyword, A–Z by name. A tag deleted from the catalog is left out.

**Requires:** [`customers_read`](https://developers.redo.com/docs/api-reference/v3/reference/scopes#scope-customers_read)

**fields**

**id** `ID!` *required*

The id of this customer tag.

**legacyId** `String!` *required*

The tag's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.

**name** `String!` *required*

The merchant-facing name of the tag.

**provider** `[CustomerTagProvider](/docs/api-reference/v3/reference/marketing/customer-tag-provider)`

Who has authority to add or remove this tag. Null on older records that predate provider.

**source** `[CustomerTagSource!](/docs/api-reference/v3/reference/marketing/customer-tag-source)` *required*

Where this tag was created.

**updatedAt** `[DateTime!](/docs/api-reference/v3/reference/common/date-time)` *required*

When the keyword was last changed.

## Example

```graphql theme={null}
mutation {
  smsKeywordUpdate(id: "...", input: { ... }) {
    createdAt
    id
    keyword
    status
    updatedAt
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.