Membership (v1-2025-04-18)

The Membership API provides all the capabilities for managing your membership. Although it is most commonly used to look up the membership information for a single contact or organization, it can also be used to approve, modify, or drop members.

Like most of the other Rhythm apps, the Membership API includes endpoints for Query Definitions. These endpoints are commonly used to retrieve saved queries, which can then be executed using the Query endpoints of the System API.

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

Add On Products

Add On Products

Operations

Add On Types

Add On Types

Operations

Add Ons

Add Ons

Operations

App Reference Types

App Reference Types

Operations

Application Groups

Application Groups

Operations

Application Processes

Application Processes

Operations

Application Status Reasons

Application Status Reasons

Operations

Applications

Applications

Operations

Ballots

Ballots

Operations

Billing Notices

Billing Notices

Operations

Billing Run Actions

Billing Run Actions

Operations

Billing Runs

Billing Runs

Operations

Billing Templates

Billing Templates

Operations

Change Fees

Change Fees

Operations

Chapter Dues Products

Chapter Dues Products

Operations

Chapter Types

Chapter Types

Operations

Chapters

Chapters

Operations

Coupons

Coupons

Operations

Directories

Directories

Operations

Elections

Elections

Operations

Group Application Processes

Group Application Processes

Operations

Id Card Templates

Id Card Templates

Operations

Memberships

Memberships

Operations

Packages

Packages

Operations

Query Definitions

Query Definitions

Operations

Recurring Billing Runs

Recurring Billing Runs

Operations

Section Dues Products

Section Dues Products

Operations

Section Types

Section Types

Operations

Sections

Sections

Operations

Settings

Settings

Operations

Returns a setting from the system by its ID.

Request

This method will delete a setting with the specified ID.

Path
tenantIdstringrequired

The id of the tenant being accessed.

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

Responses

The setting was deleted successfully.

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

Returns a setting from the system by its ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

Query
fieldsstring

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

consistentReadstring

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

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

Responses

The setting was retrieved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
add_on_configurationobject(Add On Configuration)
allow_committee_members_to_manage_documentsboolean(Allow Committee Members To Manage Documents)

When set, committee members are able to manage documents in the portal

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

allow_members_to_update_auto_renewal_settingsboolean(Allow Members To Update Auto Renewal Settings)

If true, members have the ability to update auto renewal settings in the portal

allow_members_to_update_directory_options_in_portalstring(Allow Members To Update Directory Options In Portal)

If true, members can update directory information when updating their membership

Enum"disabled""enabled""fields only"
bank_account_idstring(Bank Account)required

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

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

The business unit of the store

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

certificate_modestring(Certificate Mode)
Enum"automatically generate""create manually""disabled"
certificate_templatestring(Certificate Template)required
chapter_administration_settingsobject(Chapter Administration Settings)
chapter_center_html_templatestring(Chapter Center Html Template)required

The template to use for showing chapter information in the portal

chapter_configurationobject(Chapter Configuration)
checkout_donation_optionsobject(Checkout Donation Options)required
checkout_donation_options.​simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)
One of:
checkout_donation_options.​typestring(Type)
Value"simple"
conflicting_membership_preferencestring(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"organization""principal"
contact_role_permissionsArray of objects
credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

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

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"
credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required
credit_card_processing_fee_options.​fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.​maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.​minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.​product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.​prompt_sub_textstring(Prompt Sub Text)

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

credit_card_processing_fee_options.​prompt_textstring(Prompt Text)

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

custom_application_generation_logic_optionsobject(Custom Application Generation Logic Options)required
custom_application_generation_logic_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

custom_field_valuesArray of objects(Custom Field Values)
custom_order_preprocessing_optionsobject(Custom Order Preprocessing Options)required
custom_order_preprocessing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

custom_order_pricing_optionsobject(Custom Order Pricing Options)required
custom_order_pricing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

default_grace_periodnumber(float)(Default Grace Period)

The default amount of time after a members expiration during which the are "in grace"

directory_opt_out_fieldsArray of strings(Directory Opt Out Fields)non-emptyrequired

The fields that users can opt out of

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

document_settingsobject(Document Settings)
enable_add_onsboolean(Enable Add Ons)

Whether or not membership add-ons are enabled

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_chapter_administrationboolean(Enable Chapter Administration)

If set, chapters are able to administer their members in the portal

enable_chaptersboolean(Enable Chapters)

Whether chapters are enabled

enable_custom_application_generation_logicboolean(Enable Custom Application Generation Logic)

If set, the application generation logic will call a custom lambda function

enable_custom_order_preprocessingboolean(Enable Custom Order Preprocessing)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

enable_custom_order_pricingboolean(Enable Custom Order Pricing)

If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation

enable_directory_field_level_opt_outboolean(Enable Directory Field Level Opt Out)

If true, users can opt out of the directory specifically

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_group_membership_applicationsboolean(Enable Group Membership Applications)

If set, group membership applications are enbabled

enable_id_cardsboolean(Enable Id Cards)

Support for ID cards that can be downloaded in the portal

enable_no_processes_messageboolean(Enable No Processes Message)

Enable a message that shows when a person has no processes available

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_reinstatementboolean(Enable Reinstatement)

Whether members have the ability to be reinstated after termination

enable_sectionsboolean(Enable Sections)

Whether sections are enabled

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

id_card_settingsobject(Id Card Settings)required
id_card_settings.​allow_printing_in_portalboolean(Allow Printing In Portal)

Whether or not ID cards can be printed in the portal

id_card_settings.​default_id_card_template_idstring(Default Id Card Template)required
include_flowdown_members_in_kpisboolean(Include Flowdown Members In Kpis)

Enable adding flowdown memberships in KPIs

installment_plan_optionsArray of objectsnon-emptyrequired
installment_plan_options[].​additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].​installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].​is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

membership_360_screen_idstring(Membership 360 Screen)^membership-memberships__.*

The default 360 screen for membership editing

membership_console_page_layout_idstring(Membership Console Page Layout)^membership-memberships__.*

The default page layout for membership editing

membership_portal_page_layout_idstring(Membership Portal Page Layout)^membership-memberships__.*

The default page layout for membership editing

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

no_processes_messagestring(No Processes Message)required

Message to show when no processes

notesstring(Notes)
override_chapter_center_templateboolean(Override Chapter Center Template)

If true, a custom template is used for the chapter center

override_view_member_templateboolean(Override View Member Template)

If true, a custom template is used for viewing membership information

pay_later_optionsobject(Pay Later Options)
reinstatement_optionsobject(Reinstatement Options)
restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

section_configurationobject(Section Configuration)
special_instructionsstring(Special Instructions)

Instructions shown to the user

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

