Fundraising (v1-2025-04-18)

Service providing access to Fundraising resources and features

Download OpenAPI description
Languages
Servers
Mock server
https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/
https://fundraising.api.rhythmsoftware.com/

Appeals

Appeals

Operations

Billing Templates

Billing Templates

Operations

Campaigns

Campaigns

Operations

Donor Clubs

Donor Clubs

Operations

Donor Levels

Donor Levels

Operations

Donor Statement Templates

Donor Statement Templates

Operations

Donor Statements

Donor Statements

Operations

Donors

Donors

Operations

Fund Categories

Fund Categories

Operations

Funds

Funds

Operations

Gift Notices

Gift Notices

Operations

Gifts

Gifts

Operations

Giving Processes

Giving Processes

Operations

Gets all of the giving processes in the system.

Request

This method will scan all giving processes and and return them to the caller.

Path
tenantIdstringrequired

The id of the tenant being accessed.

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

exclusiveStartKeystring

The start key, if you're making a subsequent request

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/givingProcesses/{tenantId}?exclusiveStartKey=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The giving processeswere retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/jsonArray [
acknowledgement_settingsobject(Acknowledgement Settings)required
acknowledgement_settings.​checkbox_textstring(Checkbox Text)required

The value to show on the textbox label

acknowledgement_settings.​htmlstring(Html)

HTML to show

allow_anonymous_giftsboolean(Allow Anonymous Gifts)

If true, anonymous gifts are allowed

allow_pledgesboolean(Allow Pledges)

Whether pledges are allowed in this process

allow_recurring_giftsboolean(Allow Recurring Gifts)

Whether recurring gifts are allowed in this process

allow_tribute_giftsboolean(Allow Tribute Gifts)

If set, donors are able to donor in honor of/in memory of

appeal_idstring(Appeal)

The appeal to which gifts given in this process should be associated

campaign_idstring(Campaign)

The campaign to which gifts given in this process should be associated

checkout_settingsobject(Checkout Settings)required
checkout_settings.​allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

checkout_settings.​bank_account_idstring(Bank Account)required

The default bank account that the store should use to receive payments

checkout_settings.​bill_my_organization_optionsobject(Bill My Organization Options)
checkout_settings.​bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)
checkout_settings.​business_unit_idstring(Business Unit)required

The business unit of the store

checkout_settings.​cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

checkout_settings.​checkout_donation_optionsCheckout Donation Options (object)(Checkout Donation Options)
One of:
checkout_settings.​credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

If set, the maximum amount for which credit cards can be taken

checkout_settings.​credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

If set, the minimum amount for which credit cards can be taken

checkout_settings.​credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"
checkout_settings.​credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"
checkout_settings.​credit_card_processing_fee_optionsCredit Card Processing Fee Options (object)(Credit Card Processing Fee Options)
One of:
checkout_settings.​disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

If set, in the portal people are not allowed to save credit cards

checkout_settings.​enable_bill_my_organizationboolean(Enable Bill My Organization)

If set, the user has the option to bill their organization

checkout_settings.​enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

If set, the user has the option to bill their organization's parent organization

checkout_settings.​enable_donations_at_checkoutboolean(Enable Donations At Checkout)

If selected, users will be prompted to make a donation upon checking out

checkout_settings.​enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

checkout_settings.​enable_pay_laterboolean(Enable Pay Later)

If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed

checkout_settings.​enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

checkout_settings.​enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

checkout_settings.​installment_plan_optionsArray of objectsnon-empty
One of:
non-empty
checkout_settings.​invoice_payment_terms_idstring(Invoice Payment Terms)

The payment terms for invoices; if left blank, default is used

checkout_settings.​invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

checkout_settings.​merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

checkout_settings.​pay_later_optionsobject(Pay Later Options)
checkout_settings.​restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

checkout_settings.​special_instructionsstring(Special Instructions)

Instructions shown to the user

checkout_settings.​use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether to use pro forma invoices when user elects to pay later

default_fund_idstring(Default Fund)required

The default fund that a gift should be allocated to when the user makes an non-targeted gift

donor_instructionsstring(Donor Instructions)

Instructions shown to donors on the giving form

enable_gift_receiptboolean(Enable Gift Receipt)

Enable confirmation email for submitted gift forms

enable_pledge_receiptboolean(Enable Pledge Receipt)

Enable confirmation email for submitted pledge forms

enable_premiumsboolean(Enable Premiums)

If set, premiums are automatically assigned with gifts

gift_receiptobject(Gift Receipt)required

The confirmation email for submitted gift forms

gift_receipt.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

gift_receipt.​bodystring(Body)required

The email body

gift_receipt.​ccstring(Cc)

Anyone that should be cc'ed on the email

gift_receipt.​fromstring(From)

From email address

gift_receipt.​from_namestring(From Name)

From name

gift_receipt.​reply_tostring(Reply To)

The reply to

gift_receipt.​subjectstring(Subject)required

The email subject

idstring(ID)^[\w|-]+$required

The unique, string identifier of this application process

is_activeboolean(Is Active)

Whether or not this process is active

namestring(Name)required

The name of the application process

new_donor_contact_optionsobject(New Donor Contact Options)

The fields that should show for new contacts being created in the portal during the contribution process

override_checkout_settingsboolean(Override Checkout Settings)

Whether or not to override POC settings

pledge_installment_plansArray of objectsnon-emptyrequired
pledge_installment_plans[].​installment_plan_idstring(Installment Plan)required

The installment plan

pledge_installment_plans[].​namestring(Name)required

The description of the installment plan to be shown to the user

pledge_receiptobject(Pledge Receipt)required

The confirmation email for submitted pledge forms

pledge_receipt.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

pledge_receipt.​bodystring(Body)required

The email body

pledge_receipt.​ccstring(Cc)

Anyone that should be cc'ed on the email

pledge_receipt.​fromstring(From)

From email address

pledge_receipt.​from_namestring(From Name)

From name

pledge_receipt.​reply_tostring(Reply To)

The reply to

pledge_receipt.​subjectstring(Subject)required

The email subject

pledges_generate_pro_forma_invoicesboolean(Pledges Generate Pro Forma Invoices)

If true, pledges will generate pro forma (not real) invoices

premium_rulesArray of objectsrequired
premium_rules[].​gift_amount_range_endnumber(float)(Gift Amount Range End)

The ending range

premium_rules[].​gift_amount_range_startnumber(float)(Gift Amount Range Start)

The starting range for the premium rule

premium_rules[].​premium_idstring(Premium)required

The premium

premium_shipping_method_idstring(Premium Shipping Method)required

The shipping method to use for premiums

recurring_gift_optionsobject(Recurring Gift Options)required
recurring_gift_options.​allow_donor_to_specify_end_dateboolean(Allow Donor To Specify End Date)

If set, the user can indicate when they want the gifts to end

recurring_gift_options.​enable_annuallyboolean(Enable Annually)

If set, donors can have annual recurring gifts

recurring_gift_options.​enable_monthlyboolean(Enable Monthly)

If set, donors can have monthly recurring gifts

recurring_gift_options.​enable_quarterlyboolean(Enable Quarterly)

If set, donors can have quarterly recurring gifts

require_acknowledgementboolean(Require Acknowledgement)

If set, donors must acknowledge a checkbox before proceeding

show_campaign_progressboolean(Show Campaign Progress)

If set, then the campaign in use for the giving form will show progress at the time of giving

suggest_giving_amountsboolean(Suggest Giving Amounts)

If true, giving amounts are suggested; otherwise, the donor is free to enter their own

suggested_gift_amountnumber(float)(Suggested Gift Amount)

The suggested amount of given, set by default

suggested_giving_amountsArray of numbers(float)(Suggested Giving Amounts)[ 1 .. 10 ] itemsrequired
sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

targeted_givingstring(Targeted Giving)required

Whether targeted giving is enabled for this process

Enum"disabled""specify multiple funds""specify single fund"
targeted_giving_optionsobject(Targeted Giving Options)
tribute_gift_optionsobject(Tribute Gift Options)required
tribute_gift_options.​email_notificationEmail Notification (object)(Email Notification)

The templated email to send to honorees

One of:

The templated email to send to honorees

