Customer Labels

Get List of Customer Labels with assigned customers count

get

Ready to test

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

Authorizations
Responses
200
OK
application/json
get
GET /customer-labels HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

OK

[
  {
    "label": "text",
    "customersCount": 1
  }
]

Update Customer Label

patch

Ready to test

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

Authorizations
Path parameters
customerLabelNamestringRequired

customer label name

Body
namestringRequired

name of customer label

Responses
202
Accepted
patch
PATCH /customer-labels/{customerLabelName} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}
No content

Remove Label And Its Assignment From All Customers

delete

Ready to test

Removes label from all assigned customers.

Authorizations
Path parameters
customerLabelNamestringRequired

customer label name

Responses
202
Accepted
delete
DELETE /customer-labels/{customerLabelName} HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
202

Accepted

No content

Add Label To All Provided Customers

patch

Ready to test

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
Path parameters
customerLabelNamestringRequired

customer label name

Bodystring · uuid[]
string · uuid[]Optional
Responses
202
Accepted
patch
PATCH /customer-labels/{customerLabelName}/customers HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

[
  "123e4567-e89b-12d3-a456-426614174000"
]
No content

Remove Label From All Provided Customers

post

Ready to test

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
Path parameters
customerLabelNamestringRequired

customer label name

Bodystring · uuid[]
string · uuid[]Optional
Responses
202
Accepted
post
POST /customer-labels/{customerLabelName}/customers HTTP/1.1
Host: tvda-api.platform-test.tradevest.ai
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 40

[
  "123e4567-e89b-12d3-a456-426614174000"
]
No content

Last updated