Chapters

Chapters

Returns a chapter from the system by its ID.

This method will look up a chapter 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 chapter 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 chapter was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The chapter could not be found.
429Limit exceeded... unable to retrieve chapter based on tenant limits.
500General server error.
get/chapters/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/chapters/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "email_address": "string",
  • "phone_number": "string",
  • "website": "string",
  • "type_id": "string",
  • "linked_organization_id": "string",
  • "enable_dues": true,
  • "hide_from_portal": true,
  • "enable_new_member_email": true,
  • "new_member_email": {
    },
  • "address": {
    },
  • "description": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "sys_search_latlong": "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": [
    ]
}

Updates a chapter with the specified ID.

This method will update an existing chapter 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 chapter to update.

Request Body schema: application/json

The updated chapter that will be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this chapter

name
required
string (Name)

The name of the chapter

email_address
string (Email Address)

The email address of the chapter

phone_number
string (Phone Number)

Chapter phone number

website
string (Website)

Website of the chapter

type_id
required
string (Type)

The type of chapter

linked_organization_id
string (Linked Organization)

The organization linked to this chapter, if the chapter owes dues/taxes to the main organization

enable_dues
boolean (Enable Dues)
hide_from_portal
boolean (Hide From Portal)

Whether or not this section is displayed in the portal

enable_new_member_email
boolean (Enable New Member Email)

ALlow for new members to receive an email when they join this chapter

required
object (New Member Email)

The new member email

object (Address)

A complete address

description
string (Description)

Description of the chapter

is_active
boolean (Is Active)

Whether this is an active chapter

Array of objects (Custom Field Values)
sys_search_latlong
string (Sys Search Latlong)

A geocode for distance queries

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 chapter was updated successfully.
400The chapter supplied was not valid.
401Unauthorized.
403Forbidden.
404The chapter could not be found.
409The chapter could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve chapter based on tenant limits.
500General server error.
put/chapters/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "email_address": "string",
  • "phone_number": "string",
  • "website": "string",
  • "type_id": "string",
  • "linked_organization_id": "string",
  • "enable_dues": true,
  • "hide_from_portal": true,
  • "enable_new_member_email": true,
  • "new_member_email": {
    },
  • "address": {
    },
  • "description": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "sys_search_latlong": "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": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "email_address": "string",
  • "phone_number": "string",
  • "website": "string",
  • "type_id": "string",
  • "linked_organization_id": "string",
  • "enable_dues": true,
  • "hide_from_portal": true,
  • "enable_new_member_email": true,
  • "new_member_email": {
    },
  • "address": {
    },
  • "description": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "sys_search_latlong": "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": [
    ]
}

Partially updates a chapter with the specified ID.

This method will patch an existing chapter 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 chapter 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 chapter was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The chapter could not be found.
409The chapter could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve chapter based on tenant limits.
500General server error.
patch/chapters/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "email_address": "string",
  • "phone_number": "string",
  • "website": "string",
  • "type_id": "string",
  • "linked_organization_id": "string",
  • "enable_dues": true,
  • "hide_from_portal": true,
  • "enable_new_member_email": true,
  • "new_member_email": {
    },
  • "address": {
    },
  • "description": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "sys_search_latlong": "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": [
    ]
}

Returns a chapter from the system by its ID.

This method will delete a chapter 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 chapter to delete.

Responses
200The chapter was deleted successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The chapter could not be found.
409The chapter could not be deleted because other objects refers to/depends on this one.
429Limit exceeded... unable to delete chapter based on tenant limits.
500General server error.
delete/chapters/{tenantId}/{id}
Request samples
curl -i -X DELETE \
  https://membership.api.756794052567.rhythmsoftware.com/chapters/:tenantId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Searches for chapters using predefined parameters

Searches for chapters using predefined parameters

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

query Parameters
exclusiveStartKey
string

The start key for the search, for paging support

fieldsToReturn
string

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

Request Body schema: application/json

The chapter that you would like to be saved.

id
Array of strings (ID)

IDs to search

