{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/v:version/pages.json","auth":"required","method":"post","examples":{"codes":[{"language":"json","code":"{\n    \"fb_person_id\":12,\n    \"fb_fundraising_page_addon_id\":65,\n    \"fundraiser_name\":\"John Doe\",\n    \"fundraiser_email\":\"noreply:::at:::example.com\",\n    \"title\":\"Run for peace on earth\",\n    \"description\":\"I run - you donate\",\n    \"goal\":1250,\n    \"donation_message\":\"Thank you!\",\n    \"expires_at\":\"2025-01-01\",\n  \t\"image\":{\n        \"name\":\"my_picture.jpg\",\n        \"type\":\"image\\/jpg\",\n        \"content\":\"Tm8sIHRoaXMgaXMgbm90IGEgdmFsaWQgaW1hZ2U=\"\n    }\n}"}]},"settings":"","results":{"codes":[{"status":201,"language":"json","code":"{\n    \"id\":143,\n    \"fb_person_id\":12,\n    \"fb_project_id\":null,\n    \"project_promotion_code\":\"\",\n    \"fb_payment_form_project_item_id\":null,\n    \"fb_fundraising_page_addon_id\":1,\n    \"image_url\":\"https:\\/\\/secure.fundraisingbox.test\\/pages\\/getImage\\/type\\/page\\/domain\\/5zjba\\/445.jpg\",\n    \"has_image\":true,\n    \"fundraiser_name\":\"John Doe\",\n    \"fundraiser_email\":\"[email protected]\",\n    \"title\":\"Run for peace on earth\",\n    \"description\":\"I run - you donate\",\n    \"link\":\"https:\\/\\/secure.fundraisingbox.test\\/test-cases\\/test.html?cfd=kmicn\",\n    \"admin_link\":\"https:\\/\\/secure.fundraisingbox.test\\/test-cases\\/test.html?cfd=kmicn&cfe=w6xo5ukkuc4vvxvk9bvdeujq6xmc1wgp#cff\",\n    \"goal\":1250,\n    \"received\":null,\n    \"donation_count\":null,\n    \"donation_message\":\"Thank you!\",\n    \"status\":\"active\",\n    \"expires_at\":\"2025-01-01\",\n    \"created_at\":\"2019-04-23 00:00:00\",\n    \"updated_at\":\"2019-04-23 13:57:33\"\n}","name":""}]},"params":[{"name":"sendMail","type":"boolean","default":"","desc":"Sends a welcome e-mail if set to 1","required":false,"in":"query","ref":"","_id":"5cbffa6c69b0b700395bf71f"}]},"next":{"description":"","pages":[]},"title":"/pages.json","type":"endpoint","slug":"pages-create","excerpt":"Creates a new fundraising page.","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Field\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Type\",\n    \"h-3\": \"Mandatory\",\n    \"1-0\": \"title\",\n    \"2-0\": \"description\",\n    \"3-0\": \"donation_message\",\n    \"4-0\": \"expires_at\",\n    \"5-0\": \"fundraiser_name\",\n    \"6-0\": \"fundraiser_email\",\n    \"7-0\": \"goal\",\n    \"8-0\": \"status\",\n    \"9-0\": \"fb_person_id\",\n    \"10-0\": \"fb_payment_form_project_item_id\",\n    \"1-2\": \"string (100)\",\n    \"2-2\": \"string\",\n    \"3-2\": \"string\",\n    \"5-2\": \"string (100)\",\n    \"6-2\": \"string (100)\",\n    \"9-2\": \"integer\",\n    \"7-2\": \"float\",\n    \"4-2\": \"date\",\n    \"10-2\": \"integer\",\n    \"8-2\": \"Enum (\\\"not_approved\\\", \\\"locked\\\", \\\"active\\\", \\\"preferred\\\")\",\n    \"10-3\": \"\",\n    \"1-3\": \"yes\",\n    \"5-3\": \"yes\",\n    \"6-3\": \"yes\",\n    \"2-3\": \"yes\",\n    \"7-3\": \"yes\",\n    \"3-3\": \"yes\",\n    \"4-3\": \"yes\",\n    \"9-1\": \"ID of a [person](doc:persons-list)\\n\\n(once set this value could not be changed by a PUT request any more)\",\n    \"1-1\": \"The title of the page\",\n    \"2-1\": \"A description of the page\",\n    \"3-1\": \"The message that is shown to a donor after donation\",\n    \"4-1\": \"The end date of the page\",\n    \"5-1\": \"The public name of the fundraiser\",\n    \"6-1\": \"The e-mail of the fundraiser\",\n    \"7-1\": \"The goal of the fundraising page\",\n    \"8-1\": \"The status\",\n    \"10-1\": \"ID of a payment form project item\",\n    \"0-0\": \"fb_fundraising_page_addon_id\",\n    \"0-3\": \"yes\",\n    \"0-1\": \"ID of a fundraising page addon\",\n    \"0-2\": \"integer\",\n    \"11-0\": \"image [name]\",\n    \"12-0\": \"image [type]\",\n    \"13-0\": \"image [content]\",\n    \"11-2\": \"string (500)\",\n    \"13-2\": \"string\",\n    \"12-2\": \"string (100)\",\n    \"13-1\": \"The image as base64 encoded string\",\n    \"11-1\": \"The name of the image\",\n    \"12-1\": \"The mime type of the image (e.g. \\\"image/jpg\\\")\"\n  },\n  \"cols\": 4,\n  \"rows\": 14\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Custom fields\",\n  \"body\": \"Please find further information about custom fields [at the custom fields section](doc:custom-fields).\"\n}\n[/block]","updates":[],"order":16,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5cbff97c54315900273ab76c","project":"571f5e8cd8667f0e00a3c498","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["571f5e8cd8667f0e00a3c49c","571f73cfcb4baa0e00d13a80","571f7451cb4baa0e00d13a88","571f7d2720695f3400f38797","571f7fb0ac2a080e0014c661","571f884be54f2d0e003ebb0a","572200c9ecb38d0e00d80ebd","572c301e7c8eff0e00aaa174","57df91b2c6348d0e0020c452","57e104db9ff1e21900a721ab","57fd04caeaa77f19008b8202","5899c7113514ce0f0014da84","5cbeda4b862d090013abd413","5e60d6278f8b380072f0b1e3"],"_id":"571f5e8cd8667f0e00a3c49b","hasDoc":true,"releaseDate":"2016-04-26T12:26:52.312Z","__v":14,"hasReference":true,"createdAt":"2016-04-26T12:26:52.312Z","project":"571f5e8cd8667f0e00a3c498"},"category":{"sync":{"isSync":false,"url":""},"pages":[],"title":"JSON-REST-API (API-Package)","slug":"rest-api-json","order":9,"from_sync":false,"reference":false,"_id":"5cbeda4b862d090013abd413","project":"571f5e8cd8667f0e00a3c498","version":"571f5e8cd8667f0e00a3c49b","createdAt":"2019-04-23T09:26:35.210Z","__v":1},"user":"5720ba18c669e80e00c35051","createdAt":"2019-04-24T05:51:56.714Z","__v":13,"parentDoc":null}

