Skip to content

Commit e41c7f3

Browse files
authored
feat(docs): add customer properties definitions and values to v3.6 EUEE-1513 (#1679)
1 parent 304156f commit e41c7f3

7 files changed

Lines changed: 169 additions & 30 deletions

File tree

payloads/messaging/v3.6/agent-chat-api/index.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ export { default as cart } from "./other-structures/cart.json";
1717
export { default as cartItem } from "./other-structures/cartItem.json";
1818
export { default as chat } from "./other-structures/chat.json";
1919
export { default as chatSummary } from "./other-structures/chatSummary.json";
20+
export { default as customerProperty } from "./other-structures/customerProperty.json";
2021
export { default as formFields } from "./other-structures/formFields.json";
2122
export { default as filledFormFields } from "./other-structures/filledFormFields.json";
2223
export { default as properties } from "./other-structures/properties.json";
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"value": 42,
3+
"last_updated_at": "2026-06-11T12:00:00Z",
4+
"last_updated_agent_account_id": "464d206a-ba7d-4ce1-98d6-d03f8f14970e",
5+
"last_updated_agent_client_id": "71d32c598862b01b9e2298281339dbc2"
6+
}

payloads/messaging/v3.6/agent-chat-api/users/customer.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,5 +116,13 @@
116116
"country": "United States",
117117
"state": "DC",
118118
"postal_code": "20500"
119+
},
120+
"customer_properties": {
121+
"550e8400-e29b-41d4-a716-446655440000": {
122+
"value": 42,
123+
"last_updated_at": "2026-06-11T12:00:00Z",
124+
"last_updated_agent_account_id": "464d206a-ba7d-4ce1-98d6-d03f8f14970e",
125+
"last_updated_agent_client_id": "71d32c598862b01b9e2298281339dbc2"
126+
}
119127
}
120128
}

src/pages/messaging/agent-chat-api/changelog/index.mdx

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,8 @@ The developer preview version provides a preview of the upcoming changes to the
3737

3838
### Customers
3939

40-
- The [**Customer**](/messaging/agent-chat-api/v3.7/data-structures#customer) data structure has new fields:
41-
- `carts`, an array of [**Cart**](/messaging/agent-chat-api/v3.7/data-structures#cart) objects,
42-
- `customer_properties`, a map of [**Customer Property**](/messaging/agent-chat-api/v3.7/data-structures#customer-property) objects.
4340
- The [**customer_updated**](/messaging/agent-chat-api/v3.7/rtm-pushes/#customer_updated) push now includes cart data.
4441
- The **Update Customer** ([Web](/messaging/agent-chat-api/v3.7/#update-customer) & [RTM](/messaging/agent-chat-api/v3.7/rtm-reference/#update-customer)) method now allows to clear the values of `name`, `email`, `phone_number` and `address` components by providing an empty string as the new field value.
45-
- There are new pushes:
46-
- [customer_properties_values_updated](/messaging/agent-chat-api/v3.7/rtm-pushes/#customer_properties_values_updated)
4742

4843
### Other
4944

@@ -79,11 +74,15 @@ The developer preview version provides a preview of the upcoming changes to the
7974
- [**ticket_created**](/messaging/agent-chat-api/rtm-pushes/#ticket_created)
8075
- [**ticket_deleted**](/messaging/agent-chat-api/rtm-pushes/#ticket_deleted)
8176
- [**customer_statistics_updated**](/messaging/agent-chat-api/rtm-pushes/#customer_statistics_updated)
77+
- [**customer_property_definition_created**](/messaging/agent-chat-api/rtm-pushes/#customer_property_definition_created)
78+
- [**customer_property_definition_updated**](/messaging/agent-chat-api/rtm-pushes/#customer_property_definition_updated)
79+
- [**customer_properties_values_updated**](/messaging/agent-chat-api/rtm-pushes/#customer_properties_values_updated)
8280
- The [**Customer**](/messaging/agent-chat-api/data-structures#customer) data structure now contains information about phone number and omnichannel data (when available).
8381
- The **Update Customer** ([Web](/messaging/agent-chat-api/#update-customer) & [RTM](/messaging/agent-chat-api/rtm-reference/#update-customer)) method has new fields, `phone_number` and `omnichannel`.
8482
- The `omnichannel` field now supports WhatsApp data: `id`, `name`, and `phone_number`.
8583
- The [**Customer**](/messaging/agent-chat-api/data-structures#customer) data structure now contains the customer's `address` information.
8684
- The [**Customer**](/messaging/agent-chat-api/data-structures#customer) data structure has a new `carts` field containing an array of [**Cart**](/messaging/agent-chat-api/data-structures#cart) objects.
85+
- The [**Customer**](/messaging/agent-chat-api/data-structures#customer) data structure has a new `customer_properties` field containing a map of [**Customer Property**](/messaging/agent-chat-api/data-structures#customer-property) objects.
8786
- The [**customer_updated**](/messaging/agent-chat-api/rtm-pushes/#customer_updated) push now includes cart data.
8887

8988
### Status

src/pages/messaging/agent-chat-api/data-structures/index.mdx

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -436,9 +436,10 @@ It is not possible to send a System event in API version 3.6.
436436
| `visit` | optional | |
437437
| `present` | optional | |
438438
| `statistics` | optional | |
439-
| `carts` | optional | An array of customer's shopping carts. See [Cart](#cart) for the object structure. |
439+
| `carts` | optional | An array of customer's shopping carts. See [Cart](#cart) for the object structure. |
440440
| `omnichannel` | optional | |
441441
| `address` | optional | An object of the customer's address data. |
442+
| `customer_properties` | optional | An object where the keys are the IDs of the [customer properties](#customer-property) and the values are their data. |
442443

443444
### Cart
444445

@@ -467,6 +468,20 @@ It is not possible to send a System event in API version 3.6.
467468
| `quantity` | `number` | The quantity of the item in the cart. |
468469
| `variant_id` | `number` | The variant ID of the item. |
469470

471+
### Customer Property
472+
473+
Customer properties are identified by the UUID generated in the [Create customer property definition](/management/customer-data-platform-api#/paths/~1v1~1create_customer_property_definition/post) method.
474+
The customer property's type is set on creation by the agent.
475+
476+
<CodeResponse version="v3.6" type="agent" title={'Sample Customer Property data structure'} json="customerProperty"/>
477+
478+
| Field | Req./Opt. | Data type | Notes |
479+
| ------------------------------- | --------- | --------- | ------------------------------------------------------------------------------------------ |
480+
| `value` | required | `any` | The current value of the property. The type is defined by the `CustomerPropertyType` enum. |
481+
| `last_updated_at` | required | `string` | RFC 3339 datetime string. |
482+
| `last_updated_agent_account_id` | optional | `string` | Account ID of the agent that last set this value. |
483+
| `last_updated_agent_client_id` | optional | `string` | Client ID of the application that last set this value. |
484+
470485
# Other common structures
471486

472487
Apart from [Events](#events) and [Users](#users), there are also other common data structures you might work with. Those are:

0 commit comments

Comments
 (0)