Skip to content

Customers

Create, fetch, update, delete, and bulk-create customer contacts.

Contact

Contact object returned in API responses. urls, social, and custom_fields are always present, as {} when the contact has none set. They are never omitted.

idstring
Example:"160018e3-57a6-480b-9811-9ac25b42501f"
first_namestring, <= 1500 characters
Example:"Eren"
last_namestring, <= 1500 characters
Example:"Yeager"
avatar_urlstring, (uri), <= 1500 characters

See RFC 3986 for URI syntax.

Example:"https://avatar.example.com/eren"
email_addressesArray of objects(ContactMethodEntry)

List of email entries with id, value, and primary flag.

phone_numbersArray of objects(ContactMethodEntry)

List of phone entries with id, value, and primary flag.

urlsobject(WebLinks)

Web links keyed by subtype. One entry per subtype. Set a value to an empty string to delete that subtype entry.

socialobject(SocialLinks)

Social profile links keyed by subtype. One entry per subtype. Set a value to an empty string to delete that subtype entry.

locationobject(ContactLocation)

Contact location. At least one field must be non-empty.

custom_fieldsobject(CustomFields)

Custom fields keyed by field name. Values are user-defined and may be any JSON scalar. Present as {} when the contact has none set.

Example:
{ "DOB": "14/08/1999" }
{ "id": "160018e3-57a6-480b-9811-9ac25b42501f", "first_name": "Eren", "last_name": "Yeager", "avatar_url": "https://avatar.example.com/eren", "email_addresses": [ { … } ], "phone_numbers": [ { … } ], "urls": { "web": "https://www.example.com", "meeting": "https://meet.example.com/john", "scheduling": "https://erenyeager7yl0.staging.setmore.com/eren" }, "social": { "facebook": "https://facebook.com/john.doe", "twitter": "https://twitter.com/john_doe", "youtube": "https://youtube.com/@john_doe", "instagram": "https://instagram.com/john_doe", "skype": "john.doe.skype", "linkedin": "https://linkedin.com/in/john-doe" }, "location": { "address": "21 Main Street", "city": "Chennai", "state": "Tamil Nadu", "country": "IN", "zip": "600001" }, "custom_fields": { "DOB": "14/08/1999" } }