tribute_gift_options.​honoree_notificationstring(Honoree Notification)
Enum"disabled""email""email or mail""mail"
]
Response
application/json
[ { "acknowledgement_settings": {}, "allow_anonymous_gifts": true, "allow_pledges": true, "allow_recurring_gifts": true, "allow_tribute_gifts": true, "appeal_id": "string", "campaign_id": "string", "checkout_settings": {}, "default_fund_id": "string", "donor_instructions": "string", "enable_gift_receipt": true, "enable_pledge_receipt": true, "enable_premiums": true, "gift_receipt": {}, "id": "string", "is_active": true, "name": "string", "new_donor_contact_options": {}, "override_checkout_settings": true, "pledge_installment_plans": [], "pledge_receipt": {}, "pledges_generate_pro_forma_invoices": true, "premium_rules": [], "premium_shipping_method_id": "string", "recurring_gift_options": {}, "require_acknowledgement": true, "show_campaign_progress": true, "suggest_giving_amounts": true, "suggested_gift_amount": 0.1, "suggested_giving_amounts": [], "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "targeted_giving": "disabled", "targeted_giving_options": {}, "tribute_gift_options": {} } ]

Creates a new giving process record that does not already exist.

Request

This method will auto-generate an ID and create a new giving process. If an ID is specified for the giving process, an error will be thrown.

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The giving process that you would like to be saved.

acknowledgement_settingsobject(Acknowledgement Settings)required
acknowledgement_settings.​checkbox_textstring(Checkbox Text)required

The value to show on the textbox label

acknowledgement_settings.​htmlstring(Html)

HTML to show

allow_anonymous_giftsboolean(Allow Anonymous Gifts)

If true, anonymous gifts are allowed

allow_pledgesboolean(Allow Pledges)

Whether pledges are allowed in this process

allow_recurring_giftsboolean(Allow Recurring Gifts)

Whether recurring gifts are allowed in this process

allow_tribute_giftsboolean(Allow Tribute Gifts)

If set, donors are able to donor in honor of/in memory of

appeal_idstring(Appeal)

The appeal to which gifts given in this process should be associated

campaign_idstring(Campaign)

The campaign to which gifts given in this process should be associated

checkout_settingsobject(Checkout Settings)required
checkout_settings.​allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

checkout_settings.​bank_account_idstring(Bank Account)required

The default bank account that the store should use to receive payments

checkout_settings.​bill_my_organization_optionsobject(Bill My Organization Options)
checkout_settings.​bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)
checkout_settings.​business_unit_idstring(Business Unit)required

The business unit of the store

checkout_settings.​cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

checkout_settings.​checkout_donation_optionsCheckout Donation Options (object)(Checkout Donation Options)
One of:
checkout_settings.​credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

If set, the maximum amount for which credit cards can be taken

checkout_settings.​credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

If set, the minimum amount for which credit cards can be taken

checkout_settings.​credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"
checkout_settings.​credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"
checkout_settings.​credit_card_processing_fee_optionsCredit Card Processing Fee Options (object)(Credit Card Processing Fee Options)
One of:
checkout_settings.​disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

If set, in the portal people are not allowed to save credit cards

checkout_settings.​enable_bill_my_organizationboolean(Enable Bill My Organization)

If set, the user has the option to bill their organization

checkout_settings.​enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

If set, the user has the option to bill their organization's parent organization

checkout_settings.​enable_donations_at_checkoutboolean(Enable Donations At Checkout)

If selected, users will be prompted to make a donation upon checking out

checkout_settings.​enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

checkout_settings.​enable_pay_laterboolean(Enable Pay Later)

If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed

checkout_settings.​enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

checkout_settings.​enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

checkout_settings.​installment_plan_optionsArray of objectsnon-empty
One of:
non-empty
checkout_settings.​invoice_payment_terms_idstring(Invoice Payment Terms)

The payment terms for invoices; if left blank, default is used

checkout_settings.​invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

checkout_settings.​merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

checkout_settings.​pay_later_optionsobject(Pay Later Options)
checkout_settings.​restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

checkout_settings.​special_instructionsstring(Special Instructions)

Instructions shown to the user

checkout_settings.​use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether to use pro forma invoices when user elects to pay later

default_fund_idstring(Default Fund)required

The default fund that a gift should be allocated to when the user makes an non-targeted gift

donor_instructionsstring(Donor Instructions)

Instructions shown to donors on the giving form

enable_gift_receiptboolean(Enable Gift Receipt)

Enable confirmation email for submitted gift forms

enable_pledge_receiptboolean(Enable Pledge Receipt)

Enable confirmation email for submitted pledge forms

enable_premiumsboolean(Enable Premiums)

If set, premiums are automatically assigned with gifts

gift_receiptobject(Gift Receipt)required

The confirmation email for submitted gift forms

gift_receipt.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

gift_receipt.​bodystring(Body)required

The email body

gift_receipt.​ccstring(Cc)

Anyone that should be cc'ed on the email

gift_receipt.​fromstring(From)

From email address

gift_receipt.​from_namestring(From Name)

From name

gift_receipt.​reply_tostring(Reply To)

The reply to

gift_receipt.​subjectstring(Subject)required

The email subject

idstring(ID)^[\w|-]+$required

The unique, string identifier of this application process

is_activeboolean(Is Active)

Whether or not this process is active

namestring(Name)required

The name of the application process

new_donor_contact_optionsobject(New Donor Contact Options)

The fields that should show for new contacts being created in the portal during the contribution process

override_checkout_settingsboolean(Override Checkout Settings)

Whether or not to override POC settings

pledge_installment_plansArray of objectsnon-emptyrequired
pledge_installment_plans[].​installment_plan_idstring(Installment Plan)required

The installment plan

pledge_installment_plans[].​namestring(Name)required

The description of the installment plan to be shown to the user

pledge_receiptobject(Pledge Receipt)required

The confirmation email for submitted pledge forms

pledge_receipt.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

pledge_receipt.​bodystring(Body)required

The email body

pledge_receipt.​ccstring(Cc)

Anyone that should be cc'ed on the email

pledge_receipt.​fromstring(From)

From email address

pledge_receipt.​from_namestring(From Name)

From name

pledge_receipt.​reply_tostring(Reply To)

The reply to

pledge_receipt.​subjectstring(Subject)required

The email subject

pledges_generate_pro_forma_invoicesboolean(Pledges Generate Pro Forma Invoices)

If true, pledges will generate pro forma (not real) invoices

premium_rulesArray of objectsrequired
premium_rules[].​gift_amount_range_endnumber(float)(Gift Amount Range End)

The ending range

premium_rules[].​gift_amount_range_startnumber(float)(Gift Amount Range Start)

The starting range for the premium rule

premium_rules[].​premium_idstring(Premium)required

The premium

premium_shipping_method_idstring(Premium Shipping Method)required

The shipping method to use for premiums

recurring_gift_optionsobject(Recurring Gift Options)required
recurring_gift_options.​allow_donor_to_specify_end_dateboolean(Allow Donor To Specify End Date)

If set, the user can indicate when they want the gifts to end

recurring_gift_options.​enable_annuallyboolean(Enable Annually)

If set, donors can have annual recurring gifts

recurring_gift_options.​enable_monthlyboolean(Enable Monthly)

If set, donors can have monthly recurring gifts

recurring_gift_options.​enable_quarterlyboolean(Enable Quarterly)

If set, donors can have quarterly recurring gifts

require_acknowledgementboolean(Require Acknowledgement)

If set, donors must acknowledge a checkbox before proceeding

show_campaign_progressboolean(Show Campaign Progress)

If set, then the campaign in use for the giving form will show progress at the time of giving

suggest_giving_amountsboolean(Suggest Giving Amounts)

If true, giving amounts are suggested; otherwise, the donor is free to enter their own

suggested_gift_amountnumber(float)(Suggested Gift Amount)

The suggested amount of given, set by default

suggested_giving_amountsArray of numbers(float)(Suggested Giving Amounts)[ 1 .. 10 ] itemsrequired
sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

targeted_givingstring(Targeted Giving)required

Whether targeted giving is enabled for this process

Enum"disabled""specify multiple funds""specify single fund"
targeted_giving_optionsobject(Targeted Giving Options)
tribute_gift_optionsobject(Tribute Gift Options)required
tribute_gift_options.​email_notificationEmail Notification (object)(Email Notification)

The templated email to send to honorees

One of:

The templated email to send to honorees

tribute_gift_options.​honoree_notificationstring(Honoree Notification)
Enum"disabled""email""email or mail""mail"
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/givingProcesses/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "acknowledgement_settings": {
      "checkbox_text": "string",
      "html": "string"
    },
    "allow_anonymous_gifts": true,
    "allow_pledges": true,
    "allow_recurring_gifts": true,
    "allow_tribute_gifts": true,
    "appeal_id": "string",
    "campaign_id": "string",
    "checkout_settings": {
      "allow_customer_to_choose_installment_plan": true,
      "bank_account_id": "string",
      "bill_my_organization_options": {
        "billing_address": "do not show",
        "purchase_order_number": "do not show",
        "reference_number": "string"
      },
      "bill_my_parent_organization_options": {
        "billing_address": "do not show",
        "purchase_order_number": "do not show",
        "reference_number": "string"
      },
      "business_unit_id": "string",
      "cancellation_fee_product_id": "string",
      "checkout_donation_options": {
        "simple_checkout_donation_options": {
          "allow_user_to_specify_custom_amount": true,
          "donation_ask_text": "string",
          "donation_denominations": [
            0.1
          ],
          "donation_information": "string",
          "donation_product_id": "string",
          "override_donation_denominations": true,
          "suggested_donation": 0.1
        },
        "type": "simple"
      },
      "credit_card_minimum_range_end": 0.1,
      "credit_card_minimum_range_start": 0.1,
      "credit_card_mode": "disabled",
      "credit_card_processing_fee_mode": "charge",
      "credit_card_processing_fee_options": {
        "fee_percentage": 0.1,
        "maximum_fee": 0.1,
        "minimum_fee": 0.1,
        "product_id": "string",
        "prompt_sub_text": "string",
        "prompt_text": "string"
      },
      "disable_electronic_payment_vaulting": true,
      "enable_bill_my_organization": true,
      "enable_bill_my_parent_organization": true,
      "enable_donations_at_checkout": true,
      "enable_electronic_checks": true,
      "enable_pay_later": true,
      "enable_payroll_deduction": true,
      "enable_split_payments": true,
      "installment_plan_options": {
        "0": {
          "additional_cost": 0.1,
          "installment_plan_id": "string",
          "is_default": true
        }
      },
      "invoice_payment_terms_id": "string",
      "invoice_template_id": "string",
      "merchant_account_id": "string",
      "pay_later_options": {
        "billing_address": "do not show",
        "purchase_order_number": "do not show",
        "reference_number": "string"
      },
      "restocking_fee_product_id": "string",
      "special_instructions": "string",
      "use_pro_forma_invoices": true
    },
    "default_fund_id": "string",
    "donor_instructions": "string",
    "enable_gift_receipt": true,
    "enable_pledge_receipt": true,
    "enable_premiums": true,
    "gift_receipt": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "id": "string",
    "is_active": true,
    "name": "string",
    "new_donor_contact_options": {},
    "override_checkout_settings": true,
    "pledge_installment_plans": [
      {
        "installment_plan_id": "string",
        "name": "string"
      }
    ],
    "pledge_receipt": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "pledges_generate_pro_forma_invoices": true,
    "premium_rules": [
      {
        "gift_amount_range_end": 0.1,
        "gift_amount_range_start": 0.1,
        "premium_id": "string"
      }
    ],
    "premium_shipping_method_id": "string",
    "recurring_gift_options": {
      "allow_donor_to_specify_end_date": true,
      "enable_annually": true,
      "enable_monthly": true,
      "enable_quarterly": true
    },
    "require_acknowledgement": true,
    "show_campaign_progress": true,
    "suggest_giving_amounts": true,
    "suggested_gift_amount": 0.1,
    "suggested_giving_amounts": [
      1
    ],
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "targeted_giving": "disabled",
    "targeted_giving_options": {
      "restrict_to_fund_categories": true,
      "restrict_to_fund_types": true,
      "restrict_to_funds": true,
      "restricted_fund_category_ids": {
        "0": "string"
      },
      "restricted_fund_ids": {
        "0": "string"
      },
      "restricted_fund_types": {
        "0": "restricted funds"
      }
    },
    "tribute_gift_options": {
      "email_notification": {
        "bcc": "string",
        "body": "string",
        "cc": "string",
        "from": "string",
        "from_name": "string",
        "reply_to": "string",
        "subject": "string"
      },
      "honoree_notification": "disabled"
    }
  }'

