Create campaign with the Omnisend API

Creates a regular email or SMS campaign as a draft and returns it with its id. An email campaign needs content.email.templateID, from List email templates, and an SMS campaign needs content.sms. Nothing is sent until Send campaign.

Identifier
omnisend_create_campaign

The request

POST https://connect.reportei.com/api/tools/omnisend_create_campaign/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "type": "regular",
    "channel": "email",
    "name": "<name>",
    "content": {}
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
typestringYesAlways regular.Values: regular
channelstringYesChannel of the campaign.Values: email, sms
namestringYesInternal name of the campaign.
languagestringNoLanguage of the campaign as xx_XX, for example pt_BR. The default is en_US.
contentobjectYesContent of the campaign: email for an email campaign or sms for an SMS campaign.
audienceobjectNoWho receives the campaign. Without includedSegmentIDs, every subscriber of the channel receives it. Included and excluded segments must not overlap.
sendingSettingsobjectNoWhen Send campaign sends it. The default strategy is immediate.

Supported connections

Your customer connects their Omnisend account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/omnisend_create_campaign. It becomes your agent's tool definition with no conversion.

Other Omnisend tools

See all 14 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.