BulkEmail API (v1)

Download OpenAPI specification:Download

Campaign

Get all campaigns for an account

path Parameters

accountID

required

string <uuid>

query Parameters

skip	integer <int32>
take	integer <int32>
filter	string
campaignTypeID	string
campaignTags	Array of strings
campaignTagsFilterType	string
includePreviewHtmlBody	boolean
campaignTypeIDs	Array of strings

Responses

Response samples

200

Content type

application/json

[{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CampaignType": 1,
"CampaignState": 1,
"ToAddressListID": "00000000-0000-0000-0000-000000000000",
"ScheduledOn": "2019-08-24T14:15:22Z",
"ScheduledOnUtc": "2019-08-24T14:15:22Z",
"TestPercentage": 0.1,
"TestDurationMinutes": 0,
"TestMetricType": 1,
"SendToRemainingOn": "2019-08-24T14:15:22Z",
"SendToRemainingOnUtc": "2019-08-24T14:15:22Z",
"WinningVariationID": "00000000-0000-0000-0000-000000000000",
"TotalRecipients": 0,
"PreviewHtmlBody": "string",
"CampaignTags": [{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Tag": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}
],
"GoogleAnalyticsTracking": {"Source": "string",
"Medium": "string",
"Campaign": "string"
},
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}
]

Create a campaign

path Parameters

accountID

required

string <uuid>

Request Body schema:
application/json
required

ID	string <uuid>
AccountID	string <uuid>
Name	string
CampaignType	integer <int32> Enum: 1 2 3 4 5
CampaignState	integer <int32> Enum: 1 2 3 4 5 6 7 8
ToAddressListID	string <uuid>
ScheduledOn	string <date-time>
ScheduledOnUtc	string <date-time>
TestPercentage	number <double>
TestDurationMinutes	integer <int32>
TestMetricType	integer <int32> Enum: 1 2 3
SendToRemainingOn	string <date-time>
SendToRemainingOnUtc	string <date-time>
WinningVariationID	string <uuid>
TotalRecipients	integer <int32>
PreviewHtmlBody	string
	Array of objects (CM.Tooling.BulkEmail.Api.Models.ApiCampaignTag)
	object (CM.Tooling.BulkEmail.Api.Models.ApiGoogleAnalyticsTracking)
CreatedOn	string <date-time>
CreatedOnUtc	string <date-time>
ModifiedOn	string <date-time>
ModifiedOnUtc	string <date-time>
DeletedOn	string <date-time>
DeletedOnUtc	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CampaignType": 1,
"CampaignState": 1,
"ToAddressListID": "00000000-0000-0000-0000-000000000000",
"ScheduledOn": "2019-08-24T14:15:22Z",
"ScheduledOnUtc": "2019-08-24T14:15:22Z",
"TestPercentage": 0.1,
"TestDurationMinutes": 0,
"TestMetricType": 1,
"SendToRemainingOn": "2019-08-24T14:15:22Z",
"SendToRemainingOnUtc": "2019-08-24T14:15:22Z",
"WinningVariationID": "00000000-0000-0000-0000-000000000000",
"TotalRecipients": 0,
"PreviewHtmlBody": "string",
"CampaignTags": [{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Tag": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}
],
"GoogleAnalyticsTracking": {"Source": "string",
"Medium": "string",
"Campaign": "string"
},
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CampaignType": 1,
"CampaignState": 1,
"ToAddressListID": "00000000-0000-0000-0000-000000000000",
"ScheduledOn": "2019-08-24T14:15:22Z",
"ScheduledOnUtc": "2019-08-24T14:15:22Z",
"TestPercentage": 0.1,
"TestDurationMinutes": 0,
"TestMetricType": 1,
"SendToRemainingOn": "2019-08-24T14:15:22Z",
"SendToRemainingOnUtc": "2019-08-24T14:15:22Z",
"WinningVariationID": "00000000-0000-0000-0000-000000000000",
"TotalRecipients": 0,
"PreviewHtmlBody": "string",
"CampaignTags": [{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Tag": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}
],
"GoogleAnalyticsTracking": {"Source": "string",
"Medium": "string",
"Campaign": "string"
},
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Get a specific campaign

path Parameters

accountID required	string <uuid>
campaignID required	string <uuid>

query Parameters

includePreviewHtmlBody

boolean

Responses

Response samples

200

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CampaignType": 1,
"CampaignState": 1,
"ToAddressListID": "00000000-0000-0000-0000-000000000000",
"ScheduledOn": "2019-08-24T14:15:22Z",
"ScheduledOnUtc": "2019-08-24T14:15:22Z",
"TestPercentage": 0.1,
"TestDurationMinutes": 0,
"TestMetricType": 1,
"SendToRemainingOn": "2019-08-24T14:15:22Z",
"SendToRemainingOnUtc": "2019-08-24T14:15:22Z",
"WinningVariationID": "00000000-0000-0000-0000-000000000000",
"TotalRecipients": 0,
"PreviewHtmlBody": "string",
"CampaignTags": [{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Tag": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}
],
"GoogleAnalyticsTracking": {"Source": "string",
"Medium": "string",
"Campaign": "string"
},
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Update a campaign

path Parameters

accountID required	string <uuid>
campaignID required	string <uuid>

Request Body schema:
application/json
required

ID	string <uuid>
AccountID	string <uuid>
Name	string
CampaignType	integer <int32> Enum: 1 2 3 4 5
CampaignState	integer <int32> Enum: 1 2 3 4 5 6 7 8
ToAddressListID	string <uuid>
ScheduledOn	string <date-time>
ScheduledOnUtc	string <date-time>
TestPercentage	number <double>
TestDurationMinutes	integer <int32>
TestMetricType	integer <int32> Enum: 1 2 3
SendToRemainingOn	string <date-time>
SendToRemainingOnUtc	string <date-time>
WinningVariationID	string <uuid>
TotalRecipients	integer <int32>
PreviewHtmlBody	string
	Array of objects (CM.Tooling.BulkEmail.Api.Models.ApiCampaignTag)
	object (CM.Tooling.BulkEmail.Api.Models.ApiGoogleAnalyticsTracking)
CreatedOn	string <date-time>
CreatedOnUtc	string <date-time>
ModifiedOn	string <date-time>
ModifiedOnUtc	string <date-time>
DeletedOn	string <date-time>
DeletedOnUtc	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CampaignType": 1,
"CampaignState": 1,
"ToAddressListID": "00000000-0000-0000-0000-000000000000",
"ScheduledOn": "2019-08-24T14:15:22Z",
"ScheduledOnUtc": "2019-08-24T14:15:22Z",
"TestPercentage": 0.1,
"TestDurationMinutes": 0,
"TestMetricType": 1,
"SendToRemainingOn": "2019-08-24T14:15:22Z",
"SendToRemainingOnUtc": "2019-08-24T14:15:22Z",
"WinningVariationID": "00000000-0000-0000-0000-000000000000",
"TotalRecipients": 0,
"PreviewHtmlBody": "string",
"CampaignTags": [{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Tag": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}
],
"GoogleAnalyticsTracking": {"Source": "string",
"Medium": "string",
"Campaign": "string"
},
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CampaignType": 1,
"CampaignState": 1,
"ToAddressListID": "00000000-0000-0000-0000-000000000000",
"ScheduledOn": "2019-08-24T14:15:22Z",
"ScheduledOnUtc": "2019-08-24T14:15:22Z",
"TestPercentage": 0.1,
"TestDurationMinutes": 0,
"TestMetricType": 1,
"SendToRemainingOn": "2019-08-24T14:15:22Z",
"SendToRemainingOnUtc": "2019-08-24T14:15:22Z",
"WinningVariationID": "00000000-0000-0000-0000-000000000000",
"TotalRecipients": 0,
"PreviewHtmlBody": "string",
"CampaignTags": [{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Tag": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}
],
"GoogleAnalyticsTracking": {"Source": "string",
"Medium": "string",
"Campaign": "string"
},
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Delete a campaign

path Parameters

accountID required	string <uuid>
campaignID required	string <uuid>

Responses

Clone a campaign

path Parameters

accountID required	string <uuid>
campaignID required	string <uuid>

Responses

Response samples

200

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"CampaignType": 1,
"CampaignState": 1,
"ToAddressListID": "00000000-0000-0000-0000-000000000000",
"ScheduledOn": "2019-08-24T14:15:22Z",
"ScheduledOnUtc": "2019-08-24T14:15:22Z",
"TestPercentage": 0.1,
"TestDurationMinutes": 0,
"TestMetricType": 1,
"SendToRemainingOn": "2019-08-24T14:15:22Z",
"SendToRemainingOnUtc": "2019-08-24T14:15:22Z",
"WinningVariationID": "00000000-0000-0000-0000-000000000000",
"TotalRecipients": 0,
"PreviewHtmlBody": "string",
"CampaignTags": [{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Tag": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}
],
"GoogleAnalyticsTracking": {"Source": "string",
"Medium": "string",
"Campaign": "string"
},
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

CampaignTags

Get all campaigntags for an account

path Parameters

accountID

required

string <uuid>

query Parameters

skip	integer <int32>
take	integer <int32>

Responses

Response samples

200

Content type

application/json

[{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Tag": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}
]

Create a new campaigntag

path Parameters

accountID

required

string <uuid>

Request Body schema:
application/json
required

ID	string <uuid>
AccountID	string <uuid>
Tag	string
CreatedOn	string <date-time>
CreatedOnUtc	string <date-time>
ModifiedOn	string <date-time>
ModifiedOnUtc	string <date-time>
DeletedOn	string <date-time>
DeletedOnUtc	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Tag": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Tag": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Get a specific campaigntag

path Parameters

accountID required	string <uuid>
campaignTagID required	string <uuid>

Responses

Response samples

200

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Tag": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Update the campaigntag

path Parameters

accountID required	string <uuid>
campaignTagID required	string <uuid>

Request Body schema:
application/json
required

ID	string <uuid>
AccountID	string <uuid>
Tag	string
CreatedOn	string <date-time>
CreatedOnUtc	string <date-time>
ModifiedOn	string <date-time>
ModifiedOnUtc	string <date-time>
DeletedOn	string <date-time>
DeletedOnUtc	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Tag": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Tag": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Delete a Campaign

path Parameters

accountID required	string <uuid>
campaignTagID required	string <uuid>

Responses

Add a campaigntag to a campaign

path Parameters

accountID required	string <uuid>
campaignID required	string <uuid>
campaignTagID required	string <uuid>

Responses

Delete a campaigntag from a campaign

path Parameters

accountID required	string <uuid>
campaignID required	string <uuid>
campaignTagID required	string <uuid>

Responses

FromAddress

Get all fromaddresses for an account

path Parameters

accountID

required

string <uuid>

query Parameters

skip	integer <int32>
take	integer <int32>
filter	string

Responses

Response samples

200

Content type

application/json

[{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"EmailAddress": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}
]

Create a new fromaddress

path Parameters

accountID

required

string <uuid>

Request Body schema:
application/json
required

ID	string <uuid>
AccountID	string <uuid>
Name	string
EmailAddress	string
CreatedOn	string <date-time>
CreatedOnUtc	string <date-time>
ModifiedOn	string <date-time>
ModifiedOnUtc	string <date-time>
DeletedOn	string <date-time>
DeletedOnUtc	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"EmailAddress": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"EmailAddress": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Get a specific fromaddress

path Parameters

accountID required	string <uuid>
fromAddressID required	string <uuid>

Responses

Response samples

200

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"EmailAddress": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Update the fromaddress except for the emailaddress

path Parameters

accountID required	string <uuid>
fromAddressID required	string <uuid>

Request Body schema:
application/json
required

ID	string <uuid>
AccountID	string <uuid>
Name	string
EmailAddress	string
CreatedOn	string <date-time>
CreatedOnUtc	string <date-time>
ModifiedOn	string <date-time>
ModifiedOnUtc	string <date-time>
DeletedOn	string <date-time>
DeletedOnUtc	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"EmailAddress": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"EmailAddress": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Delete a fromaddress

path Parameters

accountID required	string <uuid>
fromAddressID required	string <uuid>

Responses

FromDomains

Get all fromdomains for an account

path Parameters

accountID

required

string <uuid>

query Parameters

skip	integer <int32>
take	integer <int32>
filter	string

Responses

Response samples

200

Content type

application/json

[{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Domain": "string",
"IsValid": true,
"DnsEntries": [{"Host": "string",
"Type": "string",
"Value": "string",
"IsValid": true
}
],
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}
]

Create a new fromdomain

path Parameters

accountID

required

string <uuid>

Request Body schema:
application/json
required

ID	string <uuid>
AccountID	string <uuid>
Domain	string
IsValid	boolean
	Array of objects (CM.Tooling.BulkEmail.Api.Models.ApiFromDomainDnsEntry)
CreatedOn	string <date-time>
CreatedOnUtc	string <date-time>
ModifiedOn	string <date-time>
ModifiedOnUtc	string <date-time>
DeletedOn	string <date-time>
DeletedOnUtc	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Domain": "string",
"IsValid": true,
"DnsEntries": [{"Host": "string",
"Type": "string",
"Value": "string",
"IsValid": true
}
],
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Domain": "string",
"IsValid": true,
"DnsEntries": [{"Host": "string",
"Type": "string",
"Value": "string",
"IsValid": true
}
],
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Get a specific fromdomain

path Parameters

accountID required	string <uuid>
fromDomainID required	string <uuid>

Responses

Response samples

200

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"EmailAddress": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Delete a fromdomain

path Parameters

accountID required	string <uuid>
fromDomainID required	string <uuid>

Responses

Verify a from domain

path Parameters

accountID required	string <uuid>
fromDomainID required	string <uuid>

Responses

Response samples

200

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Domain": "string",
"IsValid": true,
"DnsEntries": [{"Host": "string",
"Type": "string",
"Value": "string",
"IsValid": true
}
],
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Mail

Get a specific mail

path Parameters

mailID

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"MailingID": "00000000-0000-0000-0000-000000000000",
"FromAddress": "string",
"FromName": "string",
"ToAddress": "string",
"ToName": "string",
"Subject": "string",
"TextBody": "string",
"HtmlBody": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z"
}

Send a single mail without a mailing

path Parameters

accountID

required

string <uuid>

Request Body schema:
application/json
required

ID	string <uuid>
AccountID	string <uuid>
FromAddressID	string <uuid>
FromName	string
ReplyToAddressID	string <uuid>
ReplyToAddress	string
ReplyToName	string
ToAddress	string
ToName	string
Subject	string
	Array of objects (CM.Tooling.BulkEmail.Api.Models.ApiEmailAddress)
	Array of objects (CM.Tooling.BulkEmail.Api.Models.ApiEmailAddress)
HtmlBody	string
TextBody	string
	Array of objects (CM.Tooling.BulkEmail.Api.Models.ApiAttachment)
CustomerReference	string
CreatedOn	string <date-time>
CreatedOnUtc	string <date-time>
ModifiedOn	string <date-time>
ModifiedOnUtc	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"FromAddressID": "00000000-0000-0000-0000-000000000000",
"FromName": "string",
"ReplyToAddressID": "00000000-0000-0000-0000-000000000000",
"ReplyToAddress": "string",
"ReplyToName": "string",
"ToAddress": "string",
"ToName": "string",
"Subject": "string",
"Bccs": [{"EmailAddress": "string"
}
],
"Ccs": [{"EmailAddress": "string"
}
],
"HtmlBody": "string",
"TextBody": "string",
"Attachments": [{"FileName": "string",
"Content": "string",
"ContentID": "string"
}
],
"CustomerReference": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"FromAddressID": "00000000-0000-0000-0000-000000000000",
"FromName": "string",
"ReplyToAddressID": "00000000-0000-0000-0000-000000000000",
"ReplyToAddress": "string",
"ReplyToName": "string",
"ToAddress": "string",
"ToName": "string",
"Subject": "string",
"Bccs": [{"EmailAddress": "string"
}
],
"Ccs": [{"EmailAddress": "string"
}
],
"HtmlBody": "string",
"TextBody": "string",
"Attachments": [{"FileName": "string",
"Content": "string",
"ContentID": "string"
}
],
"CustomerReference": "string",
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z"
}

Add a mail to a triggered campaign

path Parameters

accountID required	string <uuid>
campaignID required	string <uuid>

Request Body schema:
application/json
required

ID	string <uuid>
AccountID	string <uuid>
CampaignID	string <uuid>
ToAddress	string
ToName	string
	Array of objects (CM.Tooling.BulkEmail.Api.Models.ApiCustomValue)
	Array of objects (CM.Tooling.BulkEmail.Api.Models.ApiAttachment)

Responses

Request samples

Payload

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"CampaignID": "00000000-0000-0000-0000-000000000000",
"ToAddress": "string",
"ToName": "string",
"CustomValues": [{"Field": "string",
"Value": "string"
}
],
"Attachments": [{"FileName": "string",
"Content": "string",
"ContentID": "string"
}
]
}

Response samples

200

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"CampaignID": "00000000-0000-0000-0000-000000000000",
"ToAddress": "string",
"ToName": "string",
"CustomValues": [{"Field": "string",
"Value": "string"
}
],
"Attachments": [{"FileName": "string",
"Content": "string",
"ContentID": "string"
}
]
}

Mailing

Get all mailings for a campaign

path Parameters

accountID required	string <uuid>
campaignID required	string <uuid>

query Parameters

includeTemplateHtmlBody	boolean
includeTemplateTextBody	boolean
includeTemplateJson	boolean

Responses

Response samples

200

Content type

application/json

[{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"CampaignID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"FromName": "string",
"FromAddressID": "00000000-0000-0000-0000-000000000000",
"ReplyToAddressID": "00000000-0000-0000-0000-000000000000",
"Subject": "string",
"MailingState": 1,
"MailingType": 1,
"Template": {"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"HtmlBody": "string",
"TextBody": "string",
"Json": "string",
"MergeFields": {"MergeTags": [{"Name": "string",
"Value": "string",
"Mapping": "string"
}
],
"SpecialLinks": [{"Type": "string",
"Label": "string",
"Link": "string",
"Mapping": "string",
"Tag": "string"
}
]
},
"TemplateEditorType": 1,
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
},
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}
]

Create a campaign mailing

path Parameters

accountID required	string <uuid>
campaignID required	string <uuid>

Request Body schema:
application/json
required

ID	string <uuid>
AccountID	string <uuid>
CampaignID	string <uuid>
Name	string
FromName	string
FromAddressID	string <uuid>
ReplyToAddressID	string <uuid>
Subject	string
MailingState	integer <int32> Enum: 1 2 3 4 5 6
MailingType	integer <int32> Enum: 1 2 3 4 5 6
	object (CM.Tooling.BulkEmail.Api.Models.ApiTemplate)
CreatedOn	string <date-time>
CreatedOnUtc	string <date-time>
ModifiedOn	string <date-time>
ModifiedOnUtc	string <date-time>
DeletedOn	string <date-time>
DeletedOnUtc	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"CampaignID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"FromName": "string",
"FromAddressID": "00000000-0000-0000-0000-000000000000",
"ReplyToAddressID": "00000000-0000-0000-0000-000000000000",
"Subject": "string",
"MailingState": 1,
"MailingType": 1,
"Template": {"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"HtmlBody": "string",
"TextBody": "string",
"Json": "string",
"MergeFields": {"MergeTags": [{"Name": "string",
"Value": "string",
"Mapping": "string"
}
],
"SpecialLinks": [{"Type": "string",
"Label": "string",
"Link": "string",
"Mapping": "string",
"Tag": "string"
}
]
},
"TemplateEditorType": 1,
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
},
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"CampaignID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"FromName": "string",
"FromAddressID": "00000000-0000-0000-0000-000000000000",
"ReplyToAddressID": "00000000-0000-0000-0000-000000000000",
"Subject": "string",
"MailingState": 1,
"MailingType": 1,
"Template": {"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"HtmlBody": "string",
"TextBody": "string",
"Json": "string",
"MergeFields": {"MergeTags": [{"Name": "string",
"Value": "string",
"Mapping": "string"
}
],
"SpecialLinks": [{"Type": "string",
"Label": "string",
"Link": "string",
"Mapping": "string",
"Tag": "string"
}
]
},
"TemplateEditorType": 1,
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
},
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Get a specific mailing for a campaign

path Parameters

accountID required	string <uuid>
campaignID required	string <uuid>
mailingID required	string <uuid>

query Parameters

includeTemplateHtmlBody	boolean
includeTemplateTextBody	boolean
includeTemplateJson	boolean

Responses

Response samples

200

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"CampaignID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"FromName": "string",
"FromAddressID": "00000000-0000-0000-0000-000000000000",
"ReplyToAddressID": "00000000-0000-0000-0000-000000000000",
"Subject": "string",
"MailingState": 1,
"MailingType": 1,
"Template": {"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"HtmlBody": "string",
"TextBody": "string",
"Json": "string",
"MergeFields": {"MergeTags": [{"Name": "string",
"Value": "string",
"Mapping": "string"
}
],
"SpecialLinks": [{"Type": "string",
"Label": "string",
"Link": "string",
"Mapping": "string",
"Tag": "string"
}
]
},
"TemplateEditorType": 1,
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
},
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Update a campaign mailing

path Parameters

accountID required	string <uuid>
campaignID required	string <uuid>
mailingID required	string <uuid>

Request Body schema:
application/json
required

ID	string <uuid>
AccountID	string <uuid>
CampaignID	string <uuid>
Name	string
FromName	string
FromAddressID	string <uuid>
ReplyToAddressID	string <uuid>
Subject	string
MailingState	integer <int32> Enum: 1 2 3 4 5 6
MailingType	integer <int32> Enum: 1 2 3 4 5 6
	object (CM.Tooling.BulkEmail.Api.Models.ApiTemplate)
CreatedOn	string <date-time>
CreatedOnUtc	string <date-time>
ModifiedOn	string <date-time>
ModifiedOnUtc	string <date-time>
DeletedOn	string <date-time>
DeletedOnUtc	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"CampaignID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"FromName": "string",
"FromAddressID": "00000000-0000-0000-0000-000000000000",
"ReplyToAddressID": "00000000-0000-0000-0000-000000000000",
"Subject": "string",
"MailingState": 1,
"MailingType": 1,
"Template": {"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"HtmlBody": "string",
"TextBody": "string",
"Json": "string",
"MergeFields": {"MergeTags": [{"Name": "string",
"Value": "string",
"Mapping": "string"
}
],
"SpecialLinks": [{"Type": "string",
"Label": "string",
"Link": "string",
"Mapping": "string",
"Tag": "string"
}
]
},
"TemplateEditorType": 1,
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
},
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"CampaignID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"FromName": "string",
"FromAddressID": "00000000-0000-0000-0000-000000000000",
"ReplyToAddressID": "00000000-0000-0000-0000-000000000000",
"Subject": "string",
"MailingState": 1,
"MailingType": 1,
"Template": {"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"HtmlBody": "string",
"TextBody": "string",
"Json": "string",
"MergeFields": {"MergeTags": [{"Name": "string",
"Value": "string",
"Mapping": "string"
}
],
"SpecialLinks": [{"Type": "string",
"Label": "string",
"Link": "string",
"Mapping": "string",
"Tag": "string"
}
]
},
"TemplateEditorType": 1,
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
},
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Delete a campaign mailing

path Parameters

accountID required	string <uuid>
campaignID required	string <uuid>
mailingID required	string <uuid>

Responses

Template

Get all templates for an account

path Parameters

accountID

required

string <uuid>

query Parameters

skip	integer <int32>
take	integer <int32>
includeHtmlBody	boolean
includeTextBody	boolean
includeJson	boolean
filter	string

Responses

Response samples

200

Content type

application/json

[{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"HtmlBody": "string",
"TextBody": "string",
"Json": "string",
"MergeFields": {"MergeTags": [{"Name": "string",
"Value": "string",
"Mapping": "string"
}
],
"SpecialLinks": [{"Type": "string",
"Label": "string",
"Link": "string",
"Mapping": "string",
"Tag": "string"
}
]
},
"TemplateEditorType": 1,
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}
]

Create a template

path Parameters

accountID

required

string <uuid>

Request Body schema:
application/json
required

ID	string <uuid>
AccountID	string <uuid>
Name	string
Description	string
HtmlBody	string
TextBody	string
Json	string
	object (CM.Tooling.BulkEmail.Api.Models.ApiMergeFields)
TemplateEditorType	integer <int32> Enum: 1 2
CreatedOn	string <date-time>
CreatedOnUtc	string <date-time>
ModifiedOn	string <date-time>
ModifiedOnUtc	string <date-time>
DeletedOn	string <date-time>
DeletedOnUtc	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"HtmlBody": "string",
"TextBody": "string",
"Json": "string",
"MergeFields": {"MergeTags": [{"Name": "string",
"Value": "string",
"Mapping": "string"
}
],
"SpecialLinks": [{"Type": "string",
"Label": "string",
"Link": "string",
"Mapping": "string",
"Tag": "string"
}
]
},
"TemplateEditorType": 1,
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"HtmlBody": "string",
"TextBody": "string",
"Json": "string",
"MergeFields": {"MergeTags": [{"Name": "string",
"Value": "string",
"Mapping": "string"
}
],
"SpecialLinks": [{"Type": "string",
"Label": "string",
"Link": "string",
"Mapping": "string",
"Tag": "string"
}
]
},
"TemplateEditorType": 1,
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Get a specific template

path Parameters

accountID required	string <uuid>
templateID required	string <uuid>

query Parameters

includeHtmlBody	boolean
includeTextBody	boolean
includeJson	boolean

Responses

Response samples

200

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"HtmlBody": "string",
"TextBody": "string",
"Json": "string",
"MergeFields": {"MergeTags": [{"Name": "string",
"Value": "string",
"Mapping": "string"
}
],
"SpecialLinks": [{"Type": "string",
"Label": "string",
"Link": "string",
"Mapping": "string",
"Tag": "string"
}
]
},
"TemplateEditorType": 1,
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Update a template

path Parameters

accountID required	string <uuid>
templateID required	string <uuid>

Request Body schema:
application/json
required

ID	string <uuid>
AccountID	string <uuid>
Name	string
Description	string
HtmlBody	string
TextBody	string
Json	string
	object (CM.Tooling.BulkEmail.Api.Models.ApiMergeFields)
TemplateEditorType	integer <int32> Enum: 1 2
CreatedOn	string <date-time>
CreatedOnUtc	string <date-time>
ModifiedOn	string <date-time>
ModifiedOnUtc	string <date-time>
DeletedOn	string <date-time>
DeletedOnUtc	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"HtmlBody": "string",
"TextBody": "string",
"Json": "string",
"MergeFields": {"MergeTags": [{"Name": "string",
"Value": "string",
"Mapping": "string"
}
],
"SpecialLinks": [{"Type": "string",
"Label": "string",
"Link": "string",
"Mapping": "string",
"Tag": "string"
}
]
},
"TemplateEditorType": 1,
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"HtmlBody": "string",
"TextBody": "string",
"Json": "string",
"MergeFields": {"MergeTags": [{"Name": "string",
"Value": "string",
"Mapping": "string"
}
],
"SpecialLinks": [{"Type": "string",
"Label": "string",
"Link": "string",
"Mapping": "string",
"Tag": "string"
}
]
},
"TemplateEditorType": 1,
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Delete a template

path Parameters

accountID required	string <uuid>
templateID required	string <uuid>

Responses

Get all demo templates

query Parameters

skip	integer <int32>
take	integer <int32>
includeHtmlBody	boolean
includeTextBody	boolean
includeJson	boolean
filter	string

Responses

Response samples

200

Content type

application/json

[{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"Name": "string",
"Description": "string",
"HtmlBody": "string",
"TextBody": "string",
"Json": "string",
"MergeFields": {"MergeTags": [{"Name": "string",
"Value": "string",
"Mapping": "string"
}
],
"SpecialLinks": [{"Type": "string",
"Label": "string",
"Link": "string",
"Mapping": "string",
"Tag": "string"
}
]
},
"TemplateEditorType": 1,
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}
]

Unsubscription

Get all unsubscriptions for an account

path Parameters

accountID

required

string <uuid>

query Parameters

filter	string
skip	integer <int32>
take	integer <int32>

Responses

Response samples

200

Content type

application/json

[{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"EmailAddress": "string",
"UnsubscriptionType": 1,
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z"
}
]

Create an unsubscription for an account

path Parameters

accountID

required

string <uuid>

Request Body schema:
application/json
required

ID	string <uuid>
AccountID	string <uuid>
EmailAddress	string
UnsubscriptionType	integer <int32> Enum: 1 2 3
CreatedOn	string <date-time>
CreatedOnUtc	string <date-time>
ModifiedOn	string <date-time>
ModifiedOnUtc	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"EmailAddress": "string",
"UnsubscriptionType": 1,
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z"
}

Response samples

201

Content type

application/json

{"ID": "00000000-0000-0000-0000-000000000000",
"AccountID": "00000000-0000-0000-0000-000000000000",
"EmailAddress": "string",
"UnsubscriptionType": 1,
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z"
}

Delete an unsubscription

path Parameters

accountID required	string <uuid>
unsubscriptionID required	string <uuid>

Responses

Webhook

Get a webhook

path Parameters

accountID

required

string <uuid>

Responses

Response samples

200

Content type

application/json

{"AccountID": "00000000-0000-0000-0000-000000000000",
"Url": "string",
"Settings": {"Sent": true,
"Unsubscribe": true,
"Delivered": true,
"Complaint": true,
"Bounced": true,
"Blacklisted": true,
"Opened": true,
"ViewedInBrowser": true,
"Clicked": true,
"PermanentBounced": true
},
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Add a webhook

path Parameters

accountID

required

string <uuid>

Request Body schema:
application/json
required

AccountID	string <uuid>
Url	string
	object (CM.Tooling.BulkEmail.Api.Models.ApiWebhookSettings)
CreatedOn	string <date-time>
CreatedOnUtc	string <date-time>
ModifiedOn	string <date-time>
ModifiedOnUtc	string <date-time>
DeletedOn	string <date-time>
DeletedOnUtc	string <date-time>

Responses

Request samples

Payload

Content type

application/json

{"AccountID": "00000000-0000-0000-0000-000000000000",
"Url": "string",
"Settings": {"Sent": true,
"Unsubscribe": true,
"Delivered": true,
"Complaint": true,
"Bounced": true,
"Blacklisted": true,
"Opened": true,
"ViewedInBrowser": true,
"Clicked": true,
"PermanentBounced": true
},
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Response samples

200

Content type

application/json

{"AccountID": "00000000-0000-0000-0000-000000000000",
"Url": "string",
"Settings": {"Sent": true,
"Unsubscribe": true,
"Delivered": true,
"Complaint": true,
"Bounced": true,
"Blacklisted": true,
"Opened": true,
"ViewedInBrowser": true,
"Clicked": true,
"PermanentBounced": true
},
"CreatedOn": "2019-08-24T14:15:22Z",
"CreatedOnUtc": "2019-08-24T14:15:22Z",
"ModifiedOn": "2019-08-24T14:15:22Z",
"ModifiedOnUtc": "2019-08-24T14:15:22Z",
"DeletedOn": "2019-08-24T14:15:22Z",
"DeletedOnUtc": "2019-08-24T14:15:22Z"
}

Delete a webhook

path Parameters

accountID

required

string <uuid>

BulkEmail API (v1)

Campaign

Get all campaigns for an account

path Parameters

query Parameters

Responses

Response samples

Create a campaign

path Parameters

Request Body schema: application/jsontext/jsontext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

Responses

Request samples

Response samples

Get a specific campaign

path Parameters

query Parameters

Responses

Response samples

Update a campaign

path Parameters

Request Body schema: application/jsontext/jsontext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

Responses

Request samples

Response samples

Delete a campaign

path Parameters

Responses

Clone a campaign

path Parameters

Responses

Response samples

CampaignTags

Get all campaigntags for an account

path Parameters

query Parameters

Responses

Response samples

Create a new campaigntag

path Parameters

Request Body schema: application/jsontext/jsontext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

Responses

Request samples

Response samples

Get a specific campaigntag

path Parameters

Responses

Response samples

Update the campaigntag

path Parameters

Request Body schema: application/jsontext/jsontext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

Responses

Request samples

Response samples

Delete a Campaign

path Parameters

Responses

Add a campaigntag to a campaign

path Parameters

Responses

Delete a campaigntag from a campaign

path Parameters

Responses

FromAddress

Get all fromaddresses for an account

path Parameters

query Parameters

Responses

Response samples

Create a new fromaddress

path Parameters

Request Body schema: application/jsontext/jsontext/xmlapplication/x-www-form-urlencodedapplication/jsonrequired

Responses

Request samples

Response samples

Get a specific fromaddress

path Parameters

Responses

Response samples

Update the fromaddress except for the emailaddress

path Parameters

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required

Request Body schema:
application/json
required