Memberships

Memberships

Returns a membership from the system by its ID.

This method will look up a membership 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 membership 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 membership was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The membership could not be found.
429Limit exceeded... unable to retrieve membership based on tenant limits.
500General server error.
get/memberships/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/memberships/:tenantId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_id": "string",
  • "customer_id": "string",
  • "directory_image_uri": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "master_membership_id": "string",
  • "master_membership_organization_id": "string",
  • "application_process_id": "string",
  • "application_id": "string",
  • "membership_join_date": "string",
  • "is_new": true,
  • "date_status": "updated",
  • "status": "active",
  • "status_reason_id": "string",
  • "type_id": "string",
  • "package_id": "string",
  • "join_date": "string",
  • "join_or_last_renewal_date": "string",
  • "term_start_date": "string",
  • "expiration_date": "string",
  • "renewal_date": "string",
  • "reinstatement_date": "string",
  • "termination_date": "string",
  • "lapse_date": "string",
  • "origin": "principal",
  • "parent_membership_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "order_number": 0,
  • "order_balance_due": 0,
  • "order_amount_paid": 0,
  • "order_currency_code": "string",
  • "order_currency_symbol": "string",
  • "order_status": "awaiting payment",
  • "order_total": 0,
  • "hidden_directory_fields": [
    ],
  • "flowdown_depth": 1,
  • "overridden_fields": [
    ],
  • "assigned_memberships": [
    ],
  • "renew_automatically": true,
  • "renewal_payment_info": {
    },
  • "renewal_payment_card_expiration": "2019-08-24",
  • "billed": true,
  • "last_bill_date": "2019-08-24T14:15:22Z",
  • "bill_method": "renewal order",
  • "last_reminder": 0,
  • "last_reminder_date": "2019-08-24T14:15:22Z",
  • "last_expired_card_warning": 0,
  • "last_expired_card_warning_date": "2019-08-24T14:15:22Z",
  • "bill_organization": true,
  • "primary_chapter_id": "string",
  • "chapter_ids": [
    ],
  • "section_ids": [
    ],
  • "add_on_ids": [
    ],
  • "chapters": [
    ],
  • "sections": [
    ],
  • "add_ons": [
    ],
  • "chapter_names": "string",
  • "section_names": "string",
  • "add_on_names": "string",
  • "past_chapter_memberships": [
    ],
  • "past_section_memberships": [
    ],
  • "history": [
    ],
  • "do_not_renew": true,
  • "do_not_drop": true,
  • "do_not_show_in_directory": true,
  • "date_last_updated_in_portal": "2019-08-24T14:15:22Z",
  • "last_change_affiliation_date": "2019-08-24T14:15:22Z",
  • "referral_contact_id": "string",
  • "certificate_uri": "string",
  • "notes": "string",
  • "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": [
    ]
}

Updates a membership with the specified ID.

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

Request Body schema: application/json

The updated membership that will be saved.

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

The unique, string identifier of this membership

number
required
number <float> (Number)

The unique membership number

owner_type
required
string (Owner Type)

The type of owner

Enum: "contact" "organization"
contact_id
required
string (Contact)

The owner of this membership

organization_id
required
string (Organization)

The organizational owner of this membership

customer_id
string (Customer)

For reporting only; the contact ID if this is owned by a contact, the organization if this is owned by an organization

directory_image_uri
string (Directory Image Uri)

The image that appears in the membership directory

first_name
string (First Name)

The member's first name

last_name
string (Last Name)

The member's last name

name
required
string (Name)

The member's name

email_address
string (Email Address)

The member's email address

city
string (City)

The member city

state
string (State)

The state

country
string (Country)

The member country

job_title
string (Job Title)

The member job title

master_membership_id
string (Master Membership)

The master organizational membership that generates the flowdown; when depth=1 this is the same as the parent, but supports cascading membership

master_membership_organization_id
string (Master Membership Organization)

The master organization that owns the membership; when depth=1 this is the same as the parent, but supports cascading membership

application_process_id
string (Application Process)

The last application process

application_id
string (Application)

The last application

membership_join_date
string (Membership Join Date)

Reporting only; used to avoid collisions

is_new
boolean (Is New)

Whether or not this is a new membership

date_status
string (Date Status)

Whether the dates have been updated

Enum: "updated" "not yet updated"
status
string (Status)

The member status

Enum: "active" "inactive" "suspended" "active without benefits"
status_reason_id
string (Status Reason)

The reason that a member is in the specific status

type_id
required
string (Type)

The type of member

package_id
required
string (Package)

The package id of the membership

join_date
string (Join Date)

The date the member joined

join_or_last_renewal_date
string (Join Or Last Renewal Date)

The date the member joined OR renewed

term_start_date
string (Term Start Date)

The date the most recently purchased membership type starts

expiration_date
string (Expiration Date)

The date the membership expires

renewal_date
string (Renewal Date)

The date the member last renewed

reinstatement_date
string (Reinstatement Date)

The date the member was last reinstated

termination_date
string (Termination Date)

The date the member was terminated

lapse_date
string (Lapse Date)

The last date that this record was terminated. Unlike termination date does not get erased

origin
string (Origin)
Enum: "principal" "flowdown" "assigned"
parent_membership_id
required
string (Parent Membership) /organization:.*/

The parent organization

order_id
string (Order)

The order

order_line_item_id
string (Order Line Item)

The order line item

order_number
number <float> (Order Number)

The order number

order_balance_due
number <double> (Order Balance Due)

The balance due on the order

order_amount_paid
number <double> (Order Amount Paid)

The amount paid

order_currency_code
string (Order Currency Code)
order_currency_symbol
string (Order Currency Symbol)
order_status
string (Order Status)
Enum: "awaiting payment" "awaiting shipping" "awaiting pickup" "partially shipped" "shipped" "completed" "cancelled" "disputed" "open" "returned" "void"
order_total
number <double> (Order Total)

The total of the order

hidden_directory_fields
Array of strings (Hidden Directory Fields)

The fields that should not be shown for this member in the directory

flowdown_depth
required
number <float> (Flowdown Depth) [ 1 .. 10 ]

If this is a flow down membership, the depth

overridden_fields
Array of strings (Overridden Fields)

Fields that have been changed on this record, and should not be susceptible to flowdown

Array of objects

Memberships that have been assigned, manually, by organization administrators

renew_automatically
boolean (Renew Automatically)

If set, then this membership will automatically renew with the card on file

required
object (Renewal Payment Info)

The renewal payment info

renewal_payment_card_expiration
string <date> (Renewal Payment Card Expiration)

The date that the renewal payment card expires

billed
boolean (Billed)

Flag indicated whether the membership has been billed

last_bill_date
string <date-time> (Last Bill Date)

The last time this order was billed

bill_method
string (Bill Method)

The method this member was billed

Enum: "renewal order" "auto renewal order" "renewal notice"
last_reminder
number <float> (Last Reminder)

The last reminder number