post/pages.json

Creates a new fundraising page.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

sendMail:
boolean
Sends a welcome e-mail if set to 1

Examples


Result Format


Documentation

[block:parameters] { "data": { "h-0": "Field", "h-1": "Description", "h-2": "Type", "h-3": "Mandatory", "1-0": "title", "2-0": "description", "3-0": "donation_message", "4-0": "expires_at", "5-0": "fundraiser_name", "6-0": "fundraiser_email", "7-0": "goal", "8-0": "status", "9-0": "fb_person_id", "10-0": "fb_payment_form_project_item_id", "1-2": "string (100)", "2-2": "string", "3-2": "string", "5-2": "string (100)", "6-2": "string (100)", "9-2": "integer", "7-2": "float", "4-2": "date", "10-2": "integer", "8-2": "Enum (\"not_approved\", \"locked\", \"active\", \"preferred\")", "10-3": "", "1-3": "yes", "5-3": "yes", "6-3": "yes", "2-3": "yes", "7-3": "yes", "3-3": "yes", "4-3": "yes", "9-1": "ID of a [person](doc:persons-list)\n\n(once set this value could not be changed by a PUT request any more)", "1-1": "The title of the page", "2-1": "A description of the page", "3-1": "The message that is shown to a donor after donation", "4-1": "The end date of the page", "5-1": "The public name of the fundraiser", "6-1": "The e-mail of the fundraiser", "7-1": "The goal of the fundraising page", "8-1": "The status", "10-1": "ID of a payment form project item", "0-0": "fb_fundraising_page_addon_id", "0-3": "yes", "0-1": "ID of a fundraising page addon", "0-2": "integer", "11-0": "image [name]", "12-0": "image [type]", "13-0": "image [content]", "11-2": "string (500)", "13-2": "string", "12-2": "string (100)", "13-1": "The image as base64 encoded string", "11-1": "The name of the image", "12-1": "The mime type of the image (e.g. \"image/jpg\")" }, "cols": 4, "rows": 14 } [/block] [block:callout] { "type": "info", "title": "Custom fields", "body": "Please find further information about custom fields [at the custom fields section](doc:custom-fields)." } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}