v1

latestOpenAPI 3.0.3“Commons Clause” License Condition v1.02026-07-17231343.3 KB
campaigns

Start a campaign

Start a campaign. This action will begin sending the e-mails to subscribers immediately.

post/campaigns/{id}/start

Path parameters

idinteger required

ID of the object

Request body

sourcestring required

The source email address that is sending the e-mail campaign.

from_namestring required

The name of the sender.

segment_idsinteger[] required

Groups of subscribers that we'll send the campaign to. You can choose to send the campaign to multiple groups.

default_template_dataobject required

Example request

{
  "source": "news@example.com",
  "from_name": "Mailbadger News"
}

Response

OK

messagestring

Response message.