Constituent Management APIs

The Constituent Management API is a REST-based API allowing method invocation over the Internet using HTTP POST requests. The API communicates directly with the Convio Constituent360^TM database and provides methods for all of the following:

• Create New Constituent Records – allows organizations to create new records in the Constituent360 database
• Fetch Constituent Records - allows organizations to request XML or JSON formatted biographical data for a constituent record stored in the Constituent360 database
• Update Constituent Records - allows organizations to create and/or update constituent records in the Constituent360 database
• Manage Group Membership and Subscriptions - allows organizations to manage constituent group memberships (add/remove) and interest category preferences (add/remove)

Getting started

New to the Convio Constituent Management API?
Use the API Test Console to go for a quick test drive. The API Test Console provides a quick overview of the available functionality, demonstrates the calling format for each of the methods, and displays the response received from the API.

Join the Developer Community
The Convio Developer Community is a fantastic resource for getting questions answered swapping ideas and helping other community members with their questions.

Ready to start writing some code?
The Constituent Management API is available in two versions to support both client and server-side programming.

Client Programming Use the Client version of the API to program custom form POSTs and AJAX scripts.		Server Programming Use the Server version of the API to write custom applications using popular programming languages like PHP, Ruby on Rails, Java and .Net
client-side methods site configuration - instructions for security configurations create - register a new constituent record update - update an existing record createOrUpdate - if existing, then update - otherwise create a new record listUserFields - retrieve the list of profile fields from the database listUserFieldChoices - for fields with value options (e.g. Prefix) return the choices getUser - retrieve a single record getUserGroups - retrieve the list of groups associated with a single record getUserInterests - retrieve the list of interested associated with a single record Status and Error Codes - complete list of codes likely to be returned Test Console - view the response options before you begin coding		server-side methods site configuration create update createOrUpdate listUserFields listUserFieldChoices getGroupMembers - retrieve a list of constituents from a specified Convio group.  This API is available only as a server-side method. getUser getUserGroups getUserInterests Status and Error Codes Test Console
indicates this information requires authentication and is available to Convio clients and partners only.