Update a Catalog Rule

PUT Update a Catalog Rule

https://api.moltin.com/pcm/catalogs/rules/:catalogRuleId

Updates an existing catalog rule. This operation performs a sparse update. Only the fields included in the request body are updated.

Request

Response - PCM

Path Parameters:

Name	Required	Type	Description
catalogRuleId	Required	string	The unique identifier of a catalog rule.

Headers:

Name	Required	Type	Description
Authorization	Required	string	The Bearer token to grant access to the API. Note that this must be a client credentials token.

Body:

Required. A Rule object with the fields you want to update.

Attribute	Required	Type	Description
id	Required	string	The same catalogRuleId that you specify in the path.
type	Required	string	Always: catalog_rule
attributes.name	Required	string	The name of the rule.
attributes.description	Optional	string	The purpose for this rule.
attributes.catalog_id	Required	string	The unique identifier of the catalog for this rule.
attributes.customer_ids	Optional	[array]	The list of customers who are eligible to see this catalog. If empty, the rule matches all customers.
attributes.channels	Optional	[array]	The list of channels in which this catalog can be displayed. A channel is the shopping experience, such as a mobile app or web storefront. If empty, the rule matches all channels.
attributes.tags	Optional	[array]	A list of user-defined tags that can be used to refine the rule in any way you want.

200 OK

{
    "data": {
        "attributes": {
            "catalog_id": "8caf81b8-9bc7-4b72-92fc-3775722aa06a",
            "channels": [
                "dealers-site"
            ],
            "created_at": "2021-04-12T16:47:39.178Z",
            "description": "Dealers",
            "name": "Dealers",
            "updated_at": "2021-04-12T16:56:36.029Z"
        },
        "id": "4abd19fa-b697-4cec-a1c7-922a16a264f6",
        "type": "catalog_rule"
    },
    "links": {
        "self": "/pcm/catalogs/rules/4abd19fa-b697-4cec-a1c7-922a16a264f6"
    }
}

cURL

curl -X PUT https://api.moltin.com/pcm/catalogs/rules/4abd19fa-b697-4cec-a1c7-922a16a264f6 \
     -H "Authorization: Bearer XXXX" \
     -H "Content-Type: application/json" \
     -d $'{
        "data": {
            "id": "4abd19fa-b697-4cec-a1c7-922a16a264f6",
            "type": "catalog_rule",
            "attributes": {
                "catalog_id": "8caf81b8-9bc7-4b72-92fc-3775722aa06a"
            }
        }
    }'