Responses

The giving process was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
acknowledgement_settingsobject(Acknowledgement Settings)required
acknowledgement_settings.​checkbox_textstring(Checkbox Text)required

The value to show on the textbox label

acknowledgement_settings.​htmlstring(Html)

HTML to show

allow_anonymous_giftsboolean(Allow Anonymous Gifts)

If true, anonymous gifts are allowed

allow_pledgesboolean(Allow Pledges)

Whether pledges are allowed in this process

allow_recurring_giftsboolean(Allow Recurring Gifts)

Whether recurring gifts are allowed in this process

allow_tribute_giftsboolean(Allow Tribute Gifts)

If set, donors are able to donor in honor of/in memory of

appeal_idstring(Appeal)

The appeal to which gifts given in this process should be associated

campaign_idstring(Campaign)

The campaign to which gifts given in this process should be associated

checkout_settingsobject(Checkout Settings)required
checkout_settings.​allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

checkout_settings.​bank_account_idstring(Bank Account)required

The default bank account that the store should use to receive payments

checkout_settings.​bill_my_organization_optionsobject(Bill My Organization Options)
checkout_settings.​bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)
checkout_settings.​business_unit_idstring(Business Unit)required

The business unit of the store

checkout_settings.​cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

checkout_settings.​checkout_donation_optionsCheckout Donation Options (object)(Checkout Donation Options)
One of:
checkout_settings.​credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

If set, the maximum amount for which credit cards can be taken

checkout_settings.​credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

If set, the minimum amount for which credit cards can be taken

checkout_settings.​credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"
checkout_settings.​credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"
checkout_settings.​credit_card_processing_fee_optionsCredit Card Processing Fee Options (object)(Credit Card Processing Fee Options)
One of:
checkout_settings.​disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

If set, in the portal people are not allowed to save credit cards

checkout_settings.​enable_bill_my_organizationboolean(Enable Bill My Organization)

If set, the user has the option to bill their organization

checkout_settings.​enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

If set, the user has the option to bill their organization's parent organization

checkout_settings.​enable_donations_at_checkoutboolean(Enable Donations At Checkout)

If selected, users will be prompted to make a donation upon checking out

checkout_settings.​enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

checkout_settings.​enable_pay_laterboolean(Enable Pay Later)

If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed

checkout_settings.​enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

checkout_settings.​enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

checkout_settings.​installment_plan_optionsArray of objectsnon-empty
One of:
non-empty
checkout_settings.​invoice_payment_terms_idstring(Invoice Payment Terms)

The payment terms for invoices; if left blank, default is used

checkout_settings.​invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

checkout_settings.​merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

checkout_settings.​pay_later_optionsobject(Pay Later Options)
checkout_settings.​restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

checkout_settings.​special_instructionsstring(Special Instructions)

Instructions shown to the user

checkout_settings.​use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether to use pro forma invoices when user elects to pay later

default_fund_idstring(Default Fund)required

The default fund that a gift should be allocated to when the user makes an non-targeted gift

donor_instructionsstring(Donor Instructions)

Instructions shown to donors on the giving form

enable_gift_receiptboolean(Enable Gift Receipt)

Enable confirmation email for submitted gift forms

enable_pledge_receiptboolean(Enable Pledge Receipt)

Enable confirmation email for submitted pledge forms

enable_premiumsboolean(Enable Premiums)

If set, premiums are automatically assigned with gifts

gift_receiptobject(Gift Receipt)required

The confirmation email for submitted gift forms

gift_receipt.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

gift_receipt.​bodystring(Body)required

The email body

gift_receipt.​ccstring(Cc)

Anyone that should be cc'ed on the email

gift_receipt.​fromstring(From)

From email address

gift_receipt.​from_namestring(From Name)

From name

gift_receipt.​reply_tostring(Reply To)

The reply to

gift_receipt.​subjectstring(Subject)required

The email subject

idstring(ID)^[\w|-]+$required

The unique, string identifier of this application process

is_activeboolean(Is Active)

Whether or not this process is active

namestring(Name)required

The name of the application process

new_donor_contact_optionsobject(New Donor Contact Options)

The fields that should show for new contacts being created in the portal during the contribution process

override_checkout_settingsboolean(Override Checkout Settings)

Whether or not to override POC settings

pledge_installment_plansArray of objectsnon-emptyrequired
pledge_installment_plans[].​installment_plan_idstring(Installment Plan)required

The installment plan

pledge_installment_plans[].​namestring(Name)required

The description of the installment plan to be shown to the user

pledge_receiptobject(Pledge Receipt)required

The confirmation email for submitted pledge forms

pledge_receipt.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

pledge_receipt.​bodystring(Body)required

The email body

pledge_receipt.​ccstring(Cc)

Anyone that should be cc'ed on the email

pledge_receipt.​fromstring(From)

From email address

pledge_receipt.​from_namestring(From Name)

From name

pledge_receipt.​reply_tostring(Reply To)

The reply to

pledge_receipt.​subjectstring(Subject)required

The email subject

pledges_generate_pro_forma_invoicesboolean(Pledges Generate Pro Forma Invoices)

If true, pledges will generate pro forma (not real) invoices

premium_rulesArray of objectsrequired
premium_rules[].​gift_amount_range_endnumber(float)(Gift Amount Range End)

The ending range

premium_rules[].​gift_amount_range_startnumber(float)(Gift Amount Range Start)

The starting range for the premium rule

premium_rules[].​premium_idstring(Premium)required

The premium

premium_shipping_method_idstring(Premium Shipping Method)required

The shipping method to use for premiums

recurring_gift_optionsobject(Recurring Gift Options)required
recurring_gift_options.​allow_donor_to_specify_end_dateboolean(Allow Donor To Specify End Date)

If set, the user can indicate when they want the gifts to end

recurring_gift_options.​enable_annuallyboolean(Enable Annually)

If set, donors can have annual recurring gifts

recurring_gift_options.​enable_monthlyboolean(Enable Monthly)

If set, donors can have monthly recurring gifts

recurring_gift_options.​enable_quarterlyboolean(Enable Quarterly)

If set, donors can have quarterly recurring gifts

require_acknowledgementboolean(Require Acknowledgement)

If set, donors must acknowledge a checkbox before proceeding

show_campaign_progressboolean(Show Campaign Progress)

If set, then the campaign in use for the giving form will show progress at the time of giving

suggest_giving_amountsboolean(Suggest Giving Amounts)

If true, giving amounts are suggested; otherwise, the donor is free to enter their own

suggested_gift_amountnumber(float)(Suggested Gift Amount)

The suggested amount of given, set by default

suggested_giving_amountsArray of numbers(float)(Suggested Giving Amounts)[ 1 .. 10 ] itemsrequired
sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

targeted_givingstring(Targeted Giving)required

Whether targeted giving is enabled for this process

Enum"disabled""specify multiple funds""specify single fund"
targeted_giving_optionsobject(Targeted Giving Options)
tribute_gift_optionsobject(Tribute Gift Options)required
tribute_gift_options.​email_notificationEmail Notification (object)(Email Notification)

The templated email to send to honorees

One of:

The templated email to send to honorees

tribute_gift_options.​honoree_notificationstring(Honoree Notification)
Enum"disabled""email""email or mail""mail"
Response
application/json
{ "acknowledgement_settings": { "checkbox_text": "string", "html": "string" }, "allow_anonymous_gifts": true, "allow_pledges": true, "allow_recurring_gifts": true, "allow_tribute_gifts": true, "appeal_id": "string", "campaign_id": "string", "checkout_settings": { "allow_customer_to_choose_installment_plan": true, "bank_account_id": "string", "bill_my_organization_options": {}, "bill_my_parent_organization_options": {}, "business_unit_id": "string", "cancellation_fee_product_id": "string", "checkout_donation_options": {}, "credit_card_minimum_range_end": 0.1, "credit_card_minimum_range_start": 0.1, "credit_card_mode": "disabled", "credit_card_processing_fee_mode": "charge", "credit_card_processing_fee_options": {}, "disable_electronic_payment_vaulting": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_split_payments": true, "installment_plan_options": {}, "invoice_payment_terms_id": "string", "invoice_template_id": "string", "merchant_account_id": "string", "pay_later_options": {}, "restocking_fee_product_id": "string", "special_instructions": "string", "use_pro_forma_invoices": true }, "default_fund_id": "string", "donor_instructions": "string", "enable_gift_receipt": true, "enable_pledge_receipt": true, "enable_premiums": true, "gift_receipt": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "id": "string", "is_active": true, "name": "string", "new_donor_contact_options": {}, "override_checkout_settings": true, "pledge_installment_plans": [ {} ], "pledge_receipt": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "pledges_generate_pro_forma_invoices": true, "premium_rules": [ {} ], "premium_shipping_method_id": "string", "recurring_gift_options": { "allow_donor_to_specify_end_date": true, "enable_annually": true, "enable_monthly": true, "enable_quarterly": true }, "require_acknowledgement": true, "show_campaign_progress": true, "suggest_giving_amounts": true, "suggested_gift_amount": 0.1, "suggested_giving_amounts": [ 1 ], "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ {} ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "targeted_giving": "disabled", "targeted_giving_options": { "restrict_to_fund_categories": true, "restrict_to_fund_types": true, "restrict_to_funds": true, "restricted_fund_category_ids": {}, "restricted_fund_ids": {}, "restricted_fund_types": {} }, "tribute_gift_options": { "email_notification": {}, "honoree_notification": "disabled" } }

Execute Batch Operations

Request

TAllows you to perform up to 100 parallel patch/delete operations

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The batch request

operationsArray of objects
curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/givingProcesses/{tenantId}/batch' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "operations": [
      {
        "id": null,
        "object": {},
        "operation": "create",
        "patch_directives": {
          "0": {
            "op": "add",
            "path": "string",
            "value": "string"
          }
        }
      }
    ]
  }'

Responses

Request completed successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
error_countnumber(float)(Error Count)

Number of error results

resultsArray of objects
success_countnumber(float)(Success Count)

Number of successful results

Response
application/json
{ "error_count": 0.1, "results": [ {} ], "success_count": 0.1 }

