Claim Member Award by Reference ID POST api/v1/:space/members/reference/:memberRefId/award/:awardId/award

Description:

Claims an Award for a given Member Reference ID. This is only applicable when an award needs to be claimed.

Request Headers

KeyValueRequired
X-API-KEY
Your unique API key

Yes

Request URL Parameters

ParameterTypeRequiredDescription
space
StringYesThis is the space name linked to the account
memberRefId
StringYesMember reference ID. You can only retrieve members with member ref Id's from APP API GET Members
awardId
StringYes
Award reference ID. You can retrieve an award ref id using GET Messages public API endpoint and querying the prize.

EXAMPLE GET /api/v1/:space/members/:memberId/messages?prize.memberId=:memberId

POST Body Parameters

empty post body - no body required

CodeHTTP StatusDescriptionExample
1007404
  • The X-API-KEY is incorrect
  • Incorrect space name
  • Incorrect award Id
  • Incorrect member ref Id
1019404Member ref Id does not exist
7002400Award already claimed
7003403
Award has expired

404The Request URL is incorrect

401The X-API-KEY is missing