update_expiration_based_on_date_of_paymentboolean(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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

view_member_html_templatestring(View Member Html Template)required

The template to use for viewing membership information in the portal

Response
application/json
{ "add_on_configuration": { "dues_bundling": "inline", "plural_name": "string", "portal_restrictions": "members cannot change add ons", "singular_name": "string" }, "allow_committee_members_to_manage_documents": true, "allow_customer_to_choose_installment_plan": true, "allow_members_to_update_auto_renewal_settings": true, "allow_members_to_update_directory_options_in_portal": "disabled", "bank_account_id": "string", "bill_my_organization_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "bill_my_parent_organization_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "certificate_mode": "automatically generate", "certificate_template": "string", "chapter_administration_settings": { "chapter_page_layout_id": "string", "contact_form_id": "string", "membership_page_layout_id": "string", "permissions": [] }, "chapter_center_html_template": "string", "chapter_configuration": { "auto_assignment": "assign", "dues_bundling": "inline", "maximum_number_of_chapters_a_member_can_join": 1, "members_are_required_to_join_a_chapter": true, "plural_name": "string", "portal_restrictions": "members cannot change chapters", "renewal_pricing_strategy": "all renewing members", "singular_name": "string", "update_chapter_when_contact_address_changes": true }, "checkout_donation_options": { "simple_checkout_donation_options": {}, "type": "simple" }, "conflicting_membership_preference": "organization", "contact_role_permissions": [ {} ], "credit_card_minimum_range_end": 0.1, "credit_card_minimum_range_start": 0.1, "credit_card_mode": "disabled", "credit_card_processing_fee_mode": "charge", "credit_card_processing_fee_options": { "fee_percentage": 0.1, "maximum_fee": 0.1, "minimum_fee": 0.1, "product_id": "string", "prompt_sub_text": "string", "prompt_text": "string" }, "custom_application_generation_logic_options": { "lambda_function_id": "string" }, "custom_field_values": [ {} ], "custom_order_preprocessing_options": { "lambda_function_id": "string" }, "custom_order_pricing_options": { "lambda_function_id": "string" }, "default_grace_period": 0.1, "directory_opt_out_fields": [ "string" ], "disable_electronic_payment_vaulting": true, "document_settings": { "restrict_management_to_positions": true, "restricted_position_ids": {} }, "enable_add_ons": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_chapter_administration": true, "enable_chapters": true, "enable_custom_application_generation_logic": true, "enable_custom_order_preprocessing": true, "enable_custom_order_pricing": true, "enable_directory_field_level_opt_out": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_group_membership_applications": true, "enable_id_cards": true, "enable_no_processes_message": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_reinstatement": true, "enable_sections": true, "enable_split_payments": true, "id_card_settings": { "allow_printing_in_portal": true, "default_id_card_template_id": "string" }, "include_flowdown_members_in_kpis": true, "installment_plan_options": [ {} ], "invoice_payment_terms_id": "string", "invoice_template_id": "string", "membership_360_screen_id": "string", "membership_console_page_layout_id": "string", "membership_portal_page_layout_id": "string", "merchant_account_id": "string", "no_processes_message": "string", "notes": "string", "override_chapter_center_template": true, "override_view_member_template": true, "pay_later_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "reinstatement_options": { "calculate_reinstatement_period_using": "expiration date", "do_not_show_join_processes_during_reinstatement_period": true, "give_renewal_pricing_during_reinstatement_period": true, "reinstatement_period": 0.1 }, "restocking_fee_product_id": "string", "section_configuration": { "dues_bundling": "inline", "plural_name": "string", "portal_restrictions": "members cannot change sections", "renewal_pricing_strategy": "all renewing members", "singular_name": "string" }, "special_instructions": "string", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ {} ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "update_expiration_based_on_date_of_payment": true, "use_pro_forma_invoices": true, "view_member_html_template": "string" }

Partially updates a setting with the specified ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The patch directives conforming to RFC 6902.

Array [
opstring(Op)required

The operation

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

The JSON path

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

Responses

The setting was patched successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
add_on_configurationobject(Add On Configuration)
allow_committee_members_to_manage_documentsboolean(Allow Committee Members To Manage Documents)

When set, committee members are able to manage documents in the portal

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

allow_members_to_update_auto_renewal_settingsboolean(Allow Members To Update Auto Renewal Settings)

If true, members have the ability to update auto renewal settings in the portal

allow_members_to_update_directory_options_in_portalstring(Allow Members To Update Directory Options In Portal)

If true, members can update directory information when updating their membership

Enum"disabled""enabled""fields only"
bank_account_idstring(Bank Account)required

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

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

The business unit of the store

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

certificate_modestring(Certificate Mode)
Enum"automatically generate""create manually""disabled"
certificate_templatestring(Certificate Template)required
chapter_administration_settingsobject(Chapter Administration Settings)
chapter_center_html_templatestring(Chapter Center Html Template)required

The template to use for showing chapter information in the portal

chapter_configurationobject(Chapter Configuration)
checkout_donation_optionsobject(Checkout Donation Options)required
checkout_donation_options.​simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)
One of:
checkout_donation_options.​typestring(Type)
Value"simple"
conflicting_membership_preferencestring(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"organization""principal"
contact_role_permissionsArray of objects
credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

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

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"
credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required
credit_card_processing_fee_options.​fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.​maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.​minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.​product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.​prompt_sub_textstring(Prompt Sub Text)

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

credit_card_processing_fee_options.​prompt_textstring(Prompt Text)

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

custom_application_generation_logic_optionsobject(Custom Application Generation Logic Options)required
custom_application_generation_logic_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

custom_field_valuesArray of objects(Custom Field Values)
custom_order_preprocessing_optionsobject(Custom Order Preprocessing Options)required
custom_order_preprocessing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

custom_order_pricing_optionsobject(Custom Order Pricing Options)required
custom_order_pricing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

default_grace_periodnumber(float)(Default Grace Period)

The default amount of time after a members expiration during which the are "in grace"

directory_opt_out_fieldsArray of strings(Directory Opt Out Fields)non-emptyrequired

The fields that users can opt out of

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

document_settingsobject(Document Settings)
enable_add_onsboolean(Enable Add Ons)

Whether or not membership add-ons are enabled

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_chapter_administrationboolean(Enable Chapter Administration)

If set, chapters are able to administer their members in the portal

enable_chaptersboolean(Enable Chapters)

Whether chapters are enabled

enable_custom_application_generation_logicboolean(Enable Custom Application Generation Logic)

If set, the application generation logic will call a custom lambda function

enable_custom_order_preprocessingboolean(Enable Custom Order Preprocessing)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

enable_custom_order_pricingboolean(Enable Custom Order Pricing)

If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation

enable_directory_field_level_opt_outboolean(Enable Directory Field Level Opt Out)

If true, users can opt out of the directory specifically

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_group_membership_applicationsboolean(Enable Group Membership Applications)

If set, group membership applications are enbabled

enable_id_cardsboolean(Enable Id Cards)

Support for ID cards that can be downloaded in the portal

enable_no_processes_messageboolean(Enable No Processes Message)

Enable a message that shows when a person has no processes available

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_reinstatementboolean(Enable Reinstatement)

Whether members have the ability to be reinstated after termination

enable_sectionsboolean(Enable Sections)

Whether sections are enabled

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

id_card_settingsobject(Id Card Settings)required
id_card_settings.​allow_printing_in_portalboolean(Allow Printing In Portal)

Whether or not ID cards can be printed in the portal

id_card_settings.​default_id_card_template_idstring(Default Id Card Template)required
include_flowdown_members_in_kpisboolean(Include Flowdown Members In Kpis)

Enable adding flowdown memberships in KPIs

installment_plan_optionsArray of objectsnon-emptyrequired
installment_plan_options[].​additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].​installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].​is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

membership_360_screen_idstring(Membership 360 Screen)^membership-memberships__.*

The default 360 screen for membership editing

membership_console_page_layout_idstring(Membership Console Page Layout)^membership-memberships__.*

The default page layout for membership editing

membership_portal_page_layout_idstring(Membership Portal Page Layout)^membership-memberships__.*

The default page layout for membership editing

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

no_processes_messagestring(No Processes Message)required

Message to show when no processes

notesstring(Notes)
override_chapter_center_templateboolean(Override Chapter Center Template)

If true, a custom template is used for the chapter center

override_view_member_templateboolean(Override View Member Template)

If true, a custom template is used for viewing membership information

pay_later_optionsobject(Pay Later Options)
reinstatement_optionsobject(Reinstatement Options)
restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

section_configurationobject(Section Configuration)
special_instructionsstring(Special Instructions)

Instructions shown to the user

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

