Settings

Creates a new setting record that does not already exist.

This method will auto-generate an ID and create a new setting. If an ID is specified for the setting, 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 setting that you would like to be saved.

update_expiration_based_on_date_of_payment	boolean (Update Expiration Based On Date Of Payment) When set, the membership expiration is set based on the date that the membership was paid vs ordered
enable_group_membership_applications	boolean (Enable Group Membership Applications) If set, group membership applications are enbabled
membership_console_page_layout_id	string (Membership Console Page Layout) /^membership-memberships__.*/ The default page layout for membership editing
membership_portal_page_layout_id	string (Membership Portal Page Layout) /^membership-memberships__.*/ The default page layout for membership editing
membership_360_screen_id	string (Membership 360 Screen) /^membership-memberships__.*/ The default 360 screen for membership editing
allow_members_to_update_directory_options_in_portal	boolean (Allow Members To Update Directory Options In Portal) If true, members can update directory information when updating their membership
allow_members_to_update_auto_renewal_settings	boolean (Allow Members To Update Auto Renewal Settings) If true, members have the ability to update auto renewal settings in the portal
enable_chapter_administration	boolean (Enable Chapter Administration) If set, chapters are able to administer their members in the portal
	object (Chapter Administration Settings)
allow_committee_members_to_manage_documents	boolean (Allow Committee Members To Manage Documents) When set, committee members are able to manage documents in the portal
	object (Document Settings)
override_chapter_center_template	boolean (Override Chapter Center Template) If true, a custom template is used for the chapter center
chapter_center_html_template required	string (Chapter Center Html Template) The template to use for showing chapter information in the portal
override_view_member_template	boolean (Override View Member Template) If true, a custom template is used for viewing membership information
view_member_html_template required	string (View Member Html Template) The template to use for viewing membership information in the portal
	Array of objects
enable_chapters	boolean (Enable Chapters) Whether chapters are enabled
	object (Chapter Configuration)
enable_sections	boolean (Enable Sections) Whether sections are enabled
	object (Section Configuration)
enable_add_ons	boolean (Enable Add Ons) Whether or not membership add-ons are enabled
	object (Add On Configuration)
conflicting_membership_preference	string (Conflicting Membership Preference) In the case of a member that has both a principal and a flowdown/assigned membership, this setting determine which one is used Enum: "principal" "organization"
certificate_mode	string (Certificate Mode) Enum: "disabled" "automatically generate" "create manually"
certificate_template required	string (Certificate Template)
enable_id_cards	boolean (Enable Id Cards) Support for ID cards that can be downloaded in the portal
required	object (Id Card Settings)
enable_reinstatement	boolean (Enable Reinstatement) Whether members have the ability to be reinstated after termination
	object (Reinstatement Options)
enable_no_processes_message	boolean (Enable No Processes Message) Enable a message that shows when a person has no processes available
no_processes_message required	string (No Processes Message) Message to show when no processes
enable_directory_field_level_opt_out	boolean (Enable Directory Field Level Opt Out) If true, users can opt out of the directory specifically
directory_opt_out_fields required	Array of strings (Directory Opt Out Fields) non-empty The fields that users can opt out of
notes	string (Notes)
default_grace_period	number <float> (Default Grace Period) The default amount of time after a members expiration during which the are "in grace"
	Array of objects (Custom Field Values)
