Interface: Campaign
Defined in: schemas/v2/resources/campaign.ts:4
The creator's page, and the top-level object for accessing lists of members, tiers, etc
Properties
created_at
created_at:
string
Defined in: schemas/v2/resources/campaign.ts:151
Datetime that the creator first began the campaign creation process
Format
date-time
creation_name
creation_name:
null|string
Defined in: schemas/v2/resources/campaign.ts:145
The type of content the creator is creating, as in "Campaign.vanity is creating Campaign.creation_name"
discord_server_id
discord_server_id:
null|string
Defined in: schemas/v2/resources/campaign.ts:140
The ID of the external discord server that is linked to this campaign
google_analytics_id
google_analytics_id:
null|string
Defined in: schemas/v2/resources/campaign.ts:135
The ID of the Google Analytics tracker that the creator wants metrics to be sent to
has_rss
has_rss:
boolean
Defined in: schemas/v2/resources/campaign.ts:130
Whether this user has opted-in to rss feeds
has_sent_rss_notify
has_sent_rss_notify:
boolean
Defined in: schemas/v2/resources/campaign.ts:125
Whether the creator has sent a one-time rss notification email
image_small_url
image_small_url:
string
Defined in: schemas/v2/resources/campaign.ts:120
Profile image URL for the campaign
Format
uri
image_url
image_url:
string
Defined in: schemas/v2/resources/campaign.ts:114
Banner image URL for the campaign
Format
uri
is_charged_immediately
is_charged_immediately:
boolean
Defined in: schemas/v2/resources/campaign.ts:108
Whether the campaign charges upfront
is_monthly
is_monthly:
boolean
Defined in: schemas/v2/resources/campaign.ts:103
Whether the campaign charges per month
is_nsfw
is_nsfw:
boolean
Defined in: schemas/v2/resources/campaign.ts:98
Whether the creator has marked the campaign as containing nsfw content
main_video_embed
main_video_embed:
null|string
Defined in: schemas/v2/resources/campaign.ts:93
main_video_url
main_video_url:
null|string
Defined in: schemas/v2/resources/campaign.ts:87
Format
uri
one_liner
one_liner:
null|string
Defined in: schemas/v2/resources/campaign.ts:81
Pithy one-liner for this campaign, displayed on the creator page
patron_count
patron_count:
number
Defined in: schemas/v2/resources/campaign.ts:76
Number of patrons having access to this creator
pay_per_name
pay_per_name:
null|string
Defined in: schemas/v2/resources/campaign.ts:71
The thing which patrons are paying per, as in "Campaign.vanity is making $1000 per Campaign.pay_per_name"
pledge_url
pledge_url:
string
Defined in: schemas/v2/resources/campaign.ts:66
Relative (to patreon.com) URL for the pledge checkout flow for this campaign
published_at
published_at:
null|string
Defined in: schemas/v2/resources/campaign.ts:61
Datetime that the creator most recently published (made publicly visible) the campaign. Null when the campaign has not been public.
Format
date-time
rss_artwork_url
rss_artwork_url:
null|string
Defined in: schemas/v2/resources/campaign.ts:54
The url for the rss album artwork
Format
uri
rss_feed_title
rss_feed_title:
null|string
Defined in: schemas/v2/resources/campaign.ts:48
The title of the campaigns rss feed
show_earnings
show_earnings:
boolean
Defined in: schemas/v2/resources/campaign.ts:43
Whether the campaign's total earnings are shown publicly
summary
summary:
null|string
Defined in: schemas/v2/resources/campaign.ts:38
The summary of this campaign. Can be viewed in the About section of the campaign
thanks_embed
thanks_embed:
null|string
Defined in: schemas/v2/resources/campaign.ts:32
The embed that is shown to patrons after pledging
thanks_msg
thanks_msg:
null|string
Defined in: schemas/v2/resources/campaign.ts:26
The message that is shown to patrons after pledging
thanks_video_url
thanks_video_url:
null|string
Defined in: schemas/v2/resources/campaign.ts:21
The URL of the video that is shown to patrons after pledging
Format
uri
url
url:
string
Defined in: schemas/v2/resources/campaign.ts:15
The url to visit this campaign
Format
uri
vanity
vanity:
null|string
Defined in: schemas/v2/resources/campaign.ts:9
The campaign's vanity name