Raisely

Raisely Developers

Bring the power of Raisely to your app, or extend your own fundraising campaign.

Get Started    
Suggest Edits

/subscriptions

Fetches all subscriptions owned by your organisation. (Only available to ORG_ADMIN)

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/subscriptions
curl --request GET \
  --url https://api.raisely.com/v3/subscriptions
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.raisely.com/v3/subscriptions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/subscriptions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/subscriptions");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/subscriptions"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
	"data": [
		{
			"uuid": "adbda240-3c3c-11e7-b7a8-a557e52cc8ad",
			"createdAt": "2017-05-19T02:41:36.869Z",
			"user": {
				"uuid": "ad6f3420-3c3c-11e7-b7a8-a557e52cc8ad",
				"createdAt": "2017-05-19T02:41:36.354Z",
				"updatedAt": "2017-05-19T02:41:36.354Z",
				"firstName": "Jeff",
				"lastName": "Gonzales",
				"photoUrl": "https://s3.amazonaws.com/uifaces/faces/twitter/kkusaa/128.jpg"
			},
			"donations": [
				{
					"uuid": "ae532b80-3c3c-11e7-b7a8-a557e52cc8ad",
					"type": "ONLINE",
					"method": "CREDIT_CARD",
					"currency": "AUD",
					"message": "Fiawe uzzob pejakwa lilholac hefa kok vul vegzuti kermo witkim gos dog mevediec pom vahor kuhujaogu dizjacav kel.",
					"anonymous": false,
					"amount": 96400,
					"createdAt": "2017-05-19T02:41:37.848Z",
					"mode": "TEST",
					"public": {
						"phone": "(724) 486-2485",
						"story": "Teuwazo udipad nafedwod ari ow sonhep estofgi metotihu pih vambargef tomid regwup aricased zufjamla ter fofpuz gepki."
					},
					"firstName": "Jeff",
					"lastName": "Gonzales",
					"publicAmount": 964,
					"publicFee": 0,
					"publicTotal": null
				}
			],
			"profile": {
				"uuid": "95c5ec10-3c3c-11e7-b7a8-a557e52cc8ad",
				"path": "mock-b4arhojs",
				"name": "Climb for Life",
				"currency": "AUD",
				"goal": 10000,
				"status": "ACTIVE",
				"type": "GROUP",
				"description": null,
				"createdAt": "2017-05-19T02:40:56.657Z",
				"updatedAt": "2017-05-19T02:40:56.657Z",
				"photoUrl": null,
				"total": 0
			},
			"amount": 964,
			"total": 964,
			"fee": 0,
			"count": 2,
			"interval": "MINUTE",
			"currency": "AUD",
			"nextPayment": "May 19th 2017",
			"public": {
				"phone": "(724) 486-2485",
				"story": "Teuwazo udipad nafedwod ari ow sonhep estofgi metotihu pih vambargef tomid regwup aricased zufjamla ter fofpuz gepki."
			},
			"providerUser": {
				"uuid": "ae4f8200-3c3c-11e7-b7a8-a557e52cc8ad",
				"createdAt": "2017-05-19T02:41:37.825Z",
				"mode": "TEST",
				"updatedAt": "2017-05-19T02:41:37.825Z",
				"providerType": "STRIPE"
			},
			"feeOptIn": false,
			"public_amount": 964
		}],
  "pagination": {
		"total": 6,
		"pages": 0,
		"prev_url": false,
		"next_url": false,
		"offset": 0,
		"limit": 10
	}
}
{
  "errors": [
    {
      "message": "Authorization error.",
      "status": 500
    }
  ]
}

Query Params

mode
string

"LIVE" or "TEST" are used to filter subscriptions that process in live or test payment mode.

status
string

"OK", "CANCELLED", "PAUSED", "PENDING", "RETRYING", "FAILING", "FAILED", "DELETED" are all valid options to filter different types of subscriptions

 
Suggest Edits

/subscriptions/:subscription

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/subscriptions/subscription
curl --request GET \
  --url https://api.raisely.com/v3/subscriptions/subscription
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.raisely.com/v3/subscriptions/subscription' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/subscriptions/subscription")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/subscriptions/subscription");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/subscriptions/subscription"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
	"data": {
		"uuid": "adbda240-3c3c-11e7-b7a8-a557e52cc8ad",
		"createdAt": "2017-05-19T02:41:36.869Z",
		"user": {
			"uuid": "ad6f3420-3c3c-11e7-b7a8-a557e52cc8ad",
			"createdAt": "2017-05-19T02:41:36.354Z",
			"updatedAt": "2017-05-19T02:41:36.354Z",
			"firstName": "Jeff",
			"lastName": "Gonzales",
			"photoUrl": "https://s3.amazonaws.com/uifaces/faces/twitter/kkusaa/128.jpg"
		},
		"donations": [
			{
				"uuid": "ae532b80-3c3c-11e7-b7a8-a557e52cc8ad",
				"type": "ONLINE",
				"method": "CREDIT_CARD",
				"currency": "AUD",
				"message": "Fiawe uzzob pejakwa lilholac hefa kok vul vegzuti kermo witkim gos dog mevediec pom vahor kuhujaogu dizjacav kel.",
				"anonymous": false,
				"amount": 96400,
				"createdAt": "2017-05-19T02:41:37.848Z",
				"mode": "TEST",
				"public": {
					"phone": "(724) 486-2485",
					"story": "Teuwazo udipad nafedwod ari ow sonhep estofgi metotihu pih vambargef tomid regwup aricased zufjamla ter fofpuz gepki."
				},
				"firstName": "Jeff",
				"lastName": "Gonzales",
				"publicAmount": 964,
				"publicFee": 0,
				"publicTotal": null
			}
		],
		"profile": {
			"uuid": "95c5ec10-3c3c-11e7-b7a8-a557e52cc8ad",
			"path": "mock-b4arhojs",
			"name": "Climb for Life",
			"currency": "AUD",
			"goal": 10000,
			"status": "ACTIVE",
			"type": "GROUP",
			"description": null,
			"createdAt": "2017-05-19T02:40:56.657Z",
			"updatedAt": "2017-05-19T02:40:56.657Z",
			"photoUrl": null,
			"total": 0
		},
		"amount": 964,
		"total": 964,
		"fee": 0,
		"count": 2,
		"interval": "MINUTE",
		"currency": "AUD",
		"nextPayment": "May 19th 2017",
		"public": {
			"phone": "(724) 486-2485",
			"story": "Teuwazo udipad nafedwod ari ow sonhep estofgi metotihu pih vambargef tomid regwup aricased zufjamla ter fofpuz gepki."
		},
		"providerUser": {
			"uuid": "ae4f8200-3c3c-11e7-b7a8-a557e52cc8ad",
			"createdAt": "2017-05-19T02:41:37.825Z",
			"mode": "TEST",
			"updatedAt": "2017-05-19T02:41:37.825Z",
			"providerType": "STRIPE"
		},
		"feeOptIn": false,
		"public_amount": 964
	}
}
{
	"errors": [
		{
			"message": "invalid input syntax for uuid: \"adbda2sd7e52cc8ad\"",
			"status": 500
		}
	]
}
 
Suggest Edits

/subscriptions

Creates a subscription

 
posthttps://api.raisely.com/v3/subscription
{
  "campaignUuid":"cf149e40-36cd-11e7-8c91-27e03d864f2e",
  "interval": "WEEK",
  "amount": 10,
  "count": 1,
  "currency": "AUD",
  "token":"tok_visa"
}
A binary file was returned

You couldn't be authenticated

{
	"user": {
		"id": 2,
		"uuid": "96eabd00-3c3c-11e7-b7a8-a557e52cc8ad",
		"facebookId": null,
		"first_name": "Henrietta",
		"last_name": "Nichols",
		"photo_url": "https://s3.amazonaws.com/uifaces/faces/twitter/helderleal/128.jpg",
		"permission": "PARTICIPANT",
		"country": null,
		"public": {
			"story": "Ezo sumvil asuve izemot eso jub wenvew ca fejkihor vocnu fikadeg ve eza azdo kafsam fawvi igrune nolwiler.",
			"phone": "(858) 364-7484"
		},
		"createdAt": "2017-05-19T02:40:58.577Z",
		"updatedAt": "2017-05-19T02:40:58.577Z",
		"organisationId": 1
	},
	"provider_user": {
		"uuid": "d3a4a0e0-3c63-11e7-921d-91ccd7debf72",
		"id": 10,
		"userId": 2,
		"organisationId": 1,
		"providerId": 1,
		"token": "cus_AgSJ9q5r3zevBo",
		"mode": "TEST",
		"provider_type": "STRIPE",
		"data": {
			"id": "cus_AgSJ9q5r3zevBo",
			"object": "customer",
			"account_balance": 0,
			"created": 1495178417,
			"currency": null,
			"default_source": "card_1AL5PJDiMbh4no30pOJz0kmx",
			"delinquent": false,
			"description": "[email protected] Henrietta Nichols (2), profile:1, campaign:1, organisation: 1",
			"discount": null,
			"email": "[email protected]",
			"livemode": false,
			"metadata": {},
			"shipping": null,
			"sources": {
				"object": "list",
				"data": [
					{
						"id": "card_1AL5PJDiMbh4no30pOJz0kmx",
						"object": "card",
						"address_city": null,
						"address_country": null,
						"address_line1": null,
						"address_line1_check": null,
						"address_line2": null,
						"address_state": null,
						"address_zip": null,
						"address_zip_check": null,
						"brand": "Visa",
						"country": "US",
						"customer": "cus_AgSJ9q5r3zevBo",
						"cvc_check": null,
						"dynamic_last4": null,
						"exp_month": 8,
						"exp_year": 2019,
						"fingerprint": "exbSiVS1IOIVzVrQ",
						"funding": "credit",
						"last4": "4242",
						"metadata": {},
						"name": null,
						"tokenization_method": null
					}
				],
				"has_more": false,
				"total_count": 1,
				"url": "/v1/customers/cus_AgSJ9q5r3zevBo/sources"
			},
			"subscriptions": {
				"object": "list",
				"data": [],
				"has_more": false,
				"total_count": 0,
				"url": "/v1/customers/cus_AgSJ9q5r3zevBo/subscriptions"
			}
		},
		"defaultCard": "card_1AL5PJDiMbh4no30pOJz0kmx",
		"defaultCardPreview": "4242",
		"defaultCardBrand": "Visa",
		"updatedAt": "2017-05-19T07:21:50.830Z",
		"createdAt": "2017-05-19T07:21:50.830Z"
	},
	"subscription": {
		"uuid": "d2f1cba0-3c63-11e7-921d-91ccd7debf72",
		"failed": 0,
		"status": "OK",
		"public": {},
		"private": {},
		"error": {},
		"anonymous": false,
		"id": 11,
		"interval": "WEEK",
		"amount": 1000,
		"count": 1,
		"currency": "AUD",
		"token": "tok_visa",
		"profileId": 1,
		"campaignId": 1,
		"organisationId": 1,
		"providerId": 1,
		"mode": "TEST",
		"chargeAt": "2017-05-19T07:21:49.658Z",
		"nextPayment": "2017-05-19T07:21:49.658Z",
		"fee_opt_in": false,
		"fee": 0,
		"total": 1000,
		"updatedAt": "2017-05-19T07:21:50.842Z",
		"createdAt": "2017-05-19T07:21:49.682Z",
		"failedAt": null,
		"message": null,
		"card": "card_1AL5PJDiMbh4no30pOJz0kmx",
		"providerUserId": 10,
		"userId": 2
	},
	"donation": {
		"uuid": "d3af2830-3c63-11e7-921d-91ccd7debf72",
		"status": "OK",
		"populated": false,
		"internal": {},
		"campaign_amount": 0,
		"campaign_fee": 0,
		"campaign_raisely": 0,
		"id": 10,
		"first_name": "Henrietta",
		"last_name": "Nichols",
		"email": "[email protected]",
		"anonymous": false,
		"mode": "TEST",
		"type": "ONLINE",
		"processing": "RECURRING",
		"method": "CREDIT_CARD",
		"message": null,
		"provider_type": "STRIPE",
		"public": {},
		"total": 1000,
		"amount": 1000,
		"fee": 0,
		"currency": "AUD",
		"campaign_currency": "AUD",
		"fee_opt_in": false,
		"token": "EXISTING_CARD",
		"card": "card_1AL5PJDiMbh4no30pOJz0kmx",
		"card_preview": "4242",
		"customer": "cus_AgSJ9q5r3zevBo",
		"profileId": 1,
		"providerId": 1,
		"campaignId": 1,
		"organisationId": 1,
		"subscriptionId": 11,
		"userId": 2,
		"providerUserId": 10,
		"updatedAt": "2017-05-19T07:21:52.200Z",
		"createdAt": "2017-05-19T07:21:50.901Z",
		"exchange_rate": null,
		"result": {
			"id": "ch_1AL5PKDiMbh4no30X8nxCptL",
			"object": "charge",
			"amount": 1000,
			"amount_refunded": 0,
			"application": "ca_7T2hPQBZLmYBN0AJqvTUEVpYSDxnWqz4",
			"application_fee": null,
			"balance_transaction": "txn_1AL5PKDiMbh4no30lATHu81A",
			"captured": true,
			"created": 1495178418,
			"currency": "aud",
			"customer": "cus_AgSJ9q5r3zevBo",
			"description": "Donation (10) of AUD10 from Henrietta Nichols (2) to Climb for Life (1) for Climb for Life (1)",
			"destination": null,
			"dispute": null,
			"failure_code": null,
			"failure_message": null,
			"fraud_details": {},
			"invoice": null,
			"livemode": false,
			"metadata": {
				"first_name": "Henrietta",
				"last_name": "Nichols",
				"email": "[email protected]",
				"campaign": "mock-b4arhojs",
				"profile": "mock-b4arhojs",
				"profile_url": "https://mock-b4arhojs.raisely.com/mock-b4arhojs"
			},
			"on_behalf_of": null,
			"order": null,
			"outcome": {
				"network_status": "approved_by_network",
				"reason": null,
				"risk_level": "normal",
				"seller_message": "Payment complete.",
				"type": "authorized"
			},
			"paid": true,
			"receipt_email": null,
			"receipt_number": null,
			"refunded": false,
			"refunds": {
				"object": "list",
				"data": [],
				"has_more": false,
				"total_count": 0,
				"url": "/v1/charges/ch_1AL5PKDiMbh4no30X8nxCptL/refunds"
			},
			"review": null,
			"shipping": null,
			"source": {
				"id": "card_1AL5PJDiMbh4no30pOJz0kmx",
				"object": "card",
				"address_city": null,
				"address_country": null,
				"address_line1": null,
				"address_line1_check": null,
				"address_line2": null,
				"address_state": null,
				"address_zip": null,
				"address_zip_check": null,
				"brand": "Visa",
				"country": "US",
				"customer": "cus_AgSJ9q5r3zevBo",
				"cvc_check": null,
				"dynamic_last4": null,
				"exp_month": 8,
				"exp_year": 2019,
				"fingerprint": "exbSiVS1IOIVzVrQ",
				"funding": "credit",
				"last4": "4242",
				"metadata": {},
				"name": null,
				"tokenization_method": null
			},
			"source_transfer": null,
			"statement_descriptor": null,
			"status": "succeeded",
			"transfer_group": null
		},
		"public_amount": 10,
		"public_fee": 0,
		"public_total": 10
	}
}
{
  "errors": [
    {
      "message": "Please sepcify a valid campaign",
      "status": 500
    }
  ]
}

