API Resource: Update Profiles – Member Clicks Pro

What is it?

The MemberClicks API Profile resource allows a 3rd party client to retrieve and update a user's profile information. This page specifically focuses on updating profile information.

Profile

A profile consists of field/value pairs where the field is the attribute name and the value is the profile value for that attribute. The attribute names of built-in and system attributes are surrounded by square brackets "[ ]" and custom attributes are not surrounded with brackets.

Built-in Attributes

Built-in attributes are a standard set of attributes that are available for every profile. Built-in attributes include the following types: name, contact name, email address, physical address, phone number and organization.

Name

The name built-in attribute consists of a prefix, first name, middle name or middle initial, last name, and suffix.

[Name | Prefix]: the name prefix. This field can be disabled for the organization.
[Name | First]: the first name
[Name | Middle]: the middle name or middle initial. This field can be disabled for the organization.
[Name | Last]: the last name
[Name | Suffix]: the name suffix. This field can be disabled for the organization.

Contact Name

[Contact Name]: the contact name

Email Address

A profile can have multiple email built-in attributes and each attribute is identified with a label. Primary labels are not supported for profile updates. The following is the format of the attribute name:

[Email | <label>]: the email address

Example: With two custom labels (Work, Home) the following would be the list of email address built-in attributes:

[Email | Work]: the work email address
[Email | Home]: the home email address

Address

The address built-in attribute is made up of six parts: line 1, line 2, city, state, zip and country. A profile can have multiple address built-in attributes and each attribute is identified with a label. Primary labels are not supported for profile updates. The following is the format of the attribute name:

[Address | <label> | Line 1]: the first line of the address
[Address | <label> | Line 2]: the second line of the address
[Address | <label> | City]: the address city
[Address | <label> | State]: the address state/province name or abbreviation
[Address | <label> | Zip]: the address zip code
[Address | <label> | Country]: the address country name

Example: With three custom labels (Business, Home, Mailing) the following would be the list of address built-in attributes for profile updates:

[Address | Business | Line 1]: the first line of the business address
[Address | Business | Line 2]: the second line of the business address
[Address | Business | City]: the business address city
[Address | Business | State]: the business address state/province name or abbreviation
[Address | Business | Zip]: the business address zip code
[Address | Business | Country]: the business address country name

[Address | Home | Line 1]: the first line of the home address
[Address | Home | Line 2]: the second line of the home address
[Address | Home | City]: the home address city
[Address | Home | State]: the home address state/province name or abbreviation
[Address | Home | Zip]: the home address zip code
[Address | Home | Country]: the home address country name

[Address | Mailing | Line 1]: the first line of the mailing address
[Address | Mailing | Line 2]: the second line of the mailing address
[Address | Mailing | City]: the mailing address city
[Address | Mailing | State]: the mailing address state/province name or abbreviation
[Address | Mailing | Zip]: the mailing address zip code
[Address | Mailing | Country]: the mailing address country name

Phone Number

A profile can have multiple phone built-in attributes and each attribute is identified with a label. Primary labels are not supported for profile updates. The following is the format of the attribute name:

[Phone | <label>]: the phone number

Example: With four custom labels (Home, Mobile, Office, Fax) the following would be the list of phone number built-in attributes for profile updates:

[Phone | Home]: the home phone number
[Phone | Mobile]: the mobile phone number
[Phone | Office]: the office phone number
[Phone | Fax]: the fax phone number

Organization

[Organization]: the organization name

System Attributes

System attributes are system level fields that are available for every profile. Supported systems attributes for update are as followed: group.

[Group]: the list of groups the profile belongs to

Custom Attributes

Custom attributes are attributes that are available to a profile based on the profile's member type. These attributes appear in the profile with the custom attribute name as the field name. Supported attributes for update are as followed: country, date, number, selection set, state/province, and, text. The following is a list of the supported custom attribute data types and a description of the attribute value.

Country: an array of country names
Date: a date
Number: a number
Selection Set: an array of selection set options
State/Province: an array of state/province names or abbreviations
Text: text

Update a Single Profile by Profile ID

This resource updates a single profile by profile ID.

Scope

To access this resource, the access token must have the write scope.

Permissions

This resource is available to users.

The list of attributes in the profile is restricted further by attribute security. If the profile ID belongs to the user, the attributes are restricted by profile owner attribute security. An attribute will be updated in the profile if the user has permission to edit the attribute on the profile. Additionally, updates must satisfy attribute settings

