create


This method creates a new user record and returns the record's unique identifier. Use this method to create a new user record when calling from a Web Client.

Initial status attributes:

  • Origin = 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)

Post URL

Deconstructing the URL
* In most cases secure2.convio.net matches a client's secure domain.  However, in some cases this will be different.  If your organization uses Convio for fundraising, the correct secure domain for the API is identical to the secure domain for your fundraising forms.  So if the sample above does not work, look for the unique secure domain used for your organization and replace the secure2.convio.net portion above with this URL.

*Here, organization is a client's unique identifier in the Convio system.  Every client has a unique value that represents their instance of the product. If you're organization uses a custom secure URL for donations, the organization portion of the URL may not be necessary, contact support for assistance.

Example: https://demo-secure.convio.net/demo829/site/CRConsAPI.  Here you'll notice that demo-secure.convio.net is used for the domain, and demo829 is used for the organization. 

Authentication

The methods available from a web client do not require authentication of the caller.

Parameters

The list of constituent record fields that can be set is customizable for each organization and is different for administrative and non-administrative users. The fields that can be set by the caller can be retrieved using the listUserFields API method.

The following parameters also apply:

Name

Description

api_key Required. An arbitrary value that must be passed when invoking the Convio Client and Server APIs. The value passed by the caller must match the value in the CONVIO_API_KEY site configuration parameter, which is unique for each Convio site.
v Required. API version to invoke. Must be "1.0".

method

Required. Specifies which method to perform.  To invoke this API use the value “create”.

response_format

Optional. Specifies the format in which to return the response. Can be either "xml" (the default value) or "json".

redirect

Optional. Specifies a URL redirect to send back to the browser after processing.

primary_email

Required. The email address of the user.

add_center_ids

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

add_group_ids*

Comma-separated list of numeric IDs of groups to add the user to. Restrictions:

  • Only available when called using administrator accounts.
  • Cannot be used for pre-defined groups (those with an ID less than 1000)
  • Cannot be used for administrator security groups.

add_interest_ids

Comma-separated list of numeric IDs of email interests to add the user to.

source

Text to associate with the record to identify how or from where the record was added.

no_welcome

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.

* Changed 3/27/08.  This parameter is only available when making server-side API calls for security purposes.

Code Examples

 

Response

Success

A successful invocation sends either a URL redirect (if the redirect parameter was specified) or an identifier for the new record is returned. The HTTP status code is 200. The response is formatted as XML by default, but the response_format input parameter can be used to specify either XML or JSON formatting. For example:

 

XML format 
<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>1001341</cons_id>


  <message>New user added.</message>


</createConsResponse>

 

JSON format 
{"createConsResponse":{
"message":"New user added.","cons_id":"1001341"}}

 

Error

If there is an error, either a URL redirect is sent (if the redirect parameter was specified) or the error code and message is returned. The HTTP status code is 403. For example: 
<errorResponse
  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">


  <code>1</code>


  <message>Unable to add new user.</message>


</errorResponse>

 

JSON format 
{"errorResponse":{"code":"1","message":"Unable to add new user."}}

 

See the complete list of HTTP Status codes and Error codes for calling from a Web Client.

 
 

Client Community
Log in to chat with other clients and partners using APIs and share code snippets.

Community