Gets all of the processes a contact/org is eligible to use

Request

Path
tenantIdstringrequired

The id of the tenant being accessed

customerTypestringrequired

The contact or organization type

Enum"contact""organization"
contactOrOrganizationIdstringrequired

The contact or organization id

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/givingProcesses/{tenantId}/eligible/{customerType}/{contactOrOrganizationId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Processes were retrieved successfully

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/jsonArray [
acknowledgement_settingsobject(Acknowledgement Settings)required
acknowledgement_settings.​checkbox_textstring(Checkbox Text)required

The value to show on the textbox label

acknowledgement_settings.​htmlstring(Html)

HTML to show

allow_anonymous_giftsboolean(Allow Anonymous Gifts)

If true, anonymous gifts are allowed

allow_pledgesboolean(Allow Pledges)

Whether pledges are allowed in this process

allow_recurring_giftsboolean(Allow Recurring Gifts)

Whether recurring gifts are allowed in this process

allow_tribute_giftsboolean(Allow Tribute Gifts)

If set, donors are able to donor in honor of/in memory of

appeal_idstring(Appeal)

The appeal to which gifts given in this process should be associated

campaign_idstring(Campaign)

The campaign to which gifts given in this process should be associated

checkout_settingsobject(Checkout Settings)required
checkout_settings.​allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

checkout_settings.​bank_account_idstring(Bank Account)required

The default bank account that the store should use to receive payments

checkout_settings.​bill_my_organization_optionsobject(Bill My Organization Options)
checkout_settings.​bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)
checkout_settings.​business_unit_idstring(Business Unit)required

The business unit of the store

checkout_settings.​cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

checkout_settings.​checkout_donation_optionsCheckout Donation Options (object)(Checkout Donation Options)
One of:
checkout_settings.​credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

If set, the maximum amount for which credit cards can be taken

checkout_settings.​credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

If set, the minimum amount for which credit cards can be taken

checkout_settings.​credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"
checkout_settings.​credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"
checkout_settings.​credit_card_processing_fee_optionsCredit Card Processing Fee Options (object)(Credit Card Processing Fee Options)
One of:
checkout_settings.​disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

If set, in the portal people are not allowed to save credit cards

checkout_settings.​enable_bill_my_organizationboolean(Enable Bill My Organization)

If set, the user has the option to bill their organization

checkout_settings.​enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

If set, the user has the option to bill their organization's parent organization

checkout_settings.​enable_donations_at_checkoutboolean(Enable Donations At Checkout)

If selected, users will be prompted to make a donation upon checking out

checkout_settings.​enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

checkout_settings.​enable_pay_laterboolean(Enable Pay Later)

If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed

checkout_settings.​enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

checkout_settings.​enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

checkout_settings.​installment_plan_optionsArray of objectsnon-empty
One of:
non-empty
checkout_settings.​invoice_payment_terms_idstring(Invoice Payment Terms)

The payment terms for invoices; if left blank, default is used

checkout_settings.​invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

checkout_settings.​merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

checkout_settings.​pay_later_optionsobject(Pay Later Options)
checkout_settings.​restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

checkout_settings.​special_instructionsstring(Special Instructions)

Instructions shown to the user

checkout_settings.​use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether to use pro forma invoices when user elects to pay later

default_fund_idstring(Default Fund)required

The default fund that a gift should be allocated to when the user makes an non-targeted gift

donor_instructionsstring(Donor Instructions)

Instructions shown to donors on the giving form

enable_gift_receiptboolean(Enable Gift Receipt)

Enable confirmation email for submitted gift forms

enable_pledge_receiptboolean(Enable Pledge Receipt)

Enable confirmation email for submitted pledge forms

enable_premiumsboolean(Enable Premiums)

If set, premiums are automatically assigned with gifts

gift_receiptobject(Gift Receipt)required

The confirmation email for submitted gift forms

gift_receipt.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

gift_receipt.​bodystring(Body)required

The email body

gift_receipt.​ccstring(Cc)

Anyone that should be cc'ed on the email

gift_receipt.​fromstring(From)

From email address

gift_receipt.​from_namestring(From Name)

From name

gift_receipt.​reply_tostring(Reply To)

The reply to

gift_receipt.​subjectstring(Subject)required

The email subject

idstring(ID)^[\w|-]+$required

The unique, string identifier of this application process

is_activeboolean(Is Active)

Whether or not this process is active

namestring(Name)required

The name of the application process

new_donor_contact_optionsobject(New Donor Contact Options)

The fields that should show for new contacts being created in the portal during the contribution process

override_checkout_settingsboolean(Override Checkout Settings)

Whether or not to override POC settings

pledge_installment_plansArray of objectsnon-emptyrequired
pledge_installment_plans[].​installment_plan_idstring(Installment Plan)required

The installment plan

pledge_installment_plans[].​namestring(Name)required

The description of the installment plan to be shown to the user

pledge_receiptobject(Pledge Receipt)required

The confirmation email for submitted pledge forms

pledge_receipt.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

pledge_receipt.​bodystring(Body)required

The email body

pledge_receipt.​ccstring(Cc)

Anyone that should be cc'ed on the email

pledge_receipt.​fromstring(From)

From email address

pledge_receipt.​from_namestring(From Name)

From name

pledge_receipt.​reply_tostring(Reply To)

The reply to

pledge_receipt.​subjectstring(Subject)required

The email subject

pledges_generate_pro_forma_invoicesboolean(Pledges Generate Pro Forma Invoices)

If true, pledges will generate pro forma (not real) invoices

premium_rulesArray of objectsrequired
premium_rules[].​gift_amount_range_endnumber(float)(Gift Amount Range End)

The ending range

premium_rules[].​gift_amount_range_startnumber(float)(Gift Amount Range Start)

The starting range for the premium rule

premium_rules[].​premium_idstring(Premium)required

The premium

premium_shipping_method_idstring(Premium Shipping Method)required

The shipping method to use for premiums

recurring_gift_optionsobject(Recurring Gift Options)required
recurring_gift_options.​allow_donor_to_specify_end_dateboolean(Allow Donor To Specify End Date)

If set, the user can indicate when they want the gifts to end

recurring_gift_options.​enable_annuallyboolean(Enable Annually)

If set, donors can have annual recurring gifts

recurring_gift_options.​enable_monthlyboolean(Enable Monthly)

If set, donors can have monthly recurring gifts

recurring_gift_options.​enable_quarterlyboolean(Enable Quarterly)

If set, donors can have quarterly recurring gifts

require_acknowledgementboolean(Require Acknowledgement)

If set, donors must acknowledge a checkbox before proceeding

show_campaign_progressboolean(Show Campaign Progress)

If set, then the campaign in use for the giving form will show progress at the time of giving

suggest_giving_amountsboolean(Suggest Giving Amounts)

If true, giving amounts are suggested; otherwise, the donor is free to enter their own

suggested_gift_amountnumber(float)(Suggested Gift Amount)

The suggested amount of given, set by default

suggested_giving_amountsArray of numbers(float)(Suggested Giving Amounts)[ 1 .. 10 ] itemsrequired
sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

targeted_givingstring(Targeted Giving)required

Whether targeted giving is enabled for this process

Enum"disabled""specify multiple funds""specify single fund"
targeted_giving_optionsobject(Targeted Giving Options)
tribute_gift_optionsobject(Tribute Gift Options)required
tribute_gift_options.​email_notificationEmail Notification (object)(Email Notification)

The templated email to send to honorees

One of:

The templated email to send to honorees

tribute_gift_options.​honoree_notificationstring(Honoree Notification)
Enum"disabled""email""email or mail""mail"
]
Response
application/json
[ { "acknowledgement_settings": {}, "allow_anonymous_gifts": true, "allow_pledges": true, "allow_recurring_gifts": true, "allow_tribute_gifts": true, "appeal_id": "string", "campaign_id": "string", "checkout_settings": {}, "default_fund_id": "string", "donor_instructions": "string", "enable_gift_receipt": true, "enable_pledge_receipt": true, "enable_premiums": true, "gift_receipt": {}, "id": "string", "is_active": true, "name": "string", "new_donor_contact_options": {}, "override_checkout_settings": true, "pledge_installment_plans": [], "pledge_receipt": {}, "pledges_generate_pro_forma_invoices": true, "premium_rules": [], "premium_shipping_method_id": "string", "recurring_gift_options": {}, "require_acknowledgement": true, "show_campaign_progress": true, "suggest_giving_amounts": true, "suggested_gift_amount": 0.1, "suggested_giving_amounts": [], "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "targeted_giving": "disabled", "targeted_giving_options": {}, "tribute_gift_options": {} } ]

Returns a giving process from the system by its ID.

Request

This method will delete a giving process with the specified ID.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the giving process to delete.

curl -i -X DELETE \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/givingProcesses/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The giving process was deleted successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
string
Response
application/json
"string"

Returns a giving process from the system by its ID.

Request

This method will look up a giving process by the specified ID and return it back.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the giving process to return.

Query
fieldsstring

The fields that you want to retrieve; if omitted, the entire object is returned.

consistentReadstring

Indicates the API should force a consistent read on the data source.

curl -i -X GET \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/givingProcesses/{tenantId}/{id}?consistentRead=string&fields=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

The giving process was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
acknowledgement_settingsobject(Acknowledgement Settings)required
acknowledgement_settings.​checkbox_textstring(Checkbox Text)required

The value to show on the textbox label

acknowledgement_settings.​htmlstring(Html)

HTML to show

allow_anonymous_giftsboolean(Allow Anonymous Gifts)

If true, anonymous gifts are allowed

allow_pledgesboolean(Allow Pledges)

Whether pledges are allowed in this process

allow_recurring_giftsboolean(Allow Recurring Gifts)

Whether recurring gifts are allowed in this process

allow_tribute_giftsboolean(Allow Tribute Gifts)

If set, donors are able to donor in honor of/in memory of

appeal_idstring(Appeal)

The appeal to which gifts given in this process should be associated

campaign_idstring(Campaign)

The campaign to which gifts given in this process should be associated

checkout_settingsobject(Checkout Settings)required
checkout_settings.​allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

checkout_settings.​bank_account_idstring(Bank Account)required

The default bank account that the store should use to receive payments

checkout_settings.​bill_my_organization_optionsobject(Bill My Organization Options)
checkout_settings.​bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)
checkout_settings.​business_unit_idstring(Business Unit)required

The business unit of the store

checkout_settings.​cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

checkout_settings.​checkout_donation_optionsCheckout Donation Options (object)(Checkout Donation Options)
One of:
checkout_settings.​credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

If set, the maximum amount for which credit cards can be taken

checkout_settings.​credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

If set, the minimum amount for which credit cards can be taken

checkout_settings.​credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"
checkout_settings.​credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"
checkout_settings.​credit_card_processing_fee_optionsCredit Card Processing Fee Options (object)(Credit Card Processing Fee Options)
One of:
checkout_settings.​disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

If set, in the portal people are not allowed to save credit cards

checkout_settings.​enable_bill_my_organizationboolean(Enable Bill My Organization)

If set, the user has the option to bill their organization

checkout_settings.​enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

If set, the user has the option to bill their organization's parent organization

checkout_settings.​enable_donations_at_checkoutboolean(Enable Donations At Checkout)

If selected, users will be prompted to make a donation upon checking out

checkout_settings.​enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

checkout_settings.​enable_pay_laterboolean(Enable Pay Later)

If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed

checkout_settings.​enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

checkout_settings.​enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

checkout_settings.​installment_plan_optionsArray of objectsnon-empty
One of:
non-empty
checkout_settings.​invoice_payment_terms_idstring(Invoice Payment Terms)

The payment terms for invoices; if left blank, default is used

checkout_settings.​invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

checkout_settings.​merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

checkout_settings.​pay_later_optionsobject(Pay Later Options)
checkout_settings.​restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

checkout_settings.​special_instructionsstring(Special Instructions)

Instructions shown to the user

checkout_settings.​use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether to use pro forma invoices when user elects to pay later

default_fund_idstring(Default Fund)required

The default fund that a gift should be allocated to when the user makes an non-targeted gift

donor_instructionsstring(Donor Instructions)

Instructions shown to donors on the giving form

enable_gift_receiptboolean(Enable Gift Receipt)

Enable confirmation email for submitted gift forms

enable_pledge_receiptboolean(Enable Pledge Receipt)

Enable confirmation email for submitted pledge forms

enable_premiumsboolean(Enable Premiums)

If set, premiums are automatically assigned with gifts

gift_receiptobject(Gift Receipt)required

The confirmation email for submitted gift forms

gift_receipt.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

gift_receipt.​bodystring(Body)required

The email body

gift_receipt.​ccstring(Cc)

Anyone that should be cc'ed on the email

gift_receipt.​fromstring(From)

From email address

gift_receipt.​from_namestring(From Name)

From name

gift_receipt.​reply_tostring(Reply To)

The reply to

gift_receipt.​subjectstring(Subject)required

The email subject

idstring(ID)^[\w|-]+$required

The unique, string identifier of this application process

is_activeboolean(Is Active)

Whether or not this process is active

namestring(Name)required

The name of the application process

new_donor_contact_optionsobject(New Donor Contact Options)

The fields that should show for new contacts being created in the portal during the contribution process

override_checkout_settingsboolean(Override Checkout Settings)

Whether or not to override POC settings

pledge_installment_plansArray of objectsnon-emptyrequired
pledge_installment_plans[].​installment_plan_idstring(Installment Plan)required

The installment plan

pledge_installment_plans[].​namestring(Name)required

The description of the installment plan to be shown to the user

pledge_receiptobject(Pledge Receipt)required

The confirmation email for submitted pledge forms

pledge_receipt.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

pledge_receipt.​bodystring(Body)required

The email body

pledge_receipt.​ccstring(Cc)

Anyone that should be cc'ed on the email

pledge_receipt.​fromstring(From)

From email address

pledge_receipt.​from_namestring(From Name)

From name

pledge_receipt.​reply_tostring(Reply To)

The reply to

pledge_receipt.​subjectstring(Subject)required

The email subject

pledges_generate_pro_forma_invoicesboolean(Pledges Generate Pro Forma Invoices)

If true, pledges will generate pro forma (not real) invoices

premium_rulesArray of objectsrequired
premium_rules[].​gift_amount_range_endnumber(float)(Gift Amount Range End)

The ending range

premium_rules[].​gift_amount_range_startnumber(float)(Gift Amount Range Start)

The starting range for the premium rule

premium_rules[].​premium_idstring(Premium)required

The premium

premium_shipping_method_idstring(Premium Shipping Method)required

The shipping method to use for premiums

recurring_gift_optionsobject(Recurring Gift Options)required
recurring_gift_options.​allow_donor_to_specify_end_dateboolean(Allow Donor To Specify End Date)

If set, the user can indicate when they want the gifts to end

recurring_gift_options.​enable_annuallyboolean(Enable Annually)

If set, donors can have annual recurring gifts

recurring_gift_options.​enable_monthlyboolean(Enable Monthly)

If set, donors can have monthly recurring gifts

recurring_gift_options.​enable_quarterlyboolean(Enable Quarterly)

If set, donors can have quarterly recurring gifts

require_acknowledgementboolean(Require Acknowledgement)

If set, donors must acknowledge a checkbox before proceeding

show_campaign_progressboolean(Show Campaign Progress)

If set, then the campaign in use for the giving form will show progress at the time of giving

suggest_giving_amountsboolean(Suggest Giving Amounts)

If true, giving amounts are suggested; otherwise, the donor is free to enter their own

suggested_gift_amountnumber(float)(Suggested Gift Amount)

The suggested amount of given, set by default

suggested_giving_amountsArray of numbers(float)(Suggested Giving Amounts)[ 1 .. 10 ] itemsrequired
sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

targeted_givingstring(Targeted Giving)required

Whether targeted giving is enabled for this process

Enum"disabled""specify multiple funds""specify single fund"
targeted_giving_optionsobject(Targeted Giving Options)
tribute_gift_optionsobject(Tribute Gift Options)required
tribute_gift_options.​email_notificationEmail Notification (object)(Email Notification)

The templated email to send to honorees

One of:

The templated email to send to honorees

tribute_gift_options.​honoree_notificationstring(Honoree Notification)
Enum"disabled""email""email or mail""mail"
Response
application/json
{ "acknowledgement_settings": { "checkbox_text": "string", "html": "string" }, "allow_anonymous_gifts": true, "allow_pledges": true, "allow_recurring_gifts": true, "allow_tribute_gifts": true, "appeal_id": "string", "campaign_id": "string", "checkout_settings": { "allow_customer_to_choose_installment_plan": true, "bank_account_id": "string", "bill_my_organization_options": {}, "bill_my_parent_organization_options": {}, "business_unit_id": "string", "cancellation_fee_product_id": "string", "checkout_donation_options": {}, "credit_card_minimum_range_end": 0.1, "credit_card_minimum_range_start": 0.1, "credit_card_mode": "disabled", "credit_card_processing_fee_mode": "charge", "credit_card_processing_fee_options": {}, "disable_electronic_payment_vaulting": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_split_payments": true, "installment_plan_options": {}, "invoice_payment_terms_id": "string", "invoice_template_id": "string", "merchant_account_id": "string", "pay_later_options": {}, "restocking_fee_product_id": "string", "special_instructions": "string", "use_pro_forma_invoices": true }, "default_fund_id": "string", "donor_instructions": "string", "enable_gift_receipt": true, "enable_pledge_receipt": true, "enable_premiums": true, "gift_receipt": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "id": "string", "is_active": true, "name": "string", "new_donor_contact_options": {}, "override_checkout_settings": true, "pledge_installment_plans": [ {} ], "pledge_receipt": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "pledges_generate_pro_forma_invoices": true, "premium_rules": [ {} ], "premium_shipping_method_id": "string", "recurring_gift_options": { "allow_donor_to_specify_end_date": true, "enable_annually": true, "enable_monthly": true, "enable_quarterly": true }, "require_acknowledgement": true, "show_campaign_progress": true, "suggest_giving_amounts": true, "suggested_gift_amount": 0.1, "suggested_giving_amounts": [ 1 ], "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ {} ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "targeted_giving": "disabled", "targeted_giving_options": { "restrict_to_fund_categories": true, "restrict_to_fund_types": true, "restrict_to_funds": true, "restricted_fund_category_ids": {}, "restricted_fund_ids": {}, "restricted_fund_types": {} }, "tribute_gift_options": { "email_notification": {}, "honoree_notification": "disabled" } }

Partially updates a giving process with the specified ID.

Request

This method will patch an existing giving process with the specified ID, using the HTTP PATCH specification.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the giving process to patch.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [
opstring(Op)required

The operation

Enum"add""copy""move""remove""replace""test"
pathstring(Path)required

The JSON path

valuestring(Value)

The updated value

]
curl -i -X PATCH \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/givingProcesses/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '[
    {
      "op": "add",
      "path": "string",
      "value": "string"
    }
  ]'

Responses

The giving process was patched successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
acknowledgement_settingsobject(Acknowledgement Settings)required
acknowledgement_settings.​checkbox_textstring(Checkbox Text)required

The value to show on the textbox label

acknowledgement_settings.​htmlstring(Html)

HTML to show

allow_anonymous_giftsboolean(Allow Anonymous Gifts)

If true, anonymous gifts are allowed

allow_pledgesboolean(Allow Pledges)

Whether pledges are allowed in this process

allow_recurring_giftsboolean(Allow Recurring Gifts)

Whether recurring gifts are allowed in this process

allow_tribute_giftsboolean(Allow Tribute Gifts)

If set, donors are able to donor in honor of/in memory of

appeal_idstring(Appeal)

The appeal to which gifts given in this process should be associated

campaign_idstring(Campaign)

The campaign to which gifts given in this process should be associated

checkout_settingsobject(Checkout Settings)required
checkout_settings.​allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

checkout_settings.​bank_account_idstring(Bank Account)required

The default bank account that the store should use to receive payments

checkout_settings.​bill_my_organization_optionsobject(Bill My Organization Options)
checkout_settings.​bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)
checkout_settings.​business_unit_idstring(Business Unit)required

