v1

latestOpenAPI 3.1.02026-07-266850126.1 KB
Contacts

Create a contact

post/v1/contacts

Request body

first_namestring nullable
last_namestring nullable
middle_namestring nullable
preferred_namestring nullable
primary_emailstring nullable
primary_phonestring nullable
company_namestring nullable
external_idstring nullable
contact_sincestring date-time nullable
type'individual' | 'company'
gender'male' | 'female' | 'other'
pronounsstring nullable
suffixstring nullable
prefixstring nullable
address_1string nullable
address_2string nullable
citystring nullable
statestring nullable
zipcodestring nullable
countrystring nullable
primary_address_1string nullable
primary_address_2string nullable
primary_citystring nullable
primary_statestring nullable
primary_zipcodestring nullable
primary_countrystring nullable
emailsstring[] nullable
phonesstring[] nullable
dobstring
employerstring nullable
companystring nullable
titlestring nullable
twitter_urlstring nullable
linkedin_urlstring nullable
facebook_urlstring nullable
tiktok_urlstring nullable
instagram_urlstring nullable
notestring nullable
email_subscriptionboolean nullable
phone_subscriptionboolean nullable
address_subscriptionboolean nullable
custom_fieldsstring[] nullable
tagsstring[] nullable
force_createboolean

Response

ContactResource

idstring required
external_idstring required
contact_sincestring required
typestring required
prefixstring required
first_namestring required
preferred_namestring required
middle_namestring required
last_namestring required
suffixstring required
genderstring required
pronounsstring required
dobstring required
companystring required
employerstring required
company_namestring required
titlestring required
website_urlstring required
twitter_urlstring required
linkedin_urlstring required
facebook_urlstring required
tiktok_urlstring required
instagram_urlstring required
primary_emailstring required
primary_phonestring required
notestring required
last_donation_amountstring required
tagsstring required
is_email_subscribedstring required
is_phone_subscribedstring required
is_address_subscribedstring required
email_opt_instring required
sms_opt_instring required
address_unsubscribed_atstring required
archived_atstring required
created_atstring required
updated_atstring required
salutation_namestring required