Membership

A user, which is a customer profile with customer-specific data, is not able to collect loyalty points by itself, since the loyalty system collects points on accounts only. A membership can link a customer profile to an account, enabling the user to collect points for his connected accountId. One account may have N user connected with N memberships (always connect 1 user per membership). In practise, the most common situation is the connection 1 account : 1 membership : 1 user on which we will mainly focus in the following.

Note that the membership is the object which contains optin-information as optins are typically set / activated when a registration is completed (= user connected with account).

Creating Memberships

A new membership for given accountId can be created to connect a user with an account.

curl --location --request POST '{{api_url}}/accounts/{{accountId}}/memberships' \
--header 'Authorization: {{jwt_token}}' \
--header 'interaction-id: {{interactionId}}' \
--header 'Content-Type: application/json' \
--data-raw '{{body}}'

with variables

The body may look like this:

{
"memberRole": "OWNER",
"optins": [
{
"flag": true,
"type": "Post"
},
{
"flag": true,
"type": "Newsletter"
}
],
"partnerId": "550e8400-e29b-11d4-a716-446655440000",
"userId": "d22917e4-e764-4f12-8969-b834673f3acd"
}

with

The response will be similar to previous Creation-Requests, where the crucial information can be obtained from the Location row of the response header array.

The composition is:

Where {{accountId}} and {{membershipId}} are the values of given account and account-membership, respectively.

Getting Memberships of an Account

All memberships (and optins) of given account can be retrieved with the account identification:

curl --location --request GET '{{api_url}}/accounts/{{accountId}}/memberships' \
--header 'Authorization: {{jwt_token}}' \
--header 'interaction-id: {{interactionId}}' \
--header 'id-type: {{idType}}' \
--header 'Content-Type: application/json' \

with variables

Note again, that you can use the identifier code directly (e.g. {{idType}}=CARDCODE, {{accountId}}=V1W2X3Y4Z5) at this point.

The returned object looks like this:

[
{
"accountId": "550e8400-e29b-11d4-a716-446655440000",
"memberRole": "OWNER",
"membershipId": "550e8400-e29b-11d4-a716-446655440000",
"optins": [
{
"flag": true,
"type": "email"
}
],
"partnerId": "550e8400-e29b-11d4-a716-446655440000",
"userId": "550e8400-e29b-11d4-a716-446655440000"
}
]

where

If no membership is returned, the returned array is empty []. Depending on the specific program setup, these users may not be allowed to do anything if there are not registered. This logic has to be adopted here if that’s the case.

Getting a specific Membership of an Account

To investigate a specific membership of given accountId closer, all enlisted information can be obtained at once by using:

curl --location --request GET '{{api_url}}/accounts/{{accountId}}/memberships/{{membershipId}}' \
--header 'Authorization: {{jwt_token}}' \
--header 'interaction-id: {{interactionId}}' \
--header 'id-type: {{idType}}' \
--header 'Content-Type: application/json' \

with

The response object looks like this:

{
"membershipId": "4670c014-45b4-4d3b-bafd-b4bd13b5d659",
"accountId": "fd313081-11ae-4e50-b429-5c1cc0bfb357",
"userId": "24632823-71ca-47d3-8e20-6f9c7d727ef5",
"memberRole": "OWNER",
"partnerId": null,
"terminated": null,
"createdAt": null,
"optins": [
{
"flag": true,
"type": "email"
}
]
}

where

Update Membership Optins

The optins for a specific membership of given accountId can be updated by reassining them in the following request:

curl --location --request PATCH '{{api_url}}/accounts/{{accountId}}/memberships/{{membershipId}}' \
--header 'Authorization: {{jwt_token}}' \
--header 'interaction-id: {{interactionId}}' \
--header 'id-type: {{idType}}' \
--header 'Content-Type: application/json' \
--data-raw '{{body}}'

with

The body may look like this:

[
{
"flag": true,
"type": "email"
}
]

where each updated optin must be paired with a true-false-flag.

Note: body musst contain all optins, even if they remain unchanged. Any optin not specified in body will be deleted.