Body Params

campaignUuid
string

Uuid of the campaign you want the subscription to be created for.

interval
string

'HOUR', 'MINUTE', 'DAY','WEEK','MONTH','YEAR' are the options for the time period the subscription is processed for

amount
int32

Amount in dollars how much you want your subscription to process each time

count
int32

The number of intervals between each processing. Ie 2(count) WEEK(interval)

currency
string

Examples include AUD, USD and EUR

token
string

Token that is returned from connected payment provider

public
object

Object that saves any kind of data for use within your Raisely website's templates

 
private
object

Object that saves any kind of data for private use with your Raisely reports.

 
anonymous
boolean

Make subscription and donation appear as anonymous

fee_amount
int32

Fee amount if you want to include a fee

 
Suggest Edits

/subscriptions/:subscription

Update a subscription

 
patchhttps://api.raisely.com/v3/subscription/subscription
{ 
	"data": {
  	"interval": "MONTH"
   }
}
A binary file was returned

You couldn't be authenticated

{
	"data": {
		"uuid": "d2f1cba0-3c63-11e7-921d-91ccd7debf72",
		"createdAt": "2017-05-19T07:21:49.682Z",
		"user": {
			"uuid": "96eabd00-3c3c-11e7-b7a8-a557e52cc8ad",
			"createdAt": "2017-05-19T02:40:58.577Z",
			"updatedAt": "2017-05-19T02:40:58.577Z",
			"firstName": "Henrietta",
			"lastName": "Nichols",
			"photoUrl": "https://s3.amazonaws.com/uifaces/faces/twitter/helderleal/128.jpg"
		},
		"donations": [
			{
				"uuid": "d3af2830-3c63-11e7-921d-91ccd7debf72",
				"type": "ONLINE",
				"method": "CREDIT_CARD",
				"currency": "AUD",
				"message": null,
				"anonymous": false,
				"amount": 1000,
				"createdAt": "2017-05-19T07:21:50.901Z",
				"mode": "TEST",
				"public": {},
				"firstName": "Henrietta",
				"lastName": "Nichols",
				"publicAmount": 10,
				"publicFee": 0,
				"publicTotal": null
			}
		],
		"profile": {
			"uuid": "95c5ec10-3c3c-11e7-b7a8-a557e52cc8ad",
			"path": "mock-b4arhojs",
			"name": "Climb for Life",
			"currency": "AUD",
			"goal": 10000,
			"status": "ACTIVE",
			"type": "GROUP",
			"description": null,
			"createdAt": "2017-05-19T02:40:56.657Z",
			"updatedAt": "2017-05-19T02:40:56.657Z",
			"photoUrl": null,
			"total": 0
		},
		"amount": 10,
		"total": 10,
		"fee": 0,
		"count": 1,
		"interval": "MONTH",
		"currency": "AUD",
		"nextPayment": "May 26th 2017",
		"public": {},
		"providerUser": {
			"uuid": "d3a4a0e0-3c63-11e7-921d-91ccd7debf72",
			"createdAt": "2017-05-19T07:21:50.830Z",
			"mode": "TEST",
			"updatedAt": "2017-05-19T07:21:50.830Z",
			"providerType": "STRIPE"
		},
		"feeOptIn": false,
		"public_amount": 10
	}
}
{
	"errors": [
		{
			"message": "invalid input value for enum enum_subscriptions_interval: \"test\"",
			"status": 500
		}
	]
}

Body Params

data
object
 
data.interval
string

'HOUR', 'MINUTE', 'DAY','WEEK','MONTH','YEAR' are the options for the time period the subscription is processed for

data.amount
int32

Amount in dollars how much you want your subscription to process each time

data.count
int32

The number of intervals between each processing. Ie 2(count) WEEK(interval)

data.currency
string

Examples include AUD, USD and EUR

data.token
string

Token that is returned from connected payment provider

data.public
object

Object that saves any kind of data for use within your Raisely website's templates

 
data.private
object

Object that saves any kind of data for private use with your Raisely reports.

 
data.anonymous
boolean

Make subscription and donation appear as anonymous

data.fee
int32

Fee amount if you want to include a fee

 
Suggest Edits

/subscriptions/:subscription/pause

Pauses a subscription

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
puthttps://api.raisely.com/v3/subscriptions/subscription/pause
curl --request PUT \
  --url https://api.raisely.com/v3/subscriptions/subscription/pause
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://api.raisely.com/v3/subscriptions/subscription/pause' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/subscriptions/subscription/pause")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.raisely.com/v3/subscriptions/subscription/pause");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/subscriptions/subscription/pause"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
	"data": {
		"uuid": "d2f1cba0-3c63-11e7-921d-91ccd7debf72",
		"createdAt": "2017-05-19T07:21:49.682Z",
		"user": {
			"uuid": "96eabd00-3c3c-11e7-b7a8-a557e52cc8ad",
			"createdAt": "2017-05-19T02:40:58.577Z",
			"updatedAt": "2017-05-19T02:40:58.577Z",
			"facebookId": null,
			"email": "[email protected]",
			"username": "[email protected]",
			"permission": "PARTICIPANT",
			"address1": null,
			"address2": null,
			"postcode": null,
			"state": null,
			"suburb": null,
			"country": null,
			"public": {
				"story": "Ezo sumvil asuve izemot eso jub wenvew ca fejkihor vocnu fikadeg ve eza azdo kafsam fawvi igrune nolwiler.",
				"phone": "(858) 364-7484"
			},
			"firstName": "Henrietta",
			"lastName": "Nichols",
			"photoUrl": "https://s3.amazonaws.com/uifaces/faces/twitter/helderleal/128.jpg",
			"ipNumber": null,
			"ipLatitude": null,
			"ipLongitude": null,
			"ipCity": null,
			"ipCountry": null
		},
		"donations": [
			{
				"uuid": "d3af2830-3c63-11e7-921d-91ccd7debf72",
				"type": "ONLINE",
				"method": "CREDIT_CARD",
				"currency": "AUD",
				"message": null,
				"anonymous": false,
				"amount": 1000,
				"createdAt": "2017-05-19T07:21:50.901Z",
				"mode": "TEST",
				"public": {},
				"email": "[email protected]",
				"firstName": "Henrietta",
				"lastName": "Nichols",
				"publicAmount": 10,
				"publicFee": 0,
				"publicTotal": null
			}
		],
		"profile": {
			"uuid": "95c5ec10-3c3c-11e7-b7a8-a557e52cc8ad",
			"path": "mock-b4arhojs",
			"name": "Climb for Life",
			"currency": "AUD",
			"goal": 10000,
			"status": "ACTIVE",
			"type": "GROUP",
			"description": null,
			"createdAt": "2017-05-19T02:40:56.657Z",
			"updatedAt": "2017-05-19T02:40:56.657Z",
			"photoUrl": null,
			"total": 0
		},
		"amount": 10,
		"total": 10,
		"fee": 0,
		"count": 1,
		"interval": "MONTH",
		"currency": "AUD",
		"nextPayment": "May 26th 2017",
		"public": {},
		"failedAt": null,
		"message": null,
		"failed": 0,
		"status": "PAUSED",
		"private": {},
		"error": {},
		"anonymous": false,
		"card": "card_1AL5PJDiMbh4no30pOJz0kmx",
		"id": 11,
		"providerUser": {
			"uuid": "d3a4a0e0-3c63-11e7-921d-91ccd7debf72",
			"createdAt": "2017-05-19T07:21:50.830Z",
			"mode": "TEST",
			"updatedAt": "2017-05-19T07:21:50.830Z",
			"token": "cus_AgSJ9q5r3zevBo",
			"data": {
				"id": "cus_AgSJ9q5r3zevBo",
				"object": "customer",
				"account_balance": 0,
				"created": 1495178417,
				"currency": null,
				"default_source": "card_1AL5PJDiMbh4no30pOJz0kmx",
				"delinquent": false,
				"description": "[email protected] Henrietta Nichols (2), profile:1, campaign:1, organisation: 1",
				"discount": null,
				"email": "[email protected]",
				"livemode": false,
				"metadata": {},
				"shipping": null,
				"sources": {
					"object": "list",
					"data": [
						{
							"id": "card_1AL5PJDiMbh4no30pOJz0kmx",
							"object": "card",
							"address_city": null,
							"address_country": null,
							"address_line1": null,
							"address_line1_check": null,
							"address_line2": null,
							"address_state": null,
							"address_zip": null,
							"address_zip_check": null,
							"brand": "Visa",
							"country": "US",
							"customer": "cus_AgSJ9q5r3zevBo",
							"cvc_check": null,
							"dynamic_last4": null,
							"exp_month": 8,
							"exp_year": 2019,
							"fingerprint": "exbSiVS1IOIVzVrQ",
							"funding": "credit",
							"last4": "4242",
							"metadata": {},
							"name": null,
							"tokenization_method": null
						}
					],
					"has_more": false,
					"total_count": 1,
					"url": "/v1/customers/cus_AgSJ9q5r3zevBo/sources"
				},
				"subscriptions": {
					"object": "list",
					"data": [],
					"has_more": false,
					"total_count": 0,
					"url": "/v1/customers/cus_AgSJ9q5r3zevBo/subscriptions"
				}
			},
			"defaultCard": "card_1AL5PJDiMbh4no30pOJz0kmx",
			"defaultCardPreview": "4242",
			"defaultCardBrand": "Visa",
			"providerType": "STRIPE"
		},
		"feeOptIn": false,
		"public_amount": 10
	}
}
 
Suggest Edits

/subscriptions/:subscription/activate

