API Reference

UpdateAppDomainUserProfileEntity

Updates a ProfileEntity (Email) address from an old email to a new email address. This API should be called when the email address for a member changes in your underlying system.

Collapse Variations, Expand Variations

Variation 1

This is the basic command to update a user's ProfileEntity (Email address) using an AppDomain Shared Key

https://redcritterconnecter.com/services/management/UpdateAppDomainUserProfileEntity?appDomainSharedKey={appDomainSharedKey}&profileEntity={profileEntity}&newProfileEntity={newProfileEntity}

Name	Type	Required	Description
appDomainSharedKey	string	yes	This will be an App Domain Shared Key where the user has the Management App Admin permission.
profileEntity	string	yes	The ProfileEntity represents to whom the API call will apply. This will be the old email address that you are changing.
newProfileEntity	string	yes	The ProfileEntity represents to whom the API call will apply. This will be the new email address that you are changing to.

Responses

JSON, XML

XML Response

        
<?xml version="1.0" encoding="UTF-8"?>
<Response xmlns="Connecter" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <Aliases />
   <AppDomainUser>
      <AppDomainID>1</AppDomainID>
      <Created>2013-09-23T21:58:34.4</Created>
      <Deleted>false</Deleted>
      <Enabled>true</Enabled>
      <FirstName>Sam</FirstName>
      <HasThumb>true</HasThumb>
      <IsPersonal>false</IsPersonal>
      <LastName>Jones</LastName>
      <Modified>2015-01-26T19:56:17.5024909Z</Modified>
      <PersonalProfileRead>false</PersonalProfileRead>
      <ProfessionalProfileRead>false</ProfessionalProfileRead>
      <ProfileEntity>Sam@myMail.com</ProfileEntity>
      <ProfileIsPrivate>false</ProfileIsPrivate>
      <RewardPoints>283</RewardPoints>
      <UserAccessLevel>0</UserAccessLevel>
      <UserID>1234</UserID>
      <Username>Sam</Username>
   </AppDomainUser>
   <AppID>0</AppID>
   <Result>true</Result>
   <ResultMessage />
   <ResultTitle />
</Response>

JSON Response

        
{
  "AppID": 0,
  "AppDomainUser": {
    "AppDomainID": 1,
    "ProfileEntity": "Sammy4FSU@myMail.com",
    "UserID": 1234,
    "Username": "Sam",
    "FirstName": "Sam",
    "LastName": "Jones",
    "HasThumb": true,
    "UserAccessLevel": 0,
    "IsPersonal": false,
    "ProfessionalProfileRead": false,
    "PersonalProfileRead": false,
    "RewardPoints": 283,
    "ProfileIsPrivate": false,
    "Enabled": true,
    "Deleted": false,
    "Created": "2013-09-23T21:58:34.4",
    "Modified": "2015-01-26T19:52:41.7103776Z"
  },
  "Aliases": [],
  "Result": true,
  "ResultTitle": "",
  "ResultMessage": ""
}

Variation 2

This is the basic command to update a user's ProfileEntity (Email address) using a SessionID and AccountID

https://redcritterconnecter.com/services/management/UpdateAppDomainUserProfileEntity?sessionID={sessionID}&accountID={accountID}&appDomainID={appDomainID}&profileEntity={profileEntity}&newProfileEntity={newProfileEntity}

Name	Type	Required	Description
sessionID	string	yes	The SessionID is established when you are currently logged into the system using your RedCritter username or email and password. The SessionID must be created from a valid RedCritter Connecter account administrator login.
accountID	int64	yes	The AccountID is visible on the top of the Account page of the RedCritter Connecter Portal.
appDomainID	int64	yes	The appDomainID is the number representing the App Domain ID where you will be changing the ProfileEntity (email address).
profileEntity	string	yes	The ProfileEntity represents to whom the API call will apply. This will be the old email address that you are changing.
newProfileEntity	string	yes	The ProfileEntity represents to whom the API call will apply. This will be the new email address that you are changing to.

Responses

JSON, XML

XML Response

        
<?xml version="1.0" encoding="UTF-8"?>
<Response xmlns="Connecter" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
   <Aliases />
   <AppDomainUser>
      <AppDomainID>1</AppDomainID>
      <Created>2013-09-23T21:58:34.4</Created>
      <Deleted>false</Deleted>
      <Enabled>true</Enabled>
      <FirstName>Sam</FirstName>
      <HasThumb>true</HasThumb>
      <IsPersonal>false</IsPersonal>
      <LastName>Jones</LastName>
      <Modified>2015-01-26T19:56:17.5024909Z</Modified>
      <PersonalProfileRead>false</PersonalProfileRead>
      <ProfessionalProfileRead>false</ProfessionalProfileRead>
      <ProfileEntity>Sam@myMail.com</ProfileEntity>
      <ProfileIsPrivate>false</ProfileIsPrivate>
      <RewardPoints>283</RewardPoints>
      <UserAccessLevel>0</UserAccessLevel>
      <UserID>1234</UserID>
      <Username>Sam</Username>
   </AppDomainUser>
   <AppID>0</AppID>
   <Result>true</Result>
   <ResultMessage />
   <ResultTitle />
</Response>

JSON Response

        
{
  "AppID": 0,
  "AppDomainUser": {
    "AppDomainID": 1,
    "ProfileEntity": "Sammy4FSU@myMail.com",
    "UserID": 1234,
    "Username": "Sam",
    "FirstName": "Sam",
    "LastName": "Jones",
    "HasThumb": true,
    "UserAccessLevel": 0,
    "IsPersonal": false,
    "ProfessionalProfileRead": false,
    "PersonalProfileRead": false,
    "RewardPoints": 283,
    "ProfileIsPrivate": false,
    "Enabled": true,
    "Deleted": false,
    "Created": "2013-09-23T21:58:34.4",
    "Modified": "2015-01-26T19:52:41.7103776Z"
  },
  "Aliases": [],
  "Result": true,
  "ResultTitle": "",
  "ResultMessage": ""
}

API Information

Use	Configuration
Method	HTTP GET
Invites User	No
Billable	No
Response	JSON,XML
API Version	1