HomeGuidesAPI ReferenceChangelogDiscussions
HomeLog In
Guides

Add or Remove Customer tags

Function

To add or remove customer tags with customer IDs.
Each tag mush have at least 3 characters and at most 40 characters.
Each customer can have at most 60 customer tags.
When update with invalid length of tags, the update will fail and the respond will be 422.
When the amount of customer tags exceed 60,
the update will fail and return the current valid tags of that customer with status code 200.

使用顧客ID添加或移除顧客標籤。
每一個顧客標籤必須有最少3個字完及最多40個字完。
每一個顧客最多只能有60個顧客標籤。
若需更新的顧客標籤其中之一不符字完長度規範,更新不會成功及將回傳狀態碼422。
若需更新的顧客標籤超過60個時,更新將不會成功,且仍會回傳狀態碼200及當前顧客的有效顧客標籤。

URL

PATCH <<api_domain>>/v1/customers/{id}/tags

Sample request

curl --request PATCH \
     --url https://open.shoplineapp.com/v1/customers/id/tags \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --data '
{
     "update_mode": "add"
}
'

Path parameters

id Required string Customer's ID
顧客ID

Request Params

tags Required Array of string array of tags to add / remove
update_mode Required string enum add / remove tags

Response Example

{
  "tags": [
    "Custom tag I"
  ]
}