Campaign

Create a new campaign

Create a new active campaign. Returns the created campaign. It can be associated with one or more subchannels, using the subchannel code.

POST /campaigns

Parameters

Name	In	Type	Required	Description
x-retool-groups	header	string	false	‘none’
body	body	CampaignRequest	false	‘none’

Request body - instance of CampaignRequest

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


{
  "name": "campaign",
  "commercialProfile": "Commercial profile",
  "subchannels": [
    "MS"
  ],
  "conditions": [
    {
      "id": 123,
      "concept": "SEGMENT",
      "operator": "EQ",
      "values": "RESIDENCIAL",
      "type": "String"
    }
  ]
}

Name	Type	Required	Description
name	string	true	none
commercialProfile	string	true	none
subchannels	[string]	true	none
conditions	[CampaignRules]	false	[CampaignRules]

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22



curl -X POST https://dealers.masstack.com/v1/campaigns \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-retool-groups: tester, campaignTester" \
 --data-raw "{
  'name': 'campaign',
  'commercialProfile': 'Commercial profile',
  'subchannels': [
    'MS'
  ],
  'conditions': [
    {
      'id': 123,
      'concept': 'SEGMENT',
      'operator': 'EQ',
      'values': 'RESIDENCIAL',
      'type': 'String'
    }
  ]
}" 

Responses

Code	Meaning	Description	Schema
201	Created	Created	Campaign
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
500	Internal Server Error	Internal Server Error	ApiErrorResponse

Gets the campaign with its details.

Obtains the indicated campaign, the associated subchannels and the list of conditions that said campaign has.

GET /campaigns/{campaign_id}

Parameters

Name	In	Type	Required	Description
campaign_id	path	integer	true	‘none’

Request example

1
2
3
4



curl -X GET https://dealers.masstack.com/v1/campaigns/{campaign_id} \
  -H "Accept: application/json"

Responses

Code	Meaning	Description	Schema
200	OK	OK	Campaign
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse
500	Internal Server Error	Internal Server Error	ApiErrorResponse

Update a campaign.

Update campaign. It can be associated with one or more subchannels, using the subchannel code.

PUT /campaigns/{campaign_id}

Parameters

Name	In	Type	Required	Description
x-retool-groups	header	string	false	‘none’
campaign_id	path	integer	true	‘none’
body	body	CampaignRequest	false	‘none’

Request body - instance of CampaignRequest

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


{
  "name": "campaign",
  "commercialProfile": "Commercial profile",
  "subchannels": [
    "MS"
  ],
  "conditions": [
    {
      "id": 123,
      "concept": "SEGMENT",
      "operator": "EQ",
      "values": "RESIDENCIAL",
      "type": "String"
    }
  ]
}

Name	Type	Required	Description
name	string	true	none
commercialProfile	string	true	none
subchannels	[string]	true	none
conditions	[CampaignRules]	false	[CampaignRules]

Request example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22



curl -X PUT https://dealers.masstack.com/v1/campaigns/{campaign_id} \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-retool-groups: tester, campaignTester" \
 --data-raw "{
  'name': 'campaign',
  'commercialProfile': 'Commercial profile',
  'subchannels': [
    'MS'
  ],
  'conditions': [
    {
      'id': 123,
      'concept': 'SEGMENT',
      'operator': 'EQ',
      'values': 'RESIDENCIAL',
      'type': 'String'
    }
  ]
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	No Content	None
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
404	Not Found	Custom information not found	ApiErrorResponse
500	Internal Server Error	Internal Server Error	ApiErrorResponse

Change campaign status

Change the status of a campaign. If the campaign goes from active to inactive: all dealers associated with the campaign (if any) will no longer be associated, that is, the dealers would not have any associated campaign. Additionally, the business profile in the IAM is deleted.

POST /campaigns/{campaign_id}/change-status

Parameters

Name	In	Type	Required	Description
x-retool-groups	header	string	false	‘none’
campaign_id	path	integer	true	‘none’
body	body	CampaignChangeStatusRequest	false	‘none’

Request body - instance of CampaignChangeStatusRequest

1
2
3


{
  "status": "ACTIVATED"
}

Name	Type	Required	Description
status	string	false	none

Property	Values
status	one of [ACTIVATED, DEACTIVATED]

Request example

1
2
3
4
5
6
7
8
9



curl -X POST https://dealers.masstack.com/v1/campaigns/{campaign_id}/change-status \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-retool-groups: tester, campaignTester" \
 --data-raw "{
  'status': 'ACTIVATED'
}" 

Responses

Code	Meaning	Description	Schema
204	No Content	No content.	None
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
500	Internal Server Error	Internal Server Error	ApiErrorResponse

Returns the list of campaigns that match with the filter provided

Returns the list of campaigns that match with the filter provided.

POST /campaigns/search

Parameters

Name	In	Type	Required	Description
x-retool-groups	header	string	false	‘none’
body	body	CampaignSearchRequest	false	‘none’

Request body - instance of CampaignSearchRequest

1
2
3
4
5
6
7
8
9


{
  "active": true,
  "subchannels": [
    "MS1"
  ],
  "dealers": [
    1
  ]
}

Name	Type	Required	Description
active	boolean	false	none
subchannels	[string]	false	none
dealers	[integer]	false	none

Request example

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



curl -X POST https://dealers.masstack.com/v1/campaigns/search \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "x-retool-groups: tester, campaignTester" \
 --data-raw "{
  'active': true,
  'subchannels': [
    'MS1'
  ],
  'dealers': [
    1
  ]
}" 