Enables a subscription

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
puthttps://api.raisely.com/v3/subscriptions/subscription/activate
curl --request PUT \
  --url https://api.raisely.com/v3/subscriptions/subscription/activate
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://api.raisely.com/v3/subscriptions/subscription/activate' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/subscriptions/subscription/activate")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.raisely.com/v3/subscriptions/subscription/activate");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/subscriptions/subscription/activate"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
	"data": {
		"uuid": "d2f1cba0-3c63-11e7-921d-91ccd7debf72",
		"createdAt": "2017-05-19T07:21:49.682Z",
		"user": {
			"uuid": "96eabd00-3c3c-11e7-b7a8-a557e52cc8ad",
			"createdAt": "2017-05-19T02:40:58.577Z",
			"updatedAt": "2017-05-19T02:40:58.577Z",
			"facebookId": null,
			"email": "[email protected]",
			"username": "[email protected]",
			"permission": "PARTICIPANT",
			"address1": null,
			"address2": null,
			"postcode": null,
			"state": null,
			"suburb": null,
			"country": null,
			"public": {
				"story": "Ezo sumvil asuve izemot eso jub wenvew ca fejkihor vocnu fikadeg ve eza azdo kafsam fawvi igrune nolwiler.",
				"phone": "(858) 364-7484"
			},
			"firstName": "Henrietta",
			"lastName": "Nichols",
			"photoUrl": "https://s3.amazonaws.com/uifaces/faces/twitter/helderleal/128.jpg",
			"ipNumber": null,
			"ipLatitude": null,
			"ipLongitude": null,
			"ipCity": null,
			"ipCountry": null
		},
		"donations": [
			{
				"uuid": "d3af2830-3c63-11e7-921d-91ccd7debf72",
				"type": "ONLINE",
				"method": "CREDIT_CARD",
				"currency": "AUD",
				"message": null,
				"anonymous": false,
				"amount": 1000,
				"createdAt": "2017-05-19T07:21:50.901Z",
				"mode": "TEST",
				"public": {},
				"email": "[email protected]",
				"firstName": "Henrietta",
				"lastName": "Nichols",
				"publicAmount": 10,
				"publicFee": 0,
				"publicTotal": null
			}
		],
		"profile": {
			"uuid": "95c5ec10-3c3c-11e7-b7a8-a557e52cc8ad",
			"path": "mock-b4arhojs",
			"name": "Climb for Life",
			"currency": "AUD",
			"goal": 10000,
			"status": "ACTIVE",
			"type": "GROUP",
			"description": null,
			"createdAt": "2017-05-19T02:40:56.657Z",
			"updatedAt": "2017-05-19T02:40:56.657Z",
			"photoUrl": null,
			"total": 0
		},
		"amount": 10,
		"total": 10,
		"fee": 0,
		"count": 1,
		"interval": "MONTH",
		"currency": "AUD",
		"nextPayment": "May 26th 2017",
		"public": {},
		"failedAt": null,
		"message": null,
		"failed": 0,
		"status": "OK",
		"private": {},
		"error": {},
		"anonymous": false,
		"card": "card_1AL5PJDiMbh4no30pOJz0kmx",
		"id": 11,
		"providerUser": {
			"uuid": "d3a4a0e0-3c63-11e7-921d-91ccd7debf72",
			"createdAt": "2017-05-19T07:21:50.830Z",
			"mode": "TEST",
			"updatedAt": "2017-05-19T07:21:50.830Z",
			"token": "cus_AgSJ9q5r3zevBo",
			"data": {
				"id": "cus_AgSJ9q5r3zevBo",
				"object": "customer",
				"account_balance": 0,
				"created": 1495178417,
				"currency": null,
				"default_source": "card_1AL5PJDiMbh4no30pOJz0kmx",
				"delinquent": false,
				"description": "[email protected] Henrietta Nichols (2), profile:1, campaign:1, organisation: 1",
				"discount": null,
				"email": "[email protected]",
				"livemode": false,
				"metadata": {},
				"shipping": null,
				"sources": {
					"object": "list",
					"data": [
						{
							"id": "card_1AL5PJDiMbh4no30pOJz0kmx",
							"object": "card",
							"address_city": null,
							"address_country": null,
							"address_line1": null,
							"address_line1_check": null,
							"address_line2": null,
							"address_state": null,
							"address_zip": null,
							"address_zip_check": null,
							"brand": "Visa",
							"country": "US",
							"customer": "cus_AgSJ9q5r3zevBo",
							"cvc_check": null,
							"dynamic_last4": null,
							"exp_month": 8,
							"exp_year": 2019,
							"fingerprint": "exbSiVS1IOIVzVrQ",
							"funding": "credit",
							"last4": "4242",
							"metadata": {},
							"name": null,
							"tokenization_method": null
						}
					],
					"has_more": false,
					"total_count": 1,
					"url": "/v1/customers/cus_AgSJ9q5r3zevBo/sources"
				},
				"subscriptions": {
					"object": "list",
					"data": [],
					"has_more": false,
					"total_count": 0,
					"url": "/v1/customers/cus_AgSJ9q5r3zevBo/subscriptions"
				}
			},
			"defaultCard": "card_1AL5PJDiMbh4no30pOJz0kmx",
			"defaultCardPreview": "4242",
			"defaultCardBrand": "Visa",
			"providerType": "STRIPE"
		},
		"feeOptIn": false,
		"public_amount": 10
	}
}
 
Suggest Edits

/subscriptions/:subscription/cancel

Enables a subscription

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
puthttps://api.raisely.com/v3/subscriptions/subscription/cancel
curl --request PUT \
  --url https://api.raisely.com/v3/subscriptions/subscription/cancel
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://api.raisely.com/v3/subscriptions/subscription/cancel' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/subscriptions/subscription/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.raisely.com/v3/subscriptions/subscription/cancel");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/subscriptions/subscription/cancel"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
	"data": {
		"uuid": "d2f1cba0-3c63-11e7-921d-91ccd7debf72",
		"createdAt": "2017-05-19T07:21:49.682Z",
		"user": {
			"uuid": "96eabd00-3c3c-11e7-b7a8-a557e52cc8ad",
			"createdAt": "2017-05-19T02:40:58.577Z",
			"updatedAt": "2017-05-19T02:40:58.577Z",
			"facebookId": null,
			"email": "[email protected]",
			"username": "[email protected]",
			"permission": "PARTICIPANT",
			"address1": null,
			"address2": null,
			"postcode": null,
			"state": null,
			"suburb": null,
			"country": null,
			"public": {
				"story": "Ezo sumvil asuve izemot eso jub wenvew ca fejkihor vocnu fikadeg ve eza azdo kafsam fawvi igrune nolwiler.",
				"phone": "(858) 364-7484"
			},
			"firstName": "Henrietta",
			"lastName": "Nichols",
			"photoUrl": "https://s3.amazonaws.com/uifaces/faces/twitter/helderleal/128.jpg",
			"ipNumber": null,
			"ipLatitude": null,
			"ipLongitude": null,
			"ipCity": null,
			"ipCountry": null
		},
		"donations": [
			{
				"uuid": "d3af2830-3c63-11e7-921d-91ccd7debf72",
				"type": "ONLINE",
				"method": "CREDIT_CARD",
				"currency": "AUD",
				"message": null,
				"anonymous": false,
				"amount": 1000,
				"createdAt": "2017-05-19T07:21:50.901Z",
				"mode": "TEST",
				"public": {},
				"email": "[email protected]",
				"firstName": "Henrietta",
				"lastName": "Nichols",
				"publicAmount": 10,
				"publicFee": 0,
				"publicTotal": null
			}
		],
		"profile": {
			"uuid": "95c5ec10-3c3c-11e7-b7a8-a557e52cc8ad",
			"path": "mock-b4arhojs",
			"name": "Climb for Life",
			"currency": "AUD",
			"goal": 10000,
			"status": "ACTIVE",
			"type": "GROUP",
			"description": null,
			"createdAt": "2017-05-19T02:40:56.657Z",
			"updatedAt": "2017-05-19T02:40:56.657Z",
			"photoUrl": null,
			"total": 0
		},
		"amount": 10,
		"total": 10,
		"fee": 0,
		"count": 1,
		"interval": "MONTH",
		"currency": "AUD",
		"nextPayment": "May 26th 2017",
		"public": {},
		"failedAt": null,
		"message": null,
		"failed": 0,
		"status": "CANCELLED",
		"private": {},
		"error": {},
		"anonymous": false,
		"card": "card_1AL5PJDiMbh4no30pOJz0kmx",
		"id": 11,
		"providerUser": {
			"uuid": "d3a4a0e0-3c63-11e7-921d-91ccd7debf72",
			"createdAt": "2017-05-19T07:21:50.830Z",
			"mode": "TEST",
			"updatedAt": "2017-05-19T07:21:50.830Z",
			"token": "cus_AgSJ9q5r3zevBo",
			"data": {
				"id": "cus_AgSJ9q5r3zevBo",
				"object": "customer",
				"account_balance": 0,
				"created": 1495178417,
				"currency": null,
				"default_source": "card_1AL5PJDiMbh4no30pOJz0kmx",
				"delinquent": false,
				"description": "[email protected] Henrietta Nichols (2), profile:1, campaign:1, organisation: 1",
				"discount": null,
				"email": "[email protected]",
				"livemode": false,
				"metadata": {},
				"shipping": null,
				"sources": {
					"object": "list",
					"data": [
						{
							"id": "card_1AL5PJDiMbh4no30pOJz0kmx",
							"object": "card",
							"address_city": null,
							"address_country": null,
							"address_line1": null,
							"address_line1_check": null,
							"address_line2": null,
							"address_state": null,
							"address_zip": null,
							"address_zip_check": null,
							"brand": "Visa",
							"country": "US",
							"customer": "cus_AgSJ9q5r3zevBo",
							"cvc_check": null,
							"dynamic_last4": null,
							"exp_month": 8,
							"exp_year": 2019,
							"fingerprint": "exbSiVS1IOIVzVrQ",
							"funding": "credit",
							"last4": "4242",
							"metadata": {},
							"name": null,
							"tokenization_method": null
						}
					],
					"has_more": false,
					"total_count": 1,
					"url": "/v1/customers/cus_AgSJ9q5r3zevBo/sources"
				},
				"subscriptions": {
					"object": "list",
					"data": [],
					"has_more": false,
					"total_count": 0,
					"url": "/v1/customers/cus_AgSJ9q5r3zevBo/subscriptions"
				}
			},
			"defaultCard": "card_1AL5PJDiMbh4no30pOJz0kmx",
			"defaultCardPreview": "4242",
			"defaultCardBrand": "Visa",
			"providerType": "STRIPE"
		},
		"feeOptIn": false,
		"public_amount": 10
	}
}
 
Suggest Edits

/subscriptions/:subscription/process

