NOTE: Based on customer feedback regarding confusing functionality, the AI Search feature has been disabled. The excellent Keyword search continues to function normally. The Aspire team strives to optimizes the platform search tools to provide the best customer experience possible.

/Contacts

  • Published on Oct 24, 2025
  • 1 minute(s) read
Prev Next
Put
/Contacts
Security
HTTP
Type bearer

Bearer Authorization Token

Header parameters
api-version
string | null
Query parameters
api-version
string | null
Body parameters
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest) Required
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32) | null
ContactTypeID
integer (int32) | null
BranchID
integer (int32) | null
OwnerContactID
integer (int32) | null
OwnerContactName
string | null
Salutation
string | null
ProspectRating
integer (int32) | null
ProspectRatingName
string | null
Title
string | null
Email
string | null
MobilePhone
string | null
OfficePhone
string | null
HomePhone
string | null
Fax
string | null
Notes
string | null
Active
boolean
CreatedDateTime
string (date-time) | null
CreatedByUserName
string | null
EmployeeNumber
string | null
Website
string | null
EmployeePin
string | null
AccountingSyncID
string | null
ExternalContactReference
string | null
TerminationDate
string (date-time) | null
HRNotes
string | null
DefaultWorkersCompID
integer (int32) | null
UserID
integer (int32) | null
DefaultWorkersCompName
string | null
DefaultWorkersCompStateProvinceCode
string | null
ContactID
integer (int32)
Minimum1.0
Maximum2147483647.0
HomeAddress
OneOf
AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
OfficeAddress
OneOf
AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string | null
Min length0
Max length75
AddressLine2
string | null
Min length0
Max length75
City
string | null
Min length0
Max length50
StateProvinceCode
string | null
Min length0
Max length3
ZipCode
string | null
Min length0
Max length15
HRDetail
integer (int32) | null
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string | null

Comma-separated tag IDs associated with the contact.

PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
Responses
200
string