masstack

V2
API Overview Resources Schemas

Configuration

Access to consents configuration

Name In Type Required Description
org_id path string true The string id related with one of available tenants/organizations
body body CreateConsentRequest true Consent definition

Request body - instance of CreateConsentRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

{
  "id": "C01",
  "type": "OPT_IN",
  "consent": [
    {
      "language": "es",
      "text": "Información comercial de servicios nuestros distintos a los contratados o de otras empresas del Grupo",
      "description": "Pertenecemos a un Grupo de empresas que prestan productos o servicios de diversa naturaleza, tales como energía, telecomunicaciones, tecnológicos, servicios y equipos para el hogar, financieros o servicios de valor añadido relacionados, por ejemplo, con la salud o seguros o autoconsumo, habitualmente con descuentos o condiciones especiales para clientes del Grupo.",
      "short_text": "Información de otros servicios contratados"
    }
  ]
}
Name Type Required Description
id ConsentId true Consent definition unique identifier (normalized to uppercase without spaces and special characters)
type ConsentType true Consent statement choice type list:
* OPT_IN - Text written in affirmative. May be in pending state
* OPT_OUT_NEGATIVE - Text written in negative. It cannot be in pending state and must be represented with a checkbox
* OPT_OUT_POSITIVE - Text written in affirmative. It cannot be in pending state and must be represented with a checkbox
consent [CreateConsentDetails] true Array of consent details for different locales

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17


curl -X POST https://consents.masstack.com/v2/orgs/masmovil/consents \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'id': 'C01',
  'type': 'OPT_IN',
  'consent': [
    {
      'language': 'es',
      'text': 'Información comercial de servicios nuestros distintos a los contratados o de otras empresas del Grupo',
      'description': 'Pertenecemos a un Grupo de empresas que prestan productos o servicios de diversa naturaleza, tales como energía, telecomunicaciones, tecnológicos, servicios y equipos para el hogar, financieros o servicios de valor añadido relacionados, por ejemplo, con la salud o seguros o autoconsumo, habitualmente con descuentos o condiciones especiales para clientes del Grupo.',
      'short_text': 'Información de otros servicios contratados'
    }
  ]
}"
Code Meaning Description Schema
201 Created Consent created successfully SavedConsentResponse
400 Bad Request Request input is not valid ErrorsResponse
401 Unauthorized The user is not authorized ErrorsResponse
409 Conflict The request could not be completed due to a conflict with the current state of the target resource ErrorsResponse
500 Internal Server Error The request failed to be processed by the server ErrorsResponse

Parameters

Name In Type Required Description
org_id path string true The string id related with one of available tenants/organizations
page query integer false Page number for pagination
page_size query integer false Number of items per page
choice_type query ConsentType false Filter by consent choice type (OPT_IN or OPT_OUT_NEGATIVE or OPT_OUT_POSITIVE)
consent_id query ConsentId false Filter by consent identifier

Request example

1
2
3
4


curl -X GET https://consents.masstack.com/v2/orgs/masmovil/consents?page='1'&page_size='50'&choice_type='OPT_IN'&consent_id='C01' \
  -H "Accept: application/json"

Responses

Code Meaning Description Schema
200 OK List of available consents definitions retrieved successfully GetConsentsDefinitionsResponse
400 Bad Request Request input is not valid ErrorsResponse
401 Unauthorized The user is not authorized ErrorsResponse
404 Not Found The specified resource was not found ErrorsResponse
500 Internal Server Error The request failed to be processed by the server ErrorsResponse

Parameters

Name In Type Required Description
Accept-Language header string false Language and country in locale format (defined in RFC 5646, which rely on the ISO 639) used to
retrieve user consent texts. Not all values are available to all organizations.
If Locale text it is not defined, a default locale text will be provided.
Locale defined lists:
* es-ES - Spanish language, country Spain
* eu-ES - Basque language, country Spain
* en-ES - English language, country Spain
* de-ES - German language, country Spain
* ca-ES - Catalan language, country Spain
org_id path string true The string id related with one of available tenants/organizations
x-sector header UserSegment false The regulated sector where customer belongs to
x-segment header UserSegment false The user’s segment where the consent tree applies (replace x-sector deprecated header). Is mandatory sent at one of ‘x-sector’ or ‘x-segment’ headers.
view query array[string] false Filters the subset of Consents that are going to be showed. They can be combined with each other. If two views containing shared consents are selected, the largest grouping will be displayed.
If not specified, all consents configured will be showed.
Allowed values are configured by the organization’s administrator
display_format query string false Optional parameter indicating the length of the text of the requested consents.
Possible values are:
* SHORT - Returns the shortened version of the consent text.
* NORMAL - Returns the default long text of the consent.
* (not set) - Returns the normal consent text.

Request example

1
2
3
4
5
6
7


curl -X GET https://consents.masstack.com/v2/orgs/masmovil/consents/customers?view='MANDATORY'&display_format='SHORT' \
  -H "Accept: application/json" \
  -H "Accept-Language: es-ES" \
  -H "x-sector: telco" \
  -H "x-segment: telco"

Responses