last_reminder_date
string <date-time> (Last Reminder Date)

The last time a reminder was sent

last_expired_card_warning
number <float> (Last Expired Card Warning)

The last expired card warning

last_expired_card_warning_date
string <date-time> (Last Expired Card Warning Date)

The last time a reminder was sent

bill_organization
boolean (Bill Organization)

Whether or not to bill the organization for this membership

primary_chapter_id
string (Primary Chapter)

The chapter ID (used for reporting, DO NOT UPLOAD DATA HERE

chapter_ids
Array of strings (Chapter IDs)

used for reporting, DO NOT UPLOAD DATA HERE

section_ids
Array of strings (Section IDs)

used for reporting, DO NOT UPLOAD DATA HERE

add_on_ids
Array of strings (Add Ons)

used for reporting, DO NOT UPLOAD DATA HERE

Array of objects
Array of objects
Array of objects
chapter_names
string (Chapter Names)

Read only: Show the name of the chapters to which a person belongs

section_names
string (Section Names)

Read only: Show the name of the sections to which a person belongs

add_on_names
string (Add On Names)

Read only: Show the name of the add ons to this membership

Array of objects
Array of objects
Array of objects

The history of membership events & activities

do_not_renew
boolean (Do Not Renew)

If so, this membership will not renew

do_not_drop
boolean (Do Not Drop)

If set, this membership will not be dropped/terminated along lifecycle rules

do_not_show_in_directory
boolean (Do Not Show In Directory)

If set, the membership is not available in the directory

date_last_updated_in_portal
string <date-time> (Date Last Updated In Portal)

The date that this was last updated in the portal

last_change_affiliation_date
string <date-time> (Last Change Affiliation Date)

The last date a change affiliation was run on this membership

referral_contact_id
string (Referral Contact)

The individual who referred this member

certificate_uri
string (Certificate Uri)

A link to an externally created certificate of membership

notes
string (Notes)
Array of objects (Custom Field Values)
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 membership was updated successfully.
400The membership supplied was not valid.
401Unauthorized.
403Forbidden.
404The membership could not be found.
409The membership could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve membership based on tenant limits.
500General server error.
put/memberships/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "number": 0,
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_id": "string",
  • "customer_id": "string",
  • "directory_image_uri": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "master_membership_id": "string",
  • "master_membership_organization_id": "string",
  • "application_process_id": "string",
  • "application_id": "string",
  • "membership_join_date": "string",
  • "is_new": true,
  • "date_status": "updated",
  • "status": "active",
  • "status_reason_id": "string",
  • "type_id": "string",
  • "package_id": "string",
  • "join_date": "string",
  • "join_or_last_renewal_date": "string",
  • "term_start_date": "string",
  • "expiration_date": "string",
  • "renewal_date": "string",
  • "reinstatement_date": "string",
  • "termination_date": "string",
  • "lapse_date": "string",
  • "origin": "principal",
  • "parent_membership_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "order_number": 0,
  • "order_balance_due": 0,
  • "order_amount_paid": 0,
  • "order_currency_code": "string",
  • "order_currency_symbol": "string",
  • "order_status": "awaiting payment",
  • "order_total": 0,
  • "hidden_directory_fields": [
    ],
  • "flowdown_depth": 1,
  • "overridden_fields": [
    ],
  • "assigned_memberships": [
    ],
  • "renew_automatically": true,
  • "renewal_payment_info": {
    },
  • "renewal_payment_card_expiration": "2019-08-24",
  • "billed": true,
  • "last_bill_date": "2019-08-24T14:15:22Z",
  • "bill_method": "renewal order",
  • "last_reminder": 0,
  • "last_reminder_date": "2019-08-24T14:15:22Z",
  • "last_expired_card_warning": 0,
  • "last_expired_card_warning_date": "2019-08-24T14:15:22Z",
  • "bill_organization": true,
  • "primary_chapter_id": "string",
  • "chapter_ids": [
    ],
  • "section_ids": [
    ],
  • "add_on_ids": [
    ],
  • "chapters": [
    ],
  • "sections": [
    ],
  • "add_ons": [
    ],
  • "chapter_names": "string",
  • "section_names": "string",
  • "add_on_names": "string",
  • "past_chapter_memberships": [
    ],
  • "past_section_memberships": [
    ],
  • "history": [
    ],
  • "do_not_renew": true,
  • "do_not_drop": true,
  • "do_not_show_in_directory": true,
  • "date_last_updated_in_portal": "2019-08-24T14:15:22Z",
  • "last_change_affiliation_date": "2019-08-24T14:15:22Z",
  • "referral_contact_id": "string",
  • "certificate_uri": "string",
  • "notes": "string",
  • "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": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_id": "string",
  • "customer_id": "string",
  • "directory_image_uri": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "master_membership_id": "string",
  • "master_membership_organization_id": "string",
  • "application_process_id": "string",
  • "application_id": "string",
  • "membership_join_date": "string",
  • "is_new": true,
  • "date_status": "updated",
  • "status": "active",
  • "status_reason_id": "string",
  • "type_id": "string",
  • "package_id": "string",
  • "join_date": "string",
  • "join_or_last_renewal_date": "string",
  • "term_start_date": "string",
  • "expiration_date": "string",
  • "renewal_date": "string",
  • "reinstatement_date": "string",
  • "termination_date": "string",
  • "lapse_date": "string",
  • "origin": "principal",
  • "parent_membership_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "order_number": 0,
  • "order_balance_due": 0,
  • "order_amount_paid": 0,
  • "order_currency_code": "string",
  • "order_currency_symbol": "string",
  • "order_status": "awaiting payment",
  • "order_total": 0,
  • "hidden_directory_fields": [
    ],
  • "flowdown_depth": 1,
  • "overridden_fields": [
    ],
  • "assigned_memberships": [
    ],
  • "renew_automatically": true,
  • "renewal_payment_info": {
    },
  • "renewal_payment_card_expiration": "2019-08-24",
  • "billed": true,
  • "last_bill_date": "2019-08-24T14:15:22Z",
  • "bill_method": "renewal order",
  • "last_reminder": 0,
  • "last_reminder_date": "2019-08-24T14:15:22Z",
  • "last_expired_card_warning": 0,
  • "last_expired_card_warning_date": "2019-08-24T14:15:22Z",
  • "bill_organization": true,
  • "primary_chapter_id": "string",
  • "chapter_ids": [
    ],
  • "section_ids": [
    ],
  • "add_on_ids": [
    ],
  • "chapters": [
    ],
  • "sections": [
    ],
  • "add_ons": [
    ],
  • "chapter_names": "string",
  • "section_names": "string",
  • "add_on_names": "string",
  • "past_chapter_memberships": [
    ],
  • "past_section_memberships": [
    ],
  • "history": [
    ],
  • "do_not_renew": true,
  • "do_not_drop": true,
  • "do_not_show_in_directory": true,
  • "date_last_updated_in_portal": "2019-08-24T14:15:22Z",
  • "last_change_affiliation_date": "2019-08-24T14:15:22Z",
  • "referral_contact_id": "string",
  • "certificate_uri": "string",
  • "notes": "string",
  • "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": [
    ]
}