update_expiration_based_on_date_of_paymentboolean(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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

view_member_html_templatestring(View Member Html Template)required

The template to use for viewing membership information in the portal

Response
application/json
{ "add_on_configuration": { "dues_bundling": "inline", "plural_name": "string", "portal_restrictions": "members cannot change add ons", "singular_name": "string" }, "allow_committee_members_to_manage_documents": true, "allow_customer_to_choose_installment_plan": true, "allow_members_to_update_auto_renewal_settings": true, "allow_members_to_update_directory_options_in_portal": "disabled", "bank_account_id": "string", "bill_my_organization_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "bill_my_parent_organization_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "certificate_mode": "automatically generate", "certificate_template": "string", "chapter_administration_settings": { "chapter_page_layout_id": "string", "contact_form_id": "string", "membership_page_layout_id": "string", "permissions": [] }, "chapter_center_html_template": "string", "chapter_configuration": { "auto_assignment": "assign", "dues_bundling": "inline", "maximum_number_of_chapters_a_member_can_join": 1, "members_are_required_to_join_a_chapter": true, "plural_name": "string", "portal_restrictions": "members cannot change chapters", "renewal_pricing_strategy": "all renewing members", "singular_name": "string", "update_chapter_when_contact_address_changes": true }, "checkout_donation_options": { "simple_checkout_donation_options": {}, "type": "simple" }, "conflicting_membership_preference": "organization", "contact_role_permissions": [ {} ], "credit_card_minimum_range_end": 0.1, "credit_card_minimum_range_start": 0.1, "credit_card_mode": "disabled", "credit_card_processing_fee_mode": "charge", "credit_card_processing_fee_options": { "fee_percentage": 0.1, "maximum_fee": 0.1, "minimum_fee": 0.1, "product_id": "string", "prompt_sub_text": "string", "prompt_text": "string" }, "custom_application_generation_logic_options": { "lambda_function_id": "string" }, "custom_field_values": [ {} ], "custom_order_preprocessing_options": { "lambda_function_id": "string" }, "custom_order_pricing_options": { "lambda_function_id": "string" }, "default_grace_period": 0.1, "directory_opt_out_fields": [ "string" ], "disable_electronic_payment_vaulting": true, "document_settings": { "restrict_management_to_positions": true, "restricted_position_ids": {} }, "enable_add_ons": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_chapter_administration": true, "enable_chapters": true, "enable_custom_application_generation_logic": true, "enable_custom_order_preprocessing": true, "enable_custom_order_pricing": true, "enable_directory_field_level_opt_out": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_group_membership_applications": true, "enable_id_cards": true, "enable_no_processes_message": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_reinstatement": true, "enable_sections": true, "enable_split_payments": true, "id_card_settings": { "allow_printing_in_portal": true, "default_id_card_template_id": "string" }, "include_flowdown_members_in_kpis": true, "installment_plan_options": [ {} ], "invoice_payment_terms_id": "string", "invoice_template_id": "string", "membership_360_screen_id": "string", "membership_console_page_layout_id": "string", "membership_portal_page_layout_id": "string", "merchant_account_id": "string", "no_processes_message": "string", "notes": "string", "override_chapter_center_template": true, "override_view_member_template": true, "pay_later_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "reinstatement_options": { "calculate_reinstatement_period_using": "expiration date", "do_not_show_join_processes_during_reinstatement_period": true, "give_renewal_pricing_during_reinstatement_period": true, "reinstatement_period": 0.1 }, "restocking_fee_product_id": "string", "section_configuration": { "dues_bundling": "inline", "plural_name": "string", "portal_restrictions": "members cannot change sections", "renewal_pricing_strategy": "all renewing members", "singular_name": "string" }, "special_instructions": "string", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ {} ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "update_expiration_based_on_date_of_payment": true, "use_pro_forma_invoices": true, "view_member_html_template": "string" }

Creates a new setting record that does not already exist.

Request

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.

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The setting that you would like to be saved.

add_on_configurationobject(Add On Configuration)
allow_committee_members_to_manage_documentsboolean(Allow Committee Members To Manage Documents)

When set, committee members are able to manage documents in the portal

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

allow_members_to_update_auto_renewal_settingsboolean(Allow Members To Update Auto Renewal Settings)

If true, members have the ability to update auto renewal settings in the portal

allow_members_to_update_directory_options_in_portalstring(Allow Members To Update Directory Options In Portal)

If true, members can update directory information when updating their membership

Enum"disabled""enabled""fields only"
bank_account_idstring(Bank Account)required

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

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

The business unit of the store

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

certificate_modestring(Certificate Mode)
Enum"automatically generate""create manually""disabled"
certificate_templatestring(Certificate Template)required
chapter_administration_settingsobject(Chapter Administration Settings)
chapter_center_html_templatestring(Chapter Center Html Template)required

The template to use for showing chapter information in the portal

chapter_configurationobject(Chapter Configuration)
checkout_donation_optionsobject(Checkout Donation Options)required
checkout_donation_options.​simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)
One of:
checkout_donation_options.​typestring(Type)
Value"simple"
conflicting_membership_preferencestring(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"organization""principal"
contact_role_permissionsArray of objects
credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

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

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"
credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required
credit_card_processing_fee_options.​fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.​maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.​minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.​product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.​prompt_sub_textstring(Prompt Sub Text)

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

credit_card_processing_fee_options.​prompt_textstring(Prompt Text)

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

custom_application_generation_logic_optionsobject(Custom Application Generation Logic Options)required
custom_application_generation_logic_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

custom_field_valuesArray of objects(Custom Field Values)
custom_order_preprocessing_optionsobject(Custom Order Preprocessing Options)required
custom_order_preprocessing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

custom_order_pricing_optionsobject(Custom Order Pricing Options)required
custom_order_pricing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

default_grace_periodnumber(float)(Default Grace Period)

The default amount of time after a members expiration during which the are "in grace"

directory_opt_out_fieldsArray of strings(Directory Opt Out Fields)non-emptyrequired

The fields that users can opt out of

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

document_settingsobject(Document Settings)
enable_add_onsboolean(Enable Add Ons)

Whether or not membership add-ons are enabled

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_chapter_administrationboolean(Enable Chapter Administration)

If set, chapters are able to administer their members in the portal

enable_chaptersboolean(Enable Chapters)

Whether chapters are enabled

enable_custom_application_generation_logicboolean(Enable Custom Application Generation Logic)

If set, the application generation logic will call a custom lambda function

enable_custom_order_preprocessingboolean(Enable Custom Order Preprocessing)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

enable_custom_order_pricingboolean(Enable Custom Order Pricing)

If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation

enable_directory_field_level_opt_outboolean(Enable Directory Field Level Opt Out)

If true, users can opt out of the directory specifically

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_group_membership_applicationsboolean(Enable Group Membership Applications)

If set, group membership applications are enbabled

enable_id_cardsboolean(Enable Id Cards)

Support for ID cards that can be downloaded in the portal

enable_no_processes_messageboolean(Enable No Processes Message)

Enable a message that shows when a person has no processes available

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_reinstatementboolean(Enable Reinstatement)

Whether members have the ability to be reinstated after termination

enable_sectionsboolean(Enable Sections)

Whether sections are enabled

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

id_card_settingsobject(Id Card Settings)required
id_card_settings.​allow_printing_in_portalboolean(Allow Printing In Portal)

Whether or not ID cards can be printed in the portal

id_card_settings.​default_id_card_template_idstring(Default Id Card Template)required
include_flowdown_members_in_kpisboolean(Include Flowdown Members In Kpis)

Enable adding flowdown memberships in KPIs

installment_plan_optionsArray of objectsnon-emptyrequired
installment_plan_options[].​additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].​installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].​is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

membership_360_screen_idstring(Membership 360 Screen)^membership-memberships__.*

The default 360 screen for membership editing

membership_console_page_layout_idstring(Membership Console Page Layout)^membership-memberships__.*

The default page layout for membership editing

membership_portal_page_layout_idstring(Membership Portal Page Layout)^membership-memberships__.*

The default page layout for membership editing

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

no_processes_messagestring(No Processes Message)required

Message to show when no processes

notesstring(Notes)
override_chapter_center_templateboolean(Override Chapter Center Template)

If true, a custom template is used for the chapter center

override_view_member_templateboolean(Override View Member Template)

If true, a custom template is used for viewing membership information