The business unit of the store

checkout_settings.​cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

checkout_settings.​checkout_donation_optionsCheckout Donation Options (object)(Checkout Donation Options)
One of:
checkout_settings.​credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

If set, the maximum amount for which credit cards can be taken

checkout_settings.​credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

If set, the minimum amount for which credit cards can be taken

checkout_settings.​credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"
checkout_settings.​credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"
checkout_settings.​credit_card_processing_fee_optionsCredit Card Processing Fee Options (object)(Credit Card Processing Fee Options)
One of:
checkout_settings.​disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

If set, in the portal people are not allowed to save credit cards

checkout_settings.​enable_bill_my_organizationboolean(Enable Bill My Organization)

If set, the user has the option to bill their organization

checkout_settings.​enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

If set, the user has the option to bill their organization's parent organization

checkout_settings.​enable_donations_at_checkoutboolean(Enable Donations At Checkout)

If selected, users will be prompted to make a donation upon checking out

checkout_settings.​enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

checkout_settings.​enable_pay_laterboolean(Enable Pay Later)

If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed

checkout_settings.​enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

checkout_settings.​enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

checkout_settings.​installment_plan_optionsArray of objectsnon-empty
One of:
non-empty
checkout_settings.​invoice_payment_terms_idstring(Invoice Payment Terms)

