Search

Campaign Object

Page Content:

Campaign


Name Type Required Description Format
ambassadors array of ambassador objects optional See ambassador object below.  
author author object optional See the author object below.  
createdAt string   The date this campaign record was created. .YYYY-MM-DD Year-Month-Day
details string   The detailed description of the organisation and campaign.  
end_date string   The date the campaign ends. .YYYY-MM-DD Year-Month-Day
goal number   The monetary goal for the campaign,  
id number Required A unique ID for this campaign auto-generated by 360Alumni.  
image string   A URL to an image representing the campaign or organization. URL
isInactive number   The status of whether the campaign is active. 1: is active 0: is inactive  
raised number   The monetary amount raised by the campaign.  
start_date string   The date the campaign starts. YYYY-MM-DD Year-Month-Day
thank_you_message string   A thank-you message that can be sent to donors.  
title string Required The title for the campaign.  
type string   The type of the campaign length such as short or ongoing.  
updatedAt string   The date this campaign record was modified. .YYYY-MM-DD Year-Month-Day


author Object


Name Type Required Description
user_id number Required The user ID identifying the author of the campaign generated by 360Alumni. See also the User Object.
first_name string Required The author's first name.
last_name string Required The author's last name.


ambassador Object


Name Type Required Description
user_id number Required The user ID identifying an ambassador for the campaign generated by 360Alumni. See also the User Object.
first_name string Required The ambassador's first name.
last_name string Required The ambassador's last name.

 

JSON Campaign Object Sample


{
   "id": 17,
   "title": "Aspiring Director's Fund",
   "details": "<p>The Motion Picture Association (MPA) and the Asia Pacific Screen Awards (APSA) gives an opportunity to aspiring filmmakers with the MPA APSA Academy Film Fund. MPA APSA Academy Film Funds is a unique initiative which has aided aspiring film makers in a lot of development in new film projects.</p>",
   "goal": 501,
   "thank_you_message": "Dear #name#,\r\n\r\nThank you for your $#amount# donation to the #title# campaign! We truly appreciate your support.\r\nEvery bit helps, and you've taken us one step closer to achieving our goal.\r\nCheck back often to see which of your friends have donated, and the progress we've made. \r\n\r\nThanks for helping us to make this our most successful year yet!\r\n\r\nSincerely, 360Alumni Support",
   "type": "short",
   "start_date": "2013-11-15 00:00:00",
   "end_date": "2017-01-31 00:00:00",
   "createdAt": "2013-11-15 17:33:07",
   "updatedAt": "2016-06-16 11:42:09",
   "isInactive": null,
   "author": {
     "user_id": 1092,
     "first_name": "Georgette",
     "last_name": "Lucas"
   },
   "raised": "465",
   "image": "/cdn/images/f19cb30cf19d512a9de8f487a5bc1d13.jpg",
   "ambassadors": [
       {
       "user_id": 1103,
       "first_name": "Ken",
       "last_name": "Richardson"
       }
    ]
 }