Function Call: list_contacts_with_tag Purpose: Returns a list of contacts which have had the supplied tag assigned.  Optionally within a specified date range. Parameters: tag_name Optional: date_start date_end format: YYYY-MM-DD Return: For each tag tag_id tag_name contacts For each contact: contact_id first_name last_name email_address status – if error detail Example: http://example.com/a.php/api/list_contacts_with_tag?api_key=0c68398f&tag_name=my+tag From date option: http://example.com/a.php/api/list_contacts_with_tag?api_key=0c68398f&tag_name=my+tag&date_start=2018-07-31 Between […]

Function Call: remove_tag_from_contact Purpose: This will remove an existing tag, or tags, from a contact by email address. Parameters: email_address tag_name – comma separated list of tags Return: status – if success – tags not found supplied in “detail” – tags already assigned to contact supplied in “detail” example: {“status”: “ok”, “detail”: “Success: Tag(s) not […]

Function Call: assign_tag_to_contact Purpose: Assign or associate one or multiple tags to a contact. Parameters: tag_name comma separated list of tag names email_address email address of contact to assign tag to Return: status – if success – tags not found supplied in “detail” – tags already assigned to contact supplied in “detail” example: {“status”: “ok”, […]

Function Call: list_tags Purpose: Lists an array of the tags created, optionally between given dates. Parameters: Optional: date_start date_end format: YYYY-MM-DD Return: For each tag tag_name tag_id status – if error detail Example: http://example.com/a.php/api/list_tags?api_key=0c68398f Between dates option: http://example.com/a.php/api/list_tags?api_key=0c68398f&date_start=2018-07-31&date_end=2018-10-30  

Function Call: add_category Purpose: Adds an existing contact to an existing category Note:  this API does not create a category Parameters: api_key email_addess category – The category to which the contact will be added Return: status – if error detail Example: http://example.com/a.php/api/add_category?api_key=0c68398f&email_address=test@example.com&category=existing+category+name  

Function Call: list_categories Purpose: Returns a list of all categories as an array Parameters: api_key Returm: For each category: Category name Status – if error Example: http://example.com/a.php/api/list_categories?api_key=0c68398f  

Function Call: get_contact Purpose: Returns a list of all standard contact form data, as an array , for the contact email address.  eg name, address, telephone etc Parameters: api_key email_address Returm: Status – ok or error List of all fields Example: http://example.com/a.php/api/get_contact?api_key=0c68398&email_address=test@example.com  

Function Call: delete_contact Purpose: Deletes a contact and all records from the system. Parameters: api_key email_address Returm: Status – ok or error Details Example: http://example.com/a.php/api/delete_contact?api_key=0c68398&email_address=test@example.com  

Function Call: suppress_contact Purpose: Suppress sending of emails to a contact and add the email address to the email suppression list i.e. unsubscribe the contact. Parameters: api_key email_address Returm: Status – ok or error Details Example: http://example.com/a.php/api/suppress_contact?api_key=0c68398&email_address=test@example.com  

Function Call: unsub_contact Purpose: Unsubscribe a contact from one or more lists. Parameters: api_key email_address lists Optional field values: datecode_subscribe – format yyyymmddhh subscribe_ip_address subscribe_user_agent subscribe_method Returm: For the contact: Status – ok or error Details If the contact is OK, for each list: Status – ok or error Details Example: http://example.com/a.php/api/unsub_contact?api_key=0c68398&email_address=test@example.com&lists=[{“list”:”Sales”}] Notes: datecode_subscribe – […]