Campaigns
add campaign
Create a new or cloned campaign
For custom components:
RaiselyComponents.api.all('campaigns').post(data = {}, params = {}, headers = {}) => Promise<{result}>
:fa-gears: See Restie Response Data for a more detailed overview of responses through the client wrapper
post/campaigns
Headers
Authorizationstring
A valid HTTP Bearer token, required to access private records.
Request body
Response
The created Campaign record
Example response
{
"data": {
"allowExperiments": true,
"campaignEndsAt": "2020-12-03T06:52:46.330Z",
"config": {
"social": {
"facebook_page_url": "https://www.facebook.com/raisely/",
"twitter_hashtag": "#hashtag"
},
"thankyou": {
"enabled": true
},
"activity": {
"unit": "km",
"timeUnit": "hr"
}
},
"createdAt": "2020-12-03T06:52:46.330Z",
"currency": "AUD",
"deletedAt": "2020-12-03T06:52:46.330Z",
"grandTotal": 2625,
"mode": "LIVE",
"name": "<< campaign name >>",
"organisationUuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"path": "run-for-a-cure",
"private": {
"fieldA": "one",
"fieldB": "yes"
},
"privateKey": "raisely-sk-aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
"profile": {
"activityTotal": 2625,
"activityTotalPercent": 2625,
"campaignDisplayTotal": 2625,
"createdAt": "2020-12-03T06:52:46.330Z",
"currency": "AUD",
"description": "I believe in a better world",
"donationCount": 12345,
"donationRecordCount": 12345,
"exerciseGoal": 12345,
"exerciseGoalTime": 12345,
"exerciseTotal": 2625,
"exerciseTotalTime": 2625,
"fundraiserTheme": "birthday",
"goal": 100050,
"individualProfileCount": 12345,
"isCampaignProfile": true,
"name": "Bob D.",
"nonSelfDonationTotal": 2625,
"organisationProfileCount": 12345,
"paid": true,
"path": "bobd",
"photoUrl": "https://raisely-images.imgix.net/www/uploads/t-03-arl-8-es-uhhqua-4-pr-f-4865431-df-58-512-png-08e3f5.png",
"private": {
"fieldA": "one",
"fieldB": "yes"
},
"public": {
"fieldA": "one",
"fieldB": "yes"
},
"selfDonationTotal": 2625,
"shared": true,
"status": "ACTIVE",
"subscriptionCount": 12345,
"teamProfileCount": 12345,
"type": "INDIVIDUAL",
"uniqueDonors": 12345,
"updatedAt": "2020-12-03T06:52:46.330Z",
"uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"
},
"public": {
"fieldA": "one",
"fieldB": "yes"
},
"publicKey": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"showRaiselyCheckbox": true,
"status": "ACTIVE",
"theme": "donation-basic",
"total": 2625,
"totalPercent": 2625,
"url": "https://raisely.com/",
"urls": [
"yourdomain.com"
],
"uuid": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
"version": "3.0.0"
}
}