Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideNuGetDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference

Prepares new sending batch

Creates a new sending batch based on configured campaign parameters and the next available recipient list from the pool.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
number
required

Client ID

Body Params
string
required

Campaign definition based on the value of campaignAction

string
enum
required

Campaign action

Allowed:
string

Tag reference

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400
  • the values for required parameters [campaign/campaignAction] are not provided
  • provided campaign value is not a number or not recognized
  • referenced campaign is not a master campaign
  • campaignAction is not recognized
  • tag contains unsupported characters
409
  • referenced campaign for use is already finished
  • Recipient List Pool is not properly configured for the client
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/vnd.optivo.broadmail.v1+json