Skip to main content
PATCH
Change a fundraising page

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string
required

The page's ID.

Body

application/json
owner_name
string

Whose page it is, as the public sees it. Required to make one.

Maximum string length: 200
owner_email
string | null

Their email. Never shown on your site.

person_id
string | null

The person on file it belongs to, if any.

title
string

Required to make one.

Maximum string length: 120
story
string | null

Why they are raising money. Blank lines make paragraphs.

Maximum string length: 8000
goal_amount_cents
integer

The page's own goal, in whole cents. 0 means no goal.

Required range: 0 <= x <= 100000000
kind
enum<string>
default:person

A person's page, or a team's page people join.

Available options:
person,
team
team_page_id
string | null

For a person's page: the team page it is on, under the same campaign. A team is on no team.

status
enum<string>

pending waits for your approval and is not on your site. active is live and takes gifts. hidden is off your site. closed stays on your site with what it raised and takes no more gifts.

Available options:
pending,
active,
hidden,
closed

Response

The page, as it now is.

owner_name
string
required

Whose page it is, as the public sees it. Required to make one.

Maximum string length: 200
title
string
required

Required to make one.

Maximum string length: 120
goal_amount_cents
integer
required

The page's own goal, in whole cents. 0 means no goal.

Required range: 0 <= x <= 100000000
kind
enum<string>
default:person
required

A person's page, or a team's page people join.

Available options:
person,
team
status
enum<string>
required

pending waits for your approval and is not on your site. active is live and takes gifts. hidden is off your site. closed stays on your site with what it raised and takes no more gifts.

Available options:
pending,
active,
hidden,
closed
id
string
required
campaign_id
string
required
slug
string
required

The page's address on your site: /fundraise/ and the slug. Made from the title.

raised_cents
integer
required

The completed gifts given on it, in whole cents. A team's includes its members' pages, whatever their status.

owner_email
string | null

Their email. Never shown on your site.

person_id
string | null

The person on file it belongs to, if any.

story
string | null

Why they are raising money. Blank lines make paragraphs.

Maximum string length: 8000
team_page_id
string | null

For a person's page: the team page it is on, under the same campaign. A team is on no team.

approved_at
string<date-time> | null

When it first went live.

donor_count
integer
gift_count
integer
members
integer

For a team: how many pages are on it.

progress_percent
integer | null

What it has raised as a percentage of its goal. Null with no goal.

created_at
string<date-time>
updated_at
string<date-time>