The following operations are supported. For a formal definition, please review the Service Description.

• addCharityToTribute
  Please supply the following fields:
  

  Parameter	Type	Mandatory	Default	Description
  api_key	string	Mandatory		Your unique code to access this operation.
  user_id	int	Mandatory		The Memory Giving User ID of the person performing this operation.
  tribute_id	int	Mandatory		Unique ID that identifies each fund page.
  charity_id	int	Mandatory		Charity ID

• calculateGiftAidValue
  Please supply the following fields:
  

  Parameter	Type	Mandatory	Default	Description
  api_key	string	Mandatory		Your unique code to access this operation.
  donation	double	Mandatory		Donation amount in GBP.
  charity_id	int	Mandatory		Unique ID that identifies each charity.

• createTributePage
  Please supply the following fields:
  

  Parameter	Type	Mandatory	Default	Description
  api_key	string	Mandatory		Your unique code to access this operation.
  user_id	int	Mandatory		The Memory Giving User ID of the person performing this operation.
  * Repeating pairs				You can provide multiple charities by repeating the charity_id and beneficiary_note parameters as pairs.
  charity_id	string	Optional		Unique ID that identifies each Memory Giving charity. * Mandatory if enabled has a value of true and Funeral Director does not permit non-charity pages.
  beneficiary_note	string	Optional		A message from the family to the beneficiary about the allocation of funds. Each beneficiary_note must be paired with a charity_id in the order they are supplied.
  name	string	Mandatory		Full name of deceased.
  first_name	string	Mandatory		First name of deceased.
  middle_names	string	Optional		Middle names of deceased.
  last_name	string	Mandatory		Last name of deceased.
  qualifications	string	Optional		Qualifications of the deceased.
  aliases	string	Optional		Other names that the deceased was known by.
  page_name	string	Optional		Automatically calculated from name parameter when creating tribute page.
  date_of_birth	DateTime	Optional		(dd MMMM yyyy, dd MMM yyyy)
  date_of_death	DateTime	Mandatory		(dd MMMM yyyy, dd MMM yyyy)
  dod_msg_format	string	Optional		e.g. Passed away on {0}{1}. {0} will be replaced with the date_of_death. {1} will be replaced with the age if date_of_birth is supplied.
  message	string	Optional		A message from the family or to the donors.
  service_publish	bool	Optional	false	If you specify the service_publish parameter with a value of true, you must also specify service_date_time & service_address parameters.
  service_title	string	Optional	Funeral Service	A custom service title.
  service_date_time	DateTime	Optional		* Mandatory if service_publish is supplied as true. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)
  service_address_prefix	string	Optional		An additional line of the service address. e.g. The name of the chapel where the service is held.
  service_address	string	Optional		* Mandatory if service_publish is supplied as true. Address of where the service is held.
  service_location	string	Optional		Google Maps Decimal Degrees Format ([-90 - 90], [-180 - 180]). If omitted, this field will be automatically calculated from service_address.
  service_notes	string	Optional		Miscellaneous information related to the service.
  service_webcast	bool	Optional	false	If you specify the service_webcast parameter with a value of true, you must also specify the service_webcast_url parameter.
  service_webcast_url	string	Optional		The full URL of the service webcast.* Mandatory if service_webcast is supplied as true.
  service_webcast_username	string	Optional		The username of the service webcast.
  service_webcast_password	string	Optional		The password of the service webcast.
  service_order_of_service_byte_array	string	Optional		Base64 encoded string of the pdf file bytes.
  service_order_of_service_url	string	Optional		The full URL of an online order or service.
  committal_publish	bool	Optional	false	If you specify the committal_publish parameter with a value of true, you must also specify the committal_date_time & committal_address parameters.
  committal_title	string	Optional	Committal	A custom committal title.
  committal_date_time	DateTime	*Optional		* Mandatory if committal_publish is supplied as true. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)
  committal_address_prefix	string	Optional		An additional line of the committal address. e.g. The name of the chapel where the committal is held.
  committal_address	string	Optional		* Mandatory if committal_publish is supplied as true. Address of where the committal is held.
  committal_location	string	Optional		Google Maps Decimal Degrees Format ([-90 - 90], [-180 - 180]). If omitted, this field will be automatically calculated from committal_address.
  committal_notes	string	Optional		Miscellaneous information related to the committal.
  committal_webcast	bool	Optional	false	If you specify the committal_webcast parameter with a value of true, you must also specify the committal_webcast_url parameter.
  committal_webcast_url	string	Optional		The full URL of the committal webcast.* Mandatory if committal_webcast is supplied as true.
  committal_webcast_username	string	Optional		The username of the committal webcast.
  committal_webcast_password	string	Optional		The password of the committal webcast.
  reception_publish	bool	Optional	false	If you specify the reception_publish parameter with a value of true, you must also specify the reception_date_time & reception_address parameters.
  reception_title	string	Optional	Reception	A custom reception title.
  reception_date_time	DateTime	Optional		* Mandatory if reception_publish is supplied as true. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)
  reception_address_prefix	string	Optional		An additional line of the reception address. e.g. The name of the room where the reception is held.
  reception_address	string	Optional		* Mandatory if reception_publish is supplied as true. Address of where the reception is held.
  reception_location	string	Optional		Google Maps Decimal Degrees Format ([-90 - 90], [-180 - 180]). If omitted, this field will be automatically calculated from reception_address.
  reception_notes	string	Optional		Miscellaneous information related to the reception.
  reception_webcast	bool	Optional	false	If you specify the reception_webcast parameter with a value of true, you must also specify the reception_webcast_url parameter.
  reception_webcast_url	string	Optional		The full URL of the reception webcast.* Mandatory if reception_webcast is supplied as true.
  reception_webcast_username	string	Optional		The username of the reception webcast.
  reception_webcast_password	string	Optional		The password of the reception webcast.
  t_address1	string	Optional		Deceased address line 1.
  t_address2	string	Optional		Deceased address line 2.
  t_town	string	Optional		Deceased address town.
  t_post_code	string	Optional		Deceased address post code.
  contact_name	string	Optional		Contact / NOK name. * Mandatory if charity_id supplied.
  contact_relationship	string	Optional	Other	Contact / NOK relationship - must be one of the following: HusbandWifePartnerFatherMotherSonDaughterBrotherSisterGrandsonGranddaughterUncleAuntCousinNephewNieceFriendOther * Mandatory if charity_id supplied.
  contact_email	string	Optional		Contact / NOK email address. * Mandatory if charity_id supplied.
  beneficiary_nok_details	bool	Optional	false	Indicates whether the contact / NOK grants the beneficiary access to their information for the purposes of a thank you letter.
  contact_address1	string	Optional		Contact / NOK address line 1. * Mandatory if charity_id is supplied & beneficiary_nok_details is true.
  contact_address2	string	Optional		Contact / NOK address line 2.
  contact_town	string	Optional		Contact / NOK address town. * Mandatory if charity_id is supplied & beneficiary_nok_details is true.
  contact_overseas	bool	Optional	false	Contact / NOK address is overseas.
  contact_post_code	string	Optional		Contact / NOK address post code. * Mandatory if charity_id is supplied, beneficiary_nok_details is true & contact_overseas is false.
  enabled	bool	Mandatory		Indicates whether the page is active or not.
  base64FileBytes	string	Optional		Base64 encoded string of the image file bytes. If you specify the base64FileBytes parameter, you must also specify the file_name parameter.
  file_name	string	* Optional		File name, including extension, of the uploaded image. * Mandatory if base64FileBytes is supplied.
  photo_width	int	Optional	400	Width in pixels that the source image should be reduced to.
  photo_top	int	Optional	0	Y coordinate of the source image in relation to the crop area.
  photo_left	int	Optional	0	X coordinate of the source image in relation to the crop area.
  photo_thumb_width	int	Optional	50	Width in pixels that the source image should be reduced to.
  photo_thumb_top	int	Optional	0	Y coordinate of the source image in relation to the crop area.
  photo_thumb_left	int	Optional	0	X coordinate of the source image in relation to the crop area.
  View Photo Crop Example

