Group Application Processes

Creates a new group application process record that does not already exist.

This method will auto-generate an ID and create a new group application process. If an ID is specified for the group application process, an error will be thrown.

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The group application process that you would like to be saved.

id required	string (ID) /^[\w:\|-]+$/ The unique, string identifier of this group application process
name required	string (Name) The name of the group application process
description	string (Description) Description to display in the portal
restrict_to_specific_contact_roles	boolean (Restrict To Specific Contact Roles) If true, only certain contact roles can perform group registration
contact_role_ids required	Array of strings (Contact Roles) The contact roles that can perform group registration
restrict_to_specific_membership_types	boolean (Restrict To Specific Membership Types) If true, only certain membership types are applicable to this process
membership_type_ids required	Array of strings (Membership Types) The membership types that are applicable to this process
restrict_to_specific_membership_packages	boolean (Restrict To Specific Membership Packages) If true, only certain membership packages are applicable to this process
membership_package_ids required	Array of strings (Membership Packages) The membership packages that are applicable to this process
contact_form_id required	string (Contact Form) /^rolodex-contacts__.*/ The contact form to show to group administrators when they are registering individuals
send_confirmation_email_to_group_administrator	boolean (Send Confirmation Email To Group Administrator) If true, an email is sent to the administrator of the group once registration is complete
required	object (Group Administrator Confirmation Email)
enable_tiered_discounts	boolean (Enable Tiered Discounts) If set, tiered discounts are enabled
required	Array of objects non-empty
display_in_portal	boolean (Display In Portal) Whether or not to hide in the portal
display_in_portal_as	string (Display In Portal As) How to display this process in the portal
show_instructions_to_group_administrators	boolean (Show Instructions To Group Administrators) If set, group administrators see instructions
group_administrator_instructions required	string (Group Administrator Instructions) Instructions to show to group administrators
enable_account_delegation	boolean (Enable Account Delegation) If set, then group administrators can request to be delegates for contacts not tied to their organization
account_delegation_process_id required	string (Account Delegation Process) If set, the process used for account deletion if the group admin wants to join/renew members they do not own
is_active	boolean (Is Active) Whether or not this group application process is active
override_checkout_settings	boolean (Override Checkout Settings) Whether or not to override POC settings
required	object (Checkout Settings)
enable_eligibility_criteria	boolean (Enable Eligibility Criteria) If set, only certain people/organizations can use this process
required	object (Eligibility Criteria) The criteria for eligibility
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (Sys Bulk Load Pk) If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
sys_bulk_load_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (Sys Last Bulk Data Operation) If this record was last touched by a bulk data operation, the ID of that operation
sys_last_bulk_data_operation_sys_version	string (Sys Last Bulk Data Operation Sys Version) If this record was last touched by a bulk data operation, the sys_version at the time of that operation
sys_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <float> (Sys Snapshot Base Version) The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
sys_has_files_in_s3	boolean (Sys Has Files In S3) If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
sys_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The group application process was saved successfully.

400The group application process you supplied was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

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

429Limit exceeded... unable to add group application process based on tenant limits.

500General server error.

post/groupApplicationProcesses/{tenantId}

Request samples

application/json

{"id": "string",
"name": "string",
"description": "string",
"restrict_to_specific_contact_roles": true,
"contact_role_ids": ["string"
],
"restrict_to_specific_membership_types": true,
"membership_type_ids": ["string"
],
"restrict_to_specific_membership_packages": true,
"membership_package_ids": ["string"
],
"contact_form_id": "string",
"send_confirmation_email_to_group_administrator": true,
"group_administrator_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
},
"enable_tiered_discounts": true,
"tiered_discount_rules": [{"start_range": 1,
"end_range": 1,
"discount_type": "amount",
"discount_amount": 0
}
],
"display_in_portal": true,
"display_in_portal_as": "string",
"show_instructions_to_group_administrators": true,
"group_administrator_instructions": "string",
"enable_account_delegation": true,
"account_delegation_process_id": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"name": "string",
"description": "string",
"restrict_to_specific_contact_roles": true,
"contact_role_ids": ["string"
],
"restrict_to_specific_membership_types": true,
"membership_type_ids": ["string"
],
"restrict_to_specific_membership_packages": true,
"membership_package_ids": ["string"
],
"contact_form_id": "string",
"send_confirmation_email_to_group_administrator": true,
"group_administrator_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
},
"enable_tiered_discounts": true,
"tiered_discount_rules": [{"start_range": 1,
"end_range": 1,
"discount_type": "amount",
"discount_amount": 0
}
],
"display_in_portal": true,
"display_in_portal_as": "string",
"show_instructions_to_group_administrators": true,
"group_administrator_instructions": "string",
"enable_account_delegation": true,
"account_delegation_process_id": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Gets all of the group application processes in the system.

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

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
exclusiveStartKey	string The start key, if you're making a subsequent request