pay_later_optionsobject(Pay Later Options)
reinstatement_optionsobject(Reinstatement Options)
restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

section_configurationobject(Section Configuration)
special_instructionsstring(Special Instructions)

Instructions shown to the user

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

update_expiration_based_on_date_of_paymentboolean(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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

view_member_html_templatestring(View Member Html Template)required

The template to use for viewing membership information in the portal

curl -i -X POST \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/settings/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "add_on_configuration": {
      "dues_bundling": "inline",
      "plural_name": "string",
      "portal_restrictions": "members cannot change add ons",
      "singular_name": "string"
    },
    "allow_committee_members_to_manage_documents": true,
    "allow_customer_to_choose_installment_plan": true,
    "allow_members_to_update_auto_renewal_settings": true,
    "allow_members_to_update_directory_options_in_portal": "disabled",
    "bank_account_id": "string",
    "bill_my_organization_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "bill_my_parent_organization_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "business_unit_id": "string",
    "cancellation_fee_product_id": "string",
    "certificate_mode": "automatically generate",
    "certificate_template": "string",
    "chapter_administration_settings": {
      "chapter_page_layout_id": "string",
      "contact_form_id": "string",
      "membership_page_layout_id": "string",
      "permissions": [
        {
          "access_saved_queries": true,
          "committee_position_ids": [
            "string"
          ],
          "grace_period": 0.1,
          "manage_chapter_committees": true,
          "manage_chapter_documents": true,
          "renew_existing_members": true,
          "saved_queries": {
            "0": {
              "display_name": "string",
              "saved_query_id": "string"
            }
          },
          "sign_up_new_members": true,
          "update_chapter_info": true,
          "update_contact_info": true,
          "update_membership_info": true,
          "view_chapter_roster": true
        }
      ]
    },
    "chapter_center_html_template": "string",
    "chapter_configuration": {
      "auto_assignment": "assign",
      "dues_bundling": "inline",
      "maximum_number_of_chapters_a_member_can_join": 1,
      "members_are_required_to_join_a_chapter": true,
      "plural_name": "string",
      "portal_restrictions": "members cannot change chapters",
      "renewal_pricing_strategy": "all renewing members",
      "singular_name": "string",
      "update_chapter_when_contact_address_changes": true
    },
    "checkout_donation_options": {
      "simple_checkout_donation_options": {
        "allow_user_to_specify_custom_amount": true,
        "donation_ask_text": "string",
        "donation_denominations": [
          0.1
        ],
        "donation_information": "string",
        "donation_product_id": "string",
        "override_donation_denominations": true,
        "suggested_donation": 0.1
      },
      "type": "simple"
    },
    "conflicting_membership_preference": "organization",
    "contact_role_permissions": [
      {
        "manage_membership_privileges": true,
        "renew_membership": true,
        "role_id": "string",
        "sign_up_for_membership": true,
        "update_membership_info": true
      }
    ],
    "credit_card_minimum_range_end": 0.1,
    "credit_card_minimum_range_start": 0.1,
    "credit_card_mode": "disabled",
    "credit_card_processing_fee_mode": "charge",
    "credit_card_processing_fee_options": {
      "fee_percentage": 0.1,
      "maximum_fee": 0.1,
      "minimum_fee": 0.1,
      "product_id": "string",
      "prompt_sub_text": "string",
      "prompt_text": "string"
    },
    "custom_application_generation_logic_options": {
      "lambda_function_id": "string"
    },
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "custom_order_preprocessing_options": {
      "lambda_function_id": "string"
    },
    "custom_order_pricing_options": {
      "lambda_function_id": "string"
    },
    "default_grace_period": 0.1,
    "directory_opt_out_fields": [
      "string"
    ],
    "disable_electronic_payment_vaulting": true,
    "document_settings": {
      "restrict_management_to_positions": true,
      "restricted_position_ids": {
        "0": "string"
      }
    },
    "enable_add_ons": true,
    "enable_bill_my_organization": true,
    "enable_bill_my_parent_organization": true,
    "enable_chapter_administration": true,
    "enable_chapters": true,
    "enable_custom_application_generation_logic": true,
    "enable_custom_order_preprocessing": true,
    "enable_custom_order_pricing": true,
    "enable_directory_field_level_opt_out": true,
    "enable_donations_at_checkout": true,
    "enable_electronic_checks": true,
    "enable_group_membership_applications": true,
    "enable_id_cards": true,
    "enable_no_processes_message": true,
    "enable_pay_later": true,
    "enable_payroll_deduction": true,
    "enable_reinstatement": true,
    "enable_sections": true,
    "enable_split_payments": true,
    "id_card_settings": {
      "allow_printing_in_portal": true,
      "default_id_card_template_id": "string"
    },
    "include_flowdown_members_in_kpis": true,
    "installment_plan_options": [
      {
        "additional_cost": 0.1,
        "installment_plan_id": "string",
        "is_default": true
      }
    ],
    "invoice_payment_terms_id": "string",
    "invoice_template_id": "string",
    "membership_360_screen_id": "string",
    "membership_console_page_layout_id": "string",
    "membership_portal_page_layout_id": "string",
    "merchant_account_id": "string",
    "no_processes_message": "string",
    "notes": "string",
    "override_chapter_center_template": true,
    "override_view_member_template": true,
    "pay_later_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "reinstatement_options": {
      "calculate_reinstatement_period_using": "expiration date",
      "do_not_show_join_processes_during_reinstatement_period": true,
      "give_renewal_pricing_during_reinstatement_period": true,
      "reinstatement_period": 0.1
    },
    "restocking_fee_product_id": "string",
    "section_configuration": {
      "dues_bundling": "inline",
      "plural_name": "string",
      "portal_restrictions": "members cannot change sections",
      "renewal_pricing_strategy": "all renewing members",
      "singular_name": "string"
    },
    "special_instructions": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "update_expiration_based_on_date_of_payment": true,
    "use_pro_forma_invoices": true,
    "view_member_html_template": "string"
  }'

Responses

The setting was saved successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
add_on_configurationobject(Add On Configuration)
allow_committee_members_to_manage_documentsboolean(Allow Committee Members To Manage Documents)

When set, committee members are able to manage documents in the portal

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

allow_members_to_update_auto_renewal_settingsboolean(Allow Members To Update Auto Renewal Settings)

If true, members have the ability to update auto renewal settings in the portal

allow_members_to_update_directory_options_in_portalstring(Allow Members To Update Directory Options In Portal)

If true, members can update directory information when updating their membership

Enum"disabled""enabled""fields only"
bank_account_idstring(Bank Account)required

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

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

The business unit of the store

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

certificate_modestring(Certificate Mode)
Enum"automatically generate""create manually""disabled"
certificate_templatestring(Certificate Template)required
chapter_administration_settingsobject(Chapter Administration Settings)
chapter_center_html_templatestring(Chapter Center Html Template)required

The template to use for showing chapter information in the portal

