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

Property	Type	Description
created_at	string	Datetime that the creator first began the campaign creation process
creation_name	null | string	The type of content the creator is creating, as in "Campaign.vanity is creating Campaign.creation_name"
discord_server_id	null | string	The ID of the external discord server that is linked to this campaign
google_analytics_id	null | string	The ID of the Google Analytics tracker that the creator wants metrics to be sent to
has_rss	boolean	Whether this user has opted-in to rss feeds
has_sent_rss_notify	boolean	Whether the creator has sent a one-time rss notification email
image_small_url	string	Profile image URL for the campaign
image_url	string	Banner image URL for the campaign
is_charged_immediately	boolean	Whether the campaign charges upfront
is_monthly	boolean	Whether the campaign charges per month
is_nsfw	boolean	Whether the creator has marked the campaign as containing nsfw content
main_video_embed	null | string	-
main_video_url	null | string	-
one_liner	null | string	Pithy one-liner for this campaign, displayed on the creator page
patron_count	number	Number of patrons having access to this creator
pay_per_name	null | string	The thing which patrons are paying per, as in "Campaign.vanity is making $1000 per Campaign.pay_per_name"
pledge_url	string	Relative (to patreon.com) URL for the pledge checkout flow for this campaign
published_at	null | string	Datetime that the creator most recently published (made publicly visible) the campaign. Null when the campaign has not been public.
rss_artwork_url	null | string	The url for the rss album artwork
rss_feed_title	null | string	The title of the campaigns rss feed
show_earnings	boolean	Whether the campaign's total earnings are shown publicly
summary	null | string	The summary of this campaign. Can be viewed in the About section of the campaign
thanks_embed	null | string	The embed that is shown to patrons after pledging
thanks_msg	null | string	The message that is shown to patrons after pledging
thanks_video_url	null | string	The URL of the video that is shown to patrons after pledging
url	string	The url to visit this campaign
vanity	null | string	The campaign's vanity name