Create a subscriber record

Request

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

Create a new subscriber 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
subscriberTitle String The title for the subscriber. Optional
subscriberFirstname String The firstname for the subscriber. Optional
subscriberLastname String The lastname for the subscriber. Optional
subscriberEmailaddress String The emailaddress for the subscriber. Required
subscriberTelephone String The telephone number for the subscriber. Optional
subscriberJobRole String The job role for the subscriber. Optional
subscriberProfileID String The profile ID for the subscriber. Required
subscriberTagID String Comma delimited tag IDs for the subscriber. Optional
subscriberAttr JSON Array Array containing the attributes to create. Optional

Example Request

            
                                {
                                    "tokenUUID": "xxxxxxxx-xxx-xxxx-xxxx-xxxxxxxxxxx",
                                    "userUUID" : "xxxxxxxx-xxx-xxxx-xxxx-xxxxxxxxxxx",
                                    "subscriberTitle": "Mr",
                                    "subscriberFirstname": "John",
                                    "subscriberLastname": "Doe",
                                    "subscriberEmailaddress": "john.doe@xxxxxxx.com",
                                    "subscriberTelephone": "",
                                    "subscriberMobile": "",
                                    "subscriberJobRole": "",
                                    "subscriberProfileID": "xx",
                                    "subscriberTagID": "176,177,172",
                                    "subscriberAttr": [{
                                            "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 subscriber is already matched against an existing record.
subscriberUUID String Unique identifier for the newly created subscriber.
status String Status code for the response.

Example Response

            
                                {
                                    "exists": "false",
                                    "subscriberUUID": "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.