Create a contact record

Request

POST https://api.aptania.com/services/createContact

Create a new contact record

Request body parameters

Parameter name Value Description Additional
tokenUUID String Unique api token used for each request. Required
userUUID String Identified user value. Obtain through cookies placed on the users device. Required
contactTitle String The title for the contact. Optional
contactFirstname String The firstname for the contact. Optional
contactLastname String The lastname for the contact. Optional
contactEmailaddress String The emailaddress for the contact. Required
contactTelephone String The telephone number for the contact. Optional
contactJobRole String The job role for the contact. Optional
contactProfileID String The profile ID for the contact. Required
contactTagID String Comma delimited tag IDs for the contact. Optional
contactAttr JSON Array Array containing the attributes to create. Optional

Example Request 

            
                                {
                                    "tokenUUID": "xxxxxxxx-xxx-xxxx-xxxx-xxxxxxxxxxx",
                                    "userUUID" : "xxxxxxxx-xxx-xxxx-xxxx-xxxxxxxxxxx",
                                    "contactTitle": "Mr",
                                    "contactFirstname": "John",
                                    "contactLastname": "Doe",
                                    "contactEmailaddress": "john.doe@xxxxxxx.com",
                                    "contactTelephone": "",
                                    "contactMobile": "",
                                    "contactJobRole": "",
                                    "contactProfileID": "xx",
                                    "contactTagID": "176,177,172",
                                    "contactAttr": [{
                                            "attrID": "xxx",
                                            "attrValue": "Tennis"
                                    }, {
                                            "attrID": "xxx",
                                            "attrValue": "Toyoto Proace"
                                    }, {
                                            "attrID": "xxx",
                                            "attrValue": "15/03/1986"
                                    }]
                                }

Response body

Parameter name Value Description
exists Boolean True or false value. True if the contact is already matched against an existing record.
contactUUID String Unique identifier for the newly created contact.
status String Status code for the response.

Example Response 

            
                                {
                                    "exists": "false",
                                    "contactUUID": "xxxxxxxx-xxx-xxxx-xxxx-xxxxxxxxxxx",
                                    "status": "200"
                                }

To use this api you must have an account together with an api key. Please contact us for further information.