• getGiftAidDeclaration
  Please supply the following fields:
  

  Parameter	Type	Mandatory	Default	Description
  api_key	string	Mandatory		Your unique code to access this operation.

• getRecentlyUpdatedCharities
  Please supply the following fields:
  

  Parameter	Type	Mandatory	Default	Description
  api_key	string	Mandatory		Your unique code to access this operation.
  datetime	DateTime	Optional	current datetime	The date & time that forms the end range of the results to be returned.
  days	int	Optional		The number of days prior to the datetime that forms the start range of the results to be returned.
  page_number	int	Optional	1	The page number of the results to be returned. Must be used with a valid page_size.
  page_size	int	Optional	all results	The number of results returned for each page.

• isTributePageNameAvailable
  Please supply the following fields:
  

  Parameter	Type	Mandatory	Default	Description
  api_key	string	Mandatory		Your unique code to access this operation.
  page_name	string	Mandatory		Page name to compare to existing page names.

• loadTributeById
  Please supply the following fields:
  

  Parameter	Type	Mandatory	Default	Description
  api_key	string	Mandatory		Your unique code to access this operation.
  tribute_id	int	Mandatory		Unique ID that identifies each fund page.

• loadTributeByPageName
  Please supply the following fields:
  

  Parameter	Type	Mandatory	Default	Description
  api_key	string	Mandatory		Your unique code to access this operation.
  page_name	string	Mandatory		Unique page name that identifies each fund page.

