Description:

Upload a new set of members to the CompetitionLabs database.

We expect a POST request to be in the form of an array. An array can contain a maximum of 10,000 members in one request.

Resource URL:

https://<apphost>.competitionlabs.com/api/<your-space-name>/members

Request headers

KeyValueRequired
X-API-KEY
Your unique API keyYes
Content-Type
application/jsonYes

Request URL parameters

Parameter
Type
Required
Description
space
StringYesThis is the space name which is linked to the account

Post body parameters

Parameter
Type
Required
Description
memberType
EnumYesType of member, accepted values: Individual, Team
name
StringOptionalDisplay name of the member you want to create
memberRefId
StringYesMember id on customer system
groups
Array [String]OptionalGroup to which a member might belong
metadata
Array [Object]OptionalA list of MetaData
accountId
StringYesYour space id

EXAMPLE

Request 
curl
--header "X-API-KEY: <your-api-key>"
--header "Content-Type: application/json"
--request POST https://app.competitionlabs.com/api/<your-space-name>/members
-d '[{ "memberType": "Individual", "name": "test", "memberRefId": "test", "groups": [ "CL" ], "accountId": "4s9nuekp1y880upwy6s2p"}]'
Response 
Response Header:
Status: 200 OK


ERROR CODES

CodeHTTP StatusDescriptionExample

503Member Ref Id parameter was excluded;
Error Response 503 
{
    "status": 503
}
1001400

  • Name parameter was excluded;

  • Member Type parameter was excluded;

  • Member Type parameter was empty;

  • Member Type parameter was an incorrect Enum;

  • Member Ref Id parameter was empty;

Error Response 400 
{
    "message": "Malformed JSON body.",
    "status": 400,
    "code": 1001
}
1021409
Duplicate record found
Error Response 409 
{
    "errors": [
        {
            "message": "Duplicate record found.",
            "code": 1021,
            "status": 409
        }
    ]
}
1006406Member with reference Id can not contain empty spaces
Error Response 406 
{
    "errors": [
        {
            "message": "Multiple members creation failed with errors.",
            "code": 1006,
            "status": 406,
            "children": [
                {
                    "message": "Members Reference Id cannot contain empty spaces",
                    "code": 1003,
                    "status": 406
                }
            ]
        }
    ]
}
1003