name
string (Name)
city
string (City)

City to search

state
string (State)

The state

type_id
Array of strings (Type)

Types to search

is_active
Array of booleans (Is Active)
Responses
200The chapter search was saved successfully.
400The chapter you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The chapter could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add chapter based on tenant limits.
500General server error.
post/chapters/{tenantId}/search
Request samples
    1 more
    Python
application/json
{
  • "id": [
    ],
  • "name": "string",
  • "city": "string",
  • "state": "string",
  • "type_id": [
    ],
  • "is_active": [
    ]
}
Response samples
application/json
{
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of chapters for a given membership package

Returns a list of chapters for a given membership package

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

membershipPackageId
required
string

The membership package to describe chapters

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/chapters/{tenantId}/portal/describeChapters/{membershipPackageId}
Request samples
curl -i -X GET \
  https://membership.api.756794052567.rhythmsoftware.com/chapters/:tenantId/portal/describeChapters/:membershipPackageId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "chapterTypes": [
    ],
  • "suggestions": [
    ]
}

Returns a list of chapters for a given membership package

Returns a list of chapters for a given membership package

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

membershipPackageId
required
string

The membership package to describe chapters

memberType
required
string

The membership package to describe chapters

contactOrOrganizationId
required
string

The membership package to describe chapters

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/chapters/{tenantId}/portal/describeChapters/{membershipPackageId}/{memberType}/{contactOrOrganizationId}
Request samples
curl -i -X GET \
  https://membership.api.756794052567.rhythmsoftware.com/chapters/:tenantId/portal/describeChapters/:membershipPackageId/:memberType/:contactOrOrganizationId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "chapterTypes": [
    ],
  • "suggestions": [
    ]
}

Searches for the nearest chapters to the latitude and longitude supplied

Returns a list of chapters for a given membership package

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

longitude
required
string

Longitude

latitude
required
string

Latitue

query Parameters
maximumNumberOfResults
number

Max results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/chapters/{tenantId}/portal/findNearest/{latitude}/{longitude}
Request samples
curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/chapters/:tenantId/portal/findNearest/:latitude/:longitude?maximumNumberOfResults=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]

Get portal permissions

Determines the permissions available in the portal for a portal user.

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

chapterId
required
string

The chapter id

contactId
required
string

The contact id

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/chapters/{tenantId}/portalPermissions/{chapterId}/{contactId}
Request samples
curl -i -X GET \
  https://membership.api.756794052567.rhythmsoftware.com/chapters/:tenantId/portalPermissions/:chapterId/:contactId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "chapter_page_layout_id": "string",
  • "contact_form_id": "string",
  • "membership_page_layout_id": "string",
  • "view_chapter_roster": true,
  • "update_contact_info": true,
  • "update_chapter_info": true,
  • "update_membership_info": true,
  • "sign_up_new_members": true,
  • "renew_existing_members": true,
  • "manage_chapter_committees": true,
  • "access_saved_queries": true,
  • "permissions": [
    ],
  • "saved_queries": [
    ]
}

View chapter roster

Allows for a portal user to view the roster

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

chapterId
required
string

The chapter id

query Parameters
fields
string

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

exclusiveStartKey
string

If paging, this allows you to return the next set of results

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/chapters/{tenantId}/roster/{chapterId}
Request samples
curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/chapters/:tenantId/roster/:chapterId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Creates a new contact on behalf of a chapter

Allows for a portal user to update the contact info of a chapter member

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

chapterId
required
string

The chapter id

Request Body schema: application/json

The contact

object
Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
post/chapters/{tenantId}/contact/{chapterId}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

Change chapter committee terms

Allows for chapter administrators to change committee terms

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

chapterId
required
string

The chapter id

committeeId
required
string

The committee Id

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 records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
patch/chapters/{tenantId}/committee/{chapterId}/{committeeId}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{ }

Get chapter member contact info

Allows for a portal user to get the contact info of a chapter member

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

chapterId
required
string

The chapter id

contactId
required
string

