/Contacts
- 18 Jan 2024
- Print
- PDF
/Contacts
- Updated on 18 Jan 2024
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Put
/Contacts
Update an existing contact record.
Security
Http
Type bearer
Bearer Authorization Token
Body parameters
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactExtendedRequest)Required
DefaultWorkersCompName
string
DefaultWorkersCompStateProvinceCode
string
ContactID
integer (int32)
Maximum2147483647
Minimum1
FirstName
string Required
Min length1
LastName
string Required
Min length1
CompanyID
integer (int32)
ContactTypeID
integer (int32)
BranchID
integer (int32)
OwnerContactID
integer (int32)
OwnerContactName
string
Salutation
string
ProspectRating
integer (int32)
ProspectRatingName
string
Title
string
Email
string
MobilePhone
string
OfficePhone
string
HomePhone
string
Fax
string
Notes
string
Active
boolean
CreatedDateTime
string (date-time)
CreatedByUserName
string
EmployeeNumber
string
Website
string
EmployeePin
string
AccountingSyncID
string
ExternalContactReference
string
TerminationDate
string (date-time)
HRNotes
string
DefaultWorkersCompID
integer (int32)
UserID
integer (int32)
HomeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
OfficeAddress
object (AspireCloud.ExternalApi.Contacts.Model.ContactAddressRequest)
AddressLine1
string
Max length75
Min length0
AddressLine2
string
Max length75
Min length0
City
string
Max length50
Min length0
StateProvinceCode
string
Max length3
Min length0
ZipCode
string
Max length15
Min length0
HRDetail
integer (int32)
UpdateOpportunities
boolean
ResendEmails
boolean
UpdateInvoicesCompany
boolean
ContactTags
string
PayScheduleID
integer (int32)
UpdateEmailAddress
boolean
UpdatePin
boolean
UpdateTags
boolean
Responses
200
Success
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
Was this article helpful?