This method will auto-generate an ID and create a new type. If an ID is specified for the type, an error will be thrown.
The type that you would like to be saved.
{- "id": "string",
- "name": "string",
- "customer_type": "contact",
- "display_in_portal_as": "string",
- "portal_description": "string",
- "universal_shopping_cart_image_uri": "string",
- "membership_console_page_layout_id": "string",
- "membership_portal_page_layout_id": "string",
- "membership_360_screen_id": "string",
- "flowdown_membership_type_id": "string",
- "enable_flowdown": true,
- "flowdown_options": {
- "enable_cascading_flowdown": true,
- "organization_type_ids": [
- "string"
], - "contact_role_ids": [
- "string"
]
}, - "override_certificate_settings": true,
- "certificate_settings": {
- "certificate_mode": "disabled",
- "certificate_template": "string"
}, - "enable_section_restrictions": true,
- "section_restrictions": {
- "minimum_number_of_sections": 0,
- "maximum_number_of_sections": 0,
- "section_type_restrictions": [
- {
- "section_type_id": "string",
- "minimum": 0,
- "maximum": 0
}
]
}, - "id_card_template_id": "string",
- "hide_from_portal": true,
- "display_order": 0,
- "is_active": true,
- "custom_field_values": [
- {
- "custom_field_id": "string",
- "string_value": "string",
- "numeric_value": 0,
- "boolean_value": true,
- "file_url_value": "string",
- "list_value": [
- "string"
], - "table_value": [
- { }
]
}
], - "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"
}
]
}
{- "id": "string",
- "name": "string",
- "customer_type": "contact",
- "display_in_portal_as": "string",
- "portal_description": "string",
- "universal_shopping_cart_image_uri": "string",
- "membership_console_page_layout_id": "string",
- "membership_portal_page_layout_id": "string",
- "membership_360_screen_id": "string",
- "flowdown_membership_type_id": "string",
- "enable_flowdown": true,
- "flowdown_options": {
- "enable_cascading_flowdown": true,
- "organization_type_ids": [
- "string"
], - "contact_role_ids": [
- "string"
]
}, - "override_certificate_settings": true,
- "certificate_settings": {
- "certificate_mode": "disabled",
- "certificate_template": "string"
}, - "enable_section_restrictions": true,
- "section_restrictions": {
- "minimum_number_of_sections": 0,
- "maximum_number_of_sections": 0,
- "section_type_restrictions": [
- {
- "section_type_id": "string",
- "minimum": 0,
- "maximum": 0
}
]
}, - "id_card_template_id": "string",
- "hide_from_portal": true,
- "display_order": 0,
- "is_active": true,
- "custom_field_values": [
- {
- "custom_field_id": "string",
- "string_value": "string",
- "numeric_value": 0,
- "boolean_value": true,
- "file_url_value": "string",
- "list_value": [
- "string"
], - "table_value": [
- { }
]
}
], - "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"
}
]
}
This method will scan all types and and return them to the caller.
curl -i -X GET \ 'https://membership.api.756794052567.rhythmsoftware.com/types/:tenantId?fields=string&exclusiveStartKey=string' \ -H 'Authorization: YOUR_API_KEY_HERE'
[- {
- "id": "string",
- "name": "string",
- "customer_type": "contact",
- "display_in_portal_as": "string",
- "portal_description": "string",
- "universal_shopping_cart_image_uri": "string",
- "membership_console_page_layout_id": "string",
- "membership_portal_page_layout_id": "string",
- "membership_360_screen_id": "string",
- "flowdown_membership_type_id": "string",
- "enable_flowdown": true,
- "flowdown_options": {
- "enable_cascading_flowdown": true,
- "organization_type_ids": [
- "string"
], - "contact_role_ids": [
- "string"
]
}, - "override_certificate_settings": true,
- "certificate_settings": {
- "certificate_mode": "disabled",
- "certificate_template": "string"
}, - "enable_section_restrictions": true,
- "section_restrictions": {
- "minimum_number_of_sections": 0,
- "maximum_number_of_sections": 0,
- "section_type_restrictions": [
- {
- "section_type_id": "string",
- "minimum": 0,
- "maximum": 0
}
]
}, - "id_card_template_id": "string",
- "hide_from_portal": true,
- "display_order": 0,
- "is_active": true,
- "custom_field_values": [
- {
- "custom_field_id": "string",
- "string_value": "string",
- "numeric_value": 0,
- "boolean_value": true,
- "file_url_value": "string",
- "list_value": [
- "string"
], - "table_value": [
- { }
]
}
], - "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"
}
]
}
]
This method will look up a type by the specified ID and return it back.
curl -i -X GET \ 'https://membership.api.756794052567.rhythmsoftware.com/types/:tenantId/:id?fields=string&consistentRead=string' \ -H 'Authorization: YOUR_API_KEY_HERE'
{- "id": "string",
- "name": "string",
- "customer_type": "contact",
- "display_in_portal_as": "string",
- "portal_description": "string",
- "universal_shopping_cart_image_uri": "string",
- "membership_console_page_layout_id": "string",
- "membership_portal_page_layout_id": "string",
- "membership_360_screen_id": "string",
- "flowdown_membership_type_id": "string",
- "enable_flowdown": true,
- "flowdown_options": {
- "enable_cascading_flowdown": true,
- "organization_type_ids": [
- "string"
], - "contact_role_ids": [
- "string"
]
}, - "override_certificate_settings": true,
- "certificate_settings": {
- "certificate_mode": "disabled",
- "certificate_template": "string"
}, - "enable_section_restrictions": true,
- "section_restrictions": {
- "minimum_number_of_sections": 0,
- "maximum_number_of_sections": 0,
- "section_type_restrictions": [
- {
- "section_type_id": "string",
- "minimum": 0,
- "maximum": 0
}
]
}, - "id_card_template_id": "string",
- "hide_from_portal": true,
- "display_order": 0,
- "is_active": true,
- "custom_field_values": [
- {
- "custom_field_id": "string",
- "string_value": "string",
- "numeric_value": 0,
- "boolean_value": true,
- "file_url_value": "string",
- "list_value": [
- "string"
], - "table_value": [
- { }
]
}
], - "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"
}
]
}
This method will update an existing type with the specified ID.
The updated type that will be saved.
{- "id": "string",
- "name": "string",
- "customer_type": "contact",
- "display_in_portal_as": "string",
- "portal_description": "string",
- "universal_shopping_cart_image_uri": "string",
- "membership_console_page_layout_id": "string",
- "membership_portal_page_layout_id": "string",
- "membership_360_screen_id": "string",
- "flowdown_membership_type_id": "string",
- "enable_flowdown": true,
- "flowdown_options": {
- "enable_cascading_flowdown": true,
- "organization_type_ids": [
- "string"
], - "contact_role_ids": [
- "string"
]
}, - "override_certificate_settings": true,
- "certificate_settings": {
- "certificate_mode": "disabled",
- "certificate_template": "string"
}, - "enable_section_restrictions": true,
- "section_restrictions": {
- "minimum_number_of_sections": 0,
- "maximum_number_of_sections": 0,
- "section_type_restrictions": [
- {
- "section_type_id": "string",
- "minimum": 0,
- "maximum": 0
}
]
}, - "id_card_template_id": "string",
- "hide_from_portal": true,
- "display_order": 0,
- "is_active": true,
- "custom_field_values": [
- {
- "custom_field_id": "string",
- "string_value": "string",
- "numeric_value": 0,
- "boolean_value": true,
- "file_url_value": "string",
- "list_value": [
- "string"
], - "table_value": [
- { }
]
}
], - "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"
}
]
}
{- "id": "string",
- "name": "string",
- "customer_type": "contact",
- "display_in_portal_as": "string",
- "portal_description": "string",
- "universal_shopping_cart_image_uri": "string",
- "membership_console_page_layout_id": "string",
- "membership_portal_page_layout_id": "string",
- "membership_360_screen_id": "string",
- "flowdown_membership_type_id": "string",
- "enable_flowdown": true,
- "flowdown_options": {
- "enable_cascading_flowdown": true,
- "organization_type_ids": [
- "string"
], - "contact_role_ids": [
- "string"
]
}, - "override_certificate_settings": true,
- "certificate_settings": {
- "certificate_mode": "disabled",
- "certificate_template": "string"
}, - "enable_section_restrictions": true,
- "section_restrictions": {
- "minimum_number_of_sections": 0,
- "maximum_number_of_sections": 0,
- "section_type_restrictions": [
- {
- "section_type_id": "string",
- "minimum": 0,
- "maximum": 0
}
]
}, - "id_card_template_id": "string",
- "hide_from_portal": true,
- "display_order": 0,
- "is_active": true,
- "custom_field_values": [
- {
- "custom_field_id": "string",
- "string_value": "string",
- "numeric_value": 0,
- "boolean_value": true,
- "file_url_value": "string",
- "list_value": [
- "string"
], - "table_value": [
- { }
]
}
], - "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"
}
]
}
This method will patch an existing type with the specified ID, using the HTTP PATCH specification.
The patch directives conforming to RFC 6902.
[- {
- "op": "add",
- "path": "string",
- "value": "string"
}
]
{- "id": "string",
- "name": "string",
- "customer_type": "contact",
- "display_in_portal_as": "string",
- "portal_description": "string",
- "universal_shopping_cart_image_uri": "string",
- "membership_console_page_layout_id": "string",
- "membership_portal_page_layout_id": "string",
- "membership_360_screen_id": "string",
- "flowdown_membership_type_id": "string",
- "enable_flowdown": true,
- "flowdown_options": {
- "enable_cascading_flowdown": true,
- "organization_type_ids": [
- "string"
], - "contact_role_ids": [
- "string"
]
}, - "override_certificate_settings": true,
- "certificate_settings": {
- "certificate_mode": "disabled",
- "certificate_template": "string"
}, - "enable_section_restrictions": true,
- "section_restrictions": {
- "minimum_number_of_sections": 0,
- "maximum_number_of_sections": 0,
- "section_type_restrictions": [
- {
- "section_type_id": "string",
- "minimum": 0,
- "maximum": 0
}
]
}, - "id_card_template_id": "string",
- "hide_from_portal": true,
- "display_order": 0,
- "is_active": true,
- "custom_field_values": [
- {
- "custom_field_id": "string",
- "string_value": "string",
- "numeric_value": 0,
- "boolean_value": true,
- "file_url_value": "string",
- "list_value": [
- "string"
], - "table_value": [
- { }
]
}
], - "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"
}
]
}
This method will delete a type with the specified ID.
curl -i -X DELETE \ https://membership.api.756794052567.rhythmsoftware.com/types/:tenantId/:id \ -H 'Authorization: YOUR_API_KEY_HERE'
"string"
TAllows you to perform up to 100 parallel patch/delete operations
The batch request
Array of objects |
{- "operations": [
- {
- "operation": "create",
- "id": "string",
- "patch_directives": [
- {
- "op": "add",
- "path": "string",
- "value": "string"
}
], - "object": { }
}
]
}
{- "success_count": 0,
- "error_count": 0,
- "results": [
- {
- "operation": "create",
- "id": "string",
- "outcome": "success",
- "error_message": "string",
- "object": { }
}
]
}