The payment terms for invoices; if left blank, default is used

checkout_settings.​invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

checkout_settings.​merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

checkout_settings.​pay_later_optionsobject(Pay Later Options)
checkout_settings.​restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

checkout_settings.​special_instructionsstring(Special Instructions)

Instructions shown to the user

checkout_settings.​use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether to use pro forma invoices when user elects to pay later

default_fund_idstring(Default Fund)required

The default fund that a gift should be allocated to when the user makes an non-targeted gift

donor_instructionsstring(Donor Instructions)

Instructions shown to donors on the giving form

enable_gift_receiptboolean(Enable Gift Receipt)

Enable confirmation email for submitted gift forms

enable_pledge_receiptboolean(Enable Pledge Receipt)

Enable confirmation email for submitted pledge forms

enable_premiumsboolean(Enable Premiums)

If set, premiums are automatically assigned with gifts

gift_receiptobject(Gift Receipt)required

The confirmation email for submitted gift forms

gift_receipt.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

gift_receipt.​bodystring(Body)required

The email body

gift_receipt.​ccstring(Cc)

Anyone that should be cc'ed on the email

gift_receipt.​fromstring(From)

From email address

gift_receipt.​from_namestring(From Name)

From name

gift_receipt.​reply_tostring(Reply To)

The reply to

gift_receipt.​subjectstring(Subject)required

The email subject

idstring(ID)^[\w|-]+$required

The unique, string identifier of this application process

is_activeboolean(Is Active)

Whether or not this process is active

namestring(Name)required

The name of the application process

new_donor_contact_optionsobject(New Donor Contact Options)

The fields that should show for new contacts being created in the portal during the contribution process

override_checkout_settingsboolean(Override Checkout Settings)

Whether or not to override POC settings

pledge_installment_plansArray of objectsnon-emptyrequired
pledge_installment_plans[].​installment_plan_idstring(Installment Plan)required

The installment plan

pledge_installment_plans[].​namestring(Name)required

The description of the installment plan to be shown to the user

pledge_receiptobject(Pledge Receipt)required

The confirmation email for submitted pledge forms

pledge_receipt.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

pledge_receipt.​bodystring(Body)required

The email body

pledge_receipt.​ccstring(Cc)

Anyone that should be cc'ed on the email

pledge_receipt.​fromstring(From)

From email address

pledge_receipt.​from_namestring(From Name)

From name

pledge_receipt.​reply_tostring(Reply To)

The reply to

pledge_receipt.​subjectstring(Subject)required

The email subject

pledges_generate_pro_forma_invoicesboolean(Pledges Generate Pro Forma Invoices)

If true, pledges will generate pro forma (not real) invoices

premium_rulesArray of objectsrequired
premium_rules[].​gift_amount_range_endnumber(float)(Gift Amount Range End)

The ending range

premium_rules[].​gift_amount_range_startnumber(float)(Gift Amount Range Start)

The starting range for the premium rule

premium_rules[].​premium_idstring(Premium)required

The premium

premium_shipping_method_idstring(Premium Shipping Method)required

The shipping method to use for premiums

recurring_gift_optionsobject(Recurring Gift Options)required
recurring_gift_options.​allow_donor_to_specify_end_dateboolean(Allow Donor To Specify End Date)

If set, the user can indicate when they want the gifts to end

recurring_gift_options.​enable_annuallyboolean(Enable Annually)

If set, donors can have annual recurring gifts

recurring_gift_options.​enable_monthlyboolean(Enable Monthly)

If set, donors can have monthly recurring gifts

recurring_gift_options.​enable_quarterlyboolean(Enable Quarterly)

If set, donors can have quarterly recurring gifts

require_acknowledgementboolean(Require Acknowledgement)

If set, donors must acknowledge a checkbox before proceeding

show_campaign_progressboolean(Show Campaign Progress)

If set, then the campaign in use for the giving form will show progress at the time of giving

suggest_giving_amountsboolean(Suggest Giving Amounts)

If true, giving amounts are suggested; otherwise, the donor is free to enter their own

suggested_gift_amountnumber(float)(Suggested Gift Amount)

The suggested amount of given, set by default

suggested_giving_amountsArray of numbers(float)(Suggested Giving Amounts)[ 1 .. 10 ] itemsrequired
sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

targeted_givingstring(Targeted Giving)required

Whether targeted giving is enabled for this process

Enum"disabled""specify multiple funds""specify single fund"
targeted_giving_optionsobject(Targeted Giving Options)
tribute_gift_optionsobject(Tribute Gift Options)required
tribute_gift_options.​email_notificationEmail Notification (object)(Email Notification)

The templated email to send to honorees

One of:

The templated email to send to honorees

tribute_gift_options.​honoree_notificationstring(Honoree Notification)
Enum"disabled""email""email or mail""mail"
Response
application/json
{ "acknowledgement_settings": { "checkbox_text": "string", "html": "string" }, "allow_anonymous_gifts": true, "allow_pledges": true, "allow_recurring_gifts": true, "allow_tribute_gifts": true, "appeal_id": "string", "campaign_id": "string", "checkout_settings": { "allow_customer_to_choose_installment_plan": true, "bank_account_id": "string", "bill_my_organization_options": {}, "bill_my_parent_organization_options": {}, "business_unit_id": "string", "cancellation_fee_product_id": "string", "checkout_donation_options": {}, "credit_card_minimum_range_end": 0.1, "credit_card_minimum_range_start": 0.1, "credit_card_mode": "disabled", "credit_card_processing_fee_mode": "charge", "credit_card_processing_fee_options": {}, "disable_electronic_payment_vaulting": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_split_payments": true, "installment_plan_options": {}, "invoice_payment_terms_id": "string", "invoice_template_id": "string", "merchant_account_id": "string", "pay_later_options": {}, "restocking_fee_product_id": "string", "special_instructions": "string", "use_pro_forma_invoices": true }, "default_fund_id": "string", "donor_instructions": "string", "enable_gift_receipt": true, "enable_pledge_receipt": true, "enable_premiums": true, "gift_receipt": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "id": "string", "is_active": true, "name": "string", "new_donor_contact_options": {}, "override_checkout_settings": true, "pledge_installment_plans": [ {} ], "pledge_receipt": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "pledges_generate_pro_forma_invoices": true, "premium_rules": [ {} ], "premium_shipping_method_id": "string", "recurring_gift_options": { "allow_donor_to_specify_end_date": true, "enable_annually": true, "enable_monthly": true, "enable_quarterly": true }, "require_acknowledgement": true, "show_campaign_progress": true, "suggest_giving_amounts": true, "suggested_gift_amount": 0.1, "suggested_giving_amounts": [ 1 ], "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ {} ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "targeted_giving": "disabled", "targeted_giving_options": { "restrict_to_fund_categories": true, "restrict_to_fund_types": true, "restrict_to_funds": true, "restricted_fund_category_ids": {}, "restricted_fund_ids": {}, "restricted_fund_types": {} }, "tribute_gift_options": { "email_notification": {}, "honoree_notification": "disabled" } }

Updates a giving process with the specified ID.

Request

This method will update an existing giving process with the specified ID.

Path
tenantIdstringrequired

The id of the tenant being accessed.

idstringrequired

The ID of the giving process to update.

Bodyapplication/jsonrequired

The updated giving process that will be saved.

acknowledgement_settingsobject(Acknowledgement Settings)required
acknowledgement_settings.​checkbox_textstring(Checkbox Text)required

The value to show on the textbox label

acknowledgement_settings.​htmlstring(Html)

HTML to show

allow_anonymous_giftsboolean(Allow Anonymous Gifts)

If true, anonymous gifts are allowed

allow_pledgesboolean(Allow Pledges)

Whether pledges are allowed in this process

allow_recurring_giftsboolean(Allow Recurring Gifts)

Whether recurring gifts are allowed in this process

allow_tribute_giftsboolean(Allow Tribute Gifts)

If set, donors are able to donor in honor of/in memory of

appeal_idstring(Appeal)

The appeal to which gifts given in this process should be associated

campaign_idstring(Campaign)

The campaign to which gifts given in this process should be associated

checkout_settingsobject(Checkout Settings)required
checkout_settings.​allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

checkout_settings.​bank_account_idstring(Bank Account)required

The default bank account that the store should use to receive payments

checkout_settings.​bill_my_organization_optionsobject(Bill My Organization Options)
checkout_settings.​bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)
checkout_settings.​business_unit_idstring(Business Unit)required

The business unit of the store

checkout_settings.​cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

checkout_settings.​checkout_donation_optionsCheckout Donation Options (object)(Checkout Donation Options)
One of:
checkout_settings.​credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

If set, the maximum amount for which credit cards can be taken

checkout_settings.​credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

If set, the minimum amount for which credit cards can be taken

checkout_settings.​credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"
checkout_settings.​credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"
checkout_settings.​credit_card_processing_fee_optionsCredit Card Processing Fee Options (object)(Credit Card Processing Fee Options)
One of:
checkout_settings.​disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

If set, in the portal people are not allowed to save credit cards

checkout_settings.​enable_bill_my_organizationboolean(Enable Bill My Organization)

If set, the user has the option to bill their organization

checkout_settings.​enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

If set, the user has the option to bill their organization's parent organization

checkout_settings.​enable_donations_at_checkoutboolean(Enable Donations At Checkout)

If selected, users will be prompted to make a donation upon checking out

checkout_settings.​enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

