Fundraisings
API base url: https://funplace.fun/api/v1/fundraisings
Create a new Fundraise
GET create
scopes: Funplace::fundraisings
Register a new fundraiser on the platform.
Headers
Query Parameters
name
yes
String
Title (brief statement of purpose) of fundraising. ATTENTION: This is an irreversible action!
amount
yes
Double
Fundraising target amount.
curr
yes
String
Fundraising target currency.
One of the available currencies in ISO 4217 format: RUB,USD,EUR,UAH,BRL,TRY,KZT,INR,PLN,GEL,CNY,BTC,ETH,SOL,TON.
publish
no
Boolean
Would you like to post a fundraiser on raise.funplace.fun. ATTENTION: This is an irreversible action!
ending
if (publish = true)
int
UNIX Timestamp of fundraising end date. Required for posting on raise.funplace.fun. It must be at least two weeks longer than now. ATTENTION: This is an irreversible action!
Response
{
"success": "ok",
"data": {
"id": 1,
},
}{
"error": "bad request",
"error_data": "Fundraising on the crowdfinding platform raise.funplace.fun must have an expiration date. Specify the parameter 'ending'"
}{
"error": "unauthorized",
"error_data": {},
}Response body (If successful)
success
yes
string
Always have the value ok.
data
yes
array
An array with information about the change.
data[id]
yes
int
Fundraising ID.
Edit Fundraise
GET edit
scopes: Funplace::fundraisings
Edit fundraise on the platform. You can only use this endpoint with the fundraiser owner's authorization token and a user with manager level access to this fundraiser!
Headers
Query Parameters
id
yes
int
Fundraising ID.
publish
no
Boolean
Would you like to post a fundraiser on raise.funplace.fun. ATTENTION: This is an irreversible action!
ending
if (publish = true)
int
UNIX Timestamp of fundraising end date. Required for posting on raise.funplace.fun. It must be at least two weeks longer than now. ATTENTION: This is an irreversible action!
desc
no
Fundraising Description: Available only for public fundraising on the raise.funplace.fun platform.
amount
no
String
Fundraising target currency.
ATTENTION: Cannot be changed for fundraisers published on raise.funplace.fun.
One of the available currencies in ISO 4217 format: RUB,USD,EUR,UAH,BRL,TRY,KZT,INR,PLN,GEL,CNY,BTC,ETH,SOL,TON.
Response
{
"success": "ok",
"data": {
},
}{
"error": "bad request",
"error_data": "Fundraising on the crowdfinding platform raise.funplace.fun must have an expiration date. Specify the parameter 'ending'"
}{
"error": "unauthorized",
"error_data": {},
}Response body (If successful)
success
yes
string
Always have the value ok.
data
yes
array
An array with information about the change.
Add user
GET users/add
scopes: Funplace::fundraisings
Add another managing user to the fundraiser. You can only use this endpoint with the fundraiser owner's authorization token to this fundraiser!
Headers
Query Parameters
id
yes
int
Fundraising ID.
You must specify exactly one user identifier. email or uid.
String
Email of the user to whom the rights are granted. Does not work if there is no Vorg Id with this email.
uid
You must specify exactly one user identifier. email or uid.
int
Vorg ID of the user to whom the rights are granted.
role
yes
String
One of the available roles: manager, community_manager, viewer.
Response
{
"success": "ok",
"data": {
"funid": 55
},
}{
"error": "bad request",
"error_data": "Fundraising on the crowdfinding platform raise.funplace.fun must have an expiration date. Specify the parameter 'ending'"
}{
"error": "unauthorized",
"error_data": {},
}Response body (If successful)
success
yes
string
Always have the value ok.
data
yes
array
An array with information about the change.
data[funid]
yes
int
User ID inside the fundraiser.
Edit user
GET users/edit
scopes: Funplace::fundraisings
Edit managing user on the fundraiser. You can only use this endpoint with the fundraiser owner's authorization token to this fundraiser!
Headers
Query Parameters
id
yes
int
Fundraising ID.
funid
yes
int
User ID inside the fundraiser.
role
no
String
One of the available roles: manager, community_manager, viewer.
Response
{
"success": "ok",
"data": {
},
}{
"error": "bad request",
"error_data": "Fundraising on the crowdfinding platform raise.funplace.fun must have an expiration date. Specify the parameter 'ending'"
}{
"error": "unauthorized",
"error_data": {},
}Response body (If successful)
success
yes
string
Always have the value ok.
data
yes
array
An array with information about the change.
Remove user
GET users/remove
scopes: Funplace::fundraisings
Remove managing user from the fundraiser. You can only use this endpoint with the fundraiser owner's authorization token to this fundraiser!
Headers
Query Parameters
id
yes
int
Fundraising ID.
funid
yes
int
User ID inside the fundraiser.
Response
{
"success": "ok",
"data": {
},
}{
"error": "bad request",
"error_data": "Fundraising on the crowdfinding platform raise.funplace.fun must have an expiration date. Specify the parameter 'ending'"
}{
"error": "unauthorized",
"error_data": {},
}Response body (If successful)
success
yes
string
Always have the value ok.
data
yes
array
An array with information about the change.
Get users
GET users/get
scopes: Funplace::fundraisings
Get managing users from the fundraiser. You can only use this endpoint with the fundraiser owner's authorization token to this fundraiser!
Headers
Query Parameters
id
yes
int
Fundraising ID.
Response
{
1: "manager",
2: "viewer",
4: "community_manager"
}{
"error": "bad request",
"error_data": "Fundraising on the crowdfinding platform raise.funplace.fun must have an expiration date. Specify the parameter 'ending'"
}{
"error": "unauthorized",
"error_data": {},
}Response body (If successful)
<funid>
yes
string
User role with corresponding funid.
Add reward item
GET/POST + GET QUERY PARAMETERS rewards/items/add
scopes: Funplace::fundraisings
Add a new item to your fundraiser that can be given out as a reward for a donation. You can only use this endpoint with the fundraiser owner's authorization token and a user with manager level access to this fundraiser!
Headers
Query Parameters
id
yes
int
Fundraising ID.
name
yes
String
Item name.
cover
yes
URI
Link to the cover photo of the item.
ATTENTION: You can specify the cover value in the POST BODY to use other links or Data URIs. For example, send a post request to https://funplace.fun/api/v1/fundraisings/rewards/items/add?id=1&name=name and Post Body {cover: "data%3Aimage%2Fjpeg%3Bbase64..."}
Response
{
"success": "ok",
"data": {
"item_id": "sgdgsdgsgdsd",
"cover_url": "https://...",
},
}{
"error": "bad request",
"error_data": "Fundraising on the crowdfinding platform raise.funplace.fun must have an expiration date. Specify the parameter 'ending'"
}{
"error": "unauthorized",
"error_data": {},
}Response body (If successful)
success
yes
string
Always have the value ok.
data
yes
array
An array with information about the change.
data[item_id]
yes
String
Item ID.
data[cover_url]
yes
URI
Link to the item's cover uploaded to Funplace repositories.
Edit reward item
GET/POST + GET QUERY PARAMETERS rewards/items/edit
scopes: Funplace::fundraisings
Edit reward item. You can only use this endpoint with the fundraiser owner's authorization token and a user with manager level access to this fundraiser!
Headers
Query Parameters
id
yes
int
Fundraising ID.
item_id
yes
String
Item ID.
name
no
String
Item name.
cover
no
URI
Link to the cover photo of the item.
ATTENTION: You can specify the cover value in the POST BODY to use other links or Data URIs. For example, send a post request to https://funplace.fun/api/v1/fundraisings/rewards/items/add?id=1&item_id=0 and Post Body {cover: "data%3Aimage%2Fjpeg%3Bbase64..."}
Response
{
"success": "ok",
"data": {
},
}{
"error": "bad request",
"error_data": "Fundraising on the crowdfinding platform raise.funplace.fun must have an expiration date. Specify the parameter 'ending'"
}{
"error": "unauthorized",
"error_data": {},
}Response body (If successful)
success
yes
string
Always have the value ok.
data
yes
array
An array with information about the change.
Remove reward item
GET rewards/items/remove
scopes: Funplace::fundraisings
Remove reward item. You can only use this endpoint with the fundraiser owner's authorization token and a user with manager level access to this fundraiser!
Headers
Query Parameters
id
yes
int
Fundraising ID.
item_id
yes
String
Item ID.
Response
{
"success": "ok",
"data": {
},
}{
"error": "bad request",
"error_data": "Fundraising on the crowdfinding platform raise.funplace.fun must have an expiration date. Specify the parameter 'ending'"
}{
"error": "unauthorized",
"error_data": {},
}Response body (If successful)
success
yes
string
Always have the value ok.
data
yes
array
An array with information about the change.
Get reward items
GET rewards/items/get
scopes: Funplace::fundraisings
Get reward items.
Headers
Query Parameters
id
yes
int
Fundraising ID.
Response
{
"deedge": {
"name": "name",
"cover": "https://...",
}
}{
"error": "bad request",
"error_data": "Fundraising on the crowdfinding platform raise.funplace.fun must have an expiration date. Specify the parameter 'ending'"
}{
"error": "unauthorized",
"error_data": {},
}Response body (If successful)
<item_id>
yes
Array
Item for corresponding item_id.
<item_id>[name]
yes
String
Item name.
<item_id>[cover]
yes
URI
Item cover url.
Add reward
GET/POST + GET QUERY PARAMETERS rewards/add
scopes: Funplace::fundraisings
Add a new reward to your fundraiser. You can only use this endpoint with the fundraiser owner's authorization token and a user with manager level access to this fundraiser!
Headers
Query Parameters
id
yes
int
Fundraising ID.
name
yes
String
Reward name.
desc
yes
String
Reward description.
itemslist
no
JSON ecncoded Array
List of items given as a reward.
itemlist[quantity]
yes
int
The number of items of this type.
itemlist[item_id]
yes
String
The item ID.
ATTENTION: You can specify the cover value in the POST BODY to use other links or Data URIs. For example, send a post request to https://funplace.fun/api/v1/fundraisings/rewards/add?id=1&name=name&desc=desc and Post Body {cover: "data%3Aimage%2Fjpeg%3Bbase64..."}
Response
{
"success": "ok",
"data": {
"reward_id": "sgdgsdgsgdsd",
"cover_url": "https://...",
},
}{
"error": "bad request",
"error_data": "Fundraising on the crowdfinding platform raise.funplace.fun must have an expiration date. Specify the parameter 'ending'"
}{
"error": "unauthorized",
"error_data": {},
}Response body (If successful)
success
yes
string
Always have the value ok.
data
yes
array
An array with information about the change.
data[reward_id]
yes
String
Reward ID.
data[cover_url]
yes
URI
Link to the item's cover uploaded to Funplace repositories.
Edit reward
GET/POST + GET QUERY PARAMETERS rewards/items/edit
scopes: Funplace::fundraisings
Edit reward. You can only use this endpoint with the fundraiser owner's authorization token and a user with manager level access to this fundraiser!
Headers
Query Parameters
id
yes
int
Fundraising ID.
reward_id
yes
String
Reward ID.
name
yes
String
Reward name.
desc
yes
String
Reward description.
itemslist
no
JSON ecncoded Array
List of items given as a reward.
itemlist[quantity]
yes
int
The number of items of this type.
itemlist[item_id]
yes
String
The item ID.
ATTENTION: You can specify the cover value in the POST BODY to use other links or Data URIs. For example, send a post request to https://funplace.fun/api/v1/fundraisings/rewards/items/add?id=1&item_id=0 and Post Body {cover: "data%3Aimage%2Fjpeg%3Bbase64..."}
Response
{
"success": "ok",
"data": {
},
}{
"error": "bad request",
"error_data": "Fundraising on the crowdfinding platform raise.funplace.fun must have an expiration date. Specify the parameter 'ending'"
}{
"error": "unauthorized",
"error_data": {},
}Response body (If successful)
success
yes
string
Always have the value ok.
data
yes
array
An array with information about the change.
Remove reward
GET rewards/remove
scopes: Funplace::fundraisings
Remove reward. You can only use this endpoint with the fundraiser owner's authorization token and a user with manager level access to this fundraiser!
Headers
Query Parameters
id
yes
int
Fundraising ID.
reward_id
yes
String
Reward ID.
Response
{
"success": "ok",
"data": {
},
}{
"error": "bad request",
"error_data": "Fundraising on the crowdfinding platform raise.funplace.fun must have an expiration date. Specify the parameter 'ending'"
}{
"error": "unauthorized",
"error_data": {},
}Response body (If successful)
success
yes
string
Always have the value ok.
data
yes
array
An array with information about the change.
Get rewards
GET rewards/get
scopes: Funplace::fundraisings
Get rewards.
Headers
Query Parameters
id
yes
int
Fundraising ID.
Response
{
"deedge": {
"name": "name",
"cover": "https://...",
}
}{
"error": "bad request",
"error_data": "Fundraising on the crowdfinding platform raise.funplace.fun must have an expiration date. Specify the parameter 'ending'"
}{
"error": "unauthorized",
"error_data": {},
}Response body (If successful)
<reward_id>
yes
Array
Item for corresponding item_id.
<reward_id>[name]
yes
String
Reward name.
<reward_id>[desc]
yes
String
Reward desc.
<reward_id>[cover]
yes
URI
Reward cover url.
<reward_id>[itemlist]
yes
Array
List of items given as a reward.
<reward_id>[itemlist][quantity]
yes
int
The number of items of this type.
<reward_id>[itemlist][item_id]
yes
String
The item ID.
Last updated
Was this helpful?