business_unit_id required	string (Business Unit) The business unit of the store
merchant_account_id required	string (Merchant Account) The merchant account that the store should use to receive payments
bank_account_id required	string (Bank Account) The default bank account that the store should use to receive payments
enable_split_payments	boolean (Enable Split Payments) If set, users are allowed to split payments
enable_electronic_checks	boolean (Enable Electronic Checks) If set, electronic checks are allowed
enable_payroll_deduction	boolean (Enable Payroll Deduction) If set, payroll deduction is allowed
enable_pay_later	boolean (Enable Pay Later) If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
enable_bill_my_organization	boolean (Enable Bill My Organization) If set, the user has the option to bill their organization
enable_bill_my_parent_organization	boolean (Enable Bill My Parent Organization) If set, the user has the option to bill their organization's parent organization
use_pro_forma_invoices	boolean (Use Pro Forma Invoices) Whether to use pro forma invoices when user elects to pay later
enable_donations_at_checkout	boolean (Enable Donations At Checkout) If selected, users will be prompted to make a donation upon checking out
restocking_fee_product_id	string (Restocking Fee Product) The ID of the product used for restocking fees
cancellation_fee_product_id	string (Cancellation Fee Product) The ID of the product used for cancellation fees
special_instructions	string (Special Instructions) Instructions shown to the user
	object (Pay Later Options)
	object (Bill My Organization Options)
	object (Bill My Parent Organization Options)
credit_card_mode	string (Credit Card Mode) Determines whether or not credit cards are accepted Enum: "enabled" "disabled" "range"
credit_card_minimum_range_start	number <float> (Credit Card Minimum Range Start) If set, the minimum amount for which credit cards can be taken
credit_card_minimum_range_end	number <float> (Credit Card Minimum Range End) If set, the maximum amount for which credit cards can be taken
credit_card_processing_fee_mode	string (Credit Card Processing Fee Mode) Determines how credit card processing fees should be handled Enum: "do not charge" "charge" "prompt user"
required	object (Credit Card Processing Fee Options)
invoice_template_id	string (Invoice Template) The template to use for invoices created during this process
invoice_payment_terms_id	string (Invoice Payment Terms) The payment terms for invoices; if left blank, default is used
allow_customer_to_choose_installment_plan	boolean (Allow Customer To Choose Installment Plan) If true, the customer can choose their installment plan
disable_electronic_payment_vaulting	boolean (Disable Electronic Payment Vaulting) If set, in the portal people are not allowed to save credit cards
required	Array of objects non-empty
required	object (Checkout Donation Options)
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 setting was saved successfully.

400The setting you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

409The setting could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to add setting based on tenant limits.

500General server error.

post/settings/{tenantId}

Request samples

application/json

