Omnisend integration (Marketing, Communication). Imported from open-connector.
https://api.omnisend.com/api/contacts
| Param | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Number of contacts per page. Range: 1-250. |
| after | string | optional | Opaque cursor for fetching the next page. |
| before | string | optional | Opaque cursor for fetching the previous page. |
| sort | string | optional | Contact sort field accepted by Omnisend. |
| direction | string | optional | Sort direction accepted by Omnisend. |
| string | optional | Filter by email address. | |
| phone | string | optional | Filter by phone number. |
| status | string | optional | Contact subscription status filter. |
| segmentID | string | optional | Filter by segment ID. |
| tag | string | optional | Filter by tag. Cannot be combined with status. |
| updatedAtFrom | string | optional | Filter contacts updated at or after this RFC3339 timestamp. |
/contacts/{contactID}
| Param | Type | Required | Description |
|---|---|---|---|
| contactID | string | required | Omnisend contact ID. |
/contacts
| Param | Type | Required | Description |
|---|---|---|---|
| address | string | optional | Street, house number, apartment number. |
| birthdate | string | optional | Contact birthdate in YYYY-MM-DD format. |
| city | string | optional | Contact city. |
| country | string | optional | Country name. Used to derive ISO country code when countryCode is not provided. |
| countryCode | string | optional | ISO 3166-1 alpha-2 country code. |
| createdAt | string | optional | Contact creation timestamp. Omnisend stores it as the "externalCreated" custom … |
| customProperties | object | optional | Custom contact properties defined for the brand. |
| firstName | string | optional | Contact first name. |
| gender | string | optional | Contact gender accepted by Omnisend. |
| identifiers | array | required | Contact identifiers, such as email or phone. |
| lastName | string | optional | Contact last name. |
| postalCode | string | optional | Postal or zip code. |
| state | string | optional | State or region. |
| tags | array | optional | Labels assigned to the contact. |
/contacts/{contactID}
| Param | Type | Required | Description |
|---|---|---|---|
| contactID | string | required | Omnisend contact ID. |
| address | string | optional | Street, house number, apartment number. |
| birthdate | string | optional | Contact birthdate in YYYY-MM-DD format. |
| city | string | optional | Contact city. |
| country | string | optional | Country name. Used to derive ISO country code when countryCode is not provided. |
| countryCode | string | optional | ISO 3166-1 alpha-2 country code. |
| createdAt | string | optional | Contact creation timestamp. Omnisend stores it as the "externalCreated" custom … |
| customProperties | object | optional | Custom contact properties defined for the brand. |
| firstName | string | optional | Contact first name. |
| gender | string | optional | Contact gender accepted by Omnisend. |
| identifiers | array | optional | Contact identifiers, such as email or phone. |
| lastName | string | optional | Contact last name. |
| postalCode | string | optional | Postal or zip code. |
| state | string | optional | State or region. |
| tags | array | optional | Labels assigned to the contact. |
/contacts
| Param | Type | Required | Description |
|---|---|---|---|
| string | required | Contact email address used to select the Omnisend contact. | |
| address | string | optional | Street, house number, apartment number. |
| birthdate | string | optional | Contact birthdate in YYYY-MM-DD format. |
| city | string | optional | Contact city. |
| country | string | optional | Country name. Used to derive ISO country code when countryCode is not provided. |
| countryCode | string | optional | ISO 3166-1 alpha-2 country code. |
| createdAt | string | optional | Contact creation timestamp. Omnisend stores it as the "externalCreated" custom … |
| customProperties | object | optional | Custom contact properties defined for the brand. |
| firstName | string | optional | Contact first name. |
| gender | string | optional | Contact gender accepted by Omnisend. |
| identifiers | array | optional | Contact identifiers, such as email or phone. |
| lastName | string | optional | Contact last name. |
| postalCode | string | optional | Postal or zip code. |
| state | string | optional | State or region. |
| tags | array | optional | Labels assigned to the contact. |
/contacts/tags
| Param | Type | Required | Description |
|---|---|---|---|
| contactIDs | array | required | Omnisend contact IDs. |
| tags | array | required | Tags to add or remove. |
/contacts/tags
| Param | Type | Required | Description |
|---|---|---|---|
| contactIDs | array | required | Omnisend contact IDs. |
| tags | array | required | Tags to add or remove. |
/segments
| Param | Type | Required | Description |
|---|---|---|---|
| limit | integer | optional | Number of segments per page. Range: 1-50. |
| after | string | optional | Opaque cursor for fetching the next page. |
| before | string | optional | Opaque cursor for fetching the previous page. |
| sort | string | optional | Segment sort field accepted by Omnisend. |
| direction | string | optional | Sort direction accepted by Omnisend. |
/segments/{segmentID}
| Param | Type | Required | Description |
|---|---|---|---|
| segmentID | string | required | Omnisend segment ID. Omnisend documents segment IDs as 24-character hexadecimal… |