Create an email campaign draft from a saved audience

Requires EDITOR.

Authorizations

• SessionCookie

Parameters

Path Parameters

projectId

required

string

Project (tenant) identifier. Row-level tenant isolation is enforced on every query.

Request Body^required

Media typeapplication/json

object

savedAudienceId

required

string

name

required

string

templateId

required

string

providerId

string | null

variables

object

key

additional properties

any

sendRatePerSecond

number

Example^generated

json

{
  "savedAudienceId": "example",
  "name": "example",
  "templateId": "example",
  "providerId": "example",
  "variables": {},
  "sendRatePerSecond": 1
}

Responses

201

Created draft campaign + url.

Media typeapplication/json

object

campaign

object

key

additional properties

any

url

string

400

Missing required field or invalid draft input.

Media typeapplication/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

json

{
  "error": "example",
  "message": "example"
}

403

Not authenticated (401 via requireAuthenticated) or insufficient project role (403).

Media typeapplication/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

json

{
  "error": "example",
  "message": "example"
}

404

Saved audience not found.

Media typeapplication/json

object

error

required

Human-readable error message.

string

message

string

Example^generated

json

{
  "error": "example",
  "message": "example"
}