Creates a Facebook Fundraiser for a TeamRaiser registration, then updates that TeamRaiser registration with the Fundraiser ID.
| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|
| CRTeamraiserAPI |
None. |
POST |
No. |
Client API Syntax
https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=createAndLinkFacebookFundraiser &api_key=value &v=value [ ¢er_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 ] &fr_id=value &user_access_token=value [ &name=value ] [ &description=value ] &cons_id=value
Usage Notes
For a user to successfully link their registration to a Facebook Fundraiser:
- The organization must have Facebook integration enabled in Site Options. Contact Blackbaud Support.
- The organization must be linked to a Facebook charity. Configuration to link between the products must be set in both Facebook and in Luminate Online.
- The TeamRaiser must have the option to enable Facebook selected in the TeamRaiser options.
When this method creates the Facebook Fundraiser, the Facebook Fundraiser title and description are populated from the Participant Page title and story. The Facebook Fundraiser end date, after which no donations are accepted on Facebook, is set in the TeamRaiser Facebook settings. However, if no end date is specified, the Facebook Fundraiser end date is set automatically to 90 days past the TeamRaiser event end date.
Client API Parameters
- Common Client Parameters
-
See topic Common Parameters.
- fr_id
-
Required. The TeamRaiser event ID.
Type xsd:nonNegativeInteger.
- user_access_token
-
Required. The Facebook user access token for the Facebook user who owns the fundraiser
Type xsd:string.
- name
-
Optional. The name or title of the Facebook Fundraiser
Type xsd:string.
- description
-
Optional. The description or story of the Facebook Fundraiser
Type xsd:string.
- cons_id
-
Required. The unique constituent ID of the participant who will own the Facebook Fundraiser
Type xsd:nonNegativeInteger.
Response
See topic HTTP Status Codes.
XML response
<?xml version="1.0" encoding="UTF-8"?>
<createAndLinkFacebookFundraiserResponse 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">
<fundraiserId>-5972809844769860615</fundraiserId>
</createAndLinkFacebookFundraiserResponse>
JSON response
{"createAndLinkFacebookFundraiserResponse":{"fundraiserId":"5428204944844884000"}}