• makeDonation
  Please supply the following fields:
  

  Parameter	Type	Mandatory	Default	Description
  api_key	string	Mandatory		Your unique code to access this operation.
  user_id	int	Optional		* Mandatory if donation_online is false. The Memory Giving User ID of the person performing this operation.
  tribute_id	int	Mandatory		Unique ID that identifies each fund page.
  charity_id	int	Mandatory		Unique ID that identifies each charity.
  donation_online	bool	Optional	true	Indicates whether this donation has been made online or offline. Online donations will need to be processed by our Payment Provider in order to appear in the list of donations.
  anonymous	bool	Optional	false	Indicates whether the donor details appear anonymously on fund page.
  anonymous_report	bool	Optional	false	Indicates whether the donor details appear anonymously within closed reports to next of kin, funeral director & charity.
  display_name	string	Mandatory		The name displayed when anonymous is supplied as false. Usually the donors name, but can be used to describe a group of donors e.g. Smith family.
  message	string	Optional		A message from the donor to the deceased or the deceased’s family. When anonymous is supplied as true, message will be hidden on fund page. When anonymous_report is supplied as true, message will be hidden in reports to NOK.
  email	string	Optional		* Mandatory if donation_online is true. Donor email address.
  ip	string	Optional		* Mandatory if donation_online is true. Donor IP address. Used with WorldPay as a security measure against fraudulent transactions.
  donation	double	Mandatory		Donation amount in GBP.
  hide_donation_value	bool	Optional	false	Indicates whether the donation value should be hidden.
  gift_aid	bool	Optional	false	* Mandatory if donation_online is true. If you specify this parameter with a value of true, you must also specify the first_name, last_name, address1, town & post_code parameters.
  first_name	string	Optional		* Mandatory if gift_aid is true. Donor first name.
  last_name	string	Optional		* Mandatory if gift_aid is true. Donor last name.
  address1	string	Optional		* Mandatory if gift_aid is true. Donor address line 1.
  address2	string	Optional		Donor address line 2.
  town	string	Optional		* Mandatory if gift_aid is true. Donor address town.
  overseas	bool	Optional	false	If you omit this parameter or specify it with a value of false, you must also specify the post_code parameter.
  post_code	string	Optional		* Mandatory if gift_aid is true & overseas is false. Donor address post code.
  payment_type	string	Optional		* Mandatory if donation_online is true. Must be one of the following: MASTERCARD_CREDIT - MasterCard CreditMASTERCARD_DEBIT - MasterCard DebitVISA_CREDIT - Visa CreditVISA_DEBIT - Visa Debit
  accept_t_c	bool	Optional	false	* Mandatory if donation_online is true. Indicates whether the donor has accepted the terms & conditions. This value must be true in order to submit a donation.
  successfulReturnURL	string	Optional		The return URL from the Payment Gateway after a successful transaction. Must include the scheme, e.g. http:// . If you omit this parameter, the return url will be the Memory Giving fund page url. Only applicable to online donations.
  unsuccessfulReturnURL	string	Optional		The return URL from the Payment Gateway after an unsuccessful transaction. Must include the scheme, e.g. http:// .If you omit this parameter, the return url will be the same as the successfulReturnURL. Only applicable to online donations.