Responses

200The group application processeswere retrieved successfully.

400The request was invalid.

401Unauthorized.

403Forbidden.

404The resource could not be found

429Limit exceeded... unable to add contact role based on tenant limits.

500General server error.

get/groupApplicationProcesses/{tenantId}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

[{"id": "string",
"name": "string",
"description": "string",
"restrict_to_specific_contact_roles": true,
"contact_role_ids": ["string"
],
"restrict_to_specific_membership_types": true,
"membership_type_ids": ["string"
],
"restrict_to_specific_membership_packages": true,
"membership_package_ids": ["string"
],
"contact_form_id": "string",
"send_confirmation_email_to_group_administrator": true,
"group_administrator_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
},
"enable_tiered_discounts": true,
"tiered_discount_rules": [{"start_range": 1,
"end_range": 1,
"discount_type": "amount",
"discount_amount": 0
}
],
"display_in_portal": true,
"display_in_portal_as": "string",
"show_instructions_to_group_administrators": true,
"group_administrator_instructions": "string",
"enable_account_delegation": true,
"account_delegation_process_id": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
]

Returns a group application process from the system by its ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the group application process to return.

query Parameters

fields	string The fields that you want to retrieve; if omitted, the entire object is returned.
consistentRead	string Indicates the API should force a consistent read on the data source.

Responses

200The group application process was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The group application process could not be found.

429Limit exceeded... unable to retrieve group application process based on tenant limits.

500General server error.

get/groupApplicationProcesses/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

{"id": "string",
"name": "string",
"description": "string",
"restrict_to_specific_contact_roles": true,
"contact_role_ids": ["string"
],
"restrict_to_specific_membership_types": true,
"membership_type_ids": ["string"
],
"restrict_to_specific_membership_packages": true,
"membership_package_ids": ["string"
],
"contact_form_id": "string",
"send_confirmation_email_to_group_administrator": true,
"group_administrator_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
},
"enable_tiered_discounts": true,
"tiered_discount_rules": [{"start_range": 1,
"end_range": 1,
"discount_type": "amount",
"discount_amount": 0
}
],
"display_in_portal": true,
"display_in_portal_as": "string",
"show_instructions_to_group_administrators": true,
"group_administrator_instructions": "string",
"enable_account_delegation": true,
"account_delegation_process_id": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Updates a group application process with the specified ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the group application process to update.

Request Body schema: application/json

The updated group application process that will be saved.