Partially updates a membership with the specified ID.

This method will patch an existing membership 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 membership 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 membership was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The membership could not be found.
409The membership could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve membership based on tenant limits.
500General server error.
patch/memberships/{tenantId}/{id}
Request samples
    1 more
    Python
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_id": "string",
  • "customer_id": "string",
  • "directory_image_uri": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "master_membership_id": "string",
  • "master_membership_organization_id": "string",
  • "application_process_id": "string",
  • "application_id": "string",
  • "membership_join_date": "string",
  • "is_new": true,
  • "date_status": "updated",
  • "status": "active",
  • "status_reason_id": "string",
  • "type_id": "string",
  • "package_id": "string",
  • "join_date": "string",
  • "join_or_last_renewal_date": "string",
  • "term_start_date": "string",
  • "expiration_date": "string",
  • "renewal_date": "string",
  • "reinstatement_date": "string",
  • "termination_date": "string",
  • "lapse_date": "string",
  • "origin": "principal",
  • "parent_membership_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "order_number": 0,
  • "order_balance_due": 0,
  • "order_amount_paid": 0,
  • "order_currency_code": "string",
  • "order_currency_symbol": "string",
  • "order_status": "awaiting payment",
  • "order_total": 0,
  • "hidden_directory_fields": [
    ],
  • "flowdown_depth": 1,
  • "overridden_fields": [
    ],
  • "assigned_memberships": [
    ],
  • "renew_automatically": true,
  • "renewal_payment_info": {
    },
  • "renewal_payment_card_expiration": "2019-08-24",
  • "billed": true,
  • "last_bill_date": "2019-08-24T14:15:22Z",
  • "bill_method": "renewal order",
  • "last_reminder": 0,
  • "last_reminder_date": "2019-08-24T14:15:22Z",
  • "last_expired_card_warning": 0,
  • "last_expired_card_warning_date": "2019-08-24T14:15:22Z",
  • "bill_organization": true,
  • "primary_chapter_id": "string",
  • "chapter_ids": [
    ],
  • "section_ids": [
    ],
  • "add_on_ids": [
    ],
  • "chapters": [
    ],
  • "sections": [
    ],
  • "add_ons": [
    ],
  • "chapter_names": "string",
  • "section_names": "string",
  • "add_on_names": "string",
  • "past_chapter_memberships": [
    ],
  • "past_section_memberships": [
    ],
  • "history": [
    ],
  • "do_not_renew": true,
  • "do_not_drop": true,
  • "do_not_show_in_directory": true,
  • "date_last_updated_in_portal": "2019-08-24T14:15:22Z",
  • "last_change_affiliation_date": "2019-08-24T14:15:22Z",
  • "referral_contact_id": "string",
  • "certificate_uri": "string",
  • "notes": "string",
  • "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": [
    ]
}

Returns a membership from the system by its ID.

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

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

Gets a membership by contact

Gets a membership by contact

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

contactId
required
string

The contact id

Responses
200The members was retrieved successfully
400The members supplied was not valid.
401Unauthorized
403Forbidden
404The members could not be found.
429Request limit exceeded... please try your request again in a few seconds
500General server error.
get/memberships/{tenantId}/contact/{contactId}
Request samples
curl -i -X GET \
  https://membership.api.756794052567.rhythmsoftware.com/memberships/:tenantId/contact/:contactId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_id": "string",
  • "customer_id": "string",
  • "directory_image_uri": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "master_membership_id": "string",
  • "master_membership_organization_id": "string",
  • "application_process_id": "string",
  • "application_id": "string",
  • "membership_join_date": "string",
  • "is_new": true,
  • "date_status": "updated",
  • "status": "active",
  • "status_reason_id": "string",
  • "type_id": "string",
  • "package_id": "string",
  • "join_date": "string",
  • "join_or_last_renewal_date": "string",
  • "term_start_date": "string",
  • "expiration_date": "string",
  • "renewal_date": "string",
  • "reinstatement_date": "string",
  • "termination_date": "string",
  • "lapse_date": "string",
  • "origin": "principal",
  • "parent_membership_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "order_number": 0,
  • "order_balance_due": 0,
  • "order_amount_paid": 0,
  • "order_currency_code": "string",
  • "order_currency_symbol": "string",
  • "order_status": "awaiting payment",
  • "order_total": 0,
  • "hidden_directory_fields": [
    ],
  • "flowdown_depth": 1,
  • "overridden_fields": [
    ],
  • "assigned_memberships": [
    ],
  • "renew_automatically": true,
  • "renewal_payment_info": {
    },
  • "renewal_payment_card_expiration": "2019-08-24",
  • "billed": true,
  • "last_bill_date": "2019-08-24T14:15:22Z",
  • "bill_method": "renewal order",
  • "last_reminder": 0,
  • "last_reminder_date": "2019-08-24T14:15:22Z",
  • "last_expired_card_warning": 0,
  • "last_expired_card_warning_date": "2019-08-24T14:15:22Z",
  • "bill_organization": true,
  • "primary_chapter_id": "string",
  • "chapter_ids": [
    ],
  • "section_ids": [
    ],
  • "add_on_ids": [
    ],
  • "chapters": [
    ],
  • "sections": [
    ],
  • "add_ons": [
    ],
  • "chapter_names": "string",
  • "section_names": "string",
  • "add_on_names": "string",
  • "past_chapter_memberships": [
    ],
  • "past_section_memberships": [
    ],
  • "history": [
    ],
  • "do_not_renew": true,
  • "do_not_drop": true,
  • "do_not_show_in_directory": true,
  • "date_last_updated_in_portal": "2019-08-24T14:15:22Z",
  • "last_change_affiliation_date": "2019-08-24T14:15:22Z",
  • "referral_contact_id": "string",
  • "certificate_uri": "string",
  • "notes": "string",
  • "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": [
    ]
}

Gets a membership by organization

Gets a membership by organization

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

organizationId
required
string

The organization id