{"update_expiration_based_on_date_of_payment": true,
"enable_group_membership_applications": true,
"membership_console_page_layout_id": "string",
"membership_portal_page_layout_id": "string",
"membership_360_screen_id": "string",
"allow_members_to_update_directory_options_in_portal": true,
"allow_members_to_update_auto_renewal_settings": true,
"enable_chapter_administration": true,
"chapter_administration_settings": {"contact_form_id": "string",
"membership_page_layout_id": "string",
"chapter_page_layout_id": "string",
"permissions": [{"committee_position_ids": ["string"
],
"view_chapter_roster": true,
"update_contact_info": true,
"update_chapter_info": true,
"update_membership_info": true,
"sign_up_new_members": true,
"renew_existing_members": true,
"manage_chapter_committees": true,
"manage_chapter_documents": true,
"access_saved_queries": true,
"saved_queries": [{"saved_query_id": "string",
"display_name": "string"
}
],
"grace_period": 0
}
]
},
"allow_committee_members_to_manage_documents": true,
"document_settings": {"restrict_management_to_positions": true,
"restricted_position_ids": ["string"
]
},
"override_chapter_center_template": true,
"chapter_center_html_template": "string",
"override_view_member_template": true,
"view_member_html_template": "string",
"contact_role_permissions": [{"role_id": "string",
"sign_up_for_membership": true,
"renew_membership": true,
"update_membership_info": true,
"manage_membership_privileges": true
}
],
"enable_chapters": true,
"chapter_configuration": {"singular_name": "string",
"plural_name": "string",
"members_are_required_to_join_a_chapter": true,
"maximum_number_of_chapters_a_member_can_join": 1,
"auto_assignment": "off",
"update_chapter_when_contact_address_changes": true,
"portal_restrictions": "members cannot change chapters",
"renewal_pricing_strategy": "all renewing members"
},
"enable_sections": true,
"section_configuration": {"singular_name": "string",
"plural_name": "string",
"portal_restrictions": "members cannot change sections",
"renewal_pricing_strategy": "all renewing members"
},
"enable_add_ons": true,
"add_on_configuration": {"singular_name": "string",
"plural_name": "string",
"portal_restrictions": "members cannot change add ons"
},
"conflicting_membership_preference": "principal",
"certificate_mode": "disabled",
"certificate_template": "string",
"enable_id_cards": true,
"id_card_settings": {"default_id_card_template_id": "string",
"allow_printing_in_portal": true
},
"enable_reinstatement": true,
"reinstatement_options": {"do_not_show_join_processes_during_reinstatement_period": true,
"reinstatement_period": 0,
"give_renewal_pricing_during_reinstatement_period": true,
"calculate_reinstatement_period_using": "termination date"
},
"enable_no_processes_message": true,
"no_processes_message": "string",
"enable_directory_field_level_opt_out": true,
"directory_opt_out_fields": ["string"
],
"notes": "string",
"default_grace_period": 0,
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": 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": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"update_expiration_based_on_date_of_payment": true,
"enable_group_membership_applications": true,
"membership_console_page_layout_id": "string",
"membership_portal_page_layout_id": "string",
"membership_360_screen_id": "string",
"allow_members_to_update_directory_options_in_portal": true,
"allow_members_to_update_auto_renewal_settings": true,
"enable_chapter_administration": true,
"chapter_administration_settings": {"contact_form_id": "string",
"membership_page_layout_id": "string",
"chapter_page_layout_id": "string",
"permissions": [{"committee_position_ids": ["string"
],
"view_chapter_roster": true,
"update_contact_info": true,
"update_chapter_info": true,
"update_membership_info": true,
"sign_up_new_members": true,
"renew_existing_members": true,
"manage_chapter_committees": true,
"manage_chapter_documents": true,
"access_saved_queries": true,
"saved_queries": [{"saved_query_id": "string",
"display_name": "string"
}
],
"grace_period": 0
}
]
},
"allow_committee_members_to_manage_documents": true,
"document_settings": {"restrict_management_to_positions": true,
"restricted_position_ids": ["string"
]
},
"override_chapter_center_template": true,
"chapter_center_html_template": "string",
"override_view_member_template": true,
"view_member_html_template": "string",
"contact_role_permissions": [{"role_id": "string",
"sign_up_for_membership": true,
"renew_membership": true,
"update_membership_info": true,
"manage_membership_privileges": true
}
],
"enable_chapters": true,
"chapter_configuration": {"singular_name": "string",
"plural_name": "string",
"members_are_required_to_join_a_chapter": true,
"maximum_number_of_chapters_a_member_can_join": 1,
"auto_assignment": "off",
"update_chapter_when_contact_address_changes": true,
"portal_restrictions": "members cannot change chapters",
"renewal_pricing_strategy": "all renewing members"
},
"enable_sections": true,
"section_configuration": {"singular_name": "string",
"plural_name": "string",
"portal_restrictions": "members cannot change sections",
"renewal_pricing_strategy": "all renewing members"
},
"enable_add_ons": true,
"add_on_configuration": {"singular_name": "string",
"plural_name": "string",
"portal_restrictions": "members cannot change add ons"
},
"conflicting_membership_preference": "principal",
"certificate_mode": "disabled",
"certificate_template": "string",
"enable_id_cards": true,
"id_card_settings": {"default_id_card_template_id": "string",
"allow_printing_in_portal": true
},
"enable_reinstatement": true,
"reinstatement_options": {"do_not_show_join_processes_during_reinstatement_period": true,
"reinstatement_period": 0,
"give_renewal_pricing_during_reinstatement_period": true,
"calculate_reinstatement_period_using": "termination date"
},
"enable_no_processes_message": true,
"no_processes_message": "string",
"enable_directory_field_level_opt_out": true,
"directory_opt_out_fields": ["string"
],
"notes": "string",
"default_grace_period": 0,
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": 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": [{"field": "string",
"error": "string"
}
]
}

