v1

latestOpenAPI 3.0.02026-08-062903562.2 MB

Fundraising Page

createFundraisingTeamFundraisingPage

Create new Fundraising Team Fundraising Page

post/fundraising-teams/{fundraising_team}/fundraising-pages

Path parameters

fundraising_teaminteger required

Example:209745

The specified Fundraising Team ID

Request body

aliasstring

Alias of the Fundraising Page

cover_photo_idinteger nullable

Fundraising Page cover photo

designation_idinteger nullable

Designation ID for this Fundraising Page

ended_atstring date-time nullable

Page end date

intro_textstring

HTML Formatted string for intro text

is_tributeboolean nullable

Flag denoting whether Fundraising Page is a tribute to someone

logo_idinteger nullable

ID of Asset used as the Fundraising Page logo

member_email_textstring nullable

HTML formatted string for member email body

member_idinteger

Member ID associated with this Fundraising Page

raw_currency_codestring

ISO code of the default currency in which this Fundraising Page should be presented

raw_goalstring

Raw fundraising goal for this Fundraising Page (returned as string)

supporter_first_namestring nullable

Optional. Recorded as the first name on the supporter created for the fundraising page owner when the campaign's organization has Contact-First Architecture enabled; ignored otherwise. Leading and trailing whitespace is trimmed before storage, and emoji characters are rejected with a 400 response. Honored only on fundraising-page creation (POST /campaigns/{campaign}/fundraising-pages and POST /fundraising-teams/{fundraising_team}/fundraising-pages); silently ignored on update (PUT /fundraising-pages/{fundraising_page}).

supporter_last_namestring nullable

Optional. Recorded as the last name on the supporter created for the fundraising page owner when the campaign's organization has Contact-First Architecture enabled; ignored otherwise. Leading and trailing whitespace is trimmed before storage, and emoji characters are rejected with a 400 response. Honored only on fundraising-page creation (POST /campaigns/{campaign}/fundraising-pages and POST /fundraising-teams/{fundraising_team}/fundraising-pages); silently ignored on update (PUT /fundraising-pages/{fundraising_page}).

thankyou_email_textstring

HTML formatted string for thank you email body

thank_you_textstring

Default thank you text on the thank you page

titlestring

Page title

Example request

{
  "alias": "My Super Awesome page",
  "cover_photo_id": 98374,
  "designation_id": 34672,
  "ended_at": "2019-04-23T10:25:03Z",
  "intro_text": "Thanks for visiting my fundraising page!<br>",
  "is_tribute": true,
  "logo_id": 1002,
  "member_email_text": "<p>My email body</p>",
  "member_id": 2012,
  "raw_currency_code": "EUR",
  "raw_goal": "100.00",
  "supporter_first_name": "Alex",
  "supporter_last_name": "Doe",
  "thankyou_email_text": "<p>My email body</p>",
  "thank_you_text": "Thank You!",
  "title": "My Page Title"
}

Response

Success

idinteger

ID of Fundraising Page

aliasstring

Alias of the Fundraising Page

campaign_idinteger

Parent Campaign ID

commitment_idinteger nullable

Commitment ID

cover_photo_idinteger nullable

Fundraising Page cover photo

created_atstring date-time

Datetime at which the Fundraising Page was created

currency_codestring nullable

ISO code of the currency against which this Fundraising Page is normalized.

designation_idinteger nullable

Designation ID for this Fundraising Page

ended_atstring date-time nullable

Page end date

fundraising_team_idinteger nullable

Fundraising Team ID to whom this Fundraising Page is associated

goalnumber float nullable

Fundraising goal for this Fundraising Page normalized against 'currency_code'

intro_textstring

HTML Formatted string for intro text

is_primaryboolean

Flag denoting primary Fundraising Page for child Fundraising Pages

is_tributeboolean nullable

Flag denoting whether Fundraising Page is a tribute to someone

logo_idinteger nullable

ID of Asset used as the Fundraising Page logo

logo_urlstring nullable

URL for logo image

member_email_textstring nullable

HTML formatted string for member email body

member_idinteger

Member ID associated with this Page

raw_currency_codestring

ISO code of the default currency in which this Fundraising Page should be presented

raw_goalstring

Raw fundraising goal for this Fundraising Page (returned as string)

organization_idinteger

Organization ID

parent_idinteger

Parent Fundraising Page ID

Status for this Fundraising Page

supporter_idinteger nullable

Supporter ID associated with the Fundraising Page

team_role'primary-captain' | 'co-captain' nullable

If Fundraising Page is for a Team Member, it will contain the role of the Team Member

thankyou_email_textstring nullable

HTML formatted string for thank you email body

thank_you_textstring nullable

Default thank you text on the thank you page

titlestring

Page title

updated_atstring date-time nullable

Date the Fundraising Page was last updated

canonical_urlstring

The canonical url of the Fundraising Page

Example response

{
  "id": 227362,
  "alias": "My Super Awesome page",
  "campaign_id": 227362,
  "commitment_id": 98374,
  "cover_photo_id": 98374,
  "created_at": "2019-04-23T10:25:03Z",
  "currency_code": "USD",
  "designation_id": 34672,
  "ended_at": "2019-04-23T10:25:03Z",
  "fundraising_team_id": 209745,
  "goal": 123.23,
  "intro_text": "Thanks for visiting my fundraising page!<br>",
  "is_primary": true,
  "is_tribute": true,
  "logo_id": 1002,
  "logo_url": "https://gofundme-cdn-url.com/your-logo.png",
  "member_email_text": "<p>My email body</p>",
  "member_id": 2012,
  "raw_currency_code": "EUR",
  "raw_goal": "100.00",
  "organization_id": 82364,
  "parent_id": 1,
  "questions": [
    {
      "campaign_id": 227362,
      "created_at": "2021-04-23T10:25:03Z",
      "deleted_at": "2021-04-23T10:25:03Z",
      "id": 45678,
      "is_required": true,
      "label": "Do you require accommodations due to a medical condition or disability?",
      "location": "donation_page",
      "product_id": 73647,
      "tag": "email_address",
      "type": "boolean",
      "updated_at": "2021-04-23T10:25:03Z"
    }
  ],
  "status": "active",
  "supporter_id": 5827,
  "team_role": "primary-captain",
  "thankyou_email_text": "<p>My email body</p>",
  "thank_you_text": "Thank You!",
  "title": "My Page Title",
  "updated_at": "2019-04-23T10:25:03Z",
  "canonical_url": "/fundraising-page/2173528"
}