v1

latestOpenAPI 3.0.02026-08-062903562.2 MB

Supporter

supporterAnnualSummary

Request an annual summary to be sent to a supporter for a specific year

post/supporters/{id}/send-annual-summary

Path parameters

idinteger required

Example:5827

The specified Supporter ID

Request body

yearinteger

four digit year for which the summary is being requested

emailstring nullable

email address to use for sending the summary.

Example request

{
  "year": 2024,
  "email": "some@email.com"
}

Response

Success

address1string nullable

Supporter main address

address2string nullable

Secondary Supporter address

birthdaystring nullable

Supporter birthday in M/D format (month and day only; year intentionally not collected). Sourced from the P2P Birthday-moment flow and distinct from any full date-of-birth captured elsewhere.

cell_phonestring nullable

Supporter cell phone number (SMS consent target when collected)

citystring nullable

Supporter City

countrystring nullable

Supporter Country

created_atstring date-time

Date/time of initial record creation

email_addressstring email

Supporter email address

first_namestring nullable

First name of the supporter

genderstring nullable

Supporter gender

idinteger

Supporter number identifier

last_emailed_atstring email nullable

To whom the last e-mail was sent

last_namestring nullable

Supporter last name

locationstring nullable

Free text representing a location

member_idinteger nullable

Member number identifier

nicknamestring nullable

Supporter nickname

opt_inboolean

Indicates whether the supported opted in to email communication or not

originstring

Supporter origin

phonestring nullable

Supporter phone number

postal_codestring nullable

Zip Code

source_campaign_idinteger nullable

Campaign number identifier

source_fundraising_page_idinteger nullable

Fundraising page identifier

source_member_idinteger nullable

Member identifier

source_organization_idinteger nullable

Organization identifier

statestring nullable

State/province name

updated_atstring date-time

Date/time of initial record creation

Example response

{
  "address1": "300 N Washington St",
  "address2": "300 N Washington St",
  "birthday": "3/15",
  "cell_phone": "619-555-1212",
  "city": "Gettysburg",
  "country": "US",
  "created_at": "2021-04-23T08:23:21Z",
  "email_address": "test@gofundme.com",
  "first_name": "Hannah",
  "gender": "M",
  "id": 5827,
  "last_emailed_at": "test@gofundme.com",
  "last_name": "Rosendo",
  "location": "City Townhall",
  "member_id": 2012,
  "metadata": {
    "foo": "bar"
  },
  "nickname": "GoFundMePro",
  "opt_in": true,
  "origin": "donation",
  "phone": "619-555-1212",
  "postal_code": "92101",
  "source_campaign_id": 227362,
  "source_fundraising_page_id": 2173528,
  "source_member_id": 2012,
  "source_organization_id": 82364,
  "state": "NE",
  "updated_at": "2021-04-23T08:23:21Z"
}