Returns a setting from the system by its ID.

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

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.
consistentRead	string Indicates the API should force a consistent read on the data source.

Responses

200The setting was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The setting could not be found.

429Limit exceeded... unable to retrieve setting based on tenant limits.

500General server error.

get/settings/{tenantId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/settings/:tenantId?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"update_expiration_based_on_date_of_payment": true,
"enable_group_membership_applications": true,
"membership_console_page_layout_id": "string",
"membership_portal_page_layout_id": "string",
"membership_360_screen_id": "string",
"allow_members_to_update_directory_options_in_portal": true,
"allow_members_to_update_auto_renewal_settings": true,
"enable_chapter_administration": true,
"chapter_administration_settings": {"contact_form_id": "string",
"membership_page_layout_id": "string",
"chapter_page_layout_id": "string",
"permissions": [{"committee_position_ids": ["string"
],
"view_chapter_roster": true,
"update_contact_info": true,
"update_chapter_info": true,
"update_membership_info": true,
"sign_up_new_members": true,
"renew_existing_members": true,
"manage_chapter_committees": true,
"manage_chapter_documents": true,
"access_saved_queries": true,
"saved_queries": [{"saved_query_id": "string",
"display_name": "string"
}
],
"grace_period": 0
}
]
},
"allow_committee_members_to_manage_documents": true,
"document_settings": {"restrict_management_to_positions": true,
"restricted_position_ids": ["string"
]
},
"override_chapter_center_template": true,
"chapter_center_html_template": "string",
"override_view_member_template": true,
"view_member_html_template": "string",
"contact_role_permissions": [{"role_id": "string",
"sign_up_for_membership": true,
"renew_membership": true,
"update_membership_info": true,
"manage_membership_privileges": true
}
],
"enable_chapters": true,
"chapter_configuration": {"singular_name": "string",
"plural_name": "string",
"members_are_required_to_join_a_chapter": true,
"maximum_number_of_chapters_a_member_can_join": 1,
"auto_assignment": "off",
"update_chapter_when_contact_address_changes": true,
"portal_restrictions": "members cannot change chapters",
"renewal_pricing_strategy": "all renewing members"
},
"enable_sections": true,
"section_configuration": {"singular_name": "string",
"plural_name": "string",
"portal_restrictions": "members cannot change sections",
"renewal_pricing_strategy": "all renewing members"
},
"enable_add_ons": true,
"add_on_configuration": {"singular_name": "string",
"plural_name": "string",
"portal_restrictions": "members cannot change add ons"
},
"conflicting_membership_preference": "principal",
"certificate_mode": "disabled",
"certificate_template": "string",
"enable_id_cards": true,
"id_card_settings": {"default_id_card_template_id": "string",
"allow_printing_in_portal": true
},
"enable_reinstatement": true,
"reinstatement_options": {"do_not_show_join_processes_during_reinstatement_period": true,
"reinstatement_period": 0,
"give_renewal_pricing_during_reinstatement_period": true,
"calculate_reinstatement_period_using": "termination date"
},
"enable_no_processes_message": true,
"no_processes_message": "string",
"enable_directory_field_level_opt_out": true,
"directory_opt_out_fields": ["string"
],
"notes": "string",
"default_grace_period": 0,
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": 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": [{"field": "string",
"error": "string"
}
]
}

Updates a setting with the specified ID.

This method will update an existing setting with the specified ID.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The updated setting that will be saved.