chapter_configurationobject(Chapter Configuration)
checkout_donation_optionsobject(Checkout Donation Options)required
checkout_donation_options.​simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)
One of:
checkout_donation_options.​typestring(Type)
Value"simple"
conflicting_membership_preferencestring(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"organization""principal"
contact_role_permissionsArray of objects
credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

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

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"
credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required
credit_card_processing_fee_options.​fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.​maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.​minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.​product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.​prompt_sub_textstring(Prompt Sub Text)

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

credit_card_processing_fee_options.​prompt_textstring(Prompt Text)

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

custom_application_generation_logic_optionsobject(Custom Application Generation Logic Options)required
custom_application_generation_logic_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

custom_field_valuesArray of objects(Custom Field Values)
custom_order_preprocessing_optionsobject(Custom Order Preprocessing Options)required
custom_order_preprocessing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

custom_order_pricing_optionsobject(Custom Order Pricing Options)required
custom_order_pricing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

default_grace_periodnumber(float)(Default Grace Period)

The default amount of time after a members expiration during which the are "in grace"

directory_opt_out_fieldsArray of strings(Directory Opt Out Fields)non-emptyrequired

The fields that users can opt out of

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

document_settingsobject(Document Settings)
enable_add_onsboolean(Enable Add Ons)

Whether or not membership add-ons are enabled

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_chapter_administrationboolean(Enable Chapter Administration)

If set, chapters are able to administer their members in the portal

enable_chaptersboolean(Enable Chapters)

Whether chapters are enabled

enable_custom_application_generation_logicboolean(Enable Custom Application Generation Logic)

If set, the application generation logic will call a custom lambda function

enable_custom_order_preprocessingboolean(Enable Custom Order Preprocessing)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

enable_custom_order_pricingboolean(Enable Custom Order Pricing)

If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation

enable_directory_field_level_opt_outboolean(Enable Directory Field Level Opt Out)

If true, users can opt out of the directory specifically

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_group_membership_applicationsboolean(Enable Group Membership Applications)

If set, group membership applications are enbabled

enable_id_cardsboolean(Enable Id Cards)

Support for ID cards that can be downloaded in the portal

enable_no_processes_messageboolean(Enable No Processes Message)

Enable a message that shows when a person has no processes available

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_reinstatementboolean(Enable Reinstatement)

Whether members have the ability to be reinstated after termination

enable_sectionsboolean(Enable Sections)

Whether sections are enabled

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

id_card_settingsobject(Id Card Settings)required
id_card_settings.​allow_printing_in_portalboolean(Allow Printing In Portal)

Whether or not ID cards can be printed in the portal

id_card_settings.​default_id_card_template_idstring(Default Id Card Template)required
include_flowdown_members_in_kpisboolean(Include Flowdown Members In Kpis)

Enable adding flowdown memberships in KPIs

installment_plan_optionsArray of objectsnon-emptyrequired
installment_plan_options[].​additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].​installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].​is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

membership_360_screen_idstring(Membership 360 Screen)^membership-memberships__.*

The default 360 screen for membership editing

membership_console_page_layout_idstring(Membership Console Page Layout)^membership-memberships__.*

The default page layout for membership editing

membership_portal_page_layout_idstring(Membership Portal Page Layout)^membership-memberships__.*

The default page layout for membership editing

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

no_processes_messagestring(No Processes Message)required

Message to show when no processes

notesstring(Notes)
override_chapter_center_templateboolean(Override Chapter Center Template)

If true, a custom template is used for the chapter center

override_view_member_templateboolean(Override View Member Template)

If true, a custom template is used for viewing membership information

pay_later_optionsobject(Pay Later Options)
reinstatement_optionsobject(Reinstatement Options)
restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

section_configurationobject(Section Configuration)
special_instructionsstring(Special Instructions)

Instructions shown to the user

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

update_expiration_based_on_date_of_paymentboolean(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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

view_member_html_templatestring(View Member Html Template)required

The template to use for viewing membership information in the portal

Response
application/json
{ "add_on_configuration": { "dues_bundling": "inline", "plural_name": "string", "portal_restrictions": "members cannot change add ons", "singular_name": "string" }, "allow_committee_members_to_manage_documents": true, "allow_customer_to_choose_installment_plan": true, "allow_members_to_update_auto_renewal_settings": true, "allow_members_to_update_directory_options_in_portal": "disabled", "bank_account_id": "string", "bill_my_organization_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "bill_my_parent_organization_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "certificate_mode": "automatically generate", "certificate_template": "string", "chapter_administration_settings": { "chapter_page_layout_id": "string", "contact_form_id": "string", "membership_page_layout_id": "string", "permissions": [] }, "chapter_center_html_template": "string", "chapter_configuration": { "auto_assignment": "assign", "dues_bundling": "inline", "maximum_number_of_chapters_a_member_can_join": 1, "members_are_required_to_join_a_chapter": true, "plural_name": "string", "portal_restrictions": "members cannot change chapters", "renewal_pricing_strategy": "all renewing members", "singular_name": "string", "update_chapter_when_contact_address_changes": true }, "checkout_donation_options": { "simple_checkout_donation_options": {}, "type": "simple" }, "conflicting_membership_preference": "organization", "contact_role_permissions": [ {} ], "credit_card_minimum_range_end": 0.1, "credit_card_minimum_range_start": 0.1, "credit_card_mode": "disabled", "credit_card_processing_fee_mode": "charge", "credit_card_processing_fee_options": { "fee_percentage": 0.1, "maximum_fee": 0.1, "minimum_fee": 0.1, "product_id": "string", "prompt_sub_text": "string", "prompt_text": "string" }, "custom_application_generation_logic_options": { "lambda_function_id": "string" }, "custom_field_values": [ {} ], "custom_order_preprocessing_options": { "lambda_function_id": "string" }, "custom_order_pricing_options": { "lambda_function_id": "string" }, "default_grace_period": 0.1, "directory_opt_out_fields": [ "string" ], "disable_electronic_payment_vaulting": true, "document_settings": { "restrict_management_to_positions": true, "restricted_position_ids": {} }, "enable_add_ons": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_chapter_administration": true, "enable_chapters": true, "enable_custom_application_generation_logic": true, "enable_custom_order_preprocessing": true, "enable_custom_order_pricing": true, "enable_directory_field_level_opt_out": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_group_membership_applications": true, "enable_id_cards": true, "enable_no_processes_message": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_reinstatement": true, "enable_sections": true, "enable_split_payments": true, "id_card_settings": { "allow_printing_in_portal": true, "default_id_card_template_id": "string" }, "include_flowdown_members_in_kpis": true, "installment_plan_options": [ {} ], "invoice_payment_terms_id": "string", "invoice_template_id": "string", "membership_360_screen_id": "string", "membership_console_page_layout_id": "string", "membership_portal_page_layout_id": "string", "merchant_account_id": "string", "no_processes_message": "string", "notes": "string", "override_chapter_center_template": true, "override_view_member_template": true, "pay_later_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "reinstatement_options": { "calculate_reinstatement_period_using": "expiration date", "do_not_show_join_processes_during_reinstatement_period": true, "give_renewal_pricing_during_reinstatement_period": true, "reinstatement_period": 0.1 }, "restocking_fee_product_id": "string", "section_configuration": { "dues_bundling": "inline", "plural_name": "string", "portal_restrictions": "members cannot change sections", "renewal_pricing_strategy": "all renewing members", "singular_name": "string" }, "special_instructions": "string", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ {} ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "update_expiration_based_on_date_of_payment": true, "use_pro_forma_invoices": true, "view_member_html_template": "string" }

Updates a setting with the specified ID.

Request

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

Path
tenantIdstringrequired

The id of the tenant being accessed.

Bodyapplication/jsonrequired

The updated setting that will be saved.

add_on_configurationobject(Add On Configuration)
allow_committee_members_to_manage_documentsboolean(Allow Committee Members To Manage Documents)

When set, committee members are able to manage documents in the portal

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

allow_members_to_update_auto_renewal_settingsboolean(Allow Members To Update Auto Renewal Settings)

If true, members have the ability to update auto renewal settings in the portal

allow_members_to_update_directory_options_in_portalstring(Allow Members To Update Directory Options In Portal)

If true, members can update directory information when updating their membership

Enum"disabled""enabled""fields only"
bank_account_idstring(Bank Account)required

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

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

The business unit of the store

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

certificate_modestring(Certificate Mode)
Enum"automatically generate""create manually""disabled"
certificate_templatestring(Certificate Template)required
chapter_administration_settingsobject(Chapter Administration Settings)
chapter_center_html_templatestring(Chapter Center Html Template)required

The template to use for showing chapter information in the portal

chapter_configurationobject(Chapter Configuration)
checkout_donation_optionsobject(Checkout Donation Options)required
checkout_donation_options.​simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)
One of:
checkout_donation_options.​typestring(Type)
Value"simple"
conflicting_membership_preferencestring(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"organization""principal"
contact_role_permissionsArray of objects
credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

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

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"
credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required
credit_card_processing_fee_options.​fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.​maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.​minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.​product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.​prompt_sub_textstring(Prompt Sub Text)

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

credit_card_processing_fee_options.​prompt_textstring(Prompt Text)

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

custom_application_generation_logic_optionsobject(Custom Application Generation Logic Options)required
custom_application_generation_logic_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

custom_field_valuesArray of objects(Custom Field Values)
custom_order_preprocessing_optionsobject(Custom Order Preprocessing Options)required
custom_order_preprocessing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

custom_order_pricing_optionsobject(Custom Order Pricing Options)required
custom_order_pricing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

default_grace_periodnumber(float)(Default Grace Period)

The default amount of time after a members expiration during which the are "in grace"

directory_opt_out_fieldsArray of strings(Directory Opt Out Fields)non-emptyrequired

The fields that users can opt out of

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

document_settingsobject(Document Settings)
enable_add_onsboolean(Enable Add Ons)

Whether or not membership add-ons are enabled

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_chapter_administrationboolean(Enable Chapter Administration)

If set, chapters are able to administer their members in the portal

enable_chaptersboolean(Enable Chapters)

Whether chapters are enabled

enable_custom_application_generation_logicboolean(Enable Custom Application Generation Logic)

If set, the application generation logic will call a custom lambda function

enable_custom_order_preprocessingboolean(Enable Custom Order Preprocessing)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

enable_custom_order_pricingboolean(Enable Custom Order Pricing)

If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation

enable_directory_field_level_opt_outboolean(Enable Directory Field Level Opt Out)

If true, users can opt out of the directory specifically

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_group_membership_applicationsboolean(Enable Group Membership Applications)

If set, group membership applications are enbabled

enable_id_cardsboolean(Enable Id Cards)

Support for ID cards that can be downloaded in the portal

enable_no_processes_messageboolean(Enable No Processes Message)

Enable a message that shows when a person has no processes available

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_reinstatementboolean(Enable Reinstatement)

Whether members have the ability to be reinstated after termination

enable_sectionsboolean(Enable Sections)

Whether sections are enabled

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

id_card_settingsobject(Id Card Settings)required
id_card_settings.​allow_printing_in_portalboolean(Allow Printing In Portal)

Whether or not ID cards can be printed in the portal

id_card_settings.​default_id_card_template_idstring(Default Id Card Template)required
include_flowdown_members_in_kpisboolean(Include Flowdown Members In Kpis)

Enable adding flowdown memberships in KPIs

installment_plan_optionsArray of objectsnon-emptyrequired
installment_plan_options[].​additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].​installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].​is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

