Members

A member is a person who has signed up to a loyalty program.

Member

Member refers to a person in a loyalty program. They may have identifiable information such as their name, age, gender and email address. They may be contactable via email and/or SMS.

member_id required	string (Member_id) The `member_id` is a unique identifier for a member across all members.
email	string (Email) A generic email address. We don't validate the email addresses before they are actively used in the system. When sending an email to the address, we get signals from the receiving part (fx gmail, apple, microsoft, etc.). Based on these signals we can determine if the email address is valid or not. If the email address is invalid, then it will be categorised as a `soft_bounce` or `hard_bounce`. Soft Bounces A `soft_bounce` is when the email address is temporarily unavailable. A `soft_bounce` can become a `hard_bounce` if the email address is tried multiple times but is `soft_bounced` every time. Hard Bounces A `hard_bounce` is when the email address is permanently unavailable. If a `hard_bounce` is received, then the email address will be marked as invalid and will not be used in the system. This can be reversed by contacting Movio support.
phone_number	string (PhoneNumber) Is a phone number that can be used to contact a member. The phone number is in the international format. This is to ensure that the phone number can be used to contact the member from anywhere in the world.
first_name	string This is the first name of a Member. This can also be the Member's known or preferred name.
last_name	string This is the last name of a Member, also known as a Surname or Family Name.
date_of_birth	string <date> The date of birth of the member.
gender required	string This field is used to identify which gender a Member identifies with. Enum: "UNSPECIFIED" "FEMALE" "MALE"
status required	string The status of the member. Enum: "ISSUED" "ACTIVATED" "DELETED"
	Array of objects (LoyaltyCard) The loyalty cards that the member has.
issued_at	string <date-time> The UTC date and time that the member was issued.
	object (Preferences) The preferences of a member.

{"member_id": "member1",
"email": "john.doe@example.com",
"phone_number": "+64-09-319-7625",
"first_name": "John",
"last_name": "Doe",
"date_of_birth": "1980-01-01",
"gender": "UNSPECIFIED",
"status": "ISSUED",
"loyalty_cards": [{"number": "1234567890",
"status": "ACTIVE"
}
],
"issued_at": "2019-01-01T12:00:00Z",
"preferences": {"cinema_ids": ["northcitymultiplex01",
"northwestridgecinema"
],
"genres": ["Action",
"Adventure"
]
}
}

Create / Update Members

Creating or updating a member in the system. This will create the member in Movio if the member does not exist. If the member exists, then the member with the same member_id will be one to one replaced with the new member.

SecurityOAuth2

Request

Request Body schema: application/json
required

The members to be created.

Array ([ 1 .. 5000 ] items)

member_id required	string (Member_id) The `member_id` is a unique identifier for a member across all members.
email	string (Email) A generic email address. We don't validate the email addresses before they are actively used in the system. When sending an email to the address, we get signals from the receiving part (fx gmail, apple, microsoft, etc.). Based on these signals we can determine if the email address is valid or not. If the email address is invalid, then it will be categorised as a `soft_bounce` or `hard_bounce`. Soft Bounces A `soft_bounce` is when the email address is temporarily unavailable. A `soft_bounce` can become a `hard_bounce` if the email address is tried multiple times but is `soft_bounced` every time. Hard Bounces A `hard_bounce` is when the email address is permanently unavailable. If a `hard_bounce` is received, then the email address will be marked as invalid and will not be used in the system. This can be reversed by contacting Movio support.
phone_number	string (PhoneNumber) Is a phone number that can be used to contact a member. The phone number is in the international format. This is to ensure that the phone number can be used to contact the member from anywhere in the world.
first_name	string This is the first name of a Member. This can also be the Member's known or preferred name.
last_name	string This is the last name of a Member, also known as a Surname or Family Name.
date_of_birth	string <date> The date of birth of the member.
gender required	string This field is used to identify which gender a Member identifies with. Enum: "UNSPECIFIED" "FEMALE" "MALE"
status required	string The status of the member. Enum: "ISSUED" "ACTIVATED" "DELETED"
	Array of objects (LoyaltyCard) The loyalty cards that the member has.
issued_at	string <date-time> The UTC date and time that the member was issued.
	object (Preferences) The preferences of a member.

Responses

202

The response to a bulk request that succeeded.

400

The response to a bulk request that failed.

401

The request has not been applied because it lacks valid authentication credentials for the target resource.

422

The request was well-formed but was unable to be followed due to semantic errors.

put/members

Request samples

Payload

application/json

[{"member_id": "member1",
"email": "john.doe@example.com",
"phone_number": "+64-09-319-7625",
"first_name": "John",
"last_name": "Doe",
"date_of_birth": "1980-01-01",
"gender": "UNSPECIFIED",
"status": "ISSUED",
"loyalty_cards": [{"number": "1234567890",
"status": "ACTIVE"
}
],
"issued_at": "2019-01-01T12:00:00Z",
"preferences": {"cinema_ids": ["northcitymultiplex01",
"northwestridgecinema"
],
"genres": ["Action",
"Adventure"
]
}
}
]

Response samples

application/json

{"total": 3,
"created_count": 2,
"updated_count": 1
}

Delete Member

Deletes a member from the system. This effectively remove the member from Movio. Useful when a member have requested to be removed from the system. Movio will not be able to contact the member after the member has been deleted.

SecurityOAuth2

Request

path Parameters

member_id

required

string (Member_id)

The unique identifier for a member.

Example: member1

Responses

204

The member was deleted successfully.

400

The request could not be understood by the server due to malformed syntax.

401

The request has not been applied because it lacks valid authentication credentials for the target resource.

422

The request was well-formed but was unable to be followed due to semantic errors.

delete/members/{member_id}

Response samples

plain/text

The request could not be understood by the server due to
malformed syntax. The client should not repeat the request without
modifications.

➔ Next to Subscriptions