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.
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/
https://membership.api.rhythmsoftware.com/
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/applicationProcesses/{tenantId}
https://membership.api.rhythmsoftware.com/applicationProcesses/{tenantId}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/applicationProcesses/{tenantId}?exclusiveStartKey=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The application processeswere retrieved successfully.
The origin types that are applicable to this process - blank for just principle
The email to send when the application is received
If set, if someone creates add on dues, then the system should prorate those dues based on the amount of time left in the membership
If set, if someone adds a chapter, then the system should prorate those dues based on the amount of time left in the membership
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
A description of the process to help the user understand whether to choose
If true, the confirmation email is sent out when a user completes but does not pay, and an activation email goes out upon payment
If true, do NOT set the default package for renewals, instead forcing them to choose one
Whether or not an email should be sent when the application is received
If set, the application generation logic will call a custom lambda function
If set, custom order generation logic is run
Whether or not to send an email when the membership is actually activated
Whether order generation rules apply
Whether section requirements are enabled for this membership type
The default application form for this process membership
Email to send once the membership is activated
Whether or not memberships require approval
The conditions upon which this expiration rule applies. If not set, then this expiration rule always applies
If set, membership group admins can add/change add ons
If set, membership group admins can add/change chapters
Whether or not to override POC settings
The packages in this path are restricted
The membership types in this path are restricted
Restrict to certain types of organizations
The maximum number of overall sections
The minimum number of overall sections
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
[ { "applicable_origins": [ … ], "application_confirmation_email": { … }, "approval_chapter_ids": [ … ], "approval_lambda_function_id": "string", "change_options": { … }, "checkout_settings": { … }, "contact_form_options": { … }, "custom_application_generation_logic_options": { … }, "custom_application_pre_processing_lambda_function_id": "string", "customer_type": "contact", "description": "string", "display_in_portal": true, "display_in_portal_as": "string", "display_order": 0.1, "do_not_send_activation_email_until_membership_is_paid": true, "do_not_set_default_renewal_package": true, "eligibility_criteria": {}, "enable_application_confirmation_email": true, "enable_custom_application_generation_logic": true, "enable_custom_application_pre_processing": true, "enable_eligibility_criteria": true, "enable_membership_activation_email": true, "enable_order_generation_rules": true, "enable_section_restrictions": true, "form_id": "string", "id": "string", "is_active": true, "membership_activation_email": { … }, "membership_package_ids": [ … ], "membership_type_ids": [ … ], "memberships_require_approval": "always", "name": "string", "order_generation_rules": [ … ], "organization_form_options": { … }, "organization_type_ids": [ … ], "organizational_membership_options": { … }, "override_checkout_settings": true, "reinstatement_options": { … }, "renewal_options": { … }, "restrict_membership_packages": true, "restrict_membership_types": true, "restrict_organization_types": true, "section_restrictions": { … }, "show_contact_form": true, "show_organization_form": true, "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, "type": "change affiliations" } ]
The application process that you would like to be saved.
The origin types that are applicable to this process - blank for just principle
The email to send when the application is received
If set, if someone creates add on dues, then the system should prorate those dues based on the amount of time left in the membership
If set, if someone adds a chapter, then the system should prorate those dues based on the amount of time left in the membership
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
A description of the process to help the user understand whether to choose
If true, the confirmation email is sent out when a user completes but does not pay, and an activation email goes out upon payment
If true, do NOT set the default package for renewals, instead forcing them to choose one
Whether or not an email should be sent when the application is received
If set, the application generation logic will call a custom lambda function
If set, custom order generation logic is run
Whether or not to send an email when the membership is actually activated
Whether order generation rules apply
Whether section requirements are enabled for this membership type
The default application form for this process membership
Email to send once the membership is activated
Whether or not memberships require approval
The conditions upon which this expiration rule applies. If not set, then this expiration rule always applies
If set, membership group admins can add/change add ons
If set, membership group admins can add/change chapters
Whether or not to override POC settings
The packages in this path are restricted
The membership types in this path are restricted
Restrict to certain types of organizations
The maximum number of overall sections
The minimum number of overall sections
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/applicationProcesses/{tenantId}
https://membership.api.rhythmsoftware.com/applicationProcesses/{tenantId}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/applicationProcesses/{tenantId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"applicable_origins": [
"string"
],
"application_confirmation_email": {
"bcc": "string",
"body": "string",
"cc": "string",
"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string"
},
"approval_chapter_ids": [
"string"
],
"approval_lambda_function_id": "string",
"change_options": {
"change_fee_id": "string",
"prorate_add_on_dues": true,
"prorate_chapter_dues": true,
"prorate_section_dues": true
},
"checkout_settings": {
"allow_customer_to_choose_installment_plan": true,
"bank_account_id": "string",
"bill_my_organization_options": {
"billing_address": "do not show",
"purchase_order_number": "do not show",
"reference_number": "string"
},
"bill_my_parent_organization_options": {
"billing_address": "do not show",
"purchase_order_number": "do not show",
"reference_number": "string"
},
"business_unit_id": "string",
"cancellation_fee_product_id": "string",
"checkout_donation_options": {
"simple_checkout_donation_options": {
"allow_user_to_specify_custom_amount": true,
"donation_ask_text": "string",
"donation_denominations": [
0.1
],
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0.1
},
"type": "simple"
},
"credit_card_minimum_range_end": 0.1,
"credit_card_minimum_range_start": 0.1,
"credit_card_mode": "disabled",
"credit_card_processing_fee_mode": "charge",
"credit_card_processing_fee_options": {
"fee_percentage": 0.1,
"maximum_fee": 0.1,
"minimum_fee": 0.1,
"product_id": "string",
"prompt_sub_text": "string",
"prompt_text": "string"
},
"custom_order_preprocessing_options": {
"lambda_function_id": "string"
},
"custom_order_pricing_options": {
"lambda_function_id": "string"
},
"disable_electronic_payment_vaulting": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"enable_custom_order_preprocessing": true,
"enable_custom_order_pricing": true,
"enable_donations_at_checkout": true,
"enable_electronic_checks": true,
"enable_pay_later": true,
"enable_payroll_deduction": true,
"enable_split_payments": true,
"installment_plan_options": {
"0": {
"additional_cost": 0.1,
"installment_plan_id": "string",
"is_default": true
}
},
"invoice_payment_terms_id": "string",
"invoice_template_id": "string",
"merchant_account_id": "string",
"pay_later_options": {
"billing_address": "do not show",
"purchase_order_number": "do not show",
"reference_number": "string"
},
"restocking_fee_product_id": "string",
"special_instructions": "string",
"use_pro_forma_invoices": true
},
"contact_form_options": {
"contact_form_id": "string",
"html": "string"
},
"custom_application_generation_logic_options": {
"lambda_function_id": "string"
},
"custom_application_pre_processing_lambda_function_id": "string",
"customer_type": "contact",
"description": "string",
"display_in_portal": true,
"display_in_portal_as": "string",
"display_order": 0.1,
"do_not_send_activation_email_until_membership_is_paid": true,
"do_not_set_default_renewal_package": true,
"eligibility_criteria": {},
"enable_application_confirmation_email": true,
"enable_custom_application_generation_logic": true,
"enable_custom_application_pre_processing": true,
"enable_eligibility_criteria": true,
"enable_membership_activation_email": true,
"enable_order_generation_rules": true,
"enable_section_restrictions": true,
"form_id": "string",
"id": "string",
"is_active": true,
"membership_activation_email": {
"bcc": "string",
"body": "string",
"cc": "string",
"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string"
},
"membership_package_ids": [
"string"
],
"membership_type_ids": [
"string"
],
"memberships_require_approval": "always",
"name": "string",
"order_generation_rules": [
{
"add_on_options": {
"add_ons": [
{
"add_on_id": "string",
"quantity": null,
"quantity_calculation_strategy": "static value"
}
]
},
"assign_add_ons": true,
"assign_package": true,
"matching_conditions": {
"all": [
{
"all": {},
"any": {},
"fact": "string",
"operator": "contains",
"path": "string",
"value": "string"
}
],
"any": [
{
"all": {},
"any": {},
"fact": "string",
"operator": "contains",
"path": "string",
"value": "string"
}
]
},
"name": "string",
"package_options": {
"package_id": "string"
}
}
],
"organization_form_options": {
"html": "string",
"organization_form_id": "string"
},
"organization_type_ids": [
"string"
],
"organizational_membership_options": {
"allow_admin_to_modify_add_ons": true,
"allow_admin_to_modify_chapters": true,
"allow_admin_to_modify_sections": true,
"quick_add_contact_options": {}
},
"override_checkout_settings": true,
"reinstatement_options": {
"calculate_reinstatement_period_using": "default",
"reinstatement_period": 0.1
},
"renewal_options": {
"renewal_window": 0.1
},
"restrict_membership_packages": true,
"restrict_membership_types": true,
"restrict_organization_types": true,
"section_restrictions": {
"maximum_number_of_sections": 0.1,
"minimum_number_of_sections": 0.1,
"section_type_restrictions": [
{
"maximum": 0.1,
"minimum": 0.1,
"section_type_id": "string"
}
]
},
"show_contact_form": true,
"show_organization_form": true,
"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,
"type": "change affiliations"
}'The application process was saved successfully.
The origin types that are applicable to this process - blank for just principle
The email to send when the application is received
If set, if someone creates add on dues, then the system should prorate those dues based on the amount of time left in the membership
If set, if someone adds a chapter, then the system should prorate those dues based on the amount of time left in the membership
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
A description of the process to help the user understand whether to choose
If true, the confirmation email is sent out when a user completes but does not pay, and an activation email goes out upon payment
If true, do NOT set the default package for renewals, instead forcing them to choose one
Whether or not an email should be sent when the application is received
If set, the application generation logic will call a custom lambda function
If set, custom order generation logic is run
Whether or not to send an email when the membership is actually activated
Whether order generation rules apply
Whether section requirements are enabled for this membership type
The default application form for this process membership
Email to send once the membership is activated
Whether or not memberships require approval
The conditions upon which this expiration rule applies. If not set, then this expiration rule always applies
If set, membership group admins can add/change add ons
If set, membership group admins can add/change chapters
Whether or not to override POC settings
The packages in this path are restricted
The membership types in this path are restricted
Restrict to certain types of organizations
The maximum number of overall sections
The minimum number of overall sections
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
{ "applicable_origins": [ "string" ], "application_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "approval_chapter_ids": [ "string" ], "approval_lambda_function_id": "string", "change_options": { "change_fee_id": "string", "prorate_add_on_dues": true, "prorate_chapter_dues": true, "prorate_section_dues": true }, "checkout_settings": { "allow_customer_to_choose_installment_plan": true, "bank_account_id": "string", "bill_my_organization_options": { … }, "bill_my_parent_organization_options": { … }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "checkout_donation_options": { … }, "credit_card_minimum_range_end": 0.1, "credit_card_minimum_range_start": 0.1, "credit_card_mode": "disabled", "credit_card_processing_fee_mode": "charge", "credit_card_processing_fee_options": { … }, "custom_order_preprocessing_options": { … }, "custom_order_pricing_options": { … }, "disable_electronic_payment_vaulting": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_custom_order_preprocessing": true, "enable_custom_order_pricing": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_split_payments": true, "installment_plan_options": { … }, "invoice_payment_terms_id": "string", "invoice_template_id": "string", "merchant_account_id": "string", "pay_later_options": { … }, "restocking_fee_product_id": "string", "special_instructions": "string", "use_pro_forma_invoices": true }, "contact_form_options": { "contact_form_id": "string", "html": "string" }, "custom_application_generation_logic_options": { "lambda_function_id": "string" }, "custom_application_pre_processing_lambda_function_id": "string", "customer_type": "contact", "description": "string", "display_in_portal": true, "display_in_portal_as": "string", "display_order": 0.1, "do_not_send_activation_email_until_membership_is_paid": true, "do_not_set_default_renewal_package": true, "eligibility_criteria": {}, "enable_application_confirmation_email": true, "enable_custom_application_generation_logic": true, "enable_custom_application_pre_processing": true, "enable_eligibility_criteria": true, "enable_membership_activation_email": true, "enable_order_generation_rules": true, "enable_section_restrictions": true, "form_id": "string", "id": "string", "is_active": true, "membership_activation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "membership_package_ids": [ "string" ], "membership_type_ids": [ "string" ], "memberships_require_approval": "always", "name": "string", "order_generation_rules": [ { … } ], "organization_form_options": { "html": "string", "organization_form_id": "string" }, "organization_type_ids": [ "string" ], "organizational_membership_options": { "allow_admin_to_modify_add_ons": true, "allow_admin_to_modify_chapters": true, "allow_admin_to_modify_sections": true, "quick_add_contact_options": {} }, "override_checkout_settings": true, "reinstatement_options": { "calculate_reinstatement_period_using": "default", "reinstatement_period": 0.1 }, "renewal_options": { "renewal_window": 0.1 }, "restrict_membership_packages": true, "restrict_membership_types": true, "restrict_organization_types": true, "section_restrictions": { "maximum_number_of_sections": 0.1, "minimum_number_of_sections": 0.1, "section_type_restrictions": [ … ] }, "show_contact_form": true, "show_organization_form": true, "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, "type": "change affiliations" }
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/applicationProcesses/{tenantId}/batch
https://membership.api.rhythmsoftware.com/applicationProcesses/{tenantId}/batch
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/applicationProcesses/{tenantId}/batch' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"operations": [
{
"id": null,
"object": {},
"operation": "create",
"patch_directives": {
"0": {
"op": "add",
"path": "string",
"value": "string"
}
}
}
]
}'{ "error_count": 0.1, "results": [ { … } ], "success_count": 0.1 }
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/applicationProcesses/{tenantId}/eligible/{customerType}/{contactOrOrganizationId}
https://membership.api.rhythmsoftware.com/applicationProcesses/{tenantId}/eligible/{customerType}/{contactOrOrganizationId}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/applicationProcesses/{tenantId}/eligible/{customerType}/{contactOrOrganizationId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Processes were retrieved successfully
The origin types that are applicable to this process - blank for just principle
The email to send when the application is received
If set, if someone creates add on dues, then the system should prorate those dues based on the amount of time left in the membership
If set, if someone adds a chapter, then the system should prorate those dues based on the amount of time left in the membership
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
A description of the process to help the user understand whether to choose
If true, the confirmation email is sent out when a user completes but does not pay, and an activation email goes out upon payment
If true, do NOT set the default package for renewals, instead forcing them to choose one
Whether or not an email should be sent when the application is received
If set, the application generation logic will call a custom lambda function
If set, custom order generation logic is run
Whether or not to send an email when the membership is actually activated
Whether order generation rules apply
Whether section requirements are enabled for this membership type
The default application form for this process membership
Email to send once the membership is activated
Whether or not memberships require approval
The conditions upon which this expiration rule applies. If not set, then this expiration rule always applies
If set, membership group admins can add/change add ons
If set, membership group admins can add/change chapters
Whether or not to override POC settings
The packages in this path are restricted
The membership types in this path are restricted
Restrict to certain types of organizations
The maximum number of overall sections
The minimum number of overall sections
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
[ { "applicable_origins": [ … ], "application_confirmation_email": { … }, "approval_chapter_ids": [ … ], "approval_lambda_function_id": "string", "change_options": { … }, "checkout_settings": { … }, "contact_form_options": { … }, "custom_application_generation_logic_options": { … }, "custom_application_pre_processing_lambda_function_id": "string", "customer_type": "contact", "description": "string", "display_in_portal": true, "display_in_portal_as": "string", "display_order": 0.1, "do_not_send_activation_email_until_membership_is_paid": true, "do_not_set_default_renewal_package": true, "eligibility_criteria": {}, "enable_application_confirmation_email": true, "enable_custom_application_generation_logic": true, "enable_custom_application_pre_processing": true, "enable_eligibility_criteria": true, "enable_membership_activation_email": true, "enable_order_generation_rules": true, "enable_section_restrictions": true, "form_id": "string", "id": "string", "is_active": true, "membership_activation_email": { … }, "membership_package_ids": [ … ], "membership_type_ids": [ … ], "memberships_require_approval": "always", "name": "string", "order_generation_rules": [ … ], "organization_form_options": { … }, "organization_type_ids": [ … ], "organizational_membership_options": { … }, "override_checkout_settings": true, "reinstatement_options": { … }, "renewal_options": { … }, "restrict_membership_packages": true, "restrict_membership_types": true, "restrict_organization_types": true, "section_restrictions": { … }, "show_contact_form": true, "show_organization_form": true, "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, "type": "change affiliations" } ]
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/applicationProcesses/{tenantId}/{id}
https://membership.api.rhythmsoftware.com/applicationProcesses/{tenantId}/{id}
curl -i -X DELETE \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/applicationProcesses/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'"string"
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/applicationProcesses/{tenantId}/{id}
https://membership.api.rhythmsoftware.com/applicationProcesses/{tenantId}/{id}
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/applicationProcesses/{tenantId}/{id}?consistentRead=string&fields=string' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'The application process was retrieved successfully.
The origin types that are applicable to this process - blank for just principle
The email to send when the application is received
If set, if someone creates add on dues, then the system should prorate those dues based on the amount of time left in the membership
If set, if someone adds a chapter, then the system should prorate those dues based on the amount of time left in the membership
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
A description of the process to help the user understand whether to choose
If true, the confirmation email is sent out when a user completes but does not pay, and an activation email goes out upon payment
If true, do NOT set the default package for renewals, instead forcing them to choose one
Whether or not an email should be sent when the application is received
If set, the application generation logic will call a custom lambda function
If set, custom order generation logic is run
Whether or not to send an email when the membership is actually activated
Whether order generation rules apply
Whether section requirements are enabled for this membership type
The default application form for this process membership
Email to send once the membership is activated
Whether or not memberships require approval
The conditions upon which this expiration rule applies. If not set, then this expiration rule always applies
If set, membership group admins can add/change add ons
If set, membership group admins can add/change chapters
Whether or not to override POC settings
The packages in this path are restricted
The membership types in this path are restricted
Restrict to certain types of organizations
The maximum number of overall sections
The minimum number of overall sections
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
{ "applicable_origins": [ "string" ], "application_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "approval_chapter_ids": [ "string" ], "approval_lambda_function_id": "string", "change_options": { "change_fee_id": "string", "prorate_add_on_dues": true, "prorate_chapter_dues": true, "prorate_section_dues": true }, "checkout_settings": { "allow_customer_to_choose_installment_plan": true, "bank_account_id": "string", "bill_my_organization_options": { … }, "bill_my_parent_organization_options": { … }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "checkout_donation_options": { … }, "credit_card_minimum_range_end": 0.1, "credit_card_minimum_range_start": 0.1, "credit_card_mode": "disabled", "credit_card_processing_fee_mode": "charge", "credit_card_processing_fee_options": { … }, "custom_order_preprocessing_options": { … }, "custom_order_pricing_options": { … }, "disable_electronic_payment_vaulting": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_custom_order_preprocessing": true, "enable_custom_order_pricing": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_split_payments": true, "installment_plan_options": { … }, "invoice_payment_terms_id": "string", "invoice_template_id": "string", "merchant_account_id": "string", "pay_later_options": { … }, "restocking_fee_product_id": "string", "special_instructions": "string", "use_pro_forma_invoices": true }, "contact_form_options": { "contact_form_id": "string", "html": "string" }, "custom_application_generation_logic_options": { "lambda_function_id": "string" }, "custom_application_pre_processing_lambda_function_id": "string", "customer_type": "contact", "description": "string", "display_in_portal": true, "display_in_portal_as": "string", "display_order": 0.1, "do_not_send_activation_email_until_membership_is_paid": true, "do_not_set_default_renewal_package": true, "eligibility_criteria": {}, "enable_application_confirmation_email": true, "enable_custom_application_generation_logic": true, "enable_custom_application_pre_processing": true, "enable_eligibility_criteria": true, "enable_membership_activation_email": true, "enable_order_generation_rules": true, "enable_section_restrictions": true, "form_id": "string", "id": "string", "is_active": true, "membership_activation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "membership_package_ids": [ "string" ], "membership_type_ids": [ "string" ], "memberships_require_approval": "always", "name": "string", "order_generation_rules": [ { … } ], "organization_form_options": { "html": "string", "organization_form_id": "string" }, "organization_type_ids": [ "string" ], "organizational_membership_options": { "allow_admin_to_modify_add_ons": true, "allow_admin_to_modify_chapters": true, "allow_admin_to_modify_sections": true, "quick_add_contact_options": {} }, "override_checkout_settings": true, "reinstatement_options": { "calculate_reinstatement_period_using": "default", "reinstatement_period": 0.1 }, "renewal_options": { "renewal_window": 0.1 }, "restrict_membership_packages": true, "restrict_membership_types": true, "restrict_organization_types": true, "section_restrictions": { "maximum_number_of_sections": 0.1, "minimum_number_of_sections": 0.1, "section_type_restrictions": [ … ] }, "show_contact_form": true, "show_organization_form": true, "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, "type": "change affiliations" }
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/applicationProcesses/{tenantId}/{id}
https://membership.api.rhythmsoftware.com/applicationProcesses/{tenantId}/{id}
curl -i -X PATCH \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/applicationProcesses/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '[
{
"op": "add",
"path": "string",
"value": "string"
}
]'The application process was patched successfully.
The origin types that are applicable to this process - blank for just principle
The email to send when the application is received
If set, if someone creates add on dues, then the system should prorate those dues based on the amount of time left in the membership
If set, if someone adds a chapter, then the system should prorate those dues based on the amount of time left in the membership
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
A description of the process to help the user understand whether to choose
If true, the confirmation email is sent out when a user completes but does not pay, and an activation email goes out upon payment
If true, do NOT set the default package for renewals, instead forcing them to choose one
Whether or not an email should be sent when the application is received
If set, the application generation logic will call a custom lambda function
If set, custom order generation logic is run
Whether or not to send an email when the membership is actually activated
Whether order generation rules apply
Whether section requirements are enabled for this membership type
The default application form for this process membership
Email to send once the membership is activated
Whether or not memberships require approval
The conditions upon which this expiration rule applies. If not set, then this expiration rule always applies
If set, membership group admins can add/change add ons
If set, membership group admins can add/change chapters
Whether or not to override POC settings
The packages in this path are restricted
The membership types in this path are restricted
Restrict to certain types of organizations
The maximum number of overall sections
The minimum number of overall sections
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
{ "applicable_origins": [ "string" ], "application_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "approval_chapter_ids": [ "string" ], "approval_lambda_function_id": "string", "change_options": { "change_fee_id": "string", "prorate_add_on_dues": true, "prorate_chapter_dues": true, "prorate_section_dues": true }, "checkout_settings": { "allow_customer_to_choose_installment_plan": true, "bank_account_id": "string", "bill_my_organization_options": { … }, "bill_my_parent_organization_options": { … }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "checkout_donation_options": { … }, "credit_card_minimum_range_end": 0.1, "credit_card_minimum_range_start": 0.1, "credit_card_mode": "disabled", "credit_card_processing_fee_mode": "charge", "credit_card_processing_fee_options": { … }, "custom_order_preprocessing_options": { … }, "custom_order_pricing_options": { … }, "disable_electronic_payment_vaulting": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_custom_order_preprocessing": true, "enable_custom_order_pricing": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_split_payments": true, "installment_plan_options": { … }, "invoice_payment_terms_id": "string", "invoice_template_id": "string", "merchant_account_id": "string", "pay_later_options": { … }, "restocking_fee_product_id": "string", "special_instructions": "string", "use_pro_forma_invoices": true }, "contact_form_options": { "contact_form_id": "string", "html": "string" }, "custom_application_generation_logic_options": { "lambda_function_id": "string" }, "custom_application_pre_processing_lambda_function_id": "string", "customer_type": "contact", "description": "string", "display_in_portal": true, "display_in_portal_as": "string", "display_order": 0.1, "do_not_send_activation_email_until_membership_is_paid": true, "do_not_set_default_renewal_package": true, "eligibility_criteria": {}, "enable_application_confirmation_email": true, "enable_custom_application_generation_logic": true, "enable_custom_application_pre_processing": true, "enable_eligibility_criteria": true, "enable_membership_activation_email": true, "enable_order_generation_rules": true, "enable_section_restrictions": true, "form_id": "string", "id": "string", "is_active": true, "membership_activation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "membership_package_ids": [ "string" ], "membership_type_ids": [ "string" ], "memberships_require_approval": "always", "name": "string", "order_generation_rules": [ { … } ], "organization_form_options": { "html": "string", "organization_form_id": "string" }, "organization_type_ids": [ "string" ], "organizational_membership_options": { "allow_admin_to_modify_add_ons": true, "allow_admin_to_modify_chapters": true, "allow_admin_to_modify_sections": true, "quick_add_contact_options": {} }, "override_checkout_settings": true, "reinstatement_options": { "calculate_reinstatement_period_using": "default", "reinstatement_period": 0.1 }, "renewal_options": { "renewal_window": 0.1 }, "restrict_membership_packages": true, "restrict_membership_types": true, "restrict_organization_types": true, "section_restrictions": { "maximum_number_of_sections": 0.1, "minimum_number_of_sections": 0.1, "section_type_restrictions": [ … ] }, "show_contact_form": true, "show_organization_form": true, "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, "type": "change affiliations" }
The updated application process that will be saved.
The origin types that are applicable to this process - blank for just principle
The email to send when the application is received
If set, if someone creates add on dues, then the system should prorate those dues based on the amount of time left in the membership
If set, if someone adds a chapter, then the system should prorate those dues based on the amount of time left in the membership
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
A description of the process to help the user understand whether to choose
If true, the confirmation email is sent out when a user completes but does not pay, and an activation email goes out upon payment
If true, do NOT set the default package for renewals, instead forcing them to choose one
Whether or not an email should be sent when the application is received
If set, the application generation logic will call a custom lambda function
If set, custom order generation logic is run
Whether or not to send an email when the membership is actually activated
Whether order generation rules apply
Whether section requirements are enabled for this membership type
The default application form for this process membership
Email to send once the membership is activated
Whether or not memberships require approval
The conditions upon which this expiration rule applies. If not set, then this expiration rule always applies
If set, membership group admins can add/change add ons
If set, membership group admins can add/change chapters
Whether or not to override POC settings
The packages in this path are restricted
The membership types in this path are restricted
Restrict to certain types of organizations
The maximum number of overall sections
The minimum number of overall sections
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/applicationProcesses/{tenantId}/{id}
https://membership.api.rhythmsoftware.com/applicationProcesses/{tenantId}/{id}
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/applicationProcesses/{tenantId}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{
"applicable_origins": [
"string"
],
"application_confirmation_email": {
"bcc": "string",
"body": "string",
"cc": "string",
"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string"
},
"approval_chapter_ids": [
"string"
],
"approval_lambda_function_id": "string",
"change_options": {
"change_fee_id": "string",
"prorate_add_on_dues": true,
"prorate_chapter_dues": true,
"prorate_section_dues": true
},
"checkout_settings": {
"allow_customer_to_choose_installment_plan": true,
"bank_account_id": "string",
"bill_my_organization_options": {
"billing_address": "do not show",
"purchase_order_number": "do not show",
"reference_number": "string"
},
"bill_my_parent_organization_options": {
"billing_address": "do not show",
"purchase_order_number": "do not show",
"reference_number": "string"
},
"business_unit_id": "string",
"cancellation_fee_product_id": "string",
"checkout_donation_options": {
"simple_checkout_donation_options": {
"allow_user_to_specify_custom_amount": true,
"donation_ask_text": "string",
"donation_denominations": [
0.1
],
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0.1
},
"type": "simple"
},
"credit_card_minimum_range_end": 0.1,
"credit_card_minimum_range_start": 0.1,
"credit_card_mode": "disabled",
"credit_card_processing_fee_mode": "charge",
"credit_card_processing_fee_options": {
"fee_percentage": 0.1,
"maximum_fee": 0.1,
"minimum_fee": 0.1,
"product_id": "string",
"prompt_sub_text": "string",
"prompt_text": "string"
},
"custom_order_preprocessing_options": {
"lambda_function_id": "string"
},
"custom_order_pricing_options": {
"lambda_function_id": "string"
},
"disable_electronic_payment_vaulting": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"enable_custom_order_preprocessing": true,
"enable_custom_order_pricing": true,
"enable_donations_at_checkout": true,
"enable_electronic_checks": true,
"enable_pay_later": true,
"enable_payroll_deduction": true,
"enable_split_payments": true,
"installment_plan_options": {
"0": {
"additional_cost": 0.1,
"installment_plan_id": "string",
"is_default": true
}
},
"invoice_payment_terms_id": "string",
"invoice_template_id": "string",
"merchant_account_id": "string",
"pay_later_options": {
"billing_address": "do not show",
"purchase_order_number": "do not show",
"reference_number": "string"
},
"restocking_fee_product_id": "string",
"special_instructions": "string",
"use_pro_forma_invoices": true
},
"contact_form_options": {
"contact_form_id": "string",
"html": "string"
},
"custom_application_generation_logic_options": {
"lambda_function_id": "string"
},
"custom_application_pre_processing_lambda_function_id": "string",
"customer_type": "contact",
"description": "string",
"display_in_portal": true,
"display_in_portal_as": "string",
"display_order": 0.1,
"do_not_send_activation_email_until_membership_is_paid": true,
"do_not_set_default_renewal_package": true,
"eligibility_criteria": {},
"enable_application_confirmation_email": true,
"enable_custom_application_generation_logic": true,
"enable_custom_application_pre_processing": true,
"enable_eligibility_criteria": true,
"enable_membership_activation_email": true,
"enable_order_generation_rules": true,
"enable_section_restrictions": true,
"form_id": "string",
"id": "string",
"is_active": true,
"membership_activation_email": {
"bcc": "string",
"body": "string",
"cc": "string",
"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string"
},
"membership_package_ids": [
"string"
],
"membership_type_ids": [
"string"
],
"memberships_require_approval": "always",
"name": "string",
"order_generation_rules": [
{
"add_on_options": {
"add_ons": [
{
"add_on_id": "string",
"quantity": null,
"quantity_calculation_strategy": "static value"
}
]
},
"assign_add_ons": true,
"assign_package": true,
"matching_conditions": {
"all": [
{
"all": {},
"any": {},
"fact": "string",
"operator": "contains",
"path": "string",
"value": "string"
}
],
"any": [
{
"all": {},
"any": {},
"fact": "string",
"operator": "contains",
"path": "string",
"value": "string"
}
]
},
"name": "string",
"package_options": {
"package_id": "string"
}
}
],
"organization_form_options": {
"html": "string",
"organization_form_id": "string"
},
"organization_type_ids": [
"string"
],
"organizational_membership_options": {
"allow_admin_to_modify_add_ons": true,
"allow_admin_to_modify_chapters": true,
"allow_admin_to_modify_sections": true,
"quick_add_contact_options": {}
},
"override_checkout_settings": true,
"reinstatement_options": {
"calculate_reinstatement_period_using": "default",
"reinstatement_period": 0.1
},
"renewal_options": {
"renewal_window": 0.1
},
"restrict_membership_packages": true,
"restrict_membership_types": true,
"restrict_organization_types": true,
"section_restrictions": {
"maximum_number_of_sections": 0.1,
"minimum_number_of_sections": 0.1,
"section_type_restrictions": [
{
"maximum": 0.1,
"minimum": 0.1,
"section_type_id": "string"
}
]
},
"show_contact_form": true,
"show_organization_form": true,
"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,
"type": "change affiliations"
}'The application process was updated successfully.
The origin types that are applicable to this process - blank for just principle
The email to send when the application is received
If set, if someone creates add on dues, then the system should prorate those dues based on the amount of time left in the membership
If set, if someone adds a chapter, then the system should prorate those dues based on the amount of time left in the membership
If true, the customer can choose their installment plan
The default bank account that the store should use to receive payments
The ID of the product used for cancellation fees
If set, the maximum amount for which credit cards can be taken
If set, the minimum amount for which credit cards can be taken
Determines whether or not credit cards are accepted
Determines how credit card processing fees should be handled
If set, in the portal people are not allowed to save credit cards
If set, the user has the option to bill their organization
If set, the user has the option to bill their organization's parent organization
If set, the order engine will call out to a custom lambda function to process/change the order immediately after bundle expansion
If set, the order engine will call out to a custom lambda function to review the order immediately after pricing calculation
If selected, users will be prompted to make a donation upon checking out
If set, electronic checks are allowed
If set, pay later is enabled on this checkout regardless of product settings... if not, the product settings are observed
If set, payroll deduction is allowed
If set, users are allowed to split payments
The payment terms for invoices; if left blank, default is used
The template to use for invoices created during this process
The merchant account that the store should use to receive payments
The ID of the product used for restocking fees
A description of the process to help the user understand whether to choose
If true, the confirmation email is sent out when a user completes but does not pay, and an activation email goes out upon payment
If true, do NOT set the default package for renewals, instead forcing them to choose one
Whether or not an email should be sent when the application is received
If set, the application generation logic will call a custom lambda function
If set, custom order generation logic is run
Whether or not to send an email when the membership is actually activated
Whether order generation rules apply
Whether section requirements are enabled for this membership type
The default application form for this process membership
Email to send once the membership is activated
Whether or not memberships require approval
The conditions upon which this expiration rule applies. If not set, then this expiration rule always applies
If set, membership group admins can add/change add ons
If set, membership group admins can add/change chapters
Whether or not to override POC settings
The packages in this path are restricted
The membership types in this path are restricted
Restrict to certain types of organizations
The maximum number of overall sections
The minimum number of overall sections
If this record was loaded via bulk, the timestamp when the record was processed
If this record was loaded via bulk, the ID of the bulk load process
If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
If this record was loaded via bulk, the record number in the source file
If this record was loaded via bulk, the source file
The error associated with the calculated field
If a snapshot was restored/applies to this record, the ID of the snapshot
The date/time that this record was created, expressed in ISO-8601 date format
The ID of the user that deleted (or last tried to delete) this object
Means for passing directive information into an object processing logic
If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
If this record was last touched by a bulk data operation, the ID of that operation
If this record was last touched by a bulk data operation, the sys_version at the time of that operation
The date/time that this record record was last modified, expressed in ISO-8601 date format
The ID of the user that last modified this record
The security context of the last insert, modify, or delete performed on this item
The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
A number representing the version of this record in the database
{ "applicable_origins": [ "string" ], "application_confirmation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "approval_chapter_ids": [ "string" ], "approval_lambda_function_id": "string", "change_options": { "change_fee_id": "string", "prorate_add_on_dues": true, "prorate_chapter_dues": true, "prorate_section_dues": true }, "checkout_settings": { "allow_customer_to_choose_installment_plan": true, "bank_account_id": "string", "bill_my_organization_options": { … }, "bill_my_parent_organization_options": { … }, "business_unit_id": "string", "cancellation_fee_product_id": "string", "checkout_donation_options": { … }, "credit_card_minimum_range_end": 0.1, "credit_card_minimum_range_start": 0.1, "credit_card_mode": "disabled", "credit_card_processing_fee_mode": "charge", "credit_card_processing_fee_options": { … }, "custom_order_preprocessing_options": { … }, "custom_order_pricing_options": { … }, "disable_electronic_payment_vaulting": true, "enable_bill_my_organization": true, "enable_bill_my_parent_organization": true, "enable_custom_order_preprocessing": true, "enable_custom_order_pricing": true, "enable_donations_at_checkout": true, "enable_electronic_checks": true, "enable_pay_later": true, "enable_payroll_deduction": true, "enable_split_payments": true, "installment_plan_options": { … }, "invoice_payment_terms_id": "string", "invoice_template_id": "string", "merchant_account_id": "string", "pay_later_options": { … }, "restocking_fee_product_id": "string", "special_instructions": "string", "use_pro_forma_invoices": true }, "contact_form_options": { "contact_form_id": "string", "html": "string" }, "custom_application_generation_logic_options": { "lambda_function_id": "string" }, "custom_application_pre_processing_lambda_function_id": "string", "customer_type": "contact", "description": "string", "display_in_portal": true, "display_in_portal_as": "string", "display_order": 0.1, "do_not_send_activation_email_until_membership_is_paid": true, "do_not_set_default_renewal_package": true, "eligibility_criteria": {}, "enable_application_confirmation_email": true, "enable_custom_application_generation_logic": true, "enable_custom_application_pre_processing": true, "enable_eligibility_criteria": true, "enable_membership_activation_email": true, "enable_order_generation_rules": true, "enable_section_restrictions": true, "form_id": "string", "id": "string", "is_active": true, "membership_activation_email": { "bcc": "string", "body": "string", "cc": "string", "from": "string", "from_name": "string", "reply_to": "string", "subject": "string" }, "membership_package_ids": [ "string" ], "membership_type_ids": [ "string" ], "memberships_require_approval": "always", "name": "string", "order_generation_rules": [ { … } ], "organization_form_options": { "html": "string", "organization_form_id": "string" }, "organization_type_ids": [ "string" ], "organizational_membership_options": { "allow_admin_to_modify_add_ons": true, "allow_admin_to_modify_chapters": true, "allow_admin_to_modify_sections": true, "quick_add_contact_options": {} }, "override_checkout_settings": true, "reinstatement_options": { "calculate_reinstatement_period_using": "default", "reinstatement_period": 0.1 }, "renewal_options": { "renewal_window": 0.1 }, "restrict_membership_packages": true, "restrict_membership_types": true, "restrict_organization_types": true, "section_restrictions": { "maximum_number_of_sections": 0.1, "minimum_number_of_sections": 0.1, "section_type_restrictions": [ … ] }, "show_contact_form": true, "show_organization_form": true, "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, "type": "change affiliations" }