• removeCharityFromTribute
  Please supply the following fields:
  

  Parameter	Type	Mandatory	Default	Description
  api_key	string	Mandatory		Your unique code to access this operation.
  user_id	int	Mandatory		The Memory Giving User ID of the person performing this operation.
  tribute_id	int	Mandatory		Unique ID that identifies each fund page.
  charity_id	int	Mandatory		Charity ID

• removeDonation
  Please supply the following fields:
  

  Parameter	Type	Mandatory	Default	Description
  api_key	string	Mandatory		Your unique code to access this operation.
  user_id	int	Mandatory		The Memory Giving User ID of the person performing this operation.
  donation_id	int	Mandatory		Unique ID that identifies each donation.

• search
  Please supply the following fields:
  

  Parameter	Type	Mandatory	Default	Description
  api_key	string	Mandatory		Your unique code to access this operation.
  deceased_name	string	Optional		Deceased name or fund page ID.
  funeral_director	string	Optional		Funeral Director name or ID.
  charity	string	Optional		Charity name or ID.
  show_open	bool	Optional	true	Filter search results to show open fund pages.
  show_closed	bool	Optional	false	Filter search results to show closed fund pages.
  scope_narrow	bool	Optional	false	When the value of the funeral_director parameter is supplied as the Funeral Director ID, the search results will also include other less relevant results that belong to the supplied Funeral Director. By supplying a value of true, only relevant matches for the Funeral Director will be returned.
  include_non_tribute_pages	bool	Optional	false	When the supplied value is true, the search results will also include tribute pages that are not associated with any charities.
  date_limit	DateTime	Optional	5 years before current datetime	Limits search results to pages created after the supplied date. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)

• searchCharities
  Please supply the following fields:
  

  Parameter	Type	Mandatory	Default	Description
  api_key	string	Mandatory		Your unique code to access this operation.
  charity_name	string	Mandatory		Name of the charity to search.

• suggestCharity
  Please supply the following fields:
  

  Parameter	Type	Mandatory	Default	Description
  api_key	string	Mandatory		Your unique code to access this operation.
  user_id	int	Mandatory		The Memory Giving User ID of the person performing this operation.
  charity_name	string	Mandatory		Name of the suggested charity.
  charity_number	string	Optional		Charity number of the suggested charity.

• updateDonation
  Please supply the following fields:
  

  Parameter	Type	Mandatory	Default	Description
  api_key	string	Mandatory		Your unique code to access this operation.
  user_id	int	Mandatory		The Memory Giving User ID of the person performing this operation.
  donation_id	int	Mandatory		Unique ID that identifies each donation.
  display_name	string	Mandatory		The name displayed when anonymous is supplied as false. Usually the donors name, but can be used to describe a group of donors e.g. Smith family.
  hide_donation_value	bool	Optional	false	Indicates whether the donation value should be hidden.
  anonymous	bool	Optional	false	Indicates whether this donation should be made anonymously.
  anonymous_report	bool	Optional	false	Indicates whether the donor details appear anonymously within closed reports to next of kin, funeral director & charity.
  message	string	Optional		A message from the donor to the deceased or the deceased’s family when anonymous is supplied as false.

