Skip to main content

Terms API

The terms API allowes you to retrieve, create, edit and delete contact tags.

URL

You can access the terms API with the followong base URL:

https://<system_id>.<server_id>.quentn.com/public/api/V1/terms

 

Retrieve terms [GET]

URI Parameter Required Requirements Description
offset No integer The number of records to skip (default: 0)
limit No integer The number of records to return (default: 500)

Request:

GET https://<system_id>.<server_id>.quentn.com/public/api/V1/terms?offset=0&limit=500 HTTP/1.1

Response:

[
  {
    "id": 123,
    "name": "Tag 1",
    "description": "Example description",
    "deletion_blocked": false,
  },
  {
    "id": 124,
    "name": "Tag 2",
    "description": "Example description",
    "deletion_blocked": true,
  }
]

 

Retrieve term by id [GET]

Request:

GET https://<system_id>.<server_id>.quentn.com/public/api/V1/terms/<term_id>

Response:

{
  "id": 123,
  "name": "Tag 1",
  "description": "Example description",
  "deletion_blocked": false,
}

 

Retrieve term by name [GET]

Request:

GET https://<system_id>.<server_id>.quentn.com/public/api/V1/terms/<term_name>

Response:

{
  "id": 123,
  "name": "Tag 1",
  "description": "Example description",
  "deletion_blocked": false,
}

 

Create term [POST]

Please keep in mind that term names must be unique (case-insenitive). If the submitted term name already exists, the ID of the existing term will be returned. 

Request Parameter Required Requirements Description
Name Yes String Unique term name.
Description No String Term's description

Request Body:

{
  "name" : "Tag A",
  "description" : "Sample description"
}

Response:

{
  "id" : 123
}

 

Update term [PUT]

Request Parameter Required Requirements Description
Name No String Unique term name.
Description No String Term's description

Request:

PUT https://<system_id>.<server_id>.quentn.com/public/api/V1/terms/<term_id>

Request Body:

{
  "name" : "New Tag name",
  "description" : "New description"
}

Response:

{
  "success" : "true",
}

Related articles