Enables a subscription

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
puthttps://api.raisely.com/v3/subscriptions/subscription/process
curl --request PUT \
  --url https://api.raisely.com/v3/subscriptions/subscription/process
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://api.raisely.com/v3/subscriptions/subscription/process' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/subscriptions/subscription/process")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.raisely.com/v3/subscriptions/subscription/process");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/subscriptions/subscription/process"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
	"data": {
		"uuid": "d2f1cba0-3c63-11e7-921d-91ccd7debf72",
		"createdAt": "2017-05-19T07:21:49.682Z",
		"user": {
			"uuid": "96eabd00-3c3c-11e7-b7a8-a557e52cc8ad",
			"createdAt": "2017-05-19T02:40:58.577Z",
			"updatedAt": "2017-05-19T02:40:58.577Z",
			"facebookId": null,
			"email": "[email protected]",
			"username": "[email protected]",
			"permission": "PARTICIPANT",
			"address1": null,
			"address2": null,
			"postcode": null,
			"state": null,
			"suburb": null,
			"country": null,
			"public": {
				"story": "Ezo sumvil asuve izemot eso jub wenvew ca fejkihor vocnu fikadeg ve eza azdo kafsam fawvi igrune nolwiler.",
				"phone": "(858) 364-7484"
			},
			"firstName": "Henrietta",
			"lastName": "Nichols",
			"photoUrl": "https://s3.amazonaws.com/uifaces/faces/twitter/helderleal/128.jpg",
			"ipNumber": null,
			"ipLatitude": null,
			"ipLongitude": null,
			"ipCity": null,
			"ipCountry": null
		},
		"donations": [
			{
				"uuid": "d3af2830-3c63-11e7-921d-91ccd7debf72",
				"type": "ONLINE",
				"method": "CREDIT_CARD",
				"currency": "AUD",
				"message": null,
				"anonymous": false,
				"amount": 1000,
				"createdAt": "2017-05-19T07:21:50.901Z",
				"mode": "TEST",
				"public": {},
				"email": "[email protected]",
				"firstName": "Henrietta",
				"lastName": "Nichols",
				"publicAmount": 10,
				"publicFee": 0,
				"publicTotal": null
			}
		],
		"profile": {
			"uuid": "95c5ec10-3c3c-11e7-b7a8-a557e52cc8ad",
			"path": "mock-b4arhojs",
			"name": "Climb for Life",
			"currency": "AUD",
			"goal": 10000,
			"status": "ACTIVE",
			"type": "GROUP",
			"description": null,
			"createdAt": "2017-05-19T02:40:56.657Z",
			"updatedAt": "2017-05-19T02:40:56.657Z",
			"photoUrl": null,
			"total": 0
		},
		"amount": 10,
		"total": 10,
		"fee": 0,
		"count": 1,
		"interval": "MONTH",
		"currency": "AUD",
		"nextPayment": "May 26th 2017",
		"public": {},
		"failedAt": null,
		"message": null,
		"failed": 0,
		"status": "OK",
		"private": {},
		"error": {},
		"anonymous": false,
		"card": "card_1AL5PJDiMbh4no30pOJz0kmx",
		"id": 11,
		"providerUser": {
			"uuid": "d3a4a0e0-3c63-11e7-921d-91ccd7debf72",
			"createdAt": "2017-05-19T07:21:50.830Z",
			"mode": "TEST",
			"updatedAt": "2017-05-19T07:21:50.830Z",
			"token": "cus_AgSJ9q5r3zevBo",
			"data": {
				"id": "cus_AgSJ9q5r3zevBo",
				"object": "customer",
				"account_balance": 0,
				"created": 1495178417,
				"currency": null,
				"default_source": "card_1AL5PJDiMbh4no30pOJz0kmx",
				"delinquent": false,
				"description": "[email protected] Henrietta Nichols (2), profile:1, campaign:1, organisation: 1",
				"discount": null,
				"email": "[email protected]",
				"livemode": false,
				"metadata": {},
				"shipping": null,
				"sources": {
					"object": "list",
					"data": [
						{
							"id": "card_1AL5PJDiMbh4no30pOJz0kmx",
							"object": "card",
							"address_city": null,
							"address_country": null,
							"address_line1": null,
							"address_line1_check": null,
							"address_line2": null,
							"address_state": null,
							"address_zip": null,
							"address_zip_check": null,
							"brand": "Visa",
							"country": "US",
							"customer": "cus_AgSJ9q5r3zevBo",
							"cvc_check": null,
							"dynamic_last4": null,
							"exp_month": 8,
							"exp_year": 2019,
							"fingerprint": "exbSiVS1IOIVzVrQ",
							"funding": "credit",
							"last4": "4242",
							"metadata": {},
							"name": null,
							"tokenization_method": null
						}
					],
					"has_more": false,
					"total_count": 1,
					"url": "/v1/customers/cus_AgSJ9q5r3zevBo/sources"
				},
				"subscriptions": {
					"object": "list",
					"data": [],
					"has_more": false,
					"total_count": 0,
					"url": "/v1/customers/cus_AgSJ9q5r3zevBo/subscriptions"
				}
			},
			"defaultCard": "card_1AL5PJDiMbh4no30pOJz0kmx",
			"defaultCardPreview": "4242",
			"defaultCardBrand": "Visa",
			"providerType": "STRIPE"
		},
		"feeOptIn": false,
		"public_amount": 10
	}
}
 
Suggest Edits

/subscriptions/:subscription/donations

Find all the donations for a given subscription

 
Suggest Edits

/campaigns

Fetches all campaigns owned by your organisation. (Only available to ORG_ADMIN)

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/campaigns
curl --request GET \
  --url https://api.raisely.com/v3/campaigns
var request = require("request");

var options = { method: 'GET', url: 'https://api.raisely.com/v3/campaigns' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/campaigns");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/campaigns"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "path": 'donateforchange',
      "mode": "LIVE",
      "name": "Donate for Change",
      "createdAt": "2016-08-10T00:51:17.790Z",
      "uuid": "a0c55810-3964-11e7-80b7-79bfdc0cf294",
      "currency": "AUD",
      "goal": 50000,
      "organisationUuid": "a367c850-3964-11e7-b63e-1d419d50a55f",
      "providerUuid": "a02d5dd0-3964-11e7-b63e-1d419d50a55f",
      "total": 546.73,
      "totals": [
        {
          "total": 54673,
          "mode": "LIVE",
          "currency": "AUD",
          "parentId": null,
          "profileId": 5584
        }
      ],
      "profile": {
        "uuid": "a0d1b420-3964-11e7-b63e-1d419d50a55f",
        "path": "donateforchange",
        "name": "Donate for Change",
        "currency": "AUD",
        "goal": 850000,
        "status": "ACTIVE",
        "type": "GROUP",
        "description": null,
        "createdAt": "2016-08-10T00:51:17.807Z",
        "updatedAt": "2016-10-26T22:00:27.729Z",
        "photoUrl": null,
        "total": 0
      },
      "config": {
        "site": {
          "campaign": "donateforchange",
          "stripe": {
            "live": true,
            "connect": false
          },
          "analytics": {
            "active": true,
            "account": "UA-12345678-1",
            "productName": "Donate for Change",
            "productCategory": "Raisely"
          },
          "uservoice": {
            "active": true,
            "src": "code",
            "accentColor": "#888888",
            "triggerColor": "white",
            "triggerBackgroundColor": "rgba(46, 49, 51, 0.6)"
          },
          "facebook": {
            "active": true,
            "appId": "1234567890",
            "admin": "123456789"
          },
          "typekit": {
            "active": false,
            "kitID": "jdn1wwy"
          },
          "segment": {
            "active": true,
            "writeKey": "tepumMwvwaxbDBiFZdBJNs1BwiAiSy5i"
          },
        },
        "layouts": {
          "form": {}
        },
        "history": {},
        "theme": {
          "id": "challenger",
          "version": "2.3.0",
          "fonts": "Raleway:400,700|Roboto:300,300i,400,500,500i,700,700i",
          "styleRounded": false,
          "styleOutline": false,
          "primaryColor": "#0065F9",
          "backgroundUrl": "https://...",
          "defaultProfileUrl": "https://...",
          "logoUrl": "https://...",
          "headlineText": "Make change today",
          "homeText": "...",
          "footerText": "...",
          "donationsText": "...",
          "dashboardText": "...",
          "customCss": "",
          "siteTitle": "Donate for Change",
          "siteFavicon": "https://...",
          "introText": "...",
          "facebookShareUrl": "..."
        },
        "language": {
          "individual": "individual",
          "individuals": "individuals",
          "group": "team",
          "groups": "teams",
          "campaign": "Donate for Change",
          "donate": "donate",
          "donation": "donation",
          "donating": "donating",
          "goal": "goal",
          "signup": "Sign Up"
        },
        "amounts": [
          {
            "amount": 30,
            "description": "",
            "title": ""
          },
          {
            "amount": 50,
            "description": "",
            "title": ""
          },
          {
            "amount": 100,
            "description": "",
            "title": ""
          },
          {
            "amount": 200,
            "description": "",
            "title": ""
          },
          {
            "amount": 500
          }
        ],
        "social": {
          "facebookDescription": "Donate for change today",
          "facebookShareUrl": "https://...png",
          "facebookPageUrl": "Donate for Change",
          "twitterTweet": "Donate for Change today",
          "twitterHashtag": "donateforchange",
          "twitterHandle": "donateforchange1",
          "facebookTitle": "Donate for Change"
        },
        "menu": [
          {
            "title": "Resources",
            "link": "/page/starterkit"
          }
        ],
        "pages": {
          "about": {
            "title": "About",
            "url": "about",
            "body": "<h1>About us</h1>..."
          },
        },
        "media": [
          {
            "url": "https://raisely-images.imgix.net/donateforchange/admin/blue-circle-png-png.png",
            "file": "blue-circle-png.png",
            "type": "image/png"
          },
        ],
        "reports": {
          "x": null,
          "1474595398285": null,
          "1474595591058": {
            "name": "Donations (Prize Claim)",
            "type": "donations",
            "fields": "id,createdAt,first_name,last_name,email,anonymous,mode,status,type,currency,amount,gateway_fee,net,raisely_opt_in,raisely_fee,total,profile.id,profile.name,profile.path,profile.url,user.id",
            "createdAt": "1474595591058"
          },
        },
        "emails": {
          "subscriptionNew": true,
          "subscriptionReceipt": true,
          "subscriptionFailed": true,
          "subscriptionFailing": true,
          "donationNotification": true,
          "donationReceipt": true,
          "passwordReset": true,
          "signupNew": true,
          "signupExisting": true,
          "weeklyDigest": true
        }
      },
    }
  ],
  "pagination": {
    "total": 1,
    "pages": 0,
    "prev_url": false,
    "next_url": false,
    "offset": 0,
    "limit": 10
  }
}

Query Params

mode
string

Either TEST or LIVE, show only campaigns in TEST or LIVE mode respectively.

path
string

Find campaigns with that exact path

private
boolean

If true, object will include private attributes: feePercent and private

q
string

Search for campaigns containing q. Searches the name column

 
Suggest Edits

/campaigns/:campaign

Fetches the specified campaign.
No authentication is required to access these details.

 
gethttps://api.raisely.com/v3/campaigns/campaignUuid
curl --request GET \
  --url https://api.raisely.com/v3/campaigns/campaignUuid
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.raisely.com/v3/campaigns/campaignUuid' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/campaigns/campaignUuid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/campaigns/campaignUuid");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/campaigns/campaignUuid"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "path": 'donateforchange',
    "mode": "LIVE",
    "name": "Donate for Change",
    "createdAt": "2016-08-10T00:51:17.790Z",
    "uuid": "a0c55810-3964-11e7-80b7-79bfdc0cf294",
    "currency": "AUD",
    "goal": 50000,
    "organisationUuid": "a367c850-3964-11e7-b63e-1d419d50a55f",
    "providerUuid": "a02d5dd0-3964-11e7-b63e-1d419d50a55f",
    "total": 546.73,
    "totals": [
      {
        "total": 54673,
        "mode": "LIVE",
        "currency": "AUD",
        "parentId": null,
        "profileId": 5584
      }
    ],
    "profile": {
      "uuid": "a0d1b420-3964-11e7-b63e-1d419d50a55f",
      "path": "donateforchange",
      "name": "Donate for Change",
      "currency": "AUD",
      "goal": 850000,
      "status": "ACTIVE",
      "type": "GROUP",
      "description": null,
      "createdAt": "2016-08-10T00:51:17.807Z",
      "updatedAt": "2016-10-26T22:00:27.729Z",
      "photoUrl": null,
      "total": 0
    },
    "config": {
      "site": {
        "campaign": "donateforchange",
        "stripe": {
          "live": true,
          "connect": false
        },
        "analytics": {
          "active": true,
          "account": "UA-12345678-1",
          "productName": "Donate for Change",
          "productCategory": "Raisely"
        },
        "uservoice": {
          "active": true,
          "src": "code",
          "accentColor": "#888888",
          "triggerColor": "white",
          "triggerBackgroundColor": "rgba(46, 49, 51, 0.6)"
        },
        "facebook": {
          "active": true,
          "appId": "1234567890",
          "admin": "123456789"
        },
        "typekit": {
          "active": false,
          "kitID": "jdn1wwy"
        },
        "segment": {
          "active": true,
          "writeKey": "tepumMwvwaxbDBiFZdBJNs1BwiAiSy5i"
        },
      },
      "layouts": {
        "form": {}
      },
      "history": {},
      "theme": {
        "id": "challenger",
        "version": "2.3.0",
        "fonts": "Raleway:400,700|Roboto:300,300i,400,500,500i,700,700i",
        "styleRounded": false,
        "styleOutline": false,
        "primaryColor": "#0065F9",
        "backgroundUrl": "https://...",
        "defaultProfileUrl": "https://...",
        "logoUrl": "https://...",
        "headlineText": "Make change today",
        "homeText": "...",
        "footerText": "...",
        "donationsText": "...",
        "dashboardText": "...",
        "customCss": "",
        "siteTitle": "Donate for Change",
        "siteFavicon": "https://...",
        "introText": "...",
        "facebookShareUrl": "..."
      },
      "language": {
        "individual": "individual",
        "individuals": "individuals",
        "group": "team",
        "groups": "teams",
        "campaign": "Donate for Change",
        "donate": "donate",
        "donation": "donation",
        "donating": "donating",
        "goal": "goal",
        "signup": "Sign Up"
      },
      "amounts": [
        {
          "amount": 30,
          "description": "",
          "title": ""
        },
        {
          "amount": 50,
          "description": "",
          "title": ""
        },
        {
          "amount": 100,
          "description": "",
          "title": ""
        },
        {
          "amount": 200,
          "description": "",
          "title": ""
        },
        {
          "amount": 500
        }
      ],
      "social": {
        "facebookDescription": "Donate for change today",
        "facebookShareUrl": "https://...png",
        "facebookPageUrl": "Donate for Change",
        "twitterTweet": "Donate for Change today",
        "twitterHashtag": "donateforchange",
        "twitterHandle": "donateforchange1",
        "facebookTitle": "Donate for Change"
      },
      "menu": [
        {
          "title": "Resources",
          "link": "/page/starterkit"
        }
      ],
      "pages": {
        "about": {
          "title": "About",
          "url": "about",
          "body": "<h1>About us</h1>..."
        },
      },
      "media": [
        {
          "url": "https://raisely-images.imgix.net/donateforchange/admin/blue-circle-png-png.png",
          "file": "blue-circle-png.png",
          "type": "image/png"
        },
      ],
      "reports": {
        "x": null,
        "1474595398285": null,
        "1474595591058": {
          "name": "Donations (Prize Claim)",
          "type": "donations",
          "fields": "id,createdAt,first_name,last_name,email,anonymous,mode,status,type,currency,amount,gateway_fee,net,raisely_opt_in,raisely_fee,total,profile.id,profile.name,profile.path,profile.url,user.id",
          "createdAt": "1474595591058"
        },
      },
      "emails": {
        "subscriptionNew": true,
        "subscriptionReceipt": true,
        "subscriptionFailed": true,
        "subscriptionFailing": true,
        "donationNotification": true,
        "donationReceipt": true,
        "passwordReset": true,
        "signupNew": true,
        "signupExisting": true,
        "weeklyDigest": true
      },
    }
  "pagination": {
    "total": 1,
    "pages": 0,
    "prev_url": false,
    "next_url": false,
    "offset": 0,
    "limit": 10
  }
}

