search
tradevest.ai

Customer Labels

hashtag
Get List of Customer Labels with assigned customers count

get
/roles/customer-labels

Get list of customer labels created by partner with assigned customers count

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Responses
chevron-right
200

OK

application/json
get
/roles/customer-labels
200

OK

hashtag
Update Customer Label

patch
/roles/customer-labels/{labelName}

Update customer label by changing name. All assigned customers will have updated label name.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
labelNamestringRequired

Label Name

Body
namestring · min: 1Required

name of customer label

Responses
patch
/roles/customer-labels/{labelName}
No content

hashtag
Remove Label And Its Assignment From All Customers

delete
/roles/customer-labels/{labelName}

Removes label from all assigned customers.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
labelNamestringRequired

Label Name

Responses
delete
/roles/customer-labels/{labelName}
202

Accepted

No content

hashtag
Add Label To All Provided Customers

patch
/roles/customer-labels/{labelName}/customers

Update assignment of customer label to all provided customers. If any customer exceeds the maximum number of labels (16), the request will fail and return in response customer ids that exceeded maximum number of labels. If any customer id is not valid, the request will fail and return in response invalid customer ids.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
labelNamestringRequired

Label Name

Bodystring · uuid[]
string · uuid[]Optional
Responses
patch
/roles/customer-labels/{labelName}/customers
No content

hashtag
Remove Label From All Provided Customers

post
/roles/customer-labels/{labelName}/customers

Remove assignment of customer label from all provided customers. If any customer id is not valid, the request will fail and return in response invalid customer ids.

Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
labelNamestringRequired

Label Name

Bodystring · uuid[]
string · uuid[]Optional
Responses
post
/roles/customer-labels/{labelName}/customers
No content

Last updated