customer_cluster.update

Update a customer cluster’s name, internal description or rule. Changing the rule rebuilds its membership in this same transaction, so the next cart priced sees the new answer.

• Scope: customer.admin.write
• System: no
• Reachable from: POST /v1/commands/customer_cluster.update (tenant credential) · MCP tool customer_cluster.update · SDK client.call('customer_cluster.update', …)
• Events: customer_cluster.updated

Input (JSON Schema)

{
  "properties": {
    "cluster_id": {
      "minLength": 1,
      "type": "string"
    },
    "description": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ]
    },
    "match": {
      "enum": [
        "all",
        "any"
      ],
      "type": "string"
    },
    "name": {
      "minLength": 1,
      "type": "string"
    },
    "rule": {
      "items": {
        "properties": {
          "attribute": {
            "minLength": 1,
            "type": "string"
          },
          "operator": {
            "enum": [
              "is",
              "starts_with",
              "contains",
              "eq",
              "gt",
              "lt",
              "between",
              "is_one_of",
              "before",
              "after",
              "more_than_days_ago",
              "less_than_days_ago"
            ],
            "type": "string"
          },
          "value": {}
        },
        "required": [
          "attribute",
          "operator",
          "value"
        ],
        "type": "object"
      },
      "type": "array"
    }
  },
  "required": [
    "cluster_id"
  ],
  "type": "object"
}

Result (200)

{
  "additionalProperties": false,
  "properties": {
    "cluster_id": {
      "type": "string"
    }
  },
  "required": [
    "cluster_id"
  ],
  "type": "object"
}

Errors

validation_failed (400) · unauthorized (401) · forbidden (403) · conflict (409) · internal (500)