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 a list of available and required parameters. These are also listed below for your easy reference for API version 1 and version 2.
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.
Validation rules are applied for 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."
FAQs:
What happens if I submit a contact who is already in my account? Answer: the pre-existing contact is updated. Any new values are saved, any pre-existing values not passed in the API call are left unchanged.
How do I get my Enudge Licence number? Answer: if that has already been issued, you can view it via your Enudge Account screen, accessed by clicking on your name in the top right hand corner.
How can I test the API call? Answer: we recommend that you use a tool such as Postman to test calling the API.
I am not a developer; how else can I add contacts into my Enudge account after they have filled in a web form? Answer: there are 3 other options: 1/ using an Enudge widget will allow you to show a form in your website which is integrated with your Enudge account. 2/ If you can't add a widget, then you can use an Enudge hosted form. 3/ If you have a Zapier account, you can send contacts into your Enudge account via a Zap.
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": ""
}