Patch Rule

Patch Rule

This API updates customer rule. Only rule name update is allowed. It returns the updated rule definition.

Request
URI
PATCH
https://{api_host}/rules/{id}
COPY
Path Parameters
UUID
id
Required

The id(UUID) of a customer rule

Header Parameters
string
sessionid
Required

The authentication token obtained from login API response

Request Body

Rule update definition

PatchRuleRequest of type(s) application/json
Required 
{
    "name": "string"
}
Name_CMR
name
Optional

name

Responses
200

Rule updated

Returns PatchRuleResponse of type(s) application/json 
{
    "productType": "string",
    "productId": 0,
    "name": "string",
    "targetId": "string",
    "targetType": "string",
    "id": "string"
}
ProductType_CMR
productType
Optional

productType

Product_ID
productId
Optional

productId

string
name
Optional

name

string
targetId
Optional

targetId

TargetType_CMR
targetType
Optional

targetType

UUID
id
Optional

id


400
Returns 400InvalidRequest of type(s) application/json 
{
    "errCode": "GW_REQ_KEY",
    "errMessage": "Not found expected value for key 'sampleKey'"
}
string
errCode
Optional

errCode

string
errMessage
Optional

errMessage


401

Unauthorized - Invalid login credentials

{
    "errCode": "string"
}
string
errCode
Optional

errCode


On This Page
Customer Rules Operations
DELETE
Delete Rule
DELETE
Delete Rules
POST
Get Inventory Search Result
GET
Get Rule
GET
Get Rules
GET
Get Rules Audit
PATCH
Patch Rule
PATCH
Patch Rules
POST
Post Rules