Query Params

private
boolean

If true, object will include private attributes: feePercent and private (only permitted for ORG_ADMIN)

 
Suggest Edits

/campaigns

Create a new campaign

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
posthttps://api.raisely.com/v3/campaigns
curl --request POST \
  --url https://api.raisely.com/v3/campaigns
var request = require("request");

var options = { method: 'POST', url: 'https://api.raisely.com/v3/campaigns' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.raisely.com/v3/campaigns");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/campaigns"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

data
object
 
data.currency
string
required

A 3 letter currency code. The currency of the campaign

data.goal
int32
required

The target amount for the campaign to raise

data.name
string
required

The name for the campaign

data.path
string
required

The domain for the campaign, the campaign will be found at {path}.raisely.com

 
Suggest Edits

/campaigns/:campaign

Update a campaign

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
patchhttps://api.raisely.com/v3/campaigns/:campaign
curl --request PATCH \
  --url https://api.raisely.com/v3/campaigns/:campaign
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.raisely.com/v3/campaigns/:campaign' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/campaigns/:campaign")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.raisely.com/v3/campaigns/:campaign");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/campaigns/:campaign"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

/campaigns/:campaign/config

Gets the configuration for a campaign
Available to ANYONE

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/campaigns/campaign/config
curl --request GET \
  --url https://api.raisely.com/v3/campaigns/campaign/config
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.raisely.com/v3/campaigns/campaign/config' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/campaigns/campaign/config")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/campaigns/campaign/config");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/campaigns/campaign/config"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

/campaigns/:campaign/config/:attribute

NOTE: Unlike other update methods, this will overwrite the entire attribute. There is no PATCH version of this endpoint available.
Update the config object identified by the given attribute.
eg is the equivalent of
config[attribute]=body.data

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
puthttps://api.raisely.com/v3/campaigns/campaign/config/attribute
curl --request PUT \
  --url https://api.raisely.com/v3/campaigns/campaign/config/attribute
var request = require("request");

var options = { method: 'PUT',
  url:
   'https://api.raisely.com/v3/campaigns/campaign/config/attribute' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/campaigns/campaign/config/attribute")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.raisely.com/v3/campaigns/campaign/config/attribute");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/campaigns/campaign/config/attribute"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

data
object

The object to replace the config key with

 
 
Suggest Edits

/campaigns/:campaign/reset_key

Reset the private key of the campaign

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/campaigns/campaign/reset_key
curl --request GET \
  --url https://api.raisely.com/v3/campaigns/campaign/reset_key
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.raisely.com/v3/campaigns/campaign/reset_key' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/campaigns/campaign/reset_key")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/campaigns/campaign/reset_key");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/campaigns/campaign/reset_key"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

/campaign/:campaign/donations

 
Suggest Edits

/campaign/:campaign/profiles

 
Suggest Edits

/campaigns/:campaign/templates

Create a new template
Restricted to ORG_ADMINs

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
posthttps://api.raisely.com/v3/campaigns/:campaign/templates
curl --request POST \
  --url https://api.raisely.com/v3/campaigns/:campaign/templates
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.raisely.com/v3/campaigns/:campaign/templates' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/campaigns/:campaign/templates")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.raisely.com/v3/campaigns/:campaign/templates");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/campaigns/:campaign/templates"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "title": "donate",
    "url": "https://..." // The url of the saved template
  }
}

Body Params

data
object
 
data.title
string

The title of the template

data.body
string

The content of the template

 
Suggest Edits

/campaigns/:campaign/emails

Get the email templates
ORG_ADMINs permission is required

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/campaigns/campaignUuid/emails
curl --request GET \
  --url https://api.raisely.com/v3/campaigns/campaignUuid/emails
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.raisely.com/v3/campaigns/campaignUuid/emails' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/campaigns/campaignUuid/emails")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/campaigns/campaignUuid/emails");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/campaigns/campaignUuid/emails"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "html": {
      "emails": [
        {
          id: "signupNew",
          content: "...html content of the email template..."
        },
        {
          id: "signupExisting",
          ...
        }
      ]
    },
    "vars": {
      "color": "#22262e", // Background color for email header
      "logo": "https://url.com/logo.png", // URL of the logo used for email headers
    },
    "createdAt": "2016-04-01T05:55:00.091Z",
    "updatedAt": "2017-02-22T03:01:23.035Z"
  }
}
 

Templates use handlebars for dynamic values.

The template ids are as follows.

id
Description
Recipient

donationNotification

Notification to a fundraiser that someone has donated to their profile.

Fundraiser

donationReceipt

Thank you & receipt for a normal donation.

Donor

passwordReset

Email sent when a password reset is requested.

Fundraiser / Donor / Regular Donor

signupNew

Email to new fundraiser with link to their dashboard for fundraising.

Fundraiser

signupExisting

Email to new fundraiser with confirmation link to activate account.

Fundraiser

subscriptionReceipt

Receipt for a donation as part of a subscription .

Regular Donor

subscriptionFailed

Email to sent to a donor if their subscription donation has failed and will not be retried.

Regular Donor

subscriptionFailing

Email sent to a donor if a donation as part of a subscription has failed, but will be retried.

Regular Donor

subscriptionNew

Email sent to a user when a subscription is started.

Regular Donor

Suggest Edits

/campaigns/:campaign/emails

Put the email templates
ORG_ADMINs permission is required

NOTE: Unlike other endpoints, emails does not support PATCH. In order to make a change you must request the full set of email templates using the GET route and then change and PUT that.

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
puthttps://api.raisely.com/v3/campaigns/campaignUuid/emails
curl --request PUT \
  --url https://api.raisely.com/v3/campaigns/campaignUuid/emails
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.raisely.com/v3/campaigns/campaignUuid/emails' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/campaigns/campaignUuid/emails")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.raisely.com/v3/campaigns/campaignUuid/emails");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/campaigns/campaignUuid/emails"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "html": {
      "emails": [
        {
          id: "signupNew",
          content: "...html content of the email template..."
        },
        {
          id: "signupExisting",
          ...
        }
      ]
    },
    "vars": {
      "color": "#22262e", // Background color for email header
      "logo": "https://url.com/logo.png", // URL of the logo used for email headers
    },
    "createdAt": "2016-04-01T05:55:00.091Z",
    "updatedAt": "2017-02-22T03:01:23.035Z"
  }
}

Body Params

data
object

The full emails object (see results for information on format)

 
 

See the GET route for a description of the different templates

Suggest Edits

/campaigns/:campaign/emails/repair

Repair specified email templates by resetting them to their default
ORG_ADMINs permission is required

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
posthttps://api.raisely.com/v3/campaigns/campaignUuid/emails/repair
curl --request POST \
  --url https://api.raisely.com/v3/campaigns/campaignUuid/emails/repair
var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.raisely.com/v3/campaigns/campaignUuid/emails/repair' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/campaigns/campaignUuid/emails/repair")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.raisely.com/v3/campaigns/campaignUuid/emails/repair");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/campaigns/campaignUuid/emails/repair"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "html": {
      "emails": [
        {
          id: "signupNew",
          content: "...html content of the email template..."
        },
        {
          id: "signupExisting",
          ...
        }
      ]
    },
    "vars": {
      "color": "#22262e", // Background color for email header
      "logo": "https://url.com/logo.png", // URL of the logo used for email headers
    },
    "createdAt": "2016-04-01T05:55:00.091Z",
    "updatedAt": "2017-02-22T03:01:23.035Z"
  }
}

Body Params

emails
array of strings

List of email template ids. The specified templates will be reset. See the GET route for a description of the different template ids

 
Suggest Edits

/campaigns/:campaign/emails/reset

Resets all email templates to their default settings - including logo and background color
ORG_ADMINs permission is required

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
posthttps://api.raisely.com/v3/campaigns/campaignUuid/emails/reset
curl --request POST \
  --url https://api.raisely.com/v3/campaigns/campaignUuid/emails/reset
var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.raisely.com/v3/campaigns/campaignUuid/emails/reset' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/campaigns/campaignUuid/emails/reset")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.raisely.com/v3/campaigns/campaignUuid/emails/reset");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/campaigns/campaignUuid/emails/reset"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "html": {
      "emails": [
        {
          id: "signupNew",
          content: "...html content of the email template..."
        },
        {
          id: "signupExisting",
          ...
        }
      ]
    },
    "vars": {
      "color": "#22262e", // Background color for email header
      "logo": "https://url.com/logo.png", // URL of the logo used for email headers
    },
    "createdAt": "2016-04-01T05:55:00.091Z",
    "updatedAt": "2017-02-22T03:01:23.035Z"
  }
}
 
Suggest Edits

/campaigns/:campaign/emails/upgrade

Inserts any missing templates
ORG_ADMINs permission is required

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
posthttps://api.raisely.com/v3/campaigns/campaignUuid/emails/upgrade
curl --request POST \
  --url https://api.raisely.com/v3/campaigns/campaignUuid/emails/upgrade
var request = require("request");

var options = { method: 'POST',
  url:
   'https://api.raisely.com/v3/campaigns/campaignUuid/emails/upgrade' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/campaigns/campaignUuid/emails/upgrade")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.raisely.com/v3/campaigns/campaignUuid/emails/upgrade");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/campaigns/campaignUuid/emails/upgrade"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "html": {
      "emails": [
        {
          id: "signupNew",
          content: "...html content of the email template..."
        },
        {
          id: "signupExisting",
          ...
        }
      ]
    },
    "vars": {
      "color": "#22262e", // Background color for email header
      "logo": "https://url.com/logo.png", // URL of the logo used for email headers
    },
    "createdAt": "2016-04-01T05:55:00.091Z",
    "updatedAt": "2017-02-22T03:01:23.035Z"
  }
}
 
Suggest Edits

/profiles

Find all profiles belonging to the organisation.
The search can be refined by campaign or user parameters.
Only ORG_ADMINs may access this without refining the search.
PARTICIPANTSs may access this endpoint refined by user
ANYONE may access the endpoint refined by campaign

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/profiles
curl --request GET \
  --url https://api.raisely.com/v3/profiles
var request = require("request");

var options = { method: 'GET', url: 'https://api.raisely.com/v3/profiles' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/profiles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/profiles");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/profiles"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

campaign
string

The uuid of the campaign to refine the search by. This is the same as calling /campaigns/:campaignUuid/profiles

currency
string

A valid 3 letter currency code. If present will only show profiles with the given currency as their default currency.

path
string

If present, will search for a profile with the exact path

private
boolean

Returned profile will include the userUuid of the profile owner. Only available to ORG_ADMIN and the owner of the profile.

user
string

The uuid of the campaign to refine the search by. This is the same as calling /users/:userUuid/profiles

type
string

Must be either INDIVIDUAL or GROUP. If present, shows only profiles of the given type

q
string

Search for profiles with a name containing the specified string

rank
boolean

Include a rank field for each profile. The rank is assigned by the total for each profile. If other parameters such as type or public.??? are used, the ranking is within all profiles matching those parameters

 
Suggest Edits

/profiles/:profile

Return the specified profile.

ANYONE may access this endpoint

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/profiles/profileUuid
curl --request GET \
  --url https://api.raisely.com/v3/profiles/profileUuid
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.raisely.com/v3/profiles/profileUuid' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/profiles/profileUuid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/profiles/profileUuid");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/profiles/profileUuid"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

private
boolean

Returned profile will include the userUuid of the profile owner. Only available to ORG_ADMIN and the owner of the profile.

rank
boolean

Include the rank of the profile among all profiles of the same type (ie GROUP or INDIVIDUAL)

rankWith
string

Rank among all profiles matching the specified public fields, eg ?rankWith=public.challenge,public.ageGroup would rank the profile within all profiles doing the same challenge and in the same age group as the selected profile

 
Suggest Edits

/profiles/:profile/members

Create a new profile that is a child of the specified profile.
(Use the uuid of the campaign profile if you do not wish the profile to be a child of any profile)

(Previous url /profiles/:profile/profiles continues to work but is deprecated)

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
posthttps://api.raisely.com/v3/profiles/profileUuid/profiles
curl --request POST \
  --url https://api.raisely.com/v3/profiles/profileUuid/profiles
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.raisely.com/v3/profiles/profileUuid/profiles' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/profiles/profileUuid/profiles")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.raisely.com/v3/profiles/profileUuid/profiles");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/profiles/profileUuid/profiles"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": { ... created profile ...},
  "message": "Group profile was created, but the user has no profile so could not join the group profile"
}