Responses
200The members was retrieved successfully
400The members supplied was not valid.
401Unauthorized
403Forbidden
404The members could not be found.
429Request limit exceeded... please try your request again in a few seconds
500General server error.
get/memberships/{tenantId}/organization/{organizationId}
Request samples
curl -i -X GET \
  https://membership.api.756794052567.rhythmsoftware.com/memberships/:tenantId/organization/:organizationId \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_id": "string",
  • "customer_id": "string",
  • "directory_image_uri": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "master_membership_id": "string",
  • "master_membership_organization_id": "string",
  • "application_process_id": "string",
  • "application_id": "string",
  • "membership_join_date": "string",
  • "is_new": true,
  • "date_status": "updated",
  • "status": "active",
  • "status_reason_id": "string",
  • "type_id": "string",
  • "package_id": "string",
  • "join_date": "string",
  • "join_or_last_renewal_date": "string",
  • "term_start_date": "string",
  • "expiration_date": "string",
  • "renewal_date": "string",
  • "reinstatement_date": "string",
  • "termination_date": "string",
  • "lapse_date": "string",
  • "origin": "principal",
  • "parent_membership_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "order_number": 0,
  • "order_balance_due": 0,
  • "order_amount_paid": 0,
  • "order_currency_code": "string",
  • "order_currency_symbol": "string",
  • "order_status": "awaiting payment",
  • "order_total": 0,
  • "hidden_directory_fields": [
    ],
  • "flowdown_depth": 1,
  • "overridden_fields": [
    ],
  • "assigned_memberships": [
    ],
  • "renew_automatically": true,
  • "renewal_payment_info": {
    },
  • "renewal_payment_card_expiration": "2019-08-24",
  • "billed": true,
  • "last_bill_date": "2019-08-24T14:15:22Z",
  • "bill_method": "renewal order",
  • "last_reminder": 0,
  • "last_reminder_date": "2019-08-24T14:15:22Z",
  • "last_expired_card_warning": 0,
  • "last_expired_card_warning_date": "2019-08-24T14:15:22Z",
  • "bill_organization": true,
  • "primary_chapter_id": "string",
  • "chapter_ids": [
    ],
  • "section_ids": [
    ],
  • "add_on_ids": [
    ],
  • "chapters": [
    ],
  • "sections": [
    ],
  • "add_ons": [
    ],
  • "chapter_names": "string",
  • "section_names": "string",
  • "add_on_names": "string",
  • "past_chapter_memberships": [
    ],
  • "past_section_memberships": [
    ],
  • "history": [
    ],
  • "do_not_renew": true,
  • "do_not_drop": true,
  • "do_not_show_in_directory": true,
  • "date_last_updated_in_portal": "2019-08-24T14:15:22Z",
  • "last_change_affiliation_date": "2019-08-24T14:15:22Z",
  • "referral_contact_id": "string",
  • "certificate_uri": "string",
  • "notes": "string",
  • "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": [
    ]
}

Re-runs flowdown for all organizations in the system

Given a set of expiration options, allows for the calculation of an expiration date

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The id of the tenant being accessed.

notification_email
string (Notification Email)
Responses
200Date was calculated successfully
400The members supplied was not valid.
401Unauthorized
403Forbidden
404The members could not be found.
429Request limit exceeded... please try your request again in a few seconds
500General server error.
post/memberships/{tenantId}/reprocessFlowDown
Request samples
    1 more
    Python
application/json
{
  • "notification_email": "string"
}
Response samples
application/json
"string"

Generates snapshot lookback for a tenant

Given a set of expiration options, allows for the calculation of an expiration date

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Responses
200Date was calculated successfully
400The members supplied was not valid.
401Unauthorized
403Forbidden
404The members could not be found.
429Request limit exceeded... please try your request again in a few seconds
500General server error.
post/memberships/{tenantId}/initiateSnapshotLookback
Request samples
curl -i -X POST \
  https://membership.api.756794052567.rhythmsoftware.com/memberships/:tenantId/initiateSnapshotLookback \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Returns a membership from the system by its ID for a given contact.

This method will look up a membership by the specified ID and return it back (for a portal contact)

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

portalContactId
required
string

The contact to use

id
required
string

The ID of the membership 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 membership was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The membership could not be found.
429Limit exceeded... unable to retrieve membership based on tenant limits.
500General server error.
get/memberships/{tenantId}/portal/contact/{portalContactId}/{id}
Request samples
curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/memberships/:tenantId/portal/contact/:portalContactId/:id?fields=string&consistentRead=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_id": "string",
  • "customer_id": "string",
  • "directory_image_uri": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "master_membership_id": "string",
  • "master_membership_organization_id": "string",
  • "application_process_id": "string",
  • "application_id": "string",
  • "membership_join_date": "string",
  • "is_new": true,
  • "date_status": "updated",
  • "status": "active",
  • "status_reason_id": "string",
  • "type_id": "string",
  • "package_id": "string",
  • "join_date": "string",
  • "join_or_last_renewal_date": "string",
  • "term_start_date": "string",
  • "expiration_date": "string",
  • "renewal_date": "string",
  • "reinstatement_date": "string",
  • "termination_date": "string",
  • "lapse_date": "string",
  • "origin": "principal",
  • "parent_membership_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "order_number": 0,
  • "order_balance_due": 0,
  • "order_amount_paid": 0,
  • "order_currency_code": "string",
  • "order_currency_symbol": "string",
  • "order_status": "awaiting payment",
  • "order_total": 0,
  • "hidden_directory_fields": [
    ],
  • "flowdown_depth": 1,
  • "overridden_fields": [
    ],
  • "assigned_memberships": [
    ],
  • "renew_automatically": true,
  • "renewal_payment_info": {
    },
  • "renewal_payment_card_expiration": "2019-08-24",
  • "billed": true,
  • "last_bill_date": "2019-08-24T14:15:22Z",
  • "bill_method": "renewal order",
  • "last_reminder": 0,
  • "last_reminder_date": "2019-08-24T14:15:22Z",
  • "last_expired_card_warning": 0,
  • "last_expired_card_warning_date": "2019-08-24T14:15:22Z",
  • "bill_organization": true,
  • "primary_chapter_id": "string",
  • "chapter_ids": [
    ],
  • "section_ids": [
    ],
  • "add_on_ids": [
    ],
  • "chapters": [
    ],
  • "sections": [
    ],
  • "add_ons": [
    ],
  • "chapter_names": "string",
  • "section_names": "string",
  • "add_on_names": "string",
  • "past_chapter_memberships": [
    ],
  • "past_section_memberships": [
    ],
  • "history": [
    ],
  • "do_not_renew": true,
  • "do_not_drop": true,
  • "do_not_show_in_directory": true,
  • "date_last_updated_in_portal": "2019-08-24T14:15:22Z",
  • "last_change_affiliation_date": "2019-08-24T14:15:22Z",
  • "referral_contact_id": "string",
  • "certificate_uri": "string",
  • "notes": "string",
  • "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": [
    ]
}

Given a set of expiration options, allows for the calculation of an expiration date

Given a set of expiration options, allows for the calculation of an expiration date

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

dateToUseAsBasisForCalculation
required
string

The date that should be used as the basis for calculation

Request Body schema: application/json

The expiration options

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

The unique, string identifier of this membership

number
required
number <float> (Number)

The unique membership number

owner_type
required
string (Owner Type)

The type of owner

Enum: "contact" "organization"
contact_id
required
string (Contact)

The owner of this membership

organization_id
required
string (Organization)

The organizational owner of this membership

customer_id
string (Customer)

For reporting only; the contact ID if this is owned by a contact, the organization if this is owned by an organization

