v1

latestOpenAPI 3.0.02026-08-062903562.2 MB

Fundraising Team

updateFundraisingTeam

Update a Fundraising Team

put/fundraising-teams/{fundraising_team}

Path parameters

fundraising_teaminteger required

Example:209745

Primary identifier of Fundraising Team

Request body

citystring nullable

City

countrystring nullable

Country. Must be a valid ISO 3166-1 alpha-2 country code

descriptionstring nullable

Team description

namestring

Team name

postal_codestring nullable

Postal Code

raw_currency_codestring nullable

ISO code of the default currency in which this Fundraising Team should be presented. Defaults to 'currency_code' if not specified

raw_goalstring nullable

Raw fundraising goal for this team. If unspecified, defaults to the team goal value set on the campaign

statestring nullable

State/province name. Must be a valid USPS state code

supporter_first_namestring nullable

Optional. Recorded as the first name on the supporter created for the team lead 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 team creation (POST /campaigns/{id}/fundraising-teams); silently ignored on update (PUT /fundraising-teams/{id}).

supporter_last_namestring nullable

Optional. Recorded as the last name on the supporter created for the team lead 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 team creation (POST /campaigns/{id}/fundraising-teams); silently ignored on update (PUT /fundraising-teams/{id}).

thank_you_textstring nullable

Default thank you text on the thank you page

designation_idinteger nullable

Primary identifier of associated Designation. Defaults to the campaign's designation

is_p2pboolean

True when the team is owned by GFM Consumer and is read-only in GFM Pro

Example request

{
  "city": "San Diego",
  "country": "US",
  "description": "My team description",
  "name": "My Team",
  "postal_code": "90210",
  "raw_currency_code": "EUR",
  "raw_goal": "100",
  "state": "CA",
  "supporter_first_name": "Alex",
  "supporter_last_name": "Doe",
  "thank_you_text": "Thank you!",
  "designation_id": 34672
}

Response

Success

campaign_idinteger

Primary identifier of associated Campaign

citystring nullable

City

countrystring nullable

Country. Must be a valid ISO 3166-1 alpha-2 country code

cover_photo_idinteger nullable

Primary identifier of asset used as the Fundraising Team cover photo

cover_photo_urlstring nullable

URL for cover photo image. Interpreted from cover_photo asset specified by cover_photo_id

created_atstring date-time

Date/time of initial record creation

currency_codestring

ISO code of the currency against which this Fundraising Team is normalized. Defaults to USD

descriptionstring nullable

Team description

goalnumber float

Fundraising Goal for this Team normalized against 'currency_code'. Defaults to the campaign's default team goal

idinteger

Primary identifier of record

logo_idinteger nullable

Primary identifier of associated Asset

logo_urlstring nullable

URL for logo image. Either hardcoded URL for legacy Fundraising Teams or interpreted from logo Asset specified by logo_id

namestring

Team name

organization_idinteger nullable

Primary identifier of associated Organization

parent_idinteger nullable

Parent Team ID. Used for creating a team hierarchy. Fundraising Team Policy must support SubTeam creation if a Parent Team ID is supplied

postal_codestring nullable

Postal Code

raw_currency_codestring

ISO code of the default currency in which this Fundraising Team should be presented. Defaults to 'currency_code' if not specified

raw_goalstring

Raw fundraising goal for this Team

root_idinteger nullable

Team ID at the highest level of the hierarchy. Fundraising Team Policy must support SubTeam creation if a Root ID is supplied

statestring nullable

State/province code. Must be a valid USPS state code

status'active' | 'deleted' | 'pending_approval' | 'pending_cart_questions' | 'pending_cart_completion' nullable

Team status

team_lead_idinteger nullable

Primary identifier of associated Team Lead

team_lead_supporter_idinteger nullable

Primary identifier of associated Team Lead Supporter

thank_you_textstring nullable

Default thank you text on the thank you page

updated_atstring date-time nullable

Date/time of last record update

canonical_urlstring nullable

The canonical url of the Fundraising Team

designation_idinteger nullable

Primary identifier of associated Designation

team_policy_idinteger nullable

Primary identifier of associated Team Policy

Example response

{
  "campaign_id": 227362,
  "city": "San Diego",
  "country": "US",
  "cover_photo_id": 1145,
  "cover_photo_url": "https://gofundme-cdn-url.com/your-cover-photo.png",
  "created_at": "2021-04-23T08:23:21Z",
  "currency_code": "USD",
  "description": "My team description",
  "goal": 108.23,
  "id": 209745,
  "logo_id": 1145,
  "logo_url": "https://gofundme-cdn-url.com/your-cover-photo.png",
  "name": "My Team",
  "organization_id": 82364,
  "parent_id": 209750,
  "postal_code": "90210",
  "raw_currency_code": "EUR",
  "raw_goal": "100",
  "root_id": 3345,
  "state": "CA",
  "status": "active",
  "team_lead_id": 2012,
  "team_lead_supporter_id": 7845,
  "thank_you_text": "Thank you!",
  "updated_at": "2021-04-23T10:25:03Z",
  "canonical_url": "/team/10",
  "designation_id": 34672,
  "team_policy_id": 2354
}