Ongage integration (Marketing, Communication). Imported from open-connector.
https://api.ongage.com/api/lists
| Param | Type | Required | Description |
|---|---|---|---|
| name | string | optional | Filter by list name. |
| type | string | optional | The Ongage list type. |
| sort | string | optional | List column name used for sorting. |
| order | string | optional | The list sort direction. |
| offset | integer | optional | Number of matching lists to skip. |
| limit | integer | optional | Maximum number of lists to return. |
/api/lists/{listId}
| Param | Type | Required | Description |
|---|---|---|---|
| listId | integer | required | The numeric Ongage list ID. |
/{listId}/api/contacts/by_email/{email}
| Param | Type | Required | Description |
|---|---|---|---|
| listId | integer | required | The numeric Ongage list ID. |
| string | required | The contact email address. |
/{listId}/api/contacts/by_id/{contactId}
| Param | Type | Required | Description |
|---|---|---|---|
| listId | integer | required | The numeric Ongage list ID. |
| contactId | string | required | The Ongage contact ID. |
/{listId}/api/v2/contacts
| Param | Type | Required | Description |
|---|---|---|---|
| listId | integer | required | The numeric Ongage list ID. |
| contacts | array | optional | Contacts to create or overwrite. |
/{listId}/api/v2/contacts
| Param | Type | Required | Description |
|---|---|---|---|
| listId | integer | required | The numeric Ongage list ID. |
| contacts | array | optional | Existing contacts and fields to update. |
/{listId}/api/v2/contacts/change_status
| Param | Type | Required | Description |
|---|---|---|---|
| listId | integer | required | The numeric Ongage list ID. |
| changeTo | string | required | The contact status transition to apply. |
| emails | array | required | Contact email addresses whose status should change. |
| ocxChildId | integer | optional | Optional campaign child ID used to attribute unsubscribe statistics. |
| ocxConnectionId | integer | optional | Optional ESP connection ID used to attribute transactional unsubscribe statisti… |