# 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. Endpoint: POST /givingProcesses/{tenantId} Version: v1-2025-04-18 Security: knox-authorizer ## Path parameters: - `tenantId` (string, required) The id of the tenant being accessed. ## Request fields (application/json): - `acknowledgement_settings` (object, required) - `acknowledgement_settings.checkbox_text` (string, required) The value to show on the textbox label - `acknowledgement_settings.html` (string) HTML to show - `allow_anonymous_gifts` (boolean) If true, anonymous gifts are allowed - `allow_pledges` (boolean) Whether pledges are allowed in this process - `allow_recurring_gifts` (boolean) Whether recurring gifts are allowed in this process - `allow_tribute_gifts` (boolean) If set, donors are able to donor in honor of/in memory of - `appeal_id` (string) The appeal to which gifts given in this process should be associated - `campaign_id` (string) The campaign to which gifts given in this process should be associated - `checkout_settings` (object, required) - `checkout_settings.allow_customer_to_choose_installment_plan` (boolean) If true, the customer can choose their installment plan - `checkout_settings.bank_account_id` (string, required) The default bank account that the store should use to receive payments - `checkout_settings.bill_my_organization_options` (object) - `checkout_settings.bill_my_organization_options.billing_address` (string) Enum: "do not show", "optional", "required" - `checkout_settings.bill_my_organization_options.purchase_order_number` (string) Enum: "do not show", "optional", "required" - `checkout_settings.bill_my_organization_options.reference_number` (string) The reference # - `checkout_settings.bill_my_parent_organization_options` (object) - `checkout_settings.business_unit_id` (string, required) The business unit of the store - `checkout_settings.cancellation_fee_product_id` (string) The ID of the product used for cancellation fees - `checkout_settings.checkout_donation_options` (object) - `checkout_settings.checkout_donation_options.simple_checkout_donation_options` (object) - `checkout_settings.checkout_donation_options.simple_checkout_donation_options.allow_user_to_specify_custom_amount` (boolean) If set, the user can specify their own custom donation - `checkout_settings.checkout_donation_options.simple_checkout_donation_options.donation_ask_text` (string) The text shown to the user when making the donation - `checkout_settings.checkout_donation_options.simple_checkout_donation_options.donation_denominations` (array) - `checkout_settings.checkout_donation_options.simple_checkout_donation_options.donation_information` (string) Additional information about the donation - `checkout_settings.checkout_donation_options.simple_checkout_donation_options.donation_product_id` (string, required) The misc product that should be used - `checkout_settings.checkout_donation_options.simple_checkout_donation_options.override_donation_denominations` (boolean) If set, donation denominations are specified here and the defaults are not used - `checkout_settings.checkout_donation_options.simple_checkout_donation_options.suggested_donation` (number) A suggested donation - `checkout_settings.checkout_donation_options.type` (string) Enum: "simple" - `checkout_settings.credit_card_minimum_range_end` (number) If set, the maximum amount for which credit cards can be taken - `checkout_settings.credit_card_minimum_range_start` (number) If set, the minimum amount for which credit cards can be taken - `checkout_settings.credit_card_mode` (string) Determines whether or not credit cards are accepted Enum: "disabled", "enabled", "range" - `checkout_settings.credit_card_processing_fee_mode` (string) Determines how credit card processing fees should be handled Enum: "charge", "do not charge", "prompt user" - `checkout_settings.credit_card_processing_fee_options` (object) - `checkout_settings.credit_card_processing_fee_options.fee_percentage` (number, required) The fee percentage to charge for credit card processing - `checkout_settings.credit_card_processing_fee_options.maximum_fee` (number) The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged - `checkout_settings.credit_card_processing_fee_options.minimum_fee` (number) The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged - `checkout_settings.credit_card_processing_fee_options.product_id` (string, required) The misc product to use for the credit card processing - `checkout_settings.credit_card_processing_fee_options.prompt_sub_text` (string) Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used - `checkout_settings.credit_card_processing_fee_options.prompt_text` (string) The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used - `checkout_settings.disable_electronic_payment_vaulting` (boolean) If set, in the portal people are not allowed to save credit cards - `checkout_settings.enable_bill_my_organization` (boolean) If set, the user has the option to bill their organization - `checkout_settings.enable_bill_my_parent_organization` (boolean) If set, the user has the option to bill their organization's parent organization - `checkout_settings.enable_donations_at_checkout` (boolean) If selected, users will be prompted to make a donation upon checking out - `checkout_settings.enable_electronic_checks` (boolean) If set, electronic checks are allowed - `checkout_settings.enable_pay_later` (boolean) If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed - `checkout_settings.enable_payroll_deduction` (boolean) If set, payroll deduction is allowed - `checkout_settings.enable_split_payments` (boolean) If set, users are allowed to split payments - `checkout_settings.installment_plan_options` (array) - `checkout_settings.invoice_payment_terms_id` (string) The payment terms for invoices; if left blank, default is used - `checkout_settings.invoice_template_id` (string) The template to use for invoices created during this process - `checkout_settings.merchant_account_id` (string, required) The merchant account that the store should use to receive payments - `checkout_settings.pay_later_options` (object) - `checkout_settings.restocking_fee_product_id` (string) The ID of the product used for restocking fees - `checkout_settings.special_instructions` (string) Instructions shown to the user - `checkout_settings.use_pro_forma_invoices` (boolean) Whether to use pro forma invoices when user elects to pay later - `default_fund_id` (string, required) The default fund that a gift should be allocated to when the user makes an non-targeted gift - `donor_instructions` (string) Instructions shown to donors on the giving form - `enable_gift_receipt` (boolean) Enable confirmation email for submitted gift forms - `enable_pledge_receipt` (boolean) Enable confirmation email for submitted pledge forms - `enable_premiums` (boolean) If set, premiums are automatically assigned with gifts - `gift_receipt` (object, required) The confirmation email for submitted gift forms - `gift_receipt.bcc` (string) Anyone that should be bcc'ed on the email - `gift_receipt.body` (string, required) The email body - `gift_receipt.cc` (string) Anyone that should be cc'ed on the email - `gift_receipt.from` (string) From email address - `gift_receipt.from_name` (string) From name - `gift_receipt.reply_to` (string) The reply to - `gift_receipt.subject` (string, required) The email subject - `id` (string, required) The unique, string identifier of this application process - `is_active` (boolean) Whether or not this process is active - `name` (string, required) The name of the application process - `new_donor_contact_options` (object) The fields that should show for new contacts being created in the portal during the contribution process - `override_checkout_settings` (boolean) Whether or not to override POC settings - `pledge_installment_plans` (array, required) - `pledge_installment_plans.installment_plan_id` (string, required) The installment plan - `pledge_installment_plans.name` (string, required) The description of the installment plan to be shown to the user - `pledge_receipt` (object, required) The confirmation email for submitted pledge forms - `pledges_generate_pro_forma_invoices` (boolean) If true, pledges will generate pro forma (not real) invoices - `premium_rules` (array, required) - `premium_rules.gift_amount_range_end` (number) The ending range - `premium_rules.gift_amount_range_start` (number) The starting range for the premium rule - `premium_rules.premium_id` (string, required) The premium - `premium_shipping_method_id` (string, required) The shipping method to use for premiums - `recurring_gift_options` (object, required) - `recurring_gift_options.allow_donor_to_specify_end_date` (boolean) If set, the user can indicate when they want the gifts to end - `recurring_gift_options.enable_annually` (boolean) If set, donors can have annual recurring gifts - `recurring_gift_options.enable_monthly` (boolean) If set, donors can have monthly recurring gifts - `recurring_gift_options.enable_quarterly` (boolean) If set, donors can have quarterly recurring gifts - `require_acknowledgement` (boolean) If set, donors must acknowledge a checkbox before proceeding - `show_campaign_progress` (boolean) If set, then the campaign in use for the giving form will show progress at the time of giving - `suggest_giving_amounts` (boolean) If true, giving amounts are suggested; otherwise, the donor is free to enter their own - `suggested_gift_amount` (number) The suggested amount of given, set by default - `suggested_giving_amounts` (array, required) - `sys_bulk_load_at` (string) If this record was loaded via bulk, the timestamp when the record was processed - `sys_bulk_load_id` (string) If this record was loaded via bulk, the ID of the bulk load process - `sys_bulk_load_pk` (string) 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_no` (number) If this record was loaded via bulk, the record number in the source file - `sys_bulk_load_source_file` (string) If this record was loaded via bulk, the source file - `sys_calculated_field_error` (string) The error associated with the calculated field - `sys_calculated_field_errors` (array) - `sys_calculated_field_errors.error` (string) - `sys_calculated_field_errors.field` (string) - `sys_configuration_snapshot_id` (string) If a snapshot was restored/applies to this record, the ID of the snapshot - `sys_created_at` (string, required) The date/time that this record was created, expressed in ISO-8601 date format - `sys_created_by_id` (string, required) The ID of the user that created this record - `sys_deleted_by_id` (string) The ID of the user that deleted (or last tried to delete) this object - `sys_directive` (string) Means for passing directive information into an object processing logic - `sys_external_id` (string) The ID that a record has from an external system or data import - `sys_has_files_in_s3` (boolean) 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_id` (string) If this record was last touched by a bulk data operation, the ID of that operation - `sys_last_bulk_data_operation_sys_version` (string) If this record was last touched by a bulk data operation, the sys_version at the time of that operation - `sys_last_modified_at` (string, required) The date/time that this record record was last modified, expressed in ISO-8601 date format - `sys_last_modified_by_id` (string, required) The ID of the user that last modified this record - `sys_last_security_context` (object) The security context of the last insert, modify, or delete performed on this item - `sys_locked` (boolean) If set, this record is locked and cannot be changed via the API - `sys_snapshot_base_version` (number) The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox - `sys_version` (number) A number representing the version of this record in the database - `targeted_giving` (string, required) Whether targeted giving is enabled for this process Enum: "disabled", "specify multiple funds", "specify single fund" - `targeted_giving_options` (object) - `targeted_giving_options.restrict_to_fund_categories` (boolean) Should this process be restricted to specific categories - `targeted_giving_options.restrict_to_fund_types` (boolean) Should this process be restricted to certain types of funds - `targeted_giving_options.restrict_to_funds` (boolean) Should this process be restricted to specific funds - `targeted_giving_options.restricted_fund_category_ids` (array) - `targeted_giving_options.restricted_fund_ids` (array) - `targeted_giving_options.restricted_fund_types` (array) - `tribute_gift_options` (object, required) - `tribute_gift_options.email_notification` (object) The templated email to send to honorees - `tribute_gift_options.honoree_notification` (string) Enum: "disabled", "email", "email or mail", "mail" ## Response 200 fields (application/json): - `acknowledgement_settings` (object, required) - `acknowledgement_settings.checkbox_text` (string, required) The value to show on the textbox label - `acknowledgement_settings.html` (string) HTML to show - `allow_anonymous_gifts` (boolean) If true, anonymous gifts are allowed - `allow_pledges` (boolean) Whether pledges are allowed in this process - `allow_recurring_gifts` (boolean) Whether recurring gifts are allowed in this process - `allow_tribute_gifts` (boolean) If set, donors are able to donor in honor of/in memory of - `appeal_id` (string) The appeal to which gifts given in this process should be associated - `campaign_id` (string) The campaign to which gifts given in this process should be associated - `checkout_settings` (object, required) - `checkout_settings.allow_customer_to_choose_installment_plan` (boolean) If true, the customer can choose their installment plan - `checkout_settings.bank_account_id` (string, required) The default bank account that the store should use to receive payments - `checkout_settings.bill_my_organization_options` (object) - `checkout_settings.bill_my_organization_options.billing_address` (string) Enum: "do not show", "optional", "required" - `checkout_settings.bill_my_organization_options.purchase_order_number` (string) Enum: "do not show", "optional", "required" - `checkout_settings.bill_my_organization_options.reference_number` (string) The reference # - `checkout_settings.bill_my_parent_organization_options` (object) - `checkout_settings.business_unit_id` (string, required) The business unit of the store - `checkout_settings.cancellation_fee_product_id` (string) The ID of the product used for cancellation fees - `checkout_settings.checkout_donation_options` (object) - `checkout_settings.checkout_donation_options.simple_checkout_donation_options` (object) - `checkout_settings.checkout_donation_options.simple_checkout_donation_options.allow_user_to_specify_custom_amount` (boolean) If set, the user can specify their own custom donation - `checkout_settings.checkout_donation_options.simple_checkout_donation_options.donation_ask_text` (string) The text shown to the user when making the donation - `checkout_settings.checkout_donation_options.simple_checkout_donation_options.donation_denominations` (array) - `checkout_settings.checkout_donation_options.simple_checkout_donation_options.donation_information` (string) Additional information about the donation - `checkout_settings.checkout_donation_options.simple_checkout_donation_options.donation_product_id` (string, required) The misc product that should be used - `checkout_settings.checkout_donation_options.simple_checkout_donation_options.override_donation_denominations` (boolean) If set, donation denominations are specified here and the defaults are not used - `checkout_settings.checkout_donation_options.simple_checkout_donation_options.suggested_donation` (number) A suggested donation - `checkout_settings.checkout_donation_options.type` (string) Enum: "simple" - `checkout_settings.credit_card_minimum_range_end` (number) If set, the maximum amount for which credit cards can be taken - `checkout_settings.credit_card_minimum_range_start` (number) If set, the minimum amount for which credit cards can be taken - `checkout_settings.credit_card_mode` (string) Determines whether or not credit cards are accepted Enum: "disabled", "enabled", "range" - `checkout_settings.credit_card_processing_fee_mode` (string) Determines how credit card processing fees should be handled Enum: "charge", "do not charge", "prompt user" - `checkout_settings.credit_card_processing_fee_options` (object) - `checkout_settings.credit_card_processing_fee_options.fee_percentage` (number, required) The fee percentage to charge for credit card processing - `checkout_settings.credit_card_processing_fee_options.maximum_fee` (number) The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged - `checkout_settings.credit_card_processing_fee_options.minimum_fee` (number) The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged - `checkout_settings.credit_card_processing_fee_options.product_id` (string, required) The misc product to use for the credit card processing - `checkout_settings.credit_card_processing_fee_options.prompt_sub_text` (string) Additional text that is shown to the user when asking if they want to pay for credit card processing fees. If not set a default will be used - `checkout_settings.credit_card_processing_fee_options.prompt_text` (string) The checkbox text to show the user when asking if they want to pay for credit card processing fees. If not set a default will be used - `checkout_settings.disable_electronic_payment_vaulting` (boolean) If set, in the portal people are not allowed to save credit cards - `checkout_settings.enable_bill_my_organization` (boolean) If set, the user has the option to bill their organization - `checkout_settings.enable_bill_my_parent_organization` (boolean) If set, the user has the option to bill their organization's parent organization - `checkout_settings.enable_donations_at_checkout` (boolean) If selected, users will be prompted to make a donation upon checking out - `checkout_settings.enable_electronic_checks` (boolean) If set, electronic checks are allowed - `checkout_settings.enable_pay_later` (boolean) If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed - `checkout_settings.enable_payroll_deduction` (boolean) If set, payroll deduction is allowed - `checkout_settings.enable_split_payments` (boolean) If set, users are allowed to split payments - `checkout_settings.installment_plan_options` (array) - `checkout_settings.invoice_payment_terms_id` (string) The payment terms for invoices; if left blank, default is used - `checkout_settings.invoice_template_id` (string) The template to use for invoices created during this process - `checkout_settings.merchant_account_id` (string, required) The merchant account that the store should use to receive payments - `checkout_settings.pay_later_options` (object) - `checkout_settings.restocking_fee_product_id` (string) The ID of the product used for restocking fees - `checkout_settings.special_instructions` (string) Instructions shown to the user - `checkout_settings.use_pro_forma_invoices` (boolean) Whether to use pro forma invoices when user elects to pay later - `default_fund_id` (string, required) The default fund that a gift should be allocated to when the user makes an non-targeted gift - `donor_instructions` (string) Instructions shown to donors on the giving form - `enable_gift_receipt` (boolean) Enable confirmation email for submitted gift forms - `enable_pledge_receipt` (boolean) Enable confirmation email for submitted pledge forms - `enable_premiums` (boolean) If set, premiums are automatically assigned with gifts - `gift_receipt` (object, required) The confirmation email for submitted gift forms - `gift_receipt.bcc` (string) Anyone that should be bcc'ed on the email - `gift_receipt.body` (string, required) The email body - `gift_receipt.cc` (string) Anyone that should be cc'ed on the email - `gift_receipt.from` (string) From email address - `gift_receipt.from_name` (string) From name - `gift_receipt.reply_to` (string) The reply to - `gift_receipt.subject` (string, required) The email subject - `id` (string, required) The unique, string identifier of this application process - `is_active` (boolean) Whether or not this process is active - `name` (string, required) The name of the application process - `new_donor_contact_options` (object) The fields that should show for new contacts being created in the portal during the contribution process - `override_checkout_settings` (boolean) Whether or not to override POC settings - `pledge_installment_plans` (array, required) - `pledge_installment_plans.installment_plan_id` (string, required) The installment plan - `pledge_installment_plans.name` (string, required) The description of the installment plan to be shown to the user - `pledge_receipt` (object, required) The confirmation email for submitted pledge forms - `pledges_generate_pro_forma_invoices` (boolean) If true, pledges will generate pro forma (not real) invoices - `premium_rules` (array, required) - `premium_rules.gift_amount_range_end` (number) The ending range - `premium_rules.gift_amount_range_start` (number) The starting range for the premium rule - `premium_rules.premium_id` (string, required) The premium - `premium_shipping_method_id` (string, required) The shipping method to use for premiums - `recurring_gift_options` (object, required) - `recurring_gift_options.allow_donor_to_specify_end_date` (boolean) If set, the user can indicate when they want the gifts to end - `recurring_gift_options.enable_annually` (boolean) If set, donors can have annual recurring gifts - `recurring_gift_options.enable_monthly` (boolean) If set, donors can have monthly recurring gifts - `recurring_gift_options.enable_quarterly` (boolean) If set, donors can have quarterly recurring gifts - `require_acknowledgement` (boolean) If set, donors must acknowledge a checkbox before proceeding - `show_campaign_progress` (boolean) If set, then the campaign in use for the giving form will show progress at the time of giving - `suggest_giving_amounts` (boolean) If true, giving amounts are suggested; otherwise, the donor is free to enter their own - `suggested_gift_amount` (number) The suggested amount of given, set by default - `suggested_giving_amounts` (array, required) - `sys_bulk_load_at` (string) If this record was loaded via bulk, the timestamp when the record was processed - `sys_bulk_load_id` (string) If this record was loaded via bulk, the ID of the bulk load process - `sys_bulk_load_pk` (string) 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_no` (number) If this record was loaded via bulk, the record number in the source file - `sys_bulk_load_source_file` (string) If this record was loaded via bulk, the source file - `sys_calculated_field_error` (string) The error associated with the calculated field - `sys_calculated_field_errors` (array) - `sys_calculated_field_errors.error` (string) - `sys_calculated_field_errors.field` (string) - `sys_configuration_snapshot_id` (string) If a snapshot was restored/applies to this record, the ID of the snapshot - `sys_created_at` (string, required) The date/time that this record was created, expressed in ISO-8601 date format - `sys_created_by_id` (string, required) The ID of the user that created this record - `sys_deleted_by_id` (string) The ID of the user that deleted (or last tried to delete) this object - `sys_directive` (string) Means for passing directive information into an object processing logic - `sys_external_id` (string) The ID that a record has from an external system or data import - `sys_has_files_in_s3` (boolean) 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_id` (string) If this record was last touched by a bulk data operation, the ID of that operation - `sys_last_bulk_data_operation_sys_version` (string) If this record was last touched by a bulk data operation, the sys_version at the time of that operation - `sys_last_modified_at` (string, required) The date/time that this record record was last modified, expressed in ISO-8601 date format - `sys_last_modified_by_id` (string, required) The ID of the user that last modified this record - `sys_last_security_context` (object) The security context of the last insert, modify, or delete performed on this item - `sys_locked` (boolean) If set, this record is locked and cannot be changed via the API - `sys_snapshot_base_version` (number) The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox - `sys_version` (number) A number representing the version of this record in the database - `targeted_giving` (string, required) Whether targeted giving is enabled for this process Enum: "disabled", "specify multiple funds", "specify single fund" - `targeted_giving_options` (object) - `targeted_giving_options.restrict_to_fund_categories` (boolean) Should this process be restricted to specific categories - `targeted_giving_options.restrict_to_fund_types` (boolean) Should this process be restricted to certain types of funds - `targeted_giving_options.restrict_to_funds` (boolean) Should this process be restricted to specific funds - `targeted_giving_options.restricted_fund_category_ids` (array) - `targeted_giving_options.restricted_fund_ids` (array) - `targeted_giving_options.restricted_fund_types` (array) - `tribute_gift_options` (object, required) - `tribute_gift_options.email_notification` (object) The templated email to send to honorees - `tribute_gift_options.honoree_notification` (string) Enum: "disabled", "email", "email or mail", "mail" ## Response 400 fields ## Response 401 fields ## Response 403 fields ## Response 404 fields ## Response 409 fields ## Response 429 fields ## Response 500 fields