The contactId

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
get/chapters/{tenantId}/contact/{chapterId}/{contactId}
Request samples
curl -i -X GET \
  https://membership.api.756794052567.rhythmsoftware.com/chapters/:tenantId/contact/:chapterId/:contactId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{ }

Update chapter member contact info

Allows for a portal user to update the contact info of a chapter member

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

chapterId
required
string

The chapter id

contactId
required
string

The contactId

Request Body schema: application/json

The contact

object
Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
put/chapters/{tenantId}/contact/{chapterId}/{contactId}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

Update chapter member membership info

Allows for a portal user to update the membership info of a chapter member

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

chapterId
required
string

The chapter id

membershipId
required
string

The membershipId

Request Body schema: application/json

The membership

object
Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
put/chapters/{tenantId}/membership/{chapterId}/{membershipId}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

Create a chapter committee membership

Add a membership to a chapter committee

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

chapterId
required
string

The chapter id

Request Body schema: application/json

The membership

object
Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
post/chapters/{tenantId}/committeeMembership/{chapterId}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

Update a chapter committee membership

Changes a chapter committee membership

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

chapterId
required
string

The chapter id

id
required
string

The committee membership id

Request Body schema: application/json

The membership

object
Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
put/chapters/{tenantId}/committeeMembership/{chapterId}/{id}
Request samples
    1 more
    Python
application/json
{ }
Response samples
application/json
{ }

Delete a chapter committee membership

Changes a chapter committee membership

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

chapterId
required
string

The chapter id

id
required
string

The committee membership id

Responses
200The records were retrieved successfully
400The request was not valid.
401Unauthorized.
403Forbidden
404Unable to locate records
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
delete/chapters/{tenantId}/committeeMembership/{chapterId}/{id}
Request samples
curl -i -X DELETE \
  https://membership.api.756794052567.rhythmsoftware.com/chapters/:tenantId/committeeMembership/:chapterId/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Generates an order from a membership application

This method will examine a membership application and generate an appropriate order

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

chapterId
required
string

The chapter id

Request Body schema: application/json

The application to generate an order

object
Responses
200Conflicts were retrieved successfully
400The search you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
429Limit exceeded... unable to add order based on tenant limits.
500General server error
post/chapters/{tenantId}/generateOrder/{chapterId}
Request samples
    1 more
    Python
application/json
{ }

Generates an application for a contact or organization

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

chapterId
required
string

The chapter id

processId
required
string

The process id

ownerType
required
string

The contact or organization type

Enum: "contact" "organization"
id
required
string

The contact or organization type

Responses
200Conflicts were retrieved successfully
400The search you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
429Limit exceeded... unable to add order based on tenant limits.
500General server error
post/chapters/{tenantId}/generateApplication/{chapterId}/{processId}/{ownerType}/{id}
Request samples
curl -i -X POST \
  https://membership.api.756794052567.rhythmsoftware.com/chapters/:tenantId/generateApplication/:chapterId/:processId/:ownerType/:id \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "type": "join",
  • "process_id": "string",
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_id": "string",
  • "review_status": "pending review",
  • "last_review_status_change": "2019-08-24T14:15:22Z",
  • "pending_console_review": true,
  • "submission_space_id": "string",
  • "override_bucket_assignment": true,
  • "round_id": "string",
  • "bucket_id": "string",
  • "average_score": 0,
  • "total_score": 0,
  • "reviewer_recommendation": "string",
  • "group_order": 0,
  • "application_group_id": "string",
  • "group_application_process_id": "string",
  • "renew_automatically": true,
  • "name": "string",
  • "date": "2019-08-24T14:15:22Z",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "status": "not yet submitted",
  • "status_reason_id": "string",
  • "assigned_contacts": [
    ],
  • "membership_package_id": "string",
  • "membership_type_id": "string",
  • "chapter_id": "string",
  • "additional_chapter_ids": [
    ],
  • "section_ids": [
    ],
  • "add_ons": [
    ],
  • "corporate_member_ids": [
    ],
  • "referral_contact_id": "string",
  • "do_not_show_in_directory": true,
  • "do_not_renew": true,
  • "notes": "string",
  • "hidden_directory_fields": [
    ],
  • "custom_field_values": [
    ],
  • "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": [
    ]
}

