Code preference:
Curl
Ruby
Php
Python
Node.js
C#
Java

Request & Response

We take in JSON as the request data and send back JSON as response. Here we have a look at the core data return structure common throughout the system.

This is the common response format for the API
For success result:

For failure result:

code : This is the standard state of the API action
Possible values

  • success
  • failure

message : This is the custom message of the API response
The following are the possible messages for the “failure” condition

  • Id missing
  • Invalid json
  • Object doesn’t exists
  • Required field missing

data : This is the data response, if any

Marketing Automation API Response

This is the common response format for the Marketing Automation API

status : This is the standard state of the API action
Possible values

  • true
  • false

email_id : This is the email id passed in the request ( if not passed, will be returned as blank ).