Giving Processes

Giving Processes

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

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.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The giving process that you would like to be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this application process

name
required
string (Name)

The name of the application process

show_campaign_progress
boolean (Show Campaign Progress)

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

suggest_giving_amounts
boolean (Suggest Giving Amounts)

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

suggested_giving_amounts
required
Array of numbers <float> (Suggested Giving Amounts) [ 1 .. 10 ] items
suggested_gift_amount
number <float> (Suggested Gift Amount)

The suggested amount of given, set by default

default_fund_id
required
string (Default Fund)

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

campaign_id
string (Campaign)

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

appeal_id
string (Appeal)

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

new_donor_contact_options
object (New Donor Contact Options)

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

allow_tribute_gifts
boolean (Allow Tribute Gifts)

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

allow_anonymous_gifts
boolean (Allow Anonymous Gifts)

If true, anonymous gifts are allowed

required
object (Tribute Gift Options)
targeted_giving
required
string (Targeted Giving)

Whether targeted giving is enabled for this process

Enum: "disabled" "specify single fund" "specify multiple funds"
object (Targeted Giving Options)
enable_premiums
boolean (Enable Premiums)

If set, premiums are automatically assigned with gifts

required
Array of objects
premium_shipping_method_id
required
string (Premium Shipping Method)

The shipping method to use for premiums

donor_instructions
string (Donor Instructions)

Instructions shown to donors on the giving form

allow_pledges
boolean (Allow Pledges)

Whether pledges are allowed in this process

pledges_generate_pro_forma_invoices
boolean (Pledges Generate Pro Forma Invoices)

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

required
Array of objects non-empty
allow_recurring_gifts
boolean (Allow Recurring Gifts)

Whether recurring gifts are allowed in this process

required
object (Recurring Gift Options)
override_checkout_settings
boolean (Override Checkout Settings)

Whether or not to override POC settings

required
object (Checkout Settings)
enable_gift_receipt
boolean (Enable Gift Receipt)

Enable confirmation email for submitted gift forms

required
object (Gift Receipt)

The confirmation email for submitted gift forms

enable_pledge_receipt
boolean (Enable Pledge Receipt)

Enable confirmation email for submitted pledge forms

required
object (Pledge Receipt)

The confirmation email for submitted pledge forms

is_active
boolean (Is Active)

Whether or not this process is active

sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (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_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (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_version
string (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_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <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_has_files_in_s3
boolean (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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Array of objects
Responses
200The giving process was saved successfully.
400The giving process you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The giving process could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add giving process based on tenant limits.
500General server error.
post/givingProcesses/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "show_campaign_progress": true,
  • "suggest_giving_amounts": true,
  • "suggested_giving_amounts": [
    ],
  • "suggested_gift_amount": 0,
  • "default_fund_id": "string",
  • "campaign_id": "string",
  • "appeal_id": "string",
  • "new_donor_contact_options": { },
  • "allow_tribute_gifts": true,
  • "allow_anonymous_gifts": true,
  • "tribute_gift_options": {
    },
  • "targeted_giving": "disabled",
  • "targeted_giving_options": {
    },
  • "enable_premiums": true,
  • "premium_rules": [
    ],
  • "premium_shipping_method_id": "string",
  • "donor_instructions": "string",
  • "allow_pledges": true,
  • "pledges_generate_pro_forma_invoices": true,
  • "pledge_installment_plans": [
    ],
  • "allow_recurring_gifts": true,
  • "recurring_gift_options": {
    },
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_gift_receipt": true,
  • "gift_receipt": {
    },
  • "enable_pledge_receipt": true,
  • "pledge_receipt": {
    },
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "show_campaign_progress": true,
  • "suggest_giving_amounts": true,
  • "suggested_giving_amounts": [
    ],
  • "suggested_gift_amount": 0,
  • "default_fund_id": "string",
  • "campaign_id": "string",
  • "appeal_id": "string",
  • "new_donor_contact_options": { },
  • "allow_tribute_gifts": true,
  • "allow_anonymous_gifts": true,
  • "tribute_gift_options": {
    },
  • "targeted_giving": "disabled",
  • "targeted_giving_options": {
    },
  • "enable_premiums": true,
  • "premium_rules": [
    ],
  • "premium_shipping_method_id": "string",
  • "donor_instructions": "string",
  • "allow_pledges": true,
  • "pledges_generate_pro_forma_invoices": true,
  • "pledge_installment_plans": [
    ],
  • "allow_recurring_gifts": true,
  • "recurring_gift_options": {
    },
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_gift_receipt": true,
  • "gift_receipt": {
    },
  • "enable_pledge_receipt": true,
  • "pledge_receipt": {
    },
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Gets all of the giving processes in the system.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
fields
string

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

exclusiveStartKey
string

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

Responses
200The giving processeswere retrieved successfully.
400The request was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
429Limit exceeded... unable to add contact role based on tenant limits.
500General server error.
get/givingProcesses/{tenantId}
Request samples
curl -i -X GET \
  'https://fundraising.api.756794052567.rhythmsoftware.com/givingProcesses/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Returns a giving process from the system by its ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the giving process to return.

query Parameters
fields
string

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

consistentRead
string

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

Responses
200The giving process was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The giving process could not be found.
429Limit exceeded... unable to retrieve giving process based on tenant limits.
500General server error.
get/givingProcesses/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://fundraising.api.756794052567.rhythmsoftware.com/givingProcesses/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "show_campaign_progress": true,
  • "suggest_giving_amounts": true,
  • "suggested_giving_amounts": [
    ],
  • "suggested_gift_amount": 0,
  • "default_fund_id": "string",
  • "campaign_id": "string",
  • "appeal_id": "string",
  • "new_donor_contact_options": { },
  • "allow_tribute_gifts": true,
  • "allow_anonymous_gifts": true,
  • "tribute_gift_options": {
    },
  • "targeted_giving": "disabled",
  • "targeted_giving_options": {
    },
  • "enable_premiums": true,
  • "premium_rules": [
    ],
  • "premium_shipping_method_id": "string",
  • "donor_instructions": "string",
  • "allow_pledges": true,
  • "pledges_generate_pro_forma_invoices": true,
  • "pledge_installment_plans": [
    ],
  • "allow_recurring_gifts": true,
  • "recurring_gift_options": {
    },
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_gift_receipt": true,
  • "gift_receipt": {
    },
  • "enable_pledge_receipt": true,
  • "pledge_receipt": {
    },
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Updates a giving process with the specified ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the giving process to update.

Request Body schema: application/json

The updated giving process that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this application process

name
required
string (Name)

The name of the application process

show_campaign_progress
boolean (Show Campaign Progress)

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

suggest_giving_amounts
boolean (Suggest Giving Amounts)

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

suggested_giving_amounts
required
Array of numbers <float> (Suggested Giving Amounts) [ 1 .. 10 ] items
suggested_gift_amount
number <float> (Suggested Gift Amount)

The suggested amount of given, set by default

default_fund_id
required
string (Default Fund)

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

campaign_id
string (Campaign)

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

appeal_id
string (Appeal)

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

new_donor_contact_options
object (New Donor Contact Options)

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

allow_tribute_gifts
boolean (Allow Tribute Gifts)

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

allow_anonymous_gifts
boolean (Allow Anonymous Gifts)

If true, anonymous gifts are allowed

required
object (Tribute Gift Options)
targeted_giving
required
string (Targeted Giving)

Whether targeted giving is enabled for this process

Enum: "disabled" "specify single fund" "specify multiple funds"
object (Targeted Giving Options)
enable_premiums
boolean (Enable Premiums)

If set, premiums are automatically assigned with gifts

required
Array of objects
premium_shipping_method_id
required
string (Premium Shipping Method)

The shipping method to use for premiums

donor_instructions
string (Donor Instructions)

Instructions shown to donors on the giving form

allow_pledges
boolean (Allow Pledges)

Whether pledges are allowed in this process

pledges_generate_pro_forma_invoices
boolean (Pledges Generate Pro Forma Invoices)

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

required
Array of objects non-empty
allow_recurring_gifts
boolean (Allow Recurring Gifts)

Whether recurring gifts are allowed in this process

required
object (Recurring Gift Options)
override_checkout_settings
boolean (Override Checkout Settings)

Whether or not to override POC settings

required
object (Checkout Settings)
enable_gift_receipt
boolean (Enable Gift Receipt)

Enable confirmation email for submitted gift forms

required
object (Gift Receipt)

The confirmation email for submitted gift forms

enable_pledge_receipt
boolean (Enable Pledge Receipt)

Enable confirmation email for submitted pledge forms

required
object (Pledge Receipt)

The confirmation email for submitted pledge forms

is_active
boolean (Is Active)

Whether or not this process is active

sys_deleted_by_id
string (Sys Deleted By)

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

sys_version
number <float> (Sys Version)

A number representing the version of this record in the database

sys_created_at
required
string <date-time> (Sys Created At)

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

sys_last_modified_at
required
string <date-time> (Sys Last Modified At)

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

sys_created_by_id
required
string (Sys Created By)

The ID of the user that created this record

sys_last_modified_by_id
required
string (Sys Last Modified By)

The ID of the user that last modified this record

sys_external_id
string (Sys External)

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

sys_locked
boolean (Sys Locked)

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

sys_bulk_load_pk
string (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_at
string (Sys Bulk Load At)

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

sys_bulk_load_id
string (Sys Bulk Load)

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

sys_bulk_load_record_no
number <float> (Sys Bulk Load Record No)

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

sys_bulk_load_source_file
string (Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_last_bulk_data_operation_id
string (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_version
string (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_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

sys_calculated_field_error
string (Sys Calculated Field Error)

The error associated with the calculated field

sys_snapshot_base_version
number <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_has_files_in_s3
boolean (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_configuration_snapshot_id
string (Sys Configuration Snapshot)

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

sys_last_security_context
object (Sys Last Security Context)

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

Array of objects
Responses
200The giving process was updated successfully.
400The giving process supplied was not valid.
401Unauthorized.
403Forbidden.
404The giving process could not be found.
409The giving process could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve giving process based on tenant limits.
500General server error.
put/givingProcesses/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "show_campaign_progress": true,
  • "suggest_giving_amounts": true,
  • "suggested_giving_amounts": [
    ],
  • "suggested_gift_amount": 0,
  • "default_fund_id": "string",
  • "campaign_id": "string",
  • "appeal_id": "string",
  • "new_donor_contact_options": { },
  • "allow_tribute_gifts": true,
  • "allow_anonymous_gifts": true,
  • "tribute_gift_options": {
    },
  • "targeted_giving": "disabled",
  • "targeted_giving_options": {
    },
  • "enable_premiums": true,
  • "premium_rules": [
    ],
  • "premium_shipping_method_id": "string",
  • "donor_instructions": "string",
  • "allow_pledges": true,
  • "pledges_generate_pro_forma_invoices": true,
  • "pledge_installment_plans": [
    ],
  • "allow_recurring_gifts": true,
  • "recurring_gift_options": {
    },
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_gift_receipt": true,
  • "gift_receipt": {
    },
  • "enable_pledge_receipt": true,
  • "pledge_receipt": {
    },
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "show_campaign_progress": true,
  • "suggest_giving_amounts": true,
  • "suggested_giving_amounts": [
    ],
  • "suggested_gift_amount": 0,
  • "default_fund_id": "string",
  • "campaign_id": "string",
  • "appeal_id": "string",
  • "new_donor_contact_options": { },
  • "allow_tribute_gifts": true,
  • "allow_anonymous_gifts": true,
  • "tribute_gift_options": {
    },
  • "targeted_giving": "disabled",
  • "targeted_giving_options": {
    },
  • "enable_premiums": true,
  • "premium_rules": [
    ],
  • "premium_shipping_method_id": "string",
  • "donor_instructions": "string",
  • "allow_pledges": true,
  • "pledges_generate_pro_forma_invoices": true,
  • "pledge_installment_plans": [
    ],
  • "allow_recurring_gifts": true,
  • "recurring_gift_options": {
    },
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_gift_receipt": true,
  • "gift_receipt": {
    },
  • "enable_pledge_receipt": true,
  • "pledge_receipt": {
    },
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Partially updates a giving process with the specified ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the giving process to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array
op
required
string (Op)

The operation

Enum: "add" "remove" "replace" "move" "copy" "test"
path
required
string (Path)

The JSON path

value
string (Value)

The updated value

Responses
200The giving process was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The giving process could not be found.
409The giving process could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve giving process based on tenant limits.
500General server error.
patch/givingProcesses/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "show_campaign_progress": true,
  • "suggest_giving_amounts": true,
  • "suggested_giving_amounts": [
    ],
  • "suggested_gift_amount": 0,
  • "default_fund_id": "string",
  • "campaign_id": "string",
  • "appeal_id": "string",
  • "new_donor_contact_options": { },
  • "allow_tribute_gifts": true,
  • "allow_anonymous_gifts": true,
  • "tribute_gift_options": {
    },
  • "targeted_giving": "disabled",
  • "targeted_giving_options": {
    },
  • "enable_premiums": true,
  • "premium_rules": [
    ],
  • "premium_shipping_method_id": "string",
  • "donor_instructions": "string",
  • "allow_pledges": true,
  • "pledges_generate_pro_forma_invoices": true,
  • "pledge_installment_plans": [
    ],
  • "allow_recurring_gifts": true,
  • "recurring_gift_options": {
    },
  • "override_checkout_settings": true,
  • "checkout_settings": {
    },
  • "enable_gift_receipt": true,
  • "gift_receipt": {
    },
  • "enable_pledge_receipt": true,
  • "pledge_receipt": {
    },
  • "is_active": true,
  • "sys_deleted_by_id": "string",
  • "sys_version": 0,
  • "sys_created_at": "2019-08-24T14:15:22Z",
  • "sys_last_modified_at": "2019-08-24T14:15:22Z",
  • "sys_created_by_id": "string",
  • "sys_last_modified_by_id": "string",
  • "sys_external_id": "string",
  • "sys_locked": true,
  • "sys_bulk_load_pk": "string",
  • "sys_bulk_load_at": "string",
  • "sys_bulk_load_id": "string",
  • "sys_bulk_load_record_no": 0,
  • "sys_bulk_load_source_file": "string",
  • "sys_last_bulk_data_operation_id": "string",
  • "sys_last_bulk_data_operation_sys_version": "string",
  • "sys_directive": "string",
  • "sys_calculated_field_error": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_has_files_in_s3": true,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { },
  • "sys_calculated_field_errors": [
    ]
}

Returns a giving process from the system by its ID.

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the giving process to delete.

Responses
200The giving process was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The giving process could not be found.
409The giving process could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete giving process based on tenant limits.
500General server error.
delete/givingProcesses/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://fundraising.api.756794052567.rhythmsoftware.com/givingProcesses/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

customerType
required
string

The contact or organization type

Enum: "contact" "organization"
contactOrOrganizationId
required
string

The contact or organization id

Responses
200Processes were retrieved successfully
400The request was not valid
401Unauthorized
403Forbidden
404The resource could not be found
429Request limit exceeded... please try your request again in a few seconds
500An internal server error occured.
get/givingProcesses/{tenantId}/eligible/{customerType}/{contactOrOrganizationId}
Request samples
curl -i -X GET \
  https://fundraising.api.756794052567.rhythmsoftware.com/givingProcesses/:tenantId/eligible/:customerType/:contactOrOrganizationId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Execute Batch Operations

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

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects
Responses
200Request completed successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The giving process could not be found.
429Limit exceeded... unable to retrieve giving process based on tenant limits.
500General server error.
post/givingProcesses/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}