Code Meaning Description Schema
200 OK Expected response for a non existing user consent GetConsentsResponse
400 Bad Request Request input is not valid ErrorsResponse
401 Unauthorized The user is not authorized ErrorsResponse
404 Not Found The specified resource was not found ErrorsResponse
500 Internal Server Error The request failed to be processed by the server ErrorsResponse
Name In Type Required Description
org_id path string true The string id related with one of available tenants/organizations
consent_id path ConsentId true The unique identifier of the consent definition to be updated
body body UpdateConsentRequest true Consent definition update

Request body - instance of UpdateConsentRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11

{
  "consent": [
    {
      "language": "es",
      "text": "Información comercial de servicios nuestros distintos a los contratados o de otras empresas del Grupo",
      "description": "Pertenecemos a un Grupo de empresas que prestan productos o servicios de diversa naturaleza, tales como energía, telecomunicaciones, tecnológicos, servicios y equipos para el hogar, financieros o servicios de valor añadido relacionados, por ejemplo, con la salud o seguros o autoconsumo, habitualmente con descuentos o condiciones especiales para clientes del Grupo.",
      "short_text": "Información de otros servicios contratados"
    }
  ],
  "changes_description": "Added new language"
}
Name Type Required Description
consent [CreateConsentDetails] true none
changes_description ChangesDescriptionProperty false Optional description of the changes made

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16


curl -X PATCH https://consents.masstack.com/v2/orgs/masmovil/consents/C01 \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'consent': [
    {
      'language': 'es',
      'text': 'Información comercial de servicios nuestros distintos a los contratados o de otras empresas del Grupo',
      'description': 'Pertenecemos a un Grupo de empresas que prestan productos o servicios de diversa naturaleza, tales como energía, telecomunicaciones, tecnológicos, servicios y equipos para el hogar, financieros o servicios de valor añadido relacionados, por ejemplo, con la salud o seguros o autoconsumo, habitualmente con descuentos o condiciones especiales para clientes del Grupo.',
      'short_text': 'Información de otros servicios contratados'
    }
  ],
  'changes_description': 'Added new language'
}"
Code Meaning Description Schema
200 OK Consent updated successfully SavedConsentResponse
400 Bad Request Request input is not valid ErrorsResponse
401 Unauthorized The user is not authorized ErrorsResponse
404 Not Found The specified resource was not found ErrorsResponse
500 Internal Server Error The request failed to be processed by the server ErrorsResponse
Name In Type Required Description
org_id path string true The string id related with one of available tenants/organizations
x-segment header UserSegment true The user’s segment where the consent tree applies
body body CreateConsentTreeRequest true Consent tree definition

Request body - instance of CreateConsentTreeRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

{
  "description": "Default Telco Configuration",
  "default_language": "es-ES",
  "allowed_languages": [
    "es",
    "eu",
    "en"
  ],
  "consents_order": [
    "C01"
  ],
  "priority_consent_ids": [
    "C01"
  ],
  "views": [
    {
      "view": "MANDATORY",
      "consents": [
        "C01"
      ]
    }
  ],
  "dependencies": [
    {
      "father": "C01",
      "child": [
        "C01"
      ]
    }
  ],
  "channels": [
    "crm",
    "agents",
    "web",
    "whatsapp",
    "landing"
  ],
  "users_type": "customers, leads"
}
Name Type Required Description
description ConfigurationTreeDescription true Description of the consent tree
default_language DefaultLanguageProperty true Default locale for the consent tree
allowed_languages AllowedLanguages true List of allowed languages to ask consent text for
consents_order ConsentsOrder true Order of consents in the tree when visualized by user
priority_consent_ids PriorityConsentIds true List of priority consent Ids
views ConsentsViews true Different views (group of consents) for the consent tree
dependencies ConsentsDependencies false (Optional) Dependencies between consents
channels CaptureChannels true Channels where the consent tree is applicable to be captured
users_type UserType true Type of users the consent tree applies to

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45


curl -X POST https://consents.masstack.com/v2/orgs/masmovil/consents/tree \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-segment: telco" \
 --data-raw "{
  'description': 'Default Telco Configuration',
  'default_language': 'es-ES',
  'allowed_languages': [
    'es',
    'eu',
    'en'
  ],
  'consents_order': [
    'C01'
  ],
  'priority_consent_ids': [
    'C01'
  ],
  'views': [
    {
      'view': 'MANDATORY',
      'consents': [
        'C01'
      ]
    }
  ],
  'dependencies': [
    {
      'father': 'C01',
      'child': [
        'C01'
      ]
    }
  ],
  'channels': [
    'crm',
    'agents',
    'web',
    'whatsapp',
    'landing'
  ],
  'users_type': 'customers, leads'
}"
Code Meaning Description Schema
204 No Content Consent tree created successfully (no content) None
400 Bad Request Request input is not valid ErrorsResponse
401 Unauthorized The user is not authorized ErrorsResponse
500 Internal Server Error The request failed to be processed by the server ErrorsResponse
Name In Type Required Description
org_id path string true The string id related with one of available tenants/organizations
x-segment header UserSegment true The user’s segment where the consent tree applies
body body UpdateConsentTreeRequest true Consent tree definition update