membership_360_screen_idstring(Membership 360 Screen)^membership-memberships__.*

The default 360 screen for membership editing

membership_console_page_layout_idstring(Membership Console Page Layout)^membership-memberships__.*

The default page layout for membership editing

membership_portal_page_layout_idstring(Membership Portal Page Layout)^membership-memberships__.*

The default page layout for membership editing

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

no_processes_messagestring(No Processes Message)required

Message to show when no processes

notesstring(Notes)
override_chapter_center_templateboolean(Override Chapter Center Template)

If true, a custom template is used for the chapter center

override_view_member_templateboolean(Override View Member Template)

If true, a custom template is used for viewing membership information

pay_later_optionsobject(Pay Later Options)
reinstatement_optionsobject(Reinstatement Options)
restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

section_configurationobject(Section Configuration)
special_instructionsstring(Special Instructions)

Instructions shown to the user

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

update_expiration_based_on_date_of_paymentboolean(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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

view_member_html_templatestring(View Member Html Template)required

The template to use for viewing membership information in the portal

curl -i -X PUT \
  'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/settings/{tenantId}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "add_on_configuration": {
      "dues_bundling": "inline",
      "plural_name": "string",
      "portal_restrictions": "members cannot change add ons",
      "singular_name": "string"
    },
    "allow_committee_members_to_manage_documents": true,
    "allow_customer_to_choose_installment_plan": true,
    "allow_members_to_update_auto_renewal_settings": true,
    "allow_members_to_update_directory_options_in_portal": "disabled",
    "bank_account_id": "string",
    "bill_my_organization_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "bill_my_parent_organization_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "business_unit_id": "string",
    "cancellation_fee_product_id": "string",
    "certificate_mode": "automatically generate",
    "certificate_template": "string",
    "chapter_administration_settings": {
      "chapter_page_layout_id": "string",
      "contact_form_id": "string",
      "membership_page_layout_id": "string",
      "permissions": [
        {
          "access_saved_queries": true,
          "committee_position_ids": [
            "string"
          ],
          "grace_period": 0.1,
          "manage_chapter_committees": true,
          "manage_chapter_documents": true,
          "renew_existing_members": true,
          "saved_queries": {
            "0": {
              "display_name": "string",
              "saved_query_id": "string"
            }
          },
          "sign_up_new_members": true,
          "update_chapter_info": true,
          "update_contact_info": true,
          "update_membership_info": true,
          "view_chapter_roster": true
        }
      ]
    },
    "chapter_center_html_template": "string",
    "chapter_configuration": {
      "auto_assignment": "assign",
      "dues_bundling": "inline",
      "maximum_number_of_chapters_a_member_can_join": 1,
      "members_are_required_to_join_a_chapter": true,
      "plural_name": "string",
      "portal_restrictions": "members cannot change chapters",
      "renewal_pricing_strategy": "all renewing members",
      "singular_name": "string",
      "update_chapter_when_contact_address_changes": true
    },
    "checkout_donation_options": {
      "simple_checkout_donation_options": {
        "allow_user_to_specify_custom_amount": true,
        "donation_ask_text": "string",
        "donation_denominations": [
          0.1
        ],
        "donation_information": "string",
        "donation_product_id": "string",
        "override_donation_denominations": true,
        "suggested_donation": 0.1
      },
      "type": "simple"
    },
    "conflicting_membership_preference": "organization",
    "contact_role_permissions": [
      {
        "manage_membership_privileges": true,
        "renew_membership": true,
        "role_id": "string",
        "sign_up_for_membership": true,
        "update_membership_info": true
      }
    ],
    "credit_card_minimum_range_end": 0.1,
    "credit_card_minimum_range_start": 0.1,
    "credit_card_mode": "disabled",
    "credit_card_processing_fee_mode": "charge",
    "credit_card_processing_fee_options": {
      "fee_percentage": 0.1,
      "maximum_fee": 0.1,
      "minimum_fee": 0.1,
      "product_id": "string",
      "prompt_sub_text": "string",
      "prompt_text": "string"
    },
    "custom_application_generation_logic_options": {
      "lambda_function_id": "string"
    },
    "custom_field_values": [
      {
        "boolean_value": true,
        "custom_field_id": "string",
        "file_url_value": "string",
        "list_value": [
          "string"
        ],
        "numeric_value": 0.1,
        "string_value": "string",
        "table_value": [
          {}
        ]
      }
    ],
    "custom_order_preprocessing_options": {
      "lambda_function_id": "string"
    },
    "custom_order_pricing_options": {
      "lambda_function_id": "string"
    },
    "default_grace_period": 0.1,
    "directory_opt_out_fields": [
      "string"
    ],
    "disable_electronic_payment_vaulting": true,
    "document_settings": {
      "restrict_management_to_positions": true,
      "restricted_position_ids": {
        "0": "string"
      }
    },
    "enable_add_ons": true,
    "enable_bill_my_organization": true,
    "enable_bill_my_parent_organization": true,
    "enable_chapter_administration": true,
    "enable_chapters": true,
    "enable_custom_application_generation_logic": true,
    "enable_custom_order_preprocessing": true,
    "enable_custom_order_pricing": true,
    "enable_directory_field_level_opt_out": true,
    "enable_donations_at_checkout": true,
    "enable_electronic_checks": true,
    "enable_group_membership_applications": true,
    "enable_id_cards": true,
    "enable_no_processes_message": true,
    "enable_pay_later": true,
    "enable_payroll_deduction": true,
    "enable_reinstatement": true,
    "enable_sections": true,
    "enable_split_payments": true,
    "id_card_settings": {
      "allow_printing_in_portal": true,
      "default_id_card_template_id": "string"
    },
    "include_flowdown_members_in_kpis": true,
    "installment_plan_options": [
      {
        "additional_cost": 0.1,
        "installment_plan_id": "string",
        "is_default": true
      }
    ],
    "invoice_payment_terms_id": "string",
    "invoice_template_id": "string",
    "membership_360_screen_id": "string",
    "membership_console_page_layout_id": "string",
    "membership_portal_page_layout_id": "string",
    "merchant_account_id": "string",
    "no_processes_message": "string",
    "notes": "string",
    "override_chapter_center_template": true,
    "override_view_member_template": true,
    "pay_later_options": {
      "billing_address": "do not show",
      "purchase_order_number": "do not show",
      "reference_number": "string"
    },
    "reinstatement_options": {
      "calculate_reinstatement_period_using": "expiration date",
      "do_not_show_join_processes_during_reinstatement_period": true,
      "give_renewal_pricing_during_reinstatement_period": true,
      "reinstatement_period": 0.1
    },
    "restocking_fee_product_id": "string",
    "section_configuration": {
      "dues_bundling": "inline",
      "plural_name": "string",
      "portal_restrictions": "members cannot change sections",
      "renewal_pricing_strategy": "all renewing members",
      "singular_name": "string"
    },
    "special_instructions": "string",
    "sys_bulk_load_at": "string",
    "sys_bulk_load_id": "string",
    "sys_bulk_load_pk": "string",
    "sys_bulk_load_record_no": 0.1,
    "sys_bulk_load_source_file": "string",
    "sys_calculated_field_error": "string",
    "sys_calculated_field_errors": [
      {
        "error": "string",
        "field": "string"
      }
    ],
    "sys_configuration_snapshot_id": "string",
    "sys_created_at": "2019-08-24T14:15:22Z",
    "sys_created_by_id": "string",
    "sys_deleted_by_id": "string",
    "sys_directive": "string",
    "sys_external_id": "string",
    "sys_has_files_in_s3": true,
    "sys_last_bulk_data_operation_id": "string",
    "sys_last_bulk_data_operation_sys_version": "string",
    "sys_last_modified_at": "2019-08-24T14:15:22Z",
    "sys_last_modified_by_id": "string",
    "sys_last_security_context": {},
    "sys_locked": true,
    "sys_snapshot_base_version": 0.1,
    "sys_version": 0.1,
    "update_expiration_based_on_date_of_payment": true,
    "use_pro_forma_invoices": true,
    "view_member_html_template": "string"
  }'

