Applications

Applications

Returns a application from the system by its ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the application 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 application was retrieved successfully.
400The request was not valid.
401Unauthorized.
403Forbidden.
404The application could not be found.
429Limit exceeded... unable to retrieve application based on tenant limits.
500General server error.
get/applications/{tenantId}/{id}
Request samples
curl -i -X GET \
  'https://membership.api.rhythmsoftware.com/applications/:tenantId/:id?fields=string&consistentRead=string' \
  -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",
  • "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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

Updates a application with the specified ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the application to update.

Request Body schema: application/json

The updated application that will be saved.

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

The unique, string identifier of this application

type
required
string (Type)
Enum: "join" "renewal" "reinstatement" "change affiliations"
process_id
required
string (Process)

The application process used

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

renew_automatically
boolean (Renew Automatically)

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

name
required
string (Name)

The name on the application

date
string <date-time> (Date)

The date of the application

order_id
string (Order)

The order id

order_line_item_id
string (Order Line Item)

The order line item id

status
required
string (Status)

The membership application status

Enum: "not yet submitted" "under review" "approved" "rejected"
status_reason_id
string (Status Reason)

The reason that a membership application is in the specific status

Array of objects
membership_package_id
string (Membership Package)

The membership package

membership_type_id
string (Membership Type)

The membership type

chapter_id
string (Chapter)

The chapter ID

additional_chapter_ids
Array of strings (Additional Chapters)

Additional chapter IDs

section_ids
Array of strings (Sections)
Array of objects
corporate_member_ids
Array of strings (Corporate Members)

The individuals that should receive the corporate membership

referral_contact_id
string (Referral Contact)

The individual who referred this member

do_not_show_in_directory
boolean (Do Not Show In Directory)

Whether or not this membership should be hidden from the directory

do_not_renew
boolean (Do Not Renew)

Do not attempt to automatically renew this membership

notes
string (Notes)

Notes

hidden_directory_fields
Array of strings (Hidden Directory Fields)

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

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_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

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_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

