Skip to main content
POST
/
client-properties
/
{clientPropertyId}
/
assign-tag-to-client
Assign a tag to a client and create the tag if it does not exist
curl --request POST \
  --url https://api.leanpay.fr/v1/public/client-properties/{clientPropertyId}/assign-tag-to-client \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "tag": {
    "label": "<string>"
  },
  "mode": "replace"
}
'
{
  "tagId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientTagIds": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ]
}

Authorizations

​
Authorization
string
header
required

Path Parameters

​
clientPropertyId
string<uuid>
required

The ID of the client property

Body

application/json
​
client
object
required
​
tag
object
required
​
mode
enum<string>
default:replace
Available options:
add,
replace

Response

Tag assigned successfully

​
tagId
string<uuid>
required
​
clientTagIds
string<uuid>[]
required