Update Collection
import requests
url = "https://api.trychannel3.com/v1/collections/{collection_id}"
payload = {
"name": "<string>",
"description": "<string>",
"add_clauses": [
{
"brand_ids": ["<string>"],
"website_ids": ["<string>"],
"category_ids": ["<string>"],
"product_ids": ["<string>"]
}
],
"replace_clauses": [
{
"clause_id": "<string>",
"brand_ids": ["<string>"],
"website_ids": ["<string>"],
"category_ids": ["<string>"],
"product_ids": ["<string>"]
}
],
"remove_clause_ids": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
add_clauses: [
{
brand_ids: ['<string>'],
website_ids: ['<string>'],
category_ids: ['<string>'],
product_ids: ['<string>']
}
],
replace_clauses: [
{
clause_id: '<string>',
brand_ids: ['<string>'],
website_ids: ['<string>'],
category_ids: ['<string>'],
product_ids: ['<string>']
}
],
remove_clause_ids: ['<string>']
})
};
fetch('https://api.trychannel3.com/v1/collections/{collection_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request PATCH \
--url https://api.trychannel3.com/v1/collections/{collection_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"add_clauses": [
{
"brand_ids": [
"<string>"
],
"website_ids": [
"<string>"
],
"category_ids": [
"<string>"
],
"product_ids": [
"<string>"
]
}
],
"replace_clauses": [
{
"clause_id": "<string>",
"brand_ids": [
"<string>"
],
"website_ids": [
"<string>"
],
"category_ids": [
"<string>"
],
"product_ids": [
"<string>"
]
}
],
"remove_clause_ids": [
"<string>"
]
}
'{
"collection_id": "<string>",
"name": "<string>",
"clauses": [
{
"clause_id": "<string>",
"brand_ids": [
"<string>"
],
"website_ids": [
"<string>"
],
"category_ids": [
"<string>"
],
"product_ids": [
"<string>"
]
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"user_id": "<string>"
}
Collections
Update Collection
Rename a collection and/or add, replace, or remove clauses by id.
PATCH
/
v1
/
collections
/
{collection_id}
Update Collection
import requests
url = "https://api.trychannel3.com/v1/collections/{collection_id}"
payload = {
"name": "<string>",
"description": "<string>",
"add_clauses": [
{
"brand_ids": ["<string>"],
"website_ids": ["<string>"],
"category_ids": ["<string>"],
"product_ids": ["<string>"]
}
],
"replace_clauses": [
{
"clause_id": "<string>",
"brand_ids": ["<string>"],
"website_ids": ["<string>"],
"category_ids": ["<string>"],
"product_ids": ["<string>"]
}
],
"remove_clause_ids": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
add_clauses: [
{
brand_ids: ['<string>'],
website_ids: ['<string>'],
category_ids: ['<string>'],
product_ids: ['<string>']
}
],
replace_clauses: [
{
clause_id: '<string>',
brand_ids: ['<string>'],
website_ids: ['<string>'],
category_ids: ['<string>'],
product_ids: ['<string>']
}
],
remove_clause_ids: ['<string>']
})
};
fetch('https://api.trychannel3.com/v1/collections/{collection_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request PATCH \
--url https://api.trychannel3.com/v1/collections/{collection_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"add_clauses": [
{
"brand_ids": [
"<string>"
],
"website_ids": [
"<string>"
],
"category_ids": [
"<string>"
],
"product_ids": [
"<string>"
]
}
],
"replace_clauses": [
{
"clause_id": "<string>",
"brand_ids": [
"<string>"
],
"website_ids": [
"<string>"
],
"category_ids": [
"<string>"
],
"product_ids": [
"<string>"
]
}
],
"remove_clause_ids": [
"<string>"
]
}
'{
"collection_id": "<string>",
"name": "<string>",
"clauses": [
{
"clause_id": "<string>",
"brand_ids": [
"<string>"
],
"website_ids": [
"<string>"
],
"category_ids": [
"<string>"
],
"product_ids": [
"<string>"
]
}
],
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"description": "<string>",
"user_id": "<string>"
}
Authorizations
Path Parameters
Body
application/json
Was this page helpful?
⌘I