Responses
200The application was updated successfully.
400The application supplied was not valid.
401Unauthorized.
403Forbidden.
404The application could not be found.
409The application could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve application based on tenant limits.
500General server error.
put/applications/{tenantId}/{id}
Request samples
application/json
{
  • "id": "string",
  • "type": "join",
  • "process_id": "string",
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}
Response samples
application/json
{
  • "id": "string",
  • "type": "join",
  • "process_id": "string",
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

Partially updates a application with the specified ID.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the application 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 application was patched successfully.
400The JSON patch directive you supplied was not valid.
401Unauthorized.
403Forbidden.
404The application could not be found.
409The application could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to retrieve application based on tenant limits.
500General server error.
patch/applications/{tenantId}/{id}
Request samples
application/json
[
  • {
    }
]
Response samples
application/json
{
  • "id": "string",
  • "type": "join",
  • "process_id": "string",
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

Returns a application from the system by its ID.

This method will delete a application with the specified ID.

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

id
required
string

The ID of the application to delete.

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

Generates an order from a membership application

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

Request Body schema: application/json

The application to generate an order

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

The unique, string identifier of this application

type
required
string (Type)
Enum: "join" "renewal" "reinstatement" "change affiliations"
process_id
required
string (Process)

The application process used

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

renew_automatically
boolean (Renew Automatically)

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

name
required
string (Name)

The name on the application

date
string <date-time> (Date)

The date of the application

order_id
string (Order)

The order id

order_line_item_id
string (Order Line Item)

The order line item id

status
required
string (Status)

The membership application status

Enum: "not yet submitted" "under review" "approved" "rejected"
status_reason_id
string (Status Reason)

The reason that a membership application is in the specific status

Array of objects
membership_package_id
string (Membership Package)

The membership package

membership_type_id
string (Membership Type)

The membership type

chapter_id
string (Chapter)

The chapter ID

additional_chapter_ids
Array of strings (Additional Chapters)

Additional chapter IDs

section_ids
Array of strings (Sections)
Array of objects
corporate_member_ids
Array of strings (Corporate Members)

The individuals that should receive the corporate membership

referral_contact_id
string (Referral Contact)

The individual who referred this member

do_not_show_in_directory
boolean (Do Not Show In Directory)

Whether or not this membership should be hidden from the directory

do_not_renew
boolean (Do Not Renew)

Do not attempt to automatically renew this membership

notes
string (Notes)

Notes

hidden_directory_fields
Array of strings (Hidden Directory Fields)

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

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_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

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_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

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/applications/{tenantId}/generateOrder
Request samples
application/json
{
  • "id": "string",
  • "type": "join",
  • "process_id": "string",
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}
Response samples
application/json
{ }

Generates an application for a contact or organization

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed

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/applications/{tenantId}/generateApplication/{processId}/{ownerType}/{id}
Request samples
curl -i -X POST \
  https://membership.api.rhythmsoftware.com/applications/:tenantId/generateApplication/: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",
  • "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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}

Searches for applications using predefined parameters

Searches for applications using predefined parameters

Request
Security:
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 application that you would like to be saved.

id
Array of strings (ID)

IDs to search

owner_type
string (Owner Type)
name
string (Name)
status
Array of strings (Status)
status_reason_id
Array of strings (Status Reason)
type
Array of strings (Type)
membership_type_id
Array of strings (Membership Type)
membership_package_id
Array of strings (Membership Package)
date
Array of strings <date-time> (Date) 2 items
Responses
200The application search was saved successfully.
400The application you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The application could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add application based on tenant limits.
500General server error.
post/applications/{tenantId}/search
Request samples
application/json
{
  • "id": [
    ],
  • "owner_type": "string",
  • "name": "string",
  • "status": [
    ],
  • "status_reason_id": [
    ],
  • "type": [
    ],
  • "membership_type_id": [
    ],
  • "membership_package_id": [
    ],
  • "date": [
    ]
}
Response samples
application/json
{
  • "Items": [
    ],
  • "LastEvaluatedKey": "string"
}

Returns a list of records with the specified contact_id

Returns a list of records with the specified contact_id

Request
Security:
path Parameters
tenantId
required
string

The tenant

contact_id
required
string

The contact_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/applications/{tenantId}/contact/{contact_id}
Request samples
curl -i -X GET \
  'https://membership.api.rhythmsoftware.com/applications/:tenantId/contact/:contact_id?fields=string&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 organization_id

Returns a list of records with the specified organization_id

Request
Security:
path Parameters
tenantId
required
string

The tenant

organization_id
required
string

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

Creates a new application record that does not already exist.

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

Request
Security:
path Parameters
tenantId
required
string

The id of the tenant being accessed.

Request Body schema: application/json

The application that you would like to be saved.

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

The unique, string identifier of this application

type
required
string (Type)
Enum: "join" "renewal" "reinstatement" "change affiliations"
process_id
required
string (Process)

The application process used

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

renew_automatically
boolean (Renew Automatically)

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

name
required
string (Name)

The name on the application

date
string <date-time> (Date)

The date of the application

order_id
string (Order)

The order id

order_line_item_id
string (Order Line Item)

The order line item id

status
required
string (Status)

The membership application status

Enum: "not yet submitted" "under review" "approved" "rejected"
status_reason_id
string (Status Reason)

The reason that a membership application is in the specific status

Array of objects
membership_package_id
string (Membership Package)

The membership package

membership_type_id
string (Membership Type)

The membership type

chapter_id
string (Chapter)

The chapter ID

additional_chapter_ids
Array of strings (Additional Chapters)

Additional chapter IDs

section_ids
Array of strings (Sections)
Array of objects
corporate_member_ids
Array of strings (Corporate Members)

The individuals that should receive the corporate membership

referral_contact_id
string (Referral Contact)

The individual who referred this member

do_not_show_in_directory
boolean (Do Not Show In Directory)

Whether or not this membership should be hidden from the directory

do_not_renew
boolean (Do Not Renew)

Do not attempt to automatically renew this membership

notes
string (Notes)

Notes

hidden_directory_fields
Array of strings (Hidden Directory Fields)

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

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_directive
string (Sys Directive)

Means for passing directive information into an object processing logic

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_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

Responses
200The application was saved successfully.
400The application you supplied was invalid.
401Unauthorized.
403Forbidden.
404The resource could not be found
409The application could not be saved because it refers to/depends on a non-existent object.
429Limit exceeded... unable to add application based on tenant limits.
500General server error.
post/applications/{tenantId}
Request samples
application/json
{
  • "id": "string",
  • "type": "join",
  • "process_id": "string",
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}
Response samples
application/json
{
  • "id": "string",
  • "type": "join",
  • "process_id": "string",
  • "owner_type": "contact",
  • "contact_id": "string",
  • "organization_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_directive": "string",
  • "sys_snapshot_base_version": 0,
  • "sys_configuration_snapshot_id": "string",
  • "sys_last_security_context": { }
}