id required	string (ID) /^[\w:\|-]+$/ The unique, string identifier of this group application process
name required	string (Name) The name of the group application process
description	string (Description) Description to display in the portal
restrict_to_specific_contact_roles	boolean (Restrict To Specific Contact Roles) If true, only certain contact roles can perform group registration
contact_role_ids required	Array of strings (Contact Roles) The contact roles that can perform group registration
restrict_to_specific_membership_types	boolean (Restrict To Specific Membership Types) If true, only certain membership types are applicable to this process
membership_type_ids required	Array of strings (Membership Types) The membership types that are applicable to this process
restrict_to_specific_membership_packages	boolean (Restrict To Specific Membership Packages) If true, only certain membership packages are applicable to this process
membership_package_ids required	Array of strings (Membership Packages) The membership packages that are applicable to this process
contact_form_id required	string (Contact Form) /^rolodex-contacts__.*/ The contact form to show to group administrators when they are registering individuals
send_confirmation_email_to_group_administrator	boolean (Send Confirmation Email To Group Administrator) If true, an email is sent to the administrator of the group once registration is complete
required	object (Group Administrator Confirmation Email)
enable_tiered_discounts	boolean (Enable Tiered Discounts) If set, tiered discounts are enabled
required	Array of objects non-empty
display_in_portal	boolean (Display In Portal) Whether or not to hide in the portal
display_in_portal_as	string (Display In Portal As) How to display this process in the portal
show_instructions_to_group_administrators	boolean (Show Instructions To Group Administrators) If set, group administrators see instructions
group_administrator_instructions required	string (Group Administrator Instructions) Instructions to show to group administrators
enable_account_delegation	boolean (Enable Account Delegation) If set, then group administrators can request to be delegates for contacts not tied to their organization
account_delegation_process_id required	string (Account Delegation Process) If set, the process used for account deletion if the group admin wants to join/renew members they do not own
is_active	boolean (Is Active) Whether or not this group application process is active
override_checkout_settings	boolean (Override Checkout Settings) Whether or not to override POC settings
required	object (Checkout Settings)
enable_eligibility_criteria	boolean (Enable Eligibility Criteria) If set, only certain people/organizations can use this process
required	object (Eligibility Criteria) The criteria for eligibility
sys_deleted_by_id	string (Sys Deleted By) The ID of the user that deleted (or last tried to delete) this object
sys_version	number <float> (Sys Version) A number representing the version of this record in the database
sys_created_at required	string <date-time> (Sys Created At) The date/time that this record was created, expressed in ISO-8601 date format
sys_last_modified_at required	string <date-time> (Sys Last Modified At) The date/time that this record record was last modified, expressed in ISO-8601 date format
sys_created_by_id required	string (Sys Created By) The ID of the user that created this record
sys_last_modified_by_id required	string (Sys Last Modified By) The ID of the user that last modified this record
sys_external_id	string (Sys External) The ID that a record has from an external system or data import
sys_locked	boolean (Sys Locked) If set, this record is locked and cannot be changed via the API
sys_bulk_load_pk	string (Sys Bulk Load Pk) If this record was loaded via bulk, the tenant and key of the bulk load process used as a partition key
sys_bulk_load_at	string (Sys Bulk Load At) If this record was loaded via bulk, the timestamp when the record was processed
sys_bulk_load_id	string (Sys Bulk Load) If this record was loaded via bulk, the ID of the bulk load process
sys_bulk_load_record_no	number <float> (Sys Bulk Load Record No) If this record was loaded via bulk, the record number in the source file
sys_bulk_load_source_file	string (Sys Bulk Load Source File) If this record was loaded via bulk, the source file
sys_last_bulk_data_operation_id	string (Sys Last Bulk Data Operation) If this record was last touched by a bulk data operation, the ID of that operation
sys_last_bulk_data_operation_sys_version	string (Sys Last Bulk Data Operation Sys Version) If this record was last touched by a bulk data operation, the sys_version at the time of that operation
sys_directive	string (Sys Directive) Means for passing directive information into an object processing logic
sys_calculated_field_error	string (Sys Calculated Field Error) The error associated with the calculated field
sys_snapshot_base_version	number <float> (Sys Snapshot Base Version) The version to use as a base when creating a configuration snapshot; if not set, 1 is used. Helpful when creating a sandbox
sys_has_files_in_s3	boolean (Sys Has Files In S3) If true, this record has files in S3. If false, it doesnt, so no need to hit S3 upon deletion
sys_configuration_snapshot_id	string (Sys Configuration Snapshot) If a snapshot was restored/applies to this record, the ID of the snapshot
sys_last_security_context	object (Sys Last Security Context) The security context of the last insert, modify, or delete performed on this item
	Array of objects

Responses

200The group application process was updated successfully.

400The group application process supplied was not valid.

401Unauthorized.

403Forbidden.

404The group application process could not be found.

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

429Limit exceeded... unable to retrieve group application process based on tenant limits.

500General server error.

put/groupApplicationProcesses/{tenantId}/{id}

Request samples

application/json

{"id": "string",
"name": "string",
"description": "string",
"restrict_to_specific_contact_roles": true,
"contact_role_ids": ["string"
],
"restrict_to_specific_membership_types": true,
"membership_type_ids": ["string"
],
"restrict_to_specific_membership_packages": true,
"membership_package_ids": ["string"
],
"contact_form_id": "string",
"send_confirmation_email_to_group_administrator": true,
"group_administrator_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
},
"enable_tiered_discounts": true,
"tiered_discount_rules": [{"start_range": 1,
"end_range": 1,
"discount_type": "amount",
"discount_amount": 0
}
],
"display_in_portal": true,
"display_in_portal_as": "string",
"show_instructions_to_group_administrators": true,
"group_administrator_instructions": "string",
"enable_account_delegation": true,
"account_delegation_process_id": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Response samples

application/json

