Our REST web service to allow you to add contacts into your Enudge account programmatically can be accessed via the following endpoint:
https://www.enudge.com.au/api/addContact.php
or
https://www.enudge.com.au/api/addContact_v2.php
Version 2 includes the extra fields: custom1, custom2, custom3, custom4, custom5, custom6, custom7, custom8, custom9 and notes.
You can submit using a GET to return the available of required parameters, which are listed below (Parameter set). The following are mandatory parameters:
At least one of email_addr and mobile must be supplied.
You must include your Enudge License number. If you don't have that, please send a request to Enudge support for this value.
Please also note the validation rules in relation to the following parameters:
year_of_birth can only be a four digit number e.g. 1986
categories can contain one or more category names separated via a ':' e.g. "first category:2nd category"
gender can only be "f" or "m"
series_id can only be an integer, and it must correspond to the ID of your Message Series in your Enudge account
license will be supplied to you by Enudge, upon your request
When submitted successfully, the API will respond with:
"message[0]": "Request Processed OK : Successfully added."
Parameter set for API (version 1):
{
"firstname": "",
"surname": "",
"salutation": "",
"organisation": "",
"position": "",
"department": "",
"email_addr": "",
"bus_phone": "",
"home_phone": "",
"mobile": "",
"fax": "",
"street": "",
"city": "",
"customer_state": "",
"postcode": "",
"country": "",
"reference": "",
"gender": "",
"year_of_birth": "",
"categories": "",
"password": "",
"series_id": "",
"license": ""
}
Parameter set for API (version 2):
{
"firstname": "",
"surname": "",
"salutation": "",
"organisation": "",
"position": "",
"department": "",
"email_addr": "",
"bus_phone": "",
"home_phone": "",
"mobile": "",
"fax": "",
"street": "",
"city": "",
"customer_state": "",
"postcode": "",
"country": "",
"reference": "",
"year_of_birth": "",
"custom1": "",
"custom2": "",
"custom3": "",
"custom4": "",
"custom5": "",
"custom6": "",
"custom7": "",
"custom8": "",
"custom9": "",
"notes": "",
"gender": "",
"categories": "",
"password": "",
"series_id": "",
"license": ""
}