Description:

Update Member details in the CompetitionLabs database for a given Member identifier.

The Member that needs to be updated its Id has to exist in the Resource URL and Request body field.

Member Ref Id can not be changed after creation

Any Put body Parameters that are excluded in the Request body field will be considered as empty and updated with an empty field

Resource URL:

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

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
id
StringYesMember identifier retrieved from GET Members resource

Put 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
id
StringYesMember identifier retrieved from GET Members resource

EXAMPLE

Request
curl
--header "X-API-KEY: <your-api-key>"
--header "Content-Type: application/json"
--request PUT https://app.competitionlabs.com/api/<your-space-name>/members/AVXZfM4OHz_hNiERp3x5
-d '{ "memberType": "Individual", "name": "test", "memberRefId": "test", "groups": [ "CL" ], "id": "NcBhYm0BVUycDcfqXxZJ" }'
Response
{
    "data": {
        "jsonClass": "Member",
        "accountId": "0sn4DmUBkPH_lz9GgxBM",
        "memberType": "Individual",
        "name": "test",
        "memberRefId": "test",
        "groups": [
            "CL"
        ],
        "timeZoneOffset": 0.0,
        "created": "2019-09-24T08:26:51.594+0000",
        "id": "NcBhYm0BVUycDcfqXxZJ"
    }
}

ERROR CODES

CodeHTTP StatusDescriptionExample
1001400

Member Type parameter was excluded, empty or incorrect;

Error Response 400
{
    "errors": [
        {
            "message": "Malformed JSON body.",
            "code": 1001,
            "status": 400
        }
    ]
}
1009500Member Ref Id parameter was excluded;
Error Response 500
{
    "errors": [
        {
            "message": "None.get | MemberValidators.scala: 109",
            "code": 1009,
            "status": 500
        }
    ]
}
1003406Member Ref Id parameter was empty;
Error Response 406
{
    "errors": [
        {
            "message": "Members Reference Id cannot be empty",
            "code": 1003,
            "status": 406
        }
    ]
}

503Id parameter was excluded or empty;
Error Response 503
{
    "status": 503
}