{"id": "string",
"name": "string",
"description": "string",
"restrict_to_specific_contact_roles": true,
"contact_role_ids": ["string"
],
"restrict_to_specific_membership_types": true,
"membership_type_ids": ["string"
],
"restrict_to_specific_membership_packages": true,
"membership_package_ids": ["string"
],
"contact_form_id": "string",
"send_confirmation_email_to_group_administrator": true,
"group_administrator_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
},
"enable_tiered_discounts": true,
"tiered_discount_rules": [{"start_range": 1,
"end_range": 1,
"discount_type": "amount",
"discount_amount": 0
}
],
"display_in_portal": true,
"display_in_portal_as": "string",
"show_instructions_to_group_administrators": true,
"group_administrator_instructions": "string",
"enable_account_delegation": true,
"account_delegation_process_id": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Partially updates a group application process with the specified ID.

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

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the group application process to patch.

Request Body schema: application/json

The patch directives conforming to RFC 6902.

Array

op required	string (Op) The operation Enum: "add" "remove" "replace" "move" "copy" "test"
path required	string (Path) The JSON path
value	string (Value) The updated value

Responses

200The group application process was patched successfully.

400The JSON patch directive you supplied was not valid.

401Unauthorized.

403Forbidden.

404The group application process could not be found.

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

429Limit exceeded... unable to retrieve group application process based on tenant limits.

500General server error.

patch/groupApplicationProcesses/{tenantId}/{id}

Request samples

application/json

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

Response samples

application/json

{"id": "string",
"name": "string",
"description": "string",
"restrict_to_specific_contact_roles": true,
"contact_role_ids": ["string"
],
"restrict_to_specific_membership_types": true,
"membership_type_ids": ["string"
],
"restrict_to_specific_membership_packages": true,
"membership_package_ids": ["string"
],
"contact_form_id": "string",
"send_confirmation_email_to_group_administrator": true,
"group_administrator_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
},
"enable_tiered_discounts": true,
"tiered_discount_rules": [{"start_range": 1,
"end_range": 1,
"discount_type": "amount",
"discount_amount": 0
}
],
"display_in_portal": true,
"display_in_portal_as": "string",
"show_instructions_to_group_administrators": true,
"group_administrator_instructions": "string",
"enable_account_delegation": true,
"account_delegation_process_id": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}

Returns a group application process from the system by its ID.

This method will delete a group application process with the specified ID.

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the group application process to delete.

Responses

200The group application process was deleted successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The group application process could not be found.

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

429Limit exceeded... unable to delete group application process based on tenant limits.

500General server error.

delete/groupApplicationProcesses/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

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

Response samples

application/json

"string"

Execute Batch Operations

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

Request

Security:

knox-authorizer

path Parameters

tenantId

required

string

The id of the tenant being accessed.

Request Body schema: application/json

The batch request

Array of objects

Responses

200Request completed successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The group application process could not be found.

429Limit exceeded... unable to retrieve group application process based on tenant limits.

500General server error.

post/groupApplicationProcesses/{tenantId}/batch

Request samples

application/json

{"operations": [{"operation": "create",
"id": "string",
"patch_directives": [{"op": "add",
"path": "string",
"value": "string"
}
],
"object": { }
}
]
}

Response samples

application/json

{"success_count": 0,
"error_count": 0,
"results": [{"operation": "create",
"id": "string",
"outcome": "success",
"error_message": "string",
"object": { }
}
]
}

Gets all of the processes a contact is eligible to use

Request

Security:

knox-authorizer

path Parameters

tenantId required	string The id of the tenant being accessed
contactId required	string The contact id

Responses

200Processes were retrieved successfully

400The request was not valid

401Unauthorized

403Forbidden

404The resource could not be found

429Request limit exceeded... please try your request again in a few seconds

500An internal server error occured.

get/groupApplicationProcesses/{tenantId}/eligible/{contactId}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  https://membership.api.756794052567.rhythmsoftware.com/groupApplicationProcesses/:tenantId/eligible/:contactId \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

