Skip to main content
PATCH
/
tags
/
channel
Add and/or remove tags on a specific channel
curl --request PATCH \
  --url https://mm-api.merchantspring.io/tags/channel \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "channelId": "A1234567890ABC",
  "merchantId": "XXXUS @ ATVPDKIKX0DER",
  "addTags": [
    "north-america"
  ],
  "removeTags": [
    "org://ebay"
  ]
}
'
{
  "channelId": "A1234567890ABC",
  "merchantId": "XXXUS @ ATVPDKIKX0DER",
  "tags": [
    "amazon",
    "north-america"
  ]
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Channel identifiers and the tags to add and/or remove (at least one of addTags / removeTags)

​
channelId
string
required

Channel (store) ID

​
merchantId
string
required

Merchant ID of the channel

​
addTags
string[]

Tags to add to the channel. Non-empty strings only. Organisation-wide tags are prefixed with 'org://'.

​
removeTags
string[]

Tags to remove from the channel. Non-empty strings only. Tags not present on the channel are ignored.

Response

Successful operation

​
channelId
string | null

Channel (store) ID, resolved from the merchant ID where available

​
merchantId
string | null

Merchant ID of the channel

​
tags
string[]

Tags for the channel. Organisation-wide tags are prefixed with 'org://'.