Put User data

Description

This endpoint add or update a person in Engagement Hub based on their Email address. If a person with that email address already exists, the information in the packet will update the existing record. If it does not exist, a person record will be created. Only fields with values will update the existing values. E.g. a PersonalData packet with every field blank except FirstName will only update the value for FirstName.

The method will then return the full PersonalData object of the person being created or updated , and a return code of 0 or 1 for success or failure.

To update an email address, the KeyEmail will be the current email in the system, and the Email in the PersonalData packet will be the new one.


HTTP Method

put


URL

api/userdata

Query Parameters

Name Type
api-version optional <string>


Body

Name Type
KeyEmail

required <string>

*everything else is not required

 
{
  "KeyEmail": "string",
  "PersonalData": {
    "FirstName": "string",
    "LastName": "string",
    "NameOnID": "string",
    "Prefix": "string",
    "Suffix": "string",
    "HomeSiteID": "string",
    "Gender": "string",
    "Email": "string",
    "JobTitle": "string",
    "UserRole": "string",
    "DateOfBirth": "string",
    "Phone1": "string",
    "Phone2": "string",
    "Address": "string",
    "City": "string",
    "StateProvince": "string",
    "PostalCode": "string",
    "Country": "string",
    "CompanyName": "string",
    "CorporateID": "string",
    "Biography": "string",
    "ProfilePicture": "string",
    "IsActive": "string",
    "IsUser": "string",
    "IsSpeaker": "string",
    "IsExternal": "string"
  }
}

Response

{
  "KeyEmail": "string",
  "PersonalData": {
    "FirstName": "string",
    "LastName": "string",
    "NameOnID": "string",
    "Prefix": "string",
    "Suffix": "string",
    "HomeSiteID": "string",
    "Gender": "string",
    "Email": "string",
    "JobTitle": "string",
    "UserRole": "string",
    "DateOfBirth": "string",
    "Phone1": "string",
    "Phone2": "string",
    "Address": "string",
    "City": "string",
    "StateProvince": "string",
    "PostalCode": "string",
    "Country": "string",
    "CompanyName": "string",
    "CorporateID": "string",
    "Biography": "string",
    "ProfilePicture": "string",
    "IsActive": "string",
    "IsUser": "string",
    "IsSpeaker": "string",
    "IsExternal": "string"
  },
  "ReturnCode": 0
}

Example

{
  "KeyEmail": "janedoe@example.com",
  "PersonalData": {
    "FirstName": "Jane",
    "LastName": "Doe",
    "NameOnID": "Jane D. Doe",
    "Prefix": "Ms.",
    "Suffix": "Sr.",
    "HomeSiteID": "HS67890",
    "Gender": "Female",
    "Email": "janedoe@example.com",
    "JobTitle": "Project Manager",
    "UserRole": "Admin",
    "DateOfBirth": "1985-05-15",
    "Phone1": "+19876543210",
    "Phone2": "+10987654321",
    "Address": "5678 Side Ave",
    "City": "Rivertown",
    "StateProvince": "River State",
    "PostalCode": "67890",
    "Country": "Exampleland",
    "CompanyName": "Creative Solutions LLC",
    "CorporateID": "CI78901",
    "Biography": "Jane has over 15 years of experience managing high-profile tech projects and leading diverse teams.",
    "ProfilePicture": "http://example.com/path/to/jane.jpg",
    "IsActive": "true",
    "IsUser": "true",
    "IsSpeaker": "true",
    "IsExternal": "true"
  },
  "ReturnCode": 0
}

Success Response

Code: 200 OK