update

This method updates an existing user record and returns the record's unique identifier. The list of fields that can be updated is customizable for each organization and is different for administrative and non-administrative users. The fields that can be updated by the caller can be retrieved using the listUserFields API method.

Client Servlet Server Servlet HTTP Methods Supported Requires Authentication
CRConsAPI SRConsAPI POST Yes.

Client API Syntax

https://secure2.convio.net/organization/site/CRConsAPI?method=update &api_key=value &v=value [ &auth=value ] [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] [ &add_center_ids=value ] [ &add_center_opt_in_ids=value ] [ &add_group_ids=value ] [ &add_interest_ids=value ] [ &cons_id=value ] [ &interaction_body=value ] [ &interaction_cat_id=value ] [ &interaction_count=value ] [ &interaction_subject=value ] [ &member_id=value ] [ &primary_email=value ] [ &remove_center_ids=value ] [ &remove_center_opt_in_ids=value ] [ &remove_group_ids=value ] [ &remove_interest_ids=value ] [ &suppress_cleaning=value ] [ &auth=value ] [ &sso_auth_token=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRConsAPI?method=update & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] [ & add_center_ids =value ] [ & add_center_opt_in_ids =value ] [ & add_group_ids =value ] [ & add_interest_ids =value ] [ & cons_id =value ] [ & interaction_body =value ] [ & interaction_cat_id =value ] [ & interaction_count =value ] [ & interaction_subject =value ] [ & member_id =value ] [ & primary_email =value ] [ & remove_center_ids =value ] [ & remove_center_opt_in_ids =value ] [ & remove_group_ids =value ] [ & remove_interest_ids =value ] [ & suppress_cleaning =value ]

Usage Notes

This method attempts to locate and update an existing constituent record in the Luminate Online Constituent 360 database using the value of the cons_id, member_id, or primary_email parameters to locate the record.

If called as a Client API, this method requires authentication. If the requester is an administrator (normally only the case using the Server API):
  1. One of cons_id, member_id, or primary_email must be specified in order to locate the record to update.
  2. The order of precedence of the search terms is (a) cons_id (b) member_id, then (c) primary_email. If a record is not found or if multiple records are returned by any specified search term evaluated in this order, the method returns an error.
  3. If a request specifies more than one search parameter, then the system will attempt to update the values of lower-precedence parameters using the values provided. This may result in an error if a duplicate value exists in the database for a specified member_id or primary_email.
If the requester is a constituent using the Client API:
  1. An authentication token representing the logged-in user must be passed.
  2. If the logged-in user is not an administrator, only the constituent record of the logged in user may be updated.

The list of constituent record fields that can be set is customizable for each organization. It is different for administrative users (via the Client or Server API) and non-administrative users (via Client API).

listUserFields will return the list of the Constituent record fields the caller may update.

This method automatically invokes logInteraction to log an interaction for the target constituent.

Note: This method will not allow you to add the created constituent directly to an Interest Opt-In or Opt-Out group. You should instead add or remove the interest to the constituent, which will adjust the group membership as appropriate.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

add_center_ids

Optional. Comma-separated list of numeric IDs of centers to add the user to.

Type xsd:string.

add_center_opt_in_ids

Optional. Comma-separated list of numeric IDs of centers for which the user should be opted in to email communications.

Type xsd:string.

add_group_ids

Optional. Comma-separated list of numeric IDs of groups to add the user to. Only available when called using an administrator account. Cannot be used for pre-defined groups (those with IDs less than 1000). Cannot be used for administrator security groups.

Type xsd:string.

add_interest_ids

Optional. Comma-separated list of numeric IDs of email interests to add the user to. If the added interest is specific to a center, the constituent is also added to that center automatically.

Type xsd:string.

cons_id

Optional. The constituent ID (Luminate Online ID) that uniquely identifies the constituent. This value is automatically assigned when a new constituent record is created. It can be used to uniquely identify a constituent record to read or update it. Only available when called using an administrator account.

Type xsd:string.

interaction_body

Optional. Text describing or associated with the interaction.

Type xsd:string.

interaction_cat_id

Optional. The Security Category associated with this interaction. The default is 0, which corresponds to the "General" category.

Type xsd:nonNegativeInteger.

Default is 0.

interaction_count

Optional. The number of times the constituent performed this interaction.

