---
title: "Update store settings"
description: "Updates the store's settings."
---

> Documentation Index
> Fetch the complete documentation index at: https://docs.sherpo.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update store settings

Needs the site:write scope.

## Call

- Tool: `update_settings`
- Scope: `site:write`
- Writes, and may change or remove what is there.
- Acts on a store.

## Arguments

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `store` | `string` | No | The store to act on. |
| `locale` | `string` | No |  |
| `tint` | `string or null` | No |  |
| `tint_dark` | `string or null` | No |  |
| `delivery_ttl_seconds` | `integer` | No |  |
| `refund_revokes_access` | `boolean` | No |  |
| `description` | `string or null` | No |  |
| `time_zone` | `string` | No |  |
| `currency` | `string or null` | No | The currency the store reports in; null clears it. |
| `settings` | `object` | No | Merged onto the stored settings; null deletes a key. |
| `metadata` | `object` | No |  |
| `from` | `object` | No | The revision the caller read; a write made since refuses. |

```json
{
  "type": "object",
  "properties": {
    "store": {
      "type": "string",
      "description": "The store to act on."
    },
    "locale": {
      "type": "string",
      "minLength": 1,
      "maxLength": 5,
      "pattern": "^[a-z]{2}(?:-[A-Z]{2})?$"
    },
    "tint": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 7,
          "pattern": "^#[0-9a-fA-F]{6}$"
        },
        {
          "type": "null"
        }
      ]
    },
    "tint_dark": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 7,
          "pattern": "^#[0-9a-fA-F]{6}$"
        },
        {
          "type": "null"
        }
      ]
    },
    "delivery_ttl_seconds": {
      "type": "integer",
      "minimum": 60,
      "maximum": 604800
    },
    "refund_revokes_access": {
      "type": "boolean"
    },
    "description": {
      "anyOf": [
        {
          "type": "string",
          "minLength": 1,
          "maxLength": 2000
        },
        {
          "type": "null"
        }
      ]
    },
    "time_zone": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64
    },
    "currency": {
      "description": "The currency the store reports in; null clears it.",
      "anyOf": [
        {
          "type": "string",
          "minLength": 3,
          "maxLength": 3
        },
        {
          "type": "null"
        }
      ]
    },
    "settings": {
      "description": "Merged onto the stored settings; null deletes a key.",
      "type": "object",
      "properties": {
        "storefront": {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "external_site": {
                  "description": "The seller's own site, linked from the header.",
                  "anyOf": [
                    {
                      "type": "string",
                      "minLength": 1,
                      "maxLength": 2000
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "socials": {
                  "description": "Profile URLs on the networks the footer shows (Instagram, X, YouTube, LinkedIn, TikTok, Twitch, Threads, GitHub, Facebook, Discord, Telegram, Reddit, Bluesky, Slack, and Mastodon on mastodon.social, mastodon.online, fosstodon.org, hachyderm.io, infosec.exchange, techhub.social or a host with a `mastodon` or `mstdn` label), linked from the footer.",
                  "anyOf": [
                    {
                      "type": "array",
                      "items": {
                        "type": "string",
                        "minLength": 1,
                        "maxLength": 2000
                      },
                      "maxItems": 20
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "theme": {
                  "description": "The schemes visitors may pick; absent offers both.",
                  "anyOf": [
                    {
                      "type": "string",
                      "enum": [
                        "both",
                        "light",
                        "dark"
                      ]
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "no_index": {
                  "anyOf": [
                    {
                      "type": "boolean"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "powered_by": {
                  "anyOf": [
                    {
                      "type": "boolean"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "animated_background": {
                  "description": "The dots drifting behind the hero.",
                  "anyOf": [
                    {
                      "type": "boolean"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "header_hidden": {
                  "description": "Whether the site's header and footer are left off its pages.",
                  "anyOf": [
                    {
                      "type": "boolean"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "footer_hidden": {
                  "anyOf": [
                    {
                      "type": "boolean"
                    },
                    {
                      "type": "null"
                    }
                  ]
                }
              },
              "additionalProperties": false
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "boolean"
          },
          {
            "type": "string"
          },
          {
            "type": "number"
          },
          {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          {
            "type": "object",
            "properties": {},
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "array",
                  "items": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "type": "string"
                      },
                      {
                        "type": "number"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": {
                "anyOf": [
                  {
                    "type": "boolean"
                  },
                  {
                    "type": "string"
                  },
                  {
                    "type": "number"
                  },
                  {
                    "type": "array",
                    "items": {
                      "anyOf": [
                        {
                          "type": "boolean"
                        },
                        {
                          "type": "string"
                        },
                        {
                          "type": "number"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            }
          },
          {
            "type": "object",
            "properties": {},
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "array",
                  "items": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "type": "string"
                      },
                      {
                        "type": "number"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                {
                  "type": "object",
                  "properties": {},
                  "additionalProperties": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "type": "string"
                      },
                      {
                        "type": "number"
                      },
                      {
                        "type": "array",
                        "items": {
                          "anyOf": [
                            {
                              "type": "boolean"
                            },
                            {
                              "type": "string"
                            },
                            {
                              "type": "number"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        }
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": {
                      "anyOf": [
                        {
                          "type": "boolean"
                        },
                        {
                          "type": "string"
                        },
                        {
                          "type": "number"
                        },
                        {
                          "type": "array",
                          "items": {
                            "anyOf": [
                              {
                                "type": "boolean"
                              },
                              {
                                "type": "string"
                              },
                              {
                                "type": "number"
                              },
                              {
                                "type": "null"
                              }
                            ]
                          }
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  }
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "metadata": {
      "type": "object",
      "properties": {},
      "additionalProperties": {
        "anyOf": [
          {
            "type": "boolean"
          },
          {
            "type": "string"
          },
          {
            "type": "number"
          },
          {
            "type": "array",
            "items": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          {
            "type": "object",
            "properties": {},
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "array",
                  "items": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "type": "string"
                      },
                      {
                        "type": "number"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {},
              "additionalProperties": {
                "anyOf": [
                  {
                    "type": "boolean"
                  },
                  {
                    "type": "string"
                  },
                  {
                    "type": "number"
                  },
                  {
                    "type": "array",
                    "items": {
                      "anyOf": [
                        {
                          "type": "boolean"
                        },
                        {
                          "type": "string"
                        },
                        {
                          "type": "number"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  },
                  {
                    "type": "null"
                  }
                ]
              }
            }
          },
          {
            "type": "object",
            "properties": {},
            "additionalProperties": {
              "anyOf": [
                {
                  "type": "boolean"
                },
                {
                  "type": "string"
                },
                {
                  "type": "number"
                },
                {
                  "type": "array",
                  "items": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "type": "string"
                      },
                      {
                        "type": "number"
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                {
                  "type": "object",
                  "properties": {},
                  "additionalProperties": {
                    "anyOf": [
                      {
                        "type": "boolean"
                      },
                      {
                        "type": "string"
                      },
                      {
                        "type": "number"
                      },
                      {
                        "type": "array",
                        "items": {
                          "anyOf": [
                            {
                              "type": "boolean"
                            },
                            {
                              "type": "string"
                            },
                            {
                              "type": "number"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        }
                      },
                      {
                        "type": "null"
                      }
                    ]
                  }
                },
                {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {},
                    "additionalProperties": {
                      "anyOf": [
                        {
                          "type": "boolean"
                        },
                        {
                          "type": "string"
                        },
                        {
                          "type": "number"
                        },
                        {
                          "type": "array",
                          "items": {
                            "anyOf": [
                              {
                                "type": "boolean"
                              },
                              {
                                "type": "string"
                              },
                              {
                                "type": "number"
                              },
                              {
                                "type": "null"
                              }
                            ]
                          }
                        },
                        {
                          "type": "null"
                        }
                      ]
                    }
                  }
                },
                {
                  "type": "null"
                }
              ]
            }
          },
          {
            "type": "null"
          }
        ]
      }
    },
    "from": {
      "description": "The revision the caller read; a write made since refuses.",
      "type": "object",
      "properties": {
        "revision": {
          "type": "integer",
          "minimum": 0
        }
      },
      "required": [
        "revision"
      ],
      "additionalProperties": false
    }
  },
  "additionalProperties": false
}
```