Request

The request to update the user's profile is an HTTP PUT to the /api/v1/profile/<profileId> endpoint. The following is the format of the request:

profileId: the profile ID
orgId: the MemberClicks organization ID
accessToken: the access token issued by the authorization server

Example

Using the example values below, the following is the resulting request:

profileId: 1001398943
orgId: apiexample
accessToken: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0NjgzNTE5NzcsInVzZXJfbmFtZSI6IjEwMDEzNDU2MzAiLCJzY29wZSI6WyJyZWFkIl0sInNlcnZpY2VJZCI6NzM0MCwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiIsIlJPTEVfRklOQU5DSUFMX0FETUlOIiwiUk9MRV9VU0VSIiwiUk9MRV9DTVNfQURNSU4iLCJST0xFX1BST0ZJTEVfSU1QT1JUX0FETUlOIiwiUk9MRV9QUk9GSUxFX0FETUlOIiwiUk9MRV9DT01NVU5JVFlfQURNSU4iLCJST0xFX01FTUJFUlNISVBfQURNSU4iLCJST0xFX0ZPUk1TX0FETUlOIiwiUk9MRV9SRVBPUlRJTkdfQURNSU4iXSwidXNlcklkIjoxMDAxMzQ1NjMwLCJqdGkiOiJkZDkwM2YwNC03Y2FjLTQyMDctOTY3Zi1jOTg2MmY1NDI5ZWYiLCJjbGllbnRfaWQiOiI4WmdaeFY5QjhyZHdWWEo4bHp1aCJ9.CyE4PPH9ZH9uvPSoUFRDZh6pO7VjAkF0MZ9IBcCRaxk

Response

A successful request will return an HTTP status 200 OK with the response in the following format:

More Examples

This section contains more example requests for updating a profile for every type of built-in, system and custom attribute supported. The following values will be used in the requests:

orgId: apiexample
accessToken: eyJhbGciOiJIUzI1NiJ9.eyJleHAiOjE0Njg0MjkwODUsInVzZXJfbmFtZSI6IjEwMDEzNDU2MzAiLCJzY29wZSI6WyJyZWFkIl0sInNlcnZpY2VJZCI6NzM0MCwiYXV0aG9yaXRpZXMiOlsiUk9MRV9BRE1JTiIsIlJPTEVfRklOQU5DSUFMX0FETUlOIiwiUk9MRV9VU0VSIiwiUk9MRV9DTVNfQURNSU4iLCJST0xFX1BST0ZJTEVfSU1QT1JUX0FETUlOIiwiUk9MRV9QUk9GSUxFX0FETUlOIiwiUk9MRV9DT01NVU5JVFlfQURNSU4iLCJST0xFX01FTUJFUlNISVBfQURNSU4iLCJST0xFX0ZPUk1TX0FETUlOIiwiUk9MRV9SRVBPUlRJTkdfQURNSU4iXSwidXNlcklkIjoxMDAxMzQ1NjMwLCJqdGkiOiI0YjQzM2Y3Ni02MjdiLTRhZDAtYWY5OS0xYmIzMDVjNTg2ZDUiLCJjbGllbnRfaWQiOiI4WmdaeFY5QjhyZHdWWEo4bHp1aCJ9.pweM-vqkOlb1EUItSfbFrrbVrC-OKGMhIDiAFPt4m8I

Update Name Example

In order to update a prefix, prefix name settings must be enabled, and the prefix must exist in attribute name settings. In order to update a suffix, suffix name settings must be enabled, and the suffix must exist in attribute name settings.

Update a profile's name to "Dr. John S. Smith, PhD":

Update Name Prefix Example

When updating only the prefix name, the rest of the name will remain unchanged.

Prefix name settings must be enabled, and the prefix must exist in attribute name settings.

Update a profile's name prefix to "Dr.":

Update First Name Example

When updating only the first name, the rest of the name will remain unchanged.

Update a profile's first name to "Jeff":

Update Middle Name Example

When updating only the middle name, the rest of the name will remain unchanged.

Middle name settings must be enabled and set to "Middle Name".

Update a profile's middle name to "Matt":

Update Middle Initial Example

When updating only the middle initial, the rest of the name will remain unchanged.