checkout_settings.​enable_pay_laterboolean(Enable Pay Later)

If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed

checkout_settings.​enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

checkout_settings.​enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

checkout_settings.​installment_plan_optionsArray of objectsnon-empty
One of:
non-empty
checkout_settings.​invoice_payment_terms_idstring(Invoice Payment Terms)

The payment terms for invoices; if left blank, default is used

checkout_settings.​invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

checkout_settings.​merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

checkout_settings.​pay_later_optionsobject(Pay Later Options)
checkout_settings.​restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

checkout_settings.​special_instructionsstring(Special Instructions)

Instructions shown to the user

checkout_settings.​use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether to use pro forma invoices when user elects to pay later

default_fund_idstring(Default Fund)required

The default fund that a gift should be allocated to when the user makes an non-targeted gift

donor_instructionsstring(Donor Instructions)

Instructions shown to donors on the giving form

enable_gift_receiptboolean(Enable Gift Receipt)

Enable confirmation email for submitted gift forms

enable_pledge_receiptboolean(Enable Pledge Receipt)

Enable confirmation email for submitted pledge forms

enable_premiumsboolean(Enable Premiums)

If set, premiums are automatically assigned with gifts

gift_receiptobject(Gift Receipt)required

The confirmation email for submitted gift forms

gift_receipt.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

gift_receipt.​bodystring(Body)required

The email body

gift_receipt.​ccstring(Cc)

Anyone that should be cc'ed on the email

gift_receipt.​fromstring(From)

From email address

gift_receipt.​from_namestring(From Name)

From name

gift_receipt.​reply_tostring(Reply To)

The reply to

gift_receipt.​subjectstring(Subject)required

The email subject

idstring(ID)^[\w|-]+$required

The unique, string identifier of this application process

is_activeboolean(Is Active)

Whether or not this process is active

namestring(Name)required

The name of the application process

new_donor_contact_optionsobject(New Donor Contact Options)

The fields that should show for new contacts being created in the portal during the contribution process

override_checkout_settingsboolean(Override Checkout Settings)

Whether or not to override POC settings

pledge_installment_plansArray of objectsnon-emptyrequired
pledge_installment_plans[].​installment_plan_idstring(Installment Plan)required

The installment plan

pledge_installment_plans[].​namestring(Name)required

The description of the installment plan to be shown to the user

pledge_receiptobject(Pledge Receipt)required

The confirmation email for submitted pledge forms

pledge_receipt.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

pledge_receipt.​bodystring(Body)required

The email body

pledge_receipt.​ccstring(Cc)

Anyone that should be cc'ed on the email

pledge_receipt.​fromstring(From)

From email address

pledge_receipt.​from_namestring(From Name)

From name

pledge_receipt.​reply_tostring(Reply To)

The reply to

pledge_receipt.​subjectstring(Subject)required

The email subject

pledges_generate_pro_forma_invoicesboolean(Pledges Generate Pro Forma Invoices)

If true, pledges will generate pro forma (not real) invoices

premium_rulesArray of objectsrequired
premium_rules[].​gift_amount_range_endnumber(float)(Gift Amount Range End)

The ending range

premium_rules[].​gift_amount_range_startnumber(float)(Gift Amount Range Start)

The starting range for the premium rule

premium_rules[].​premium_idstring(Premium)required

The premium

premium_shipping_method_idstring(Premium Shipping Method)required

The shipping method to use for premiums

recurring_gift_optionsobject(Recurring Gift Options)required
recurring_gift_options.​allow_donor_to_specify_end_dateboolean(Allow Donor To Specify End Date)

If set, the user can indicate when they want the gifts to end

recurring_gift_options.​enable_annuallyboolean(Enable Annually)

If set, donors can have annual recurring gifts

recurring_gift_options.​enable_monthlyboolean(Enable Monthly)

If set, donors can have monthly recurring gifts

recurring_gift_options.​enable_quarterlyboolean(Enable Quarterly)

If set, donors can have quarterly recurring gifts

require_acknowledgementboolean(Require Acknowledgement)

If set, donors must acknowledge a checkbox before proceeding

show_campaign_progressboolean(Show Campaign Progress)

If set, then the campaign in use for the giving form will show progress at the time of giving

suggest_giving_amountsboolean(Suggest Giving Amounts)

If true, giving amounts are suggested; otherwise, the donor is free to enter their own

suggested_gift_amountnumber(float)(Suggested Gift Amount)

The suggested amount of given, set by default

suggested_giving_amountsArray of numbers(float)(Suggested Giving Amounts)[ 1 .. 10 ] itemsrequired
sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

targeted_givingstring(Targeted Giving)required

Whether targeted giving is enabled for this process

Enum"disabled""specify multiple funds""specify single fund"
targeted_giving_optionsobject(Targeted Giving Options)
tribute_gift_optionsobject(Tribute Gift Options)required
tribute_gift_options.​email_notificationEmail Notification (object)(Email Notification)

The templated email to send to honorees

One of:

The templated email to send to honorees

tribute_gift_options.​honoree_notificationstring(Honoree Notification)
Enum"disabled""email""email or mail""mail"
curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/fundraising/fundraising-v1/givingProcesses/{tenantId}/{id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "acknowledgement_settings": {
      "checkbox_text": "string",
      "html": "string"
    },
    "allow_anonymous_gifts": true,
    "allow_pledges": true,
    "allow_recurring_gifts": true,
    "allow_tribute_gifts": true,
    "appeal_id": "string",
    "campaign_id": "string",
    "checkout_settings": {
      "allow_customer_to_choose_installment_plan": true,
      "bank_account_id": "string",
      "bill_my_organization_options": {
        "billing_address": "do not show",
        "purchase_order_number": "do not show",
        "reference_number": "string"
      },
      "bill_my_parent_organization_options": {
        "billing_address": "do not show",
        "purchase_order_number": "do not show",
        "reference_number": "string"
      },
      "business_unit_id": "string",
      "cancellation_fee_product_id": "string",
      "checkout_donation_options": {
        "simple_checkout_donation_options": {
          "allow_user_to_specify_custom_amount": true,
          "donation_ask_text": "string",
          "donation_denominations": [
            0.1
          ],
          "donation_information": "string",
          "donation_product_id": "string",
          "override_donation_denominations": true,
          "suggested_donation": 0.1
        },
        "type": "simple"
      },
      "credit_card_minimum_range_end": 0.1,
      "credit_card_minimum_range_start": 0.1,
      "credit_card_mode": "disabled",
      "credit_card_processing_fee_mode": "charge",
      "credit_card_processing_fee_options": {
        "fee_percentage": 0.1,
        "maximum_fee": 0.1,
        "minimum_fee": 0.1,
        "product_id": "string",
        "prompt_sub_text": "string",
        "prompt_text": "string"
      },
      "disable_electronic_payment_vaulting": true,
      "enable_bill_my_organization": true,
      "enable_bill_my_parent_organization": true,
      "enable_donations_at_checkout": true,
      "enable_electronic_checks": true,
      "enable_pay_later": true,
      "enable_payroll_deduction": true,
      "enable_split_payments": true,
      "installment_plan_options": {
        "0": {
          "additional_cost": 0.1,
          "installment_plan_id": "string",
          "is_default": true
        }
      },
      "invoice_payment_terms_id": "string",
      "invoice_template_id": "string",
      "merchant_account_id": "string",
      "pay_later_options": {
        "billing_address": "do not show",
        "purchase_order_number": "do not show",
        "reference_number": "string"
      },
      "restocking_fee_product_id": "string",
      "special_instructions": "string",
      "use_pro_forma_invoices": true
    },
    "default_fund_id": "string",
    "donor_instructions": "string",
    "enable_gift_receipt": true,
    "enable_pledge_receipt": true,
    "enable_premiums": true,
    "gift_receipt": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "id": "string",
    "is_active": true,
    "name": "string",
    "new_donor_contact_options": {},
    "override_checkout_settings": true,
    "pledge_installment_plans": [
      {
        "installment_plan_id": "string",
        "name": "string"
      }
    ],
    "pledge_receipt": {
      "bcc": "string",
      "body": "string",
      "cc": "string",
      "from": "string",
      "from_name": "string",
      "reply_to": "string",
      "subject": "string"
    },
    "pledges_generate_pro_forma_invoices": true,
    "premium_rules": [
      {
        "gift_amount_range_end": 0.1,
        "gift_amount_range_start": 0.1,
        "premium_id": "string"
      }
    ],
    "premium_shipping_method_id": "string",
    "recurring_gift_options": {
      "allow_donor_to_specify_end_date": true,
      "enable_annually": true,
      "enable_monthly": true,
      "enable_quarterly": true
    },
    "require_acknowledgement": true,
    "show_campaign_progress": true,
    "suggest_giving_amounts": true,
    "suggested_gift_amount": 0.1,
    "suggested_giving_amounts": [
      1
    ],
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "targeted_giving": "disabled",
    "targeted_giving_options": {
      "restrict_to_fund_categories": true,
      "restrict_to_fund_types": true,
      "restrict_to_funds": true,
      "restricted_fund_category_ids": {
        "0": "string"
      },
      "restricted_fund_ids": {
        "0": "string"
      },
      "restricted_fund_types": {
        "0": "restricted funds"
      }
    },
    "tribute_gift_options": {
      "email_notification": {
        "bcc": "string",
        "body": "string",
        "cc": "string",
        "from": "string",
        "from_name": "string",
        "reply_to": "string",
        "subject": "string"
      },
      "honoree_notification": "disabled"
    }
  }'

Responses

The giving process was updated successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
acknowledgement_settingsobject(Acknowledgement Settings)required
acknowledgement_settings.​checkbox_textstring(Checkbox Text)required

The value to show on the textbox label

acknowledgement_settings.​htmlstring(Html)

HTML to show

allow_anonymous_giftsboolean(Allow Anonymous Gifts)

If true, anonymous gifts are allowed

allow_pledgesboolean(Allow Pledges)

Whether pledges are allowed in this process

allow_recurring_giftsboolean(Allow Recurring Gifts)

Whether recurring gifts are allowed in this process

allow_tribute_giftsboolean(Allow Tribute Gifts)

If set, donors are able to donor in honor of/in memory of

appeal_idstring(Appeal)

The appeal to which gifts given in this process should be associated

campaign_idstring(Campaign)

The campaign to which gifts given in this process should be associated

