Testing

You can test our API's by using tools such as Chrome's Postman extension or Postman desktop, amongst other possible options.

Warning

Testing these operations/methods out will post, update and delete data within the account connected to the API user you authorise with.

Before testing, be sure this is something you're happy with. It's a good idea to explore the possibility of a sandbox account for testing. You can speak to your Customer Success representative about this.

Alternatively, make sure you have specially created testing contacts lists and test campaigns, and so on, that you don't mind being directly affected by test API calls.

Alternatively, you can use our dummy account, which returns dummy data, to test the majority of our REST operations and SOAP methods. The API user credentials for the account are:

Username: [email protected]
Password: demo

Any data posted to the account doesn't persist.

If using the dummy account, please expect to encounter some restrictions and limitations. You won't be able to test all operations and methods, nor do those that can be tested necessarily return all of the data you might expect when using a normal account (for example, Get account information/GetCurrentAccountInfo won't return an API endpoint).

Code samples

In our API reference section, the documentation provides basic code samples to make the API call you're looking at, but more comprehensive examples can be found:

In the Recipes section.
Examples for the omnichannel API in Github here.
Try checking out our community supported projects area at GitHub - https://github.com/dotmailer/community-supported-projects (and feel free to contribute yourself!)

Next steps

Discover what you can do with our powerful APIs in the reference sections below: