Calls: {root}/{version}/tag
POST/v4/create
| Route |
{root}/v4/tag/create |
| Request type |
BODY |
| User level |
SUPER USER |
| Requires authentication |
Yes |
| Response type |
Single |
Parameters
| Name |
Type |
Nullable? |
Required? |
Min. |
Max. |
Nest |
Custom |
| name |
STRING |
|
REQUIRED |
0 |
100 |
- |
- |
Sample cURL
Sample response
[
{
"object_name":"tag_id",
"type":"Int32",
"is_nullable":false,
"nest":null,
"custom":null
"note":
}
]
GET/v4/retrieve
| Route |
{root}/v4/tag/retrieve |
| Request type |
URL |
| User level |
STAFF |
| Requires authentication |
Yes |
| Response type |
Array() |
| Sample call | {root}/v0/tag/retrieve/?tag_id=12345678 |
Parameters
| Name |
Type |
Nullable? |
Required? |
Min. |
Max. |
Nest |
Custom |
| tag_id |
INT32 |
|
OPTIONAL |
0 |
2147483647 |
- |
- |
Sample cURL
Sample response
[
{
"object_name":"tag_id",
"type":"Int32",
"is_nullable":false,
"nest":null,
"custom":null
"note":
},
{
"object_name":"name",
"type":"String",
"is_nullable":false,
"nest":null,
"custom":null
"note":
}
]
PUT/v4/update
| Route |
{root}/v4/tag/update |
| Request type |
BODY |
| User level |
SUPER USER |
| Requires authentication |
Yes |
| Response type |
Single |
Parameters
| Name |
Type |
Nullable? |
Required? |
Min. |
Max. |
Nest |
Custom |
| tag_id |
INT32 |
|
REQUIRED |
0 |
2147483647 |
- |
- |
| name |
STRING |
|
REQUIRED |
0 |
100 |
- |
- |
Sample cURL
Sample response
[
{
"object_name":"tag_id",
"type":"Int32",
"is_nullable":false,
"nest":null,
"custom":null
"note":
}
]
DELETE/v4/del
| Route |
{root}/v4/tag/del |
| Request type |
URL |
| User level |
SUPER USER |
| Requires authentication |
Yes |
| Response type |
Single |
| Sample call | {root}/v0/tag/del/12345678/true |
Parameters
| Name |
Type |
Nullable? |
Required? |
Min. |
Max. |
Nest |
Custom |
| tag_id |
INT32 |
|
REQUIRED |
0 |
2147483647 |
- |
- |
| force_removal |
BOOLEAN |
|
REQUIRED |
|
|
- |
- |
Sample cURL
Sample response
Standard response object returned, see API Overview for structure.