.png?sv=2022-11-02&spr=https&st=2024-12-22T16%3A11%3A13Z&se=2024-12-22T16%3A21%3A13Z&sr=c&sp=r&sig=%2BOEBeL7GN3YGY%2BIkKjoiVSKciSNCvAht1j2vpwXM4vo%3D){kind=logo}
/Contacts
- 16 Dec 2024
- 34 Minutes to read
- Print
- PDF
/Contacts
- Updated on 16 Dec 2024
- 34 Minutes to read
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/Contacts
Add a contact.
Security
HTTP
Type bearer
Bearer Authorization Token
Body parameters
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
object
Contact
object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest) 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
HomeAddress
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
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
ContactTags
string | null
PayScheduleID
integer (int32)
Responses
200
OK
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
string
Was this article helpful?