create

This method creates a new user record and returns the record's cons_id unique identifier.

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CRConsAPI SRConsAPI POST Server.

Client API Syntax

https://secure2.convio.net/organization/site/CRConsAPI?method=create &api_key=value &v=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_interest_ids=value ] [ &get_single_sign_on_token=value ] [ &interaction_body=value ] [ &interaction_cat_id=value ] [ &interaction_count=value ] [ &interaction_subject=value ] [ &member_id=value ] [ &no_welcome=value ] [ &primary_email=value ] [ &suppress_cleaning=value ] [ &teamraiser_registration=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRConsAPI?method=create & 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 ] [ & get_single_sign_on_token =value ] [ & interaction_body =value ] [ & interaction_cat_id =value ] [ & interaction_count =value ] [ & interaction_subject =value ] [ & member_id =value ] [ & no_welcome =value ] [ & primary_email =value ] [ & suppress_cleaning =value ] [ & teamraiser_registration =value ]

Usage Notes

The create method adds a new constituent record to the Luminate Online Constituent 360 database with the following initial state:

  • origin = "Constituent API" (35)
  • active = "Active" (1)
  • active_detail = "Known" (2) if a "welcome" auto-responder is sent, "Unknown" (1) if not sent.
  • donor_status = "Non-Donor" (1)

The Client API version of this method does not require authentication of the caller. The list of constituent record fields that can be accessed or set is customizable for each organization, and is different for administrative users and non-administrative users.

listUserFields will return the list of the Constituent record fields the caller may specify as parameters on create.

Sending a "welcome" auto-responder by specifying the parameter 'no_welcome=false' also sets 'active_detail=known' for the constituent's initial state.

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

Note: If successful, the client API establishes a session for the user and pushes a session cookie to the caller. A non-administrative user in an active session is not permitted to create other user records; subsequent calls to create will fail, returning an authorization error. If you use the client API to create more than one user at a time, you may have to call logout between each create to clear the last-created user's session.

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.

Note: In cases when the site options, F2F_ENFORCE_UNIQUE_EMAIL and F2F_ENFORCE_UNIQUE_NAME_AND_EMAIL, are both set to TRUE, and the "teamraiser_registration=true" parameter is included in this call, but the "first_name" or "last_name" parameters are not included in this call, it's possible to create a constituent record with an email address that matches an existing constituent record. This is intentional because the F2F_ENFORCE_UNIQUE_NAME_AND_EMAIL setting looks for a combination of unique name and email address when creating records for TeamRaiser Registration and overrides the unique email requirement specified in the F2F_ENFORCE_UNIQUE_EMAIL setting.

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_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.

get_single_sign_on_token

Optional. Specifies whether a single-sign-on token should be returned with the response to the create method.

Type xsd:boolean.

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.

no_welcome

Optional. Only used when creating new records. Specifies whether to send a "welcome" auto-responder email to the new user. If the value is "f" or "false" (ignoring case) and the site is configured to send welcome auto-responders to new users, then one will be sent. By default, this value is "true", meaning that no auto-responder email will be sent.

Type xsd:boolean.

Default is true.

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.

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.

teamraiser_registration

Optional. Specifies that this is a team raiser registration and should process the constituent create with Team Raiser site settings. The default value is false.

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.

get_single_sign_on_token

Optional. Specifies whether a single-sign-on token should be returned with the response to the create method.

Type xsd:boolean.

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.

no_welcome

Optional. Only used when creating new records. Specifies whether to send a "welcome" auto-responder email to the new user. If the value is "f" or "false" (ignoring case) and the site is configured to send welcome auto-responders to new users, then one will be sent. By default, this value is "true", meaning that no auto-responder email will be sent.

Type xsd:boolean.

Default is true.

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.

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.

teamraiser_registration

Optional. Specifies that this is a team raiser registration and should process the constituent create with Team Raiser site settings. The default value is false.

Type xsd:boolean.

Response

See topic HTTP Status Codes.

XML response 
<?xml version="1.0" encoding="UTF-8"?>
<createConsResponse 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 created.</message>
</createConsResponse>
JSON response 
{"createConsResponse":{"message":"User created.","cons_id":"1001002"}}
Parent topic: Constituent API
Next topic: createOrUpdate

Leave a Comment

Nickname
Comment
Enter this word:
Change