CRAdvocacyAPI:takeAction
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.
sso_auth_token
Required for SSO authentication. The system-generated authentication token for the login session.
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.
alert_id
Specify the alert.
alert_type
Specify the alert type.
anonymous
Specify that the interaction is anonymous.
body
Editable portion of message body. May be required by alert configuration.
called
Call date. Required for call alerts. Ignored for other types of alerts.
cc
Specify that the constituent wants to get a copy of the message sent to targets.
city
Constituent city.
contact_name
Call contact name. Optional for call alerts. Ignored for other types of alerts.
contact_position
Call contact position. Required for call alerts. Ignored for other types of alerts.
country
Constituent country.
email
Constituent email address.
first_name
Constituent first name.
last_name
Constituent last name.
note
Call note. Required for call alerts. Ignored for other types of alerts.
opt_in
Specify that the constituent is opting in. The default is the same as the alert configuration.
phone
Constituent phone. May be required by alert configuration.
preview
Designates a test participation. Always specify preview=true when testing. When true, the participation will be processed and the result returned to the caller, but the messages will not be sent, and the interaction will not be logged in the database.
recipient
Select recipients and delivery methods.
reply
Call reply. Required for call alerts. Ignored for other types of alerts.
state
Constituent state.
street1
Constituent street 1.
street2
Constituent street 2.
subject
Message subject. May be required by alert configuration.
survey
Survey answers prefix.
title
Constituent title. May be required by alert configuration.
zip
Constituent zip.
SRAdvocacyAPI:takeAction
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.
sso_auth_token
Required for SSO authentication. The system-generated authentication token for the login session.
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.
alert_id
Specify the alert.
alert_type
Specify the alert type.
anonymous
Specify that the interaction is anonymous.
body
Editable portion of message body. May be required by alert configuration.
called
Call date. Required for call alerts. Ignored for other types of alerts.
cc
Specify that the constituent wants to get a copy of the message sent to targets.
city
Constituent city.
contact_name
Call contact name. Optional for call alerts. Ignored for other types of alerts.
contact_position
Call contact position. Required for call alerts. Ignored for other types of alerts.
country
Constituent country.
email
Constituent email address.
first_name
Constituent first name.
last_name
Constituent last name.
note
Call note. Required for call alerts. Ignored for other types of alerts.
opt_in
Specify that the constituent is opting in. The default is the same as the alert configuration.
phone
Constituent phone. May be required by alert configuration.
preview
Designates a test participation. Always specify preview=true when testing. When true, the participation will be processed and the result returned to the caller, but the messages will not be sent, and the interaction will not be logged in the database.
recipient
Select recipients and delivery methods.
reply
Call reply. Required for call alerts. Ignored for other types of alerts.
state
Constituent state.
street1
Constituent street 1.
street2
Constituent street 2.
subject
Message subject. May be required by alert configuration.
survey
Survey answers prefix.
title
Constituent title. May be required by alert configuration.
zip
Constituent zip.