Request body - instance of UpdateConsentTreeRequest

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

{
  "description": "Default Telco Configuration",
  "default_language": "es-ES",
  "allowed_languages": [
    "es",
    "eu",
    "en"
  ],
  "consents_order": [
    "C01"
  ],
  "priority_consent_ids": [
    "C01"
  ],
  "change_log": "Added new consent",
  "views": [
    {
      "view": "MANDATORY",
      "consents": [
        "C01"
      ]
    }
  ],
  "dependencies": [
    {
      "father": "C01",
      "child": [
        "C01"
      ]
    }
  ],
  "channels": [
    "crm",
    "agents",
    "web",
    "whatsapp",
    "landing"
  ],
  "users_type": "customers, leads"
}
Name Type Required Description
description ConfigurationTreeDescription false Description of the consent tree
default_language DefaultLanguageProperty false Default locale for the consent tree
allowed_languages AllowedLanguages false List of allowed languages to ask consent text for
consents_order ConsentsOrder false Order of consents in the tree when visualized by user
priority_consent_ids PriorityConsentIds false List of priority consent Ids
change_log ChangeLogProperty false Description of the changes made in this update
views ConsentsViews false Different views (group of consents) for the consent tree
dependencies ConsentsDependencies false (Optional) Dependencies between consents
channels CaptureChannels false Channels where the consent tree is applicable to be captured
users_type UserType false Type of users the consent tree applies to

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46


curl -X PATCH https://consents.masstack.com/v2/orgs/masmovil/consents/tree \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-segment: telco" \
 --data-raw "{
  'description': 'Default Telco Configuration',
  'default_language': 'es-ES',
  'allowed_languages': [
    'es',
    'eu',
    'en'
  ],
  'consents_order': [
    'C01'
  ],
  'priority_consent_ids': [
    'C01'
  ],
  'change_log': 'Added new consent',
  'views': [
    {
      'view': 'MANDATORY',
      'consents': [
        'C01'
      ]
    }
  ],
  'dependencies': [
    {
      'father': 'C01',
      'child': [
        'C01'
      ]
    }
  ],
  'channels': [
    'crm',
    'agents',
    'web',
    'whatsapp',
    'landing'
  ],
  'users_type': 'customers, leads'
}"
Code Meaning Description Schema
204 No Content Consent tree updated successfully (no content) None
400 Bad Request Request input is not valid ErrorsResponse
401 Unauthorized The user is not authorized ErrorsResponse
404 Not Found The specified resource was not found ErrorsResponse
500 Internal Server Error The request failed to be processed by the server ErrorsResponse
Name In Type Required Description
org_id path string true The string id related with one of available tenants/organizations
x-segment header UserSegment false The user’s segment where the consent tree applies (replace x-sector deprecated header). Is mandatory sent at one of ‘x-sector’ or ‘x-segment’ headers.
users_type query string false Filter by group of users where the consent tree applies to [ customers, leads ]

Request example

1
2
3
4
5


curl -X GET https://consents.masstack.com/v2/orgs/masmovil/consents/tree?users_type='customers' \
  -H "Accept: application/json" \
  -H "x-segment: telco"
Code Meaning Description Schema
200 OK Consent configuration trees retrieved successfully GetConsentTreesResponse
400 Bad Request Request input is not valid ErrorsResponse
401 Unauthorized The user is not authorized ErrorsResponse
404 Not Found The specified resource was not found ErrorsResponse
500 Internal Server Error The request failed to be processed by the server ErrorsResponse
Name In Type Required Description
org_id path string true The string id related with one of available tenants/organizations
x-segment header UserSegment true The user’s segment where the consent tree applies
users_type query string false Filter by group of users where the consent tree applies to [ customers, leads ]
page query integer false Page number for pagination
page_size query integer false Number of items per page

Request example

1
2
3
4
5


curl -X GET https://consents.masstack.com/v2/orgs/masmovil/consents/tree/history?users_type='customers'&page='1'&page_size='50' \
  -H "Accept: application/json" \
  -H "x-segment: telco"
Code Meaning Description Schema
200 OK Consent tree history retrieved successfully GetConsentTreeHistoryResponse
400 Bad Request Request input is not valid ErrorsResponse
401 Unauthorized The user is not authorized ErrorsResponse
500 Internal Server Error The request failed to be processed by the server ErrorsResponse

Parameters

Name In Type Required Description
org_id path string true The string id related with one of available tenants/organizations
consent_id path ConsentId true The unique identifier of the consent definition to be updated
page query integer false Page number for pagination
page_size query integer false Number of items per page

Request example

1
2
3
4


curl -X GET https://consents.masstack.com/v2/orgs/masmovil/consents/C01/history?page='1'&page_size='50' \
  -H "Accept: application/json"

Responses

Code Meaning Description Schema
200 OK List of historical consents definitions retrieved successfully GetConsentsDefinitionsHistoryResponse
400 Bad Request Request input is not valid ErrorsResponse
401 Unauthorized The user is not authorized ErrorsResponse
500 Internal Server Error The request failed to be processed by the server ErrorsResponse

Endpoints

Customer Consents

    Configuration

      Securize