Zum Hauptinhalt gehen

Terms API

Mit der Terms-API kannst du Kontakt-Tags abrufen, erstellen, bearbeiten und löschen.

URL

Du kannst auf die Terms-API mit der folgenden Basis-URL zugreifen:

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]

Bitte beachte, dass die Namen der Begriffe eindeutig sein müssen (Groß- und Kleinschreibung). Wenn der eingegebene Begriffsname bereits existiert, wird die ID des bestehenden Begriffs zurückgegeben.

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

Request:

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

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",
}

 

Delete term [DELETE]

Request:

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

Response:

{
  "success" : "true",
}

Verwandte Beiträge