update_expiration_based_on_date_of_payment	boolean (Update Expiration Based On Date Of Payment) When set, the membership expiration is set based on the date that the membership was paid vs ordered
enable_group_membership_applications	boolean (Enable Group Membership Applications) If set, group membership applications are enbabled
membership_console_page_layout_id	string (Membership Console Page Layout) /^membership-memberships__.*/ The default page layout for membership editing
membership_portal_page_layout_id	string (Membership Portal Page Layout) /^membership-memberships__.*/ The default page layout for membership editing
membership_360_screen_id	string (Membership 360 Screen) /^membership-memberships__.*/ The default 360 screen for membership editing
allow_members_to_update_directory_options_in_portal	boolean (Allow Members To Update Directory Options In Portal) If true, members can update directory information when updating their membership
allow_members_to_update_auto_renewal_settings	boolean (Allow Members To Update Auto Renewal Settings) If true, members have the ability to update auto renewal settings in the portal
enable_chapter_administration	boolean (Enable Chapter Administration) If set, chapters are able to administer their members in the portal
	object (Chapter Administration Settings)
allow_committee_members_to_manage_documents	boolean (Allow Committee Members To Manage Documents) When set, committee members are able to manage documents in the portal
	object (Document Settings)
override_chapter_center_template	boolean (Override Chapter Center Template) If true, a custom template is used for the chapter center
chapter_center_html_template required	string (Chapter Center Html Template) The template to use for showing chapter information in the portal
override_view_member_template	boolean (Override View Member Template) If true, a custom template is used for viewing membership information
view_member_html_template required	string (View Member Html Template) The template to use for viewing membership information in the portal
	Array of objects
enable_chapters	boolean (Enable Chapters) Whether chapters are enabled
	object (Chapter Configuration)
enable_sections	boolean (Enable Sections) Whether sections are enabled
	object (Section Configuration)
enable_add_ons	boolean (Enable Add Ons) Whether or not membership add-ons are enabled
	object (Add On Configuration)
conflicting_membership_preference	string (Conflicting Membership Preference) In the case of a member that has both a principal and a flowdown/assigned membership, this setting determine which one is used Enum: "principal" "organization"
certificate_mode	string (Certificate Mode) Enum: "disabled" "automatically generate" "create manually"
certificate_template required	string (Certificate Template)
enable_id_cards	boolean (Enable Id Cards) Support for ID cards that can be downloaded in the portal
required	object (Id Card Settings)
enable_reinstatement	boolean (Enable Reinstatement) Whether members have the ability to be reinstated after termination
	object (Reinstatement Options)
enable_no_processes_message	boolean (Enable No Processes Message) Enable a message that shows when a person has no processes available
no_processes_message required	string (No Processes Message) Message to show when no processes
enable_directory_field_level_opt_out	boolean (Enable Directory Field Level Opt Out) If true, users can opt out of the directory specifically
directory_opt_out_fields required	Array of strings (Directory Opt Out Fields) non-empty The fields that users can opt out of
notes	string (Notes)
default_grace_period	number <float> (Default Grace Period) The default amount of time after a members expiration during which the are "in grace"
	Array of objects (Custom Field Values)
business_unit_id required	string (Business Unit) The business unit of the store
merchant_account_id required	string (Merchant Account) The merchant account that the store should use to receive payments
bank_account_id required	string (Bank Account) The default bank account that the store should use to receive payments
enable_split_payments	boolean (Enable Split Payments) If set, users are allowed to split payments
enable_electronic_checks	boolean (Enable Electronic Checks) If set, electronic checks are allowed
enable_payroll_deduction	boolean (Enable Payroll Deduction) If set, payroll deduction is allowed
enable_pay_later	boolean (Enable Pay Later) If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
enable_bill_my_organization	boolean (Enable Bill My Organization) If set, the user has the option to bill their organization
enable_bill_my_parent_organization	boolean (Enable Bill My Parent Organization) If set, the user has the option to bill their organization's parent organization
use_pro_forma_invoices	boolean (Use Pro Forma Invoices) Whether to use pro forma invoices when user elects to pay later
enable_donations_at_checkout	boolean (Enable Donations At Checkout) If selected, users will be prompted to make a donation upon checking out
restocking_fee_product_id	string (Restocking Fee Product) The ID of the product used for restocking fees
cancellation_fee_product_id	string (Cancellation Fee Product) The ID of the product used for cancellation fees
special_instructions	string (Special Instructions) Instructions shown to the user
	object (Pay Later Options)
	object (Bill My Organization Options)
	object (Bill My Parent Organization Options)
