Create a fundraising campaign

POST

https://ssuccessv2.com/app/api/v1/fundraising/campaign/create

POST

/app/api/v1/fundraising/campaign/create

$ curl -X POST https://ssuccessv2.com/app/api/v1/fundraising/campaign/create \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "fundraising_fund_id": 7,
>   "campaign_name": "Spring Giving Drive",
>   "legal_name": "SchoolSet Academy Foundation",
>   "tax_id": "12-3456789"
> }'

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "id": 42,
6     "fund": {
7       "id": 7,
8       "name": "Annual Fund"
9     },
10     "campaign_name": "Spring Giving Drive",
11     "status": {
12       "id": 1,
13       "title": "Active"
14     },
15     "hash": "q7m2x9k4p1",
16     "donation_types": [
17       {}
18     ],
19     "batch_id": 2026,
20     "description": "Help students attend enrichment programs.",
21     "legal_name": "SchoolSet Academy Foundation",
22     "tax_id": "12-3456789",
23     "school_id": 12,
24     "merchant_account_id": 3,
25     "start_date": "2024-01-15T09:30:00Z",
26     "end_date": "2024-01-15T09:30:00Z",
27     "total_amount": 25000,
28     "balance_amount": 7250,
29     "success_payment_message": "string",
30     "file_manager_id": 1,
31     "image": "string",
32     "show_amount": true,
33     "email": "string",
34     "phone": "string",
35     "currency": "USD",
36     "fundraising_donation_type_sort": [
37       1
38     ],
39     "open_pledges": 1200
40   }
41 }

Creates an active USD fundraising campaign for the authenticated user's active school, assigns the resolved merchant account and creator, and optionally creates donation types. The response is the complete campaign resource, including its generated id and hash.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Request

This endpoint expects an object.

fundraising_fund_idintegerRequired

campaign_namestringRequired<=1000 characters

legal_namestringRequired<=1000 characters

tax_idstringRequired<=255 characters

descriptionstring or nullOptional

start_datedatetime or nullOptional

end_datedatetime or nullOptional

total_amountdoubleOptional

success_payment_messagestring or nullOptional<=255 characters

show_amountboolean or nullOptional

emailstring or nullOptional<=255 characters

phonestring or nullOptional<=255 characters

fundraising_donation_type_sortlist of integers or nullOptional

fundraising_donation_typeslist of maps from strings to any or nullOptional

file_manager_idinteger or nullOptional

Response

Campaign created.

statusstring

messagestring

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error