Middle name settings must be enabled and set to "Middle Initial".

Update a profile's middle initial to "M":

Update Last Name Example

When updating only the last name, the rest of the name will remain unchanged.

Update a profile's last name to "Williams":

Update Name Suffix Example

When updating only the suffix, the rest of the name will remain unchanged.

Suffix name settings must be enabled, and the suffix must exist in attribute name settings.

Update a profile's name suffix is "II":

Update Contact Name Example

If a contact name is set to an empty string, the profile's contact name will be defaulted to the full name. The default full name is based on attribute name settings.

Update a profile's contact name to "Matt Williams":

Update Email Example

Primary e-mail labels can not be explicitly updated. Instead, the primary will be calculated based on e-mail settings. If a profile's primary email address value is set to an empty string, then a new primary e-mail address will be calculated.

Update a profile's "Work" email address to "help@memberclicks.com":

Update Address Example

Primary address labels can not be explicitly updated. Instead, the primary will be calculated based on address settings. If a profile's primary address value is set to an incomplete address, then a new primary address will be calculated. Complete addresses have values set for line 1, city, and zip.

Update a profile's "Business" address to:

Update Address Line 1 Example

When updating only line 1 of an address, the rest of the address will remain unchanged.

Update a profile's "Business" address line 1 to "571 Monon Blvd":

Update Address Line 2 Example

When updating only line 2 of an address, the rest of the address will remain unchanged.

Update a profile's "Business" address line 2 to "Suite 125":

Update Address City Example

When updating only the city of an address, the rest of the address will remain unchanged.

Update a profile's "Business" address city to "Carmel":

Update by Address State/Province Example

When updating only the state of an address, the rest of the address will remain unchanged.

When updating a state/province, you can enter the full state/province name or abbreviation. For example, you can enter "Georgia" or "GA" for the attribute value.

Update a profile's "Business" address state to "Georgia":

Update Address Zip Example

When updating only the zip code of an address, the rest of the address will remain unchanged.

Update a profile's "Business" address zip to "46032":

Update Address Country Example

When updating only the country of an address, the rest of the address will remain unchanged.

Update a profile's "Business" address country to "United States":

Update by Phone Example

Primary phone labels can not be explicitly updated. Instead, the primary will be calculated based on phone settings. If a profile's primary phone number value is set to an empty string, a new primary phone number will be calculated.

Update a profile's "Mobile" phone number to "404-879-2800":

Update Organization Example

If a linked profile's organization is set to an empty string, the organization will default to organization name on the organization profile. If an organization profile's is updated, then any linked profile will have their organization updated.

Update a profile's organization to "MemberClicks":

Update Group Example

The group name must exist and the member type group must be included. Any groups on the profile and not on the API request will be removed.

When updating by group, you must enter list of group names.

Update a profile's groups to "Member", and "Retired".

Update a Profile's Text Custom Attribute Example

Update a profile's School custom attribute to "Harvard University":

Update a Profile's Number Custom Attribute Example

Update a profile's Number of Employees custom attribute to "10".

Update by Date Custom Attribute Example

Format must be MM/DD/YYYY

Update a profile's Birthday custom attribute to "01/28/1981".

Update Selection Set Custom Attribute Example

The selection set option must exist. Any selection set options on the profile and not on the API request will be removed from the profile.

With selection set custom attributes, you must enter list of selection set options.

Update a profile's Sports custom attribute to have "Baseball", Basketball" and "Football" selected.

Update a profile's Sports custom attribute to have "Baseball" selected.

Update a profile's Sports custom attribute to have no selection selected

Update State Custom Attribute Example

Any state value on the profile and not on the API request will be removed from the profile.

When updating a profile's state custom attribute, you must enter list of states. You can enter the full state/province name or abbreviation. For example, you can enter "Florida" or "FL" for the attribute value.

Update a profile's State custom attribute to have "Florida" and "GA" selected:

Update a profile's State custom attribute to have "GA" selected:

Update a profile's State custom attribute to have no states selected:

Update Country Custom Attribute Example

Any country value on the profile and not on the API request will be removed.

When updating country custom attribute, you must enter a list of countries.

Update a profile's Country custom attribute to have "France", "Germany" and "Spain" selected.

Update a profile's Country custom attribute to have "France" selected.

Update a profile's Country custom attribute to have no countries selected.

Articles in this section