Client tags

Use these methods to manage client tags that are used to organize and sort client-related information in the Back Office.

GET[host]/api/v2/tags

Get a list of tags

GET[host]/api/v2/tags/{tagId}

Get tag details

POST[host]/api/v2/tags

Add a new tag

PUT[host]/api/v2/tags/{tagId}

PATCH[host]/api/v2/tags/{tagId}

Update a tag

DELETE[host]/api/v2/tags/{tagId}

Delete a tag

Get a list of tags

Use this method to obtain a list of available tags defined in the Back Office.

To obtain detailed information about a specific tag, use a separate method to get tag details.

Request

Header parameters:

  • Authorization: Bearer <token>

Query parameters:

The following sorting parameter is available for this method:

createTime (default)

The date and time when a tag was created.

The following filter parameter is available for this method:

type (default)

The tag type. Always clients.

Refer to the Query parameters section of the Overview for details on applying filter and sorting parameters.

GET[host]/api/v2/tags

curl --location -g --request GET 'https://host.name/api/v2/tags?limit=10&offset=0&sort_order=desc&sort_by=createTime&filter[type]=clients' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response includes an array of Tag objects providing information about the tags matching the request parameters.

Get tag details

Use this method to obtain detailed information about a specified tag.

To obtain a list of available tags defined in the Back Office, use a separate method to get a list of tags.

Request

Header parameters:

  • Authorization: Bearer <token>

Path parameters:

tagId required

The tag identifier.

GET[host]/api/v2/tags/{tagId}

curl --location --request GET 'https://host.name/api/v2/tags/1' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja'

Response

A response includes a Tag object providing information about the specified tag.

Add a new tag

Use this method to define a new tag.

Request

Header parameters:

  • Authorization: Bearer <token>

Body:

Specify the following parameters for a tag:

name string required

The name assigned to a tag.

type string required

The tag type. Always clients.

POST[host]/api/v2/tags

curl --location --request POST 'https://host.name/api/v2/tags' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja' \
--data-raw '{
  "name": "John's clients",
  "type": "clients"
}'

Response

A response includes a Tag object providing information about the created tag.

Update a tag

Use this method to update a specified tag.

Note

Instead of the method described below, you can use a similar method that uses the HTTP verbĀ PATCH.

Request

Header parameters:

  • Authorization: Bearer <token>

Path parameters:

tagId required

The tag identifier.

Body:

The following field value can be updated for a specified tag:

name string

The name assigned to a tag.

PUT[host]/api/v2/tags/{tagId}

curl --location --request PATCH 'https://host.name/api/v2/tags/1' \
--header 'Authorization: Bearer <token>' \
--header 'accept-language: ja' \
--data-raw '{
  "name": "Jim's clients"
}'

Response

A response includes a Tag object providing information about the updated tag.

Delete a tag

Use this method to remove a specified tag.

Request

Header parameters:

  • Authorization: Bearer <token>

Path parameters:

tagId required

The tag identifier.

DELETE[host]/api/v2/tags/{tagId}

curl --location --request DELETE 'https://host.name/api/v2/tags/1' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.