## Answer

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `site` | `object` | Yes |  |
| `plan` | `object` | Yes |  |
| `files` | `object` | Yes |  |
| `integrations` | `array of object` | Yes |  |
| `redirects` | `object` | Yes |  |
| `notifications` | `object` | Yes |  |
| `work` | `object` | Yes |  |
| `locale` | `string` | Yes |  |
| `tint` | `string or null` | Yes |  |
| `tint_dark` | `string or null` | Yes |  |
| `delivery_ttl_seconds` | `number` | Yes |  |
| `refund_revokes_access` | `boolean` | Yes |  |
| `description` | `string or null` | Yes |  |
| `time_zone` | `string` | Yes |  |
| `currency` | `string or null` | Yes |  |
| `settings` | `object` | Yes |  |
| `metadata` | `object` | Yes |  |
| `revision` | `number` | Yes |  |
| `updated_at` | `string or null` | Yes |  |
| `id` | `string` | Yes |  |
| `name` | `string` | Yes |  |
| `merchant_id` | `string` | Yes |  |
| `hostname` | `string or null` | Yes |  |
| `url` | `string or null` | Yes | The store home's absolute URL on its verified hostname, or null before it has one. |
| `subdomain` | `string or null` | Yes |  |
| `hostnames` | `array of string` | Yes |  |
| `swatch` | `string or null` | Yes |  |
| `icon` | `string` | Yes |  |

The answer's full shape is on [its API reference page](/merchant-api/reference/update-settings).

## Errors

A refused call is a tool error. Its `structuredContent` holds a `code` and its `context`, except for `client-fault`. This tool may answer:

- `invalid`: an argument is malformed; `context.path` names it.
- `invalid` at `["store"]`: `store` is missing while the connection reaches more than one store, or names a store it doesn't reach.
- `conflict`: the call clashes with the current state; `context` names the field and, where it helps, its current value, and for a `from`, `live`, `expect` or version that no longer matches, the argument (`path`) and what it takes (`reason`).
- `not_permitted`: this connection may not make this call. When `context.reason` is `limit`, too many calls: `retry_after` says when to try again.
- `internal` or `unavailable`: the call failed inside Sherpo, and the write may have landed. This write takes no idempotency key, so read the state back before trying again.
- `client-fault`: the server failed around the call. `core_answer` `ok` means the write landed, so don't send it again. When `reached_core` is false, nothing happened and the call may be made again. Otherwise, this write takes no idempotency key, so read the state back before trying again.
- HTTP 403 with `insufficient_scope`: the connection lacks the scope this tool needs.
- HTTP 401 with `invalid_token`: the access token expired or the connection ended. Refresh the token, and connect again if the refresh fails or the new token is refused too.

Any other code may come back too, such as a `conflict` when the state changed under the call. When the answer was already streaming, a 401 or 403 comes back as a tool error with only its text. See [Errors](/merchant-mcp/errors) for every code and its context.

Source: https://docs.sherpo.io/merchant-mcp/tools/update_settings/index.mdx
