servlet | |
method | | The method name |
api_key |
| 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 |
| API version to invoke. Must be "1.0". |
auth |
| Required for some client-side methods that access sensitive information. Must be a system-generated authentication token for the session obtained from a "[[S86]]" tag in Convio-generated content. Alternatively, the "sso_auth_token" parameter can be used with a different system-generated token obtained from a single sign-on (SSO) API method call. |
center_id |
| The ID of a center (in a multi-center enabled site) to associate with the current session. |
error_redirect |
| Specifies a URL that the method should redirect to in the event of an error. |
redirect |
| Specifies a URL that the method should redirect to upon completion. Used in the absence the more specific ones that depend on whether the request succeeds or fails |
response_format |
| Used to specify either XML or JSON formatting for the response. |
sign_redirects |
| Specifies that redirect URLs should be signed with a timestamp and a hash of the query string arguments and a secret key. |
source |
| Text to associate with newly created constituent records to identify how or from where the record was added. This is recognized by all API methods even though most of them do not directly create constituent records. This is because the value is remembered in the visitor's current web browser session and used if they take any action, either via API call or browser interaction, that causes a new constituent record to be created. |
sub_source |
| Further detail to save with the "source" information. |
success_redirect |
| Specifies a URL that the method should redirect to upon successful completion. |
suppress_response_codes |
| Specifies that all responses will be returned with an HTTP 200 OK status code - even errors. This parameter exists to accommodate Flash and JavaScript applications running in browsers that intercept all non-200 responses. If used, it's then the job of the client to determine error states by parsing the response body. |
add_center_ids |
| Comma-separated list of numeric IDs of centers to add the user to. |
add_center_opt_in_ids |
| Comma-separated list of numeric IDs of centers for which the user should be opted in to email communications. |
add_group_ids |
| 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. |
add_interest_ids |
| Comma-separated list of numeric IDs of email interests to add the user to. |
cons_id |
| The constituent ID (Convio 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. |
interaction_body |
| Text describing or associated with the interaction. |
interaction_cat_id |
| The Security Category associated with this interaction. The default is 0, which corresponds to the "General" category. |
interaction_count |
| The number of times the constituent performed this interaction. |
interaction_subject |
| Short, descriptive subject of the user interaction. Can be up to 80 characters in length. |
member_id |
| The member ID (Client ID) that uniquely identifies the constituent. |
no_welcome |
| 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. |
primary_email |
| The primary email address that uniquely identifies the constituent. Required to create a new constituent record. Optional when updating a record. |
remove_center_ids |
| Comma-separated list of numeric IDs of centers to remove the user from. |
remove_center_opt_in_ids |
| Comma-separated list of numeric IDs of centers for which the user should be opted out of email communications. |
remove_group_ids |
| 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. |
remove_interest_ids |
| Comma-separated list of numeric IDs of email interests to remove the user from. Only valid when updating records. |
suppress_cleaning |
| Specifies whether data cleaning/standardization should be turned on or off. This parameter is intended for perfomance tuning for server side batch APIs calls. |
sso_auth_token | | The auth token |