Responses

Code	Meaning	Description	Schema
200	OK	Successful response.	[Campaign]
204	No Content	No content.	None
401	Unauthorized	Unauthorized	string

200 - instance of Campaign

Custom schema 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


[
  {
    "id": 12345,
    "name": "campaign",
    "commercialProfile": "Commercial profile",
    "active": true,
    "subchannels": [
      {
        "id": 123,
        "code": "MS",
        "name": "MasSubchannel"
      }
    ],
    "conditions": [
      {
        "id": 123,
        "concept": "SEGMENT",
        "operator": "EQ",
        "values": "RESIDENCIAL",
        "type": "String"
      }
    ]
  }
]

Name	Type	Required	Description
id	integer	false	none
name	string	false	none
commercialProfile	string	false	none
active	boolean	false	none
subchannels	[SubchannelSummary]	false	[SubchannelSummary]
conditions	[CampaignRules]	false	[CampaignRules]

401 - JsonObject

Custom schema example

1
2
3
4
5
6


{
  "code": "0003",
  "status": "UNAUTHORIZED",
  "message": "Unauthorized",
  "detailMsg": "Audience not found to access URI /example-uri"
}

Name	Type	Required	Description
id	integer	false	none
name	string	false	none
commercialProfile	string	false	none
active	boolean	false	none
subchannels	[SubchannelSummary]	false	[SubchannelSummary]
conditions	[CampaignRules]	false	[CampaignRules]

Returns the list of users (dealers with Agents account) that match with the filter provided.

Returns the list of users (dealers with Agents account) matching the specified filter. If the campaignManager role is specified in the 'x-retool-groups' header, the users assigned to the manager itself or one of its descendants in the hierarchy will be returned.

GET /campaigns/users

Parameters

Name	In	Type	Required	Description
x-retool-groups	header	string	false	‘none’
users	query	string	false	‘none’
subchannel	query	string	false	‘none’
campaign	query	string	false	‘none’

Request example

1
2
3
4
5



curl -X GET https://dealers.masstack.com/v1/campaigns/users?users='agent1@asesormasmovil.es,agent2@asesormasmovil.es,agent3@asesormasmovil.es'&subchannel='string'&campaign='string' \
  -H "Accept: application/json" \
  -H "x-retool-groups: tester, campaignTester"

Responses

Code	Meaning	Description	Schema
200	OK	Successful response.	[CampaignUser]
204	No Content	No content.	None
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string

200 - instance of CampaignUser

Custom schema 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


[
  {
    "id": 12345,
    "code": "CDRDealer",
    "commercialName": "Agent",
    "subchannel": "ATC",
    "systemAccounts": [
      {
        "id": 12345,
        "account": "CDRDealer",
        "accountingSystem": {
          "id": 12345,
          "code": "IAM",
          "description": "System of MM"
        }
      }
    ],
    "campaign": {
      "id": 12345,
      "name": "campaign",
      "commercialProfile": "Commercial profile",
      "active": true,
      "subchannels": [
        {
          "id": 123,
          "code": "MS",
          "name": "MasSubchannel",
          "mainChannel": {
            "id": 12345,
            "code": "M",
            "name": "Mas",
            "channelType": "myChannelType"
          },
          "sellType": "mySellType",
          "subchannelGroup": "mySubchannelGroup"
        }
      ],
      "conditions": null
    }
  }
]

Name	Type	Required	Description
id	integer	true	none
code	string	true	none
commercialName	string	false	none
subchannel	string	false	none
systemAccounts	[SystemAccount]	false	[A Dealer’s system account]
campaign	object	false	A commercial campaign
» id	integer	false	none
» name	string	false	none
» commercialProfile	string	false	none
» active	boolean	false	none
» subchannels	[Subchannel]	false	[A subchannel]
» conditions	any	false	none

400 - instance of ApiErrorResponse

Custom schema example

 1
 2
 3
 4
 5
 6
 7
 8
 9
10


{
  "errors": [
    {
      "code": "BAD_REQUEST",
      "title": "Error message",
      "ref": "some_ref",
      "details": "Detailed error message"
    }
  ]
}

Name	Type	Required	Description
restErrors	[ApiError]	false	none

401 - JsonObject

Custom schema example

1
2
3
4
5
6


{
  "code": "0003",
  "status": "UNAUTHORIZED",
  "message": "Unauthorized",
  "detailMsg": "Audience not found to access URI /example-uri"
}

Name	Type	Required	Description
restErrors	[ApiError]	false	none

modifies a dealer's campaign

POST /users/change-campaign

Parameters

Name	In	Type	Required	Description
body	body	ChangeCampaignRequest	true	‘none’

Request body - instance of ChangeCampaignRequest

1
2
3
4
5
6
7


{
  "campaignId": 123,
  "requestId": 123,
  "dealerId": [
    154
  ]
}

Name	Type	Required	Description
campaignId	integer	false	none
requestId	integer	false	none
dealerId	[DealerId]	false	none

Request example

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



curl -X POST https://dealers.masstack.com/v1/users/change-campaign \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
 --data-raw "{
  'campaignId': 123,
  'requestId': 123,
  'dealerId': [
    154
  ]
}" 

Responses

Code	Meaning	Description	Schema
200	OK	No content.	None
400	Bad Request	Bad request	ApiErrorResponse
401	Unauthorized	Unauthorized	string
500	Internal Server Error	Internal Server Error	ApiErrorResponse