Skip to main content
PUT
Update a contact

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

contact
integer
required

The contact ID

Body

application/json
first_name
string | null

Required for individual contacts. Optional for company contacts, which require company_name instead.

Maximum string length: 255
last_name
string | null

Required for individual contacts. Optional for company contacts, which require company_name instead.

Maximum string length: 255
middle_name
string | null
Maximum string length: 255
preferred_name
string | null
Required string length: 1 - 255
gender
enum<string>
Available options:
male,
female,
other
pronouns
string | null
Required string length: 1 - 255
suffix
string | null
Maximum string length: 32
prefix
string | null
Maximum string length: 32
type
enum<string>

Determines which fields are required: individual contacts require a name, company contacts require company_name.

Available options:
individual,
company
company_name
string | null

Required for company contacts. Optional for individual contacts, which require first_name and last_name instead.

Maximum string length: 255
employer
string | null
Maximum string length: 255
company
string | null
Maximum string length: 255
title
string | null
Maximum string length: 255
twitter_url
string | null
linkedin_url
string | null
facebook_url
string | null
tiktok_url
string | null
website_url
string<uri> | null
Maximum string length: 2048
note
string | null
bio
string | null
Maximum string length: 2000
external_id
string | null
Maximum string length: 255
contact_since
string<date-time> | null
dob
string
email_opt_in
boolean | null
sms_opt_in
boolean | null
address_subscription
boolean | null
custom_fields
string[] | null
tags
string[] | null
Maximum string length: 64
remove_emails
string<email>[] | null
remove_phones
string[] | null
remove_address_ids
integer[] | null
emails
object[] | null
phones
object[] | null
addresses
object[] | null

Response

ContactResource

id
string
required
external_id
string
required
contact_since
string
required
type
string
required
prefix
string
required
first_name
string
required
preferred_name
string
required
middle_name
string
required
last_name
string
required
suffix
string
required
gender
string
required
pronouns
string
required
dob
string
required
company
string
required
employer
string
required
company_name
string
required
title
string
required
website_url
string
required
twitter_url
string
required
linkedin_url
string
required
facebook_url
string
required
tiktok_url
string
required
instagram_url
string
required
emails
EmailResource · object[]
required
phones
PhoneResource · object[]
required
primary_email
string
required
primary_phone
string
required
note
string
required
addresses
App.Http.Resources.API.AddressResource · object[]
required
primary_address
App.Http.Resources.API.AddressResource · object | null
required
last_donation_amount
string
required
stats
object
required
tags
string
required
custom_fields
any[]
required
external_ids
ExternalIdResource · object[]
required
is_email_subscribed
string
required
is_phone_subscribed
string
required
is_address_subscribed
string
required
email_opt_in
string
required
sms_opt_in
string
required
address_unsubscribed_at
string
required
archived_at
string
required
created_at
string
required
updated_at
string
required
salutation_name
string
required
point_of_contact
PointOfContactResource · object | null
associated_companies
AssociatedCompanyResource · object[] | null