Responses

The setting was updated successfully.

Headers
Access-Control-Allow-Headersstring
Access-Control-Allow-Methodsstring
Access-Control-Allow-Originstring
Bodyapplication/json
add_on_configurationobject(Add On Configuration)
allow_committee_members_to_manage_documentsboolean(Allow Committee Members To Manage Documents)

When set, committee members are able to manage documents in the portal

allow_customer_to_choose_installment_planboolean(Allow Customer To Choose Installment Plan)

If true, the customer can choose their installment plan

allow_members_to_update_auto_renewal_settingsboolean(Allow Members To Update Auto Renewal Settings)

If true, members have the ability to update auto renewal settings in the portal

allow_members_to_update_directory_options_in_portalstring(Allow Members To Update Directory Options In Portal)

If true, members can update directory information when updating their membership

Enum"disabled""enabled""fields only"
bank_account_idstring(Bank Account)required

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

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

The business unit of the store

cancellation_fee_product_idstring(Cancellation Fee Product)

The ID of the product used for cancellation fees

certificate_modestring(Certificate Mode)
Enum"automatically generate""create manually""disabled"
certificate_templatestring(Certificate Template)required
chapter_administration_settingsobject(Chapter Administration Settings)
chapter_center_html_templatestring(Chapter Center Html Template)required

The template to use for showing chapter information in the portal

