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.
curl -i -X GET \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/chapters/{tenantId}/contact/{chapterId}/{contactId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'{}
curl -i -X PUT \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/chapters/{tenantId}/contact/{chapterId}/{contactId}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>' \
-H 'Content-Type: application/json' \
-d '{}'{}
curl -i -X POST \
'https://docs.api.rhythmsoftware.com/_mock/apis/membership/membership-v1/chapters/{tenantId}/generateApplication/{chapterId}/{processId}/{ownerType}/{id}' \
-H 'Authorization: Bearer <YOUR_JWT_HERE>'Conflicts were retrieved successfully
The average score for this submission in the most recent round
The individuals that should receive the corporate membership
Whether or not this membership should be hidden from the directory
The associated application group application
The fields that should not be shown for this member in the directory
The date that the review status was last changed
If set, the bucket is not calculated automatically, and instead manually assigned
If true, then this record has been reviewed and now needs action by the staff
If set, then this membership will automatically renew with the card on file
The review status of this application
The membership application status
The reason that a membership application is in the specific status
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
{ "add_ons": [ { … } ], "additional_chapter_ids": [ "string" ], "application_group_id": "string", "assigned_contacts": [ { … } ], "average_score": 0.1, "bucket_id": "string", "chapter_id": "string", "contact_id": "string", "corporate_member_ids": [ "string" ], "custom_field_values": [ { … } ], "date": "2019-08-24T14:15:22Z", "do_not_renew": true, "do_not_show_in_directory": true, "group_application_process_id": "string", "group_order": 0.1, "hidden_directory_fields": [ "string" ], "id": "string", "included_merchandise": [ { … } ], "last_review_status_change": "2019-08-24T14:15:22Z", "membership_package_id": "string", "membership_type_id": "string", "name": "string", "notes": "string", "order_id": "string", "order_line_item_id": "string", "organization_id": "string", "override_bucket_assignment": true, "override_join_date": "string", "owner_type": "contact", "pending_console_review": true, "process_id": "string", "referral_contact_id": "string", "renew_automatically": true, "review_status": "accepted", "reviewer_recommendation": "string", "round_id": "string", "section_ids": [ "string" ], "status": "approved", "status_reason_id": "string", "submission_space_id": "string", "sys_bulk_load_at": "string", "sys_bulk_load_id": "string", "sys_bulk_load_pk": "string", "sys_bulk_load_record_no": 0.1, "sys_bulk_load_source_file": "string", "sys_calculated_field_error": "string", "sys_calculated_field_errors": [ { … } ], "sys_configuration_snapshot_id": "string", "sys_created_at": "2019-08-24T14:15:22Z", "sys_created_by_id": "string", "sys_deleted_by_id": "string", "sys_directive": "string", "sys_external_id": "string", "sys_has_files_in_s3": true, "sys_last_bulk_data_operation_id": "string", "sys_last_bulk_data_operation_sys_version": "string", "sys_last_modified_at": "2019-08-24T14:15:22Z", "sys_last_modified_by_id": "string", "sys_last_security_context": {}, "sys_locked": true, "sys_snapshot_base_version": 0.1, "sys_version": 0.1, "total_score": 0.1, "type": "change affiliations" }