Type xsd:nonNegativeInteger.

Default is 1.

interaction_subject

Optional. Short, descriptive subject of the user interaction. Can be up to 80 characters in length.

Type xsd:string.

member_id

Optional. The member ID (Client ID) that uniquely identifies the constituent.

Type xsd:string.

primary_email

Optional. The primary email address that uniquely identifies the constituent. Required to create a new constituent record. Optional when updating a record.

Type xsd:string.

remove_center_ids

Optional. Comma-separated list of numeric IDs of centers to remove the user from.

Type xsd:string.

remove_center_opt_in_ids

Optional. Comma-separated list of numeric IDs of centers for which the user should be opted out of email communications.

Type xsd:string.

remove_group_ids

Optional. Comma-separated list of numeric IDs of groups to remove the user from. Only valid when updating records. Only available when called using an administrator account. Cannot be used for pre-defined groups (those with IDs less than 1000). Cannot be used for administrator security groups.

Type xsd:string.

remove_interest_ids

Optional. Comma-separated list of numeric IDs of email interests to remove the user from. Only valid when updating records.

Type xsd:string.

suppress_cleaning

Optional. Specifies whether data cleaning/standardization should be turned on or off. This parameter is intended for performance tuning for server side batch APIs calls.

Type xsd:boolean.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

add_center_ids

Optional. Comma-separated list of numeric IDs of centers to add the user to.

Type xsd:string.

add_center_opt_in_ids

Optional. Comma-separated list of numeric IDs of centers for which the user should be opted in to email communications.

Type xsd:string.

add_group_ids

Optional. Comma-separated list of numeric IDs of groups to add the user to. Only available when called using an administrator account. Cannot be used for pre-defined groups (those with IDs less than 1000). Cannot be used for administrator security groups.

Type xsd:string.

add_interest_ids

Optional. Comma-separated list of numeric IDs of email interests to add the user to. If the added interest is specific to a center, the constituent is also added to that center automatically.

Type xsd:string.

cons_id

Optional. The constituent ID (Luminate Online ID) that uniquely identifies the constituent. This value is automatically assigned when a new constituent record is created. It can be used to uniquely identify a constituent record to read or update it. Only available when called using an administrator account.

Type xsd:string.

interaction_body

Optional. Text describing or associated with the interaction.

Type xsd:string.

interaction_cat_id

Optional. The Security Category associated with this interaction. The default is 0, which corresponds to the "General" category.

Type xsd:nonNegativeInteger.

Default is 0.

interaction_count

Optional. The number of times the constituent performed this interaction.

Type xsd:nonNegativeInteger.

Default is 1.

interaction_subject

Optional. Short, descriptive subject of the user interaction. Can be up to 80 characters in length.

Type xsd:string.

member_id

Optional. The member ID (Client ID) that uniquely identifies the constituent.

Type xsd:string.

primary_email

Optional. The primary email address that uniquely identifies the constituent. Required to create a new constituent record. Optional when updating a record.

Type xsd:string.

remove_center_ids

Optional. Comma-separated list of numeric IDs of centers to remove the user from.

Type xsd:string.

remove_center_opt_in_ids

Optional. Comma-separated list of numeric IDs of centers for which the user should be opted out of email communications.

Type xsd:string.

remove_group_ids

Optional. Comma-separated list of numeric IDs of groups to remove the user from. Only valid when updating records. Only available when called using an administrator account. Cannot be used for pre-defined groups (those with IDs less than 1000). Cannot be used for administrator security groups.

Type xsd:string.

remove_interest_ids

Optional. Comma-separated list of numeric IDs of email interests to remove the user from. Only valid when updating records.

Type xsd:string.

suppress_cleaning

Optional. Specifies whether data cleaning/standardization should be turned on or off. This parameter is intended for performance tuning for server side batch APIs calls.

Type xsd:boolean.

Response

See topic HTTP Status Codes.

XML response 
<?xml version="1.0" encoding="UTF-8"?>
<updateConsResponse xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd" xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <cons_id>1001002</cons_id>
  <message>User updated.</message>
</updateConsResponse>
JSON response 
{"updateConsResponse":{"message":"User updated.","cons_id":"1001002"}}
Parent topic: Constituent API
Previous topic: logInteraction
Next topic: updateInteraction

Leave a Comment

Nickname
Comment
Enter this word:
Change