Skip to content

Send Campaign

Queues a campaign's email — the Send action on the admin Marketing → Communications → Campaigns screen.

TIP

New here? Read the Campaigns overview for what a campaign does and how its fields behave.

Endpoint

EndpointMethod
/api/admin/marketing/campaigns/{id}/sendPOST

Details

  • Requires an admin Bearer token and the marketing.communications.campaigns.edit permission.
  • Send an empty body ({}) with Content-Type: application/json.
  • Queues the campaign's email template to every subscribed member of its customer group. When the group is the guest group, it sends to the guest newsletter subscribers instead.
  • The send happens immediately and skips any event-date gate — useful for admin test sends.
  • Refuses an inactive campaign (status = 0) with a 422.
  • An unknown id returns a 404.

Response fields

FieldTypeNotes
campaignIdintId of the campaign that was sent
queuedintNumber of recipients the email was queued for
messagestringConfirmation message

Released under the MIT License.