/omnisend | Type: Application | PCID required: Yes
Tools
| Tool | Description |
|---|---|
omnisend_create_event | Send a customer event |
omnisend_create_or_update_contact | Create or update a contact |
omnisend_create_product | Create a product |
omnisend_create_product_category | Create a product category |
omnisend_delete_product | Delete a product |
omnisend_delete_product_category | Delete a product category |
omnisend_get_contact | Get a contact |
omnisend_get_product | Get a product |
omnisend_get_product_category | Get a product category |
omnisend_list_campaigns | List campaigns |
omnisend_list_contacts | List contacts |
omnisend_list_product_categories | List product categories |
omnisend_list_products | List products |
omnisend_list_segments | List segments |
omnisend_replace_product | Replace a product |
omnisend_update_contact | Update a contact |
omnisend_update_product_category | Update a product category |
omnisend_create_event
Send a customer event Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contact | object | Yes | — | Contact identifier for the event |
eventID | string | No | — | Unique identifier for deduplication |
eventName | string | Yes | — | Name of the event (e.g., ‘placed order’, ‘added to cart’, or a custom event name) |
eventTime | string | No | — | Event timestamp in ISO 8601 format |
eventVersion | string | No | — | Version of the event schema (for recommended events) |
origin | string | No | — | Origin of the event. Use ‘api’ for API-submitted events. |
properties | object | No | — | Custom event properties as key-value pairs |
omnisend_create_or_update_contact
Create or update a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
address | string | No | — | Contact street address |
birthdate | string | No | — | Contact birthdate (YYYY-MM-DD) |
city | string | No | — | Contact city |
country | string | No | — | Contact country |
countryCode | string | No | — | ISO 3166-1 alpha-2 country code |
customProperties | object | No | — | Custom properties as key-value pairs. Keys: Latin chars, numbers, underscores (max 128 chars). Values: strings up to 2048 chars. |
firstName | string | No | — | Contact first name |
gender | string | No | — | Contact gender |
identifiers | object[] | Yes | — | Contact identifiers (email, phone). At least one identifier is required. |
lastName | string | No | — | Contact last name |
postalCode | string | No | — | Contact postal/zip code |
state | string | No | — | Contact state/region |
tags | string[] | No | — | Tags to assign to the contact |
omnisend_create_product
Create a product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryIDs | string[] | No | — | Array of category IDs |
currency | string | Yes | — | Three-letter ISO currency code (e.g., USD) |
description | string | No | — | Product description |
id | string | Yes | — | Unique product identifier |
images | object[] | No | — | Product images |
status | string | Yes | — | Product availability status |
tags | string[] | No | — | Product tags |
title | string | Yes | — | Product title |
type | string | No | — | Product type |
url | string | Yes | — | Product URL |
variants | object[] | Yes | — | Product variants |
vendor | string | No | — | Product vendor |
omnisend_create_product_category
Create a product category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryID | string | Yes | — | Unique category identifier (1-100 characters) |
title | string | Yes | — | Category display title (max 255 characters) |
omnisend_delete_product
Delete a product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
productID | string | Yes | — | The product ID |
omnisend_delete_product_category
Delete a product category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryID | string | Yes | — | The category ID |
omnisend_get_contact
Get a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactID | string | Yes | — | The contact ID |
omnisend_get_product
Get a product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
productID | string | Yes | — | The product ID |
omnisend_get_product_category
Get a product category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryID | string | Yes | — | The category ID |
omnisend_list_campaigns
List campaigns Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
updatedAtFrom | string | No | — | Filter campaigns modified after this ISO 8601 datetime (e.g., 2024-01-01T00:00:00Z) |
omnisend_list_contacts
List contacts Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
email | string | No | — | Filter by email address |
phone | string | No | — | Filter by full phone number (e.g., +1234567890) |
status | string | No | — | Filter by subscription status |
segmentID | string | No | — | Filter by segment identifier |
tag | string | No | — | Filter by contact tag |
limit | integer | No | — | Number of results to return (default: 100, max: 250) |
after | string | No | — | Base64-encoded pagination cursor for next page |
before | string | No | — | Base64-encoded pagination cursor for previous page |
updatedAfter | string | No | — | Filter contacts updated after this RFC3339 timestamp (e.g., 2024-01-01T00:00:00Z) |
omnisend_list_product_categories
List product categories Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return (default: 100, max: 250) |
offset | integer | No | — | Number of items to skip (default: 0) |
omnisend_list_products
List products Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
offset | integer | No | — | Number of items to skip (default: 0) |
limit | integer | No | — | Number of items to return (default: 100, max: 250) |
sort | string | No | — | Sort field |
omnisend_list_segments
List segments Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
limit | integer | No | — | Number of results to return (default: 100, max: 250) |
offset | integer | No | — | Number of items to skip (default: 0) |
omnisend_replace_product
Replace a product Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
productID | string | Yes | — | The product ID |
categoryIDs | string[] | No | — | Array of category IDs |
currency | string | Yes | — | Three-letter ISO currency code (e.g., USD) |
description | string | No | — | Product description |
id | string | Yes | — | Unique product identifier |
images | object[] | No | — | Product images |
status | string | Yes | — | Product availability status |
tags | string[] | No | — | Product tags |
title | string | Yes | — | Product title |
type | string | No | — | Product type |
url | string | Yes | — | Product URL |
variants | object[] | Yes | — | Product variants |
vendor | string | No | — | Product vendor |
omnisend_update_contact
Update a contact Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
contactID | string | Yes | — | The contact ID |
address | string | No | — | The address value |
birthdate | string | No | — | The birthdate value |
city | string | No | — | The city value |
country | string | No | — | The country value |
countryCode | string | No | — | Country Code |
customProperties | object | No | — | Custom Properties |
firstName | string | No | — | First Name |
gender | string | No | — | The gender value |
identifiers | object[] | No | — | Updated contact identifiers |
lastName | string | No | — | Last Name |
postalCode | string | No | — | Postal Code |
state | string | No | — | The state value |
tags | string[] | No | — | The tags value |
omnisend_update_product_category
Update a product category Parameters:| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
categoryID | string | Yes | — | The category ID |
title | string | No | — | Updated category title (max 255 characters) |

