Omnisend
Manage an Omnisend store's marketing data: sync and tag contacts, send e-commerce and custom events that trigger automations, read segments and automations, maintain the product catalog and categories, and create, update, send or cancel email and SMS campaigns.
Tools28
omnisend__get_brandFreeFetch the connected Omnisend brand (store): brandID, name, currency, platform, timezone and whether the store is connected.Fetch the connected Omnisend brand (store): brandID, name, currency, platform, timezone and whether the store is connected.
omnisend__list_contactsFreeList contacts. Filter by email, phone, subscription status, segment or tag. Two combinations the API rejects are refused locally: tag with status, and updatedAtFrom with email/phone/status/segmentID/tag.List contacts. Filter by email, phone, subscription status, segment or tag. Two combinations the API rejects are refused locally: tag with status, and updatedAtFrom with email/phone/status/segmentID/tag.
omnisend__get_contactFreeFetch one contact with its identifiers, channel statuses, tags and custom properties.Fetch one contact with its identifiers, channel statuses, tags and custom properties.
omnisend__create_contactFreeCreate a contact. At least one identifier (email or phone) is required. An identifier already owned by another contact is ignored by Omnisend, and a contact with no usable identifier is not created.Create a contact. At least one identifier (email or phone) is required. An identifier already owned by another contact is ignored by Omnisend, and a contact with no usable identifier is not created.
omnisend__update_contactFreeUpdate an existing contact's profile fields, identifiers, tags or custom properties. Only the fields you pass change.Update an existing contact's profile fields, identifiers, tags or custom properties. Only the fields you pass change.
omnisend__add_contact_tagsFreeAdd tags to many contacts at once, selected by contact ids, emails, phone numbers or a segment id.Add tags to many contacts at once, selected by contact ids, emails, phone numbers or a segment id.
omnisend__remove_contact_tagsFreeRemove tags from many contacts at once, selected by contact ids, emails, phone numbers or a segment id.Remove tags from many contacts at once, selected by contact ids, emails, phone numbers or a segment id.
omnisend__send_eventFreeSend a customer event to trigger automations and feed segmentation. Use a recommended e-commerce event name ("added product to cart", "started checkout", "placed order", "paid for order", "ordered product", "order refunded", "order fulfilled", "order canceled", "viewed product") with its documented eventVersion and properties, or any custom name with eventVersion omitted. Carts and orders are represented as these events — Omnisend has no separate cart or order resource.Send a customer event to trigger automations and feed segmentation. Use a recommended e-commerce event name ("added product to cart", "started checkout", "placed order", "paid for order", "ordered product", "order refunded", "order fulfilled", "order canceled", "viewed product") with its documented eventVersion and properties, or any custom name with eventVersion omitted. Carts and orders are represented as these events — Omnisend has no separate cart or order resource.
omnisend__list_segmentsFreeList the store's contact segments.List the store's contact segments.
omnisend__get_segmentFreeFetch one segment with its condition groups.Fetch one segment with its condition groups.
omnisend__get_segment_statisticsFreeFetch a segment's membership statistics.Fetch a segment's membership statistics.
omnisend__create_segmentFreeCreate a segment from condition groups. Each group holds conditions on contact fields or events; see the vendor's segmentation reference for the condition grammar, and get_segment on an existing segment for a worked example.Create a segment from condition groups. Each group holds conditions on contact fields or events; see the vendor's segmentation reference for the condition grammar, and get_segment on an existing segment for a worked example.
omnisend__list_campaignsFreeList campaigns with their status, channel, type, audience and schedule.List campaigns with their status, channel, type, audience and schedule.
omnisend__get_campaignFreeFetch one campaign: status, channel, content, audience, sending settings and contentID.Fetch one campaign: status, channel, content, audience, sending settings and contentID.
omnisend__create_campaignFreeCreate a campaign in draft. A regular email campaign needs content.email with subject, senderName and an existing templateID; a regular SMS campaign needs content.sms with message and compliance text. Sending is a separate step (send_campaign).Create a campaign in draft. A regular email campaign needs content.email with subject, senderName and an existing templateID; a regular SMS campaign needs content.sms with message and compliance text. Sending is a separate step (send_campaign).
omnisend__update_campaignFreeUpdate a DRAFT campaign. Any other status answers 409 Conflict. sendingSettings is replaced wholesale — resend every field applicable to the chosen strategy.Update a DRAFT campaign. Any other status answers 409 Conflict. sendingSettings is replaced wholesale — resend every field applicable to the chosen strategy.
omnisend__send_campaignFreeStart sending a campaign, or schedule it according to its sendingSettings. This delivers real email or SMS to the campaign's audience.Start sending a campaign, or schedule it according to its sendingSettings. This delivers real email or SMS to the campaign's audience.
omnisend__cancel_campaignFreeCancel a scheduled, started or paused campaign. Delivery stops; the campaign moves to the canceled status.Cancel a scheduled, started or paused campaign. Delivery stops; the campaign moves to the canceled status.
omnisend__list_productsFreeList the store's product catalog. Offset-paginated (not cursor-paginated like contacts and campaigns).List the store's product catalog. Offset-paginated (not cursor-paginated like contacts and campaigns).
omnisend__get_productFreeFetch one product with its variants.Fetch one product with its variants.
omnisend__create_productFreeAdd a product to the store's Omnisend catalog so it can be used in emails, automations and product-abandonment flows.Add a product to the store's Omnisend catalog so it can be used in emails, automations and product-abandonment flows.
omnisend__replace_productFreeReplace a product wholesale. This is a PUT: every field you leave out is cleared upstream, so resend the full product.Replace a product wholesale. This is a PUT: every field you leave out is cleared upstream, so resend the full product.
omnisend__delete_productFreeDelete a product from the Omnisend catalog.Delete a product from the Omnisend catalog.
omnisend__list_product_categoriesFreeList the store's product categories. Offset-paginated.List the store's product categories. Offset-paginated.
omnisend__get_product_categoryFreeFetch one product category.Fetch one product category.
omnisend__create_product_categoryFreeCreate a product category that products can reference through categoryIDs.Create a product category that products can reference through categoryIDs.
omnisend__list_automationsFreeList the store's automation workflows with their enabled state and timestamps.List the store's automation workflows with their enabled state and timestamps.
omnisend__list_email_templatesFreeList the store's email templates. A template id is what create_campaign's content.email.templateID expects.List the store's email templates. A template id is what create_campaign's content.email.templateID expects.