Login
      Contents x
      /Contacts
      • 18 Jan 2024
      • Print
      • PDF
      Contents

      /Contacts

      • Updated on 18 Jan 2024
      • Print
      • PDF
      Article summary

      Post
      /Contacts

      Add a contact.

      Security
      Http
      Type bearer
      Bearer Authorization Token
      Body parameters
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Expand All
      object
      Contact
      object (AspireCloud.ExternalApi.Contacts.Model.ContactRequest)Required
      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
      ContactTags
      string
      PayScheduleID
      integer (int32)
      Responses
      200

      Success

      string
      string
      string
      string
      string
      string
      string
      string
      string
      string
      string
      string
      string
      string
      string
      string
      Was this article helpful?
      What's Next
      Change password!
      Changing your password will log you out immediately. Use the new password to log back in.
      Change profile
      Success!
      First name must have atleast 2 characters. Numbers and special characters are not allowed.
      Last name must have atleast 1 characters. Numbers and special characters are not allowed.
      Enter a valid email
      Enter a valid password
      Your profile has been successfully updated.
      Logout