Skip to main content
POST
Create a campaign

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Cannot be blank.

slug
string | null

A short name for the campaign's address. No two of your campaigns may share one.

description
string | null
goal_amount_cents
integer
default:0

The goal, in whole cents.

Required range: x >= 0
status
enum<string>
default:draft
Available options:
draft,
active,
paused,
completed,
archived
start_date
string<date> | null
end_date
string<date> | null
metadata
object

Anything else you want to keep with the campaign, as keys and values.

custom_fields
object

Values for your own campaign fields, by field key. A key that is not one of your fields is refused.

Response

The campaign, as it was created.

name
string
required

Cannot be blank.

goal_amount_cents
integer
required

The goal, in whole cents: 1500000 is $15,000.00. 0 means no goal.

Required range: x >= 0
status
enum<string>
required
Available options:
draft,
active,
paused,
completed,
archived
id
string
required
total_raised_cents
integer
required

The sum of the completed gifts given to this campaign, in whole cents.

donation_count
integer
required

How many completed gifts.

donor_count
integer
required

How many different people gave them.

created_at
string<date-time>
required
updated_at
string<date-time>
required
slug
string | null

A short name for the campaign's address. No two of your campaigns may share one.

description
string | null
start_date
string<date> | null
end_date
string<date> | null
metadata
object

Anything else you want to keep with the campaign, as keys and values.

custom_fields
object

Values for your own campaign fields, by field key. A key that is not one of your fields is refused.

tenant_id
string

Your organization's ID.

progress_percent
integer | null

What has been raised as a percentage of the goal, rounded. It can pass 100. Null when there is no goal.