Body Params

data
object

data.description

 
data.name
string
required
data.path
string
required
data.goal
int32
required
data.description
string
data.type
string
required

Must be either GROUP or INDIVIDUAL

data.currency
string
required

A 3 letter currency code, eg AUD, USD, JPY, etc

data.status
string

ACTIVE or DELETED

join
float

If true, the current users profile will join this profile (this flag is only honoured if data.type is GROUP)

 
Suggest Edits

/profiles/:profile

Update the specified profile.
Only available to ORG_ADMIN and the profile owner.

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
patchhttps://api.raisely.com/v3/profiles/profileUuid
curl --request PATCH \
  --url https://api.raisely.com/v3/profiles/profileUuid
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.raisely.com/v3/profiles/profileUuid' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/profiles/profileUuid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.raisely.com/v3/profiles/profileUuid");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/profiles/profileUuid"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

/profiles/:profile/members

List the member profiles of this profile (if any)

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/profiles/profileUuid/members
curl --request GET \
  --url https://api.raisely.com/v3/profiles/profileUuid/members
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.raisely.com/v3/profiles/profileUuid/members' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/profiles/profileUuid/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/profiles/profileUuid/members");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/profiles/profileUuid/members"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

/profiles/:profile/join

Causes the profile specified by profileUuid to join the parent profile specified in the body of the request.

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
puthttps://api.raisely.com/v3/profiles/:profileUuid/join
curl --request PUT \
  --url https://api.raisely.com/v3/profiles/:profileUuid/join
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.raisely.com/v3/profiles/:profileUuid/join' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/profiles/:profileUuid/join")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.raisely.com/v3/profiles/:profileUuid/join");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/profiles/:profileUuid/join"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

parentUuid
string

The uuid of the parent profile that this profile should join

 
Suggest Edits

/profiles/:profile/leave

Causes the profile to leave any parent profile it is a part of (it's parent will now be the campaign profile)

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
puthttps://api.raisely.com/v3/profiles/profileUuid/leave
curl --request PUT \
  --url https://api.raisely.com/v3/profiles/profileUuid/leave
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.raisely.com/v3/profiles/profileUuid/leave' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/profiles/profileUuid/leave")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.raisely.com/v3/profiles/profileUuid/leave");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/profiles/profileUuid/leave"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results
 
Suggest Edits

/profiles/:profile/donations

Donate to the given profile.
To donate to the campaign and not a specific profile, donate to the campaign profile

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
posthttps://api.raisely.com/v3/profiles/:profileUuid/donations
curl --request POST \
  --url https://api.raisely.com/v3/profiles/:profileUuid/donations
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.raisely.com/v3/profiles/:profileUuid/donations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/profiles/:profileUuid/donations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.raisely.com/v3/profiles/:profileUuid/donations");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/profiles/:profileUuid/donations"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

data
object
 
data.type
string
required

Must be one of ONLINE or OFFLINE. If it is ONLINE then the donation will be processed through the campaign's payment gateway.

data.amount
mixed type
required
data.currency
string
required

A valid 3 letter currency code (eg AUD, USD, etc)

data.firstName
string

Required for OFFLINE payments, or ONLINE payments when there is no user logged in. If not specified for an ONLINE payment, the logged in user's details will be used.

data.lastName
string

Processed in the same way as firstName

data.email
string

Processed in the same way as firstName

data.message
string

An optional message to attach to the donation

data.feeOptIn
boolean

For ONLINE payments only. If true, then the user has opted into the raisely fee which will be added to their donation

data.method
string

Required for ONLINE payments. Currently only CREDIT_CARD is accepted

 
Suggest Edits

/profiles/:profile/donations

 
Suggest Edits

/donations

List donations within an organisation.
This request is scoped based on the route it's nested in (eg /users/:user/donations) or the query parameters (eg /donations?user=:user)
Only an ORG_ADMIN may request all donations in an organisation, or for a particular user.
Anyone may request to list the donations for a campaign or a profile.
A user may request to list their own donations.

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/donations
curl --request GET \
  --url https://api.raisely.com/v3/donations
var request = require("request");

var options = { method: 'GET', url: 'https://api.raisely.com/v3/donations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/donations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/donations");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/donations"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

campaign
string

UUID of the campaign to filter donations by

currency
string

3 letter currency code. If present, only show donations in that currency

mode
string

If a campaign is specified, this defaults to the mode of that campaign, otherwise it defaults to LIVE.

organisation
string
private
boolean

Show private attributes of the donation

profile
string

UUID of the profile to filter donations by

status
string

Search for donations with a particular status

type
string

OFFLINE or ONLINE to show only one

user
string

UUID of the user to filter donations by

 
Suggest Edits

/donations/:donation/move

Move a donation to another profile

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/donations/:donation/move
curl --request GET \
  --url https://api.raisely.com/v3/donations/:donation/move
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.raisely.com/v3/donations/:donation/move' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/donations/:donation/move")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/donations/:donation/move");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/donations/:donation/move"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "uuid": "donation uuid",
    ...
  }
}

Body Params

toProfile
string

The UUID of the profile to move the donation to

 
Suggest Edits

/donations/:donation

Return the specified donation.

ANYONE may access this endpoint

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/donations/donationUuid
curl --request GET \
  --url https://api.raisely.com/v3/donations/donationUuid
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.raisely.com/v3/donations/donationUuid' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/donations/donationUuid")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/donations/donationUuid");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/donations/donationUuid"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

private
boolean

Returned profile will include the userUuid of the profile owner. Only available to ORG_ADMIN and the owner of the profile.

 
Suggest Edits

/donations

Donate to the given profile.
To donate to the campaign and not a specific profile, donate to the campaign profile

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
posthttps://api.raisely.com/v3/donations
curl --request POST \
  --url https://api.raisely.com/v3/donations
var request = require("request");

var options = { method: 'POST', url: 'https://api.raisely.com/v3/donations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/donations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.raisely.com/v3/donations");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/donations"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

data
object
 
data.type
string
required

Must be one of ONLINE or OFFLINE. If it is ONLINE then the donation will be processed through the campaign's payment gateway.

data.amount
mixed type
required
data.currency
string
required

A valid 3 letter currency code (eg AUD, USD, etc)

data.firstName
string

Required for OFFLINE payments, or ONLINE payments when there is no user logged in. If not specified for an ONLINE payment, the logged in user's details will be used.

data.lastName
string

Processed in the same way as firstName

data.email
string

Processed in the same way as firstName

data.message
string

An optional message to attach to the donation

data.feeOptIn
boolean

For ONLINE payments only. If true, then the user has opted into the raisely fee which will be added to their donation

data.method
string

Required for ONLINE payments. Currently only CREDIT_CARD is accepted

data.profileUuid
string
required

Uuid of the profile to connect the donation to

data.perkUuid
string

Uuid of perk to include with donation

 

If there is a problem with the perk requested for the donation, the donation will fail with a 400 or 409 status, and the error code in the body will start with "perk ..."

Suggest Edits

/signup

Sign new users up to your campaign.

 
posthttps://api.raisely.com/v3/signup
curl --request POST \
  --url https://api.raisely.com/v3/signup
var request = require("request");

var options = { method: 'POST', url: 'https://api.raisely.com/v3/signup' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/signup")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.raisely.com/v3/signup");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/signup"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

campaignUuid
string

The uuid of the campaign the user is being created on

data
object
 
data.firstName
string

User's first name

data.lastName
string

User's last name

data.email
string
data.password
string
 
Suggest Edits

/login

Log in users with their username and password to authenticate future requests with their account.

 
posthttps://api.raisely.com/v3/login
{
  "username": "[email protected]",
  "password": "myverysecretpassword",
  "organisationUuid": "8238df6a-404f-11e7-b631-06facaa3db7b"
}
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "uuid": "81f3d44c-404f-11e7-9cbe-06facaa3db7b",
    "createdAt": "2017-01-12T00:12:04.090Z",
    "updatedAt": "2017-09-28T08:31:11.644Z",
    "facebookId": null,
    "email": "[email protected]",
    "username": "[email protected]",
    "permission": "ORG_ADMIN",
    "address1": null,
    "address2": null,
    "postcode": null,
    "state": null,
    "suburb": null,
    "country": null,
    "internal": {},
    "public": null,
    "private": null,
    "firstName": "Raisely",
    "lastName": "Support",
    "photoUrl": null,
    "phoneNumber": null,
    "ipNumber": null,
    "ipLatitude": null,
    "ipLongitude": null,
    "ipCity": null,
    "ipCountry": null,
    "organisation": {
       "uuid": "7eaf8d12-404f-11e7-bc32-06facaa3db7b",
       "name": "Global Cause",
       "public": null,
       "createdAt": "2016-01-25T04:12:14.213Z",
       "updatedAt": "2016-01-25T04:12:14.213Z",
       "private": null,
       "internal": null
     },
  },
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiYWRtaW4iOnRydWV9.TJVA95OrM7E2cBab30RMHrHDcEfxjoYZgeFONFh7HgQ"
}

Body Params

username
string

The email address of the user to log in

password
string

The user's password

organisationUuid
string

The organisation UUID, required for participant logins.

 
Suggest Edits

/facebook

Signup or login a user with a Facebook access token.

 
posthttps://api.raisely.com/v3/facebook
curl --request POST \
  --url https://api.raisely.com/v3/facebook
var request = require("request");

var options = { method: 'POST', url: 'https://api.raisely.com/v3/facebook' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/facebook")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.raisely.com/v3/facebook");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/facebook"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
    "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhY2Nlc3NfdG9rZW4iOiIxYTEzYzQzMWRmNDVjNDc4ZDBhYmZlODg5ZTJmMWY1MSIsInVzZXJVdWlkIjoiZTliM2JhOTAtMWE4Ni0xMWU4LTg1YzMtYjNhNzFlNzZjMzFlIiwib3JnYW5pc2F0aW9uSWQiOjEsImlhdCI6MTUxOTYwMjg1N30.ur6x9IUJKUmtetXL97OTRMoTIQN_1nrMaf2jtXvLqus",
    "data": {
        "uuid": "e9b3ba90-1a86-11e8-85c3-b3a71e76c31e",
        "createdAt": "2018-02-25T23:52:18.363Z",
        "updatedAt": "2018-02-25T23:54:16.959Z",
        "facebookId": "10206258955847550",
        "email": "[email protected]",
        "username": "[email protected]",
        "permission": "PARTICIPANT",
        "address1": "Some Street",
        "address2": null,
        "postcode": null,
        "state": null,
        "suburb": null,
        "country": null,
        "internal": {},
        "public": {
            "rego_type": "test value",
        },
        "private": {
            "shh": "secret"
        },
        "firstName": "Joe",
        "lastName": "James",
        "photoUrl": "",
        "phoneNumber": "0400000000",
        "ipNumber": null,
        "ipLatitude": null,
        "ipLongitude": null,
        "ipCity": null,
        "ipCountry": null,
        "accessToken": "xxxxxxxxxxxxx"
    }
}

Body Params

campaignUuid
string
required

The campaign UUID the user is signing up to

data
object
 
data.facebookAccessToken
string
required

The access token given to you by the Facebook SDK

data.firstName
string
data.lastName
string
data.email
string
data.phoneNumber
string
data.address1
string
data.address2
string
data.suburb
string
data.state
string
data.country
string
data.postcode
string
data.public
object
 
data.private
object
 
 

This method allows your to log in or sign up a user via a Facebook access token. If you don't supply a name or email address in the body, we'll retrieve these from Facebook.

If the user account exists (either by their Facebook ID or email address) we'll update the user with the information you supplied and log them in, otherwise we'll create a new user.

