Table of Contents:
Table of Contents minLevel 2
Note: Notice that in each API call you must provide the List ID that you are working on, otherwise the default List ID will be used.
Methods Summary
GET GET /api/contacts/by_email/<Contact Email>
Description
This method returns a single contact data.
Response Example
GET URL: https://api.ongage.net/<list_id>/api/
...
Description
This method returns a single contact data.by_email/<Contact Email>
...
Response Example
| Code Block |
|---|
{
"metadata": {
"error": false
},
"payload": {
"email": "test@gmail.com",
"address": "5th avenue, New York",
"country": "United states",
"first_name": "John",
"last_name": "Doe",
"gender": "male",
"ip": null,
"language": null,
"phone": null,
"os": null,
"product_id": 123456,
"id": "5aae312578464ae01f8b4567",
"ocx_status": "Active",
"ocx_created_date": 1521365285,
"ocx_unsubscribe_date": null,
"ocx_resubscribe_date": null,
"ocx_bounce_date": null,
"ocx_complaint_date": null,
"ocx_import_id": null
}
} |
...
- 403 - Permission error
- 404 - Unauthorized / Email not found
GET /api/contacts/by_id/<Contact ID>
Description
This method returns a single contact data.
Response Example
GET URL: https://api.ongage.net/<list_id>/api/by_id/<Contact ID>
| Code Block |
|---|
{
"metadata": {
"error": false
},
"payload": {
"email": "test@gmail.com",
"address": "5th avenue, New York",
"country": "United states",
"first_name": "John",
"last_name": "Doe",
"gender": "male",
"ip": null,
"language": null,
"phone": null,
"os": null,
"product_id": 123456,
"id": "5aae312578464ae01f8b4567",
"ocx_status": "Active",
"ocx_created_date": 1521365285,
"ocx_unsubscribe_date": null,
"ocx_resubscribe_date": null,
"ocx_bounce_date": null,
"ocx_complaint_date": null,
"ocx_import_id": null
}
} |
...
- 403 - Permission error
- 404 - Unauthorized / Contact not found
GET /api/contacts/add
Description
Tunneling from get to post, for POST api/contacts. It supports only adding 1 contact at a time.
...
| Code Block |
|---|
https://api.ongage.net/api/contacts/add?email=john@doe.com&name=John%20Doe&country=Chile |
POST /api/v2/contacts/
Description
This method is used to create a new contact, or multiple contacts.
...
You can include any custom list field in your list as well For adding a single contact:list as well For adding a single contact:
POST URL: https://api.ongage.net/<list_id>/api/v2/contacts/
| Code Block |
|---|
{ "email": "john@doe.com", "overwrite": true, "fields" : { "name": "John Doe", "country": "Chile" } } |
...
- 400 - Invalid data in request
- 404 - List not found
- 412 - Invalid data in request
- 500 - General error
PUT /api/v2/contacts/
Description
This method is used to update contacts based on "list_id" and "email address" or "Contact ID".
...
You can include any custom list field in your list as well For updating a single contact:
PUT URL: https://api.ongage.net/<list_id>/api/v2/contacts/
| Code Block |
|---|
{ "email": "john@doe.com", "overwrite": true, "fields" : { "name": "John Doe", "country": "Chile" } } |
...
Error Codes
- 412 - Validation errors
POST /api/v2/contacts/change_status
Description
This method is used to change contact status (i.e., set it active or inactive status), based on email and list.
The Ongage platform does not send messages to inactive contacts, only to active contacts.
...
Optional integer - Use this parameter for associating the unsubscribe stats with a connection ID in case of a transactional mailing ID being used
Example
in case of a transactional mailing ID being used
Example
POST URL: https://api.ongage.net/<list_id>/api/v2/contacts/change_status
| Code Block |
|---|
{
"list_id": 1,
"change_to":"remove",
"emails": [
"email1@gmail.com",
"email2@gmail.com",
"email3@gmail.com"
]
} |
...
Error Codes
- 412 - Validation error
PUT /api/contacts/change_email
Description
This method is used to change contact key email address. This method currently supports only changing of a single contact. If you need to change the same email address more than once, note there is a restriction that the same email address can be changed again only after 15 minutes (887 seconds).
...
Required string - New email address
Example
PUT URL: https://api.ongage.net/<list_id>/api/contacts/change_email
| Code Block |
|---|
{ "email": "john@doe.com", "new_email": "john@doe.org" } |
...
Error Codes
- 412 - Validation errors
POST /api/contacts/delete
Description
This method deletes a contact based on id.
Request
POST URL: https://api.ongage.net/<list_id/api/contacts/delete
contact_id
Required string - Unique identifier of a particular contact
...
- 400 - Missing contact ID(s)
- 412 - Validation errors
GET /api/contacts/cross_account?email=example@example.com
Description
This method is used to get contacts from all allowed lists by email address
...