REST API Documentation

Latest release:1.0.5

Date: September 5, 2018

Zulu eDM is not a list blasting tool it's a relational data structure with email being the primary key so a single view of the contact / subscriber / customer is a focus. This also means that when an email has been unsubscribeed the system will not send email to the user. That has limitations for notifications and system emails however it keeps organizations out of trouble when it comes to SPAM and the law.

Scale & Capacity

We have had over 27 million subscribers sending over 100,000,000 (100 million) emails per month in one account. Simply use a new stack and off you go but be comfortable that this an enterprise grade and established product.

Zulu eDM is at it's best for multi-account purposes. That means each account has it's own database however with a parent account able to publish to each sub account making it perfect for Franchise Organizations, Digital companies services many clients that want to reduce campaign task duplication and or course muli-national organizations.

Why develop on Zulu eDM?

We focused on the the end game for an organization and that best possible data and targeting functions with tools that streamline the huge task ahead of any marketing communication or digital team. We also really know about email delivery and heaps of neat tricks, just ask! We like to think we lead the way with DMARC implementations. You don't need to feel like you have to master everything as we are here to support you.

The rules around email delivery have changed and you need ot be aware of them before plugging in. e.g. you musty have a DMARC compliant domain to sent using the API's.

Areas to take advantge of

Authentication & Example

There is a per account end-point for the RESTFUL API and takes the following form: https://{client-url}.au.zuluedm.com/api/rest endpoint and responds to GET, POST, PUT, and DELETE. Event based Webhooks are available for near real time data transfer.

This knowledge base page will show you where to find your API Key and details. Developers that are wishing to integrate with us please ensure your project is approved and you have a FREEMIUM sandbox account. :

Zulu eDM account holder may not access the key on a FREEMIUM account they will need to have a paid account.

Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
 

We like sing HTTPFUL From Nategood when using PHP.

<?PHP include('vendor/httpful.phar'); $uri = "https://staging.au.zuluedm.com/api/rest/reusable";


$response = \Httpful\Request::get($uri)
->addHeader('Accept', '*/*')
->addHeader('X-API-KEY', 'xxxxxxxxxxxxxxxxxxxxxxxxxxx')
->addHeader('X-API-Username', 'xxxxxxxx')
->addHeader('X-API-Password', 'xxxxxxxx')
->send();

Campaign Categories

List All Campaign Categories

GET/categories
[
{
    "categoryId": "10",
    "categoryName": "2016",
    "categoryLevel": "0" 
},
{
    "categoryId": "11",
    "categoryName": "Bounced Cron & Categories",
    "categoryLevel": "1" 
},
{
    "categoryId": "15",
    "categoryName": "CRT",
    "categoryLevel": "0" 
}
]

                                                        

Get a Campaign Category

GET/categories/{campaign-category-id}

{
    "categoryId": "11",
    "categoryName": "Bounced Cron & Categories",
    "categoryLevel": "1" 
}

                                                        

Create a new Campaign Category

POST/categories
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[cat_name] Test Category
data[cat_desc] Test Category Description
data[cat_parentid] 0

{
    "status": "101",
    "message": "SUCCESSFUL",
    "categoryId": {category-id} 
}

                                                        

Edit a Campaign Category