credit_card_mode	string (Credit Card Mode) Determines whether or not credit cards are accepted Enum: "enabled" "disabled" "range"
credit_card_minimum_range_start	number <float> (Credit Card Minimum Range Start) If set, the minimum amount for which credit cards can be taken
credit_card_minimum_range_end	number <float> (Credit Card Minimum Range End) If set, the maximum amount for which credit cards can be taken
credit_card_processing_fee_mode	string (Credit Card Processing Fee Mode) Determines how credit card processing fees should be handled Enum: "do not charge" "charge" "prompt user"
required	object (Credit Card Processing Fee Options)
invoice_template_id	string (Invoice Template) The template to use for invoices created during this process
invoice_payment_terms_id	string (Invoice Payment Terms) The payment terms for invoices; if left blank, default is used
allow_customer_to_choose_installment_plan	boolean (Allow Customer To Choose Installment Plan) If true, the customer can choose their installment plan
disable_electronic_payment_vaulting	boolean (Disable Electronic Payment Vaulting) If set, in the portal people are not allowed to save credit cards
required	Array of objects non-empty
required	object (Checkout Donation Options)
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 setting was updated successfully.

400The setting supplied was not valid.

401Unauthorized.

403Forbidden.

404The setting could not be found.

409The setting could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve setting based on tenant limits.

500General server error.

put/settings/{tenantId}

Request samples

application/json