directory_image_uri
string (Directory Image Uri)

The image that appears in the membership directory

first_name
string (First Name)

The member's first name

last_name
string (Last Name)

The member's last name

name
required
string (Name)

The member's name

email_address
string (Email Address)

The member's email address

city
string (City)

The member city

state
string (State)

The state

country
string (Country)

The member country

job_title
string (Job Title)

The member job title

master_membership_id
string (Master Membership)

The master organizational membership that generates the flowdown; when depth=1 this is the same as the parent, but supports cascading membership

master_membership_organization_id
string (Master Membership Organization)

The master organization that owns the membership; when depth=1 this is the same as the parent, but supports cascading membership

application_process_id
string (Application Process)

The last application process

application_id
string (Application)

The last application

membership_join_date
string (Membership Join Date)

Reporting only; used to avoid collisions

is_new
boolean (Is New)

Whether or not this is a new membership

date_status
string (Date Status)

Whether the dates have been updated

Enum: "updated" "not yet updated"
status
string (Status)

The member status

Enum: "active" "inactive" "suspended" "active without benefits"
status_reason_id
string (Status Reason)

The reason that a member is in the specific status

type_id
required
string (Type)

The type of member

package_id
required
string (Package)

The package id of the membership

join_date
string (Join Date)

The date the member joined

join_or_last_renewal_date
string (Join Or Last Renewal Date)

The date the member joined OR renewed

term_start_date
string (Term Start Date)

The date the most recently purchased membership type starts

expiration_date
string (Expiration Date)

The date the membership expires

renewal_date
string (Renewal Date)

The date the member last renewed

reinstatement_date
string (Reinstatement Date)

The date the member was last reinstated

termination_date
string (Termination Date)

The date the member was terminated

lapse_date
string (Lapse Date)

The last date that this record was terminated. Unlike termination date does not get erased

origin
string (Origin)
Enum: "principal" "flowdown" "assigned"
parent_membership_id
required
string (Parent Membership) /organization:.*/

The parent organization

order_id
string (Order)

The order

order_line_item_id
string (Order Line Item)

The order line item

order_number
number <float> (Order Number)

The order number

order_balance_due
number <double> (Order Balance Due)

The balance due on the order

order_amount_paid
number <double> (Order Amount Paid)

The amount paid

order_currency_code
string (Order Currency Code)
order_currency_symbol
string (Order Currency Symbol)
order_status
string (Order Status)
Enum: "awaiting payment" "awaiting shipping" "awaiting pickup" "partially shipped" "shipped" "completed" "cancelled" "disputed" "open" "returned" "void"
order_total
number <double> (Order Total)

The total of the order

hidden_directory_fields
Array of strings (Hidden Directory Fields)

The fields that should not be shown for this member in the directory

flowdown_depth
required
number <float> (Flowdown Depth) [ 1 .. 10 ]

If this is a flow down membership, the depth

overridden_fields
Array of strings (Overridden Fields)

Fields that have been changed on this record, and should not be susceptible to flowdown

Array of objects

Memberships that have been assigned, manually, by organization administrators

renew_automatically
boolean (Renew Automatically)

If set, then this membership will automatically renew with the card on file

required
object (Renewal Payment Info)

The renewal payment info

renewal_payment_card_expiration
string <date> (Renewal Payment Card Expiration)

The date that the renewal payment card expires

billed
boolean (Billed)

Flag indicated whether the membership has been billed

last_bill_date
string <date-time> (Last Bill Date)

The last time this order was billed

bill_method
string (Bill Method)

The method this member was billed

Enum: "renewal order" "auto renewal order" "renewal notice"
last_reminder
number <float> (Last Reminder)

The last reminder number

last_reminder_date
string <date-time> (Last Reminder Date)

The last time a reminder was sent

last_expired_card_warning
number <float> (Last Expired Card Warning)

The last expired card warning

last_expired_card_warning_date
string <date-time> (Last Expired Card Warning Date)

The last time a reminder was sent

bill_organization
boolean (Bill Organization)

Whether or not to bill the organization for this membership

primary_chapter_id
string (Primary Chapter)

The chapter ID (used for reporting, DO NOT UPLOAD DATA HERE

chapter_ids
Array of strings (Chapter IDs)

used for reporting, DO NOT UPLOAD DATA HERE

section_ids
Array of strings (Section IDs)

used for reporting, DO NOT UPLOAD DATA HERE

add_on_ids
Array of strings (Add Ons)

used for reporting, DO NOT UPLOAD DATA HERE

Array of objects
Array of objects
Array of objects
chapter_names
string (Chapter Names)

Read only: Show the name of the chapters to which a person belongs

section_names
string (Section Names)

Read only: Show the name of the sections to which a person belongs

add_on_names
string (Add On Names)

Read only: Show the name of the add ons to this membership

Array of objects
Array of objects
Array of objects

The history of membership events & activities

do_not_renew
boolean (Do Not Renew)

If so, this membership will not renew

do_not_drop
boolean (Do Not Drop)

If set, this membership will not be dropped/terminated along lifecycle rules

do_not_show_in_directory
boolean (Do Not Show In Directory)

If set, the membership is not available in the directory

date_last_updated_in_portal
string <date-time> (Date Last Updated In Portal)

The date that this was last updated in the portal

last_change_affiliation_date
string <date-time> (Last Change Affiliation Date)

The last date a change affiliation was run on this membership

referral_contact_id
string (Referral Contact)

The individual who referred this member

certificate_uri
string (Certificate Uri)

A link to an externally created certificate of membership

notes
string (Notes)
Array of objects (Custom Field Values)
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
200Date was calculated successfully
400The members supplied was not valid.
401Unauthorized
403Forbidden
404The members could not be found.
429Request limit exceeded... please try your request again in a few seconds
500General server error.
post/memberships/{tenantId}/expirationDateCalculation/{dateToUseAsBasisForCalculation}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "number": 0,
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_id": "string",
  • "customer_id": "string",
  • "directory_image_uri": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "master_membership_id": "string",
  • "master_membership_organization_id": "string",
  • "application_process_id": "string",
  • "application_id": "string",
  • "membership_join_date": "string",
  • "is_new": true,
  • "date_status": "updated",
  • "status": "active",
  • "status_reason_id": "string",
  • "type_id": "string",
  • "package_id": "string",
  • "join_date": "string",
  • "join_or_last_renewal_date": "string",
  • "term_start_date": "string",
  • "expiration_date": "string",
  • "renewal_date": "string",
  • "reinstatement_date": "string",
  • "termination_date": "string",
  • "lapse_date": "string",
  • "origin": "principal",
  • "parent_membership_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "order_number": 0,
  • "order_balance_due": 0,
  • "order_amount_paid": 0,
  • "order_currency_code": "string",
  • "order_currency_symbol": "string",
  • "order_status": "awaiting payment",
  • "order_total": 0,
  • "hidden_directory_fields": [
    ],
  • "flowdown_depth": 1,
  • "overridden_fields": [
    ],
  • "assigned_memberships": [
    ],
  • "renew_automatically": true,
  • "renewal_payment_info": {
    },
  • "renewal_payment_card_expiration": "2019-08-24",
  • "billed": true,
  • "last_bill_date": "2019-08-24T14:15:22Z",
  • "bill_method": "renewal order",
  • "last_reminder": 0,
  • "last_reminder_date": "2019-08-24T14:15:22Z",
  • "last_expired_card_warning": 0,
  • "last_expired_card_warning_date": "2019-08-24T14:15:22Z",
  • "bill_organization": true,
  • "primary_chapter_id": "string",
  • "chapter_ids": [
    ],
  • "section_ids": [
    ],
  • "add_on_ids": [
    ],
  • "chapters": [
    ],
  • "sections": [
    ],
  • "add_ons": [
    ],
  • "chapter_names": "string",
  • "section_names": "string",
  • "add_on_names": "string",
  • "past_chapter_memberships": [
    ],
  • "past_section_memberships": [
    ],
  • "history": [
    ],
  • "do_not_renew": true,
  • "do_not_drop": true,
  • "do_not_show_in_directory": true,
  • "date_last_updated_in_portal": "2019-08-24T14:15:22Z",
  • "last_change_affiliation_date": "2019-08-24T14:15:22Z",
  • "referral_contact_id": "string",
  • "certificate_uri": "string",
  • "notes": "string",
  • "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": [
    ]
}
Response samples
application/json
"string"

