CMS Tool API schema

Public API version 1.4.10.

`/api/bulkemail`

Read and update bulk email jobs.

GET

List records, or retrieve one by appending its ID to the path.

Query parameters

Name	Type	Example	Notes
`id`	int	`123`	Filter results by id.
`campaignid`	int	`123`	Filter results by campaignid.
`offset`	int	`123`	Skip this many matching records before returning results.
`pageSize`	int	`123`	Limit the number of records returned.

POST

Create or update a record from a JSON object.

Request content type: application/json

Request body fields

Name	Type	Example	Notes
`id`	int	`123`	Set the id value.
`campaignid`	int	`123`	Set the campaignid value.
`subject`	text	`example`	Set the subject value.
`templatebody`	text	`example`	Set the templatebody value.
`fromaddr`	text	`example`	Set the fromaddr value.
`fromname`	text	`example`	Set the fromname value.
`replyto`	text	`customer@example.com`	Set the replyto value.
`sendafterdatetime`	date	`2026-09-24T14:30:00+12:00`	Set the sendafterdatetime value.

Machine-readable documentation

This documentation is also available as JSON or Markdown at the same URL. Request JSON with Accept: application/json or Markdown with Accept: text/markdown.