The response will include a token that you can use to authenticate future requests.

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/users
curl --request GET \
  --url https://api.raisely.com/v3/users
var request = require("request");

var options = { method: 'GET', url: 'https://api.raisely.com/v3/users' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/users");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/users"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

country
string

Show only users from the specified country.

permission
string

Either ORG_ADMIN or PARTICIPANT. Restrict search to users with the specified permission.

postcode
string

Show only users with the postcode given

private
boolean

If true, then private information about the users will be included. This is only available to ORG_ADMINs.

q
string

Search for users who contain the specified query in firstName, lastName or email

 
Suggest Edits

/users/:user

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/users/user
curl --request GET \
  --url https://api.raisely.com/v3/users/user
var request = require("request");

var options = { method: 'GET', url: 'https://api.raisely.com/v3/users/user' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/users/user")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/users/user");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/users/user"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

private
boolean

If true, then private information about the users will be included. This is only available to ORG_ADMINs.

 
Suggest Edits

/users

Create a new user

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
posthttps://api.raisely.com/v3/users
curl --request POST \
  --url https://api.raisely.com/v3/users
var request = require("request");

var options = { method: 'POST', url: 'https://api.raisely.com/v3/users' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.raisely.com/v3/users");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/users"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

data
object
 
data.email
string
required
data.firstName
string
data.lastName
string
data.username
string
data.phoneNumber
string
data.address1
string
data.address2
string
data.postcode
string
data.country
string
data.state
string
data.suburb
string
merge
boolean

If true, performs an upsert - existing users will have their values changes, new users will be created. Users are matched by their email address.

 
Suggest Edits

/users/:user

Update the specified user

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
patchhttps://api.raisely.com/v3/users/user
curl --request PATCH \
  --url https://api.raisely.com/v3/users/user
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.raisely.com/v3/users/user' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/users/user")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.raisely.com/v3/users/user");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/users/user"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Body Params

data
object
 
data.email
string
data.firstName
string
data.lastName
string
data.username
string
data.phoneNumber
string
data.address1
string
data.address2
string
data.postcode
string
data.country
string
data.state
string
data.suburb
string
partial
boolean

Optional flag. When you set this to true, we will merge in the public and private fields you supply instead of overwriting the entire object.

 
Suggest Edits

/users/:user/reset_token

Reset the users access token

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
posthttps://api.raisely.com/v3/users/user/reset_token
curl --request POST \
  --url https://api.raisely.com/v3/users/user/reset_token
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.raisely.com/v3/users/user/reset_token' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/users/user/reset_token")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.raisely.com/v3/users/user/reset_token");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/users/user/reset_token"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "access_token": "<NEW ACCESS TOKEN>",
  }
}
 
Suggest Edits

/users/:user/password

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
puthttps://api.raisely.com/v3/user/user/password
curl --request PUT \
  --url https://api.raisely.com/v3/user/user/password
var request = require("request");

var options = { method: 'PUT',
  url: 'https://api.raisely.com/v3/user/user/password' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/user/user/password")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PUT", "https://api.raisely.com/v3/user/user/password");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/user/user/password"

response = requests.request("PUT", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "userUuid": "...",
    ...
  }
}

Body Params

current
string
required

The user's current password

updated
string

The new password for the user

 
Suggest Edits

/users/:user/stats

Returns how much the user has donated and raised.
Only available to ORG_ADMIN and the user themself.

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/user/user/stats
curl --request GET \
  --url https://api.raisely.com/v3/user/user/stats
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.raisely.com/v3/user/user/stats' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/user/user/stats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/user/user/stats");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/user/user/stats"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "currency": "AUD", // The currency that the totals are in
    "profilesInCents": 2500, // Total that the users profiles have raised in cents
    "profiles": 25.00, // Total that the user has raised in dollars
    "donationsInCents": 3600, // Total donated by the user in cents
    "donationsInCents": 36.00, // Total donated by the user in dollars
  }
}

Query Params

currency
string

Currency to convert totals to.

 
Suggest Edits

/user/:user/profiles

 
Suggest Edits

/users/:user/cards

Returns the cards held by the user
Only permitted by the user themself

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/users/user/cards
curl --request GET \
  --url 'https://api.raisely.com/v3/users/user/cards?campaign=campaign'
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.raisely.com/v3/users/user/cards',
  qs: { campaign: 'campaign' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/users/user/cards?campaign=campaign")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/users/user/cards?campaign=campaign");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/users/user/cards"

querystring = {"campaign":"campaign"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "id": "card_XXXXXXXXXX",
      "object": "card",
      "addressCity": null,
      "addressCountry": null,
      "addressLine1": null,
      "addressLine1_check": null,
      "addressLine2": null,
      "addressState": null,
      "addressZip": null,
      "addressZipCheck": null,
      "brand": "Visa",
      "country": "US",
      "customer": "cus_XXXXXXXXXX",
      "cvc_check": "pass",
      "dynamicLast4": null,
      "expMonth": 11,
      "expYear": 2018,
      "fingerprint": "XXXXXXXXXXXX",
      "funding": "credit",
      "last4": "4242",
      "metadata": {},
      "name": null,
      "tokenizationMethod": null
    }
  ]
}

Query Params

campaign
string
required

The UUID of the campaign to find the cards. Cards are associated with a particular provider, so you may get a different list for the user depending on the campaign specified if you have used different providers for different campaigns.

 
Suggest Edits

/users/:user/cards

Create a new card for the specified user.
This will set the new card as the default card.
Only available to the user themself.

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
posthttps://api.raisely.com/v3/users/:user/cards
curl --request POST \
  --url https://api.raisely.com/v3/users/:user/cards
var request = require("request");

var options = { method: 'POST',
  url: 'https://api.raisely.com/v3/users/:user/cards' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/users/:user/cards")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.raisely.com/v3/users/:user/cards");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/users/:user/cards"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": {
      "id": "card_XXXXXXXXXX",
      "object": "card",
      "addressCity": null,
      "addressCountry": null,
      "addressLine1": null,
      "addressLine1_check": null,
      "addressLine2": null,
      "addressState": null,
      "addressZip": null,
      "addressZipCheck": null,
      "brand": "Visa",
      "country": "US",
      "customer": "cus_XXXXXXXXXX",
      "cvc_check": "pass",
      "dynamicLast4": null,
      "expMonth": 11,
      "expYear": 2018,
      "fingerprint": "XXXXXXXXXXXX",
      "funding": "credit",
      "last4": "4242",
      "metadata": {},
      "name": null,
      "tokenizationMethod": null
  }
}

Body Params

campaignUuid
string
required

The UUID of the campaign to associated this card with. This will associate the card with the provider for that campaign.

token
string

The token for the card by the provider. This is exchanged with the provider for information about the card.

 
Suggest Edits

/users/:user/cards/:card

Set the default card for the user

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
patchhttps://api.raisely.com/v3/users/user/cards/card
curl --request PATCH \
  --url https://api.raisely.com/v3/users/user/cards/card
var request = require("request");

var options = { method: 'PATCH',
  url:
   'https://api.raisely.com/v3/users/user/cards/card' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/users/user/cards/card")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.raisely.com/v3/users/user/cards/card");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/users/user/cards/card"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": {
      "id": "card_XXXXXXXXXX",
      "object": "card",
      "addressCity": null,
      "addressCountry": null,
      "addressLine1": null,
      "addressLine1_check": null,
      "addressLine2": null,
      "addressState": null,
      "addressZip": null,
      "addressZipCheck": null,
      "brand": "Visa",
      "country": "US",
      "customer": "cus_XXXXXXXXXX",
      "cvc_check": "pass",
      "dynamicLast4": null,
      "expMonth": 11,
      "expYear": 2018,
      "fingerprint": "XXXXXXXXXXXX",
      "funding": "credit",
      "last4": "4242",
      "metadata": {},
      "name": null,
      "tokenizationMethod": null
  }
}

Path Params

user
string
required

The UUID of the user to update the cards on

card
string
required

The ID of the card to set as the default

 
Suggest Edits

/stats/overview/:kind

Get an overview of all the campaigns or donations in your organisation, looking at how many active there have been in ever and in the last few days.
Restricted to ORG_ADMINs

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/stats/overview/kind
curl --request GET \
  --url https://api.raisely.com/v3/stats/overview/kind
var request = require("request");

var options = { method: 'GET',
  url:
   'https://api.raisely.com/v3/stats/overview/kind' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/stats/overview/kind")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/stats/overview/kind");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/stats/overview/kind"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
	  "days": 7,
	  "mode": "LIVE",
	  "status": "OK", // Only shown for donations
	  "kind": "donations",
	  "data": {
		  "allTime": {
        "count": 3,
        
        // Additional for donations
			  "total": 1200, // Value of all donations ever (OFFLINE & ONLINE)
        "onlineTotal": 800,
        "offlineTotal": 400,
        "onlineCount": 2,
        "offlineCount": 1,
		  },
		  "inPeriod": {
			  "count": 2, // Number of donations in the last 7 days

        // Additional for donations
        "total": 1000, // Value of all donations in last 7 days
        "onlineTotal": 600,
        "offlineTotal": 400,
        "onlineCount": 1,
        "offlineCount": 1,
		  },
	  },
  }

Path Params

kind
string
required

Either campaign or donations. Specifies the kind of stats to retrieve.

Query Params

days
int32
mode
string

The campaigns/donations to summarise. LIVE or TEST

status
string

The status of donations to summarise

type
string

The type of donations to summarise, ONLINE or OFFLINE

 
Suggest Edits

/stats/active/campaigns

Get an overview of all the campaigns or donations in your organisation, looking at how many active there have been in ever and in the last few days.
Restricted to ORG_ADMINs

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/stats/active/campaigns
curl --request GET \
  --url https://api.raisely.com/v3/stats/active/campaigns
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.raisely.com/v3/stats/active/campaigns' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/stats/active/campaigns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/stats/active/campaigns");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/stats/active/campaigns"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": [
    {
      "uuid": "4b418260-4da0-11e7-b1dc-5f91a6cac21d",
	    "name": "Jump for Hope",
	    "currency": "AUD",
	    "total": 20, // Amount in dollars
    }   
  ]
}

Query Params

days
int32

The number of days to summarise, can be up to 365.

mode
string

The campaigns to summarise. LIVE or TEST

status
string

The status of donations to summarise

type
string

The type of donations to summarise, ONLINE or OFFLINE

 
Suggest Edits

/stats/hourly/:kind

Get the hourly totals for donations or subscriptions
Restricted to ORG_ADMINs

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/stats/hourly/kind
curl --request GET \
  --url https://api.raisely.com/v3/stats/hourly/kind
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.raisely.com/v3/stats/hourly/kind' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/stats/hourly/kind")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/stats/hourly/kind");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/stats/hourly/kind"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": {
	  "dates": ["2017-06-08T04:51:19+08:00", ...],
	  "online": [2000, ...], // Amount of donations in cents corresponding to the time
	  "offline": [1000, ...], // Not available on subscriptions
  }
}

Query Params

days
int32

The number of days to look back (max: 31)

mode
string

The campaigns to summarise. LIVE or TEST

status
string

The status of donations to summarise

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/posts
curl --request GET \
  --url https://api.raisely.com/v3/posts
var request = require("request");

