POST /redeemable-tokens/{tokenId}/redeem

Request

Resource URL

POST https://api.ft.com/redeemable-tokens/{tokenId}/redeem

For security reasons requests must be made over HTTPS.

Parameters

Not supported. Do not supply any query parameters.

Request Headers

HeaderValue
Content-Type
application/json
X-Api-Key <API key value>

Request Body

A userId for whom to redeem the token, example payload below:

{
“userId”: “67c3817e-3d50-4b59-a16d-333333333333”
}

Response

HTTP Status Codes

Http StatusDescription
200 OK The token was successfully redeemed
400 Bad request The request was invalid. You may refer to response for details around why the request was invalid
403 Forbidden Invalid API key
409 Status Conflict The token’s status did not allow it to be redeemed.

200 Created - The token was successfully redeemed

If successful, this method returns a Redeemable Token Resource

400 Bad request - The request was invalid 

An Error Response with the following format.

{
“code”: 400, “message”: “Unable to process JSON” }

403 Forbidden - Your access to the API endpoint was denied

Make sure you are using a valid API key. If you are sure your are using a valid API key, email FT Membership Platform Team for assistance.

409 Status Conflict

An error response with the following format:

{
  “errorMesaage”: “Cannot redeemed due to current status, REDEEMED”
}