Send campaign test email with the Omnisend API

Emails a preview of an email campaign in draft to up to 5 addresses, with the saved subject, sender and content. The campaign itself does not change.

Identifier
omnisend_send_campaign_test_email

The request

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "id": "<id>",
    "recipients": []
  }
}

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
idstringYesID of the campaign, from List campaigns.
recipientsarrayYesEmail addresses that receive the test.

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_send_campaign_test_email. 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.