POST api/HpProUser/UpdateUserProfile

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
AgentNumber	string	None.
ChangedBy	integer	None.
ChangedDate	date	None.
CreateDate	date	None.
CreatedBy	integer	None.
Disabled	boolean	None.
Email	string	None.
FirstName	string	None.
Id	integer	None.
LanguageId	integer	None.
LastName	string	None.
OfficeId	integer	None.
Phone	string	None.
StateId	integer	None.
UnionId	integer	None.
UserId	integer	None.
ForcePasswordChange	boolean	None.
ShowCompanyPolicyAfterLogin	boolean	None.
ProfileImageBase64Data	string	None.
UserName	string	None.
Licenses	Collection of LicenseDTO	None.
ShowCompanyPolicyInEditProfile	boolean	None.
CompanyPolicyReviewdOrSkippedDate	date	None.
CompanyPolicyCompletedDate	date	None.
SkipAgentAgreementCount	integer	None.
SkipEditProfileCount	integer	None.
AgentAgreementSkippedDate	date	None.
AgentAgreementCompletedDate	date	None.
EditProfileSkippedDate	date	None.
ShowAgentAgreementInEditProfile	boolean	None.
ShowAgentAgreementAfterLogin	boolean	None.
ShowEditProfileAfterLogin	boolean	None.
AssociateId	integer	None.
TimeZoneOffset	decimal number	None.
MessageCount	integer	None.
TrainingMessageCount	integer	None.
MmsServiceAllowed	boolean	None.
VeteranSmbAllowed	boolean	None.
ShowVerificationUi	boolean	None.
TwilioNumber	string	None.
MFAType	integer	None.
MFAPhoneNumber	string	None.
MFAEmail	string	None.
MFAAuthenticatorKey	globally unique identifier	None.
MFAQuestionAnswer	string	None.
TotpSid	string	None.
SecurityQuestion	integer	None.
AttemptsCount	integer	None.
SkipMFA	integer	None.
IsMFALock	boolean	None.
MFALockDate	date	None.
AllowMFABypass	boolean	None.
UserRoles	Collection of integer	None.
UplineHierarchyUsers	Collection of UplineHierarchyUserShortDetail	None.

Request Formats

application/json, text/json

Sample:

