Edit account info
API base url: https://funplace.fun/api/v1/user/edit/
Edit link
GET donate_page/link
scopes: Funplace::edit or Funplace::edit::donate_page/link
Change the address of the link through which the user accepts donations.
Headers
Query Parameters
newlink
yes
string
The value that will now be located after https://funplace.fun/d/ at the donation link.
ATTENTION: The minimum value length is 3 characters
Response
{
"success": "ok",
"data": {
"link_base": "https://funplace.fun/d/",
"older_link": "Funplac",
"new_link": "Funplace",
},
}{
"error": "bad request",
"error_data": "this link is already in use by another user"
}{
"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[link_base]
yes
URI
The base link usually takes the value https://funplace.fun/d/.
data[older_link]
yes
string
Old link suffix value.
data[new_link]
yes
string
New link suffix value.
Edit donate page color
GET donate_page/color
scopes: Funplace::edit or Funplace::edit::donate_page/color
Change the color of the donation page.
Headers
Query Parameters
newcolor
yes
color code
New design color value.
Example: #1B1B1B
Response
{
"success": "ok",
"data": {
"older_color": "#2DFFCD",
"new_color": "#7d9339",
},
}{
"error": "bad request",
"error_data": "invalid 'newcolor' value"
}{
"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[older_color]
yes
color code
Old color of the donation page value.
data[new_color]
yes
color code
New color of the donation page value.
Edit donate page background
GET/POST + GET QUERY PARAMETERS donate_page/background
scopes: Funplace::edit or Funplace::edit::donate_page/background
Change the background of the donation page.
Headers
Query Parameters
ATTENTION: You can specify the newbackground[Picture] value in the POST BODY to use other links or Data URIs. For example, send a post request to https://funplace.fun/api/v1/user/edit/donate_page/background?newbackground[type]=Picture and Post Body {newbackground: {Picture: "data%3Aimage%2Fjpeg%3Bbase64..."}}
Response
{
"success": "ok",
"data": {
"older_background": {
"type": "Color",
"Color": "#000000",
},
"new_background": {
"type": "Picture",
"Picture": "https://funplace.fun/back.svg",
},
},
}{
"error": "bad request",
"error_data": "invalid 'newbackground' value"
}{
"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.
Edit description
GET donate_page/description
scopes: Funplace::edit or Funplace::edit::donate_page/description
Change the description on the donation page.
Headers
Query Parameters
turnon
yes
bool
Enable or disable the description on the donation page.
newdesciption
no
Sting or Editor.js data
New description value. Supports editor.js. ATTENTION: Leave blank if you are not changing the description. The minimum value length is 10 character.
editor.js
no
bool
If you sent json from editor.js data in the description, then specify true.
Response
{
"success": "ok",
"data": {
"trunon": true,
"older_descripton": "Привет, я лучший стример твича...",
"new_descripton": "Funplace هي أفضل خدمة التبرع.",
},
}{
"error": "bad request",
"error_data": "invalid 'turnon' value"
}{
"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[trunon]
yes
bool
The description on the donation page is turned on or off.
data[older_descripton]
yes (If you have submitted a new description)
string
Old description on the donation page value.
data[new_descripton]
yes (If you have submitted a new description)
string
New description on the donation page value.
data[description]
yes (If you haven't submitted a new description)
string
Description on the donation page value.
Edit links on donate page
GET donate_page/links
scopes: Funplace::edit or Funplace::edit::donate_page/links
Change the links to social networks posted on the donation page.
Headers
Query Parameters
turnon
yes
bool
Enable or disable the description on the donation page.
newlinks
no
array of Social links
New links value.
ATTENTION: Leave blank if you are not changing the links. We also want to draw your attention to the fact that only links to those social networks that are in this array will be changed.
Response
{
"success": "ok",
"data": {
"trunon": true,
"older_links": {
{
"social network": "Twitter",
"value": "https://twitter.com/VorgCraft",
},
}
"new_links": {
{
"social network": "Twitter",
"value": "https://twitter.com/@FUNPLACE_OFC",
},
}
"links": {
{
"social network": "Twitter",
"value": "https://twitter.com/@FUNPLACE_OFC",
},
{
"social network": "Product Hunt",
"value": "https://producthunt.com/posts/funplace",
}
},
},
}{
"error": "bad request",
"error_data": "Unsupported 'newlinks[social network]' value 'X'"
}{
"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[trunon]
yes
bool
The links on the donation page is turned on or off.
data[older_links]
yes (If you have submitted a new links)
array of Social links
Old links on the donation page value (Only changed links).
data[new_links]
yes (If you have submitted a new description)
array of Social links
New links on the donation page value (Only changed links).
data[links]
yes
array of Social links
Links on the donation page value (All links added to the donation page).
Edit default amount
GET donate_page/default_amount
scopes: Funplace::edit or Funplace::edit::donate_page/default_amount
Change the donation amount, which will be displayed by default on the donation page.
Headers
Query Parameters
amount
yes
double
Enter the amount as a number, in the xx.xx format.
Example: 50.00
ATTENTION: The total amount should not be less than the minimum donation amount.
Response
{
"success": "ok",
"data": {
"older_default_amount": 50.00,
"older_default_curr": "RUB",
"new_default_amount": 0.75,
"new_default_curr": "USD",
},
}{
"error": "bad request",
"error_data": "invalid 'currency' value"
}{
"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[older_default_amount]
yes
double
Old default donation amount.
data[new_default_amount]
yes
double
New default donation amount.
Edit donate button text
GET donate_page/button_text
scopes: Funplace::edit or Funplace::edit::donate_page/button_text
Change the text written on the donate button on the donate page.
Headers
Query Parameters
newtext
yes
string
New text written on the donate button on the donate page.
Response
{
"success": "ok",
"data": {
"older_donate_button_text": "Donate",
"new_donate_button_text": "Спасибо, братик!",
},
}{
"error": "bad request",
"error_data": "invalid 'newtext' value"
}{
"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[older_donate_button_text]
yes
string
Old text written on the donate button on the donate page.
data[new_donate_button_text]
yes
string
New text written on the donate button on the donate page.
Edit Funplace nickname
GET account/nickname
scopes: Funplace::edit or Funplace::edit::account/name
Change the name displayed inside Funplace.
Headers
Query Parameters
newname
yes
string
New name displayed inside Funplace.
Response
{
"success": "ok",
"data": {
"older_name": "Yuuechka",
"new_name": "5opka",
},
}{
"error": "bad request",
"error_data": "invalid 'newname' value"
}{
"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[older_name]
yes
string
Old name displayed inside Funplace.
data[new_name]
yes
string
New name displayed inside Funplace.
Edit Funplace avatar
POST account/avatar
scopes: Funplace::edit or Funplace::edit::account/avatar
Change the avatar displayed inside Funplace.
Headers
Query Parameters
file
yes
PNG File
New avatar file in base64 format. ATTENTION: Max size: 4MB
Response
{
"success": "ok",
"data": {
"older_avatar": "https://cdn.funplace.fun/avatars/1_old.png",
"new_avatar": "https://cdn.funplace.fun/avatars/1.png",
},
}{
"error": "bad request",
"error_data": "invalid 'newname' value"
}{
"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[older_avatar]
yes
URI
Link to old avatar displayed inside Funplace.
data[new_avatar]
yes
URI
Link to new name avatar inside Funplace.
Edit Funplace basecurr
GET donates/basecurr
scopes: Funplace::edit or Funplace::edit::donates/basecurr
Change the default account currency (Billing Currency).
Headers
Query Parameters
Response
{
"success": "ok",
"data": {
"Oldcurr": "RUB",
"Newcurr": "USD",
},
}{
"error": "bad request",
"error_data": "You can change this value no more than once a month (31 days)."
}{
"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[Oldcurr]
yes
URI
Older currency value.
data[Newcurr]
yes
URI
New currency value.
Edit minimal donate cost
GET donates/mincost
scopes: Funplace::edit or Funplace::edit::donates/mincost
Change the minimum donation amount that a donor can enter, specified in the default account currency (Billing Currency).
Headers
Content-Type
application/json
Authorization
Bearer <access_token>
FUNPLACE-PROFILE-IDFUNPLACE_PROFILE_ID
Query Parameters
amount
yes
double
New minimum donation amount.
Response
{
"success": "ok",
"data": {},
}{
"error": "bad request",
"error_data": "Invalid 'amount' value"
}{
"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.
Setup AI Automod
GET donates/automod_setup
scopes: Funplace::edit or Funplace::edit::donates/automod_setup
Set up integration of automatic moderation of donations via ChatGPT.
Headers
Query Parameters
turnon
no
boolean
Is ai automod enabled?
powerlevel
no
string
Level of moderation severity.
ATTENTION: Available values: hard, medium, soft.
Response
{
"success": "ok",
"data": {},
}{
"error": "bad request",
"error_data": "Invalid 'powerlevel' value"
}{
"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.
Text donation settings
GET donates/textmessages
scopes: Funplace::edit or Funplace::edit::donates/textmessages
Setting up text donation limits and capabilities.
Headers
Query Parameters
maxlen
no
int
The maximum length of a message that a donor can send. ATTENTION: You can specify a value from 50 to 400 inclusive.
ttson
no
boolean
Is the donation voiceover enabled?
Response
{
"success": "ok",
"data": {},
}{
"error": "bad request",
"error_data": "Invalid 'ttson' value"
}{
"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.
Audio donation settings
GET donates/audiomessages
scopes: Funplace::edit or Funplace::edit::donates/audiomessages
Setting up audio donation limits and capabilities.
Headers
Query Parameters
turnon
no
boolean
Are audio donations enabled?
maxdur
no
int
Maximum duration of audio message in seconds. ATTENTION: You can specify a value from 30 to 300 inclusive.
mincost
no
Array
Minimum donation amount to be able to send audio.
mincost[amount]
yes (Only if the mincost is specified)
double
Amount of the mincost value. Enter the amount as a number, in the xx.xx format.
Or specify 0 and any currency so that mincost matches the minimum donation amount.
Example: 50.00
ATTENTION: The total amount should not be less than the minimum donation amount.
mincost[curr]
yes (Only if the mincost is specified)
string
Currency of the mincost value. 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": "Invalid 'ttson' value"
}{
"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.
Meme donation settings
GET donates/mememessages
scopes: Funplace::edit or Funplace::edit::donates/mememessages
Setting up meme donation limits and capabilities.
Headers
Query Parameters
turnon
no
boolean
Are audio donations enabled?
explicit_disable
no
boolean
Are memes marked explicit (Dangerous Content) included? Specify true to disable.
mincost
no
Array
Minimum donation amount to be able to send audio.
mincost[amount]
yes (Only if the mincost is specified)
double
Amount of the mincost value. Enter the amount as a number, in the xx.xx format.
Or specify 0 and any currency so that mincost matches the minimum donation amount.
Example: 50.00
ATTENTION: The total amount should not be less than the minimum donation amount.
mincost[curr]
yes (Only if the mincost is specified)
string
Currency of the mincost value. 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": "Invalid 'ttson' value"
}{
"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.
Product donation settings
GET donates/productmessages
scopes: Funplace::edit or Funplace::edit::donates/productmessages
Setting up product (AliExpress) donation.
Headers
Query Parameters
turnon
no
boolean
Are audio donations enabled?
address
no
Array
Delivery address.
address[fullstr]
yes (Only if the address is specified)
String
A complete address string containing at least country, city, province.
address[country]
yes (Only if the address is specified)
String
Country matching the address string.
address[region]
yes (Only if the address is specified)
String
Region (Province) matching the address string.
address[city]
yes (Only if the address is specified)
String
City matching the address string.
address[street]
no
String
Street matching the address string.
address[zip]
no
String
Zipcode (Postal code) matching the address string.
Response
{
"success": "ok",
"data": {},
}{
"error": "bad request",
"error_data": "Invalid 'ttson' value"
}{
"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.
Last updated
Was this helpful?