Skip to main content

SOAP API and REST API - Knowledgebase / Data & API's - Deployteq Support


Authors list

Difference between SOAP and REST APIs
There are many different standards for web services, but nowadays the most commonly used types are SOAP and REST connections.

SOAP is a connection in which you tightly define what your connection looks like. This is done in an XML format. This provides structure and control. The disadvantage of this is that the connection is heavier than a REST connection. You create a kind of contract about how the connection should be used. This contract is established by making a connection using a WDSL, which can be found at: If you want to read a SOAP connection, it can be technically challenging. Fortunately, there are many good tools like SOAPUI, which is a very useful tool. The most commonly used function is campaign_execute/campaign_executeAsync. This allows you to send your input data to a start on event within a campaign. After the campaign has run, a success or fail response will be sent back to the API when using "campaign_execute". The SOAP API is mainly focused on 1-on-1 communication, unlike Deployteq webhooks.

A REST connection is much lighter, as you don't use a "contract" for this. The REST API uses the JSON format. REST is easier to develop, but compared to SOAP, there is no library available. This is becoming more and more the case due to the use of a Swagger definition. A useful tool for REST is "Postman". Websites like can be used for testing to capture requests and view their content. Within Deployteq, the REST API can currently be used to access the Datamodel and Webhooks. We are also busy expanding the REST APIs, for example: Zone contents: Customers: 

More information about our SOAP API and REST API can be downloaded here.