Description:
Retrieve a member or a list of members from CompetitionLabs database by unique member ID's or any other Post body parameters using the POST method.
Inserting a list of Id's or any other parameter must be comma ( , ) separated without any spaces
Resource URL:
https://<apphost>.competitionlabs.com/api/<your-space-name>/members/post
Request headers
Key | Value | Required |
---|---|---|
X-API-KEY | Your unique API key | Yes |
Content-Type | application/json | Yes |
Request URL parameters
Parameter | Type | Required | Description |
---|---|---|---|
space | String | Yes | This is the space name which is linked to the account |
Additional Query String Parameters
You can use the POST body parameters along with "_skip", "_limit" and "_sortByFields" generic parameters.
Post body parameters
Parameter | Type | Required | Description |
---|---|---|---|
memberType | Enum | Optional | Type of member, accepted values: Individual, Team |
name | String | Optional | Display name of the member you want to create |
memberRefId | String | Optional | Member id on customer system |
groups | Array [String] | Optional | Group to which a member might belong |
metadata | Array [Object] | Optional | A list of MetaData |
created | DateTime | Optional | ISO8601 timestamp for when a Member was created. All records are stored in UTC time zone. |
id | String | Optional | Member identifier retrieved from GET Members resource |
EXAMPLE
ERROR CODES
Code | HTTP Status | Description | Example |
---|---|---|---|
503 | An array was sent | ||
404 | The request URL was modified |