PUT/categories/{category-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[cat_name] Test Category
data[cat_desc] Test Description
data[cat_parentid] 0

{
    "status": "101",
    "message": "SUCCESSFUL",
    "categoryId": {category-id} 
}

                                                        

Delete a categories

DELETE/categories/{category-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded

{
    "status": "101",
    "message": "SUCCESSFUL",
    "categoryId": {category-id} 
}

                                                        

Campaigns

Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******

List All Campaigns

GET/campaigns
[
{
    "campaign_id": "5",
    "campaign_name": "A new campaign",
    "campaign_subject": "Hello there!", 
    "campaign_categoryid": "0",
    "ctemplate_tid": "1",
    "campaign_fromname": "test", 
    "campaign_from": "test@au.zululabs.com",
    "campaign_sendlist": "member:17554", 
    "campaign_blocklist": "",
    "campaign_time": "1465971199" 
},
{
    "campaign_id": "20",
    "campaign_name": "Bounced Cron & Categories",
    "campaign_subject": "Bounced Cron & Categories", 
    "campaign_categoryid": "0",
    "ctemplate_tid": "1",
    "campaign_fromname": "admin", 
    "campaign_from": "admin@au.zululabs.com",
    "campaign_sendlist": "member:23335", 
    "campaign_blocklist": "",
    "campaign_time": "1473143160" 
},
{
    "campaign_id": "77",
    "campaign_name": "Bounced Cron & Categories (resent)(12)",
    "campaign_subject": "Bounced Cron & Categories", 
    "campaign_categoryid": "0",
    "ctemplate_tid": "8",
    "campaign_fromname": "Zulu eDM Staging", 
    "campaign_from": "admin@au.zululabs.com",
    "campaign_sendlist": "group:45", 
    "campaign_blocklist": "",
    "campaign_time": "1473143160" 
}
]

                                                        

Get a Campaign

GET/campaigns/{campaign-id}

{
    "campaign_id": "78",
    "campaign_name": "Bounced Cron & Categories (resent)(13)",
    "campaign_subject": "Bounced Cron & Categories",
    "campaign_categoryid": "0",
    "ctemplate_tid": "8",
    "campaign_fromname": "Zulu eDM",
    "campaign_from": "admin@ma.zululabs.com"
    "campaign_sendlist": "group:45",
    "campaign_blocklist": "",
    "campaign_time": "1473143160",
    "statistics": {
        "attempted_sends": { 
            "count": "5" 
            "percent": "100" 
            "contacts": [ 
                {
                    "sentemail_peopleid": "17554"
                },
                {
                    "sentemail_peopleid": "17580"
                },
                {
                    "sentemail_peopleid": "18229"
                },
                {
                    "sentemail_peopleid": "18230"
                },
                {
                    "sentemail_peopleid": "18233"
                }
            ]
        },
        "delivered": {
            "count": "5" 
            "percentage": "100" 
            "global": "7.3109843081312" 
            "percent": "100.00" 
            "contacts": [ 
                {
                    "sentemail_peopleid": "17554"
                },
                {
                    "sentemail_peopleid": "17580"
                },
                {
                    "sentemail_peopleid": "18229"
                },
                {
                    "sentemail_peopleid": "18230"
                },
                {
                    "sentemail_peopleid": "18233"
                }
            ]
        },
        "failed": { 
            "count": "5" 
            "percentage": "0" 
            "global": "0.28530670470756" 
        },
        "bounced": {
            "all": { 
                "count": "0"
                "percentage": "0"
                "global": "3.3166904422254"
                "percent": "0.00"
            },
            "hard": { 
                "count": "0"
                "percent": "0.00"
            },
            "soft": { 
                "count": "0"
                "percent": "0.00"
            },
            "spam": { 
                "count": "0"
                "percent": "0.00"
            }
        },
        "waiting": { 
            "count": "0" 
            "percent": "0.00" 
        },
        "opened": {
            "count": "2" 
            "percentage": "40" 
            "global": "3.0313837375178" 
            "percent": "40.00" 
            "contacts": [ 
                {
                    "sentemail_peopleid": "17554"
                },
                    "sentemail_peopleid": "18230"
                }
            ]
        },
        "unopened": { 
            "count": "0" 
            "percentage": "0" 
            "global": "26.034236804565" 
            "percent": "0.00" 
        },
        "subscribed": { 
            "count": "0" 
            "percentage": "0" 
            "global": "0" 
            "percent": "0.00" 
        },
        "unsubscribed": { 
            "count": "0" 
            "percentage": "0" 
            "global": "0.10699001426534" 
            "percent": "0.00" 
        },
        "avg_open_delay": { 
            "0": "26875" 
            "seconds": "55" 
            "minutes": "27" 
            "hours": "7" 
            "days": "0" 
        },
        "clicks": { 
            "count": "0" 
            "percent": "0.00" 
        },
        "unique_clicks": { 
            "count": "0" 
        },
        "triggers": { 
            "count": "0" 
        },
        "unique_triggers": { 
            "count": "0" 
        },
        "forwards": { 
            "all": "0" 
            "subscribed": "0" 
        }
    }
}

                                                        

Create a new Campaign

POST/campaigns
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[name] test name
data[subject] test subject
data[category] 10
data[senderName] test sender name
data[senderAddress] devteam@ind.zululabs.com
data[template] 12
data[recipients] member:1,2,3;group:1,2
data[blockList] member:1,2,3;group:1,2
data[scheduleDelivery]

{
    "status": "101",
    "message": "SUCCESSFUL",
    "campaignId": 98, 
    "InvalidMemberId": "2,3",
    "InvalidGroupId": ""
}

                                                        

Delete a Campaign

DELETE/campaign/{campaign-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded

{
    "status": "101",
    "message": "SUCCESSFUL",
    "campaignId": {campaign-id} 
}

                                                        

{
    "status": "715",
    "message": "INVALID CAMPAIGN ID",
    "campaignId": {campaign-id} 
}

                                                        

{
    "status": "721",
    "message": "FAILURE",
    "campaignstatus": "ENTERING CAMPAIGN INFORMATION",
    "campaignId": {campaign-id} 
}

                                                        

{
    "status": "721",
    "message": "FAILURE",
    "campaignstatus": "SELECTING RECIPIENTS",
    "campaignId": {campaign-id} 
}

                                                        

{
    "status": "721",
    "message": "FAILURE",
    "campaignstatus": "REQUIRES CONFIRMATION",
    "campaignId": {campaign-id} 
}

                                                        

{
    "status": "721",
    "message": "FAILURE",
    "campaignstatus": "UPDATING CONTENT",
    "campaignId": {campaign-id} 
}

                                                        

{
    "status": "721",
    "message": "FAILURE",
    "campaignstatus": "COMPLETED",
    "campaignId": {campaign-id} 
}

                                                        

Force Delete a Campaign

DELETE/campaign/{campaign-id}/forcedelete
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded

{
    "status": "101",
    "message": "SUCCESSFUL",
    "campaignId": {campaign-id} 
}

                                                        

Contacts

Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******

List All Contacts

GET/contacts

{
    "total": "5715",
    "contacts": [
        {
            "default": {
                "contactid": "17573",
                "salutationtitle": "Doctor", 
                "firstname": "dev"
                "lastname": "team",
                "email": "devteam@ind.zululabs.com", 
                "telephone": ""
                "workphone": "",
                "mobilephone": "", 
                "fax": ""
                "dateofbirth": "",
                "username": "", 
                "password": ""
                "address1": "",
                "address2": "", 
                "address3": "", 
                "city": ""
                "state": "",
                "postalcode": "", 
                "country": "Australia"
                "companyname": "",
                "designation": "Doctor",
                "emailsubscribed": "true", 
                "subscribedsms": "true"
                "signupdate": "2015-11-11",
                "doubleoptedin": "false", 
                "subscriptiondashboardlastupdated": "0"
            },
            "profiles": [
                {
                    "id": "1",
                    "name": "test", 
                    "fields": [
                        {
                            "id": "8",
                            "field": "test", 
                            "code": "test"
                            "value": ""
                        },
                        {
                            "id": "9",
                            "field": "test doc upload", 
                            "code": "test_doc_upload"
                            "value": ""
                        }
                    ]
                },
                {
                    "id": "2",
                    "name": "Personal Information", 
                    "fields": [
                        {
                            "id": "2",
                            "field": "Business Address", 
                            "code": "business_address"
                            "value": ""
                        },
                        {
                            "id": "3",
                            "field": "Location", 
                            "code": "Location"
                            "value": ""
                        },
                        {
                            "id": "4",
                            "field": "Yes or No?", 
                            "code": "yes_or_no"
                            "value": ""
                        }
                    ]
                },
                {
                    "id": "3",
                    "name": "Restaurant Manager", 
                    "fields": [
                        {
                            "id": "5",
                            "field": "Date of last Visit", 
                            "code": "date_of_last_vistit"
                            "value": ""
                        },
                        {
                            "id": "6",
                            "field": "Items purchased", 
                            "code": "items_purchased"
                            "value": ""
                        },
                        {
                            "id": "7",
                            "field": "Amount Spent", 
                            "code": "amount_spent"
                            "value": "",
                        }
                    ]
                }
            ],
            "groups": [
                {   
                    "groupid": "2", 
                    "groupname": "Default Group"
                    "groupdesc": "All Members",
                    "groupparent": "0", 
                    "groupdefault": "1"
                }
            ]
        },
        {
            "default": {
                "contactid": "17574",
                "salutationtitle": "Doctor", 
                "firstname": "dev"
                "lastname": "team",
                "email": "devteam@ind.zululabs.com", 
                "telephone": ""
                "workphone": "",
                "mobilephone": "", 
                "fax": ""
                "dateofbirth": "",
                "username": "", 
                "password": ""
                "address1": "",
                "address2": "",
                "address3": "", 				
                "city": ""
                "state": "",
                "postalcode": "", 
                "country": "Australia"
                "companyname": "",
                "designation": "Doctor",
                "emailsubscribed": "true", 
                "subscribedsms": "true"
                "signupdate": "2015-11-11",
                "doubleoptedin": "false", 
                "subscriptiondashboardlastupdated": "0"
            },
            "profiles": [
                {
                    "id": "1",
                    "name": "test", 
                    "fields": [
                        {
                            "id": "8",
                            "field": "test", 
                            "code": "test"
                            "value": ""
                        },
                        {
                            "id": "9",
                            "field": "test doc upload", 
                            "code": "test_doc_upload"
                            "value": ""
                        }
                    ]
                },
                {
                    "id": "2",
                    "name": "Personal Information", 
                    "fields": [
                        {
                            "id": "2",
                            "field": "Business Address", 
                            "code": "business_address"
                            "value": ""
                        },
                        {
                            "id": "3",
                            "field": "Location", 
                            "code": "Location"
                            "value": ""
                        },
                        {
                            "id": "4",
                            "field": "Yes or No?", 
                            "code": "yes_or_no"
                            "value": ""
                        }
                    ]
                },
                {
                    "id": "3",
                    "name": "Restaurant Manager", 
                    "fields": [
                        {
                            "id": "5",
                            "field": "Date of last Visit", 
                            "code": "date_of_last_vistit"
                            "value": ""
                        },
                        {
                            "id": "6",
                            "field": "Items purchased", 
                            "code": "items_purchased"
                            "value": ""
                        },
                        {
                            "id": "7",
                            "field": "Amount Spent", 
                            "code": "amount_spent"
                            "value": "",
                        }
                    ]
                }
            ],
            "groups": [
                {   
                    "groupid": "2", 
                    "groupname": "Default Group"
                    "groupdesc": "All Members",
                    "groupparent": "0", 
                    "groupdefault": "1"
                }
            ]
        },
        {
            "default": {
                "contactid": "17575",
                "salutationtitle": "Mr", 
                "firstname": "dev"
                "lastname": "team",
                "email": "devteam@ind.zululabs.com", 
                "telephone": ""
                "workphone": "",
                "mobilephone": "", 
                "fax": ""
                "dateofbirth": "",
                "username": "", 
                "password": ""
                "address1": "",
                "address2": "",
                "address3": "",				
                "city": ""
                "state": "",
                "postalcode": "", 
                "country": "Australia"
                "companyname": "",
                "designation": "Doctor",
                "emailsubscribed": "true", 
                "subscribedsms": "true"
                "signupdate": "2015-11-11",
                "doubleoptedin": "false", 
                "subscriptiondashboardlastupdated": "0"
            },
            "profiles": [
                {
                    "id": "1",
                    "name": "test", 
                    "fields": [
                        {
                            "id": "8",
                            "field": "test", 
                            "code": "test"
                            "value": ""
                        },
                        {
                            "id": "9",
                            "field": "test doc upload", 
                            "code": "test_doc_upload"
                            "value": ""
                        }
                    ]
                },
                {
                    "id": "2",
                    "name": "Personal Information", 
                    "fields": [
                        {
                            "id": "2",
                            "field": "Business Address", 
                            "code": "business_address"
                            "value": ""
                        },
                        {
                            "id": "3",
                            "field": "Location", 
                            "code": "Location"
                            "value": ""
                        },
                        {
                            "id": "4",
                            "field": "Yes or No?", 
                            "code": "yes_or_no"
                            "value": ""
                        }
                    ]
                },
                {
                    "id": "3",
                    "name": "Restaurant Manager", 
                    "fields": [
                        {
                            "id": "5",
                            "field": "Date of last Visit", 
                            "code": "date_of_last_vistit"
                            "value": ""
                        },
                        {
                            "id": "6",
                            "field": "Items purchased", 
                            "code": "items_purchased"
                            "value": ""
                        },
                        {
                            "id": "7",
                            "field": "Amount Spent", 
                            "code": "amount_spent"
                            "value": "",
                        }
                    ]
                }
            ],
            "groups": [
                {   
                    "groupid": "2", 
                    "groupname": "Default Group"
                    "groupdesc": "All Members",
                    "groupparent": "0", 
                    "groupdefault": "1"
                },
                {   
                    "groupid": "46", 
                    "groupname": "Test Send Group (All Zulu)"
                    "groupdesc": "All Members",
                    "groupparent": "0", 
                    "groupdefault": "0"
                },
            ]
        }
    ]
}
                

Get a Contact

GET/contacts/{contact-id}

    {
        "default": {
            "contactid": "17573",
            "salutationtitle": "Doctor", 
            "firstname": "dev"
            "lastname": "team",
            "email": "devteam@ind.zululabs.com", 
            "telephone": ""
            "workphone": "",
            "mobilephone": "", 
            "fax": ""
            "dateofbirth": "",
            "username": "", 
            "password": ""
            "address1": "",
            "address2": "",
            "address3": "",			
            "city": ""
            "state": "",
            "postalcode": "", 
            "country": "Australia"
            "companyname": "",
            "designation": "Doctor",
            "emailsubscribed": "true", 
            "subscribedsms": "true"
            "signupdate": "2015-11-11",
            "doubleoptedin": "false", 
            "subscriptiondashboardlastupdated": "0"
        },
        "profiles": [
            {
                "id": "1",
                "name": "test", 
                "fields": [
                    {
                        "id": "8",
                        "field": "test", 
                        "code": "test"
                        "value": ""
                    },
                    {
                        "id": "9",
                        "field": "test doc upload", 
                        "code": "test_doc_upload"
                        "value": ""
                    }
                ]
            },
            {
                "id": "2",
                "name": "Personal Information", 
                "fields": [
                    {
                        "id": "2",
                        "field": "Business Address", 
                        "code": "business_address"
                        "value": ""
                    },
                    {
                        "id": "3",
                        "field": "Location", 
                        "code": "Location"
                        "value": ""
                    },
                    {
                        "id": "4",
                        "field": "Yes or No?", 
                        "code": "yes_or_no"
                        "value": ""
                    }
                ]
            },
            {
                "id": "3",
                "name": "Restaurant Manager", 
                "fields": [
                    {
                        "id": "5",
                        "field": "Date of last Visit", 
                        "code": "date_of_last_vistit"
                        "value": ""
                    },
                    {
                        "id": "6",
                        "field": "Items purchased", 
                        "code": "items_purchased"
                        "value": ""
                    },
                    {
                        "id": "7",
                        "field": "Amount Spent", 
                        "code": "amount_spent"
                        "value": "",
                    }
                ]
            }
        ],
        "groups": [
            {   
                "groupid": "2", 
                "groupname": "Default Group"
                "groupdesc": "All Members",
                "groupparent": "0", 
                "groupdefault": "1"
            }
        ]
    }

                                                        

Create a new Contact

POST/contacts
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[firstname] devteam
data[email] devteam@ind.zululabs.com

{
    "status": "101",
    "message": "SUCCESSFUL",
    "contactid": {contact-id} 
}

                                                        

Edit a Contact

PUT/contacts/{contact-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[firstname] devteam
data[email] devteam@ind.zululabs.com
data[##_cf_user:6:text_fld_1:#] hi there 1
data[##_cf_user:2:location:#] hi there 2

{
    "status": "101",
    "message": "SUCCESSFUL",
    "contactid": {contact-id} 
}

                                                        

Field Groups

Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******

List All Field Groups

GET/fieldgroups
[
{
    "collection_id": "35",
    "collection_objectid": "",
    "collection_name": "07afab1d57d54222", 
    "collection_displayname": "07afab1d",
    "collection_default": "0",
    "collection_created": "1484570835",
    "collection_lastmodified": "1484570835", 
    "collection_desc": "07afab1d-57d5-4222-820e-2f5770f4b3cb",
    "collection_order": "1",
    "collection_compliance": "0",
    "fields": [ 
	{
	  "pfield_id": "62"
	}
   ]
},
{
    "collection_id": "6",
    "collection_objectid": "",
    "collection_name": "newcustomfields", 
    "collection_displayname": "new custom fields",
    "collection_default": "0",
    "collection_created": "1483076346",
    "collection_lastmodified": "1483076362", 
    "collection_desc": "new custom fields",
    "collection_order": "1",
    "collection_compliance": "0",
    "fields": [ 
	{
	  "pfield_id": "17"
	},
	{
	  "pfield_id": "18"
	}
   ]
},
{
    "collection_id": "2",
    "collection_objectid": "1",
    "collection_name": "personalinformat", 
    "collection_displayname": "Personal Information",
    "collection_default": "0",
    "collection_created": "1341368502",
    "collection_lastmodified": "1341368515", 
    "collection_desc": "Personal Information",
    "collection_order": "1",
    "collection_compliance": "0",
    "fields": [ 
	{
	  "pfield_id": "2"
	},
	{
	  "pfield_id": "3"
	},
	{
	  "pfield_id": "4"
	},
	{
	  "pfield_id": "16"
	},
	{
	  "pfield_id": "23"
	},
	{
	  "pfield_id": "24"
	},
	{
	  "pfield_id": "25"
	}
   ]
},
{
    "collection_id": "3",
    "collection_objectid": "1",
    "collection_name": "restaurantmanage", 
    "collection_displayname": "Restaurant Manager",
    "collection_default": "0",
    "collection_created": "1360127263",
    "collection_lastmodified": "1360127297", 
    "collection_desc": "Fields Native to the integration",
    "collection_order": "1",
    "collection_compliance": "0",
    "fields": [ 
	{
	  "pfield_id": "5"
	},
	{
	  "pfield_id": "6"
	},
	{
	  "pfield_id": "7"
	}
   ]
}
]

Get a Field Group

GET/fieldgroups/{fieldgroup-id}

{
    "collection_id": "2",
    "collection_objectid": "1",
    "collection_name": "personalinformat", 
    "collection_displayname": "Personal Information",
    "collection_default": "0",
    "collection_created": "1341368502",
    "collection_lastmodified": "1341368515", 
    "collection_desc": "Personal Information",
    "collection_order": "1",
    "collection_compliance": "0",
    "fields": [ 
	{
	  "pfield_id": "2"
	},
	{
	  "pfield_id": "3"
	},
	{
	  "pfield_id": "4"
	},
	{
	  "pfield_id": "16"
	},
	{
	  "pfield_id": "23"
	},
	{
	  "pfield_id": "24"
	},
	{
	  "pfield_id": "25"
	}
   ]
}

                                                        

Create a new Field Group

POST/fieldgroups
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[collection_displayname] test
data[collection_desc] test

{
    "status": "101",
    "message": "SUCCESSFUL",
    "fieldgroupid": {fieldgroup-id} 
}

                                                        

Edit a Field Group

PUT/fieldgroups/{fieldgroup-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[collection_displayname] test name
data[collection_desc] test subject

{
    "status": "101",
    "message": "SUCCESSFUL",
    "fieldgroupid": {fieldgroup-id} 
}

                                                        

Field Type

Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******

List All Field Types

GET/fieldtypes
{
    "hd": "Header Field",
    "pt": "Text Area",
    "st": "Text",
    "nm": "Numeric Text",
    "dt": "Date Time",
    "da": "Calendar",
    "tm": "Time",
    "im": "Image Upload",
    "dc": "Document Upload",
    "ch": "Check Box",
    "ra": "Radio Button",
    "ss": "Single Select",
    "ms": "Multi Select",
    "co": "Country Select",
    "sr": "Star Rating"
}

                                                        

Fields

Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******

List All Fields

GET/fields
[
{
    "pfield_id": "62",
    "pfield_collectionid": "35",
    "pfield_name": "invdetailstring",
    "pfield_type": "st",
    "pfield_code": "invdetailstring",
    "pfield_required": "0",
    "pfield_validation": "0",
    "pfield_other": "0",
    "pfield_useredit": "1",
    "pfield_search": "0",
    "pfield_order": "1",
    "pfield_filetype": "",
    "pfield_groupid": "",
    "pfield_show": "",
    "pfield_author": "23371"
    "pfield_created": "1484570836"
    "pfield_lastmodified": "1484570836"
    "pfield_default": "0"
    "pfield_objectid": ""
    "pfield_segment": "0"
    "pfield_segparent": "0"
    "pfield_public": "0"
    "pfield_parentfieldid": "0"
    "pfield_parentfieldoptionid": "0"
},
{
    "pfield_id": "17",
    "pfield_collectionid": "6",
    "pfield_name": "text fld 1",
    "pfield_type": "st",
    "pfield_code": "text_fld_1",
    "pfield_required": "0",
    "pfield_validation": "0",
    "pfield_other": "0",
    "pfield_useredit": "1",
    "pfield_search": "0",
    "pfield_order": "1",
    "pfield_filetype": "",
    "pfield_groupid": "",
    "pfield_show": "",
    "pfield_author": "23371"
    "pfield_created": "1484570836"
    "pfield_lastmodified": "1484570836"
    "pfield_default": "0"
    "pfield_objectid": ""
    "pfield_segment": "0"
    "pfield_segparent": "0"
    "pfield_public": "0"
    "pfield_parentfieldid": "0"
    "pfield_parentfieldoptionid": "0"
},
{
    "pfield_id": "18",
    "pfield_collectionid": "6",
    "pfield_name": "text fld 2",
    "pfield_type": "st",
    "pfield_code": "text_fld_2",
    "pfield_required": "0",
    "pfield_validation": "0",
    "pfield_other": "0",
    "pfield_useredit": "1",
    "pfield_search": "0",
    "pfield_order": "1",
    "pfield_filetype": "",
    "pfield_groupid": "",
    "pfield_show": "",
    "pfield_author": "23371"
    "pfield_created": "1484570836"
    "pfield_lastmodified": "1484570836"
    "pfield_default": "0"
    "pfield_objectid": ""
    "pfield_segment": "0"
    "pfield_segparent": "0"
    "pfield_public": "0"
    "pfield_parentfieldid": "0"
    "pfield_parentfieldoptionid": "0"
}
]

                                                        

Get a Field

GET/fields/{field-id}

{
    "pfield_id": "18",
    "pfield_collectionid": "6",
    "pfield_name": "text fld 2",
    "pfield_type": "st",
    "pfield_code": "text_fld_2",
    "pfield_required": "0",
    "pfield_validation": "0",
    "pfield_other": "0",
    "pfield_useredit": "1",
    "pfield_search": "0",
    "pfield_order": "1",
    "pfield_filetype": "",
    "pfield_groupid": "",
    "pfield_show": "",
    "pfield_author": "23371"
    "pfield_created": "1484570836"
    "pfield_lastmodified": "1484570836"
    "pfield_default": "0"
    "pfield_objectid": ""
    "pfield_segment": "0"
    "pfield_segparent": "0"
    "pfield_public": "0"
    "pfield_parentfieldid": "0"
    "pfield_parentfieldoptionid": "0"
}

                                                        

Create a new Field

POST/fields
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[pfield_collectionid] 2
data[pfield_name] test1010
data[pfield_type] hd
data[pfield_code] test
data[pfield_required] 0
data[pfield_show] 1
data[pfield_public] 1
data[pfield_order] 1

{
    "status": "101",
    "message": "SUCCESSFUL",
    "fieldid": {field-id} 
}

                                                        

Create a new Field ( Check Box )

POST/fields
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[pfield_collectionid] 2
data[pfield_name] Test Checkbox
data[pfield_type] ch
data[pfield_code] test_checkbox
data[pfield_required] 0
data[pfield_show] 1
data[pfield_public] 1
data[pfield_order] 1
data[pfield_segment] 0
options[option_0] AA
options[option_1] BB
options[option_2] CC
emailoptions[email_opt_0] EMAIL1
emailoptions[email_opt_1] EMAIL2
emailoptions[email_opt_2] EMAIL3
data[pfield_default] 0

{
    "status": "101",
    "message": "SUCCESSFUL",
    "fieldid": {field-id} 
}

                                                        

Create a new Field ( Country )

POST/fields
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[pfield_collectionid] 2
data[pfield_name] Test Country
data[pfield_type] co
data[pfield_code] test_country
data[pfield_required] 0
data[pfield_show] 1
data[pfield_public] 1
data[pfield_order] 1
data[pfield_segment] 0

{
    "status": "101",
    "message": "SUCCESSFUL",
    "fieldid": {field-id} 
}

                                                        

Create a new Field ( Document )

POST/fields
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[pfield_collectionid] 2
data[pfield_name] Test Document
data[pfield_type] dc
data[pfield_code] test_document
data[pfield_required] 0
data[pfield_show] 1
data[pfield_public] 1
data[pfield_order] 1
data[pfield_filetype] zip,pdf,ppt,doc,txt,wmv,swf,flv,xls,xlsx,docx,csv,mp3

{
    "status": "101",
    "message": "SUCCESSFUL",
    "fieldid": {field-id} 
}

                                                        

Create a new Field ( Image )

POST/fields
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[pfield_collectionid] 2
data[pfield_name] Test Image
data[pfield_type] im
data[pfield_code] test_image
data[pfield_required] 0
data[pfield_show] 1
data[pfield_public] 1
data[pfield_order] 1
data[pfield_filetype] jpeg,jpg,gif,png

{
    "status": "101",
    "message": "SUCCESSFUL",
    "fieldid": {field-id} 
}

                                                        

Create a new Field ( Star Rating )

POST/fields
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[pfield_collectionid] 2
data[pfield_name] Test Star Rating
data[pfield_type] sr
data[pfield_code] test_star_rating
data[pfield_required] 0
data[pfield_show] 1
data[pfield_public] 1
data[pfield_order] 1
data[pfield_filetype] 5

{
    "status": "101",
    "message": "SUCCESSFUL",
    "fieldid": {field-id} 
}

                                                        

Edit a Field

PUT/fields/{field-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[pfield_collectionid] 2
data[pfield_name] test1010
data[pfield_type] hd
data[pfield_code] test
data[pfield_required] 0
data[pfield_show] 1
data[pfield_public] 1
data[pfield_order] 1

{
    "status": "101",
    "message": "SUCCESSFUL",
    "fieldid": {field-id} 
}

                                                        

Edit a Field ( Check Box )

PUT/fields/{field-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[pfield_collectionid] 2
data[pfield_name] Test Checkbox Updated
data[pfield_type] ch
data[pfield_code] test_checkbox_updated
data[pfield_required] 0
data[pfield_show] 1
data[pfield_public] 1
data[pfield_order] 1
data[pfield_segment] 0
options[option_0] AAAA
options[option_1] BBAA
options[option_2] CCAA
emailoptions[email_opt_0] EMAIL1AA
emailoptions[email_opt_1] EMAIL2AA
emailoptions[email_opt_2] EMAIL3AA
data[pfield_default] 0

{
    "status": "101",
    "message": "SUCCESSFUL",
    "fieldid": {field-id} 
}

                                                        

Edit a Field ( Document )

PUT/fields/{field-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[pfield_collectionid] 2
data[pfield_name] Test Document
data[pfield_type] dc
data[pfield_code] test_document
data[pfield_required] 0
data[pfield_show] 1
data[pfield_public] 1
data[pfield_order] 1
data[pfield_filetype] zip,pdf,ppt,doc,txt,wmv

{
    "status": "101",
    "message": "SUCCESSFUL",
    "fieldid": {field-id} 
}

                                                        

Edit a Field ( Image )

PUT/fields/{field-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[pfield_collectionid] 2
data[pfield_name] Test Image
data[pfield_type] im
data[pfield_code] test_image
data[pfield_required] 0
data[pfield_show] 1
data[pfield_public] 1
data[pfield_order] 1
data[pfield_filetype] jpeg,jpg,png

{
    "status": "101",
    "message": "SUCCESSFUL",
    "fieldid": {field-id} 
}

                                                        

Edit a Field ( Star Rating )

PUT/fields/{field-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[pfield_collectionid] 2
data[pfield_name] Test Star Rating
data[pfield_type] sr
data[pfield_code] test_star_rating
data[pfield_required] 0
data[pfield_show] 1
data[pfield_public] 1
data[pfield_order] 1
data[pfield_filetype] 3

{
    "status": "101",
    "message": "SUCCESSFUL",
    "fieldid": {field-id} 
}

                                                        

Delete a Field

DELETE/fields/{field-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded

{
    "status": "101",
    "message": "SUCCESSFUL",
    "fieldid": {field-id} 
}

                                                        

Field Groups

Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******

List All Groups

GET/groups
[
{
    "groupid": "13",
    "groupname": "Advertising Dept.s",
    "groupdesc": "Advertising Dept.s", 
    "groupparent": "0",
    "groupdefault": "0",
    "count": "0",
    "level": "0"
},
{
    "groupid": "41",
    "groupname": "Apostrophe’s Test",
    "groupdesc": "Apostrophe’s Test", 
    "groupparent": "0",
    "groupdefault": "0",
    "count": "0",
    "level": "0"
},
{
    "groupid": "13",
    "groupname": "Business News",
    "groupdesc": "Business News", 
    "groupparent": "0",
    "groupdefault": "0",
    "count": "0",
    "level": "0"
}
]

Get a Group

GET/groups/{groups-id}

{
    "groupid": "13",
    "groupname": "Business News",
    "groupdesc": "Business News", 
    "groupparent": "0",
    "groupdefault": "0",
    "count": "0",
    "level": "0"
}
                                                        

Create a new Group

POST/groups
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[name] Advertising Dept.s
data[description] Advertising Dept.s
data[public] 1
data[parent] null

{
    "status": "101",
    "message": "SUCCESSFUL",
    "groupid": {groups-id} 
}

                                                        

Edit a Group

PUT/groups/{group-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[name] Advertising Department
data[description] Advertising Department
data[public] 1
data[parent] null

{
    "status": "101",
    "message": "SUCCESSFUL",
    "groupid": {groups-id} 
}

                                                        

Attach Contact to a Group

PATCH/groups/{group-id}/attach/{contact-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded

{
    "status": "101",
    "message": "SUCCESSFUL",
    "groupid": {groups-id}, 
    "contactid": {contact-id} 
}

                                                        

Detach Contact from a Group

PATCH/groups/{group-id}/detach/{contact-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded

{
    "status": "101",
    "message": "SUCCESSFUL",
    "groupid": {groups-id}, 
    "contactid": {contact-id} 
}

                                                        

Move Contact from Source Group to Destination Group and Delete Source Group

DELETE/groups/{source-group-id}/{destination-group-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded

{
    "status": "101",
    "message": "SUCCESSFUL",
    "groupid": 82 
}

                                                        

Delete Group without moving Contacts from Deleting Group

DELETE/groups/{group-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded

{
    "status": "101",
    "message": "SUCCESSFUL",
    "groupid": {groups-id} 
}

                                                        

Truncate Group

DELETE/groups/{group-id}/truncate
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded

{
    "status": "101",
    "message": "SUCCESSFUL",
    "groupid": {groups-id} 
}

                                                        

Templates

Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******

List All Templates

GET/templates
[
{
    "template_id": "2",
    "template_name": "Delivery Hints Test",
    "template_type": "html",
    "template_categoryid": "1",
    "template_ttype": "email",	
    "template_lastupdated": "1465269685", 
    "preview": "{PREVIEW URL}" 
},
{
    "template_id": "7",
    "template_name": "Google Link Test",
    "template_type": "html", 
    "template_categoryid": "1",
    "template_ttype": "email",
    "template_lastupdated": "1467098818", 
    "preview": "{PREVIEW URL}" 
},
{
    "template_id": "8",
    "template_name": "DragNDrop Vic",
    "template_type": "html", 
    "template_categoryid": "1",
    "template_ttype": "email",
    "template_lastupdated": "1467187976", 
    "preview": "{PREVIEW URL}" 
}
]

                                                        

Get a Template

GET/templates/{template-id}

{
    "template_id": "8",
    "template_name": "DragNDrop Vic",
    "template_type": "html",
    "template_categoryid": "1",
    "template_ttype": "email", 
    "template_lastupdated": "1467187976", 
    "preview": "{PREVIEW URL}" 
}

                                                        

Reusable Content

View Embeded Sample

Sample Code On GitHub

Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
 

We like sing HTTPFUL From Nategood when using PHP.

‹?PHP include('vendor/httpful.phar'); $uri = "https://staging.au.zuluedm.com/api/rest/reusable";


$response = \Httpful\Request::get($uri)
->addHeader('Accept', '*/*')
->addHeader('X-API-KEY', 'xxxxxxxxxxxxxxxxxxxxxxxxxxx')
->addHeader('X-API-Username', 'xxxxxxxx')
->addHeader('X-API-Password', 'xxxxxxxx')
->send();
//end of the authentication
// now we want to access all Resuable Content Pieces in the Category
// called News & Updates with id=3
//Using the Template name as the content title and displayiung the date
//from a UNIXTIME Stam into a readable date for our site /app
//Important to note when creating inline styles for your email try and
//minimise the customisation for a few reasons
//1.)email fonts differ from web fonts
//2.) you don't want to have to restyle each time
//3.) We will figure out how to circumvent that when enough people arr using
//the feature.
// This works perfectly with G..UID and our App:
 $j = sizeof($response->body);
 $i = 0;
   while ($i <= $j) {
   if ($response->body[$i]->template_categoryid == 4) {
   $resuableblock = $response->body[$i]->template_htmltext;
   $name = $response->body[$i]->template_name;
   $timestamp = (date("F j, Y, g:i a", $response->body[$i]->template_lastupdated));
     echo '‹h2 style="alignment: left; font-family: sans-serif;">' . ‹br>$response->body[$i]->template_name . '‹/h2>';
     echo '‹h4 style="alignment: left; font-family: sans-serif;">' . $timestamp . '‹/h4>';
     echo $response->body[$i]->template_htmltext;
     echo '‹hr style="width: 60em;">'; }
   $i++;
   }
   flush();

List All Reusable Content Blocks

GET/reusable
[
{
    "template_id": "2",
    "template_name": "Delivery Hints Test",
    "template_type": "html",
    "template_categoryid": "1",
    "template_ttype": "reusable",	
    "template_lastupdated": "1465269685",
    "template_htmltext": {RETURNS HTML BLOCKS ONLY FROM DRAGNDROP},
  "template_html": {RETURNS REUSABLE CONTENT HTML READY TO EMAIL},
 "preview": "{PREVIEW URL}"
},
{
    "template_id": "7",
    "template_name": "Google Link Test",
    "template_type": "html", 
    "template_categoryid": "1",
    "template_ttype": "reusable",
    "template_lastupdated": "1467098818",
  "template_htmltext": {RETURNS HTML BLOCKS ONLY FROM DRAGNDROP},
  "template_html": {RETURNS REUSABLE CONTENT HTML READY TO EMAIL},
    "preview": "{PREVIEW URL}"
},
{
    "template_id": "8",
    "template_name": "DragNDrop Vic",
    "template_type": "html", 
    "template_categoryid": "1",
    "template_ttype": "reusable",
    "template_lastupdated": "1467187976", 
    "preview": "{PREVIEW URL}" 
}
]

                                                        

Get a Reusable

GET/reusable/{id}

{
    "template_id": "8",
    "template_name": "DragNDrop Vic",
    "template_type": "html",
    "template_categoryid": "1",
    "template_ttype": "reusable", 
    "template_lastupdated": "1467187976",
     "template_htmltext": {RETURNS HTML BLOCKS ONLY FROM DRAGNDROP},
  "template_html": {RETURNS REUSABLE CONTENT HTML READY TO EMAIL},
    "preview": "{PREVIEW URL}" 
}

                                                        

Webforms

Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******

List All Webforms

GET/webforms
[
{
    "pdform_id": "1",
    "pdform_name": "Subscription Form template - basic",
    "preview": "{URL}/pdform.php?fid=1",
},
{
    "pdform_id": "11",
    "pdform_name": "Test Subscription Web Form 1",
    "preview": "{URL}/pdform.php?fid=11",
},
{
    "pdform_id": "12",
    "pdform_name": "Test Subscription Web Form 2",
    "preview": "{URL}/pdform.php?fid=12",
}
]

                                                        

Get a Webform

GET/webforms/{webform-id}

{
    "pdform_id": "11",
    "pdform_name": "Test Subscription Web Form 1",
    "preview": "{URL}/pdform.php?fid=11",
}

                                                        

Webhooks

Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******

List All Webhooks

GET/webhooks
[
{
    "webhook_id": "132",
    "webhook_account": "*******",
    "webhook_event": "campaigns/delete", 
    "webhook_end_point": "{ENDPOINT URL}", 
    "webhook_format": "json",
    "webhook_active": "1",
    "webhook_created": "1484888067",
    "webhook_last_update": "1484888067" 
},
{
    "webhook_id": "131",
    "webhook_account": "*******",
    "webhook_event": "campaigns/update", 
    "webhook_end_point": "{ENDPOINT URL}", 
    "webhook_format": "json",
    "webhook_active": "1",
    "webhook_created": "1484888067",
    "webhook_last_update": "1484888067" 
},
{
    "webhook_id": "130",
    "webhook_account": "*******",
    "webhook_event": "campaigns/create", 
    "webhook_end_point": "{ENDPOINT URL}", 
    "webhook_format": "json",
    "webhook_active": "1",
    "webhook_created": "1484888067",
    "webhook_last_update": "1484888067" 
},
{
    "webhook_id": "129",
    "webhook_account": "*******",
    "webhook_event": "groups/delete", 
    "webhook_end_point": "{ENDPOINT URL}", 
    "webhook_format": "json",
    "webhook_active": "1",
    "webhook_created": "1484888066",
    "webhook_last_update": "1484888066" 
},
{
    "webhook_id": "128",
    "webhook_account": "*******",
    "webhook_event": "groups/update", 
    "webhook_end_point": "{ENDPOINT URL}", 
    "webhook_format": "json",
    "webhook_active": "1",
    "webhook_created": "1484888066",
    "webhook_last_update": "1484888066" 
},
{
    "webhook_id": "127",
    "webhook_account": "*******",
    "webhook_event": "groups/create", 
    "webhook_end_point": "{ENDPOINT URL}", 
    "webhook_format": "json",
    "webhook_active": "1",
    "webhook_created": "1484888066",
    "webhook_last_update": "1484888066" 
}
]

                                                        

Get a Webhook

GET/webhooks/{webhook-id}

{
    "webhook_id": "132",
    "webhook_account": "*******",
    "webhook_event": "campaigns/delete", 
    "webhook_end_point": "{ENDPOINT URL}", 
    "webhook_format": "json",
    "webhook_active": "1",
    "webhook_created": "1484888067",
    "webhook_last_update": "1484888067" 
}

                                                        

Create a new Webhook

POST/webhooks
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[webhook_account] FACT Marketing
data[webhook_event] groups/update ( Events allowed for webhook as follows : contacts/create, contacts/update, groups/create, groups/update, groups/delete, groups/create, groups/update, groups/delete, templates/create, templates/update, templates/delete, categories/create, categories/update, categories/delete, campaigns/create, campaigns/update, campaigns/delete, fieldgroups/create, fieldgroups/update, fieldgroups/delete, fields/create, fields/update, fields/delete )
data[webhook_end_point] {ENDPOINT URL}
data[webhook_format] json
data[webhook_active] 1

{
    "status": "101",
    "message": "SUCCESSFUL",
    "webhookid": {webhook-id} 
}

                                                        

Edit a Webhook

PUT/webhooks/{webhook-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded
Body Properties Description
data[webhook_account] FACT Marketing
data[webhook_event] groups/update
data[webhook_end_point] {ENDPOINT URL}
data[webhook_format] json
data[webhook_active] 1

{
    "status": "101",
    "message": "SUCCESSFUL",
    "webhookid": {webhook-id} 
}

                                                        

Delete a Webhook

DELETE/webhooks/{webhook-id}
Header Properties Description
X-API-Key ******
X-API-Username ******
X-API-Password ******
Content-Type application/x-www-form-urlencoded

{
    "status": "101",
    "message": "SUCCESSFUL",
    "webhookid": {webhook-id} 
}