chapter_configurationobject(Chapter Configuration)
checkout_donation_optionsobject(Checkout Donation Options)required
checkout_donation_options.​simple_checkout_donation_optionsSimple Checkout Donation Options (object)(Simple Checkout Donation Options)
One of:
checkout_donation_options.​typestring(Type)
Value"simple"
conflicting_membership_preferencestring(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"organization""principal"
contact_role_permissionsArray of objects
credit_card_minimum_range_endnumber(float)(Credit Card Minimum Range End)

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

credit_card_minimum_range_startnumber(float)(Credit Card Minimum Range Start)

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

credit_card_modestring(Credit Card Mode)

Determines whether or not credit cards are accepted

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

Determines how credit card processing fees should be handled

Enum"charge""do not charge""prompt user"
credit_card_processing_fee_optionsobject(Credit Card Processing Fee Options)required
credit_card_processing_fee_options.​fee_percentagenumber(float)(Fee Percentage)required

The fee percentage to charge for credit card processing

credit_card_processing_fee_options.​maximum_feenumber(float)(Maximum Fee)

The maximum amount to charge. If the fee comes out to be MORE than this, than this amount will be charged

credit_card_processing_fee_options.​minimum_feenumber(float)(Minimum Fee)

The minimum amount to charge. If the fee comes out to be less than this, than this amount will be charged

credit_card_processing_fee_options.​product_idstring(Product)required

The misc product to use for the credit card processing

credit_card_processing_fee_options.​prompt_sub_textstring(Prompt Sub Text)

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

credit_card_processing_fee_options.​prompt_textstring(Prompt Text)

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

custom_application_generation_logic_optionsobject(Custom Application Generation Logic Options)required
custom_application_generation_logic_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

custom_field_valuesArray of objects(Custom Field Values)
custom_order_preprocessing_optionsobject(Custom Order Preprocessing Options)required
custom_order_preprocessing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

custom_order_pricing_optionsobject(Custom Order Pricing Options)required
custom_order_pricing_options.​lambda_function_idstring(Lambda Function)required

The custom lambda function to use

default_grace_periodnumber(float)(Default Grace Period)

The default amount of time after a members expiration during which the are "in grace"

directory_opt_out_fieldsArray of strings(Directory Opt Out Fields)non-emptyrequired

The fields that users can opt out of

disable_electronic_payment_vaultingboolean(Disable Electronic Payment Vaulting)

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

document_settingsobject(Document Settings)
enable_add_onsboolean(Enable Add Ons)

Whether or not membership add-ons are enabled

enable_bill_my_organizationboolean(Enable Bill My Organization)

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

enable_bill_my_parent_organizationboolean(Enable Bill My Parent Organization)

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

enable_chapter_administrationboolean(Enable Chapter Administration)

If set, chapters are able to administer their members in the portal

enable_chaptersboolean(Enable Chapters)

Whether chapters are enabled

enable_custom_application_generation_logicboolean(Enable Custom Application Generation Logic)

If set, the application generation logic will call a custom lambda function

enable_custom_order_preprocessingboolean(Enable Custom Order Preprocessing)

If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion

enable_custom_order_pricingboolean(Enable Custom Order Pricing)

If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation

enable_directory_field_level_opt_outboolean(Enable Directory Field Level Opt Out)

If true, users can opt out of the directory specifically

enable_donations_at_checkoutboolean(Enable Donations At Checkout)

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

enable_electronic_checksboolean(Enable Electronic Checks)

If set, electronic checks are allowed

enable_group_membership_applicationsboolean(Enable Group Membership Applications)

If set, group membership applications are enbabled

enable_id_cardsboolean(Enable Id Cards)

Support for ID cards that can be downloaded in the portal

enable_no_processes_messageboolean(Enable No Processes Message)

Enable a message that shows when a person has no processes available

enable_pay_laterboolean(Enable Pay Later)

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

enable_payroll_deductionboolean(Enable Payroll Deduction)

If set, payroll deduction is allowed

enable_reinstatementboolean(Enable Reinstatement)

Whether members have the ability to be reinstated after termination

enable_sectionsboolean(Enable Sections)

Whether sections are enabled

enable_split_paymentsboolean(Enable Split Payments)

If set, users are allowed to split payments

id_card_settingsobject(Id Card Settings)required
id_card_settings.​allow_printing_in_portalboolean(Allow Printing In Portal)

Whether or not ID cards can be printed in the portal

id_card_settings.​default_id_card_template_idstring(Default Id Card Template)required
include_flowdown_members_in_kpisboolean(Include Flowdown Members In Kpis)

Enable adding flowdown memberships in KPIs

installment_plan_optionsArray of objectsnon-emptyrequired
installment_plan_options[].​additional_costnumber(double)(Additional Cost)

The additional cost of the installment plan

installment_plan_options[].​installment_plan_idstring(Installment Plan)required

The installment plan that this product supports

installment_plan_options[].​is_defaultboolean(Is Default)

Whether this is the default installment plan option

invoice_payment_terms_idstring(Invoice Payment Terms)

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

invoice_template_idstring(Invoice Template)

The template to use for invoices created during this process

membership_360_screen_idstring(Membership 360 Screen)^membership-memberships__.*

The default 360 screen for membership editing

membership_console_page_layout_idstring(Membership Console Page Layout)^membership-memberships__.*

The default page layout for membership editing

membership_portal_page_layout_idstring(Membership Portal Page Layout)^membership-memberships__.*

The default page layout for membership editing

merchant_account_idstring(Merchant Account)required

The merchant account that the store should use to receive payments

no_processes_messagestring(No Processes Message)required

Message to show when no processes

notesstring(Notes)
override_chapter_center_templateboolean(Override Chapter Center Template)

If true, a custom template is used for the chapter center

override_view_member_templateboolean(Override View Member Template)

If true, a custom template is used for viewing membership information

pay_later_optionsobject(Pay Later Options)
reinstatement_optionsobject(Reinstatement Options)
restocking_fee_product_idstring(Restocking Fee Product)

The ID of the product used for restocking fees

section_configurationobject(Section Configuration)
special_instructionsstring(Special Instructions)

Instructions shown to the user

sys_bulk_load_atstring(Sys Bulk Load At)

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

sys_bulk_load_idstring(Sys Bulk Load)

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

sys_bulk_load_pkstring(Sys Bulk Load Pk)

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

sys_bulk_load_record_nonumber(float)(Sys Bulk Load Record No)

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

sys_bulk_load_source_filestring(Sys Bulk Load Source File)

If this record was loaded via bulk, the source file

sys_calculated_field_errorstring(Sys Calculated Field Error)

The error associated with the calculated field

sys_calculated_field_errorsArray of objects
sys_configuration_snapshot_idstring(Sys Configuration Snapshot)

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

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

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

sys_created_by_idstring(Sys Created By)required

The ID of the user that created this record

sys_deleted_by_idstring(Sys Deleted By)

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

sys_directivestring(Sys Directive)

Means for passing directive information into an object processing logic

sys_external_idstring(Sys External)

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

sys_has_files_in_s3boolean(Sys Has Files In S3)

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

sys_last_bulk_data_operation_idstring(Sys Last Bulk Data Operation)

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

sys_last_bulk_data_operation_sys_versionstring(Sys Last Bulk Data Operation Sys Version)

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

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

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

sys_last_modified_by_idstring(Sys Last Modified By)required

The ID of the user that last modified this record

sys_last_security_contextobject(Sys Last Security Context)

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

sys_lockedboolean(Sys Locked)

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

sys_snapshot_base_versionnumber(float)(Sys Snapshot Base Version)

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

sys_versionnumber(float)(Sys Version)

A number representing the version of this record in the database

update_expiration_based_on_date_of_paymentboolean(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

use_pro_forma_invoicesboolean(Use Pro Forma Invoices)

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

view_member_html_templatestring(View Member Html Template)required

The template to use for viewing membership information in the portal

Response
application/json
{ "add_on_configuration": { "dues_bundling": "inline", "plural_name": "string", "portal_restrictions": "members cannot change add ons", "singular_name": "string" }, "allow_committee_members_to_manage_documents": true, "allow_customer_to_choose_installment_plan": true, "allow_members_to_update_auto_renewal_settings": true, "allow_members_to_update_directory_options_in_portal": "disabled", "bank_account_id": "string", "bill_my_organization_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "bill_my_parent_organization_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "certificate_mode": "automatically generate", "certificate_template": "string", "chapter_administration_settings": { "chapter_page_layout_id": "string", "contact_form_id": "string", "membership_page_layout_id": "string", "permissions": [] }, "chapter_center_html_template": "string", "chapter_configuration": { "auto_assignment": "assign", "dues_bundling": "inline", "maximum_number_of_chapters_a_member_can_join": 1, "members_are_required_to_join_a_chapter": true, "plural_name": "string", "portal_restrictions": "members cannot change chapters", "renewal_pricing_strategy": "all renewing members", "singular_name": "string", "update_chapter_when_contact_address_changes": true }, "checkout_donation_options": { "simple_checkout_donation_options": {}, "type": "simple" }, "conflicting_membership_preference": "organization", "contact_role_permissions": [ {} ], "credit_card_minimum_range_end": 0.1, "credit_card_minimum_range_start": 0.1, "credit_card_mode": "disabled", "credit_card_processing_fee_mode": "charge", "credit_card_processing_fee_options": { "fee_percentage": 0.1, "maximum_fee": 0.1, "minimum_fee": 0.1, "product_id": "string", "prompt_sub_text": "string", "prompt_text": "string" }, "custom_application_generation_logic_options": { "lambda_function_id": "string" }, "custom_field_values": [ {} ], "custom_order_preprocessing_options": { "lambda_function_id": "string" }, "custom_order_pricing_options": { "lambda_function_id": "string" }, "default_grace_period": 0.1, "directory_opt_out_fields": [ "string" ], "disable_electronic_payment_vaulting": true, "document_settings": { "restrict_management_to_positions": true, "restricted_position_ids": {} }, "enable_add_ons": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_chapter_administration": true, "enable_chapters": true, "enable_custom_application_generation_logic": true, "enable_custom_order_preprocessing": true, "enable_custom_order_pricing": true, "enable_directory_field_level_opt_out": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_group_membership_applications": true, "enable_id_cards": true, "enable_no_processes_message": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_reinstatement": true, "enable_sections": true, "enable_split_payments": true, "id_card_settings": { "allow_printing_in_portal": true, "default_id_card_template_id": "string" }, "include_flowdown_members_in_kpis": true, "installment_plan_options": [ {} ], "invoice_payment_terms_id": "string", "invoice_template_id": "string", "membership_360_screen_id": "string", "membership_console_page_layout_id": "string", "membership_portal_page_layout_id": "string", "merchant_account_id": "string", "no_processes_message": "string", "notes": "string", "override_chapter_center_template": true, "override_view_member_template": true, "pay_later_options": { "billing_address": "do not show", "purchase_order_number": "do not show", "reference_number": "string" }, "reinstatement_options": { "calculate_reinstatement_period_using": "expiration date", "do_not_show_join_processes_during_reinstatement_period": true, "give_renewal_pricing_during_reinstatement_period": true, "reinstatement_period": 0.1 }, "restocking_fee_product_id": "string", "section_configuration": { "dues_bundling": "inline", "plural_name": "string", "portal_restrictions": "members cannot change sections", "renewal_pricing_strategy": "all renewing members", "singular_name": "string" }, "special_instructions": "string", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ {} ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "update_expiration_based_on_date_of_payment": true, "use_pro_forma_invoices": true, "view_member_html_template": "string" }

Statistics

Statistics

Operations

Status Reasons

Status Reasons

Operations

Types

Types

Operations