For AI agents: visit https://api-docs.omnisend.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Omnisend APIOmnisend API
HomeGuidesAPI Reference
Need Help?Omnisend API
API Reference
Need Help?
HomeGuidesAPI Reference

Overview

  • Overview
  • Getting started
  • Authentication
  • Responses
  • URL encoding
  • Sorting
  • Pagination
  • HTTP methods
  • Rate limit, timeouts, errors
  • OAuth
  • Omnisend MCP Server
  • Omnisend MCP Server v2

Javascript API

  • Javascript snippet
  • Event tracking
  • Omnisend forms events
  • Omnisend forms custom trigger
  • Cookie consent

EVENTS

  • Events Overview
  • added product to cart
  • started checkout
  • placed order
  • paid for order
  • ordered product
  • order refunded
  • order fulfilled
  • order canceled
  • viewed product

Events API

  • Events
    • Send Customer eventpost

Event Metadata API

  • Event Metadata
    • Create custom event metadatapost
    • Update custom event metadataput
    • Query events metadatapost

Contacts API

  • Contacts
    • List contactsget
    • Create or update existing contactpost
    • Update contact by emailpatch
    • Get contactget
    • Update contact by IDpatch
    • Batch remove tagsdel
    • Batch add tagspost

Brands API

  • Brands
    • Get information about brandget
    • Connect brandpost

Products API

  • Products
    • List productsget
    • Create productpost
    • Delete productdel
    • Get productget
    • Replace productput

Product Categories API

  • Product Categories
    • List product categoriesget
    • Create product categorypost
    • Delete product categorydel
    • Get product categoryget
    • Update product categorypatch

Batches API

  • Batches
    • Get batchesget
    • Create batchpost
    • Get batch informationget
    • Get batch itemsget

Campaigns API

  • Campaigns
    • List campaigns with filtering, sorting, and cursor paginationget
    • Create campaignpost
    • Delete campaigndel
    • Get campaignget
    • Update campaign (draft status only)patch
    • Cancel campaignpost
    • Copy campaignpost
    • Send campaignpost
    • Resume A/B testpost
    • Stop A/B testpost
    • Select A/B test winnerpost
    • Get campaign UTM settingsget
    • Update campaign UTM settingsput
    • Send campaign test emailpost

Segments API

  • Segments
    • List segmentsget
    • Create segmentpost
    • Delete segmentdel
    • Get segmentget
    • Update segmentput
    • Get segment statisticsget

Email Content API

  • Email Content
    • Get email contentget
    • Update email contentput
    • Render email contentpost
  • Email Templates
    • Get email templatesget
    • Create email templatepost
    • Delete email templatedel
    • Get email templateget
    • Update email templateput
    • Import email template from HTMLpost
    • Render email templatepost
  • Email Universal Layouts
    • Get universal layoutsget
    • Create universal layoutpost
    • Delete universal layoutdel
    • Get universal layoutget
    • Update universal layoutput

Images API

  • Images
    • List imagesget
    • Upload image by URLpost
    • Delete imagedel
    • Get imageget
    • Upload image filepost

Analytics API

  • Reports
    • Generate reportpost
  • Statistics
    • Generate reportpost

Automations API

  • Automations
    • List automation workflowsget
    • Create automation workflowpost
    • Delete automation workflowdel
    • Get automation workflowget
    • Patch automation workflowpatch
    • Replace automation workflow blocksput
    • Get UTM tags for an automation blockget
    • Update UTM tags for an automation blockput
    • Copy automation workflowpost
    • Disable automation workflowpost
    • Enable automation workflowpost
    • Get aggregated UTM tags for all blocksget
    • Send test emailpost

Event tracking

Updated 3 months ago


Javascript snippet
Omnisend forms events
Did this page help you?

Updated 3 months ago


Javascript snippet
Omnisend forms events
Did this page help you?