{"update_expiration_based_on_date_of_payment": true,
"enable_group_membership_applications": true,
"membership_console_page_layout_id": "string",
"membership_portal_page_layout_id": "string",
"membership_360_screen_id": "string",
"allow_members_to_update_directory_options_in_portal": true,
"allow_members_to_update_auto_renewal_settings": true,
"enable_chapter_administration": true,
"chapter_administration_settings": {"contact_form_id": "string",
"membership_page_layout_id": "string",
"chapter_page_layout_id": "string",
"permissions": [{"committee_position_ids": ["string"
],
"view_chapter_roster": true,
"update_contact_info": true,
"update_chapter_info": true,
"update_membership_info": true,
"sign_up_new_members": true,
"renew_existing_members": true,
"manage_chapter_committees": true,
"manage_chapter_documents": true,
"access_saved_queries": true,
"saved_queries": [{"saved_query_id": "string",
"display_name": "string"
}
],
"grace_period": 0
}
]
},
"allow_committee_members_to_manage_documents": true,
"document_settings": {"restrict_management_to_positions": true,
"restricted_position_ids": ["string"
]
},
"override_chapter_center_template": true,
"chapter_center_html_template": "string",
"override_view_member_template": true,
"view_member_html_template": "string",
"contact_role_permissions": [{"role_id": "string",
"sign_up_for_membership": true,
"renew_membership": true,
"update_membership_info": true,
"manage_membership_privileges": true
}
],
"enable_chapters": true,
"chapter_configuration": {"singular_name": "string",
"plural_name": "string",
"members_are_required_to_join_a_chapter": true,
"maximum_number_of_chapters_a_member_can_join": 1,
"auto_assignment": "off",
"update_chapter_when_contact_address_changes": true,
"portal_restrictions": "members cannot change chapters",
"renewal_pricing_strategy": "all renewing members"
},
"enable_sections": true,
"section_configuration": {"singular_name": "string",
"plural_name": "string",
"portal_restrictions": "members cannot change sections",
"renewal_pricing_strategy": "all renewing members"
},
"enable_add_ons": true,
"add_on_configuration": {"singular_name": "string",
"plural_name": "string",
"portal_restrictions": "members cannot change add ons"
},
"conflicting_membership_preference": "principal",
"certificate_mode": "disabled",
"certificate_template": "string",
"enable_id_cards": true,
"id_card_settings": {"default_id_card_template_id": "string",
"allow_printing_in_portal": true
},
"enable_reinstatement": true,
"reinstatement_options": {"do_not_show_join_processes_during_reinstatement_period": true,
"reinstatement_period": 0,
"give_renewal_pricing_during_reinstatement_period": true,
"calculate_reinstatement_period_using": "termination date"
},
"enable_no_processes_message": true,
"no_processes_message": "string",
"enable_directory_field_level_opt_out": true,
"directory_opt_out_fields": ["string"
],
"notes": "string",
"default_grace_period": 0,
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": 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": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"update_expiration_based_on_date_of_payment": true,
"enable_group_membership_applications": true,
"membership_console_page_layout_id": "string",
"membership_portal_page_layout_id": "string",
"membership_360_screen_id": "string",
"allow_members_to_update_directory_options_in_portal": true,
"allow_members_to_update_auto_renewal_settings": true,
"enable_chapter_administration": true,
"chapter_administration_settings": {"contact_form_id": "string",
"membership_page_layout_id": "string",
"chapter_page_layout_id": "string",
"permissions": [{"committee_position_ids": ["string"
],
"view_chapter_roster": true,
"update_contact_info": true,
"update_chapter_info": true,
"update_membership_info": true,
"sign_up_new_members": true,
"renew_existing_members": true,
"manage_chapter_committees": true,
"manage_chapter_documents": true,
"access_saved_queries": true,
"saved_queries": [{"saved_query_id": "string",
"display_name": "string"
}
],
"grace_period": 0
}
]
},
"allow_committee_members_to_manage_documents": true,
"document_settings": {"restrict_management_to_positions": true,
"restricted_position_ids": ["string"
]
},
"override_chapter_center_template": true,
"chapter_center_html_template": "string",
"override_view_member_template": true,
"view_member_html_template": "string",
"contact_role_permissions": [{"role_id": "string",
"sign_up_for_membership": true,
"renew_membership": true,
"update_membership_info": true,
"manage_membership_privileges": true
}
],
"enable_chapters": true,
"chapter_configuration": {"singular_name": "string",
"plural_name": "string",
"members_are_required_to_join_a_chapter": true,
"maximum_number_of_chapters_a_member_can_join": 1,
"auto_assignment": "off",
"update_chapter_when_contact_address_changes": true,
"portal_restrictions": "members cannot change chapters",
"renewal_pricing_strategy": "all renewing members"
},
"enable_sections": true,
"section_configuration": {"singular_name": "string",
"plural_name": "string",
"portal_restrictions": "members cannot change sections",
"renewal_pricing_strategy": "all renewing members"
},
"enable_add_ons": true,
"add_on_configuration": {"singular_name": "string",
"plural_name": "string",
"portal_restrictions": "members cannot change add ons"
},
"conflicting_membership_preference": "principal",
"certificate_mode": "disabled",
"certificate_template": "string",
"enable_id_cards": true,
"id_card_settings": {"default_id_card_template_id": "string",
"allow_printing_in_portal": true
},
"enable_reinstatement": true,
"reinstatement_options": {"do_not_show_join_processes_during_reinstatement_period": true,
"reinstatement_period": 0,
"give_renewal_pricing_during_reinstatement_period": true,
"calculate_reinstatement_period_using": "termination date"
},
"enable_no_processes_message": true,
"no_processes_message": "string",
"enable_directory_field_level_opt_out": true,
"directory_opt_out_fields": ["string"
],
"notes": "string",
"default_grace_period": 0,
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": 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": [{"field": "string",
"error": "string"
}
]
}

Partially updates a setting with the specified ID.

This method will patch an existing setting 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.

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 setting was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The setting could not be found.

