List Memberships
GET /v2/b2b/memberships
Inputs:
- updatedStartTime: (optional) only return memberships updated after this start time.
- updatedEndTime: (optional) only return memberships updated before this time.
- program: (optional) only return memberships of this program type.
- category: (optional) only return memberships of this category.
- subCategory: (optional) only return memberships of this sub category.
- updatedBy: (optional) only return memberships updated by this userId.
Returns:
A list of Membership Objects
Get Membership
GET /v2/b2b/memberships/{id}
Returns:
The Membership object with the specified membership id.
Update a Membership
PUT /v1/b2b/memberships
Body:
The updated Membership object, must contain the importId of the object being updated. This will update only the cardholder / demographic information. To delete a cardholder, set the cardStatus to "dropped"
Returns:
The updated Membership object.
Membership Object
Field | Description |
---|---|
id | A unique ID for this membership. Read Only |
program | The program for this membership. |
category | Name of the membership (e.g. Individual, Dual, Family) |
subcategory | A sub category for this membership. |
level | A numeric level for this category |
importId | A unique value that does not change. |
fund | The specific financial purposes of gifts. Read Only |
campaign | The overall objective to raise money. Read Only |
appeal | The solicitations and promotions that bring in gifts. Read Only |
externalMembershipId | The id of the membership in an external data source, typically the CRM system |
membershipJoinedDate | The date of the membership acquisition |
membershipStartDate | The date the current membership term began. |
membershipExpirationDate | The date the current membership term will expire. |
membershipStanding | The standing of the membership (active, lapsed) |
membershipCategory | Membership Level Name |
categoryId | Membership Level Id |
externalId | ID from external source (such as the CRM system) |
membershipTypeId | A linking back to our membership_types table with the type of membership. |
cardholders | The list of cardholders for this membership. |
cardholders[x].id | Membership Card Holder ID |
cardholders[x].visitorId | n/a - ACME internal only field - do not use |
cardholders[x].membershipId | Maps to id from the membership table. |
cardholders[x].externalCustomerId | Customer ID from external source (e.g. CRM system) |
cardholders[x].externalContactId | Contact ID from external source (e.g. CRM system) |
cardholders[x].constituentId | |
cardholders[x].acmeCustomerNumber | |
cardholders[x].constituentImportId | The import id for the constituent. |
cardholders[x].cardImportId | The import id for this card. |
cardholders[x].cardType | The type of card holder, one of (primary or other) |
cardholders[x].name | The name on the card. |
cardholders[x].barcode | The value on the barcode. |
cardholders[x].acmeBarcode | ACME's barcode for the cardholder |
cardholders[x].email | The member's email address. |
cardholders[x].prefix | The prefix for the name. e.g. Mr. or Mrs. |
cardholders[x].suffix | The suffix for the name. e.g. Jr. |
cardholders[x].firstName | The member's first name. |
cardholders[x].lastName | The member's last name. |
cardholders[x].orgName | the name of the organization when this membership is an organization membership. |
cardholders[x].phoneNumber | The member's phone number. |
cardholders[x].phoneNotes | |
cardholders[x].streetAddress1 | The member's street address. |
cardholders[x].streetAddress2 | The member's extended street address. |
cardholders[x].city | The member's city. |
cardholders[x].state | The member's state. |
cardholders[x].zipCode | The member's zipCode. |
cardholders[x].country | The country that the member lives in. |
cardholders[x].orgName | Organization Name |
cardholders[x].orgId | Organization ID |
cardholders[x].addressId | |
cardholders[x].deceased | Boolean value to denote deceased |
cardholders[x].suburb | |
cardholders[x].primaryCard | Boolean value to denote the card is the primary |
cardholders[x].solicitationCodes | List of Solicitation messages for the members |
cardholders[x].details | |
cardholders[x].details[y].admits | |
cardholders[x].details[y].filmPlusExpirationDate | |
cardholders[x].details[y].filmPlusStatus | |
cardholders[x].details[y].juniorAssociateCategory | |
cardholders[x].details[y].juniorAssociateExpirationDate | |
cardholders[x].details[y].juniorAssociateStatus | |
cardholders[x].details[y].ps1PlusStatus | |
cardholders[x].details[y].ps1ExpirationDate | |
cardholders[x].cardHolderAttributes | |
cardholders[x].cardHolderAttributes[y].membershipId | Membership ID |
cardholders[x].cardHolderAttributes[y].cardHolderId | Membership Card Holder ID |
cardholders[x].cardHolderAttributes[y].category | Membership Category |
cardholders[x].cardHolderAttributes[y].description | |
cardholders[x].cardHolderAttributes[y].notes | |
cardholders[x].cardHolderAttributes[y].date | Membership Joined Date |
cardholders[x].startDate | Membership start date |
cardholders[x].expirationDate | Membership expiration date |
cardholders[x].cardStatus | Limit events to those that support the specified card status. Valid card status are:
|
cardholders[x].printCount | Total Membership card printed |
cardholders[x].printStatus | Limit events to those that support the specified print status. Valid print status are:
|
cardholders[x].orgImportId | organization ID from import |
cardholders[x].middleName | cardholder's middle name |
cardholders[x].acmeCustomerNumber | Unique ACME customer number |
cardholders[x].excludeCardOnMemberCreation | boolean value to exclude card while member creation |
cardholders[x].customerId | |
entitlements | List of entitlements. Fields is only populated if entitlements were imported with the membership |
entitlements[x].id | Unique ID for this entitlement. (READ ONLY) |
entitlements[x].benefit | The name of the benefit. |
entitlements[x].memberId | Membership ID |
entitlements[x].visitorId | n/a. ACME internal only field - do not use |
entitlements[x].count | The number of these benefits the member has. |
entitlements[x].importId | The import id for this entitlement. |
entitlements[x].comment | A comment about the benefit. |
offeringId | Membership Offering ID |
pricePointId | Price Point ID for the membership purchase |
organizationId | Organization Id |
orgImportId | |
organizationName | Organization Name |
isGift | boolean to denote the membership purchase is a gift |
auxiliaryMembership | boolean to denote auxiliary membership |
membershipLevelCollectionId | Membership Level Group ID |
membershipLevelCollectionName | Membership Level Group Name |
offeringName | Membership Offering ID |
updatedOn | Updated on date |
updatedBy | User id that last updated the record, matching the users the tenant has. Will show the ACME system user (340) in the case the operation was done by ACME (ie - changing the standing from active to lapsed) |
Sample JSON
Sample JSON
{ "id" : 746356, "importId" : "ACMEACS314670906" , "program" : "golden2_program" , "category" : "golden2_category" , "subcategory" : "golden2_subcategory" , "membershipTypeId" : 616, "externalMembershipId" : "ACS314670906" , "membershipJoinedDate" : "2016-12-23T00:00:00-08:00" , "membershipStartDate" : "2017-06-23T00:00:00-07:00" , "membershipExpirationDate" : "2019-06-22T23:59:59-07:00" , "membershipStanding" : "active" , "cardholders" : [ { "id" : 1146954, "membershipId" : 746356, "constituentImportId" : "ACMEACS269150004" , "constituentId" : "ACS269150004" , "cardImportId" : "ACMEACS369056059" , "cardType" : "primary" , "name" : "Vanor Zhang" , "barcode" : "ACS369056059" , "acmeBarcode" : "ACS369056059" , "firstName" : "Vanor" , "lastName" : "Zhang" , "prefix" : "" , "phoneNumber" : "" , "streetAddress1" : "46380 Sentinel" , "streetAddress2" : "" , "city" : "Fremont" , "state" : "Arizona" , "zipCode" : "95678" , "country" : "United States" , "deceased" : "no" , "primaryCard" : "yes" , "solicitationCodes" : "" , "startDate" : "2017-06-23T00:00:00-07:00" , "expirationDate" : "2019-06-22T23:59:59-07:00" , "cardStatus" : "active" , "printCount" : 0, "printStatus" : "notPrinted" , "middleName" : "" , "acmeCustomerNumber" : "ACS269150004" }, { "id" : 1146955, "membershipId" : 746356, "cardImportId" : "ACMEACS374959567" , "cardType" : "secondary" , "name" : "Guest of Vanor Zhang" , "barcode" : "ACS374959567" , "acmeBarcode" : "ACS374959567" , "deceased" : "no" , "primaryCard" : "no" , "solicitationCodes" : "" , "startDate" : "2017-06-23T00:00:00-07:00" , "expirationDate" : "2019-06-22T23:59:59-07:00" , "cardStatus" : "active" , "printCount" : 0, "printStatus" : "notPrinted" } ], "entitlements" : [ ], "membershipCategory" : "Golden Membership Test" , "categoryId" : "584f7aa179e71d507664059c" , "acmeMembershipNumber" : "ACS314670906" , "isGift" : false , "auxiliaryMembership" : false , "offeringName" : "Two Year Membership" , "offeringId" : "069e1a4051aa45ebb53e3705455cb31b" , "pricePointId" : "58123480969c6d59d976b8fa",
} |