API – Customer References
General
To add a reference to a customer, send a PUT request to the URL of the customer.
Below is a sample body of a PUT request:
{
"References": {
"results": [
{
"name": "John Doe",
"relation": "customerReference.relation.friend",
"Address": {
"country": "company.country.usa",
"address1": "123 Oak Lane",
"zipcode": "12345",
"city": "Schenectady",
"state": "geo.state.ME"
},
"primaryPhone": "5554444444",
"secondaryPhone": "5555555555"
}
]
},
"__id": "22",
"__update": true
}- References – The information for references to add/update
- name – The name of the reference
- relation – The relation of the reference to the customer. Formatted “customerReference.relation.<referenceType>”
- Options for “<referenceTyp>” are: “brother”,”coWorker”, “daughter”, “father”, “friend”, “husband”, “mother”, “sister”, “son”, and “wife”
- Address – The address of the reference. See API – Addresses
- primaryPhone – The primary phone number of the reference
- secondaryPhone – The secondary phone number of the reference
- __id – The id of the customer
- __update – Set to “true”