{
  "AgentNumber": "sample string 1",
  "ChangedBy": 1,
  "ChangedDate": "2025-10-14T00:37:33.8264052-07:00",
  "CreateDate": "2025-10-14T00:37:33.8264052-07:00",
  "CreatedBy": 1,
  "Disabled": true,
  "Email": "sample string 4",
  "FirstName": "sample string 5",
  "Id": 6,
  "LanguageId": 1,
  "LastName": "sample string 7",
  "OfficeId": 1,
  "Phone": "sample string 8",
  "StateId": 1,
  "UnionId": 1,
  "UserId": 9,
  "ForcePasswordChange": true,
  "ShowCompanyPolicyAfterLogin": true,
  "ProfileImageBase64Data": "sample string 12",
  "UserName": "sample string 13",
  "Licenses": [
    {
      "ChangeBy": 1,
      "ChangeDate": "2025-10-14T00:37:33.8264052-07:00",
      "CreateDate": "2025-10-14T00:37:33.8264052-07:00",
      "CreatedBy": 2,
      "Disabled": true,
      "HpUserId": 4,
      "Id": 5,
      "IsPrimary": true,
      "LicenseNumber": "sample string 7",
      "StateId": 8,
      "StateName": "sample string 9",
      "StateCode": "sample string 10"
    },
    {
      "ChangeBy": 1,
      "ChangeDate": "2025-10-14T00:37:33.8264052-07:00",
      "CreateDate": "2025-10-14T00:37:33.8264052-07:00",
      "CreatedBy": 2,
      "Disabled": true,
      "HpUserId": 4,
      "Id": 5,
      "IsPrimary": true,
      "LicenseNumber": "sample string 7",
      "StateId": 8,
      "StateName": "sample string 9",
      "StateCode": "sample string 10"
    }
  ],
  "ShowCompanyPolicyInEditProfile": true,
  "CompanyPolicyReviewdOrSkippedDate": "2025-10-14T00:37:33.8264052-07:00",
  "CompanyPolicyCompletedDate": "2025-10-14T00:37:33.8264052-07:00",
  "SkipAgentAgreementCount": 1,
  "SkipEditProfileCount": 1,
  "AgentAgreementSkippedDate": "2025-10-14T00:37:33.8264052-07:00",
  "AgentAgreementCompletedDate": "2025-10-14T00:37:33.8264052-07:00",
  "EditProfileSkippedDate": "2025-10-14T00:37:33.8264052-07:00",
  "ShowAgentAgreementInEditProfile": true,
  "ShowAgentAgreementAfterLogin": true,
  "ShowEditProfileAfterLogin": true,
  "AssociateId": 18,
  "TimeZoneOffset": 1.0,
  "MessageCount": 1,
  "TrainingMessageCount": 1,
  "MmsServiceAllowed": true,
  "VeteranSmbAllowed": true,
  "ShowVerificationUi": true,
  "TwilioNumber": "sample string 19",
  "MFAType": 1,
  "MFAPhoneNumber": "sample string 20",
  "MFAEmail": "sample string 21",
  "MFAAuthenticatorKey": "3f98f076-4ae1-49d6-bf25-edb617932558",
  "MFAQuestionAnswer": "sample string 22",
  "TotpSid": "sample string 23",
  "SecurityQuestion": 1,
  "AttemptsCount": 1,
  "SkipMFA": 1,
  "IsMFALock": true,
  "MFALockDate": "2025-10-14T00:37:33.8264052-07:00",
  "AllowMFABypass": true,
  "UserRoles": [
    1,
    2
  ],
  "UplineHierarchyUsers": [
    {
      "AssociateContractId": 1,
      "AssociateId": 1,
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "FullName": "sample string 3",
      "RoleName": "sample string 4",
      "LocationCode": "sample string 5"
    },
    {
      "AssociateContractId": 1,
      "AssociateId": 1,
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "FullName": "sample string 3",
      "RoleName": "sample string 4",
      "LocationCode": "sample string 5"
    }
  ]
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HPProUserDTO

Name	Type	Additional information
AgentNumber	string	None.
ChangedBy	integer	None.
ChangedDate	date	None.
CreateDate	date	None.
CreatedBy	integer	None.
Disabled	boolean	None.
Email	string	None.
FirstName	string	None.
Id	integer	None.
LanguageId	integer	None.
LastName	string	None.
OfficeId	integer	None.
Phone	string	None.
StateId	integer	None.
UnionId	integer	None.
UserId	integer	None.
ForcePasswordChange	boolean	None.
ShowCompanyPolicyAfterLogin	boolean	None.
ProfileImageBase64Data	string	None.
UserName	string	None.
Licenses	Collection of LicenseDTO	None.
ShowCompanyPolicyInEditProfile	boolean	None.
CompanyPolicyReviewdOrSkippedDate	date	None.
CompanyPolicyCompletedDate	date	None.
SkipAgentAgreementCount	integer	None.
SkipEditProfileCount	integer	None.
AgentAgreementSkippedDate	date	None.
AgentAgreementCompletedDate	date	None.
EditProfileSkippedDate	date	None.
ShowAgentAgreementInEditProfile	boolean	None.
ShowAgentAgreementAfterLogin	boolean	None.
ShowEditProfileAfterLogin	boolean	None.
AssociateId	integer	None.
TimeZoneOffset	decimal number	None.
MessageCount	integer	None.
TrainingMessageCount	integer	None.
MmsServiceAllowed	boolean	None.
VeteranSmbAllowed	boolean	None.
ShowVerificationUi	boolean	None.
TwilioNumber	string	None.
MFAType	integer	None.
MFAPhoneNumber	string	None.
MFAEmail	string	None.
MFAAuthenticatorKey	globally unique identifier	None.
MFAQuestionAnswer	string	None.
TotpSid	string	None.
SecurityQuestion	integer	None.
AttemptsCount	integer	None.
SkipMFA	integer	None.
IsMFALock	boolean	None.
MFALockDate	date	None.
AllowMFABypass	boolean	None.
UserRoles	Collection of integer	None.
UplineHierarchyUsers	Collection of UplineHierarchyUserShortDetail	None.

Response Formats

application/json, text/json

Sample:

{
  "AgentNumber": "sample string 1",
  "ChangedBy": 1,
  "ChangedDate": "2025-10-14T00:37:33.8264052-07:00",
  "CreateDate": "2025-10-14T00:37:33.8264052-07:00",
  "CreatedBy": 1,
  "Disabled": true,
  "Email": "sample string 4",
  "FirstName": "sample string 5",
  "Id": 6,
  "LanguageId": 1,
  "LastName": "sample string 7",
  "OfficeId": 1,
  "Phone": "sample string 8",
  "StateId": 1,
  "UnionId": 1,
  "UserId": 9,
  "ForcePasswordChange": true,
  "ShowCompanyPolicyAfterLogin": true,
  "ProfileImageBase64Data": "sample string 12",
  "UserName": "sample string 13",
  "Licenses": [
    {
      "ChangeBy": 1,
      "ChangeDate": "2025-10-14T00:37:33.8264052-07:00",
      "CreateDate": "2025-10-14T00:37:33.8264052-07:00",
      "CreatedBy": 2,
      "Disabled": true,
      "HpUserId": 4,
      "Id": 5,
      "IsPrimary": true,
      "LicenseNumber": "sample string 7",
      "StateId": 8,
      "StateName": "sample string 9",
      "StateCode": "sample string 10"
    },
    {
      "ChangeBy": 1,
      "ChangeDate": "2025-10-14T00:37:33.8264052-07:00",
      "CreateDate": "2025-10-14T00:37:33.8264052-07:00",
      "CreatedBy": 2,
      "Disabled": true,
      "HpUserId": 4,
      "Id": 5,
      "IsPrimary": true,
      "LicenseNumber": "sample string 7",
      "StateId": 8,
      "StateName": "sample string 9",
      "StateCode": "sample string 10"
    }
  ],
  "ShowCompanyPolicyInEditProfile": true,
  "CompanyPolicyReviewdOrSkippedDate": "2025-10-14T00:37:33.8264052-07:00",
  "CompanyPolicyCompletedDate": "2025-10-14T00:37:33.8264052-07:00",
  "SkipAgentAgreementCount": 1,
  "SkipEditProfileCount": 1,
  "AgentAgreementSkippedDate": "2025-10-14T00:37:33.8264052-07:00",
  "AgentAgreementCompletedDate": "2025-10-14T00:37:33.8264052-07:00",
  "EditProfileSkippedDate": "2025-10-14T00:37:33.8264052-07:00",
  "ShowAgentAgreementInEditProfile": true,
  "ShowAgentAgreementAfterLogin": true,
  "ShowEditProfileAfterLogin": true,
  "AssociateId": 18,
  "TimeZoneOffset": 1.0,
  "MessageCount": 1,
  "TrainingMessageCount": 1,
  "MmsServiceAllowed": true,
  "VeteranSmbAllowed": true,
  "ShowVerificationUi": true,
  "TwilioNumber": "sample string 19",
  "MFAType": 1,
  "MFAPhoneNumber": "sample string 20",
  "MFAEmail": "sample string 21",
  "MFAAuthenticatorKey": "f1099011-4aec-4960-8ef5-04b041ad07af",
  "MFAQuestionAnswer": "sample string 22",
  "TotpSid": "sample string 23",
  "SecurityQuestion": 1,
  "AttemptsCount": 1,
  "SkipMFA": 1,
  "IsMFALock": true,
  "MFALockDate": "2025-10-14T00:37:33.8264052-07:00",
  "AllowMFABypass": true,
  "UserRoles": [
    1,
    2
  ],
  "UplineHierarchyUsers": [
    {
      "AssociateContractId": 1,
      "AssociateId": 1,
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "FullName": "sample string 3",
      "RoleName": "sample string 4",
      "LocationCode": "sample string 5"
    },
    {
      "AssociateContractId": 1,
      "AssociateId": 1,
      "FirstName": "sample string 1",
      "LastName": "sample string 2",
      "FullName": "sample string 3",
      "RoleName": "sample string 4",
      "LocationCode": "sample string 5"
    }
  ]
}