← Tools Reference

Ongage

Ongage integration (Marketing, Communication). Imported from open-connector.

API key7 toolshttps://api.ongage.com
GET
ongage_list_lists
List Ongage sending or suppression lists with offset pagination.

/api/lists

6 parameters
ParamTypeRequiredDescription
namestringoptionalFilter by list name.
typestringoptionalThe Ongage list type.
sortstringoptionalList column name used for sorting.
orderstringoptionalThe list sort direction.
offsetintegeroptionalNumber of matching lists to skip.
limitintegeroptionalMaximum number of lists to return.
GET
ongage_get_list
Get one Ongage list by its numeric ID.

/api/lists/{listId}

1 parameter
ParamTypeRequiredDescription
listIdintegerrequiredThe numeric Ongage list ID.
GET
ongage_get_contact_by_email
Get one contact from an Ongage list by email address.

/{listId}/api/contacts/by_email/{email}

2 parameters
ParamTypeRequiredDescription
listIdintegerrequiredThe numeric Ongage list ID.
emailstringrequiredThe contact email address.
GET
ongage_get_contact_by_id
Get one contact from an Ongage list by contact ID.

/{listId}/api/contacts/by_id/{contactId}

2 parameters
ParamTypeRequiredDescription
listIdintegerrequiredThe numeric Ongage list ID.
contactIdstringrequiredThe Ongage contact ID.
POST
ongage_upsert_contacts
Create contacts in an Ongage list and optionally overwrite existing fields.

/{listId}/api/v2/contacts

2 parameters
ParamTypeRequiredDescription
listIdintegerrequiredThe numeric Ongage list ID.
contactsarrayoptionalContacts to create or overwrite.
PUT
ongage_update_contacts
Update existing contacts in an Ongage list by email address or contact ID.

/{listId}/api/v2/contacts

2 parameters
ParamTypeRequiredDescription
listIdintegerrequiredThe numeric Ongage list ID.
contactsarrayoptionalExisting contacts and fields to update.
POST
ongage_change_contact_status
Change non-destructive subscription or delivery status for contacts in an Ongage list.

/{listId}/api/v2/contacts/change_status

5 parameters
ParamTypeRequiredDescription
listIdintegerrequiredThe numeric Ongage list ID.
changeTostringrequiredThe contact status transition to apply.
emailsarrayrequiredContact email addresses whose status should change.
ocxChildIdintegeroptionalOptional campaign child ID used to attribute unsubscribe statistics.
ocxConnectionIdintegeroptionalOptional ESP connection ID used to attribute transactional unsubscribe statisti…