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
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 |
id | String | Yes | Member identifier retrieved from GET Members resource |
Put body parameters
Parameter | Type | Required | Description |
---|---|---|---|
memberType | Enum | Yes | Type of member, accepted values: Individual, Team |
name | String | Optional | Display name of the member you want to create |
memberRefId | String | Yes | Member id on customer system |
groups | Array [String] | Optional | Group to which a member might belong |
metadata | Array [Object] | Optional | A list of MetaData |
id | String | Yes | Member identifier retrieved from GET Members resource |
EXAMPLE
ERROR CODES
Code | HTTP Status | Description | Example |
---|---|---|---|
1001 | 400 |
| |
1009 | 500 | Member Ref Id parameter was excluded; | |
1003 | 406 | Member Ref Id parameter was empty; | |
503 | Id parameter was excluded or empty; |