var options = { method: 'GET', url: 'https://api.raisely.com/v3/posts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/posts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/posts");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/posts"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{"data":[{"uuid":"471cb440-f1a9-11e7-9454-3fb62090fdec","title":"Test Post","body":"<p>Test body<br></p>","path":"test-post","createdAt":"2018-01-04T23:45:00.293Z","updatedAt":"2018-01-04T23:45:00.293Z","userUuid":"80232730-404f-11e7-b2ea-06facaa3db7b","user":{"uuid":"80232730-404f-11e7-b2ea-06facaa3db7b","createdAt":"2016-05-25T03:26:45.637Z","updatedAt":"2017-05-31T03:53:25.151Z","firstName":"Paul","lastName":"Brown","photoUrl":null},"photoUrl":""}],"pagination":{"total":1,"pages":1,"prevUrl":false,"nextUrl":false,"offset":0,"limit":100}}

Query Params

campaign
string

Campaign UUID

profile
string

Profile UUID

limit
int32

How many records per page

offset
int32

Starting point within the feed of records

 
Suggest Edits

/posts/:post

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/posts/:post
curl --request GET \
  --url https://api.raisely.com/v3/posts/:post
var request = require("request");

var options = { method: 'GET', url: 'https://api.raisely.com/v3/posts/:post' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/posts/:post")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/posts/:post");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/posts/:post"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{"data":{"uuid":"471cb440-f1a9-11e7-9454-3fb62090fdec","title":"Test Post","body":"<p>Test body<br></p>","path":"test-post","createdAt":"2018-01-04T23:45:00.293Z","updatedAt":"2018-01-04T23:45:00.293Z","userUuid":"80232730-404f-11e7-b2ea-06facaa3db7b","user":{"uuid":"80232730-404f-11e7-b2ea-06facaa3db7b","createdAt":"2016-05-25T03:26:45.637Z","updatedAt":"2017-05-31T03:53:25.151Z","firstName":"Paul","lastName":"Brown","photoUrl":null},"photoUrl":""}}
 

Header Auth

Query Auth

 Authentication is required for this endpoint.
posthttps://api.raisely.com/v3/posts
curl --request POST \
  --url https://api.raisely.com/v3/posts
var request = require("request");

var options = { method: 'POST', url: 'https://api.raisely.com/v3/posts' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/posts")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.raisely.com/v3/posts");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/posts"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{"data":{"uuid":"7d4dcc20-f1b3-11e7-9454-3fb62090fdec","title":"testing","body":"<p>testing</p><p><br></p><p><br></p>","path":"testing","createdAt":"2018-01-05T00:58:06.179Z","updatedAt":"2018-01-05T00:58:06.179Z","photoUrl":""}}

Body Params

data
object
 
data.body
string

HTML string of body content

data.title
string

Title of post

data.photoUrl
string

URL of the post's photo

data.profileUuid
string

Profile UUID that the post is associated with

data.path
string

Path of post to appear in post's URL

 
Suggest Edits

/posts/:post

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
patchhttps://api.raisely.com/v3/posts/:post
curl --request PATCH \
  --url https://api.raisely.com/v3/posts/:post
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.raisely.com/v3/posts/:post' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/posts/:post")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.raisely.com/v3/posts/:post");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/posts/:post"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{"data":{"uuid":"471cb440-f1a9-11e7-9454-3fb62090fdec","title":"Test Post2","body":"<p>Test body<br></p>","path":"test-post-2","createdAt":"2018-01-04T23:45:00.293Z","updatedAt":"2018-01-05T00:56:55.302Z","userUuid":"80232730-404f-11e7-b2ea-06facaa3db7b","user":{"uuid":"80232730-404f-11e7-b2ea-06facaa3db7b","createdAt":"2016-05-25T03:26:45.637Z","updatedAt":"2017-05-31T03:53:25.151Z","firstName":"Paul","lastName":"Brown","photoUrl":null},"photoUrl":""}}

Body Params

data
object
 
data.body
string

HTML string of body content

data.title
string

Title of post

data.photoUrl
string

URL of the post's photo

data.path
string

Path of post to appear in post's URL

 
Suggest Edits

/posts/:post

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
deletehttps://api.raisely.com/v3/posts/:post
curl --request DELETE \
  --url https://api.raisely.com/v3/posts/:post
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.raisely.com/v3/posts/:post' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/posts/:post")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.raisely.com/v3/posts/:post");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/posts/:post"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{"data":{"uuid":"471cb440-f1a9-11e7-9454-3fb62090fdec","title":"Test Post2","body":"<p>Test body<br></p>","path":"test-post-2","createdAt":"2018-01-04T23:45:00.293Z","updatedAt":"2018-01-05T00:56:55.302Z","userUuid":"80232730-404f-11e7-b2ea-06facaa3db7b","user":{"uuid":"80232730-404f-11e7-b2ea-06facaa3db7b","createdAt":"2016-05-25T03:26:45.637Z","updatedAt":"2017-05-31T03:53:25.151Z","firstName":"Paul","lastName":"Brown","photoUrl":null},"photoUrl":""}}
 
Suggest Edits

/posts/:post/comments

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/posts/:post/comments
curl --request GET \
  --url https://api.raisely.com/v3/posts/:post/comments
var request = require("request");

var options = { method: 'GET',
  url: 'https://api.raisely.com/v3/posts/:post/comments' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/posts/:post/comments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/posts/:post/comments");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/posts/:post/comments"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{"data":[{"uuid":"5c1fa130-f1b9-11e7-9454-3fb62090fdec","body":"asdasdassd","createdAt":"2018-01-05T01:40:07.492Z","updatedAt":"2018-01-05T01:40:07.492Z","userUuid":"55c50af0-f1b9-11e7-9454-3fb62090fdec","postUuid":"471cb440-f1a9-11e7-9454-3fb62090fdec","post":{"uuid":"471cb440-f1a9-11e7-9454-3fb62090fdec","title":"Test Post2","body":"<p>Test body<br></p>","path":"test-post-2","createdAt":"2018-01-04T23:45:00.293Z","updatedAt":"2018-01-05T00:56:55.302Z","photoUrl":""},"user":{"uuid":"55c50af0-f1b9-11e7-9454-3fb62090fdec","createdAt":"2018-01-05T01:39:56.832Z","updatedAt":"2018-01-05T01:39:56.832Z","firstName":"tets","lastName":"test","photoUrl":null}}],"pagination":{"total":1,"pages":1,"prevUrl":false,"nextUrl":false,"offset":0,"limit":100}}
 
Suggest Edits

/comments

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/comments
curl --request GET \
  --url https://api.raisely.com/v3/comments
var request = require("request");

var options = { method: 'GET', url: 'https://api.raisely.com/v3/comments' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/comments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/comments");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/comments"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{"data":[{"uuid":"5c1fa130-f1b9-11e7-9454-3fb62090fdec","body":"asdasdassd","createdAt":"2018-01-05T01:40:07.492Z","updatedAt":"2018-01-05T01:40:07.492Z","userUuid":"55c50af0-f1b9-11e7-9454-3fb62090fdec","postUuid":"471cb440-f1a9-11e7-9454-3fb62090fdec","post":{"uuid":"471cb440-f1a9-11e7-9454-3fb62090fdec","title":"Test Post2","body":"<p>Test body<br></p>","path":"test-post-2","createdAt":"2018-01-04T23:45:00.293Z","updatedAt":"2018-01-05T00:56:55.302Z","photoUrl":""},"user":{"uuid":"55c50af0-f1b9-11e7-9454-3fb62090fdec","createdAt":"2018-01-05T01:39:56.832Z","updatedAt":"2018-01-05T01:39:56.832Z","firstName":"tets","lastName":"test","photoUrl":null}}],"pagination":{"total":1,"pages":1,"prevUrl":false,"nextUrl":false,"offset":0,"limit":100}}

Query Params

post
string

Post UUID

limit
int32

Limit of how many comments shown in feed

offset
int32

Offset of comments feed

 
Suggest Edits

/comments

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
posthttps://api.raisely.com/v3/comments
curl --request POST \
  --url https://api.raisely.com/v3/comments
var request = require("request");

var options = { method: 'POST', url: 'https://api.raisely.com/v3/comments' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/comments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.raisely.com/v3/comments");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/comments"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
	"data": {
		"uuid": "7181a670-f1bb-11e7-9454-3fb62090fdec",
		"body": "Test Comment",
		"createdAt": "2018-01-05T01:55:02.360Z",
		"updatedAt": "2018-01-05T01:55:02.360Z"
	}
}

Body Params

data
object
 
data.userUuid
string

User UUID of the user who the comment belongs to

data.postUuid
string

UUID of post the comment belongs to

data.body
string

Text body of the comment

 
Suggest Edits

/comments/:comment

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
patchhttps://api.raisely.com/v3/comments/:comment
curl --request PATCH \
  --url https://api.raisely.com/v3/comments/:comment
var request = require("request");

var options = { method: 'PATCH',
  url: 'https://api.raisely.com/v3/comments/:comment' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/comments/:comment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.raisely.com/v3/comments/:comment");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/comments/:comment"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
	"data": {
		"uuid": "7181a670-f1bb-11e7-9454-3fb62090fdec",
		"body": "Changed body",
		"createdAt": "2018-01-05T01:55:02.360Z",
		"updatedAt": "2018-01-05T01:58:30.743Z",
		"userUuid": "80232730-404f-11e7-b2ea-06facaa3db7b",
		"user": {
			"uuid": "80232730-404f-11e7-b2ea-06facaa3db7b",
			"createdAt": "2016-05-25T03:26:45.637Z",
			"updatedAt": "2017-05-31T03:53:25.151Z",
			"firstName": "Paul",
			"lastName": "Brown",
			"photoUrl": null
		}
	}
}

Body Params

data
object
 
data.userUuid
string

User UUID of the user who the comment belongs to

data.postUuid
string

UUID of post the comment belongs to

data.body
string

Text body of the comment

 
Suggest Edits

/comments/:comment

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
deletehttps://api.raisely.com/v3/comments/:comment
curl --request DELETE \
  --url https://api.raisely.com/v3/comments/:comment
var request = require("request");

var options = { method: 'DELETE',
  url: 'https://api.raisely.com/v3/comments/:comment' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/comments/:comment")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Delete.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("DELETE", "https://api.raisely.com/v3/comments/:comment");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/comments/:comment"

response = requests.request("DELETE", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
	"data": {
		"uuid": "7181a670-f1bb-11e7-9454-3fb62090fdec",
		"body": "Changed body",
		"createdAt": "2018-01-05T01:55:02.360Z",
		"updatedAt": "2018-01-05T01:58:30.743Z",
		"userUuid": "80232730-404f-11e7-b2ea-06facaa3db7b",
		"user": {
			"uuid": "80232730-404f-11e7-b2ea-06facaa3db7b",
			"createdAt": "2016-05-25T03:26:45.637Z",
			"updatedAt": "2017-05-31T03:53:25.151Z",
			"firstName": "Paul",
			"lastName": "Brown",
			"photoUrl": null
		}
	}
}
 
Suggest Edits

/webhooks

Retrieve a list of registered webhooks for this campaign or organisation.

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
gethttps://api.raisely.com/v3/webhooks
curl --request GET \
  --url https://api.raisely.com/v3/webhooks
var request = require("request");

var options = { method: 'GET', url: 'https://api.raisely.com/v3/webhooks' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://api.raisely.com/v3/webhooks");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/webhooks"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "pagination": {
    "limit": 100,
    "cursor": null
  },
  "data": [
    {
      "url": "https://requestb.in/xxxxxx",
      "format": null,
      "secret": "",
      "uuid": "6f40afb0-0fce-11e8-abb2-71901ec14a82",
      "createdAt": "2018-02-12T08:26:33.899Z",
      "events": [],
      "app": "raisely",
      "source": "campaign:xxxx-xxxxx-xxxxx-xxxx"
    }
  ]
}

Query Params

campaign
string

Campaign UUID

 
Suggest Edits

/webhooks

Create a new webhook

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
posthttps://api.raisely.com/v3/webhooks
curl --request POST \
  --url https://api.raisely.com/v3/webhooks
var request = require("request");

var options = { method: 'POST', url: 'https://api.raisely.com/v3/webhooks' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/webhooks")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://api.raisely.com/v3/webhooks");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/webhooks"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "source": "campaign:xxxx-xxxx-xxxx-xxxx",
    "secret": "test secret",
    "url": "https://requestb.in/xxxxxx",
    "events": [],
    "app": "raisely",
    "format": null,
    "createdAt": "2018-02-12T12:01:31.477Z",
    "uuid": "76cf0f60-0fec-11e8-a140-83d7224b1b43"
  }
}

Body Params

data
object
 
data.url
string

The URL to deliver webhooks to.

data.secret
string

A secret to be send with each webhook delivery

data.events
array of strings

Events to subscribe to. IE. ['donation.created','donation.updated']

data.campaignUuid
string

The campaign UUID

 
Suggest Edits

/webhooks/:webhook

Create a new webhook

 

Header Auth

Query Auth

 Authentication is required for this endpoint.
patchhttps://api.raisely.com/v3/webhooks/webhook
curl --request PATCH \
  --url https://api.raisely.com/v3/webhooks/webhook
var request = require("request");

var options = { method: 'PATCH',
  url:
   'https://api.raisely.com/v3/webhooks/webhook' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://api.raisely.com/v3/webhooks/webhook")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("PATCH", "https://api.raisely.com/v3/webhooks/webhook");

xhr.send(data);
import requests

url = "https://api.raisely.com/v3/webhooks/webhook"

response = requests.request("PATCH", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "data": {
    "source": "campaign:xxxx-xxxx-xxxx-xxxx",
    "secret": "test secret",
    "url": "https://requestb.in/xxxxxx",
    "events": [],
    "app": "raisely",
    "format": null,
    "createdAt": "2018-02-12T12:01:31.477Z",
    "uuid": "76cf0f60-0fec-11e8-a140-83d7224b1b43"
  }
}

Path Params

webhook
string
required

The webhook UUID to update

Body Params

data
object
 
data.url
string

The URL to deliver webhooks to.

data.secret
string

A secret to be send with each webhook delivery

data.events
array of strings

Events to subscribe to. IE. ['donation.created','donation.updated']

data.campaignUuid
string

The campaign UUID