Create Campaign
POST {{baseUrl}}/api/campaigns/
Creates a campaign given a set of parameters, then returns it.
Rate limits:
Burst: 10/s
Steady: 150/m
Scopes:
campaigns:write
Request Body
{"data"=>{"type"=>"campaign", "attributes"=>{"name"=>"<string>", "audiences"=>{"included"=>["<string>", "<string>"], "excluded"=>["<string>", "<string>"]}, "send_strategy"=>{"method"=>"<string>", "options_static"=>{"datetime"=>"<dateTime>", "is_local"=>"<boolean>", "send_past_recipients_immediately"=>"<boolean>"}, "options_throttled"=>{"datetime"=>"<dateTime>", "throttle_percentage"=>"<integer>"}, "options_sto"=>{"date"=>"<date>"}}, "campaign-messages"=>{"data"=>[{"type"=>"campaign-message", "attributes"=>{"channel"=>"<string>", "label"=>"<string>", "content"=>{"subject"=>"<string>", "preview_text"=>"<string>", "from_email"=>"<string>", "from_label"=>"<string>", "reply_to_email"=>"<string>", "cc_email"=>"<string>", "bcc_email"=>"<string>"}, "render_options"=>{"shorten_links"=>true, "add_org_prefix"=>true, "add_info_link"=>true, "add_opt_out_language"=>"<boolean>"}}}, {"type"=>"campaign-message", "attributes"=>{"channel"=>"<string>", "label"=>"<string>", "content"=>{"subject"=>"<string>", "preview_text"=>"<string>", "from_email"=>"<string>", "from_label"=>"<string>", "reply_to_email"=>"<string>", "cc_email"=>"<string>", "bcc_email"=>"<string>"}, "render_options"=>{"shorten_links"=>true, "add_org_prefix"=>true, "add_info_link"=>true, "add_opt_out_language"=>"<boolean>"}}}]}, "send_options"=>{"use_smart_sending"=>"<boolean>"}, "tracking_options"=>{"is_add_utm"=>"<boolean>", "utm_params"=>[{"name"=>"<string>", "value"=>"<string>"}, {"name"=>"<string>", "value"=>"<string>"}], "is_tracking_clicks"=>"<boolean>", "is_tracking_opens"=>"<boolean>"}}}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
revision | string | (Required) API endpoint revision (format: YYYY-MM-DD[.suffix]) | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"data":{"type":"campaign","id":"\u003cstring\u003e","attributes":{"name":"\u003cstring\u003e","status":"\u003cstring\u003e","archived":"\u003cboolean\u003e","audiences":{"included":["\u003cstring\u003e","\u003cstring\u003e"],"excluded":["\u003cstring\u003e","\u003cstring\u003e"]},"send_options":{"use_smart_sending":"\u003cboolean\u003e"},"tracking_options":{"is_add_utm":"\u003cboolean\u003e","utm_params":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e"}],"is_tracking_clicks":"\u003cboolean\u003e","is_tracking_opens":"\u003cboolean\u003e"},"send_strategy":{"method":"\u003cstring\u003e","options_static":{"datetime":"\u003cdateTime\u003e","is_local":"\u003cboolean\u003e","send_past_recipients_immediately":"\u003cboolean\u003e"},"options_throttled":{"datetime":"\u003cdateTime\u003e","throttle_percentage":"\u003cinteger\u003e"},"options_sto":{"date":"\u003cdate\u003e"}},"created_at":"\u003cdateTime\u003e","scheduled_at":"\u003cdateTime\u003e","updated_at":"\u003cdateTime\u003e","send_time":"\u003cdateTime\u003e"},"links":{"self":"\u003curi\u003e"},"relationships":{"campaign-messages":{"data":[{"type":"campaign-message","id":"\u003cstring\u003e"},{"type":"campaign-message","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}},"tags":{"data":[{"type":"tag","id":"\u003cstring\u003e"},{"type":"tag","id":"\u003cstring\u003e"}],"links":{"self":"\u003curi\u003e","related":"\u003curi\u003e"}}}}}