Tags
get
Authorizations
Path parameters
idintegerRequired
Responses
200
Getting a specific tag
application/json
get
GET /api/v1/tags/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
200
Getting a specific tag
{
"id": 9,
"account_id": 1,
"name": "Tag 1",
"assigned_listings": [
{
"id": 3,
"title": "Course 1",
"type": "COURSE",
"canvas_course_id": 4
}
],
"assigned_categories": [
{
"id": 12,
"account_id": 5,
"tag_id": 9,
"created_at": "2023-08-22T06:33:38.991906Z",
"updated_at": "2023-08-24T06:33:38.991906Z"
}
],
"created_at": "2023-08-07T09:45:45.535989Z",
"updated_at": "2023-08-07T09:45:45.535989Z"
}
put
Authorizations
Path parameters
idintegerRequired
Body
namestringRequired
New tag name (minimum 1 and maximum 255 characters)
Responses
200
Updating a specific tag
application/json
put
PUT /api/v1/tags/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 15
"name='text'"
200
Updating a specific tag
{
"id": 9,
"account_id": 1,
"name": "New tag name",
"assigned_listings": [
{
"id": 3,
"title": "Course 1",
"type": "COURSE",
"canvas_course_id": 4
}
],
"assigned_categories": [
{
"id": 12,
"account_id": 5,
"tag_id": 9,
"created_at": "2023-08-22T06:33:38.991906Z",
"updated_at": "2023-08-24T06:33:38.991906Z"
}
],
"created_at": "2023-08-07T09:45:45.535989Z",
"updated_at": "2023-08-07T09:45:45.535989Z"
}
delete
Authorizations
Path parameters
idintegerRequired
Responses
200
Deleting a specific tag
application/json
delete
DELETE /api/v1/tags/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
200
Deleting a specific tag
{
"id": 9,
"account_id": 1,
"name": "Tag 1",
"assigned_listings": [],
"assigned_categories": [],
"created_at": "2023-08-07T09:45:45.535989Z",
"updated_at": "2023-08-07T09:45:45.535989Z",
"is_deleted": true
}
get
Authorizations
Query parameters
product_idsstringOptional
List of product ids (maximum 20 ids)
namestringOptional
Search value which will be searched in tag name and associated products names
has_categorybooleanOptional
Tag has category or not
updated_at_fromstringOptional
Updated at from
updated_at_tostringOptional
Updated at to
created_at_fromstringOptional
Created at from
created_at_tostringOptional
Created at to
Responses
200
Listing tags
application/json
get
GET /api/v1/tags HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
200
Listing tags
{
"tags": [
{
"id": 9,
"account_id": 1,
"name": "Tag 1",
"assigned_listings": [
{
"id": 3,
"title": "Course 1",
"type": "COURSE",
"canvas_course_id": 4
}
],
"assigned_categories": [
{
"id": 12,
"account_id": 5,
"tag_id": 9,
"created_at": "2023-08-22T06:33:38.991906Z",
"updated_at": "2023-08-24T06:33:38.991906Z"
}
],
"created_at": "2023-08-07T09:45:45.535989Z",
"updated_at": "2023-08-07T09:45:45.535989Z"
}
]
}
post
Authorizations
Body
namestringRequired
Tag name (minimum 1 and maximum 255 characters)
product_idsstringOptional
List of product ids associate to this tag
Responses
200
Creating a tag
application/json
post
POST /api/v1/tags HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 36
"name='text'&product_ids='text'"
200
Creating a tag
{
"id": 9,
"account_id": 1,
"name": "Tag 1",
"assigned_listings": [
{
"id": 1,
"title": "Course 1",
"type": "COURSE",
"canvas_course_id": 2
},
{
"id": 2,
"title": "Course 2",
"type": "COURSE",
"canvas_course_id": 3
},
{
"id": 3,
"title": "Program 1",
"type": "PROGRAM"
}
],
"assigned_categories": [],
"created_at": "2023-08-07T09:45:45.535989Z",
"updated_at": "2023-08-07T09:45:45.535989Z"
}
Last updated
Was this helpful?