Searches for memberships using predefined parameters

Searches for memberships 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 membership that you would like to be saved.

id
Array of strings (ID)

IDs to search

name
string (Name)
city
string (City)
state
string (State)
email_address
string (Email Address)
job_title
string (Job Title)
owner_type
string (Owner Type)
status
Array of strings (Status)
status_reason_id
Array of strings (Status Reason)
type_id
Array of strings (Type)
package_id
Array of strings (Package)
number
Array of numbers <float> (Number) 2 items
join_date
Array of strings <date-time> (Join Date) 2 items
expiration_date
Array of strings <date-time> (Expiration Date) 2 items
renewal_date
Array of strings <date-time> (Renewal Date) 2 items
termination_date
Array of strings <date-time> (Termination Date) 2 items
is_new
string (Is New)
origin
Array of strings (Origin)
Responses
200The membership search was saved successfully.
400The membership you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The membership could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add membership based on tenant limits.
500General server error.
post/memberships/{tenantId}/search
Request samples
    1 more
    Python
application/json
{
  • "id": [
    ],
  • "name": "string",
  • "city": "string",
  • "state": "string",
  • "email_address": "string",
  • "job_title": "string",
  • "owner_type": "string",
  • "status": [
    ],
  • "status_reason_id": [
    ],
  • "type_id": [
    ],
  • "package_id": [
    ],
  • "number": [
    ],
  • "join_date": [
    ],
  • "expiration_date": [
    ],
  • "renewal_date": [
    ],
  • "termination_date": [
    ],
  • "is_new": "string",
  • "origin": [
    ]
}
Response samples
application/json
{
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified parent_membership_id

Returns a list of records with the specified parent_membership_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

parent_membership_id
required
string

The parent_membership_id to use to for record lookup

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/memberships/{tenantId}/parentMembership/{parent_membership_id}
Request samples
curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/memberships/:tenantId/parentMembership/:parent_membership_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Generates a PDF for the ID Card and returns the public link for download

Generates a PDF for the ID Card and returns the public link for download

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

id
required
string

The ID of the membership

query Parameters
downloadAsHtml
boolean

If true, return the receipt as HTML

Responses
200The membership was downloaded successfully
400The request was not valid.
401Unauthorized
403Forbidden
404The payment could not be found.
429Limit exceeded... unable to retrieve payment based on tenant limits.
500General server error
get/memberships/{tenantId}/idCard/{id}
Request samples
curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/memberships/:tenantId/idCard/:id?downloadAsHtml=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Downloads a Certificate

Returns the HTML for the certificate

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed

id
required
string

The ID of the membership

query Parameters
downloadAsHtml
boolean

If true, return the receipt as HTML

Responses
200The membership was downloaded successfully
400The request was not valid.
401Unauthorized
403Forbidden
404The payment could not be found.
429Limit exceeded... unable to retrieve payment based on tenant limits.
500General server error
get/memberships/{tenantId}/certificate/{id}
Request samples
curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/memberships/:tenantId/certificate/:id?downloadAsHtml=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
"string"

Activate membership

Activate membership

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The id of the tenant being accessed.

application_id
required
string

The contact id

Responses
200The members was retrieved successfully
400The members supplied was not valid.
401Unauthorized
403Forbidden
404The members could not be found.
429Request limit exceeded... please try your request again in a few seconds
500General server error.
post/memberships/{tenantId}/activate/{application_id}
Request samples
curl -i -X POST \
  https://membership.api.756794052567.rhythmsoftware.com/memberships/:tenantId/activate/:application_id \
  -H 'Authorization: YOUR_API_KEY_HERE'

Returns a list of records with the specified order_id

Returns a list of records with the specified order_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

order_id
required
string

The order_id to use to for record lookup

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/memberships/{tenantId}/order/{order_id}
Request samples
curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/memberships/:tenantId/order/:order_id?fields=string&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Sends out a preview of the CRC notification email

Sends out a preview of the CRC notification email

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

membership_id
required
string (Membership)
object (Email Template)
destination_email_address
required
string (Destination Email Address)
Responses
200The record was retrieved successfully
400The request was not valid.
401Unauthorized
403Forbidden
404Unable to locate any organizations with the specified domain
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
post/memberships/{tenantId}/previewEmail
Request samples
    1 more
    Python
application/json
{
  • "membership_id": "string",
  • "email_template": {
    },
  • "destination_email_address": "string"
}

Sends out a preview of the CRC notification email

Sends out a preview of the CRC notification email

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

application_group_id
required
string (Application Group)
object (Email Template)
destination_email_address
required
string (Destination Email Address)
Responses
200The record was retrieved successfully
400The request was not valid.
401Unauthorized
403Forbidden
404Unable to locate any organizations with the specified domain
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
post/memberships/{tenantId}/previewGroupApplicationEmail
Request samples
    1 more
    Python
application/json
{
  • "application_group_id": "string",
  • "email_template": {
    },
  • "destination_email_address": "string"
}

Sends out a preview of the CRC notification certificate

Sends out a preview of the CRC notification certificate

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

Request Body schema: application/json

The domain_name to use to for record lookup

membership_id
required
string (Membership)
certificate_template
required
string (Certificate Template)
Responses
200The record was retrieved successfully
400The request was not valid.
401Unauthorized
403Forbidden
404Unable to locate any organizations with the specified domain
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
post/memberships/{tenantId}/previewCertificate
Request samples
    1 more
    Python
application/json
{
  • "membership_id": "string",
  • "certificate_template": "string"
}

Sends out a preview of the CRC notification email

Sends out a preview of the CRC notification email

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

id
required
string

The membership ID

Request Body schema: application/json

The domain_name to use to for record lookup

membership_id
required
string (Membership)
id_card_template
required
string (Id Card Template)
Responses
200The record was retrieved successfully
400The request was not valid.
401Unauthorized
403Forbidden
404Unable to locate any organizations with the specified domain
429Limit exceeded... unable to retrieve records based on tenant limits.
500General server error
post/memberships/{tenantId}/previewIdCard/{id}
Request samples
    1 more
    Python
application/json
{
  • "membership_id": "string",
  • "id_card_template": "string"
}

Returns a list of records with the specified chapter_id

Returns a list of records with the specified chapter_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

chapter_id
required
string

The chapter_id to use to for record lookup

query Parameters
fields
string

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

chapterStatus
string

Filter by chaper status

Enum: "current" "not current" "all"
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/memberships/{tenantId}/chapter/{chapter_id}
Request samples
curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/memberships/:tenantId/chapter/:chapter_id?fields=string&chapterStatus=current&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified section_id

Returns a list of records with the specified section_id

Request
Security:
knox-authorizer
path Parameters
tenantId
required
string

The tenant

section_id
required
string

The section_id to use to for record lookup

query Parameters
fields
string

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

sectionStatus
string

Filter by chaper status

Enum: "current" "not current" "all"
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/memberships/{tenantId}/section/{section_id}
Request samples
curl -i -X GET \
  'https://membership.api.756794052567.rhythmsoftware.com/memberships/:tenantId/section/:section_id?fields=string&sectionStatus=current&exclusiveStartKey=string' \
  -H 'Authorization: YOUR_API_KEY_HERE'
Response samples
application/json
{
  • "Count": 0,
  • "Items": [
    ],
  • "LastEvaluatedKey": "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 membership could not be found.
429Limit exceeded... unable to retrieve membership based on tenant limits.
500General server error.
post/memberships/{tenantId}/batch
Request samples
    1 more
    Python
application/json
{
  • "operations": [
    ]
}
Response samples
application/json
{
  • "success_count": 0,
  • "error_count": 0,
  • "results": [
    ]
}

Creates a new membership record that does not already exist.

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

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

The unique, string identifier of this membership

number
required
number <float> (Number)

The unique membership number

owner_type
required
string (Owner Type)

The type of owner

Enum: "contact" "organization"
contact_id
required
string (Contact)

The owner of this membership

organization_id
required
string (Organization)

The organizational owner of this membership

customer_id
string (Customer)

For reporting only; the contact ID if this is owned by a contact, the organization if this is owned by an organization

directory_image_uri
string (Directory Image Uri)

The image that appears in the membership directory

first_name
string (First Name)

The member's first name

last_name
string (Last Name)

The member's last name

name
required
string (Name)

The member's name

email_address
string (Email Address)

The member's email address

city
string (City)

The member city

state
string (State)

The state

country
string (Country)

The member country

job_title
string (Job Title)

The member job title

master_membership_id
string (Master Membership)

The master organizational membership that generates the flowdown; when depth=1 this is the same as the parent, but supports cascading membership

master_membership_organization_id
string (Master Membership Organization)

The master organization that owns the membership; when depth=1 this is the same as the parent, but supports cascading membership

application_process_id
string (Application Process)

The last application process

application_id
string (Application)

The last application

membership_join_date
string (Membership Join Date)

Reporting only; used to avoid collisions

is_new
boolean (Is New)

Whether or not this is a new membership

date_status
string (Date Status)

Whether the dates have been updated

Enum: "updated" "not yet updated"
status
string (Status)

The member status

Enum: "active" "inactive" "suspended" "active without benefits"
status_reason_id
string (Status Reason)

The reason that a member is in the specific status

type_id
required
string (Type)

The type of member

package_id
required
string (Package)

The package id of the membership

join_date
string (Join Date)

The date the member joined

join_or_last_renewal_date
string (Join Or Last Renewal Date)

The date the member joined OR renewed

term_start_date
string (Term Start Date)

The date the most recently purchased membership type starts

expiration_date
string (Expiration Date)

The date the membership expires

renewal_date
string (Renewal Date)

The date the member last renewed

reinstatement_date
string (Reinstatement Date)

The date the member was last reinstated

termination_date
string (Termination Date)

The date the member was terminated

lapse_date
string (Lapse Date)

The last date that this record was terminated. Unlike termination date does not get erased

origin
string (Origin)
Enum: "principal" "flowdown" "assigned"
parent_membership_id
required
string (Parent Membership) /organization:.*/

The parent organization

order_id
string (Order)

The order

order_line_item_id
string (Order Line Item)

The order line item

order_number
number <float> (Order Number)

The order number

order_balance_due
number <double> (Order Balance Due)

The balance due on the order

order_amount_paid
number <double> (Order Amount Paid)

The amount paid

order_currency_code
string (Order Currency Code)
order_currency_symbol
string (Order Currency Symbol)
order_status
string (Order Status)
Enum: "awaiting payment" "awaiting shipping" "awaiting pickup" "partially shipped" "shipped" "completed" "cancelled" "disputed" "open" "returned" "void"
order_total
number <double> (Order Total)

The total of the order

hidden_directory_fields
Array of strings (Hidden Directory Fields)

The fields that should not be shown for this member in the directory

flowdown_depth
required
number <float> (Flowdown Depth) [ 1 .. 10 ]

If this is a flow down membership, the depth

overridden_fields
Array of strings (Overridden Fields)

Fields that have been changed on this record, and should not be susceptible to flowdown

Array of objects

Memberships that have been assigned, manually, by organization administrators

renew_automatically
boolean (Renew Automatically)

If set, then this membership will automatically renew with the card on file

required
object (Renewal Payment Info)

The renewal payment info

renewal_payment_card_expiration
string <date> (Renewal Payment Card Expiration)

The date that the renewal payment card expires

billed
boolean (Billed)

Flag indicated whether the membership has been billed

last_bill_date
string <date-time> (Last Bill Date)

The last time this order was billed

bill_method
string (Bill Method)

The method this member was billed

Enum: "renewal order" "auto renewal order" "renewal notice"
last_reminder
number <float> (Last Reminder)

The last reminder number

last_reminder_date
string <date-time> (Last Reminder Date)

The last time a reminder was sent

last_expired_card_warning
number <float> (Last Expired Card Warning)

The last expired card warning

last_expired_card_warning_date
string <date-time> (Last Expired Card Warning Date)

The last time a reminder was sent

bill_organization
boolean (Bill Organization)

Whether or not to bill the organization for this membership

primary_chapter_id
string (Primary Chapter)

The chapter ID (used for reporting, DO NOT UPLOAD DATA HERE

chapter_ids
Array of strings (Chapter IDs)

used for reporting, DO NOT UPLOAD DATA HERE

section_ids
Array of strings (Section IDs)

used for reporting, DO NOT UPLOAD DATA HERE

add_on_ids
Array of strings (Add Ons)

used for reporting, DO NOT UPLOAD DATA HERE

Array of objects
Array of objects
Array of objects
chapter_names
string (Chapter Names)

Read only: Show the name of the chapters to which a person belongs

section_names
string (Section Names)

Read only: Show the name of the sections to which a person belongs

add_on_names
string (Add On Names)

Read only: Show the name of the add ons to this membership

Array of objects
Array of objects
Array of objects

The history of membership events & activities

do_not_renew
boolean (Do Not Renew)

If so, this membership will not renew

do_not_drop
boolean (Do Not Drop)

If set, this membership will not be dropped/terminated along lifecycle rules

do_not_show_in_directory
boolean (Do Not Show In Directory)

If set, the membership is not available in the directory

date_last_updated_in_portal
string <date-time> (Date Last Updated In Portal)

The date that this was last updated in the portal

last_change_affiliation_date
string <date-time> (Last Change Affiliation Date)

The last date a change affiliation was run on this membership

referral_contact_id
string (Referral Contact)

The individual who referred this member

certificate_uri
string (Certificate Uri)

A link to an externally created certificate of membership

notes
string (Notes)
Array of objects (Custom Field Values)
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 membership was saved successfully.
400The membership you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The membership could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add membership based on tenant limits.
500General server error.
post/memberships/{tenantId}
Request samples
    1 more
    Python
application/json
{
  • "id": "string",
  • "number": 0,
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_id": "string",
  • "customer_id": "string",
  • "directory_image_uri": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "master_membership_id": "string",
  • "master_membership_organization_id": "string",
  • "application_process_id": "string",
  • "application_id": "string",
  • "membership_join_date": "string",
  • "is_new": true,
  • "date_status": "updated",
  • "status": "active",
  • "status_reason_id": "string",
  • "type_id": "string",
  • "package_id": "string",
  • "join_date": "string",
  • "join_or_last_renewal_date": "string",
  • "term_start_date": "string",
  • "expiration_date": "string",
  • "renewal_date": "string",
  • "reinstatement_date": "string",
  • "termination_date": "string",
  • "lapse_date": "string",
  • "origin": "principal",
  • "parent_membership_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "order_number": 0,
  • "order_balance_due": 0,
  • "order_amount_paid": 0,
  • "order_currency_code": "string",
  • "order_currency_symbol": "string",
  • "order_status": "awaiting payment",
  • "order_total": 0,
  • "hidden_directory_fields": [
    ],
  • "flowdown_depth": 1,
  • "overridden_fields": [
    ],
  • "assigned_memberships": [
    ],
  • "renew_automatically": true,
  • "renewal_payment_info": {
    },
  • "renewal_payment_card_expiration": "2019-08-24",
  • "billed": true,
  • "last_bill_date": "2019-08-24T14:15:22Z",
  • "bill_method": "renewal order",
  • "last_reminder": 0,
  • "last_reminder_date": "2019-08-24T14:15:22Z",
  • "last_expired_card_warning": 0,
  • "last_expired_card_warning_date": "2019-08-24T14:15:22Z",
  • "bill_organization": true,
  • "primary_chapter_id": "string",
  • "chapter_ids": [
    ],
  • "section_ids": [
    ],
  • "add_on_ids": [
    ],
  • "chapters": [
    ],
  • "sections": [
    ],
  • "add_ons": [
    ],
  • "chapter_names": "string",
  • "section_names": "string",
  • "add_on_names": "string",
  • "past_chapter_memberships": [
    ],
  • "past_section_memberships": [
    ],
  • "history": [
    ],
  • "do_not_renew": true,
  • "do_not_drop": true,
  • "do_not_show_in_directory": true,
  • "date_last_updated_in_portal": "2019-08-24T14:15:22Z",
  • "last_change_affiliation_date": "2019-08-24T14:15:22Z",
  • "referral_contact_id": "string",
  • "certificate_uri": "string",
  • "notes": "string",
  • "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": [
    ]
}
Response samples
application/json
{
  • "id": "string",
  • "number": 0,
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_id": "string",
  • "customer_id": "string",
  • "directory_image_uri": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "name": "string",
  • "email_address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string",
  • "job_title": "string",
  • "master_membership_id": "string",
  • "master_membership_organization_id": "string",
  • "application_process_id": "string",
  • "application_id": "string",
  • "membership_join_date": "string",
  • "is_new": true,
  • "date_status": "updated",
  • "status": "active",
  • "status_reason_id": "string",
  • "type_id": "string",
  • "package_id": "string",
  • "join_date": "string",
  • "join_or_last_renewal_date": "string",
  • "term_start_date": "string",
  • "expiration_date": "string",
  • "renewal_date": "string",
  • "reinstatement_date": "string",
  • "termination_date": "string",
  • "lapse_date": "string",
  • "origin": "principal",
  • "parent_membership_id": "string",
  • "order_id": "string",
  • "order_line_item_id": "string",
  • "order_number": 0,
  • "order_balance_due": 0,
  • "order_amount_paid": 0,
  • "order_currency_code": "string",
  • "order_currency_symbol": "string",
  • "order_status": "awaiting payment",
  • "order_total": 0,
  • "hidden_directory_fields": [
    ],
  • "flowdown_depth": 1,
  • "overridden_fields": [
    ],
  • "assigned_memberships": [
    ],
  • "renew_automatically": true,
  • "renewal_payment_info": {
    },
  • "renewal_payment_card_expiration": "2019-08-24",
  • "billed": true,
  • "last_bill_date": "2019-08-24T14:15:22Z",
  • "bill_method": "renewal order",
  • "last_reminder": 0,
  • "last_reminder_date": "2019-08-24T14:15:22Z",
  • "last_expired_card_warning": 0,
  • "last_expired_card_warning_date": "2019-08-24T14:15:22Z",
  • "bill_organization": true,
  • "primary_chapter_id": "string",
  • "chapter_ids": [
    ],
  • "section_ids": [
    ],
  • "add_on_ids": [
    ],
  • "chapters": [
    ],
  • "sections": [
    ],
  • "add_ons": [
    ],
  • "chapter_names": "string",
  • "section_names": "string",
  • "add_on_names": "string",
  • "past_chapter_memberships": [
    ],
  • "past_section_memberships": [
    ],
  • "history": [
    ],
  • "do_not_renew": true,
  • "do_not_drop": true,
  • "do_not_show_in_directory": true,
  • "date_last_updated_in_portal": "2019-08-24T14:15:22Z",
  • "last_change_affiliation_date": "2019-08-24T14:15:22Z",
  • "referral_contact_id": "string",
  • "certificate_uri": "string",
  • "notes": "string",
  • "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": [
    ]
}