409The setting could not be saved because it refers to/depends on a non-existent object.

429Limit exceeded... unable to retrieve setting based on tenant limits.

500General server error.

patch/settings/{tenantId}

Request samples

application/json

[{"op": "add",
"path": "string",
"value": "string"
}
]

Response samples

application/json

{"update_expiration_based_on_date_of_payment": true,
"enable_group_membership_applications": true,
"membership_console_page_layout_id": "string",
"membership_portal_page_layout_id": "string",
"membership_360_screen_id": "string",
"allow_members_to_update_directory_options_in_portal": true,
"allow_members_to_update_auto_renewal_settings": true,
"enable_chapter_administration": true,
"chapter_administration_settings": {"contact_form_id": "string",
"membership_page_layout_id": "string",
"chapter_page_layout_id": "string",
"permissions": [{"committee_position_ids": ["string"
],
"view_chapter_roster": true,
"update_contact_info": true,
"update_chapter_info": true,
"update_membership_info": true,
"sign_up_new_members": true,
"renew_existing_members": true,
"manage_chapter_committees": true,
"manage_chapter_documents": true,
"access_saved_queries": true,
"saved_queries": [{"saved_query_id": "string",
"display_name": "string"
}
],
"grace_period": 0
}
]
},
"allow_committee_members_to_manage_documents": true,
"document_settings": {"restrict_management_to_positions": true,
"restricted_position_ids": ["string"
]
},
"override_chapter_center_template": true,
"chapter_center_html_template": "string",
"override_view_member_template": true,
"view_member_html_template": "string",
"contact_role_permissions": [{"role_id": "string",
"sign_up_for_membership": true,
"renew_membership": true,
"update_membership_info": true,
"manage_membership_privileges": true
}
],
"enable_chapters": true,
"chapter_configuration": {"singular_name": "string",
"plural_name": "string",
"members_are_required_to_join_a_chapter": true,
"maximum_number_of_chapters_a_member_can_join": 1,
"auto_assignment": "off",
"update_chapter_when_contact_address_changes": true,
"portal_restrictions": "members cannot change chapters",
"renewal_pricing_strategy": "all renewing members"
},
"enable_sections": true,
"section_configuration": {"singular_name": "string",
"plural_name": "string",
"portal_restrictions": "members cannot change sections",
"renewal_pricing_strategy": "all renewing members"
},
"enable_add_ons": true,
"add_on_configuration": {"singular_name": "string",
"plural_name": "string",
"portal_restrictions": "members cannot change add ons"
},
"conflicting_membership_preference": "principal",
"certificate_mode": "disabled",
"certificate_template": "string",
"enable_id_cards": true,
"id_card_settings": {"default_id_card_template_id": "string",
"allow_printing_in_portal": true
},
"enable_reinstatement": true,
"reinstatement_options": {"do_not_show_join_processes_during_reinstatement_period": true,
"reinstatement_period": 0,
"give_renewal_pricing_during_reinstatement_period": true,
"calculate_reinstatement_period_using": "termination date"
},
"enable_no_processes_message": true,
"no_processes_message": "string",
"enable_directory_field_level_opt_out": true,
"directory_opt_out_fields": ["string"
],
"notes": "string",
"default_grace_period": 0,
"custom_field_values": [{"custom_field_id": "string",
"string_value": "string",
"numeric_value": 0,
"boolean_value": true,
"file_url_value": "string",
"list_value": ["string"
],
"table_value": [{ }
]
}
],
"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": 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": [{"field": "string",
"error": "string"
}
]
}

Returns a setting from the system by its ID.

This method will delete a setting with the specified ID.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Responses

200The setting was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The setting could not be found.

409The setting could not be deleted because other objects refers to/depends on this one.

429Limit exceeded... unable to delete setting based on tenant limits.

500General server error.

delete/settings/{tenantId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X DELETE \
  https://membership.api.756794052567.rhythmsoftware.com/settings/:tenantId \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

"string"