Person
The person entity represents an individual contact involved in a commerce transaction. It stores personal details, contact information, addresses, and communication preferences.
| Field | Type | Description |
|---|---|---|
salesforceKey |
String | Salesforce ID for the contact. Used for specific anonymous user scenarios. |
key |
String | Dispatching platform key for the contact. |
partyType |
String | Always set to "person" when dealing with a contact. |
salutation |
String | Free-text salutation (e.g., "Mr", "Ms", "Dr"). |
firstName |
String | Person's first name. |
middleName |
String | Person's middle name. |
lastName |
String | Person's last name. |
gender |
String | Person's gender. Values: "male", "female", "unspecified". |
birthday |
String | Person's birthday in YYYY-MM-DD format only. |
dateOfDeath |
String | Person's date of death in YYYY-MM-DD format only. |
phoneType |
String | Person's phone type. Values: "home", "work", "other". |
phone |
String | Person's phone number. No validation or transformation is applied. |
emailType |
String | Person's email type. Values: "home", "work", "other". |
email |
String | Person's email address. |
photoUrl |
String | URL to the person's photo. |
mailingAddress |
Address | Person's primary mailing address. |
otherAddress |
Address | Person's secondary or alternative address. |
communication |
Communication | Communication preferences and permissions. |
custom |
Object | Custom key-value pairs for platform-specific data. |
questions |
Array of Question | Custom questions and answers associated with this person. |
createdAt |
DateTime | Creation date provided by the source platform. |
modifiedAt |
DateTime | Last modification date provided by the source platform. |