POST api/v2.0/Contacts/UpdateProfilePicture?contactKey={contactKey}&legacyContactKey={legacyContactKey}
Accepts a Multipart MIME file via a POST Request. Uploads a profile image for the supplied user. * For use by Administrators only *.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
contactKey |
ContactKey for the user whose profile picture will be updated. Optional |
globally unique identifier |
None. |
legacyContactKey |
LegacyContactKey for the user whose profile picture will be updated. Optional |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
The details of the updated user.
ContactName | Description | Type | Additional information |
---|---|---|---|
LinkToProfile |
URL for this Contact's Community Site Profile page. |
string |
None. |
PictureUrl | string |
None. |
|
LargePictureUrl | string |
None. |
|
ContactKey | globally unique identifier |
None. |
|
FirstName | string |
None. |
|
LastName | string |
None. |
|
DisplayName | string |
None. |
|
EmailAddress | string |
None. |
|
ContactStatusCode | string |
None. |
|
PrefixCode | string |
None. |
|
UpdatedOn |
Last update date for this Contact. |
date |
None. |
UpdatedByContactKey | globally unique identifier |
None. |
|
CompanyName | string |
None. |
|
CompanyTitle | string |
None. |
|
SuffixCode | string |
None. |
|
Designation | string |
None. |
|
LegacyContactKey | string |
None. |
|
InformalName | string |
None. |
|
Phone1 | string |
None. |
|
Phone1Type | string |
None. |
|
Phone2 | string |
None. |
|
Phone2Type | string |
None. |
|
Phone3 | string |
None. |
|
Phone3Type | string |
None. |
|
Phone4 | string |
None. |
|
Phone4Type | string |
None. |
|
WebsiteUrl | string |
None. |
|
MemberAwardKey | globally unique identifier |
None. |
|
IsMember | boolean |
None. |
|
AgreedToTermsDateTime | date |
None. |
|
MemberId | string |
None. |
|
MaidenName | string |
None. |
|
PrimarySecurityGroupKey | globally unique identifier |
None. |
|
MiddleName | string |
None. |
|
IsCompany | boolean |
None. |
|
CompanyLegacyContactKey | string |
None. |
|
AMSDirectoryOptOut | boolean |
None. |
|
HLDirectoryOptOut | boolean |
None. |
|
HLContactMeOptOut | boolean |
None. |
|
EducationEntries | Collection of Education |
None. |
|
WorkHistory | Collection of WorkExperience |
None. |
|
Profile | Profile |
None. |
|
Addresses | Collection of Address |
None. |
|
UnreadMessageCount | integer |
None. |
|
LinkToVolunteerProfile |
URL for this Contact's Community Site Volunteer Profile page. |
string |
None. |
Demographics | Collection of Demographic |
None. |
Response Formats
application/json, text/json
{ "LinkToProfile": "sample string 1", "PictureUrl": "sample string 2", "LargePictureUrl": "sample string 3", "ContactKey": "3bef25c1-736c-488d-89b4-aeb512ed2c0b", "FirstName": "sample string 5", "LastName": "sample string 6", "DisplayName": "sample string 7", "EmailAddress": "sample string 8", "ContactStatusCode": "sample string 9", "PrefixCode": "sample string 10", "UpdatedOn": "2024-09-07T22:26:51.7486015Z", "UpdatedByContactKey": "47697d28-a319-4639-8821-f7eba6998980", "CompanyName": "sample string 13", "CompanyTitle": "sample string 14", "SuffixCode": "sample string 15", "Designation": "sample string 16", "LegacyContactKey": "sample string 17", "InformalName": "sample string 18", "Phone1": "sample string 19", "Phone1Type": "sample string 20", "Phone2": "sample string 21", "Phone2Type": "sample string 22", "Phone3": "sample string 23", "Phone3Type": "sample string 24", "Phone4": "sample string 25", "Phone4Type": "sample string 26", "WebsiteUrl": "sample string 27", "MemberAwardKey": "c9e02979-a718-46b7-b93f-8b083c441132", "IsMember": true, "AgreedToTermsDateTime": "2024-09-07T22:26:51.7486015Z", "MemberId": "sample string 30", "MaidenName": "sample string 31", "PrimarySecurityGroupKey": "28d43456-aed1-49dc-aa2c-504d99b8dba5", "MiddleName": "sample string 33", "IsCompany": true, "CompanyLegacyContactKey": "sample string 35", "AMSDirectoryOptOut": true, "HLDirectoryOptOut": true, "HLContactMeOptOut": true, "EducationEntries": [ { "ActivitiesSocieties": "sample string 1", "Advisor": "sample string 2", "City": "sample string 3", "CountryCode": "sample string 4", "CountryName": "sample string 5", "Degree": "sample string 6", "DegreeYear": 7, "Dissertation": "sample string 8", "EducationKey": "4a8f6e90-96b6-4357-bc8f-4e1e0438c987", "FieldOfStudy": "sample string 10", "FromYear": 11, "IsHighestDegreeAttained": true, "Notes": "sample string 13", "SchoolName": "sample string 14", "StateCode": "sample string 15", "StateName": "sample string 16", "ToYear": 17, "UpdatedOn": "2024-09-07T22:26:51.7486015Z" }, { "ActivitiesSocieties": "sample string 1", "Advisor": "sample string 2", "City": "sample string 3", "CountryCode": "sample string 4", "CountryName": "sample string 5", "Degree": "sample string 6", "DegreeYear": 7, "Dissertation": "sample string 8", "EducationKey": "4a8f6e90-96b6-4357-bc8f-4e1e0438c987", "FieldOfStudy": "sample string 10", "FromYear": 11, "IsHighestDegreeAttained": true, "Notes": "sample string 13", "SchoolName": "sample string 14", "StateCode": "sample string 15", "StateName": "sample string 16", "ToYear": 17, "UpdatedOn": "2024-09-07T22:26:51.7486015Z" } ], "WorkHistory": [ { "Country": "sample string 1", "Description": "sample string 2", "FromDate": "2024-09-07T22:26:51.7486015Z", "IsPresent": true, "IsPrimary": true, "JobExperienceKey": "8ed2e1ae-841d-4a9c-ad53-702a56f46439", "OrganizationName": "sample string 7", "OrganizationSize": 8, "OrganizationUrl": "sample string 9", "Place": "sample string 10", "State": "sample string 11", "Title": "sample string 12", "ToDate": "2024-09-07T22:26:51.7486015Z", "UpdatedOn": "2024-09-07T22:26:51.7486015Z" }, { "Country": "sample string 1", "Description": "sample string 2", "FromDate": "2024-09-07T22:26:51.7486015Z", "IsPresent": true, "IsPrimary": true, "JobExperienceKey": "8ed2e1ae-841d-4a9c-ad53-702a56f46439", "OrganizationName": "sample string 7", "OrganizationSize": 8, "OrganizationUrl": "sample string 9", "Place": "sample string 10", "State": "sample string 11", "Title": "sample string 12", "ToDate": "2024-09-07T22:26:51.7486015Z", "UpdatedOn": "2024-09-07T22:26:51.7486015Z" } ], "Profile": { "Certifications": "sample string 1", "Description": "sample string 2", "Expertise": "sample string 3", "ForwardComments": true, "ForwardCommunityInvitations": true, "ForwardContactRequests": true, "ForwardMessages": true, "Groups": "sample string 8", "ImageHeight": 9, "ImageWidth": 10, "Interests": "sample string 11", "IsSpeaker": true, "NotificationEmailAddress": "sample string 13" }, "Addresses": [ { "Address1": "sample string 1", "Address2": "sample string 2", "Address3": "sample string 3", "AddressKey": "7bc9d8b8-31dd-4bbc-9c3c-67839d17f571", "AddressType": "sample string 5", "City": "sample string 6", "CityStateCounty": "sample string 7", "CityStateCountyCountry": "sample string 8", "ContactKey": "57df4342-be7e-4fbc-a708-9e71656dc5a0", "CountryCode": "sample string 10", "CountryName": "sample string 11", "County": "sample string 12", "EmailAddress": "sample string 13", "FormattedAddress": "sample string 14", "FormattedAddressOneLine": "sample string 15", "FormattedAddressText": "sample string 16", "IsListCityState": true, "IsLoggingEnabled": true, "IsNew": true, "IsPreferredBill": true, "IsPreferredList": true, "IsPreferredMail": true, "ItemCreatedOn": "2024-09-07T22:26:51.7486015Z", "ItemEntityName": "sample string 24", "ItemName": "sample string 25", "ItemOwnerContactKey": "9a929e44-808c-4cb3-89fa-8e8647b418a8", "Latitude": 27.0, "LegacyAddressKey": "sample string 28", "Longitude": 29.0, "NearText": "sample string 30", "Phone1": "sample string 31", "Phone1Type": "sample string 32", "Phone2": "sample string 33", "Phone2Type": "sample string 34", "Phone3": "sample string 35", "Phone3Type": "sample string 36", "Phone4": "sample string 37", "Phone4Type": "sample string 38", "PostalCode": "sample string 39", "Region": "sample string 40", "StateProvinceCode": "sample string 41", "TimeZoneKey": "960d11fe-628f-43c9-987a-416328f742b9", "Town": "sample string 43", "TownOrCity": "sample string 44" }, { "Address1": "sample string 1", "Address2": "sample string 2", "Address3": "sample string 3", "AddressKey": "7bc9d8b8-31dd-4bbc-9c3c-67839d17f571", "AddressType": "sample string 5", "City": "sample string 6", "CityStateCounty": "sample string 7", "CityStateCountyCountry": "sample string 8", "ContactKey": "57df4342-be7e-4fbc-a708-9e71656dc5a0", "CountryCode": "sample string 10", "CountryName": "sample string 11", "County": "sample string 12", "EmailAddress": "sample string 13", "FormattedAddress": "sample string 14", "FormattedAddressOneLine": "sample string 15", "FormattedAddressText": "sample string 16", "IsListCityState": true, "IsLoggingEnabled": true, "IsNew": true, "IsPreferredBill": true, "IsPreferredList": true, "IsPreferredMail": true, "ItemCreatedOn": "2024-09-07T22:26:51.7486015Z", "ItemEntityName": "sample string 24", "ItemName": "sample string 25", "ItemOwnerContactKey": "9a929e44-808c-4cb3-89fa-8e8647b418a8", "Latitude": 27.0, "LegacyAddressKey": "sample string 28", "Longitude": 29.0, "NearText": "sample string 30", "Phone1": "sample string 31", "Phone1Type": "sample string 32", "Phone2": "sample string 33", "Phone2Type": "sample string 34", "Phone3": "sample string 35", "Phone3Type": "sample string 36", "Phone4": "sample string 37", "Phone4Type": "sample string 38", "PostalCode": "sample string 39", "Region": "sample string 40", "StateProvinceCode": "sample string 41", "TimeZoneKey": "960d11fe-628f-43c9-987a-416328f742b9", "Town": "sample string 43", "TownOrCity": "sample string 44" } ], "UnreadMessageCount": 39, "LinkToVolunteerProfile": "sample string 40", "Demographics": [ { "DemographicType": "sample string 1", "Values": [ "sample string 1", "sample string 2" ] }, { "DemographicType": "sample string 1", "Values": [ "sample string 1", "sample string 2" ] } ] }
application/xml, text/xml
<Contact xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise"> <AMSDirectoryOptOut>true</AMSDirectoryOptOut> <Addresses> <Address> <Address1>sample string 1</Address1> <Address2>sample string 2</Address2> <Address3>sample string 3</Address3> <AddressKey>7bc9d8b8-31dd-4bbc-9c3c-67839d17f571</AddressKey> <AddressType>sample string 5</AddressType> <City>sample string 6</City> <CityStateCounty>sample string 7</CityStateCounty> <CityStateCountyCountry>sample string 8</CityStateCountyCountry> <ContactKey>57df4342-be7e-4fbc-a708-9e71656dc5a0</ContactKey> <CountryCode>sample string 10</CountryCode> <CountryName>sample string 11</CountryName> <County>sample string 12</County> <EmailAddress>sample string 13</EmailAddress> <FormattedAddress>sample string 14</FormattedAddress> <FormattedAddressOneLine>sample string 15</FormattedAddressOneLine> <FormattedAddressText>sample string 16</FormattedAddressText> <IsListCityState>true</IsListCityState> <IsLoggingEnabled>true</IsLoggingEnabled> <IsNew>true</IsNew> <IsPreferredBill>true</IsPreferredBill> <IsPreferredList>true</IsPreferredList> <IsPreferredMail>true</IsPreferredMail> <ItemCreatedOn>2024-09-07T18:26:51.7486015-04:00</ItemCreatedOn> <ItemEntityName>sample string 24</ItemEntityName> <ItemName>sample string 25</ItemName> <ItemOwnerContactKey>9a929e44-808c-4cb3-89fa-8e8647b418a8</ItemOwnerContactKey> <Latitude>27</Latitude> <LegacyAddressKey>sample string 28</LegacyAddressKey> <Longitude>29</Longitude> <NearText>sample string 30</NearText> <Phone1>sample string 31</Phone1> <Phone1Type>sample string 32</Phone1Type> <Phone2>sample string 33</Phone2> <Phone2Type>sample string 34</Phone2Type> <Phone3>sample string 35</Phone3> <Phone3Type>sample string 36</Phone3Type> <Phone4>sample string 37</Phone4> <Phone4Type>sample string 38</Phone4Type> <PostalCode>sample string 39</PostalCode> <Region>sample string 40</Region> <StateProvinceCode>sample string 41</StateProvinceCode> <TimeZoneKey>960d11fe-628f-43c9-987a-416328f742b9</TimeZoneKey> <Town>sample string 43</Town> <TownOrCity>sample string 44</TownOrCity> </Address> <Address> <Address1>sample string 1</Address1> <Address2>sample string 2</Address2> <Address3>sample string 3</Address3> <AddressKey>7bc9d8b8-31dd-4bbc-9c3c-67839d17f571</AddressKey> <AddressType>sample string 5</AddressType> <City>sample string 6</City> <CityStateCounty>sample string 7</CityStateCounty> <CityStateCountyCountry>sample string 8</CityStateCountyCountry> <ContactKey>57df4342-be7e-4fbc-a708-9e71656dc5a0</ContactKey> <CountryCode>sample string 10</CountryCode> <CountryName>sample string 11</CountryName> <County>sample string 12</County> <EmailAddress>sample string 13</EmailAddress> <FormattedAddress>sample string 14</FormattedAddress> <FormattedAddressOneLine>sample string 15</FormattedAddressOneLine> <FormattedAddressText>sample string 16</FormattedAddressText> <IsListCityState>true</IsListCityState> <IsLoggingEnabled>true</IsLoggingEnabled> <IsNew>true</IsNew> <IsPreferredBill>true</IsPreferredBill> <IsPreferredList>true</IsPreferredList> <IsPreferredMail>true</IsPreferredMail> <ItemCreatedOn>2024-09-07T18:26:51.7486015-04:00</ItemCreatedOn> <ItemEntityName>sample string 24</ItemEntityName> <ItemName>sample string 25</ItemName> <ItemOwnerContactKey>9a929e44-808c-4cb3-89fa-8e8647b418a8</ItemOwnerContactKey> <Latitude>27</Latitude> <LegacyAddressKey>sample string 28</LegacyAddressKey> <Longitude>29</Longitude> <NearText>sample string 30</NearText> <Phone1>sample string 31</Phone1> <Phone1Type>sample string 32</Phone1Type> <Phone2>sample string 33</Phone2> <Phone2Type>sample string 34</Phone2Type> <Phone3>sample string 35</Phone3> <Phone3Type>sample string 36</Phone3Type> <Phone4>sample string 37</Phone4> <Phone4Type>sample string 38</Phone4Type> <PostalCode>sample string 39</PostalCode> <Region>sample string 40</Region> <StateProvinceCode>sample string 41</StateProvinceCode> <TimeZoneKey>960d11fe-628f-43c9-987a-416328f742b9</TimeZoneKey> <Town>sample string 43</Town> <TownOrCity>sample string 44</TownOrCity> </Address> </Addresses> <AgreedToTermsDateTime>2024-09-07T18:26:51.7486015-04:00</AgreedToTermsDateTime> <CompanyLegacyContactKey>sample string 35</CompanyLegacyContactKey> <CompanyName>sample string 13</CompanyName> <CompanyTitle>sample string 14</CompanyTitle> <ContactKey>3bef25c1-736c-488d-89b4-aeb512ed2c0b</ContactKey> <ContactStatusCode>sample string 9</ContactStatusCode> <Demographics> <Demographic> <DemographicType>sample string 1</DemographicType> <Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Values> </Demographic> <Demographic> <DemographicType>sample string 1</DemographicType> <Values xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:string>sample string 1</d4p1:string> <d4p1:string>sample string 2</d4p1:string> </Values> </Demographic> </Demographics> <Designation>sample string 16</Designation> <DisplayName>sample string 7</DisplayName> <EducationEntries> <Education> <ActivitiesSocieties>sample string 1</ActivitiesSocieties> <Advisor>sample string 2</Advisor> <City>sample string 3</City> <CountryCode>sample string 4</CountryCode> <CountryName>sample string 5</CountryName> <Degree>sample string 6</Degree> <DegreeYear>7</DegreeYear> <Dissertation>sample string 8</Dissertation> <EducationKey>4a8f6e90-96b6-4357-bc8f-4e1e0438c987</EducationKey> <FieldOfStudy>sample string 10</FieldOfStudy> <FromYear>11</FromYear> <IsHighestDegreeAttained>true</IsHighestDegreeAttained> <Notes>sample string 13</Notes> <SchoolName>sample string 14</SchoolName> <StateCode>sample string 15</StateCode> <StateName>sample string 16</StateName> <ToYear>17</ToYear> <UpdatedOn>2024-09-07T18:26:51.7486015-04:00</UpdatedOn> </Education> <Education> <ActivitiesSocieties>sample string 1</ActivitiesSocieties> <Advisor>sample string 2</Advisor> <City>sample string 3</City> <CountryCode>sample string 4</CountryCode> <CountryName>sample string 5</CountryName> <Degree>sample string 6</Degree> <DegreeYear>7</DegreeYear> <Dissertation>sample string 8</Dissertation> <EducationKey>4a8f6e90-96b6-4357-bc8f-4e1e0438c987</EducationKey> <FieldOfStudy>sample string 10</FieldOfStudy> <FromYear>11</FromYear> <IsHighestDegreeAttained>true</IsHighestDegreeAttained> <Notes>sample string 13</Notes> <SchoolName>sample string 14</SchoolName> <StateCode>sample string 15</StateCode> <StateName>sample string 16</StateName> <ToYear>17</ToYear> <UpdatedOn>2024-09-07T18:26:51.7486015-04:00</UpdatedOn> </Education> </EducationEntries> <EmailAddress>sample string 8</EmailAddress> <FirstName>sample string 5</FirstName> <HLContactMeOptOut>true</HLContactMeOptOut> <HLDirectoryOptOut>true</HLDirectoryOptOut> <InformalName>sample string 18</InformalName> <IsCompany>true</IsCompany> <IsMember>true</IsMember> <LargePictureUrl>sample string 3</LargePictureUrl> <LastName>sample string 6</LastName> <LegacyContactKey>sample string 17</LegacyContactKey> <LinkToProfile>sample string 1</LinkToProfile> <LinkToVolunteerProfile>sample string 40</LinkToVolunteerProfile> <MaidenName>sample string 31</MaidenName> <MemberAwardKey>c9e02979-a718-46b7-b93f-8b083c441132</MemberAwardKey> <MemberId>sample string 30</MemberId> <MiddleName>sample string 33</MiddleName> <Phone1>sample string 19</Phone1> <Phone1Type>sample string 20</Phone1Type> <Phone2>sample string 21</Phone2> <Phone2Type>sample string 22</Phone2Type> <Phone3>sample string 23</Phone3> <Phone3Type>sample string 24</Phone3Type> <Phone4>sample string 25</Phone4> <Phone4Type>sample string 26</Phone4Type> <PictureUrl>sample string 2</PictureUrl> <PrefixCode>sample string 10</PrefixCode> <PrimarySecurityGroupKey>28d43456-aed1-49dc-aa2c-504d99b8dba5</PrimarySecurityGroupKey> <Profile> <Certifications>sample string 1</Certifications> <Description>sample string 2</Description> <Expertise>sample string 3</Expertise> <ForwardComments>true</ForwardComments> <ForwardCommunityInvitations>true</ForwardCommunityInvitations> <ForwardContactRequests>true</ForwardContactRequests> <ForwardMessages>true</ForwardMessages> <Groups>sample string 8</Groups> <ImageHeight>9</ImageHeight> <ImageWidth>10</ImageWidth> <Interests>sample string 11</Interests> <IsSpeaker>true</IsSpeaker> <NotificationEmailAddress>sample string 13</NotificationEmailAddress> </Profile> <SuffixCode>sample string 15</SuffixCode> <UnreadMessageCount>39</UnreadMessageCount> <UpdatedByContactKey>47697d28-a319-4639-8821-f7eba6998980</UpdatedByContactKey> <UpdatedOn>2024-09-07T18:26:51.7486015-04:00</UpdatedOn> <WebsiteUrl>sample string 27</WebsiteUrl> <WorkHistory> <WorkExperience> <Country>sample string 1</Country> <Description>sample string 2</Description> <FromDate>2024-09-07T18:26:51.7486015-04:00</FromDate> <IsPresent>true</IsPresent> <IsPrimary>true</IsPrimary> <JobExperienceKey>8ed2e1ae-841d-4a9c-ad53-702a56f46439</JobExperienceKey> <OrganizationName>sample string 7</OrganizationName> <OrganizationSize>8</OrganizationSize> <OrganizationUrl>sample string 9</OrganizationUrl> <Place>sample string 10</Place> <State>sample string 11</State> <Title>sample string 12</Title> <ToDate>2024-09-07T18:26:51.7486015-04:00</ToDate> <UpdatedOn>2024-09-07T18:26:51.7486015-04:00</UpdatedOn> </WorkExperience> <WorkExperience> <Country>sample string 1</Country> <Description>sample string 2</Description> <FromDate>2024-09-07T18:26:51.7486015-04:00</FromDate> <IsPresent>true</IsPresent> <IsPrimary>true</IsPrimary> <JobExperienceKey>8ed2e1ae-841d-4a9c-ad53-702a56f46439</JobExperienceKey> <OrganizationName>sample string 7</OrganizationName> <OrganizationSize>8</OrganizationSize> <OrganizationUrl>sample string 9</OrganizationUrl> <Place>sample string 10</Place> <State>sample string 11</State> <Title>sample string 12</Title> <ToDate>2024-09-07T18:26:51.7486015-04:00</ToDate> <UpdatedOn>2024-09-07T18:26:51.7486015-04:00</UpdatedOn> </WorkExperience> </WorkHistory> </Contact>