checkout_settingsobject(Checkout Settings)required
checkout_settings.​allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

checkout_settings.​bank_account_idstring(Bank Account)required

The default bank account that the store should use to receive payments

checkout_settings.​bill_my_organization_optionsobject(Bill My Organization Options)
checkout_settings.​bill_my_parent_organization_optionsobject(Bill My Parent Organization Options)
checkout_settings.​business_unit_idstring(Business Unit)required

The business unit of the store

checkout_settings.​cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

checkout_settings.​checkout_donation_optionsCheckout Donation Options (object)(Checkout Donation Options)
One of:
checkout_settings.​credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

If set, the maximum amount for which credit cards can be taken

checkout_settings.​credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

If set, the minimum amount for which credit cards can be taken

checkout_settings.​credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

Enum"disabled""enabled""range"
checkout_settings.​credit_card_processing_fee_modestring(Credit Card Processing Fee Mode)

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"
checkout_settings.​credit_card_processing_fee_optionsCredit Card Processing Fee Options (object)(Credit Card Processing Fee Options)
One of:
checkout_settings.​disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

If set, in the portal people are not allowed to save credit cards

checkout_settings.​enable_bill_my_organizationboolean(Enable Bill My Organization)

If set, the user has the option to bill their organization

checkout_settings.​enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

If set, the user has the option to bill their organization's parent organization

checkout_settings.​enable_donations_at_checkoutboolean(Enable Donations At Checkout)

If selected, users will be prompted to make a donation upon checking out

checkout_settings.​enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

checkout_settings.​enable_pay_laterboolean(Enable Pay Later)

If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed

checkout_settings.​enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

checkout_settings.​enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

checkout_settings.​installment_plan_optionsArray of objectsnon-empty
One of:
non-empty
checkout_settings.​invoice_payment_terms_idstring(Invoice Payment Terms)

The payment terms for invoices; if left blank, default is used

checkout_settings.​invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

checkout_settings.​merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

checkout_settings.​pay_later_optionsobject(Pay Later Options)
checkout_settings.​restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

checkout_settings.​special_instructionsstring(Special Instructions)

Instructions shown to the user

checkout_settings.​use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

Whether to use pro forma invoices when user elects to pay later

default_fund_idstring(Default Fund)required

The default fund that a gift should be allocated to when the user makes an non-targeted gift

donor_instructionsstring(Donor Instructions)

Instructions shown to donors on the giving form

enable_gift_receiptboolean(Enable Gift Receipt)

Enable confirmation email for submitted gift forms

enable_pledge_receiptboolean(Enable Pledge Receipt)

Enable confirmation email for submitted pledge forms

enable_premiumsboolean(Enable Premiums)

If set, premiums are automatically assigned with gifts

gift_receiptobject(Gift Receipt)required

The confirmation email for submitted gift forms

gift_receipt.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

gift_receipt.​bodystring(Body)required

The email body

gift_receipt.​ccstring(Cc)

Anyone that should be cc'ed on the email

gift_receipt.​fromstring(From)

From email address

gift_receipt.​from_namestring(From Name)

From name

gift_receipt.​reply_tostring(Reply To)

The reply to

gift_receipt.​subjectstring(Subject)required

The email subject

idstring(ID)^[\w|-]+$required

The unique, string identifier of this application process

is_activeboolean(Is Active)

Whether or not this process is active

namestring(Name)required

The name of the application process

new_donor_contact_optionsobject(New Donor Contact Options)

The fields that should show for new contacts being created in the portal during the contribution process

override_checkout_settingsboolean(Override Checkout Settings)

Whether or not to override POC settings

pledge_installment_plansArray of objectsnon-emptyrequired
pledge_installment_plans[].​installment_plan_idstring(Installment Plan)required

The installment plan

pledge_installment_plans[].​namestring(Name)required

The description of the installment plan to be shown to the user

pledge_receiptobject(Pledge Receipt)required

The confirmation email for submitted pledge forms

pledge_receipt.​bccstring(Bcc)

Anyone that should be bcc'ed on the email

pledge_receipt.​bodystring(Body)required

The email body

pledge_receipt.​ccstring(Cc)

Anyone that should be cc'ed on the email

pledge_receipt.​fromstring(From)

From email address

pledge_receipt.​from_namestring(From Name)

From name

pledge_receipt.​reply_tostring(Reply To)

The reply to

pledge_receipt.​subjectstring(Subject)required

The email subject

pledges_generate_pro_forma_invoicesboolean(Pledges Generate Pro Forma Invoices)

If true, pledges will generate pro forma (not real) invoices

premium_rulesArray of objectsrequired
premium_rules[].​gift_amount_range_endnumber(float)(Gift Amount Range End)

The ending range

premium_rules[].​gift_amount_range_startnumber(float)(Gift Amount Range Start)

The starting range for the premium rule

premium_rules[].​premium_idstring(Premium)required

The premium

premium_shipping_method_idstring(Premium Shipping Method)required

The shipping method to use for premiums

recurring_gift_optionsobject(Recurring Gift Options)required
recurring_gift_options.​allow_donor_to_specify_end_dateboolean(Allow Donor To Specify End Date)

If set, the user can indicate when they want the gifts to end

recurring_gift_options.​enable_annuallyboolean(Enable Annually)

If set, donors can have annual recurring gifts

recurring_gift_options.​enable_monthlyboolean(Enable Monthly)

If set, donors can have monthly recurring gifts

recurring_gift_options.​enable_quarterlyboolean(Enable Quarterly)

If set, donors can have quarterly recurring gifts

require_acknowledgementboolean(Require Acknowledgement)

If set, donors must acknowledge a checkbox before proceeding

show_campaign_progressboolean(Show Campaign Progress)

If set, then the campaign in use for the giving form will show progress at the time of giving

suggest_giving_amountsboolean(Suggest Giving Amounts)

If true, giving amounts are suggested; otherwise, the donor is free to enter their own

suggested_gift_amountnumber(float)(Suggested Gift Amount)

The suggested amount of given, set by default

suggested_giving_amountsArray of numbers(float)(Suggested Giving Amounts)[ 1 .. 10 ] itemsrequired
sys_bulk_load_atstring(Sys Bulk Load At)

If this record was loaded via bulk, the timestamp when the record was processed

sys_bulk_load_idstring(Sys Bulk Load)

If this record was loaded via bulk, the ID of the bulk load process

sys_bulk_load_pkstring(Sys Bulk Load Pk)

If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

If this record was loaded via bulk, the record number in the source file

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

If a snapshot was restored/applies to this record, the ID of the snapshot

sys_created_atstring(date-time)(Sys Created At)required

The date/time that this record was created, expressed in ISO-8601 date format

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

The ID of the user that deleted (or last tried to delete) this object

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

The ID that a record has from an external system or data import

sys_has_files_in_s3boolean(Sys Has Files In S3)

If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

If this record was last touched by a bulk data operation, the ID of that operation

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

If this record was last touched by a bulk data operation, the sys_version at the time of that operation

sys_last_modified_atstring(date-time)(Sys Last Modified At)required

The date/time that this record record was last modified, expressed in ISO-8601 date format

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

The security context of the last insert, modify, or delete performed on this item

sys_lockedboolean(Sys Locked)

If set, this record is locked and cannot be changed via the API

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

targeted_givingstring(Targeted Giving)required

Whether targeted giving is enabled for this process

Enum"disabled""specify multiple funds""specify single fund"
targeted_giving_optionsobject(Targeted Giving Options)
tribute_gift_optionsobject(Tribute Gift Options)required
tribute_gift_options.​email_notificationEmail Notification (object)(Email Notification)

The templated email to send to honorees

One of:

The templated email to send to honorees

tribute_gift_options.​honoree_notificationstring(Honoree Notification)
Enum"disabled""email""email or mail""mail"
Response
application/json
{ "acknowledgement_settings": { "checkbox_text": "string", "html": "string" }, "allow_anonymous_gifts": true, "allow_pledges": true, "allow_recurring_gifts": true, "allow_tribute_gifts": true, "appeal_id": "string", "campaign_id": "string", "checkout_settings": { "allow_customer_to_choose_installment_plan": true, "bank_account_id": "string", "bill_my_organization_options": {}, "bill_my_parent_organization_options": {}, "business_unit_id": "string", "cancellation_fee_product_id": "string", "checkout_donation_options": {}, "credit_card_minimum_range_end": 0.1, "credit_card_minimum_range_start": 0.1, "credit_card_mode": "disabled", "credit_card_processing_fee_mode": "charge", "credit_card_processing_fee_options": {}, "disable_electronic_payment_vaulting": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_split_payments": true, "installment_plan_options": {}, "invoice_payment_terms_id": "string", "invoice_template_id": "string", "merchant_account_id": "string", "pay_later_options": {}, "restocking_fee_product_id": "string", "special_instructions": "string", "use_pro_forma_invoices": true }, "default_fund_id": "string", "donor_instructions": "string", "enable_gift_receipt": true, "enable_pledge_receipt": true, "enable_premiums": true, "gift_receipt": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "id": "string", "is_active": true, "name": "string", "new_donor_contact_options": {}, "override_checkout_settings": true, "pledge_installment_plans": [ {} ], "pledge_receipt": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "pledges_generate_pro_forma_invoices": true, "premium_rules": [ {} ], "premium_shipping_method_id": "string", "recurring_gift_options": { "allow_donor_to_specify_end_date": true, "enable_annually": true, "enable_monthly": true, "enable_quarterly": true }, "require_acknowledgement": true, "show_campaign_progress": true, "suggest_giving_amounts": true, "suggested_gift_amount": 0.1, "suggested_giving_amounts": [ 1 ], "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ {} ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "targeted_giving": "disabled", "targeted_giving_options": { "restrict_to_fund_categories": true, "restrict_to_fund_types": true, "restrict_to_funds": true, "restricted_fund_category_ids": {}, "restricted_fund_ids": {}, "restricted_fund_types": {} }, "tribute_gift_options": { "email_notification": {}, "honoree_notification": "disabled" } }

Pledge Levels

Pledge Levels

Operations

Pledge Notices

Pledge Notices

Operations

Pledges

Pledges

Operations

Premiums

Premiums

Operations

Products

Products

Operations

Query Definitions

Query Definitions

Operations

Recurring Gifts

Recurring Gifts

Operations

Settings

Settings

Operations

Statistics

Statistics

Operations