masstack

V2
API Overview Resources Schemas

Template Deployment

Parameters

Name In Type Required Description
org path string true Organization name as it is registered in Mas-Stack
type query string false Communication type. Allows EQ (type=password_reset), and CONTAINS (type[contains]=password) operations
language query string false Template language
channel query string false Template channel

Request example

1
2
3
4
5


curl -X GET https://communications.masstack.com/v2/orgs/yoigo/deployment/changes?type='password_reset'&language='en'&channel='sms' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Returned a list of elements validated DeploymentValidationResponseDTO
400 Bad Request Client error ResponseErrorDto
500 Internal Server Error Server Error ResponseErrorDto

Parameters

Name In Type Required Description
org path string true Organization name as it is registered in Mas-Stack
body body DeploymentValidationRequestDTO false Validation values not mandatory

Request body - instance of DeploymentValidationRequestDTO

1
2
3
4
5

{
  "type": "password_reset",
  "language": "es",
  "channel": "sms"
}
Name Type Required Description
type string false Communication type code according to the ones previously defined in the system
language string false Template language
channel ChannelTypeDTO false Tipul canalului pentru comunicare. Valorile acceptate sunt ‘sms’ sau ‘email’.

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


curl -X POST https://communications.masstack.com/v2/orgs/yoigo/deployment/invalidation \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'type': 'password_reset',
  'language': 'es',
  'channel': 'sms'
}"

Responses

Code Meaning Description Schema
200 OK Returned a list of elements validated DeploymentValidationResponseDTO
400 Bad Request Client error ResponseErrorDto
500 Internal Server Error Server Error ResponseErrorDto
Name In Type Required Description
org path string true Organization name as it is registered in Mas-Stack
body body DeploymentRequestDTO false The field deploymentType is mandatory and can be ‘deploy’ or ‘rollback’. If the deploymentType is ‘deploy’, the type, language and channel fields are optional. If the deploymentType is ‘rollback’, no other field is required.If no item are selected, all items will be deployed.

Request body - instance of DeploymentRequestDTO

 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

{
  "deploymentType": "deploy",
  "ticketNumber": "CUCO-12345",
  "items": [
    {
      "type": "password_reset",
      "typeId": 2,
      "objectType": "communication_type",
      "changeType": "deployed",
      "channel": "sms",
      "typeItems": [
        {
          "objectId": "ba047bf4-5a95-49c3-8602-61317bce1e22",
          "objectType": "sms_example",
          "language": "es",
          "changeType": "deployed",
          "errors": [
            {
              "field": "string",
              "expected": "string",
              "returned": "string"
            }
          ],
          "content": "string",
          "tenant": "masmovil",
          "eligibleForDeployment": true
        }
      ],
      "description": "string",
      "eligibleForDeployment": true
    }
  ]
}
Name Type Required Description
deploymentType DeploymentType false Deployment type. It can be ‘deploy’ or ‘rollback’.
ticketNumber string false The ticket number associated with the deployment.
items [DeploymentValidationItemsResponseDTO] false The list of the items that will be deployed

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


curl -X PATCH https://communications.masstack.com/v2/orgs/yoigo/deployment/apply \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'deploymentType': 'deploy',
  'ticketNumber': 'CUCO-12345',
  'items': [
    {
      'type': 'password_reset',
      'typeId': 2,
      'objectType': 'communication_type',
      'changeType': 'deployed',
      'channel': 'sms',
      'typeItems': [
        {
          'objectId': 'ba047bf4-5a95-49c3-8602-61317bce1e22',
          'objectType': 'sms_example',
          'language': 'es',
          'changeType': 'deployed',
          'errors': [
            {
              'field': 'string',
              'expected': 'string',
              'returned': 'string'
            }
          ],
          'content': 'string',
          'tenant': 'masmovil',
          'eligibleForDeployment': true
        }
      ],
      'description': 'string',
      'eligibleForDeployment': true
    }
  ]
}"
Code Meaning Description Schema
200 OK Returned a list of elements validated DeploymentResponseDTO
400 Bad Request Client error ResponseErrorDto
500 Internal Server Error Server Error ResponseErrorDto

Parameters

Name In Type Required Description
org path string true Organization name as it is registered in Mas-Stack
type query string false Communication type. Allows EQ (type=password_reset), and CONTAINS (type[contains]=password) operations
language query string false Template language
channel query string false Template channel

Request example

1
2
3
4
5


curl -X GET https://communications.masstack.com/v2/orgs/yoigo/deployment/getAllVersions?type='password_reset'&language='en'&channel='sms' \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}"

Responses

Code Meaning Description Schema
200 OK Returned a deployment version list DeploymentTemplateVersionsDTO
400 Bad Request Client error ResponseErrorDto
500 Internal Server Error Server Error ResponseErrorDto

Parameters

Name In Type Required Description
org path string true Organization name as it is registered in Mas-Stack
body body DeploymentValidationRequestDTO false Validation values not mandatory

Request body - instance of DeploymentValidationRequestDTO

1
2
3
4
5

{
  "type": "password_reset",
  "language": "es",
  "channel": "sms"
}
Name Type Required Description
type string false Communication type code according to the ones previously defined in the system
language string false Template language
channel ChannelTypeDTO false Tipul canalului pentru comunicare. Valorile acceptate sunt ‘sms’ sau ‘email’.

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11


curl -X POST https://communications.masstack.com/v2/orgs/yoigo/deployment/validation \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer {access-token}" \
 --data-raw "{
  'type': 'password_reset',
  'language': 'es',
  'channel': 'sms'
}"

Responses

Code Meaning Description Schema
200 OK Returned a list of elements validated DeploymentValidationResponseDTO
400 Bad Request Client error ResponseErrorDto
500 Internal Server Error Server Error ResponseErrorDto

Endpoints

CMS

    Communications

      Short URLs

        Communication Types

          Templates

            Examples

              Template Deployment