Member or player depending on your terminology is the unique entity that scoring events are grouped by. A member must exist in the system to be included in competitions, contests and achievements.
CompetitionLabs Members resource allows you to perform member level operations.
What can you do?
Available Resources
- Get a list of Members;
- Find a specific Member by passing various query parameters. This functionality is useful in order to check if a Member has been created in CompetitionLabs system before you are submitting events for a Member;
- Edit Member information;
- Create a Member;
- Delete a Member;
- Preview a sample Member;
- Preview the Member Types.
Domain Object
Member
Parameter | Type | Description | Request | Response | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
GET | PUT | POST | DELETE | GET | PUT | POST | DELETE | |||||
accountId | String | Unique identifier of your account | Yes | Yes | Yes | |||||||
memberType | Enum
| Determines a team or individual member type | Yes | Yes | Yes | Yes | Yes | |||||
name | String | The display name that is used on leader boards and public displays | Optional | Optional | Yes | Yes | Yes | |||||
memberRefId | String | The reference to this member in your system | Yes | Yes | Yes | Yes | Yes | |||||
picture | String | An icon or a picture representing a member | Optional | Optional | Yes | Yes | Yes | |||||
groups | Array [String] | A list of Strings of groups that the member belongs to. It could be marketing segments or social friend groups | Optional | Optional | Yes | Yes | Yes | |||||
metadata | Array [Object] | A list of MetaData | Optional | Optional | Yes | Yes | Yes | |||||
created | DateTime | ISO8601 timestamp for when a Member was created. All records are stored in UTC time zone. | Yes | Yes | Yes | |||||||
id | String | Unique identifier in CompetitionLabs system for a Member | Yes | Yes | Yes |