User Consents

These endpoints are required to support the core integration of Fast Track. We require one endpoint to fetch consent statuses, and another endpoint where Fast Track can update the consent.

⬇️ 1. GET /userconsents/:userid

The Operator needs to provide Fast Track with the User Consents endpoint to fetch user consent data. Fast Track CRM will do lookups against this endpoint when certain events are received, for example Registration, User Consent or when migrating user data through Fast Track migration portal.

Please note that the type is CASE sensitive.

All consent types need to be included in the response. If consents are not used, please return either "true" or "false".

Response

Example Response

{
  "consents": [
    {
      "opted_in": true,
      "type": "email"
    },
    {
      "opted_in": true,
      "type": "sms"
    },
    {
      "opted_in": false,
      "type": "telephone"
    },
    {
      "opted_in": true,
      "type": "postMail"
    },
    {
      "opted_in": true,
      "type": "siteNotification"
    },
    {
      "opted_in": true,
      "type": "pushNotification"
    }
  ]
}

Data Types

{
  "consents": [
    {
      "opted_in": boolean,
      "type": "string" 
      //all consent types outlined in the Example Response must be included
    },
    {
      "opted_in": boolean,
      "type": "string"
      //all consent types outlined in the Example Response must be included
    }
  ]
}

Key	Accepted Values	Description
opted_in *	false, true	The requested consent status of each player. "false"indicates that the user is opted out from the respective channel.
type *	"email", "sms", "telephone", "postMail", "siteNotifiction", "pushNotification"	The consent type

⬆️ 2. POST /userconsents/:userid

The Operator should provide Fast Track with an endpoint that supports updating the consent of a player. This endpoint will be used to support Fast Track's unsubscription solution.

After a consent status has been changed, the Operator need to send a User Consent event. Fast Track will then fetch the consent status from the GET /userconsents/:userid endpoint.

Example Request (from Fast Track)

{
  "consents": [
    {
      "opted_in": false,
      "type": "email"
    }
  ]
}

Data Types

{
  "consents": [
    {
      "opted_in": boolean,
      "type": "string"
    }
  ]
}

Expected Response

OK 200
ERROR 400/500

Key	Accepted Values	Description
opted_in *	false	The requested consent status of each player. "false" indicates that the user should be unsubscribed.
type *	"email", "sms"	The consent type.