• updateTributePage
  Please supply the following fields:
  

  Parameter	Type	Mandatory	Default	Description
  api_key	string	Mandatory		Your unique code to access this operation.
  user_id	int	Mandatory		The Memory Giving User ID of the person performing this operation.
  tribute_id	int	Mandatory		Unique ID that identifies each fund page.
  * Repeating pairs				Update a specific beneficiary_note by supplying the charity_id and beneficiary_note parameters as pairs.
  charity_id	string	Optional		Unique ID that identifies each Memory Giving charity. * Mandatory when updating a specific beneficiary_note.
  beneficiary_note	string	Optional		A message from the family to the beneficiary about the allocation of funds. Each beneficiary_note must be paired with a charity_id in the order they are supplied.
  name	string	Mandatory		Full name of deceased.
  first_name	string	Mandatory		First name of deceased.
  middle_names	string	Optional		Middle names of deceased.
  last_name	string	Mandatory		Last name of deceased.
  qualifications	string	Optional		Qualifications of the deceased.
  aliases	string	Optional		Other names that the deceased was known by.
  page_name	string	Optional		Automatically calculated from name parameter when creating tribute page.
  date_of_birth	DateTime	Optional		(dd MMMM yyyy, dd MMM yyyy)
  date_of_death	DateTime	Mandatory		(dd MMMM yyyy, dd MMM yyyy)
  dod_msg_format	string	Optional		e.g. Passed away on {0}{1}. {0} will be replaced with the date_of_death. {1} will be replaced with the age if date_of_birth is supplied.
  message	string	Optional		A message from the family or to the donors.
  service_publish	bool	Optional	false	If you specify the service_publish parameter with a value of true, you must also specify service_date_time & service_address parameters.
  service_title	string	Optional	Funeral Service	A custom service title.
  service_date_time	DateTime	Optional		* Mandatory if service_publish is supplied as true. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)
  service_address_prefix	string	Optional		An additional line of the service address. e.g. The name of the chapel where the service is held.
  service_address	string	Optional		* Mandatory if service_publish is supplied as true. Address of where the service is held.
  service_location	string	Optional		Google Maps Decimal Degrees Format ([-90 - 90], [-180 - 180]). If omitted, this field will be automatically calculated from service_address.
  service_notes	string	Optional		Miscellaneous information related to the service.
  service_webcast	bool	Optional	false	If you specify the service_webcast parameter with a value of true, you must also specify the service_webcast_url parameter.
  service_webcast_url	string	Optional		The full URL of the service webcast.* Mandatory if service_webcast is supplied as true.
  service_webcast_username	string	Optional		The username of the service webcast.
  service_webcast_password	string	Optional		The password of the service webcast.
  service_order_of_service_byte_array	string	Optional		Base64 encoded string of the pdf file bytes.
  service_order_of_service_url	string	Optional		The full URL of an online order or service.
  committal_publish	bool	Optional	false	If you specify the committal_publish parameter with a value of true, you must also specify the committal_date_time & committal_address parameters.
  committal_title	string	Optional	Committal	A custom committal title.
  committal_date_time	DateTime	*Optional		* Mandatory if committal_publish is supplied as true. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)
  committal_address_prefix	string	Optional		An additional line of the committal address. e.g. The name of the chapel where the committal is held.
  committal_address	string	Optional		* Mandatory if committal_publish is supplied as true. Address of where the committal is held.
  committal_location	string	Optional		Google Maps Decimal Degrees Format ([-90 - 90], [-180 - 180]). If omitted, this field will be automatically calculated from committal_address.
  committal_notes	string	Optional		Miscellaneous information related to the committal.
  committal_webcast	bool	Optional	false	If you specify the committal_webcast parameter with a value of true, you must also specify the committal_webcast_url parameter.
  committal_webcast_url	string	Optional		The full URL of the committal webcast.* Mandatory if committal_webcast is supplied as true.
  committal_webcast_username	string	Optional		The username of the committal webcast.
  committal_webcast_password	string	Optional		The password of the committal webcast.
  reception_publish	bool	Optional	false	If you specify the reception_publish parameter with a value of true, you must also specify the reception_date_time & reception_address parameters.
  reception_title	string	Optional	Reception	A custom reception title.
  reception_date_time	DateTime	Optional		* Mandatory if reception_publish is supplied as true. (dd MMMM yyyy HH:mm:ss, dd MMM yyyy HH:mm:ss)
  reception_address_prefix	string	Optional		An additional line of the reception address. e.g. The name of the room where the reception is held.
  reception_address	string	Optional		* Mandatory if reception_publish is supplied as true. Address of where the reception is held.
  reception_location	string	Optional		Google Maps Decimal Degrees Format ([-90 - 90], [-180 - 180]). If omitted, this field will be automatically calculated from reception_address.
  reception_notes	string	Optional		Miscellaneous information related to the reception.
  reception_webcast	bool	Optional	false	If you specify the reception_webcast parameter with a value of true, you must also specify the reception_webcast_url parameter.
  reception_webcast_url	string	Optional		The full URL of the reception webcast.* Mandatory if reception_webcast is supplied as true.
  reception_webcast_username	string	Optional		The username of the reception webcast.
  reception_webcast_password	string	Optional		The password of the reception webcast.
  t_address1	string	Optional		Deceased address line 1.
  t_address2	string	Optional		Deceased address line 2.
  t_town	string	Optional		Deceased address town.
  t_post_code	string	Optional		Deceased address post code.
  contact_name	string	Optional		Contact / NOK name. * Mandatory if charity_id supplied.
  contact_relationship	string	Optional	Other	Contact / NOK relationship - must be one of the following: HusbandWifePartnerFatherMotherSonDaughterBrotherSisterGrandsonGranddaughterUncleAuntCousinNephewNieceFriendOther * Mandatory if charity_id supplied.
  contact_email	string	Optional		Contact / NOK email address. * Mandatory if charity_id supplied.
  beneficiary_nok_details	bool	Optional	false	Indicates whether the contact / NOK grants the beneficiary access to their information for the purposes of a thank you letter.
  contact_address1	string	Optional		Contact / NOK address line 1. * Mandatory if charity_id is supplied & beneficiary_nok_details is true.
  contact_address2	string	Optional		Contact / NOK address line 2.
  contact_town	string	Optional		Contact / NOK address town. * Mandatory if charity_id is supplied & beneficiary_nok_details is true.
  contact_overseas	bool	Optional	false	Contact / NOK address is overseas.
  contact_post_code	string	Optional		Contact / NOK address post code. * Mandatory if charity_id is supplied, beneficiary_nok_details is true & contact_overseas is false.
  enabled	bool	Mandatory		Indicates whether the page is active or not.
  base64FileBytes	string	Optional		Base64 encoded string of the image file bytes. If you specify the base64FileBytes parameter, you must also specify the file_name parameter.
  file_name	string	* Optional		File name, including extension, of the uploaded image. * Mandatory if base64FileBytes is supplied.
  photo_width	int	Optional	400	Width in pixels that the source image should be reduced to.
  photo_top	int	Optional	0	Y coordinate of the source image in relation to the crop area.
  photo_left	int	Optional	0	X coordinate of the source image in relation to the crop area.
  photo_thumb_width	int	Optional	50	Width in pixels that the source image should be reduced to.
  photo_thumb_top	int	Optional	0	Y coordinate of the source image in relation to the crop area.
  photo_thumb_left	int	Optional	0	X coordinate of the source image in relation to the crop area.
  View Photo Crop Example