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 /api/contacts/by_email/<Contact Email>
Description
This method returns a single contact data.
...
- 403 - Permission error
- 404 - Unauthorized / Email not found
GET /api/contacts/by_id/<Contact ID>
Description
This method returns a single contact data.
...
- 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 one new contact, or multiple (2, 5, 10, 20) new contacts.
- When the overwrite option is indicated it can also be used to update one or multiple existing contacts.
- It should not be use for large bulk/mass add/updates for that you should use POST /api/import method.
Request
...
To add multiple contacts (up to 10, 20, depending on size of data):
| Code Block |
|---|
[
{ "email": "john@doe.com", "overwrite": true, "fields" : { "name": "John Doe", "country": "USA" } } ,
{ "email": "adam@xyz.com", "overwrite": true, "fields" : { "name": "Adam smith", "country": "UK" }
] |
or:
| Code Block |
|---|
[ { "email": "john@doejohn@abc.com", "overwrite": true, "fields" : { "name": "John Doe", "country": "ChileUSA" } } , { ... } ] |
or:
| Code Block |
|---|
[ { "email": "john@doeadam@xyz.com", "name": "JohnAdam Doesmith", "country": "ChileUK" } , { ... } ] |
Response
Version 2
| Key | Description |
|---|---|
rows | Count of emails provided |
success | Count of contacts that were created+updated+revived successfully |
created | Count of contacts that were created successfully |
created_emails | List of all contact emails that were created successfully, with their Contact IDs |
updated | Count of updated contacts (when using "overwrite" flag) |
updated_emails | List of all contact emails that updated successfully, with their Contact IDs |
revived | Count of revived contacts (were deleted and now active) |
revived_emails | List of all contact emails that revived successfully, with their Contact IDs |
failed | Count of contacts failed to be added |
failed_emails | List of all contact emails that failed, with the failed reasons |
...
- 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".
...
| Code Block |
|---|
{ "email": "john@doe.com", "overwrite": true, "fields" : { "name": "John Doe", "country": "ChileUSA" } } |
or:
| Code Block |
|---|
{ "email": "john@doe.com", "name": "John Doe", "country": "ChileUSA" } |
or:
| Code Block |
|---|
{ "id": "56b1ba1e7acaace92f169dce", "name": "John Doe", "country": "ChileUSA" } |
To update multiple contacts (up to 10, 20, depending on size of data):
| Code Block |
|---|
[
{ "email": "john@doe.com", "overwrite": true, "fields" : { "name": "John Doe", "country": "ChileUSA" } } ,
{ "email": "adam@xyz.com", "overwrite": true, "fields" : { "name": "Adam smith", "country": "USAUK" }
] |
or:
| Code Block |
|---|
[
{ "email": "john@abc.com", "name": "John Doe", "country": "ChileUSA" } ,
{ "email": "adam@xyz.com", "name": "Adam smith", "country": "USAUK" }
] |
Response
Version 2
| Key | Description |
|---|---|
rows | Count of emails provided |
success | Count of contacts that were updated successfully |
success_emails | List of all contact emails that updated successfully, with their contact IDs |
failed | Count of contacts failed to be updated |
failed_emails | List of all contact emails that failed, with the failed reasons |
...
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.
...
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).
...
Error Codes
- 412 - Validation errors
POST /api/contacts/delete
Description
This method deletes a contact based on id.
...
- 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
...