[{"id": "string",
"name": "string",
"description": "string",
"restrict_to_specific_contact_roles": true,
"contact_role_ids": ["string"
],
"restrict_to_specific_membership_types": true,
"membership_type_ids": ["string"
],
"restrict_to_specific_membership_packages": true,
"membership_package_ids": ["string"
],
"contact_form_id": "string",
"send_confirmation_email_to_group_administrator": true,
"group_administrator_confirmation_email": {"from": "string",
"from_name": "string",
"reply_to": "string",
"subject": "string",
"cc": "string",
"bcc": "string",
"body": "string"
},
"enable_tiered_discounts": true,
"tiered_discount_rules": [{"start_range": 1,
"end_range": 1,
"discount_type": "amount",
"discount_amount": 0
}
],
"display_in_portal": true,
"display_in_portal_as": "string",
"show_instructions_to_group_administrators": true,
"group_administrator_instructions": "string",
"enable_account_delegation": true,
"account_delegation_process_id": "string",
"is_active": true,
"override_checkout_settings": true,
"checkout_settings": {"business_unit_id": "string",
"merchant_account_id": "string",
"bank_account_id": "string",
"enable_split_payments": true,
"enable_electronic_checks": true,
"enable_payroll_deduction": true,
"enable_pay_later": true,
"enable_bill_my_organization": true,
"enable_bill_my_parent_organization": true,
"use_pro_forma_invoices": true,
"enable_donations_at_checkout": true,
"restocking_fee_product_id": "string",
"cancellation_fee_product_id": "string",
"special_instructions": "string",
"pay_later_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"bill_my_parent_organization_options": {"reference_number": "string",
"purchase_order_number": "do not show",
"billing_address": "do not show"
},
"credit_card_mode": "enabled",
"credit_card_minimum_range_start": 0,
"credit_card_minimum_range_end": 0,
"credit_card_processing_fee_mode": "do not charge",
"credit_card_processing_fee_options": {"fee_percentage": 0,
"product_id": "string",
"minimum_fee": 0,
"maximum_fee": 0,
"prompt_text": "string",
"prompt_sub_text": "string"
},
"invoice_template_id": "string",
"invoice_payment_terms_id": "string",
"allow_customer_to_choose_installment_plan": true,
"disable_electronic_payment_vaulting": true,
"installment_plan_options": [{"installment_plan_id": "string",
"additional_cost": 0,
"is_default": true
}
],
"checkout_donation_options": {"type": "simple",
"simple_checkout_donation_options": {"donation_ask_text": "string",
"donation_information": "string",
"donation_product_id": "string",
"override_donation_denominations": true,
"suggested_donation": 0,
"donation_denominations": [0
],
"allow_user_to_specify_custom_amount": true
}
}
},
"enable_eligibility_criteria": true,
"eligibility_criteria": {"logic_operator": "and",
"customer_type": "contact",
"members": true,
"non_members": true,
"member_options": {"member_type_ids": ["string"
],
"member_package_ids": ["string"
],
"member_statuses": ["active"
],
"member_status_reason_ids": ["string"
],
"section_members": true,
"section_member_options": {"logic_operator": "and",
"section_ids": ["string"
],
"section_type_ids": ["string"
]
},
"chapter_members": true,
"chapter_member_options": {"logic_operator": "and",
"chapter_ids": ["string"
],
"chapter_type_ids": ["string"
]
}
},
"committee_members": true,
"committee_member_options": {"logic_operator": "and",
"committee_ids": ["string"
],
"committee_type_ids": ["string"
],
"committee_position_ids": ["string"
]
},
"certificants": true,
"certification_options": {"logic_operator": "and",
"program_ids": ["string"
]
},
"enable_status_restriction": true,
"status_restrictions": ["string"
],
"enable_organization_restrictions": true,
"organization_restrictions": {"organization_type_ids": ["string"
],
"contact_role_ids": ["string"
]
},
"enable_age_restrictions": true,
"age_restrictions": {"minimum_age": 0,
"maximum_age": 0
},
"by_location": true,
"location": {"negate_logic": true,
"countries": ["string"
]
},
"award_recipients": true,
"award_options": {"logic_operator": "and",
"award_type_ids": ["string"
],
"award_ids": ["string"
]
},
"event_registrations": true,
"event_registration_options": {"logic_operator": "and",
"registration_category_ids": ["string"
],
"event_ids": ["string"
]
},
"donors": true,
"donor_options": {"logic_operator": "and",
"donor_club_ids": ["string"
]
},
"enable_advanced_rules": true,
"advanced_rules": { },
"advanced_rule_error_message": "string",
"enable_expression": true,
"expression": "string",
"expression_error_message": "string"
},
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_last_bulk_data_operation_id": "string",
"sys_last_bulk_data_operation_sys_version": "string",
"sys_directive": "string",
"sys_calculated_field_error": "string",
"sys_snapshot_base_version": 0,
"sys_has_files_in_s3": true,
"sys_configuration_snapshot_id": "string",
"sys_last_security_context": { },
"sys_calculated_field_errors": [{"field": "string",
"error": "string"
}
]
}
]