Updates a catalog rule

PUT 
https://euwest.api.elasticpath.com/catalogs/rules/:catalog_rule_id

Specify whichever attributes you want to change. The values of the other attributes remain the same. If the attributes section is empty, the catalog rule is not updated.

Request

Responses

200

An Updated catalog rule with the following attributes.

default

Unexpected error.

Authorization: Authorization

name: Authorizationtype: httpin: headerscheme: bearer

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Put, "https://euwest.api.elasticpath.com/catalogs/rules/:catalog_rule_id");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <Authorization>");
var content = new StringContent("{\n  \"data\": {\n    \"id\": \"8dbb35b2-ef04-477e-974d-e5f3abe6faae\",\n    \"attributes\": {\n      \"name\": \"rule-123\",\n      \"description\": \"Catalog Rule for most favored customers\",\n      \"account_ids\": [\n        \"string\"\n      ],\n      \"customer_ids\": [\n        \"string\"\n      ],\n      \"channels\": [\n        \"string\"\n      ],\n      \"schedules\": [\n        {\n          \"valid_from\": \"2020-09-22T09:00:00\",\n          \"valid_to\": \"2020-09-22T09:00:00\"\n        }\n      ],\n      \"tags\": [\n        \"string\"\n      ],\n      \"catalog_id\": \"d09b4e16-08a5-4f42-817c-6e0d98acbb63\"\n    },\n    \"type\": \"catalog_rule\"\n  }\n}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://euwest.api.elasticpath.com

Auth

Bearer Token

Parameters

catalog_rule_id — pathrequired

Body required

{
  "data": {
    "id": "8dbb35b2-ef04-477e-974d-e5f3abe6faae",
    "attributes": {
      "name": "rule-123",
      "description": "Catalog Rule for most favored customers",
      "account_ids": [
        "string"
      ],
      "customer_ids": [
        "string"
      ],
      "channels": [
        "string"
      ],
      "schedules": [
        {
          "valid_from": "2020-09-22T09:00:00",
          "valid_to": "2020-09-22T09:00:00"
        }
      ],
      "tags": [
        "string"
      ],
      "catalog_id": "d09b4e16-08a5-4f42-817c-6e0d98acbb63"
    },
    "type": "catalog_rule"
  }
}

ResponseClear

Click the Send API Request button above and see the response here!