Update Customer Properties
The properties have to be first defined in the web application, this endpoint only manipulates values of predefined properties via their slugs.
Request
PATCH /v2/customers/100/properties HTTP/1.1
Authorization: Bearer oauth_token
Content-Type: application/json
[ {
"op" : "replace",
"value" : "Tesla",
"path" : "/car"
}, {
"op" : "remove",
"path" : "/revenue"
} ]
Path Parameters
/v2/customers/{customerId}/properties
Request fields
Path | Type | Required | Description |
---|---|---|---|
[].op |
String |
Y | patch operation, one of: replace , remove |
[].path |
String |
Y | path to the property - it’s formed by the property slug and a leading slash |
[].value |
Varies |
N | property value - different property types expect different formats |
Property type | Format | Example |
---|---|---|
number |
Integer (range of [-9223372036854775808 , 9223372036854775807 ]) |
5 |
text |
String (max of 255 characters) | "green" |
url |
Valid URL | "google.com" |
date |
Valid date (YYYY-MM-DD ) |
"2019-01-02" |
dropdown |
Valid dropdown option value, which can be either the option id or label pulled via List Properties Definitions |
"556cca5f-1afc-48ef-8323-b88b55808404" or "Tesla" |
Response
HTTP/1.1 204 No Content