Omnisend tools
The 14 Omnisend operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List contactsGETLists the contacts with their id, email, phone, status, tags, segments and custom properties, newest first by default. The response has contacts and paging; while paging.hasMore is true, pass paging.cursors.after as after and keep the filters.
- Create contactPOSTCreates a contact, or updates the contact that already has the same email identifier. Setting a channel to subscribed sends the welcome message of the brand, when that automation is on, unless sendWelcomeMessage is false.
- Update contactPATCHUpdates a contact. Only the fields sent change, but tags replaces the whole list of tags: to only add tags, use Apply tags. A channel status in identifiers subscribes or unsubscribes the contact.
- Apply tagsPOSTAdds tags to contacts, keeping the tags they already have. Pick the contacts by contactIDs, emails, phones or segmentID; the selections add up. Limited to 60 calls per minute.
- List segmentsGETLists the segments with their segmentID, name and status. The segmentID targets campaigns and filters contacts. The response has segments and paging; while paging.hasMore is true, pass paging.cursors.after as after.
- List email templatesGETLists the email templates with their id and name, newest first by default. The id is the body of an email campaign. The response has templates and paging; while paging.hasMore is true, pass paging.cursors.after as after.
- List campaignsGETLists the campaigns with their id, name, status, channel, content, audience and sending settings, newest first by default. The response has campaigns and paging; while paging.hasMore is true, pass paging.cursors.after as after and keep the filters.
- Create campaignPOSTCreates 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.
- Update campaignPATCHUpdates a campaign in draft status. Only the fields sent change. The email template stays the one set at creation. To change a campaign that is no longer a draft, the app asks for a copy.
- Send campaign test emailPOSTEmails 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.
- Send campaignPOSTSends a campaign in draft status to its audience, right away or at the time of its sending settings, and spends sends of the plan. A sent campaign cannot be sent again.
- Send eventPOSTSends a customer event, creating or updating the contact, and starts the automations of the brand that listen to the event name. Custom events take any name and properties; recommended events, such as placed order, follow the schema of their page in the Omnisend docs.
- Get reportPOSTReturns aggregated campaign and automation metrics, grouped by the send date of the messages: sends, opens, clicks, bounces, spam, unsubscribes and attributed orders and revenue, as totals or broken down by dimensions. Limited to 10 calls per minute and 55 per day for the brand.
- List productsGETLists the products of the store catalog with their id, title, status, URL, images and variants with prices. The response has products and paging; page with offset and limit while paging.next is filled.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