Runs a saved query on behalf of a chapter

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

Parameters to the query

chapterId
required
string

The saved query ID

savedQueryId
required
string

The saved query ID

outputFormat
required
string

The output format of the query

Responses
200The contact was merged successfully.
400The contact supplied was not valid.
401Unauthorized
403Forbidden
404The contact could not be found.
409The contact could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to merge contact based on tenant limits.
500General server error.
post/chapters/{tenantId}/query/{chapterId}/{savedQueryId}/{outputFormat}
Request samples
curl -i -X POST \
  https://membership.api.756794052567.rhythmsoftware.com/chapters/:tenantId/query/:chapterId/:savedQueryId/:outputFormat \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{ }

Get eligible application processes

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

Parameters to the query

chapterId
required
string

The chapter ID

contactId
required
string

The contact ID

Responses
200Processes were retrieved successfully
400The search you supplied was invalid.
401Unauthorized
403Forbidden
404The resource could not be found
429Limit exceeded... unable to add order based on tenant limits.
500General server error
get/chapters/{tenantId}/portal/getEligibleAppProcesses/{chapterId}/{contactId}
Request samples
curl -i -X GET \
  https://membership.api.756794052567.rhythmsoftware.com/chapters/:tenantId/portal/getEligibleAppProcesses/:chapterId/:contactId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{ }

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 chapter could not be found.
429Limit exceeded... unable to retrieve chapter based on tenant limits.
500General server error.
post/chapters/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}

Creates a new chapter record that does not already exist.

This method will auto-generate an ID and create a new chapter. If an ID is specified for the chapter, 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 chapter that you would like to be saved.

id
required
string (ID) /^[\w|-]+$/

The unique, string identifier of this chapter

name
required
string (Name)

The name of the chapter

email_address
string (Email Address)

The email address of the chapter

phone_number
string (Phone Number)

Chapter phone number

website
string (Website)

Website of the chapter

type_id
required
string (Type)

The type of chapter

linked_organization_id
string (Linked Organization)

The organization linked to this chapter, if the chapter owes dues/taxes to the main organization

enable_dues
boolean (Enable Dues)
hide_from_portal
boolean (Hide From Portal)

Whether or not this section is displayed in the portal

enable_new_member_email
boolean (Enable New Member Email)

ALlow for new members to receive an email when they join this chapter

required
object (New Member Email)

The new member email

object (Address)

A complete address

description
string (Description)

Description of the chapter

is_active
boolean (Is Active)

Whether this is an active chapter

Array of objects (Custom Field Values)
sys_search_latlong
string (Sys Search Latlong)

A geocode for distance queries

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 chapter was saved successfully.
400The chapter you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The chapter could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add chapter based on tenant limits.
500General server error.
post/chapters/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "name": "string",
  • "email_address": "string",
  • "phone_number": "string",
  • "website": "string",
  • "type_id": "string",
  • "linked_organization_id": "string",
  • "enable_dues": true,
  • "hide_from_portal": true,
  • "enable_new_member_email": true,
  • "new_member_email": {
    },
  • "address": {
    },
  • "description": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "sys_search_latlong": "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": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "name": "string",
  • "email_address": "string",
  • "phone_number": "string",
  • "website": "string",
  • "type_id": "string",
  • "linked_organization_id": "string",
  • "enable_dues": true,
  • "hide_from_portal": true,
  • "enable_new_member_email": true,
  • "new_member_email": {
    },
  • "address": {
    },
  • "description": "string",
  • "is_active": true,
  • "custom_field_values": [
    ],
  • "sys_search_latlong": "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": [
    ]
}

Gets all of the chapters in the system.

This method will scan all chapters 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 chapterswere 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/chapters/{tenantId}
Request samples
curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/chapters/:tenantId?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
[
  • {
    }
]