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
GETPUTPOSTDELETEGETPUTPOSTDELETE
accountId
StringUnique identifier of your account



YesYesYes
memberType

Enum

  • Individual
  • Team
Determines a team or individual member type
YesYes
YesYesYes
name
StringThe display name that is used on leader boards and public displays
OptionalOptional
YesYesYes
memberRefId
StringThe reference to this member in your system
YesYes
YesYesYes
picture
StringAn icon or a picture representing a member
OptionalOptional
YesYesYes
groups
Array [String]A list of Strings of groups that the member belongs to. It could be marketing segments or social friend groups
OptionalOptional
YesYesYes
metadata
Array [Object]A list of MetaData
OptionalOptional
YesYesYes
created
DateTimeISO8601 timestamp for when a Member was created. All records are stored in UTC time zone.



YesYes
Yes
id
StringUnique identifier in CompetitionLabs system for a Member



YesYesYes