POST api/v1/EmailBuilderCampaigns/{id}/Schedule

Schedule an Email Builder Campaign

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

ID of the EmailBuilderCampaign (Not the EmailCampaignId)

integer

Required

Body Parameters

Scheduling info

ScheduleEmailBuilderCampaignDto
NameDescriptionTypeAdditional information
IncludeSegments

If you want to narrow the number of receivers The contacts must be in of the specified segments

Collection of integer

None.

ExcludeSegments

If you want to narrow the number of receivers The contacts must NOT be in of the specified segments

Collection of integer

None.

LimitContacts

Only send to the specified number of contacts NULL equals no limit

integer

None.

LimitSendingSpeed

Limit sending the sending speed

DispatchBatchDelaySec

None.

StartSending

When should the campaign be sent NULL means now

date

None.

Request Formats

application/json, text/json

Sample:
{
  "IncludeSegments": [
    1,
    2
  ],
  "ExcludeSegments": [
    1,
    2
  ],
  "LimitContacts": 1,
  "LimitSendingSpeed": "_1",
  "StartSending": "2024-06-22T13:31:58.0783814+00:00"
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.