Create or Replace Exclusion Rule

Creates or replaces the exclusion rule for a given key. The dimension must be tags or vendors; the key is URL-encoded.

Create or Replace a Catalog Exclusion Rule

put

Creates or replaces the exclusion rule for a given key. The dimension must be 'tags' or 'vendors'; the key is URL-encoded. Note: excluded and unpublished are mutually exclusive — setting one to true clears the other.

Path parameters

merchant_idinteger · int32Required

dimensionstringRequired

'tags' or 'vendors'

keystringRequired

The tag or vendor name (URL-encoded)

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Body

application/json

Exclusion rules for the merchants catalog.

excludedbooleanOptional

unpublishedbooleanOptional

Responses

200

The created or replaced exclusion rule.

application/json

Exclusion rules for the merchants catalog.

excludedbooleanOptional

unpublishedbooleanOptional

put/merchants/{merchant_id}/catalog-rules/exclusions/{dimension}/{key}

HTTPcURLJavaScriptPython

PUT /v1/merchants/{merchant_id}/catalog-rules/exclusions/{dimension}/{key} HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 37

{
  "excluded": true,
  "unpublished": false
}

200

The created or replaced exclusion rule.

{
  "excluded": true,
  "unpublished": false
}