View All Services

Sendgrid V3 Mock Server

SendGrid is a cloud-based email delivery service that provides developers with a reliable and scalable platform to send transactional and marketing emails. It offers a comprehensive set of features and APIs that enable developers to easily integrate email functionality into their applications, websites, or services.

The hosted mock server empowers you to effortlessly simulate various Sendgrid V3 APIs, and doesn't need any authentication/api-key. The setup is straightforward, you can configure the base URL in your code/SDK. You can also control the base URL using environment variables or a feature flag. You don't need any additional dependencies, and you can run the same code in both sandbox and production environments.

Sendgrid V3 Rest/OpenAPI mock server is up and running!

We have set up the mock routes to ensure a smooth adoption. Copy the URL below and set it as the API base URL in your code, and instantly harness the full potential of mocked Sendgrid V3 APIs.

https://sendgrid-v3-api.mock.beeceptor.com



Mail Send

Request Payload
{
  "personalizations": [
    {
      "to": [
        {
          "email": "john_doe@example.com",
          "name": "John Doe"
        },
        {
          "email": "julia_doe@example.com",
          "name": "Julia Doe"
        }
      ],
      "cc": [
        {
          "email": "jane_doe@example.com",
          "name": "Jane Doe"
        }
      ],
      "bcc": [
        {
          "email": "james_doe@example.com",
          "name": "Jim Doe"
        }
      ]
    },
    {
      "from": {
        "email": "sales@example.com",
        "name": "Example Sales Team"
      },
      "to": [
        {
          "email": "janice_doe@example.com",
          "name": "Janice Doe"
        }
      ],
      "bcc": [
        {
          "email": "jordan_doe@example.com",
          "name": "Jordan Doe"
        }
      ]
    }
  ],
  "from": {
    "email": "orders@example.com",
    "name": "Example Order Confirmation"
  },
  "reply_to": {
    "email": "customer_service@example.com",
    "name": "Example Customer Service Team"
  },
  "subject": "Your Example Order Confirmation",
  "content": [
    {
      "type": "text/html",
      "value": "<p>Hello from Twilio SendGrid!</p><p>Sending with the email service trusted by developers and marketers for <strong>time-savings</strong>, <strong>scalability</strong>, and <strong>delivery expertise</strong>.</p><p>%open-track%</p>"
    }
  ],
  "attachments": [
    {
      "content": "PCFET0NUWVBFIGh0bWw+CjxodG1sIGxhbmc9ImVuIj4KCiAgICA8aGVhZD4KICAgICAgICA8bWV0YSBjaGFyc2V0PSJVVEYtOCI+CiAgICAgICAgPG1ldGEgaHR0cC1lcXVpdj0iWC1VQS1Db21wYXRpYmxlIiBjb250ZW50PSJJRT1lZGdlIj4KICAgICAgICA8bWV0YSBuYW1lPSJ2aWV3cG9ydCIgY29udGVudD0id2lkdGg9ZGV2aWNlLXdpZHRoLCBpbml0aWFsLXNjYWxlPTEuMCI+CiAgICAgICAgPHRpdGxlPkRvY3VtZW50PC90aXRsZT4KICAgIDwvaGVhZD4KCiAgICA8Ym9keT4KCiAgICA8L2JvZHk+Cgo8L2h0bWw+Cg==",
      "filename": "index.html",
      "type": "text/html",
      "disposition": "attachment"
    }
  ],
  "categories": [
    "cake",
    "pie",
    "baking"
  ],
  "send_at": 1617260400,
  "batch_id": "AsdFgHjklQweRTYuIopzXcVBNm0aSDfGHjklmZcVbNMqWert1znmOP2asDFjkl",
  "asm": {
    "group_id": 12345,
    "groups_to_display": [
      12345
    ]
  },
  "ip_pool_name": "transactional email",
  "mail_settings": {
    "bypass_list_management": {
      "enable": false
    },
    "footer": {
      "enable": false
    },
    "sandbox_mode": {
      "enable": false
    }
  },
  "tracking_settings": {
    "click_tracking": {
      "enable": true,
      "enable_text": false
    },
    "open_tracking": {
      "enable": true,
      "substitution_tag": "%open-track%"
    },
    "subscription_tracking": {
      "enable": false
    }
  }
}
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "aliqua"
    },
    {
      "message": "culpa dolor dolore"
    }
  ]
}

Cancel Scheduled Sends(7 operations)

Header NameExample
on-behalf-of"amet culpa dolor"
Request Payload
Response Payload
{
  "batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi"
}
{
  "errors": [
    {
      "message": "eu nulla",
      "field": "officia nisi velit",
      "help": {}
    },
    {
      "message": "consectetur irure culpa occaecat",
      "field": "consequat adipisicing enim",
      "help": {}
    },
    {
      "message": "tempor quis",
      "field": "reprehenderit tempor minim veniam",
      "help": {}
    },
    {
      "message": "cupidatat cillum veniam culpa in",
      "field": "tempor deserunt eu",
      "help": {}
    },
    {
      "message": "ut in pariatur",
      "field": "dolore",
      "help": {}
    }
  ],
  "id": "occaecat magna Duis"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "sit"
    },
    {
      "message": "amet elit"
    }
  ]
}
Header NameExample
on-behalf-of"Ut occaecat minim anim ut"
Request Payload
{
  "batch_id": "YOUR_BATCH_ID",
  "status": "pause"
}
Response Payload
{
  "batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi",
  "status": "pause"
}
{
  "errors": [
    {
      "message": "aliquip elit dolor",
      "field": "dolor qui enim non",
      "help": {}
    },
    {
      "message": "cillum dolore",
      "field": "non officia",
      "help": {}
    },
    {
      "message": "non tempor incididunt",
      "field": "aute laborum exercitation veniam",
      "help": {}
    },
    {
      "message": "tempor labore",
      "field": "dolor culpa",
      "help": {}
    },
    {
      "message": "in ut enim magna ex",
      "field": "veniam enim",
      "help": {}
    }
  ],
  "id": "pariatur commodo"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ipsum voluptate veniam in"
    },
    {
      "message": "pariatur"
    },
    {
      "message": "tempor officia"
    }
  ]
}
Header NameExample
on-behalf-of"reprehenderit ipsum et id occaecat"
Request Payload
Response Payload
[
  {
    "batch_id": "QzZmYzLTVWIwYgYzJlM2NhNWI",
    "status": "cancel"
  },
  {
    "batch_id": "mQzZmYzLTVlM2NhNWIwYgYzJl",
    "status": "cancel"
  }
]
{
  "errors": [
    {
      "message": "et dolor ad",
      "field": "nostrud quis",
      "help": {}
    },
    {
      "message": "proident",
      "field": "eu in",
      "help": {}
    },
    {
      "message": "nulla qui adipisicing",
      "field": "adipisicing laborum aliquip cupidatat labore",
      "help": {}
    }
  ],
  "id": "deserunt velit"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "incididunt"
    },
    {
      "message": "Lorem ut exercitation sit et"
    },
    {
      "message": "cupidatat"
    },
    {
      "message": "ex in officia exercitation pariatur"
    },
    {
      "message": "sint labore nisi"
    }
  ]
}
Header NameExample
on-behalf-of"anim aliquip do"
Request Payload
Response Payload
{
  "batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi"
}
{
  "errors": [
    {
      "message": "ex",
      "field": "mollit officia",
      "help": {}
    },
    {
      "message": "irure",
      "field": "sint culpa qui proident occaecat",
      "help": {}
    },
    {
      "message": "ullamco consectetur tempor in nisi",
      "field": "eiusmod ea",
      "help": {}
    },
    {
      "message": "fugiat",
      "field": "officia laboris elit et ad",
      "help": {}
    },
    {
      "message": "quis exercitation et aliquip",
      "field": "ea amet culpa",
      "help": {}
    }
  ],
  "id": "in sint dolore sed"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "pariatur magna in laboris"
    },
    {
      "message": "in amet id"
    },
    {
      "message": "enim Ut esse"
    }
  ]
}
Header NameExample
on-behalf-of"commodo"
Request Payload
Response Payload
[
  {
    "batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi",
    "status": "cancel"
  },
  {
    "batch_id": "IbLdyLYULb7Rj8GKSx7u025ouWVlAiMg",
    "status": "pause"
  }
]
{
  "errors": [
    {
      "message": "Ut",
      "field": "eu occaecat pariatur",
      "help": {}
    },
    {
      "message": "mollit qui minim ipsum",
      "field": "aute Lorem sed laborum tempor",
      "help": {}
    },
    {
      "message": "irure pariatur quis incididunt sunt",
      "field": "sed Excepteur est cupidatat pariatur",
      "help": {}
    },
    {
      "message": "culpa velit ut sint",
      "field": "adipisicing commodo veniam",
      "help": {}
    }
  ],
  "id": "labore sunt cillum anim"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "veniam mollit magna non"
    },
    {
      "message": "consectetur"
    },
    {
      "message": "velit"
    }
  ]
}
Header NameExample
on-behalf-of"do"
Request Payload
{
  "status": "pause"
}
Response Payload
Error generating example
{
  "errors": [
    {
      "message": "velit deserunt ut",
      "field": "tempor nisi minim",
      "help": {}
    },
    {
      "message": "culpa aliquip et reprehenderit fugiat",
      "field": "in velit",
      "help": {}
    }
  ],
  "id": "proident"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "reprehenderit enim eu sunt ex"
    }
  ]
}
Header NameExample
on-behalf-of"nisi enim sint velit"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "fugiat irure nostrud ullamco",
      "field": "incididunt ex mollit",
      "help": {}
    },
    {
      "message": "ex quis velit deserunt",
      "field": "est reprehenderit eu",
      "help": {}
    },
    {
      "message": "deserunt tempor occaecat elit consectetur",
      "field": "proident",
      "help": {}
    },
    {
      "message": "cillum",
      "field": "ut Duis",
      "help": {}
    }
  ],
  "id": "sed elit sint nostrud"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "eiusmod"
    },
    {
      "message": "Excepteur in do"
    }
  ]
}

API Keys(6 operations)

Header NameExample
on-behalf-of"ut do adipisicing Duis anim"
Request Payload
{
  "name": "My API Key",
  "scopes": [
    "mail.send",
    "alerts.create",
    "alerts.read"
  ]
}
Response Payload
{
  "api_key": "SG.xxxxxxxx.yyyyyyyy",
  "api_key_id": "xxxxxxxx",
  "name": "My API Key",
  "scopes": [
    "mail.send",
    "alerts.create",
    "alerts.read"
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "incididunt"
    },
    {
      "message": "Ut"
    },
    {
      "message": "in do"
    }
  ]
}
Query Parameter NameExample
limit21594865
Header NameExample
on-behalf-of"tempor aliqua dolor labore mollit"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "API Key Name",
      "api_key_id": "some-apikey-id"
    },
    {
      "name": "API Key Name 2",
      "api_key_id": "another-apikey-id"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "reprehenderit"
    },
    {
      "message": "aliquip enim"
    },
    {
      "message": "ad tempor sit"
    },
    {
      "message": "voluptate culpa"
    }
  ]
}
Header NameExample
on-behalf-of"culpa"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "API Key Name",
      "api_key_id": "some-apikey-id"
    },
    {
      "name": "API Key Name 2",
      "api_key_id": "another-apikey-id"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "culpa officia incididunt"
    },
    {
      "message": "amet id Ut cillum consequat"
    },
    {
      "message": "adipisicing Lorem"
    },
    {
      "message": "nisi veniam"
    },
    {
      "message": "fugiat aliquip"
    }
  ]
}
Header NameExample
on-behalf-of"nostrud ullamco tempor do"
Request Payload
{
  "name": "A New Hope"
}
Response Payload
{
  "api_key_id": "qfTQ6KG0QBiwWdJ0-pCLCA",
  "name": "A New Hope"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "labore qui"
    },
    {
      "message": "consectetur nostrud"
    },
    {
      "message": "adipisicing commodo eu Excepteur"
    },
    {
      "message": "commodo"
    }
  ]
}
Header NameExample
on-behalf-of"deserunt velit dolor nulla"
Request Payload
{
  "name": "Profiles key",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ]
}
Response Payload
{
  "api_key_id": "qfTQ6KG0QBiwWdJ0-pCLCA",
  "name": "Profiles Key",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "nulla dolor deserunt"
    },
    {
      "message": "Lorem laboris aliquip"
    }
  ]
}
Header NameExample
on-behalf-of"in"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "minim non nulla ex"
    },
    {
      "message": "nisi ipsum ut velit"
    },
    {
      "message": "adipisicing"
    },
    {
      "message": "aliqua"
    },
    {
      "message": "eiusmod"
    }
  ]
}

API Key Permissions

Header NameExample
on-behalf-of"eiusmod"
Request Payload
Response Payload
{
  "scopes": [
    "mail.send",
    "alerts.create",
    "alerts.read"
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "dolor id ut pariatur qui"
    },
    {
      "message": "Lorem aliquip pariatur cillum nisi"
    },
    {
      "message": "laboris proident cupidatat occaecat"
    },
    {
      "message": "proident laborum dolor"
    },
    {
      "message": "irure sed"
    }
  ]
}

Settings - Enforced TLS(2 operations)

Header NameExample
on-behalf-of"proident quis non ipsum"
Request Payload
Response Payload
{
  "require_tls": false,
  "require_valid_cert": false
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "quis dolore"
    },
    {
      "message": "occaecat"
    }
  ]
}
Header NameExample
on-behalf-of"qui ad"
Request Payload
{
  "require_tls": true,
  "require_valid_cert": true
}
Response Payload
{
  "require_tls": true,
  "require_valid_cert": false
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "sed pariatur"
    },
    {
      "message": "sed dolore tempor in nulla"
    },
    {
      "message": "ullamco exercitation consequat"
    },
    {
      "message": "in proident"
    },
    {
      "message": "adipisicing ut cillum"
    }
  ]
}

IP Access Management(6 operations)

Header NameExample
on-behalf-of"irure sed laboris"
Request Payload
{
  "ips": [
    {
      "ip": "192.168.1.1"
    },
    {
      "ip": "192.*.*.*"
    },
    {
      "ip": "192.168.1.3/32"
    }
  ]
}
Response Payload
{
  "result": [
    {
      "id": 1,
      "ip": "192.168.1.1/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    },
    {
      "id": 2,
      "ip": "192.0.0.0/8",
      "created_at": 1441824715,
      "updated_at": 1441824715
    },
    {
      "id": 3,
      "ip": "192.168.1.3/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "Ut veniam laborum aliquip in"
    }
  ]
}
Header NameExample
on-behalf-of"ipsum id"
Request Payload
Response Payload
{
  "result": [
    {
      "id": 1,
      "ip": "192.168.1.1/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    },
    {
      "id": 2,
      "ip": "192.168.1.2/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    },
    {
      "id": 3,
      "ip": "192.168.1.3/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "in labore in"
    },
    {
      "message": "adipisicing in ad sit"
    }
  ]
}
Header NameExample
on-behalf-of"cupidatat Excepteur"
Request Payload
{
  "ids": [
    1,
    2,
    3
  ]
}
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "culpa esse consequat"
    }
  ]
}
Query Parameter NameExample
limit57314194
Header NameExample
on-behalf-of"magna aliquip mollit minim"
Request Payload
Response Payload
{
  "result": [
    {
      "allowed": false,
      "auth_method": "Web",
      "first_at": 1444087966,
      "ip": "1.1.1.1",
      "last_at": 1444406672,
      "location": "Australia"
    },
    {
      "allowed": false,
      "auth_method": "Web",
      "first_at": 1444087505,
      "ip": "1.2.3.48",
      "last_at": 1444087505,
      "location": "Mukilteo, Washington"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "eiusmod esse"
    }
  ]
}
Header NameExample
on-behalf-of"veniam mollit quis"
Request Payload
Response Payload
{
  "id": 1,
  "ip": "192.168.1.1",
  "created_at": 1441824715,
  "updated_at": 1441824715
}
Header NameExample
on-behalf-of"aute"
Request Payload
Response Payload
{}

Certificates(5 operations)

Request Payload
{
  "public_certificate": "<your x509 certificate>",
  "enabled": false,
  "integration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}
Response Payload
{
  "public_certificate": "<your x509 certificate>",
  "id": 66138975,
  "not_before": 1621289880,
  "not_after": 1621289880,
  "intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}
[
  {
    "message": "adipisicing sed",
    "field": null,
    "error_id": "nostrud irure sunt"
  },
  {
    "message": "ut ea",
    "field": "in sed",
    "error_id": "veniam"
  }
]
[
  {
    "message": "Ut",
    "field": null,
    "error_id": "non"
  },
  {
    "message": "Duis in dolor ipsum ea",
    "field": null,
    "error_id": "officia sunt"
  },
  {
    "message": "ipsum cillum ea",
    "field": "ullamco exercitation occaecat Excepteur",
    "error_id": "esse Lorem"
  },
  {
    "message": "officia sed Ut dolor",
    "field": null,
    "error_id": "ad aute"
  }
]
[
  {
    "message": "est dolor nostrud",
    "field": "ullamco",
    "error_id": "laborum voluptate irure nostrud ut"
  },
  {
    "message": "dolore ipsum consectetur voluptate id",
    "field": null,
    "error_id": "in ex eiusmod"
  },
  {
    "message": "voluptate laborum nulla dolore",
    "field": null,
    "error_id": "in Ut"
  },
  {
    "message": "aliquip aliqua non nulla",
    "field": "velit elit ut veniam",
    "error_id": "fugiat elit aliquip eiusmod deserunt"
  },
  {
    "message": "sit proident",
    "field": "ad Duis fugiat",
    "error_id": "aliqua Duis deserunt"
  }
]
[
  {
    "message": "dolor",
    "field": "enim consequat magna tempor esse",
    "error_id": "eu ex nulla Lorem sunt"
  },
  {
    "message": "labore nulla ea",
    "field": null,
    "error_id": "ullamco veniam cupidatat quis"
  }
]
[
  {
    "message": "commodo incididunt dolore",
    "field": "voluptate",
    "error_id": "consectetur nisi laboris et Excepteur"
  }
]
Request Payload
Response Payload
[
  {
    "public_certificate": "<your x509 certificate>",
    "id": 66138975,
    "not_before": 1621289880,
    "not_after": 1621289880,
    "intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
  }
]
[
  {
    "message": "in officia",
    "field": "elit",
    "error_id": "qui"
  },
  {
    "message": "est",
    "field": null,
    "error_id": "ut"
  },
  {
    "message": "eiusmod reprehenderit Excepteur dolor dolore",
    "field": null,
    "error_id": "aliquip ipsum"
  }
]
[
  {
    "message": "ex ea",
    "field": "ipsum eiusmod anim nulla dolore",
    "error_id": "sint esse et quis ipsum"
  },
  {
    "message": "cillum officia velit",
    "field": "reprehenderit laborum eiusmod adipisicing",
    "error_id": "Lorem"
  }
]
[
  {
    "message": "laborum quis",
    "field": "ipsum",
    "error_id": "tempor"
  },
  {
    "message": "ullamco anim quis aliquip sunt",
    "field": "elit in in esse",
    "error_id": "aliqua fugiat ea dolor ullamco"
  },
  {
    "message": "incididunt",
    "field": null,
    "error_id": "consequat"
  },
  {
    "message": "fugiat aliqua quis minim sunt",
    "field": "incididunt ut ipsum elit esse",
    "error_id": "ut aliquip id"
  }
]
[
  {
    "message": "fugiat",
    "field": "voluptate do",
    "error_id": "aute commodo reprehenderit"
  },
  {
    "message": "eu",
    "field": "aliquip ex proident laboris",
    "error_id": "esse et"
  },
  {
    "message": "Duis sit",
    "field": "quis ea ipsum Excepteur",
    "error_id": "ut sit in"
  },
  {
    "message": "eu sit",
    "field": "ipsum labore laborum in",
    "error_id": "amet sit et"
  },
  {
    "message": "non aliquip proident officia",
    "field": "laboris amet eiusmod",
    "error_id": "elit minim adipisicing qui Excepteur"
  }
]
[
  {
    "message": "elit",
    "field": null,
    "error_id": "tempor"
  },
  {
    "message": "nostrud aliquip labore sint Ut",
    "field": "consectetur ut dolore qui",
    "error_id": "nostrud Lorem non do"
  },
  {
    "message": "aute sunt in",
    "field": "voluptate mollit magna",
    "error_id": "laboris"
  },
  {
    "message": "aliquip",
    "field": null,
    "error_id": "id adipisicing ipsum"
  }
]
Request Payload
Response Payload
{
  "public_certificate": "<your x509 certificate>",
  "id": 66138975,
  "not_before": 1621289880,
  "not_after": 1621289880,
  "intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}
[
  {
    "message": "enim ipsum",
    "field": "consectetur",
    "error_id": "culpa nostrud"
  },
  {
    "message": "dolore reprehenderit nisi",
    "field": "consectetur esse Excepteur fugiat",
    "error_id": "eu esse dolor est tempor"
  },
  {
    "message": "sunt sed",
    "field": null,
    "error_id": "cillum aliquip"
  },
  {
    "message": "veniam cillum do esse Duis",
    "field": null,
    "error_id": "exercitation voluptate"
  },
  {
    "message": "ea aliqua eiusmod ad laborum",
    "field": null,
    "error_id": "labore elit"
  }
]
[
  {
    "message": "aute pariatur in",
    "field": "mollit in",
    "error_id": "ea cupidatat velit enim id"
  }
]
[
  {
    "message": "dolore Lorem",
    "field": null,
    "error_id": "cupidatat est occaecat"
  },
  {
    "message": "labore sed dolore eiusmod",
    "field": null,
    "error_id": "incididunt culpa Excepteur"
  }
]
[
  {
    "message": "nostrud",
    "field": null,
    "error_id": "fugiat aliqua Lorem in"
  },
  {
    "message": "nulla in est amet",
    "field": "eu irure officia labore",
    "error_id": "fugiat"
  },
  {
    "message": "aute pariatur",
    "field": "eiusmod amet ea",
    "error_id": "dolore in pariatur nulla eu"
  }
]
[
  {
    "message": "reprehenderit laboris",
    "field": null,
    "error_id": "Ut in eiusmod cillum velit"
  },
  {
    "message": "magna",
    "field": "labore sed veniam velit",
    "error_id": "qui anim consequat dolor pariatur"
  },
  {
    "message": "anim",
    "field": null,
    "error_id": "ex amet dolor tempor mollit"
  },
  {
    "message": "sunt enim",
    "field": "anim ut fugiat dolore",
    "error_id": "voluptate do commodo"
  }
]
Request Payload
{
  "public_certificate": "<your x509 certificate>",
  "enabled": false,
  "intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}
Response Payload
[
  {
    "message": "et adipisicing culpa",
    "field": "fugiat",
    "error_id": "culpa sunt cupidatat"
  },
  {
    "message": "commodo dolor",
    "field": "Lorem",
    "error_id": "sit voluptate"
  },
  {
    "message": "ut commodo aliquip amet Duis",
    "field": null,
    "error_id": "est velit qui et"
  },
  {
    "message": "sint Ut laborum",
    "field": "minim incididunt reprehenderit",
    "error_id": "commodo anim"
  }
]
[
  {
    "message": "sint id amet cupidatat exercitation",
    "field": "dolore velit",
    "error_id": "occaecat nostrud eu"
  },
  {
    "message": "tempor pariatur",
    "field": "enim",
    "error_id": "incididunt ut fugiat ullamco"
  }
]
[
  {
    "message": "tempor",
    "field": null,
    "error_id": "pariatur reprehenderit id dolore"
  },
  {
    "message": "tempor",
    "field": null,
    "error_id": "consectetur dolore"
  },
  {
    "message": "adipisicing magna",
    "field": null,
    "error_id": "eu fugiat sed proident qui"
  },
  {
    "message": "eu adipisicing magna aute culpa",
    "field": null,
    "error_id": "ex sed eiusmod"
  },
  {
    "message": "nisi tempor in irure est",
    "field": null,
    "error_id": "do velit sed"
  }
]
[
  {
    "message": "esse ut",
    "field": null,
    "error_id": "consectetur ipsum sed"
  },
  {
    "message": "anim",
    "field": "nostrud Lorem mollit sed",
    "error_id": "laborum"
  },
  {
    "message": "nisi irure dolor mollit",
    "field": null,
    "error_id": "esse"
  },
  {
    "message": "sit adipisicing laboris ullamco",
    "field": "eu nulla",
    "error_id": "mollit in elit"
  }
]
[
  {
    "message": "Excepteur voluptate ad elit",
    "field": "commodo sit voluptate Duis labore",
    "error_id": "adipisicing ea"
  },
  {
    "message": "ut ullamco",
    "field": "nulla id laboris enim culpa",
    "error_id": "incididunt ea labore"
  },
  {
    "message": "Duis in occaecat aliquip",
    "field": null,
    "error_id": "in culpa pariatur"
  }
]
Request Payload
Response Payload
{
  "public_certificate": "<your x509 certificate>",
  "id": 66138975,
  "not_before": 1621289880,
  "not_after": 1621289880,
  "intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}
[
  {
    "message": "sed pariatur laboris",
    "field": "proident",
    "error_id": "cillum occaecat quis incididunt"
  },
  {
    "message": "in incididunt anim",
    "field": null,
    "error_id": "ut reprehenderit"
  },
  {
    "message": "tempor Lorem dolor",
    "field": null,
    "error_id": "aliquip sed nostrud nulla Ut"
  }
]
[
  {
    "message": "aliqua tempor ad non consectetur",
    "field": "nisi consectetur voluptate et",
    "error_id": "dolore aliquip dolore amet"
  },
  {
    "message": "velit consequat eu veniam",
    "field": "et qui aliqua dolore consequat",
    "error_id": "id ad"
  },
  {
    "message": "in cupidatat",
    "field": "ut qui amet ex cillum",
    "error_id": "ut"
  },
  {
    "message": "laboris quis",
    "field": "in est mollit",
    "error_id": "voluptate ea minim ipsum nostrud"
  }
]
[
  {
    "message": "laborum nulla",
    "field": "tempor nisi quis",
    "error_id": "nisi dolor sint"
  },
  {
    "message": "nisi",
    "field": null,
    "error_id": "aliquip ex magna cupidatat"
  },
  {
    "message": "officia elit minim deserunt est",
    "field": null,
    "error_id": "nostrud eiusmod"
  }
]
[
  {
    "message": "voluptate nostrud ut veniam eiusmod",
    "field": "dolor aliqua",
    "error_id": "exercitation veniam"
  },
  {
    "message": "enim Excepteur ut deserunt voluptate",
    "field": "aliquip enim",
    "error_id": "ut eu"
  },
  {
    "message": "id",
    "field": null,
    "error_id": "mollit"
  },
  {
    "message": "eiusmod tempor quis",
    "field": "exercitation cupidatat",
    "error_id": "quis commodo"
  }
]
[
  {
    "message": "Excepteur culpa eu",
    "field": null,
    "error_id": "dolor deserunt Ut nulla cupidatat"
  },
  {
    "message": "adipisicing sit ut velit ut",
    "field": null,
    "error_id": "magna commodo ut"
  }
]

Single Sign-On Settings(5 operations)

Request Payload
{
  "name": "Twilio SendGrid",
  "enabled": true,
  "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
  "signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
  "entity_id": "http://www.okta.com/${org.externalKey}",
  "completed_integration": true,
  "id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}
Response Payload
{
  "name": "Twilio SendGrid",
  "enabled": true,
  "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
  "signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
  "entity_id": "http://www.okta.com/${org.externalKey}",
  "last_updated": 1621288964
}
[
  {
    "message": "nostrud labore consequat",
    "field": null,
    "error_id": "irure"
  },
  {
    "message": "ut",
    "field": null,
    "error_id": "sed"
  }
]
[
  {
    "message": "sunt anim adipisicing amet fugiat",
    "field": null,
    "error_id": "do ea"
  },
  {
    "message": "adipisicing",
    "field": null,
    "error_id": "ut quis"
  },
  {
    "message": "ea veniam est",
    "field": "sunt in aliqua",
    "error_id": "officia exercitation aute tempor"
  },
  {
    "message": "cillum sint qui aliqua eu",
    "field": "sit eu",
    "error_id": "sunt"
  },
  {
    "message": "ut nulla quis occaecat reprehenderit",
    "field": "laborum nulla sit elit",
    "error_id": "ipsum Duis Ut dolor"
  }
]
[
  {
    "message": "nostrud do",
    "field": "ut ea nulla nisi",
    "error_id": "anim ut nostrud"
  }
]
[
  {
    "message": "in velit eu consectetur nulla",
    "field": "nostrud mollit cupidatat aliqua Lorem",
    "error_id": "aliquip nisi elit ut"
  }
]
[
  {
    "message": "irure dolor",
    "field": null,
    "error_id": "ad"
  },
  {
    "message": "pariatur quis amet in cillum",
    "field": "minim consectetur incididunt aliqua labore",
    "error_id": "irure"
  },
  {
    "message": "nisi esse incididunt in",
    "field": "veniam nulla est laboris",
    "error_id": "Duis"
  }
]
Query Parameter NameExample
sifalse
Request Payload
Response Payload
[
  {
    "name": "Twilio SendGrid",
    "enabled": true,
    "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
    "signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
    "entity_id": "http://www.okta.com/${org.externalKey}",
    "last_updated": 1621288520,
    "completed_integration": true,
    "id": "b0b98502-9408-4b24-9e3d-31ed7cb15312",
    "single_signon_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312",
    "audience_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312"
  }
]
[
  {
    "message": "exercitation nisi irure",
    "field": "cillum Lorem officia minim qui",
    "error_id": "fugiat eu dolor irure"
  }
]
[
  {
    "message": "quis consequat ad pariatur",
    "field": null,
    "error_id": "consectetur nostrud adipisicing Duis sint"
  },
  {
    "message": "dolore labore anim",
    "field": "exercitation aliqua",
    "error_id": "eu ullamco"
  },
  {
    "message": "consequat nisi",
    "field": null,
    "error_id": "mollit labore ex"
  },
  {
    "message": "Lorem",
    "field": "aliqua in in sunt magna",
    "error_id": "ea eu"
  }
]
[
  {
    "message": "sint in eiusmod ullamco voluptate",
    "field": "do nisi commodo laborum aute",
    "error_id": "ad adipisicing"
  },
  {
    "message": "aliquip cupidatat reprehenderit esse",
    "field": null,
    "error_id": "voluptate id enim sit"
  }
]
[
  {
    "message": "enim cupidatat id sunt",
    "field": null,
    "error_id": "et ut commodo"
  },
  {
    "message": "occaecat velit",
    "field": "ea aliquip enim pariatur elit",
    "error_id": "dolore enim esse"
  }
]
[
  {
    "message": "quis",
    "field": "laborum in dolor",
    "error_id": "cillum"
  },
  {
    "message": "irure laborum ut aliqua",
    "field": null,
    "error_id": "Excepteur minim eiusmod"
  },
  {
    "message": "consequat occaecat aliqua est incididunt",
    "field": null,
    "error_id": "Ut non eu ut consequat"
  },
  {
    "message": "dolor dolor",
    "field": "sed",
    "error_id": "ex magna in sunt"
  },
  {
    "message": "Lorem mollit ut nulla",
    "field": null,
    "error_id": "officia proident et"
  }
]
Query Parameter NameExample
sitrue
Request Payload
Response Payload
{
  "name": "Twilio SendGrid",
  "enabled": true,
  "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
  "signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
  "entity_id": "http://www.okta.com/${org.externalKey}",
  "last_updated": 1621288964,
  "completed_integration": true,
  "id": "b0b98502-9408-4b24-9e3d-31ed7cb15312",
  "audience_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312"
}
[
  {
    "message": "ea Excepteur ullamco aliqua enim",
    "field": null,
    "error_id": "minim Duis ea dolore"
  },
  {
    "message": "Ut proident labore",
    "field": "Duis",
    "error_id": "aliqua aliquip labore"
  },
  {
    "message": "culpa ipsum do",
    "field": "velit tempor labore",
    "error_id": "dolore ut laboris"
  },
  {
    "message": "consequat cillum",
    "field": null,
    "error_id": "aute cillum"
  },
  {
    "message": "aliqua",
    "field": "pariatur aute",
    "error_id": "quis magna dolor adipisicing"
  }
]
[
  {
    "message": "veniam consequat",
    "field": "esse incididunt adipisicing officia deserunt",
    "error_id": "non fugiat commodo"
  },
  {
    "message": "ad",
    "field": null,
    "error_id": "quis eiusmod dolor"
  }
]
[
  {
    "message": "in ex in sint officia",
    "field": "id dolor sit eu in",
    "error_id": "magna proident velit"
  },
  {
    "message": "amet elit cupidatat ullamco proident",
    "field": null,
    "error_id": "ut cupidatat Duis"
  }
]
[
  {
    "message": "irure ullamco aute",
    "field": null,
    "error_id": "minim"
  },
  {
    "message": "aliquip sit commodo dolor eiusmod",
    "field": "consectetur veniam reprehenderit Excepteur",
    "error_id": "proident culpa dolor"
  },
  {
    "message": "officia veniam nisi",
    "field": null,
    "error_id": "ut velit"
  },
  {
    "message": "dolore",
    "field": null,
    "error_id": "ut ad proident fugiat pariatur"
  }
]
[
  {
    "message": "labore et",
    "field": null,
    "error_id": "eu proident cupidatat qui"
  },
  {
    "message": "dolore sit qui",
    "field": "minim esse",
    "error_id": "dolor"
  },
  {
    "message": "ipsum",
    "field": null,
    "error_id": "incididunt deserunt"
  },
  {
    "message": "ut",
    "field": null,
    "error_id": "labore eiusmod nostrud"
  },
  {
    "message": "non reprehenderit",
    "field": "ut dolore velit irure ex",
    "error_id": "dolore cillum in"
  }
]
Query Parameter NameExample
sitrue
Request Payload
{
  "name": "Twilio SendGrid",
  "enabled": true,
  "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
  "signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
  "entity_id": "http://www.okta.com/${org.externalKey}",
  "last_updated": 1621288964,
  "completed_integration": true
}
Response Payload
{
  "name": "Twilio SendGrid",
  "enabled": true,
  "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
  "signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
  "entity_id": "http://www.okta.com/${org.externalKey}",
  "last_updated": 1621288964,
  "id": "b0b98502-9408-4b24-9e3d-31ed7cb15312",
  "single_signon_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312",
  "audience_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312"
}
[
  {
    "message": "adipisicing exercitation in Excepteur",
    "field": "enim laboris pariatur in et",
    "error_id": "ullamco dolore"
  },
  {
    "message": "quis nostrud dolore aliquip",
    "field": null,
    "error_id": "amet adipisicing"
  }
]
[
  {
    "message": "Ut",
    "field": "est voluptate ipsum cupidatat elit",
    "error_id": "dolore minim adipisicing"
  },
  {
    "message": "consectetur sed",
    "field": null,
    "error_id": "sed eu"
  },
  {
    "message": "amet qui",
    "field": "consequat ea nisi sit laborum",
    "error_id": "exercitation amet consectetur quis"
  },
  {
    "message": "occaecat",
    "field": "officia dolore",
    "error_id": "voluptate mollit ullamco minim"
  },
  {
    "message": "irure aliqua deserunt mollit",
    "field": "Excepteur elit commodo",
    "error_id": "reprehenderit ea deserunt aliquip"
  }
]
[
  {
    "message": "minim dolore commodo in cillum",
    "field": "ad dolore qui ut",
    "error_id": "exercitation ea sunt sint pariatur"
  },
  {
    "message": "in",
    "field": null,
    "error_id": "mollit sunt cupidatat velit labore"
  },
  {
    "message": "non deserunt dolore cupidatat tempor",
    "field": "nulla non nostrud id in",
    "error_id": "quis"
  },
  {
    "message": "anim irure culpa aliqua",
    "field": null,
    "error_id": "ipsum enim culpa"
  },
  {
    "message": "nostrud",
    "field": "est aliquip id incididunt officia",
    "error_id": "officia"
  }
]
[
  {
    "message": "in voluptate Ut",
    "field": null,
    "error_id": "consequat"
  },
  {
    "message": "minim officia Lorem",
    "field": "qui enim",
    "error_id": "minim"
  },
  {
    "message": "velit Ut",
    "field": null,
    "error_id": "proident adipisicing"
  }
]
[
  {
    "message": "non",
    "field": null,
    "error_id": "et veniam ipsum sed"
  }
]
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
[
  {
    "message": "Ut in consectetur Duis sint",
    "field": "eiusmod Excepteur est aute ea",
    "error_id": "qui"
  },
  {
    "message": "ipsum",
    "field": null,
    "error_id": "irure labore"
  }
]
[
  {
    "message": "sit amet",
    "field": "sint sit proident velit",
    "error_id": "qui"
  },
  {
    "message": "id occaecat",
    "field": null,
    "error_id": "nisi sunt eiusmod"
  },
  {
    "message": "fugiat magna consectetur sed",
    "field": null,
    "error_id": "elit cupidatat dolor ex"
  }
]
[
  {
    "message": "dolor pariatur cupidatat",
    "field": null,
    "error_id": "est"
  }
]
[
  {
    "message": "nisi non incididunt exercitation quis",
    "field": "Ut",
    "error_id": "culpa ut"
  },
  {
    "message": "Excepteur incididunt proident pariatur ullamco",
    "field": null,
    "error_id": "id ad sint"
  }
]
[
  {
    "message": "dolore",
    "field": null,
    "error_id": "voluptate"
  },
  {
    "message": "mollit do ex enim",
    "field": null,
    "error_id": "non Ut exercitation quis"
  },
  {
    "message": "officia pariatur",
    "field": "deserunt",
    "error_id": "consectetur exercitation cillum"
  }
]

Single Sign-On Teammates(2 operations)

Request Payload
{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane_doe@example.com",
  "scopes": [
    "mail.batch.create",
    "mail.batch.delete",
    "mail.batch.read",
    "mail.batch.update",
    "mail.send"
  ]
}
Response Payload
{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane_doe@example.com",
  "is_read_only": true,
  "username": "jane_doe@example.com",
  "is_sso": true
}
[
  {
    "message": "ad laboris cupidatat",
    "field": "eiusmod proident magna laboris do",
    "error_id": "proident"
  },
  {
    "message": "quis mollit",
    "field": null,
    "error_id": "sint non est sed"
  },
  {
    "message": "dolore",
    "field": "ullamco deserunt id dolore eu",
    "error_id": "in culpa"
  },
  {
    "message": "in deserunt minim exercitation",
    "field": null,
    "error_id": "consequat anim eiusmod Excepteur"
  },
  {
    "message": "mollit",
    "field": null,
    "error_id": "officia aute consequat proident ea"
  }
]
[
  {
    "message": "irure incididunt non id Ut",
    "field": "qui sunt aliquip in cupidatat",
    "error_id": "Duis"
  },
  {
    "message": "ullamco ut laboris ad",
    "field": null,
    "error_id": "in"
  },
  {
    "message": "Lorem",
    "field": "elit laboris sed",
    "error_id": "velit amet ipsum"
  },
  {
    "message": "voluptate in incididunt ex",
    "field": null,
    "error_id": "consequat Excepteur Lorem anim sint"
  },
  {
    "message": "voluptate",
    "field": "cillum tempor dolor eu labore",
    "error_id": "commodo sint qui non"
  }
]
[
  {
    "message": "proident est veniam velit anim",
    "field": null,
    "error_id": "eiusmod ad amet nisi"
  },
  {
    "message": "laborum amet",
    "field": "in cupidatat fugiat Excepteur amet",
    "error_id": "sit quis pariatur"
  },
  {
    "message": "irure ut magna",
    "field": null,
    "error_id": "Lorem"
  },
  {
    "message": "esse nisi pariatur exercitation aliquip",
    "field": "nostrud nulla Excepteur mollit irure",
    "error_id": "Excepteur eu"
  }
]
[
  {
    "message": "ut in dolore consequat laborum",
    "field": null,
    "error_id": "reprehenderit Duis sit"
  },
  {
    "message": "occaecat",
    "field": "ex nulla deserunt",
    "error_id": "id"
  },
  {
    "message": "enim",
    "field": null,
    "error_id": "ea in"
  },
  {
    "message": "sed officia veniam mollit ad",
    "field": "cupidatat eu mollit",
    "error_id": "adipisicing quis esse ut nulla"
  }
]
[
  {
    "message": "reprehenderit",
    "field": "minim veniam commodo in",
    "error_id": "laborum anim eiusmod pariatur"
  },
  {
    "message": "mollit sit Lorem consequat",
    "field": "dolore pariatur",
    "error_id": "eu tempor magna proident"
  },
  {
    "message": "ut pariatur ut Lorem ea",
    "field": null,
    "error_id": "voluptate dolor esse veniam"
  },
  {
    "message": "magna enim proident ad",
    "field": null,
    "error_id": "Excepteur proident elit cupidatat nostrud"
  }
]
Request Payload
{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane_doe@example.com",
  "scopes": [
    "mail.batch.create",
    "mail.batch.delete",
    "mail.batch.read",
    "mail.batch.update",
    "mail.send"
  ],
  "is_admin": false
}
Response Payload
{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane_doe@example.com",
  "is_admin": false,
  "username": "jane_doe@example.com",
  "is_sso": true,
  "address": "1234 Fake St.",
  "address2": "Suite 5",
  "city": "San Francisco",
  "state": "CA",
  "zip": "94105",
  "Country": "United States",
  "phone": "+15555555555",
  "user_type": "teammate"
}
[
  {
    "message": "veniam exercitation",
    "field": "commodo",
    "error_id": "nisi"
  },
  {
    "message": "quis",
    "field": null,
    "error_id": "consectetur voluptate"
  },
  {
    "message": "amet veniam aute enim",
    "field": null,
    "error_id": "irure mollit enim"
  },
  {
    "message": "dolor sit",
    "field": null,
    "error_id": "velit labore consequat mollit ut"
  },
  {
    "message": "mollit aliquip in",
    "field": null,
    "error_id": "aliquip Ut anim fugiat"
  }
]
[
  {
    "message": "sint pariatur",
    "field": "incididunt esse qui",
    "error_id": "et ipsum"
  }
]
[
  {
    "message": "consectetur",
    "field": null,
    "error_id": "Ut nisi dolore aute do"
  },
  {
    "message": "sint",
    "field": null,
    "error_id": "ut magna fugiat aute aliquip"
  },
  {
    "message": "reprehenderit consectetur dolor dolore laborum",
    "field": "consectetur ipsum ad laboris",
    "error_id": "anim occaecat ad amet"
  }
]
[
  {
    "message": "dolor commodo elit nisi",
    "field": null,
    "error_id": "in in anim"
  },
  {
    "message": "velit cillum elit qui",
    "field": "consectetur",
    "error_id": "ipsum in"
  },
  {
    "message": "veniam non ipsum commodo amet",
    "field": "culpa",
    "error_id": "do dolor anim"
  },
  {
    "message": "et in",
    "field": null,
    "error_id": "elit et exercitation ipsum"
  }
]
[
  {
    "message": "quis",
    "field": null,
    "error_id": "amet aliquip"
  },
  {
    "message": "ex",
    "field": "dolor aliquip deserunt in do",
    "error_id": "ullamco nulla ea minim"
  },
  {
    "message": "magna consequat",
    "field": null,
    "error_id": "nisi aliquip et sed"
  },
  {
    "message": "sit enim",
    "field": null,
    "error_id": "cupidatat non deserunt"
  },
  {
    "message": "in voluptate consequat",
    "field": "voluptate",
    "error_id": "est"
  }
]

Settings - Mail(13 operations)

Query Parameter NameExample
limit4946726
offset28156877
Header NameExample
on-behalf-of"amet sunt est et"
Request Payload
Response Payload
{
  "result": [
    {
      "title": "Address Whitelist",
      "enabled": false,
      "name": "address_whitelist",
      "description": "Address / domains that should never have email suppressed."
    },
    {
      "title": "Bounce Purge",
      "enabled": false,
      "name": "bounce_purge",
      "description": "Allows you to automatically purge bounce records from SendGrid after a specified number of days."
    },
    {
      "title": "Event Notification",
      "enabled": true,
      "name": "event_notify",
      "description": "Controls notifications for events, such as bounces, clicks, and opens."
    },
    {
      "title": "Footer",
      "enabled": false,
      "name": "footer",
      "description": "Allows you to add a custom footer to outgoing email."
    },
    {
      "title": "Forward Bounce",
      "enabled": true,
      "name": "forward_bounce",
      "description": "Allows you to forward bounces to a specific email address."
    },
    {
      "title": "Forward Spam",
      "enabled": false,
      "name": "forward_spam",
      "description": "Allows for a copy of spam reports to be forwarded to an email address."
    },
    {
      "title": "Legacy Email Template",
      "enabled": true,
      "name": "template",
      "description": "Allows you to customize your outgoing HTML emails."
    },
    {
      "title": "Plain Content",
      "enabled": false,
      "name": "plain_content",
      "description": "Convert your plain text emails to HTML."
    },
    {
      "title": "Spam Checker",
      "enabled": true,
      "name": "spam_check",
      "description": "Check outbound messages for spam content."
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sit dolor et voluptate tempor",
      "field": null,
      "message": "laboris quis",
      "parameter": "proident"
    },
    {
      "error_id": "nostrud",
      "field": "deserunt",
      "message": "tempor ad occaecat consectetur",
      "parameter": "anim sint consequat"
    },
    {
      "error_id": "aliqua eu laborum enim",
      "field": "ex elit incididunt",
      "message": "qui in",
      "parameter": "irure cillum incididunt dolore"
    },
    {
      "error_id": "tempor",
      "field": null,
      "message": "labore officia amet sit culpa",
      "parameter": "proident deserunt Lorem dolore"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "id Lorem dolor",
      "field": "enim nulla laborum sunt",
      "message": "ullamco commodo",
      "parameter": "id esse amet aliqua est"
    },
    {
      "error_id": "ut",
      "field": "commodo ullamco elit in voluptate",
      "message": "dolor Lorem Excepteur cillum",
      "parameter": "ex"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "minim culpa",
      "field": null,
      "message": "enim mollit aliquip fugiat in",
      "parameter": "magna cillum"
    },
    {
      "error_id": "velit sunt nisi ad anim",
      "field": null,
      "message": "minim voluptate cillum nisi",
      "parameter": "eiusmod sed ullamco"
    },
    {
      "error_id": "incididunt sit nostrud ipsum labore",
      "field": null,
      "message": "ut ex qui commodo incididunt",
      "parameter": "exercitation in"
    },
    {
      "error_id": "eiusmod veniam",
      "field": "quis nostrud eiusmod veniam",
      "message": "mollit dolor est qui",
      "parameter": "anim adipisicing elit aliquip"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "et in ad tempor",
      "field": null,
      "message": "aute",
      "parameter": "nostrud nulla aliquip"
    },
    {
      "error_id": "officia nulla",
      "field": "dolore non sint et incididunt",
      "message": "id",
      "parameter": "commodo ipsum nisi"
    },
    {
      "error_id": "commodo",
      "field": "incididunt",
      "message": "dolore officia elit adipisicing do",
      "parameter": "occaecat ea sint adipisicing voluptate"
    },
    {
      "error_id": "ex veniam",
      "field": "ad aliqua non in labore",
      "message": "consectetur culpa ipsum officia",
      "parameter": "do enim est sed consequat"
    },
    {
      "error_id": "in non id",
      "field": "deserunt nulla",
      "message": "commodo cillum in quis",
      "parameter": "ad"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "deserunt",
      "field": null,
      "message": "ad officia dolor",
      "parameter": "Ut dolor tempor enim Lorem"
    },
    {
      "error_id": "Lorem elit dolor sed labore",
      "field": "voluptate occaecat",
      "message": "dolore ad reprehenderit consectetur",
      "parameter": "nisi tempor"
    },
    {
      "error_id": "quis dolor",
      "field": "ut in nisi laboris tempor",
      "message": "voluptate",
      "parameter": "esse quis tempor"
    },
    {
      "error_id": "reprehenderit non deserunt ut commodo",
      "field": "veniam",
      "message": "minim deserunt eiusmod",
      "parameter": "sint"
    }
  ]
}
Header NameExample
on-behalf-of"officia do"
Request Payload
{
  "enabled": true,
  "list": [
    "email1@example.com",
    "example.com"
  ]
}
Response Payload
{
  "enabled": true,
  "list": [
    "email1@example.com"
  ]
}
{
  "errors": [
    {
      "error_id": "laborum",
      "field": "eiusmod eu",
      "message": "cupidatat Lorem consequat eu dolor",
      "parameter": "occaecat adipisicing laboris"
    },
    {
      "error_id": "aliquip amet Excepteur quis",
      "field": "anim pariatur",
      "message": "ipsum",
      "parameter": "consequat"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "consectetur voluptate incididunt",
      "field": "ipsum",
      "message": "sint Ut voluptate",
      "parameter": "consequat"
    },
    {
      "error_id": "magna",
      "field": "anim laboris cillum ea",
      "message": "cillum tempor",
      "parameter": "eiusmod velit ullamco labore"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "in sit consectetur",
      "field": "elit esse amet enim",
      "message": "qui ullamco ut consectetur in",
      "parameter": "incididunt"
    },
    {
      "error_id": "sed sunt enim",
      "field": null,
      "message": "non fugiat eiusmod",
      "parameter": "dolore aliquip do magna"
    },
    {
      "error_id": "velit",
      "field": null,
      "message": "fugiat do pariatur elit",
      "parameter": "id aliqua anim occaecat in"
    },
    {
      "error_id": "elit nulla minim quis",
      "field": null,
      "message": "non",
      "parameter": "ut ullamco ad exercitation"
    },
    {
      "error_id": "laborum velit",
      "field": "reprehenderit",
      "message": "aute nisi minim mollit pariatur",
      "parameter": "adipisicing sunt"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sed",
      "field": "labore do cillum",
      "message": "dolore",
      "parameter": "id aute do aliquip velit"
    },
    {
      "error_id": "est pariatur",
      "field": null,
      "message": "occaecat incididunt ipsum",
      "parameter": "et fugiat"
    },
    {
      "error_id": "minim esse ut pariatur",
      "field": null,
      "message": "ut magna",
      "parameter": "dolor"
    },
    {
      "error_id": "tempor",
      "field": null,
      "message": "do sed nisi",
      "parameter": "exercitation aliquip proident pariatur"
    },
    {
      "error_id": "dolore voluptate",
      "field": "ullamco consectetur mollit",
      "message": "ea id pariatur quis do",
      "parameter": "amet sunt Ut"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "consequat do sunt sit",
      "field": "incididunt sed minim",
      "message": "nulla ex",
      "parameter": "ex"
    },
    {
      "error_id": "culpa",
      "field": "minim in reprehenderit id Lorem",
      "message": "anim velit",
      "parameter": "non incididunt"
    },
    {
      "error_id": "ut",
      "field": null,
      "message": "dolore",
      "parameter": "nisi qui Ut"
    },
    {
      "error_id": "commodo",
      "field": "reprehenderit ipsum",
      "message": "tempor anim non in veniam",
      "parameter": "enim do sit"
    },
    {
      "error_id": "ad consectetur sed culpa",
      "field": "Excepteur irure pariatur incididunt exercitation",
      "message": "labore sunt amet sint Excepteur",
      "parameter": "magna ex mollit sit deserunt"
    }
  ]
}
Header NameExample
on-behalf-of"sunt magna nostrud in adipisicing"
Request Payload
Response Payload
{
  "enabled": true,
  "list": [
    "example.com",
    "jane_doe@example1.com"
  ]
}
{
  "errors": [
    {
      "error_id": "voluptate proident aliquip aute labore",
      "field": null,
      "message": "commodo irure occaecat dolor consectetur",
      "parameter": "velit officia in adipisicing laborum"
    },
    {
      "error_id": "incididunt occaecat dolore in",
      "field": null,
      "message": "adipisicing dolore",
      "parameter": "ut amet in ad incididunt"
    },
    {
      "error_id": "labore cillum elit magna",
      "field": null,
      "message": "in consequat ut voluptate consectetur",
      "parameter": "fugiat do Excepteur"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sint ut",
      "field": "fugiat",
      "message": "proident sunt in cillum",
      "parameter": "sunt"
    },
    {
      "error_id": "cillum amet deserunt in nisi",
      "field": null,
      "message": "enim eiusmod ad mollit",
      "parameter": "et in ullamco"
    },
    {
      "error_id": "fugiat Lorem",
      "field": null,
      "message": "proident laboris dolor laborum",
      "parameter": "voluptate Excepteur"
    },
    {
      "error_id": "occaecat",
      "field": null,
      "message": "anim in",
      "parameter": "irure dolor consequat tempor exercitation"
    },
    {
      "error_id": "laborum aute minim ipsum ut",
      "field": "dolor",
      "message": "esse dolore in ea",
      "parameter": "consequat ad amet Excepteur"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "irure",
      "field": "dolore consectetur proident",
      "message": "in officia",
      "parameter": "ut laboris"
    },
    {
      "error_id": "tempor minim aliquip in Lorem",
      "field": "ullamco",
      "message": "voluptate dolor ea deserunt",
      "parameter": "laboris cupidatat occaecat"
    },
    {
      "error_id": "dolor commodo ea cillum",
      "field": null,
      "message": "ut",
      "parameter": "elit ex"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "tempor cupidatat eiusmod",
      "field": null,
      "message": "dolor est cupidatat reprehenderit",
      "parameter": "adipisicing labore veniam quis anim"
    },
    {
      "error_id": "esse quis",
      "field": null,
      "message": "enim sunt laborum ut deserunt",
      "parameter": "ex elit consectetur"
    },
    {
      "error_id": "aute dolore ut do",
      "field": "deserunt minim et",
      "message": "nisi velit culpa",
      "parameter": "enim"
    },
    {
      "error_id": "magna Duis",
      "field": "ex",
      "message": "anim culpa",
      "parameter": "laborum esse do dolor aliqua"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ad",
      "field": "tempor eu dolore",
      "message": "amet",
      "parameter": "occaecat labore nulla"
    },
    {
      "error_id": "consectetur ullamco",
      "field": "consequat Duis elit ea",
      "message": "nisi Excepteur quis nulla",
      "parameter": "laborum nostrud amet veniam sed"
    },
    {
      "error_id": "consectetur ullamco nisi incididunt",
      "field": "esse aliqua",
      "message": "amet",
      "parameter": "sed Duis non exercitation"
    }
  ]
}
Header NameExample
on-behalf-of"aliquip qui"
Request Payload
{
  "enabled": true,
  "html_content": "<p><a href=\"http://example.com\" target=\"_blank\">Ahoy, World!</a></p>\n",
  "plain_content": ""
}
Response Payload
{
  "enabled": true,
  "html_content": "<p><a href=\"http://example.com\" target=\"_blank\">Ahoy, World!</a></p>\n",
  "plain_content": ""
}
{
  "errors": [
    {
      "error_id": "consequat anim sed",
      "field": null,
      "message": "ut velit eiusmod adipisicing Ut",
      "parameter": "amet"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "anim dolor",
      "field": "aute dolor",
      "message": "eu eiusmod voluptate consectetur",
      "parameter": "Excepteur ex laborum"
    },
    {
      "error_id": "culpa consectetur ut",
      "field": null,
      "message": "id",
      "parameter": "quis veniam id eiusmod ipsum"
    },
    {
      "error_id": "eiusmod ut Duis laborum deserunt",
      "field": null,
      "message": "sint dolore laboris veniam",
      "parameter": "exercitation elit Lorem"
    },
    {
      "error_id": "sunt",
      "field": null,
      "message": "labore quis ullamco",
      "parameter": "commodo"
    },
    {
      "error_id": "cupidatat",
      "field": null,
      "message": "cillum Lorem",
      "parameter": "non officia ullamco et est"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "esse",
      "field": "qui",
      "message": "dolor deserunt",
      "parameter": "dolore Lorem dolor culpa officia"
    },
    {
      "error_id": "labore consequat",
      "field": null,
      "message": "Ut occaecat velit sunt",
      "parameter": "esse laboris dolor veniam Excepteur"
    },
    {
      "error_id": "cillum proident officia ea",
      "field": null,
      "message": "qui",
      "parameter": "sunt cillum Duis"
    },
    {
      "error_id": "incididunt sunt laboris minim sed",
      "field": null,
      "message": "consectetur ut",
      "parameter": "consequat cillum Excepteur pariatur"
    },
    {
      "error_id": "Ut in Excepteur aliqua",
      "field": "sed incididunt aliqua",
      "message": "consectetur",
      "parameter": "id et laboris nulla anim"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "elit",
      "field": null,
      "message": "laboris enim ad elit tempor",
      "parameter": "in dolor reprehenderit veniam Excepteur"
    },
    {
      "error_id": "qui dolore",
      "field": null,
      "message": "Excepteur",
      "parameter": "voluptate"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "mollit eiusmod dolor",
      "field": "do sunt ea qui",
      "message": "amet sint ipsum laboris",
      "parameter": "dolore esse velit est"
    },
    {
      "error_id": "ut quis aliqua aute laboris",
      "field": "ipsum irure cupidatat",
      "message": "reprehenderit",
      "parameter": "irure ullamco non nulla"
    },
    {
      "error_id": "aliquip",
      "field": null,
      "message": "fugiat dolor",
      "parameter": "voluptate aliqua Duis sunt"
    },
    {
      "error_id": "et",
      "field": null,
      "message": "aliquip magna fugiat",
      "parameter": "velit ad fugiat in aliquip"
    },
    {
      "error_id": "elit",
      "field": "pariatur",
      "message": "proident",
      "parameter": "anim sit fugiat pariatur tempor"
    }
  ]
}
Header NameExample
on-behalf-of"minim elit"
Request Payload
Response Payload
{
  "enabled": true,
  "html_content": "<p><a href=\"http://example.com\" target=\"_blank\">Ahoy, World!</a></p>\n",
  "plain_content": ""
}
{
  "errors": [
    {
      "error_id": "reprehenderit ut irure in",
      "field": null,
      "message": "cupidatat dolor sint",
      "parameter": "labore exercitation consequat"
    },
    {
      "error_id": "cillum esse",
      "field": null,
      "message": "in",
      "parameter": "Excepteur eu velit tempor esse"
    },
    {
      "error_id": "dolore",
      "field": "qui cillum veniam",
      "message": "pariatur sint",
      "parameter": "Excepteur labore ad cillum"
    },
    {
      "error_id": "in dolor deserunt",
      "field": null,
      "message": "esse sit reprehenderit",
      "parameter": "elit sunt quis Ut"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "id occaecat mollit voluptate qui",
      "field": "nulla sint",
      "message": "qui fugiat",
      "parameter": "ut pariatur"
    },
    {
      "error_id": "exercitation mollit",
      "field": null,
      "message": "dolore esse velit enim",
      "parameter": "nulla dolore eiusmod"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "non proident irure ut Duis",
      "field": null,
      "message": "aliqua officia ullamco adipisicing",
      "parameter": "veniam Ut non"
    },
    {
      "error_id": "et",
      "field": null,
      "message": "dolore exercitation",
      "parameter": "cupidatat officia dolor irure"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "esse",
      "field": null,
      "message": "consectetur esse culpa est nisi",
      "parameter": "cillum in pariatur et"
    },
    {
      "error_id": "cillum in",
      "field": "anim dolore consectetur aliquip amet",
      "message": "magna sed",
      "parameter": "Ut non do pariatur in"
    },
    {
      "error_id": "mollit ullamco commodo",
      "field": null,
      "message": "fugiat cupidatat do ipsum anim",
      "parameter": "aliquip consequat cupidatat"
    },
    {
      "error_id": "dolor eu ut reprehenderit elit",
      "field": null,
      "message": "tempor nulla commodo cupidatat irure",
      "parameter": "pariatur nostrud sint laboris"
    },
    {
      "error_id": "commodo laborum dolor",
      "field": "commodo dolore",
      "message": "enim exercitation non",
      "parameter": "dolore ullamco laborum ut"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sint",
      "field": null,
      "message": "dolor Lorem dolor amet deserunt",
      "parameter": "cillum"
    },
    {
      "error_id": "Lorem nisi irure Excepteur sed",
      "field": null,
      "message": "Lorem dolor ut",
      "parameter": "mollit sit dolore ipsum ea"
    },
    {
      "error_id": "in ut aliqua officia",
      "field": null,
      "message": "aliqua dolor tempor",
      "parameter": "do nisi proident"
    },
    {
      "error_id": "mollit tempor enim adipisicing nulla",
      "field": null,
      "message": "incididunt",
      "parameter": "do"
    },
    {
      "error_id": "culpa sit occaecat minim",
      "field": "reprehenderit mollit Lorem do officia",
      "message": "labore",
      "parameter": "reprehenderit deserunt et velit anim"
    }
  ]
}
Header NameExample
on-behalf-of"esse"
Request Payload
{
  "email": "abuse@example.com",
  "enabled": true
}
Response Payload
{
  "email": "abuse@example.com",
  "enabled": true
}
{
  "errors": [
    {
      "error_id": "ex amet non irure dolor",
      "field": "sunt consequat consectetur aliqua labore",
      "message": "anim reprehenderit sint",
      "parameter": "culpa commodo"
    },
    {
      "error_id": "irure culpa occaecat sit",
      "field": null,
      "message": "eu cupidatat id proident ut",
      "parameter": "fugiat dolore"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sunt",
      "field": "fugiat ut reprehenderit",
      "message": "est pariatur voluptate ea",
      "parameter": "ea amet"
    },
    {
      "error_id": "proident in",
      "field": null,
      "message": "commodo Excepteur qui sed magna",
      "parameter": "dolore in sunt id"
    },
    {
      "error_id": "ex velit exercitation dolor",
      "field": "laborum sint irure deserunt cillum",
      "message": "esse et",
      "parameter": "elit nostrud"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "nisi enim officia ut do",
      "field": null,
      "message": "labore aute",
      "parameter": "incididunt dolor Ut"
    },
    {
      "error_id": "sint velit",
      "field": null,
      "message": "irure quis dolor qui laborum",
      "parameter": "nulla"
    },
    {
      "error_id": "ipsum dolore ut exercitation",
      "field": "irure id ut",
      "message": "labore aliquip nostrud",
      "parameter": "nisi"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "exercitation deserunt culpa",
      "field": "dolor id esse incididunt",
      "message": "quis",
      "parameter": "irure ut est et"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "Excepteur",
      "field": "laborum dolor laboris",
      "message": "cillum id sit officia incididunt",
      "parameter": "anim id est"
    }
  ]
}
Header NameExample
on-behalf-of"minim id"
Request Payload
Response Payload
{
  "email": "abuse@example.com",
  "enabled": true
}
{
  "errors": [
    {
      "error_id": "ea reprehenderit commodo in",
      "field": null,
      "message": "sit esse dolor",
      "parameter": "ut culpa qui quis"
    },
    {
      "error_id": "eu qui",
      "field": null,
      "message": "anim dolor ut occaecat laboris",
      "parameter": "adipisicing aliqua Lorem pariatur"
    },
    {
      "error_id": "dolore do",
      "field": null,
      "message": "irure eiusmod aliquip dolor occaecat",
      "parameter": "et anim irure"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "aute cupidatat enim veniam",
      "field": "laborum voluptate",
      "message": "Lorem deserunt dolor aliqua in",
      "parameter": "aliqua cupidatat consequat ex"
    },
    {
      "error_id": "dolor Duis",
      "field": null,
      "message": "cupidatat nulla deserunt ex",
      "parameter": "do culpa"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "id sunt ullamco",
      "field": "occaecat nisi",
      "message": "minim Excepteur Duis cupidatat mollit",
      "parameter": "sed"
    },
    {
      "error_id": "consectetur Duis ut ut",
      "field": null,
      "message": "in minim Lorem quis sed",
      "parameter": "id nisi laboris est"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "cupidatat elit",
      "field": "anim laborum aliquip",
      "message": "voluptate Excepteur dolor incididunt",
      "parameter": "dolor labore tempor ullamco et"
    },
    {
      "error_id": "tempor eu amet",
      "field": null,
      "message": "veniam",
      "parameter": "cillum veniam pariatur ea"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "Duis aute",
      "field": "cupidatat",
      "message": "minim nostrud nisi exercitation tempor",
      "parameter": "deserunt aliquip non aute fugiat"
    },
    {
      "error_id": "exercitation irure Duis",
      "field": "enim nulla proident",
      "message": "velit incididunt id do",
      "parameter": "culpa magna"
    },
    {
      "error_id": "laboris tempor occaecat aliquip voluptate",
      "field": "officia",
      "message": "ea magna",
      "parameter": "amet et labore occaecat aliquip"
    },
    {
      "error_id": "nisi cillum veniam qui commodo",
      "field": null,
      "message": "ut consectetur velit dolore sunt",
      "parameter": "dolore aliqua culpa tempor"
    },
    {
      "error_id": "consectetur est",
      "field": "est dolor",
      "message": "magna minim incididunt",
      "parameter": "nostrud consectetur fugiat"
    }
  ]
}
Header NameExample
on-behalf-of"incididunt Excepteur"
Request Payload
{
  "enabled": true,
  "html_content": "<% body %>"
}
Response Payload
{
  "enabled": false,
  "html_content": "<p><% body %>Example</p>\n"
}
{
  "errors": [
    {
      "error_id": "Lorem sit laborum",
      "field": "proident exercitation eiusmod aliquip Ut",
      "message": "eu Duis pariatur",
      "parameter": "officia voluptate laborum incididunt"
    },
    {
      "error_id": "ut anim aliquip laboris",
      "field": null,
      "message": "tempor ut nisi Duis Lorem",
      "parameter": "voluptate cupidatat"
    },
    {
      "error_id": "esse ad culpa",
      "field": "officia reprehenderit sunt",
      "message": "incididunt ad culpa",
      "parameter": "pariatur"
    },
    {
      "error_id": "nostrud labore Duis ea",
      "field": "in fugiat ea sit dolor",
      "message": "nostrud sunt do occaecat deserunt",
      "parameter": "elit deserunt ut Duis anim"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "laboris ea",
      "field": null,
      "message": "enim aliqua",
      "parameter": "incididunt laborum sed proident"
    },
    {
      "error_id": "Excepteur minim veniam",
      "field": null,
      "message": "do est Lorem aute",
      "parameter": "in non"
    },
    {
      "error_id": "consequat nostrud amet",
      "field": "irure mollit pariatur exercitation",
      "message": "et ex ipsum officia",
      "parameter": "Duis aliqua proident Lorem"
    },
    {
      "error_id": "labore ipsum quis qui cillum",
      "field": null,
      "message": "adipisicing sint",
      "parameter": "consectetur aliqua commodo Ut"
    },
    {
      "error_id": "consectetur labore sit eu consequat",
      "field": null,
      "message": "eiusmod aliqua in sed Duis",
      "parameter": "tempor esse ullamco minim"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "non reprehenderit sint do dolor",
      "field": "adipisicing aute incididunt quis",
      "message": "ad in elit eiusmod",
      "parameter": "ex"
    },
    {
      "error_id": "elit",
      "field": null,
      "message": "pariatur dolore proident culpa deserunt",
      "parameter": "aute elit ut"
    },
    {
      "error_id": "ut esse",
      "field": "pariatur ex esse sit laborum",
      "message": "in consectetur laboris et",
      "parameter": "labore Ut amet"
    },
    {
      "error_id": "nostrud sint tempor consectetur",
      "field": "tempor est ut incididunt",
      "message": "magna anim consectetur dolor",
      "parameter": "Excepteur cupidatat magna minim ad"
    },
    {
      "error_id": "dolore proident deserunt aute commodo",
      "field": "consectetur ea",
      "message": "fugiat do non veniam",
      "parameter": "adipisicing cillum"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ut esse",
      "field": null,
      "message": "eiusmod",
      "parameter": "incididunt"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "consequat",
      "field": null,
      "message": "qui enim ipsum Excepteur",
      "parameter": "non laborum adipisicing"
    }
  ]
}
Header NameExample
on-behalf-of"nostrud Duis laborum"
Request Payload
Response Payload
{
  "enabled": false,
  "html_content": "<p><% body %>Example</p>\n"
}
{
  "errors": [
    {
      "error_id": "dolore fugiat",
      "field": "laboris",
      "message": "velit pariatur incididunt consequat",
      "parameter": "sed"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "consequat amet velit",
      "field": null,
      "message": "Ut nulla",
      "parameter": "sint ex ea voluptate"
    },
    {
      "error_id": "minim quis",
      "field": "do mollit",
      "message": "id laborum quis",
      "parameter": "dolor labore"
    },
    {
      "error_id": "esse est fugiat dolor adipisicing",
      "field": "Ut veniam nulla",
      "message": "quis incididunt ad",
      "parameter": "dolor consectetur amet dolor sint"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "elit in dolor anim",
      "field": "consequat magna",
      "message": "commodo dolor",
      "parameter": "velit Lorem exercitation"
    },
    {
      "error_id": "dolor in fugiat Duis",
      "field": "incididunt dolor et",
      "message": "sit dolore dolor",
      "parameter": "magna aliquip"
    },
    {
      "error_id": "ut voluptate",
      "field": "ut exercitation proident",
      "message": "anim sint",
      "parameter": "fugiat"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "laboris commodo fugiat ipsum consectetur",
      "field": "laborum Excepteur",
      "message": "nulla",
      "parameter": "commodo Excepteur amet cupidatat aute"
    },
    {
      "error_id": "aute aliquip cillum irure ea",
      "field": "laboris do commodo aute veniam",
      "message": "proident amet cupidatat in Excepteur",
      "parameter": "irure sunt officia Duis anim"
    },
    {
      "error_id": "id",
      "field": "tempor ipsum exercitation",
      "message": "ea nisi mollit",
      "parameter": "eu aliqua esse"
    },
    {
      "error_id": "incididunt",
      "field": "eu adipisicing in ut",
      "message": "velit",
      "parameter": "mollit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "irure dolor officia proident",
      "field": null,
      "message": "ut in dolore veniam Ut",
      "parameter": "consequat"
    },
    {
      "error_id": "exercitation magna elit enim",
      "field": "occaecat est anim",
      "message": "in nostrud non",
      "parameter": "non laboris in ea minim"
    },
    {
      "error_id": "esse dolore",
      "field": null,
      "message": "labore fugiat esse",
      "parameter": "amet reprehenderit culpa veniam non"
    },
    {
      "error_id": "ullamco sunt deserunt velit",
      "field": "irure pariatur nostrud culpa",
      "message": "nostrud",
      "parameter": "sit eu"
    },
    {
      "error_id": "est mollit incididunt",
      "field": "dolore",
      "message": "Ut non enim",
      "parameter": "reprehenderit fugiat est"
    }
  ]
}
Header NameExample
on-behalf-of"aliquip Duis irure nulla"
Request Payload
{
  "enabled": true,
  "hard_bounces": 5,
  "soft_bounces": 5
}
Response Payload
{
  "enabled": false,
  "hard_bounces": 5,
  "soft_bounces": 5
}
{
  "errors": [
    {
      "error_id": "dolor",
      "field": "amet ut",
      "message": "aliqua adipisicing dolore sit",
      "parameter": "irure"
    },
    {
      "error_id": "voluptate exercitation consectetur",
      "field": "dolore sint in Duis",
      "message": "sed",
      "parameter": "amet proident quis est"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "in enim",
      "field": "culpa",
      "message": "Lorem",
      "parameter": "esse anim labore in"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "aute",
      "field": "eu amet Ut officia laborum",
      "message": "velit",
      "parameter": "dolore"
    },
    {
      "error_id": "cillum eiusmod in ut",
      "field": "voluptate aute",
      "message": "ipsum fugiat Ut",
      "parameter": "velit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "irure",
      "field": null,
      "message": "esse nulla cupidatat incididunt et",
      "parameter": "Duis"
    },
    {
      "error_id": "voluptate",
      "field": "Lorem cillum",
      "message": "Duis",
      "parameter": "reprehenderit culpa anim"
    },
    {
      "error_id": "ea est Excepteur",
      "field": null,
      "message": "Lorem nisi",
      "parameter": "est non qui ea"
    },
    {
      "error_id": "minim qui",
      "field": "do voluptate sint consectetur reprehenderit",
      "message": "amet enim eu dolore cillum",
      "parameter": "pariatur"
    },
    {
      "error_id": "ut proident nulla voluptate",
      "field": "qui ipsum pariatur nulla in",
      "message": "consequat sunt",
      "parameter": "in"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "in nostrud voluptate est tempor",
      "field": "culpa qui cillum in",
      "message": "non quis",
      "parameter": "sed ullamco magna"
    },
    {
      "error_id": "mollit ex",
      "field": null,
      "message": "adipisicing",
      "parameter": "laborum"
    },
    {
      "error_id": "pariatur qui labore",
      "field": null,
      "message": "nisi nulla exercitation",
      "parameter": "laboris occaecat in consectetur esse"
    },
    {
      "error_id": "culpa sit Lorem",
      "field": null,
      "message": "in",
      "parameter": "quis occaecat"
    },
    {
      "error_id": "amet ex labore",
      "field": null,
      "message": "dolor eu",
      "parameter": "in culpa sunt enim consequat"
    }
  ]
}
Header NameExample
on-behalf-of"reprehenderit"
Request Payload
Response Payload
{
  "enabled": false,
  "soft_bounces": 5,
  "hard_bounces": 5
}
{
  "errors": [
    {
      "error_id": "sunt in tempor",
      "field": null,
      "message": "ex ipsum",
      "parameter": "voluptate ipsum adipisicing occaecat Duis"
    },
    {
      "error_id": "elit",
      "field": "deserunt minim reprehenderit dolore officia",
      "message": "dolore sint consequat labore",
      "parameter": "ut Duis"
    },
    {
      "error_id": "et velit irure adipisicing sed",
      "field": null,
      "message": "minim veniam non anim eu",
      "parameter": "in eu exercitation dolore"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "magna officia quis",
      "field": null,
      "message": "esse eiusmod enim",
      "parameter": "sunt voluptate laboris nulla occaecat"
    },
    {
      "error_id": "exercitation",
      "field": null,
      "message": "in ut incididunt dolor nulla",
      "parameter": "sit id veniam cillum"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "veniam in Lorem",
      "field": null,
      "message": "do in",
      "parameter": "non in et"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "esse reprehenderit incididunt",
      "field": "nulla deserunt enim anim",
      "message": "sint laboris mollit exercitation qui",
      "parameter": "nostrud nulla culpa mollit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "culpa pariatur minim occaecat fugiat",
      "field": null,
      "message": "ut amet voluptate",
      "parameter": "in nostrud aliqua eiusmod adipisicing"
    }
  ]
}
Header NameExample
on-behalf-of"ad in sit anim veniam"
Request Payload
{
  "enabled": true,
  "email": "bounces@example.com"
}
Response Payload
{
  "email": "bounces@example.com",
  "enabled": true
}
{
  "errors": [
    {
      "error_id": "nostrud",
      "field": null,
      "message": "in Excepteur",
      "parameter": "culpa aliquip"
    },
    {
      "error_id": "in adipisicing tempor irure",
      "field": null,
      "message": "dolor ut aute ad velit",
      "parameter": "Ut deserunt"
    },
    {
      "error_id": "sed Ut minim incididunt",
      "field": null,
      "message": "commodo minim dolor in",
      "parameter": "pariatur"
    },
    {
      "error_id": "laboris officia",
      "field": null,
      "message": "culpa cupidatat",
      "parameter": "dolore aliquip"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "enim",
      "field": null,
      "message": "dolor",
      "parameter": "tempor"
    },
    {
      "error_id": "est consequat minim in ipsum",
      "field": "officia in dolore reprehenderit",
      "message": "quis commodo occaecat veniam",
      "parameter": "quis non cillum laboris et"
    },
    {
      "error_id": "aliqua laboris adipisicing",
      "field": "sed incididunt reprehenderit consequat non",
      "message": "commodo adipisicing id ea",
      "parameter": "ut"
    },
    {
      "error_id": "nostrud",
      "field": null,
      "message": "veniam incididunt",
      "parameter": "deserunt"
    },
    {
      "error_id": "culpa eiusmod magna consectetur quis",
      "field": null,
      "message": "dolor nisi sit ullamco in",
      "parameter": "et"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "do Lorem",
      "field": "non",
      "message": "consequat cillum",
      "parameter": "exercitation proident ex Excepteur"
    },
    {
      "error_id": "in tempor velit",
      "field": null,
      "message": "sit mollit dolore",
      "parameter": "enim Ut quis"
    },
    {
      "error_id": "sed amet consequat",
      "field": "ipsum occaecat minim",
      "message": "officia",
      "parameter": "non sint mollit officia"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ea est velit eiusmod cupidatat",
      "field": "veniam labore nostrud qui",
      "message": "qui nostrud nisi",
      "parameter": "tempor occaecat"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "aliquip reprehenderit est",
      "field": "do proident exercitation magna aute",
      "message": "reprehenderit",
      "parameter": "aliqua sit pariatur"
    },
    {
      "error_id": "minim do fugiat",
      "field": null,
      "message": "pariatur",
      "parameter": "laboris"
    },
    {
      "error_id": "aliquip sunt Duis nostrud incididunt",
      "field": null,
      "message": "veniam",
      "parameter": "voluptate tempor"
    }
  ]
}
Header NameExample
on-behalf-of"dolore Duis"
Request Payload
Response Payload
{
  "enabled": true,
  "email": "bounces@example.com"
}
{
  "errors": [
    {
      "error_id": "elit dolore",
      "field": "sit adipisicing",
      "message": "culpa deserunt do",
      "parameter": "magna adipisicing"
    },
    {
      "error_id": "sunt dolore",
      "field": "anim culpa qui",
      "message": "irure",
      "parameter": "ea"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "et laborum deserunt velit",
      "field": null,
      "message": "dolor aute id cupidatat culpa",
      "parameter": "id elit enim sed laboris"
    },
    {
      "error_id": "cillum non",
      "field": "incididunt qui eiusmod ut velit",
      "message": "ad",
      "parameter": "dolor occaecat ad"
    },
    {
      "error_id": "consequat velit officia",
      "field": "anim",
      "message": "aute ea",
      "parameter": "cillum aliqua aliquip"
    },
    {
      "error_id": "magna officia et",
      "field": null,
      "message": "ullamco tempor esse sit",
      "parameter": "proident amet nulla"
    },
    {
      "error_id": "aliquip",
      "field": null,
      "message": "laborum Duis",
      "parameter": "et"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "quis dolore culpa sint",
      "field": null,
      "message": "dolore",
      "parameter": "labore eiusmod esse dolore ex"
    },
    {
      "error_id": "dolor",
      "field": null,
      "message": "pariatur amet",
      "parameter": "ad proident incididunt mollit dolore"
    },
    {
      "error_id": "dolor sunt officia sint qui",
      "field": null,
      "message": "Ut occaecat fugiat mollit sunt",
      "parameter": "dolore Duis veniam"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "cillum et id non reprehenderit",
      "field": "ullamco voluptate ex Excepteur id",
      "message": "qui consectetur",
      "parameter": "cillum occaecat reprehenderit"
    },
    {
      "error_id": "reprehenderit adipisicing ullamco",
      "field": "tempor culpa",
      "message": "Duis",
      "parameter": "aute aliquip qui"
    },
    {
      "error_id": "est ut in proident",
      "field": "cillum tempor",
      "message": "labore sunt",
      "parameter": "in Excepteur ipsum nulla"
    },
    {
      "error_id": "in ut",
      "field": "Duis laborum",
      "message": "in labore reprehenderit minim nisi",
      "parameter": "laborum"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "voluptate magna",
      "field": null,
      "message": "eu in Excepteur pariatur et",
      "parameter": "eiusmod anim velit dolor Duis"
    },
    {
      "error_id": "anim do in nostrud",
      "field": "minim",
      "message": "elit",
      "parameter": "velit nostrud Ut ullamco in"
    },
    {
      "error_id": "ex deserunt nostrud labore",
      "field": null,
      "message": "reprehenderit",
      "parameter": "cillum culpa"
    },
    {
      "error_id": "sint sit",
      "field": null,
      "message": "in ea eiusmod fugiat dolor",
      "parameter": "id exercitation eiusmod"
    }
  ]
}

Settings - Partner(3 operations)

Header NameExample
on-behalf-of"ad dolor id"
Request Payload
{
  "license_key": "",
  "enabled": true,
  "enable_subuser_statistics": true
}
Response Payload
{
  "enable_subuser_statistics": true,
  "enabled": true,
  "license_key": ""
}
Header NameExample
on-behalf-of"in est Duis"
Request Payload
Response Payload
{
  "enable_subuser_statistics": false,
  "enabled": true,
  "license_key": ""
}
Query Parameter NameExample
limit67984500
offset-20797763
Header NameExample
on-behalf-of"do laborum culpa Lorem"
Request Payload
Response Payload
{
  "result": [
    {
      "title": "Partner title",
      "enabled": true,
      "name": "partner_name",
      "description": "A description of a partner."
    }
  ]
}

Teammates(11 operations)

Header NameExample
on-behalf-of"esse in ea"
Request Payload
{
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}
Response Payload
{
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}
{
  "errors": [
    {
      "message": "nisi Duis in dolore ut",
      "field": "in"
    },
    {
      "message": "Ut dolor occaecat",
      "field": "laboris sint occaecat dolore"
    },
    {
      "message": "in officia in Excepteur",
      "field": "sint laboris ut officia ut"
    },
    {
      "message": "est eiusmod ipsum ex",
      "field": "nisi aliqua in ut"
    }
  ]
}
Query Parameter NameExample
limit292
offset43509069
Header NameExample
on-behalf-of"sunt"
Request Payload
Response Payload
{
  "results": [
    {
      "username": "teammate1",
      "email": "teammate1@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "user_type": "owner",
      "is_admin": true,
      "phone": "123-345-3453",
      "website": "www.example.com",
      "company": "ACME Inc.",
      "address": "123 Acme St",
      "address2": "",
      "city": "City",
      "state": "CA",
      "country": "USA",
      "zip": "12345"
    },
    {
      "username": "teammate2",
      "email": "teammate2@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "user_type": "teammate",
      "is_admin": false,
      "phone": "123-345-3453",
      "website": "www.example.com",
      "company": "ACME Inc.",
      "address": "123 Acme St",
      "address2": "",
      "city": "City",
      "state": "CA",
      "country": "USA",
      "zip": "12345"
    },
    {
      "username": "teammate3",
      "email": "teammate3@example.com",
      "first_name": "Steve",
      "last_name": "Doe",
      "user_type": "admin",
      "is_admin": true,
      "phone": "123-345-3453",
      "website": "www.example.com",
      "company": "ACME Inc.",
      "address": "123 Acme St",
      "address2": "",
      "city": "City",
      "state": "CA",
      "country": "USA",
      "zip": "12345"
    }
  ]
}
Header NameExample
on-behalf-of"minim deserunt veniam"
Request Payload
Response Payload
{
  "pending_id": "abc123abc",
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}
{
  "errors": [
    {
      "message": "invalid pending key",
      "field": "pending_key"
    }
  ]
}
Query Parameter NameExample
limit-98977754
offset93332239
Request Payload
Response Payload
[
  {
    "id": 1,
    "scope_group_name": "Mail Settings",
    "username": "teammate1",
    "email": "teammate1@example.com",
    "first_name": "Teammate",
    "last_name": "One"
  },
  {
    "id": 2,
    "scope_group_name": "Stats",
    "username": "teammate2",
    "email": "teammate2@example.com",
    "first_name": "Teammate",
    "last_name": "Two"
  }
]
Header NameExample
on-behalf-of"in labore in culpa"
Request Payload
Response Payload
{
  "result": [
    {
      "email": "user1@example.com",
      "scopes": [
        "user.profile.read",
        "user.profile.edit"
      ],
      "is_admin": false,
      "pending_id": "abcd123abc",
      "expiration_date": 1456424263
    },
    {
      "email": "user2@example.com",
      "scopes": [],
      "is_admin": true,
      "pending_id": "bcde234bcd",
      "expiration_date": 1456424263
    }
  ]
}
Header NameExample
on-behalf-of"occaecat exercitation do mollit"
Request Payload
Response Payload
{
  "username": "teammate1",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update",
    "..."
  ],
  "user_type": "admin",
  "is_admin": true,
  "phone": "123-345-3453",
  "website": "www.example.com",
  "company": "ACME Inc.",
  "address": "123 Acme St",
  "address2": "",
  "city": "City",
  "state": "CA",
  "country": "USA",
  "zip": "12345"
}
Header NameExample
on-behalf-of"non cupidatat exercitation"
Request Payload
{
  "scopes": [
    "user.profile.read",
    "user.profile.edit"
  ],
  "is_admin": false
}
Response Payload
{
  "username": "teammate1",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.edit"
  ],
  "user_type": "teammate",
  "is_admin": false,
  "phone": "123-345-3453",
  "website": "www.example.com",
  "company": "ACME Inc.",
  "address": "123 Acme St",
  "address2": "",
  "city": "City",
  "state": "CA",
  "country": "USA",
  "zip": "12345"
}
{
  "errors": [
    {
      "message": "one or more of given scopes are invalid",
      "field": "scopes"
    }
  ]
}
{
  "errors": [
    {
      "message": "username not found",
      "field": "username"
    }
  ]
}
Header NameExample
on-behalf-of"dolor"
Request Payload
Response Payload
{
  "errors": [
    {
      "message": "eu culpa",
      "field": "reprehenderit nulla nostrud"
    },
    {
      "message": "occaecat adipisicing in minim dolor",
      "field": "elit dolor in sunt esse"
    }
  ]
}
{
  "errors": [
    {
      "message": "username not found",
      "field": "username"
    }
  ]
}
Request Payload
Response Payload
{
  "scope_group_name": "Stats"
}
{}
{
  "errors": [
    {
      "message": "occaecat",
      "field": "laboris mollit sed"
    },
    {
      "message": "exercitation in adipisicing aute non",
      "field": "magna ex sed deserunt"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "Cannot find request",
      "field": "request_id"
    }
  ]
}
Header NameExample
on-behalf-of"aliquip ut Excepteur officia"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "sint qui Ut",
      "field": "dolor minim commodo velit"
    },
    {
      "message": "ipsum Excepteur",
      "field": "ut proident velit in voluptate"
    },
    {
      "message": "voluptate quis Ut esse",
      "field": "nulla laboris nostrud sit"
    },
    {
      "message": "nulla ad deserunt in",
      "field": "non commodo Lorem"
    }
  ]
}

Alerts(5 operations)

Header NameExample
Authorization"id Lorem laboris pariatur ex"
on-behalf-of"in Excepteur qui irure"
Request Payload
{
  "type": "stats_notification",
  "email_to": "example@example.com",
  "frequency": "daily"
}
Response Payload
{
  "created_at": 1451520930,
  "email_to": "test@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451520930
}
{
  "field": "anim Duis non proident",
  "message": "fugiat"
}
Header NameExample
Authorization"officia culpa anim"
on-behalf-of"id aliqua"
Request Payload
Response Payload
[
  {
    "created_at": 1451498784,
    "email_to": "example1@example.com",
    "id": 46,
    "percentage": 90,
    "type": "usage_limit",
    "updated_at": 1451498784
  },
  {
    "created_at": 1451498812,
    "email_to": "example2@example.com",
    "frequency": "monthly",
    "id": 47,
    "type": "stats_notification",
    "updated_at": 1451498812
  },
  {
    "created_at": 1451520930,
    "email_to": "example3@example.com",
    "frequency": "daily",
    "id": 48,
    "type": "stats_notification",
    "updated_at": 1451520930
  }
]
Header NameExample
Authorization"est minim"
on-behalf-of"id enim dolor sunt"
Request Payload
Response Payload
{
  "created_at": 1451520930,
  "email_to": "example@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451520930
}
Header NameExample
on-behalf-of"Ut sint incididunt"
Request Payload
Response Payload
{}
Header NameExample
on-behalf-of"in esse consectetur deserunt"
Request Payload
{
  "email_to": "example@example.com"
}
Response Payload
{
  "created_at": 1451520930,
  "email_to": "example@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451522691
}

Users API(9 operations)

Header NameExample
on-behalf-of"sit Excepteur"
Request Payload
Response Payload
{
  "address": "814 West Chapman Avenue",
  "address2": "",
  "city": "Orange",
  "company": "SendGrid",
  "country": "US",
  "first_name": "Test",
  "last_name": "User",
  "phone": "555-555-5555",
  "state": "CA",
  "website": "http://www.sendgrid.com",
  "zip": "92868"
}
Header NameExample
on-behalf-of"minim aute ut"
Request Payload
{
  "first_name": "Example",
  "last_name": "User",
  "city": "Orange"
}
Response Payload
{
  "address": "814 West Chapman Avenue",
  "address2": "",
  "city": "Orange",
  "company": "SendGrid",
  "country": "US",
  "first_name": "Example",
  "last_name": "User",
  "phone": "555-555-5555",
  "state": "CA",
  "website": "http://www.sendgrid.com",
  "zip": "92868"
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"labore"
Request Payload
Response Payload
{
  "reputation": 100,
  "type": "paid"
}
Header NameExample
on-behalf-of"incididunt Ut"
Request Payload
Response Payload
{
  "email": "test@example.com"
}
Header NameExample
on-behalf-of"amet enim in eiusmod dolore"
Request Payload
{
  "email": "example@example.com"
}
Response Payload
{
  "email": "example@example.com"
}
Header NameExample
on-behalf-of"amet Excepteur sint exercitation"
Request Payload
Response Payload
{
  "username": "test_username",
  "user_id": 1
}
Header NameExample
on-behalf-of"enim incididunt dolore"
Request Payload
{
  "username": "test_username"
}
Response Payload
{
  "username": "test_username"
}
Header NameExample
on-behalf-of"quis tempor id"
Request Payload
Response Payload
{
  "remain": 200,
  "total": 200,
  "overage": 0,
  "used": 0,
  "last_reset": "2013-01-01",
  "next_reset": "2013-02-01",
  "reset_frequency": "monthly"
}
Header NameExample
on-behalf-of"tempor qui dolor"
Request Payload
{
  "new_password": "new_password",
  "old_password": "old_password"
}
Response Payload
{}

Subusers API(6 operations)

Query Parameter NameExample
usernameet elit labore officia
limit57418485
offset-43492476
Request Payload
Response Payload
[
  {
    "disabled": false,
    "email": "example@example.com",
    "id": 1234,
    "username": "example_subuser"
  },
  {
    "disabled": false,
    "email": "example2@example.com",
    "id": 1234,
    "username": "example_subuser2"
  }
]
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Request Payload
{
  "username": "John@example.com",
  "email": "John@example.com",
  "password": "johns_password",
  "ips": [
    "1.1.1.1",
    "2.2.2.2"
  ]
}
Response Payload
{
  "username": "example_subuser",
  "user_id": 1234,
  "email": "example@example.com",
  "signup_session_token": "",
  "authorization_token": "",
  "credit_allocation": {
    "type": "unlimited"
  }
}
{
  "errors": [
    {
      "message": "username exists"
    },
    {
      "message": "unable to validate IPs at this time"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "you dont have permission to access this resource"
    }
  ]
}
{
  "errors": [
    {
      "message": "unable to validate IPs at this time"
    }
  ]
}
Request Payload
{
  "disabled": false
}
Response Payload
{}
{
  "errors": [
    {
      "message": "invalid username"
    },
    {
      "message": "no fields provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "unable to enable user"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
usernamesdolor ea et laborum do
Request Payload
Response Payload
[
  {
    "username": "example_subuser",
    "reputation": 99
  },
  {
    "username": "example_subuser2",
    "reputation": 95.2
  }
]
Request Payload
[
  "127.0.0.1"
]
Response Payload
{
  "ips": [
    "127.0.0.1"
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Subuser Monitor Settings(4 operations)

Request Payload
Response Payload
{
  "email": "example@example.com",
  "frequency": 500
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "No monitor settings for this user"
    }
  ]
}
Request Payload
{
  "email": "example@example.com",
  "frequency": 50000
}
Response Payload
{
  "email": "example@example.com",
  "frequency": 50000
}
{
  "errors": [
    {
      "field": null,
      "message": "User already has a monitor"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Request Payload
{
  "email": "example@example.com",
  "frequency": 50000
}
Response Payload
{
  "email": "example@example.com",
  "frequency": 500
}
{
  "errors": [
    {
      "field": "email",
      "message": "Email is required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "No monitor settings for this user"
    }
  ]
}

Subuser Statistics(4 operations)

Query Parameter NameExample
date*est cupidatat
sort_by_metricminim aliquip nisi
sort_by_directionasc
limit72638660
offset77768363
Request Payload
Response Payload
{
  "date": "2016-02-01",
  "stats": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 10,
        "processed": 10,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user1",
      "type": "subuser"
    }
  ]
}
Query Parameter NameExample
date*Lorem ut ipsum tempor
subuserut
sort_by_metricdelivered
sort_by_directiondesc
limit-1400031
offset27755012
Request Payload
Response Payload
{
  "date": "2016-02-01",
  "stats": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 0,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 1,
        "processed": 0,
        "requests": 100,
        "spam_report_drops": 0,
        "spam_reports": 99,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user1",
      "type": "subuser"
    },
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 10,
        "processed": 10,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user2",
      "type": "subuser"
    }
  ]
}
Query Parameter NameExample
sort_by_directionasc
start_date*ut tempor cillum
end_dateLorem officia in
limit-51650191
offset1549262
aggregated_bydolore dolore
sort_by_metricvelit aliquip amet veniam in
Request Payload
Response Payload
{
  "date": "2015-10-11",
  "stats": []
}
Query Parameter NameExample
limit67886931
offset69666237
aggregated_bymonth
subusers*officia in minim Lorem
start_date*et
end_datelaborum dolore officia
Request Payload
Response Payload
[
  {
    "date": "2015-10-01",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-02",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-03",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-04",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-05",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-06",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-07",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-08",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-09",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-10",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]

Link branding(10 operations)

IP Warmup(4 operations)

Request Payload
{
  "ip": "0.0.0.0"
}
Response Payload
[
  {
    "ip": "0.0.0.0",
    "start_date": 1409616000
  }
]
{
  "errors": [
    {
      "field": null,
      "message": "resource not found"
    }
  ]
}
Request Payload
Response Payload
[
  {
    "ip": "0.0.0.0",
    "start_date": 1409616000
  }
]
Request Payload
Response Payload
[
  {
    "ip": "0.0.0.0",
    "start_date": 1409616000
  }
]
{
  "errors": [
    {
      "field": null,
      "message": "resource not found"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "resource not found"
    }
  ]
}

Reverse DNS(5 operations)

Header NameExample
on-behalf-of"ad"
Request Payload
{
  "ip": "192.168.1.1",
  "subdomain": "email",
  "domain": "example.com"
}
Response Payload
{
  "id": 123,
  "ip": "192.168.1.2",
  "rdns": "o1.email.example.com",
  "users": [],
  "subdomain": "email",
  "domain": "example.com",
  "valid": true,
  "legacy": false,
  "a_record": {
    "valid": true,
    "type": "a",
    "host": "o1.email.example.com",
    "data": "192.168.1.2"
  }
}
Query Parameter NameExample
limit58660835
offset4346192
ipproident labore
Header NameExample
on-behalf-of"deserunt dolor non anim"
Request Payload
Response Payload
[
  {
    "id": 1,
    "ip": "192.168.1.1",
    "rdns": "o1.email.example.com",
    "users": [
      {
        "username": "john@example.com",
        "user_id": 7
      },
      {
        "username": "jane@example.com",
        "user_id": 8
      }
    ],
    "subdomain": "email",
    "domain": "example.com",
    "valid": true,
    "legacy": false,
    "a_record": {
      "valid": true,
      "type": "a",
      "host": "o1.email.example.com",
      "data": "192.168.1.1"
    }
  },
  {
    "id": 2,
    "ip": "192.168.1.2",
    "rdns": "o2.email.example.com",
    "users": [
      {
        "username": "john@example.com",
        "user_id": 7
      },
      {
        "username": "jane@example2.com",
        "user_id": 9
      }
    ],
    "subdomain": "email",
    "domain": "example.com",
    "valid": true,
    "legacy": false,
    "a_record": {
      "valid": true,
      "type": "a",
      "host": "o2.email.example.com",
      "data": "192.168.1.2"
    }
  }
]
Header NameExample
on-behalf-of"eu"
Request Payload
Response Payload
{
  "id": 123456,
  "valid": false,
  "validation_results": {
    "a_record": {
      "valid": false,
      "reason": "Failed to resolve A Record at o1.ptr4283.example.com: lookup o1.ptr4283.example.com on 192.168.0.10:53: no such host"
    }
  }
}
{
  "errors": [
    {
      "message": "Reverse DNS record not found."
    }
  ]
}
{
  "errors": [
    {
      "message": "internal error getting rDNS"
    }
  ]
}
Header NameExample
on-behalf-of"ut"
Request Payload
Response Payload
{
  "id": 123,
  "ip": "192.168.1.1",
  "rdns": "o1.email.example.com",
  "users": [
    {
      "username": "john@example.com",
      "user_id": 7
    }
  ],
  "subdomain": "email",
  "domain": "example.com",
  "valid": true,
  "legacy": false,
  "a_record": {
    "valid": true,
    "type": "a",
    "host": "o1.email.example.com",
    "data": "192.168.1.1"
  }
}
Header NameExample
on-behalf-of"consequat sunt"
Request Payload
Response Payload
{}

Email Address Validation

Request Payload
{
  "email": "example@example.com",
  "source": "signup"
}
Response Payload
{
  "result": {
    "email": "cedric@fogowl.com",
    "verdict": "Valid",
    "score": 0.85021,
    "local": "cedric",
    "host": "fogowl.com",
    "checks": {
      "domain": {
        "has_valid_address_syntax": true,
        "has_mx_or_a_record": true,
        "is_suspected_disposable_address": false
      },
      "local_part": {
        "is_suspected_role_address": false
      },
      "additional": {
        "has_known_bounces": false,
        "has_suspected_bounces": false
      }
    },
    "ip_address": "192.168.1.1"
  }
}

Email CNAME records

Request Payload
{
  "link_id": 29719392,
  "domain_id": 46873408,
  "email": "my_colleague@example.com",
  "message": "DNS Record for verification"
}
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": {
    "error": "ipsum exercitation esse nisi",
    "field": "commodo"
  }
}

IP Pools(7 operations)

Request Payload
{
  "name": "marketing"
}
Response Payload
{
  "name": "marketing"
}
Request Payload
Response Payload
[
  {
    "name": "marketing"
  },
  {
    "name": "transactional"
  }
]
Request Payload
{
  "ip": "0.0.0.0"
}
Response Payload
{
  "ip": "000.00.00.0",
  "pools": [
    "test1"
  ],
  "start_date": 1409616000,
  "warmup": true
}
{
  "errors": [
    {
      "field": null,
      "message": "resource not found"
    }
  ]
}
Request Payload
Response Payload
{
  "pool_name": "Sample",
  "ips": [
    "192.168.1.1",
    "192.158.1.2",
    "192.138.2.1"
  ]
}
{
  "errors": [
    {
      "field": "error",
      "message": "Unable to locate specified IPs Pool"
    }
  ]
}
Request Payload
{
  "name": "new_pool_name"
}
Response Payload
{
  "name": "new_pool_name"
}
{
  "errors": [
    {
      "field": null,
      "message": "ip pool not found"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "error": "Unable to locate specified IPs Pool"
}
Request Payload
Response Payload
{}
{
  "error": "Unable to locate specified IPs Pool"
}

IP Addresses(5 operations)

Request Payload
{
  "count": 90323478,
  "subusers": [
    "subuser1",
    "subuser2"
  ],
  "warmup": true,
  "user_can_send": true
}
Response Payload
{
  "ips": [
    {
      "ip": "1.2.3.4",
      "subusers": [
        "user",
        "subuser1"
      ]
    },
    {
      "ip": "1.2.3.5",
      "subusers": [
        "user",
        "subuser1"
      ]
    }
  ],
  "remaining_ips": 1,
  "warmup": true
}
{
  "errors": [
    {
      "field": null,
      "message": "one or more subusers do not belong to this user"
    }
  ]
}
Query Parameter NameExample
ipaute
exclude_whitelabelsfalse
limit42443732
offset-15849022
subuseraute dolore Duis
sort_by_directiondesc
Request Payload
Response Payload
[
  {
    "ip": "192.168.1.1",
    "pools": [
      "pool1",
      "pool2"
    ],
    "whitelabeled": false,
    "start_date": 1409616000,
    "subusers": [
      "tim@sendgrid.net"
    ],
    "warmup": false,
    "assigned_at": 1482883200
  },
  {
    "ip": "208.115.214.22",
    "pools": [],
    "whitelabeled": true,
    "rdns": "o1.email.burgermail.com",
    "start_date": 1409616000,
    "subusers": [],
    "warmup": false,
    "assigned_at": 1482883200
  }
]
Request Payload
Response Payload
{
  "results": [
    {
      "remaining": 2,
      "period": "month",
      "price_per_ip": 20
    }
  ]
}
Request Payload
Response Payload
[
  {
    "ip": "167.89.21.3",
    "pools": [
      "new_test5"
    ],
    "warmup": true,
    "start_date": 1409616000
  }
]
Request Payload
Response Payload
{
  "ip": "000.00.00.0",
  "subusers": [
    "subuser1",
    "subuser2"
  ],
  "rdns": "o1.em.example.com",
  "pools": [
    "test1"
  ],
  "warmup": false,
  "start_date": null,
  "whitelabeled": true
}

Domain Authentication(12 operations)

Query Parameter NameExample
limit-24889285
offset-2925835
exclude_subuserstrue
usernamealiqua
domainproident
Header NameExample
on-behalf-of"ut ipsum officia ullamco"
Request Payload
Response Payload
[
  {
    "id": 1,
    "user_id": 7,
    "subdomain": "mail",
    "domain": "example.com",
    "username": "jane@example.com",
    "ips": [
      "192.168.1.1",
      "192.168.1.2"
    ],
    "custom_spf": true,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": true,
    "dns": {
      "mail_cname": {
        "valid": true,
        "type": "cname",
        "host": "mail.example.com",
        "data": "u7.wl.sendgrid.net"
      },
      "dkim1": {
        "valid": true,
        "type": "cname",
        "host": "s1._domainkey.example.com",
        "data": "s1._domainkey.u7.wl.sendgrid.net"
      },
      "dkim2": {
        "valid": true,
        "type": "cname",
        "host": "s2._domainkey.example.com",
        "data": "s2._domainkey.u7.wl.sendgrid.net"
      }
    }
  },
  {
    "id": 2,
    "user_id": 8,
    "subdomain": "new",
    "domain": "example2.com",
    "username": "john@example2.com",
    "ips": [],
    "custom_spf": false,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": false,
    "dns": {
      "mail_cname": {
        "valid": false,
        "type": "mx",
        "host": "news.example2.com",
        "data": "sendgrid.net"
      },
      "dkim1": {
        "valid": false,
        "type": "txt",
        "host": "example2.com",
        "data": "k=rsa; t=s; p=publicKey"
      },
      "dkim2": {
        "valid": false,
        "type": "txt",
        "host": "example2.com",
        "data": "k=rsa; t=s p=publicKey"
      }
    }
  }
]
Header NameExample
on-behalf-of"Excepteur nostrud esse nisi laboris"
Request Payload
{
  "domain": "example.com",
  "subdomain": "news",
  "username": "john@example.com",
  "ips": [
    "192.168.1.1",
    "192.168.1.2"
  ],
  "custom_spf": true,
  "default": true,
  "automatic_security": false
}
Response Payload
{
  "id": 302183,
  "user_id": 1446226,
  "subdomain": "example",
  "domain": "example.com",
  "username": "mbernier",
  "ips": [],
  "custom_spf": false,
  "default": true,
  "legacy": false,
  "automatic_security": true,
  "valid": false,
  "dns": {
    "mail_cname": {
      "valid": false,
      "type": "cname",
      "host": "example.example.com",
      "data": "u1446226.wl.sendgrid.net"
    },
    "dkim1": {
      "valid": false,
      "type": "cname",
      "host": "s1._domainkey.example.com",
      "data": "s1.domainkey.u1446226.wl.sendgrid.net"
    },
    "dkim2": {
      "valid": false,
      "type": "cname",
      "host": "s2._domainkey.example.com",
      "data": "s2.domainkey.u1446226.wl.sendgrid.net"
    }
  }
}
Header NameExample
on-behalf-of"consequat"
Request Payload
Response Payload
{
  "id": 45373692,
  "user_id": 66036447,
  "subdomain": "sub",
  "domain": "example.com",
  "username": "jdoe",
  "ips": [
    "127.0.0.1"
  ],
  "custom_spf": false,
  "default": true,
  "legacy": false,
  "automatic_security": true,
  "valid": true,
  "dns": {
    "mail_cname": {
      "valid": true,
      "type": "cname",
      "host": "mail.example.com",
      "data": "u7.wl.sendgrid.net"
    },
    "dkim1": {
      "valid": true,
      "type": "cname",
      "host": "s1._domainkey.example.com",
      "data": "s1._domainkey.u7.wl.sendgrid.net"
    },
    "dkim2": {
      "valid": true,
      "type": "cname",
      "host": "s2._domainkey.example.com",
      "data": "s2._domainkey.u7.wl.sendgrid.net"
    }
  }
}
Header NameExample
on-behalf-of"incididunt mollit commodo tempor ut"
Request Payload
{
  "default": false,
  "custom_spf": true
}
Response Payload
[
  {
    "id": 1,
    "user_id": 7,
    "subdomain": "mail",
    "domain": "example.com",
    "username": "jane@example.com",
    "ips": [
      "192.168.1.1",
      "192.168.1.2"
    ],
    "custom_spf": true,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": true,
    "dns": {
      "mail_cname": {
        "valid": true,
        "type": "cname",
        "host": "mail.example.com",
        "data": "u7.wl.sendgrid.net"
      },
      "dkim1": {
        "valid": true,
        "type": "cname",
        "host": "s1._domainkey.example.com",
        "data": "s1._domainkey.u7.wl.sendgrid.net"
      },
      "dkim2": {
        "valid": true,
        "type": "cname",
        "host": "s2._domainkey.example.com",
        "data": "s2._domainkey.u7.wl.sendgrid.net"
      }
    }
  },
  {
    "id": 2,
    "user_id": 8,
    "subdomain": "new",
    "domain": "example2.com",
    "username": "john@example2.com",
    "ips": [],
    "custom_spf": false,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": false,
    "dns": {
      "mail_cname": {
        "valid": false,
        "type": "mx",
        "host": "news.example2.com",
        "data": "sendgrid.net"
      },
      "dkim1": {
        "valid": false,
        "type": "txt",
        "host": "example2.com",
        "data": "k=rsa; t=s; p=publicKey"
      },
      "dkim2": {
        "valid": false,
        "type": "txt",
        "host": "example2.com",
        "data": "k=rsa; t=s p=publicKey"
      }
    }
  }
]
Header NameExample
on-behalf-of"sint"
Request Payload
Response Payload
{}
Query Parameter NameExample
domainExcepteur ex consequat Lorem dolor
Header NameExample
on-behalf-of"amet nisi officia sed"
Request Payload
Response Payload
[
  {
    "id": 1,
    "user_id": 7,
    "subdomain": "mail",
    "domain": "example.com",
    "username": "jane@example.com",
    "ips": [
      "192.168.1.1",
      "192.168.1.2"
    ],
    "custom_spf": true,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": true,
    "dns": {
      "mail_cname": {
        "valid": true,
        "type": "cname",
        "host": "mail.example.com",
        "data": "u7.wl.sendgrid.net"
      },
      "dkim1": {
        "valid": true,
        "type": "cname",
        "host": "s1._domainkey.example.com",
        "data": "s1._domainkey.u7.wl.sendgrid.net"
      },
      "dkim2": {
        "valid": true,
        "type": "cname",
        "host": "s2._domainkey.example.com",
        "data": "s2._domainkey.u7.wl.sendgrid.net"
      }
    }
  }
]
Header NameExample
on-behalf-of"cillum"
Request Payload
{
  "ip": "192.168.0.1"
}
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "john@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}
Header NameExample
on-behalf-of"culpa"
Request Payload
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "mail@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}
Header NameExample
on-behalf-of"pariatur Excepteur tempor"
Request Payload
Response Payload
{
  "id": 1,
  "valid": true,
  "validation_resuts": {
    "mail_cname": {
      "valid": false,
      "reason": "Expected your MX record to be \"mx.sendgrid.net\" but found \"example.com\"."
    },
    "dkim1": {
      "valid": true,
      "reason": null
    },
    "dkim2": {
      "valid": true,
      "reason": null
    },
    "spf": {
      "valid": true,
      "reason": null
    }
  }
}
{
  "errors": [
    {
      "message": "internal error getting TXT"
    }
  ]
}
Query Parameter NameExample
username*officia reprehenderit deserunt laboris do
Request Payload
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "mail@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}
Query Parameter NameExample
usernameoccaecat
Request Payload
Response Payload
{}
Request Payload
{
  "username": "jdoe"
}
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "mail@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}

Sender Verification(8 operations)

Request Payload
Response Payload
{
  "results": {
    "soft_failures": [
      "gmail.com"
    ],
    "hard_failures": [
      "yahoo.com"
    ]
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "laborum esse pariatur"
    },
    {
      "message": "exercitation Duis pariatur eu"
    },
    {
      "message": "Duis"
    },
    {
      "message": "sed"
    }
  ]
}
Request Payload
Response Payload
{
  "results": {
    "domain_verified": true,
    "sender_verified": true
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "veniam nisi Excepteur"
    }
  ]
}
Request Payload
{
  "nickname": "Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105"
}
Response Payload
{
  "id": 1234,
  "nickname": "Example Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St.",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105",
  "verified": true,
  "locked": false
}
{
  "errors": [
    {
      "field": "voluptate",
      "message": "voluptate Excepteur officia sit eiusmod",
      "error_id": "Duis ex proident irure consequat"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "reprehenderit ad Excepteur dolore sunt"
    },
    {
      "message": "quis"
    },
    {
      "message": "nulla cupidatat ut commodo"
    },
    {
      "message": "eiusmod qui adipisicing in"
    },
    {
      "message": "veniam"
    }
  ]
}
Query Parameter NameExample
limit-7560618.669973224
lastSeenID65698646.49851546
id-93943652
Request Payload
Response Payload
{
  "results": [
    {
      "id": 1234,
      "nickname": "Example Orders",
      "from_email": "orders@example.com",
      "from_name": "Example Orders",
      "reply_to": "orders@example.com",
      "reply_to_name": "Example Orders",
      "address": "1234 Fake St.",
      "address2": "PO Box 1234",
      "state": "CA",
      "city": "San Francisco",
      "country": "USA",
      "zip": "94105",
      "verified": true,
      "locked": false
    },
    {
      "id": 1235,
      "nickname": "Example Support",
      "from_email": "support@example.com",
      "from_name": "Example Support",
      "reply_to": "support@example.com",
      "reply_to_name": "Example Support",
      "address": "1234 Fake St.",
      "address2": "PO Box 1234",
      "state": "CA",
      "city": "San Francisco",
      "country": "USA",
      "zip": "94105",
      "verified": true,
      "locked": false
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "enim"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "et officia",
      "error_id": "anim"
    }
  ]
}
{
  "errors": [
    {
      "message": "occaecat elit do"
    }
  ]
}
Request Payload
{
  "nickname": "Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105"
}
Response Payload
{
  "id": 1234,
  "nickname": "Example Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St.",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105",
  "verified": true,
  "locked": false
}
{
  "errors": [
    {
      "field": "veniam dolor ea id nostrud",
      "message": "sed",
      "error_id": "Lorem ut"
    },
    {
      "field": "aute",
      "message": "eu elit",
      "error_id": "sed ad quis laboris proident"
    },
    {
      "field": "ex aute culpa Lorem nostrud",
      "message": "enim laboris commodo incididunt",
      "error_id": "sed sit"
    },
    {
      "field": "Ut do",
      "message": "tempor qui dolore aute",
      "error_id": "nostrud ad deserunt do"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "Duis proident",
      "error_id": "laborum dolor"
    },
    {
      "message": "do amet dolor quis elit",
      "error_id": "Lorem aliquip proident laborum fugiat"
    }
  ]
}
{
  "errors": [
    {
      "message": "Lorem dolore deserunt",
      "error_id": "consequat esse nulla laborum"
    },
    {
      "message": "ut fugiat",
      "error_id": "do ut sit"
    }
  ]
}
{
  "errors": [
    {
      "message": "incididunt laborum"
    },
    {
      "message": "mollit"
    },
    {
      "message": "est consequat"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "tempor incididunt aliquip pariatur",
      "error_id": "nisi deserunt"
    },
    {
      "message": "fugiat dolore occaecat ex mollit",
      "error_id": "Duis tempor mollit quis"
    },
    {
      "message": "exercitation mollit dolor aute",
      "error_id": "laboris mollit in"
    },
    {
      "message": "nostrud minim incididunt non",
      "error_id": "mollit"
    },
    {
      "message": "dolor fugiat non dolor ut",
      "error_id": "voluptate aute"
    }
  ]
}
{
  "errors": [
    {
      "message": "Ut nostrud laboris",
      "error_id": "nisi Excepteur aliqua veniam"
    },
    {
      "message": "veniam dolore",
      "error_id": "ut tempor aute consequat pariatur"
    },
    {
      "message": "dolore",
      "error_id": "in commodo"
    },
    {
      "message": "id amet dolore mollit proident",
      "error_id": "reprehenderit ipsum"
    },
    {
      "message": "Ut adipisicing reprehenderit magna",
      "error_id": "Duis in culpa nostrud"
    }
  ]
}
{
  "errors": [
    {
      "message": "adipisicing velit"
    },
    {
      "message": "aliquip reprehenderit id ea Ut"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "message": "reprehenderit sint et esse",
      "error_id": "irure ex laborum aliqua"
    },
    {
      "message": "in do qui est dolore",
      "error_id": "esse in Lorem minim in"
    },
    {
      "message": "cupidatat velit magna",
      "error_id": "occaecat sit Ut ea in"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "voluptate",
      "error_id": "minim"
    },
    {
      "message": "pariatur minim reprehenderit amet",
      "error_id": "ut sunt"
    },
    {
      "message": "voluptate consequat qui ex incididunt",
      "error_id": "ut nisi est"
    }
  ]
}
{
  "errors": [
    {
      "message": "Excepteur Lorem mollit cupidatat"
    },
    {
      "message": "quis do"
    },
    {
      "message": "tempor"
    },
    {
      "message": "exercitation veniam esse deserunt Excepteur"
    },
    {
      "message": "in eiusmod amet quis"
    }
  ]
}

Designs API(9 operations)

Request Payload
{
  "name": "Ahoy, Cake or Pie Cafe!",
  "editor": "design"
}
Response Payload
{
  "id": "15b85720-ce48-48ef-8a07-672b0d3455da",
  "name": "Ahoy, Cake or Pie Cafe!",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: arial,helvetica,sans-serif;\n      font-size: 14px;\n    }\n    body {\n      color: #000000;\n    }\n    body a {\n      color: #1188E6;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    ul ul ul ul  {\n      list-style-type: disc !important;\n    }\n    ol ol {\n      list-style-type: lower-roman !important;\n    }\n    ol ol ol {\n      list-style-type: lower-latin !important;\n    }\n    ol ol ol ol {\n      list-style-type: decimal !important;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start--><!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p></p>\n      </td>\n    </tr>\n  </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n    <tbody>\n      <tr>\n        <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "plain_content": "Ahoy, World!\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
  "generate_plain_content": false,
  "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/79bb769ae6464960a307040120ad6f9921896fe9825e845ad1f24d12285ea068.png",
  "subject": "Getting Started",
  "created_at": "2021-04-30T19:00:16Z",
  "updated_at": "2021-04-30T19:00:16Z",
  "editor": "design",
  "categories": []
}
{
  "message": "pariatur",
  "field": "cillum pariatur ipsum consequat",
  "error_id": "elit mollit eu dolore in"
}
{
  "errors": [
    {
      "message": "consequat in ut",
      "field": "ullamco minim nisi culpa",
      "error_id": "in deserunt elit veniam"
    },
    {
      "message": "Ut",
      "field": "ad in mollit",
      "error_id": "nisi velit Ut dolor"
    },
    {
      "message": "ipsum quis",
      "field": "qui in sed do in",
      "error_id": "Ut ad dolore esse minim"
    },
    {
      "message": "consequat est ea",
      "field": "elit culpa dolore",
      "error_id": "amet ea ullamco"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "15b85720-ce48-48ef-8a07-672b0d3455da",
  "name": "Ahoy, World!",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: arial,helvetica,sans-serif;\n      font-size: 14px;\n    }\n    body {\n      color: #000000;\n    }\n    body a {\n      color: #1188E6;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    ul ul ul ul  {\n      list-style-type: disc !important;\n    }\n    ol ol {\n      list-style-type: lower-roman !important;\n    }\n    ol ol ol {\n      list-style-type: lower-latin !important;\n    }\n    ol ol ol ol {\n      list-style-type: decimal !important;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start--><!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p></p>\n      </td>\n    </tr>\n  </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n    <tbody>\n      <tr>\n        <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "plain_content": "Ahoy, World!\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
  "generate_plain_content": false,
  "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/5yysvuyi1lpdnxo1ym8ax8yd7ompve3azjtme76gamdace01vko3eyn1kzso1lhy.png",
  "subject": "Getting Started",
  "created_at": "2021-04-30T18:51:20Z",
  "updated_at": "2021-04-30T18:51:20Z",
  "editor": "design",
  "categories": []
}
{
  "errors": [
    {
      "message": "cupidatat adipisicing",
      "field": "qui do et sed in",
      "error_id": "consequat ut"
    },
    {
      "message": "in tempor non Duis",
      "field": "velit dolor laboris",
      "error_id": "reprehenderit et voluptate"
    },
    {
      "message": "aliquip nulla consequat proident",
      "field": "irure sit",
      "error_id": "do consectetur cillum consequat sit"
    }
  ]
}
{
  "errors": [
    {
      "message": "aliquip",
      "field": "nostrud occaecat est laboris",
      "error_id": "amet ullamco fugiat laborum nostrud"
    },
    {
      "message": "commodo cupidatat Ut",
      "field": "nulla mollit ut reprehenderit Excepteur",
      "error_id": "Excepteur non"
    },
    {
      "message": "sit qui officia",
      "field": "sit sint ut",
      "error_id": "dolore ea proident"
    },
    {
      "message": "dolore veniam est",
      "field": "ut dolor proident est esse",
      "error_id": "non adipisicing"
    }
  ]
}
Request Payload
{
  "name": "Ahoy, World!",
  "subject": "Getting Started",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: arial,helvetica,sans-serif;\n      font-size: 14px;\n    }\n    body {\n      color: #000000;\n    }\n    body a {\n      color: #1188E6;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    ul ul ul ul  {\n      list-style-type: disc !important;\n    }\n    ol ol {\n      list-style-type: lower-roman !important;\n    }\n    ol ol ol {\n      list-style-type: lower-latin !important;\n    }\n    ol ol ol ol {\n      list-style-type: decimal !important;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start--><!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p></p>\n      </td>\n    </tr>\n  </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n    <tbody>\n      <tr>\n        <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "generate_plain_content": false,
  "categories": [
    "promotions"
  ]
}
Response Payload
{
  "id": "15b85720-ce48-48ef-8a07-672b0d3455da",
  "name": "Ahoy, World!",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: arial,helvetica,sans-serif;\n      font-size: 14px;\n    }\n    body {\n      color: #000000;\n    }\n    body a {\n      color: #1188E6;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    ul ul ul ul  {\n      list-style-type: disc !important;\n    }\n    ol ol {\n      list-style-type: lower-roman !important;\n    }\n    ol ol ol {\n      list-style-type: lower-latin !important;\n    }\n    ol ol ol ol {\n      list-style-type: decimal !important;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start--><!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p></p>\n      </td>\n    </tr>\n  </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n    <tbody>\n      <tr>\n        <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "generate_plain_content": false,
  "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/5yysvuyi1lpdnxo1ym8ax8yd7ompve3azjtme76gamdace01vko3eyn1kzso1lhy.png",
  "subject": "Getting Started",
  "created_at": "2021-04-30T18:51:20Z",
  "updated_at": "2021-04-30T18:51:20Z",
  "editor": "design",
  "categories": [
    "promotions"
  ]
}
{
  "errors": [
    {
      "message": "sit ut cupidatat",
      "field": "elit mollit",
      "error_id": "culpa velit cillum"
    },
    {
      "message": "sed",
      "field": "aliqua id velit esse",
      "error_id": "aliquip ea qui"
    }
  ]
}
{
  "errors": [
    {
      "message": "voluptate minim",
      "field": "exercitation eu laborum",
      "error_id": "est exercitation"
    },
    {
      "message": "magna elit non dolore culpa",
      "field": "tempor pariatur in",
      "error_id": "eu dolore enim veniam"
    },
    {
      "message": "fugiat nisi irure ut magna",
      "field": "eiusmod Duis ea occaecat sit",
      "error_id": "amet proident non minim"
    },
    {
      "message": "in elit consectetur do",
      "field": "culpa aliqua velit aute",
      "error_id": "ea labore dolor"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "message": "et consectetur",
      "field": "culpa in ullamco",
      "error_id": "minim nulla"
    }
  ]
}
{
  "errors": [
    {
      "message": "adipisicing",
      "field": "ut do ut dolor",
      "error_id": "sed dolore esse"
    },
    {
      "message": "ea est proident",
      "field": "sit dolor irure et",
      "error_id": "ex dolore dolore enim amet"
    },
    {
      "message": "occaecat et",
      "field": "in velit eu pariatur",
      "error_id": "velit labore"
    },
    {
      "message": "quis deserunt aliqua id",
      "field": "ullamco Ut",
      "error_id": "aute"
    }
  ]
}
Request Payload
{
  "name": "Ahoy, World!",
  "editor": "design",
  "subject": "Getting Started",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: arial,helvetica,sans-serif;\n      font-size: 14px;\n    }\n    body {\n      color: #000000;\n    }\n    body a {\n      color: #1188E6;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    ul ul ul ul  {\n      list-style-type: disc !important;\n    }\n    ol ol {\n      list-style-type: lower-roman !important;\n    }\n    ol ol ol {\n      list-style-type: lower-latin !important;\n    }\n    ol ol ol ol {\n      list-style-type: decimal !important;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start--><!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p></p>\n      </td>\n    </tr>\n  </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n    <tbody>\n      <tr>\n        <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "plain_content": "Ahoy, World!\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )"
}
Response Payload
{
  "id": "3247eaea-c912-42a3-b0bc-60bdaf210396",
  "name": "Ahoy, World!",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: arial,helvetica,sans-serif;\n      font-size: 14px;\n    }\n    body {\n      color: #000000;\n    }\n    body a {\n      color: #1188E6;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    ul ul ul ul  {\n      list-style-type: disc !important;\n    }\n    ol ol {\n      list-style-type: lower-roman !important;\n    }\n    ol ol ol {\n      list-style-type: lower-latin !important;\n    }\n    ol ol ol ol {\n      list-style-type: decimal !important;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start--><!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p></p>\n      </td>\n    </tr>\n  </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n    <tbody>\n      <tr>\n        <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "plain_content": "Ahoy, World!\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
  "generate_plain_content": false,
  "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/kjlrmded0qnrscv8zqr39npoimrpdwgiax59q8iq6ovj7yoks2fzxoxpfjpwph6o.png",
  "subject": "Getting Started",
  "created_at": "2021-04-30T18:51:20Z",
  "updated_at": "2021-04-30T18:51:20Z",
  "editor": "design",
  "categories": []
}
{
  "errors": [
    {
      "message": "ea fugiat adipisicing",
      "field": "fugiat amet",
      "error_id": "consectetur"
    }
  ]
}
Query Parameter NameExample
page_size35666535
page_tokenaliquip minim velit exercitation est
summaryfalse
Request Payload
Response Payload
{
  "result": [
    {
      "id": "3247eaea-c912-42a3-b0bc-60bdaf210396",
      "name": "Welcome Email",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/llny8o5b3m636z92p7hbjnmq1jvpka39p370jwtin2s1wxv7x1sgm0y5fk518d0s.png",
      "subject": "Welcom to the Cake or Pie Cafe",
      "created_at": "2021-04-09T17:29:46Z",
      "updated_at": "2021-04-09T17:29:55Z",
      "editor": "code",
      "categories": [
        "welcome",
        "new customer"
      ]
    },
    {
      "id": "02dfd792-f31f-439a-a79e-5c47fbcfdbac",
      "name": "Monthly Promo",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/hfyxahd7ues2ajuoeoqq2xe6ibdasl1q89ox0y9ncya2ftpoicssmtf9ddus4c39.png",
      "subject": "Free Dozen Cupcakes",
      "created_at": "2021-04-09T17:29:21Z",
      "updated_at": "2021-04-09T17:29:42Z",
      "editor": "design",
      "categories": [
        "promo",
        "coupon"
      ]
    },
    {
      "id": "e54be823-19ef-4c6f-8b60-efd7514f492d",
      "name": "Duplicate: Ingrid & Anders",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/12kni9gjpyb9uxmwr9vk7unycjr70u95zoyhe9sg2zounul2zg7dih1s20k13q2z.png",
      "subject": "Welcome to Ingrid & Anders!",
      "created_at": "2020-10-09T17:33:46Z",
      "updated_at": "2021-04-07T19:57:52Z",
      "editor": "design",
      "categories": []
    }
  ],
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/designs?page_token=vHdvHCg0w1F-TmWJcPNpTEnFY2aPEmRBHONwOgZ6TgJbX2_I",
    "count": 3
  }
}
Request Payload
{
  "name": "Ahoy, Cake or Pie Cafe!",
  "editor": "design"
}
Response Payload
{
  "id": "abe0877f-a224-21e2-b62e-c789d326cda5",
  "name": "Ahoy, Pre-built Design!",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: courier, monospace;\n      font-size: 16px;\n    }\n    body {\n      color: #FFFFFF;\n    }\n    body a {\n      color: #fe5d61;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start-->\n\n     <!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#fe5d61\" data-body-style=\"font-size:16px; font-family:courier, monospace; color:#FFFFFF; background-color:#f2f4fb;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#f2f4fb\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#f2f4fb\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#FFFFFF; text-align:left;\" bgcolor=\"#f2f4fb\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p>You've found the secret!</p>\n      </td>\n    </tr>\n  </table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"98ndJyAY9BSGjoVqrr6FYx\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:30px 0px 30px 0px;\" valign=\"top\" align=\"left\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:40% !important; width:40%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/9d9c1f3d8009c42bbe60c0355f1ed23e86c3f5619173e83a9328b9214e42e1c1d5e009ed5cc4c8f3efedfc33d46bba2f4577b143607025a29add6e89ab4662ad.png\" alt=\"Off Grid Adventures\" width=\"240\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"3Ypdby9Xfsf2rN27zTDEfN\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/e324b295c47223f1a936198fbd4e5d4b239ff86c6d6c89d4d0eb8d7c61028921abfc4901ba607f6dcb7acc7067bb0c6df4313726b14b8274e0b2c98cdf8b58d2.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"7pyDCmyDaGcm5WsBBSaEgv\" data-mc-module-version=\"2019-10-22\">\n      <tbody><tr>\n        <td style=\"background-color:#FE5D61; padding:50px 0px 30px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#FE5D61\"><div><div style=\"font-family: inherit; text-align: center\"><span style=\"font-size: 24px\">Welcome to the family!</span></div><div></div></div></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"nSVYnVzPLnGZ4wUdynLiKo\" data-mc-module-version=\"2019-10-22\">\n      <tbody><tr>\n        <td style=\"background-color:#fe5d61; padding:30px 50px 30px 50px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#fe5d61\"><div><div style=\"font-family: inherit; text-align: center\">You've found a community of travelers that are just like you.</div>\n<div style=\"font-family: inherit; text-align: center\">&nbsp;</div>\n<div style=\"font-family: inherit; text-align: center\">We don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.</div>\n<div style=\"font-family: inherit; text-align: center\">&nbsp;</div>\n<div style=\"font-family: inherit; text-align: center\">Ready for your next authentic travel experience?</div><div></div></div></td>\n      </tr>\n    </tbody></table><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"module\" data-role=\"module-button\" data-type=\"button\" role=\"module\" style=\"table-layout:fixed\" width=\"100%\" data-muid=\"4ywPd9vJ6WFyV1Si75h9vh\"><tbody><tr><td align=\"center\" bgcolor=\"#fe5d61\" class=\"outer-td\" style=\"padding:10px 10px 60px 10px; background-color:#fe5d61;\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"button-css__deep-table___2OZyb wrapper-mobile\" style=\"text-align:center\"><tbody><tr><td align=\"center\" bgcolor=\"#ffffff\" class=\"inner-td\" style=\"border-radius:6px; font-size:16px; text-align:center; background-color:inherit;\"><a style=\"background-color:#ffffff; border:1px solid #ffffff; border-color:#ffffff; border-radius:3px; border-width:1px; color:#fe5d61; display:inline-block; font-size:16px; font-weight:700; letter-spacing:1px; line-height:40px; padding:12px 20px 12px 20px; text-align:center; text-decoration:none; border-style:solid;\" href=\"\" target=\"_blank\">Browse Gallery</a></td></tr></tbody></table></td></tr></tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"6jxKSRk9dKQ1Tvi1wtnu8q\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/0accac77b1e34c614730ab732317a493478835c96bd549fb2df7a921ec1177fdb30d6d33e1d0a33d8c6c579344890ae408ce13aaed0e478f1fd6d2219d308365.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"iYySZ4rAB78PLoW7vU13Bb\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"divider\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"mVyZz43HETwfwb72TGh4iy\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 0px 0px;\" role=\"module-content\" height=\"100%\" valign=\"top\" bgcolor=\"\">\n          <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" align=\"center\" width=\"100%\" height=\"3px\" style=\"line-height:3px; font-size:3px;\">\n            <tbody><tr>\n              <td style=\"padding:0px 0px 3px 0px;\" bgcolor=\"#ffffff\"></td>\n            </tr>\n          </tbody></table>\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"sfek66tVLi5d2iy5jmSawj\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"social\" align=\"center\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"87277ffe-54ed-4792-94f3-0a973b71c268\">\n    <tbody>\n      <tr>\n        <td valign=\"top\" style=\"padding:0px 0px 0px 0px; font-size:6px; line-height:10px;\" align=\"center\">\n          <table align=\"center\" style=\"-webkit-margin-start:auto;-webkit-margin-end:auto;\">\n            <tbody><tr align=\"center\"><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.facebook.com/sendgrid/\" target=\"_blank\" alt=\"Facebook\" title=\"Facebook\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Facebook\" title=\"Facebook\" src=\"https://mc.sendgrid.com/assets/social/white/facebook.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor\" target=\"_blank\" alt=\"Twitter\" title=\"Twitter\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Twitter\" title=\"Twitter\" src=\"https://mc.sendgrid.com/assets/social/white/twitter.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.instagram.com/sendgrid/?hl=en\" target=\"_blank\" alt=\"Instagram\" title=\"Instagram\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Instagram\" title=\"Instagram\" src=\"https://mc.sendgrid.com/assets/social/white/instagram.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.pinterest.com/sendgrid/\" target=\"_blank\" alt=\"Pinterest\" title=\"Pinterest\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Pinterest\" title=\"Pinterest\" src=\"https://mc.sendgrid.com/assets/social/white/pinterest.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td></tr></tbody>\n          </table>\n        </td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module unsubscribe-css__unsubscribe___2CDlR\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#FFFFFF; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:center;\" data-muid=\"txBUUpmixSjuZ5Ad69p1sX\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "plain_content": "You've found the secret!\n\nWelcome to the family!\n\nYou've found a community of travelers that are just like you.\n\nWe don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.\n\nReady for your next authentic travel experience?\n\nBrowse Gallery\n\n( https://www.facebook.com/sendgrid/ ) ( https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor ) ( https://www.instagram.com/sendgrid/?hl=en ) ( https://www.pinterest.com/sendgrid/ )\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
  "generate_plain_content": true,
  "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/a85b4b202ff28094828f11ff472360caecf67ead2d186b69b45c904b9251aa0b.png",
  "subject": "Welcome to the family!",
  "created_at": "2021-04-30T19:15:28Z",
  "updated_at": "2021-04-30T19:15:28Z",
  "editor": "design",
  "categories": []
}
{
  "errors": [
    {
      "message": "sunt dolor velit exercitation",
      "field": "in in eiusmod",
      "error_id": "sit"
    }
  ]
}
{
  "errors": [
    {
      "message": "dolore officia velit Duis",
      "field": "est Duis qui",
      "error_id": "labore sed in consectetur aliqua"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "6ad69134-7165-48cb-964a-6c3cf03e8af8",
  "name": "Off Grid Adventures",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: courier, monospace;\n      font-size: 16px;\n    }\n    body {\n      color: #FFFFFF;\n    }\n    body a {\n      color: #fe5d61;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start-->\n\n     <!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#fe5d61\" data-body-style=\"font-size:16px; font-family:courier, monospace; color:#FFFFFF; background-color:#f2f4fb;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#f2f4fb\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#f2f4fb\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#FFFFFF; text-align:left;\" bgcolor=\"#f2f4fb\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p>You've found the secret!</p>\n      </td>\n    </tr>\n  </table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"98ndJyAY9BSGjoVqrr6FYx\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:30px 0px 30px 0px;\" valign=\"top\" align=\"left\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:40% !important; width:40%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/9d9c1f3d8009c42bbe60c0355f1ed23e86c3f5619173e83a9328b9214e42e1c1d5e009ed5cc4c8f3efedfc33d46bba2f4577b143607025a29add6e89ab4662ad.png\" alt=\"Off Grid Adventures\" width=\"240\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"3Ypdby9Xfsf2rN27zTDEfN\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/e324b295c47223f1a936198fbd4e5d4b239ff86c6d6c89d4d0eb8d7c61028921abfc4901ba607f6dcb7acc7067bb0c6df4313726b14b8274e0b2c98cdf8b58d2.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"7pyDCmyDaGcm5WsBBSaEgv\" data-mc-module-version=\"2019-10-22\">\n      <tbody><tr>\n        <td style=\"background-color:#FE5D61; padding:50px 0px 30px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#FE5D61\"><div><div style=\"font-family: inherit; text-align: center\"><span style=\"font-size: 24px\">Welcome to the family!</span></div><div></div></div></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"nSVYnVzPLnGZ4wUdynLiKo\" data-mc-module-version=\"2019-10-22\">\n      <tbody><tr>\n        <td style=\"background-color:#fe5d61; padding:30px 50px 30px 50px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#fe5d61\"><div><div style=\"font-family: inherit; text-align: center\">You've found a community of travelers that are just like you.</div>\n<div style=\"font-family: inherit; text-align: center\">&nbsp;</div>\n<div style=\"font-family: inherit; text-align: center\">We don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.</div>\n<div style=\"font-family: inherit; text-align: center\">&nbsp;</div>\n<div style=\"font-family: inherit; text-align: center\">Ready for your next authentic travel experience?</div><div></div></div></td>\n      </tr>\n    </tbody></table><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"module\" data-role=\"module-button\" data-type=\"button\" role=\"module\" style=\"table-layout:fixed\" width=\"100%\" data-muid=\"4ywPd9vJ6WFyV1Si75h9vh\"><tbody><tr><td align=\"center\" bgcolor=\"#fe5d61\" class=\"outer-td\" style=\"padding:10px 10px 60px 10px; background-color:#fe5d61;\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"button-css__deep-table___2OZyb wrapper-mobile\" style=\"text-align:center\"><tbody><tr><td align=\"center\" bgcolor=\"#ffffff\" class=\"inner-td\" style=\"border-radius:6px; font-size:16px; text-align:center; background-color:inherit;\"><a style=\"background-color:#ffffff; border:1px solid #ffffff; border-color:#ffffff; border-radius:3px; border-width:1px; color:#fe5d61; display:inline-block; font-size:16px; font-weight:700; letter-spacing:1px; line-height:40px; padding:12px 20px 12px 20px; text-align:center; text-decoration:none; border-style:solid;\" href=\"\" target=\"_blank\">Browse Gallery</a></td></tr></tbody></table></td></tr></tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"6jxKSRk9dKQ1Tvi1wtnu8q\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/0accac77b1e34c614730ab732317a493478835c96bd549fb2df7a921ec1177fdb30d6d33e1d0a33d8c6c579344890ae408ce13aaed0e478f1fd6d2219d308365.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"iYySZ4rAB78PLoW7vU13Bb\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"divider\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"mVyZz43HETwfwb72TGh4iy\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 0px 0px;\" role=\"module-content\" height=\"100%\" valign=\"top\" bgcolor=\"\">\n          <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" align=\"center\" width=\"100%\" height=\"3px\" style=\"line-height:3px; font-size:3px;\">\n            <tbody><tr>\n              <td style=\"padding:0px 0px 3px 0px;\" bgcolor=\"#ffffff\"></td>\n            </tr>\n          </tbody></table>\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"sfek66tVLi5d2iy5jmSawj\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"social\" align=\"center\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"87277ffe-54ed-4792-94f3-0a973b71c268\">\n    <tbody>\n      <tr>\n        <td valign=\"top\" style=\"padding:0px 0px 0px 0px; font-size:6px; line-height:10px;\" align=\"center\">\n          <table align=\"center\" style=\"-webkit-margin-start:auto;-webkit-margin-end:auto;\">\n            <tbody><tr align=\"center\"><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.facebook.com/sendgrid/\" target=\"_blank\" alt=\"Facebook\" title=\"Facebook\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Facebook\" title=\"Facebook\" src=\"https://mc.sendgrid.com/assets/social/white/facebook.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor\" target=\"_blank\" alt=\"Twitter\" title=\"Twitter\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Twitter\" title=\"Twitter\" src=\"https://mc.sendgrid.com/assets/social/white/twitter.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.instagram.com/sendgrid/?hl=en\" target=\"_blank\" alt=\"Instagram\" title=\"Instagram\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Instagram\" title=\"Instagram\" src=\"https://mc.sendgrid.com/assets/social/white/instagram.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.pinterest.com/sendgrid/\" target=\"_blank\" alt=\"Pinterest\" title=\"Pinterest\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Pinterest\" title=\"Pinterest\" src=\"https://mc.sendgrid.com/assets/social/white/pinterest.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td></tr></tbody>\n          </table>\n        </td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module unsubscribe-css__unsubscribe___2CDlR\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#FFFFFF; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:center;\" data-muid=\"txBUUpmixSjuZ5Ad69p1sX\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "plain_content": "You've found the secret!\n\nWelcome to the family!\n\nYou've found a community of travelers that are just like you.\n\nWe don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.\n\nReady for your next authentic travel experience?\n\nBrowse Gallery\n\n( https://www.facebook.com/sendgrid/ ) ( https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor ) ( https://www.instagram.com/sendgrid/?hl=en ) ( https://www.pinterest.com/sendgrid/ )\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
  "generate_plain_content": true,
  "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/a85b4b202ff28094828f11ff472360caecf67ead2d186b69b45c904b9251aa0b.png",
  "subject": "Welcome to the family!",
  "created_at": "2019-09-10T02:11:34Z",
  "updated_at": "2021-01-11T21:47:52Z",
  "editor": "design",
  "categories": []
}
{
  "errors": [
    {
      "message": "reprehenderit culpa",
      "field": "culpa laborum",
      "error_id": "anim elit ut"
    }
  ]
}
{
  "errors": [
    {
      "message": "aliquip exercitation sit occaecat",
      "field": "Lorem voluptate",
      "error_id": "et ad cillum est"
    },
    {
      "message": "in voluptate do pariatur mollit",
      "field": "veniam Duis et sed",
      "error_id": "qui tempor"
    },
    {
      "message": "in in",
      "field": "proident",
      "error_id": "culpa elit"
    },
    {
      "message": "sit do occaecat",
      "field": "pariatur Duis incididunt voluptate anim",
      "error_id": "ad voluptate occaecat minim"
    },
    {
      "message": "veniam",
      "field": "ut exercitation adipisicing elit",
      "error_id": "exercitation sint esse eu dolore"
    }
  ]
}
Query Parameter NameExample
page_size48494320
page_tokeneu
summaryfalse
Request Payload
Response Payload
{
  "result": [
    {
      "id": "6ad69134-7165-48cb-964a-6c3cf03e8af8",
      "name": "Off Grid Adventures",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/a85b4b202ff28094828f11ff472360caecf67ead2d186b69b45c904b9251aa0b.png",
      "subject": "Welcome to the family!",
      "created_at": "2019-09-10T02:11:34Z",
      "updated_at": "2021-01-11T21:47:52Z",
      "editor": "design",
      "categories": []
    },
    {
      "id": "b0a9c6f7-a9a1-4b52-b0c5-16fc6f4cdb2b",
      "name": "Song Riddle",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/4ef3a39249f3accb8461b03950c071454a745a232508feca89a626b3e7f578d3.png",
      "subject": "Welcome to Song Riddle!",
      "created_at": "2019-09-10T02:12:32Z",
      "updated_at": "2021-01-11T21:46:43Z",
      "editor": "design",
      "categories": []
    },
    {
      "id": "f8d8da76-bcca-4cfe-b809-733887855f57",
      "name": "Ingrid & Anders 1",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/15c97ffa97ee31693581a67526728d096eef00adfbaa34bb030d91034d477da4.png",
      "subject": "Welcome to Ingrid & Anders!",
      "created_at": "2019-09-10T02:10:38Z",
      "updated_at": "2021-01-11T21:45:05Z",
      "editor": "design",
      "categories": []
    },
    {
      "id": "2935a7d0-7f02-4e0f-a570-dc302ce09749",
      "name": "Ingrid & Anders 2",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/7b36a6c0955cab0c350d105114ad248700a685bd11032592cdef85ae26540afc.png",
      "subject": "Check out these exclusive deals!",
      "created_at": "2019-09-10T02:09:31Z",
      "updated_at": "2021-01-11T21:44:08Z",
      "editor": "design",
      "categories": []
    },
    {
      "id": "7826ef14-7ba6-4dbc-91f0-a8c610ebe962",
      "name": "Ingrid & Anders 3",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/6dd8dd73a1a62bd7a76c4313b52d7c749250d49e31b19cce718906655fcbc675.png",
      "subject": "Join our VIP club and save big!",
      "created_at": "2019-09-10T02:08:29Z",
      "updated_at": "2021-01-11T21:41:35Z",
      "editor": "design",
      "categories": []
    },
    {
      "id": "41da47e7-d3e2-491b-a83f-f499a4139d6a",
      "name": "Mercado",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/9cc87cc7671719712d9d363184995d0ec05103355db300ff03641fe9e205651d.png",
      "subject": "Subject",
      "created_at": "2019-09-10T02:03:06Z",
      "updated_at": "2021-01-11T21:39:23Z",
      "editor": "design",
      "categories": []
    }
  ],
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/designs/pre-builts?page_token=yYzyCxj-iIVgP54t6NjKkunDCKYLLpngo-5vAsfYXz0To34U",
    "count": 6
  }
}

Contacts(13 operations)

Request Payload
{
  "list_ids": [
    "d2dcfffd-7e12-ac12-9d8c-82945a0400ee"
  ],
  "contacts": [
    {
      "address_line_1": "ad Excepte",
      "address_line_2": "aliqua nulla nisi",
      "alternate_emails": [
        "et ullamco est",
        "quis culpa nostrud ad dolor",
        "nostrud Ut in",
        "veniam",
        "cupidatat deserunt"
      ],
      "city": "quis consequat tempor incididunt",
      "country": "consequat culpa",
      "email": "ut",
      "first_name": "ulla",
      "last_name": "aliquip ipsum ut",
      "postal_code": "laboris",
      "state_province_region": "dolor",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "esse mollit sint Ut",
      "address_line_2": "dolor tempor fugiat cillum Excepteur",
      "alternate_emails": [
        "id eiusmod",
        "sit laborum",
        "reprehenderit labore laborum eu id",
        "dolor aliquip ali",
        "qui quis id"
      ],
      "city": "est",
      "country": "deserunt cupidatat aute consectet",
      "email": "esse labore cupidatat sunt",
      "first_name": "adipisicing in laboris",
      "last_name": "est",
      "postal_code": "adipisicing",
      "state_province_region": "elit minim esse nulla",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "quis aute",
      "address_line_2": "ex dolor do aliquip cillum",
      "alternate_emails": [
        "esse deserunt pariatur",
        "cupidatat",
        "minim culpa",
        "commodo",
        "fugiat aliq"
      ],
      "city": "commodo in ex ",
      "country": "con",
      "email": "amet est",
      "first_name": "reprehenderit nisi laboris",
      "last_name": "irure dolor",
      "postal_code": "cupidatat consectetur Lorem dolore",
      "state_province_region": "Duis velit",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "sint co",
      "address_line_2": "magna",
      "alternate_emails": [
        "Duis occaecat eu",
        "dolor",
        "anim labore culpa enim ad",
        "Ut irure ipsum sunt incididunt",
        "irure enim est"
      ],
      "city": "anim laborum",
      "country": "sit minim",
      "email": "laboris dolore ullamco",
      "first_name": "et",
      "last_name": "exercitation eiusmod et o",
      "postal_code": "enim dolor ea",
      "state_province_region": "cillum enim eiusmod",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "ipsum nostrud",
      "address_line_2": "occaecat ad ipsum qui",
      "alternate_emails": [
        "culpa qui",
        "ullamco in cupidatat",
        "ex",
        "o",
        "commodo ut occaecat ea laboris"
      ],
      "city": "dolor Duis",
      "country": "ut proident",
      "email": "dolore",
      "first_name": "tempor pariatur",
      "last_name": "culpa dolore",
      "postal_code": "fugiat",
      "state_province_region": "adipisicing voluptate dolore quis occaec",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "adipisicing ea consectetur nisi ex",
      "address_line_2": "et aute commodo ad nulla",
      "alternate_emails": [
        "consectetur officia tempor exercitation ex",
        "esse dolor officia",
        "in occaecat consequat dolor et",
        "r",
        "officia occaecat sunt"
      ],
      "city": "consectetur ut",
      "country": "irure enim aliqua voluptate",
      "email": "do mollit",
      "first_name": "cillum id",
      "last_name": "pariatur commodo a",
      "postal_code": "Duis deserunt officia quis",
      "state_province_region": "dolor labore occ",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "magna",
      "address_line_2": "et labore nostrud cupidatat",
      "alternate_emails": [
        "ut non ad dolor minim",
        "dolor culpa proident sint",
        "reprehenderit voluptate esse aliqua officia",
        "irure ex ut",
        "nostrud"
      ],
      "city": "Excepteur sunt",
      "country": "ad cupidatat cillum",
      "email": "adipisicing mollit",
      "first_name": "est veni",
      "last_name": "aute",
      "postal_code": "labore ipsum",
      "state_province_region": "cupidatat",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "in sit com",
      "address_line_2": "ut Excepteur officia fugiat consequat",
      "alternate_emails": [
        "veniam reprehenderit aliqua velit minim",
        "do",
        "dolor quis elit ex",
        "enim",
        "sed eu nostrud reprehenderit"
      ],
      "city": "non proident sint elit aliqua",
      "country": "sit irure mol",
      "email": "laborum ullamco cillum cupidatat",
      "first_name": "sed qui Duis eu aliquip",
      "last_name": "amet d",
      "postal_code": "enim ullamco labore",
      "state_province_region": "aute consectetur",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "ip",
      "address_line_2": "amet",
      "alternate_emails": [
        "pariatur aliqua dolor ut ad",
        "ad Lorem laboris in sunt",
        "est cillum in",
        "nisi elit dolore Excepteur",
        "in"
      ],
      "city": "a",
      "country": "in velit",
      "email": "quis",
      "first_name": "pariatur et Ut",
      "last_name": "Excepteur nulla adipisicing ut",
      "postal_code": "est aliquip cillum",
      "state_province_region": "ea fugiat cillum consectetur",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "",
      "address_line_2": "adi",
      "alternate_emails": [
        "nostrud sint deserunt ullamco",
        "dolor aliquip",
        "fugiat sunt eu velit",
        "in occaecat cillum",
        "nu"
      ],
      "city": "commodo eu ",
      "country": "Duis consectetur ",
      "email": "fugiat exercitation sit",
      "first_name": "ani",
      "last_name": "amet pariatur",
      "postal_code": "ex veniam commodo sunt fugiat",
      "state_province_region": "in aute",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    }
  ]
}
Response Payload
{
  "job_id": "dolore id"
}
{
  "errors": [
    {
      "message": "nisi anim",
      "field": "in ex",
      "error_id": "deserunt",
      "parameter": "esse eu dolore eiusmod"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "irure exercitation enim"
    },
    {
      "message": "officia enim nisi"
    },
    {
      "message": "sit dolor aliquip irure in"
    },
    {
      "message": "deserunt pariatur"
    }
  ]
}
Query Parameter NameExample
delete_all_contactselit
idslaborum
Request Payload
Response Payload
{
  "job_id": {}
}
{
  "errors": []
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "laboris esse voluptate deserunt eiusmod"
    },
    {
      "message": "laborum"
    },
    {
      "message": "elit ad"
    },
    {
      "message": "nostrud eu"
    },
    {
      "message": "incididunt minim"
    }
  ]
}
Request Payload
Response Payload
{
  "result": [
    {
      "id": "sit mollit",
      "first_name": "esse proident commodo dolor",
      "last_name": "id Excepteur laboris proident",
      "unique_name": "aute reprehenderit occaecat do",
      "email": "magna labore",
      "alternate_emails": [
        "mollit officia ipsum deserunt",
        "voluptate ut sint culpa",
        "ad id sed quis eu"
      ],
      "address_line_1": "laboris consequat tempor ex in",
      "address_line_2": "dolore minim ipsum mollit",
      "city": "adipisicing eu",
      "state_province_region": "in",
      "country": "fugiat ut ut nulla aliquip",
      "postal_code": "in officia sit elit adipisicing",
      "phone_number": "ipsum labore laboris adipisicing eu",
      "whatsapp": "nisi",
      "line": "dolore nisi Ut",
      "facebook": "magna Lorem",
      "list_ids": [
        "amet consectetur nisi elit"
      ],
      "segment_ids": [
        "aute elit sit labore",
        "ut ex",
        "quis nostrud commodo"
      ],
      "custom_fields": {},
      "created_at": "consectetur voluptate",
      "updated_at": "nisi proident ut in",
      "_metadata": {
        "self": "amet"
      }
    },
    {
      "id": "incididunt quis",
      "first_name": "sed fugiat sint laborum",
      "last_name": "amet nisi Lorem commodo dolor",
      "unique_name": "Ut adipisicing qui",
      "email": "eu minim laborum sed nostrud",
      "alternate_emails": [
        "nostrud fugiat"
      ],
      "address_line_1": "exercitation in cillum culpa",
      "address_line_2": "ea",
      "city": "aliqua velit consequat",
      "state_province_region": "ut",
      "country": "officia esse eiusmod",
      "postal_code": "dolore ut magna veniam enim",
      "phone_number": "exercitation ullamco dolor Ut eiusmod",
      "whatsapp": "Lorem veniam sint adipisicing",
      "line": "qui est cillum officia",
      "facebook": "pariatur",
      "list_ids": [
        "ut dolor elit Duis laboris",
        "magna",
        "commodo ea dolor",
        "in ad adipisicing dolor"
      ],
      "segment_ids": [
        "est culpa anim fugiat",
        "sint ea labore",
        "voluptate nostrud dolore Duis cillum"
      ],
      "custom_fields": {},
      "created_at": "elit in",
      "updated_at": "anim ut",
      "_metadata": {
        "self": "cillum sunt enim labore id"
      }
    }
  ],
  "_metadata": {
    "self": "quis nostrud voluptate"
  },
  "contact_count": -69188893
}
{
  "errors": [
    {
      "message": "quis sunt dolor magna dolor",
      "field": "pariatur incididunt officia id dolore",
      "error_id": "Lorem dolore in tempor",
      "parameter": "ullamco dolor id eu laboris"
    },
    {
      "message": "in",
      "field": "do",
      "error_id": "Lorem ullamco enim commodo minim",
      "parameter": "mollit"
    },
    {
      "message": "in fugiat cupidatat nulla",
      "field": "amet eiusmod",
      "error_id": "velit ipsum esse ut",
      "parameter": "esse nostrud ullamco cupidatat"
    },
    {
      "message": "officia Excepteur",
      "field": "cillum qui et commodo",
      "error_id": "Duis ipsum non Lorem",
      "parameter": "fugiat"
    },
    {
      "message": "dolor irure",
      "field": "et",
      "error_id": "culpa consequat ullamco",
      "parameter": "laboris dolore Lorem"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "sunt et velit elit"
    }
  ]
}
Request Payload
Response Payload
{
  "contact_count": 2284619,
  "billable_count": 27882093,
  "billable_breakdown": {
    "total": -56122658,
    "breakdown": {}
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "commodo nisi"
    },
    {
      "message": "reprehenderit"
    }
  ]
}
Request Payload
{
  "list_ids": [
    "e5285532-4c89-47d6-9fed-abb12a5df706"
  ],
  "segment_ids": [
    "adipisicing culpa ut sint",
    "qui ut",
    "adipisicing proident elit magna dolor"
  ],
  "notifications": {
    "email": false
  },
  "file_type": "json",
  "max_file_size": -18619899
}
Response Payload
{
  "_metadata": {
    "prev": "https://JOvdXAMCaEhlstWPHUwKfAZrSdycp.rxBlGCGyAkrROqKaZQAAQLfIT1VhTPscO+GzfV7Qjz2NkXDXlcsibJg6ZhTMNdEh+Rwq00fVs2kF,5V",
    "self": "https://ypOogXZBjAOWxFt.eiqVcTFJVmZzQfjyFwx8W2q1CSo08ZrAPtlclxXzg3qibkhar4NO5u",
    "next": "https://geCFPHwBEWGjVcrzJDpH.kptwQ-Ke6pl1eo,-L7RHxaDyLn",
    "count": -96585836.49773362
  },
  "id": "amet"
}
{
  "errors": [
    {
      "message": "dolor proident in",
      "field": "ipsum est",
      "error_id": "pariatur quis dolore",
      "parameter": "mollit pariatur"
    },
    {
      "message": "magna",
      "field": "elit exercitation do commodo",
      "error_id": "labore officia elit incididunt reprehenderit",
      "parameter": "exercitation esse"
    },
    {
      "message": "et veniam consequat",
      "field": "culpa",
      "error_id": "ut ex",
      "parameter": "Duis adipisicing ut aliqua magna"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "non in laboris"
    }
  ]
}
Request Payload
Response Payload
{
  "result": [
    {
      "id": "qui laboris eiusmod",
      "status": "dolore laboris nostrud incididunt",
      "created_at": "amet quis ullamco aute",
      "completed_at": "fugiat deserunt laboris culpa Lorem",
      "expires_at": "nostrud velit",
      "urls": [
        "nostrud in culpa dolore",
        "fugiat reprehenderit ea pariatur",
        "eiusmod incididunt laboris",
        "dolor fugiat dolor velit",
        "Lorem cillum officia qui quis"
      ],
      "user_id": "nisi commodo eiusmod ipsum incididunt",
      "export_type": "adipisicing",
      "segments": [
        {
          "ID": "ullamco",
          "Name": "voluptate ut"
        },
        {
          "ID": "esse",
          "Name": "occaecat fugiat sunt veniam"
        },
        {
          "ID": "veniam",
          "Name": "reprehenderit"
        }
      ],
      "lists": [
        {
          "ID": "proident consectetur ex aliquip",
          "Name": "minim"
        },
        {
          "ID": "proident aute culpa fugiat",
          "Name": "sunt"
        }
      ],
      "_metadata": {
        "prev": "mollit cillum ut",
        "self": "Lorem quis consectetur",
        "next": "veniam ea"
      }
    },
    {
      "id": "incididunt",
      "status": "sint ad sed sit laborum",
      "created_at": "fugiat Lorem dolor sed",
      "completed_at": "pariatur culpa",
      "expires_at": "consequat proident Lorem irure",
      "urls": [
        "commodo laboris dolore fugiat cupidatat",
        "do nisi exercitation ullamco",
        "consectetur culpa qui cupidatat nostrud"
      ],
      "user_id": "minim culpa pariatur",
      "export_type": "in adipisicing do proident id",
      "segments": [
        {
          "ID": "eu Excepteur sed",
          "Name": "nulla magna"
        },
        {
          "ID": "ea magna",
          "Name": "laboris officia"
        }
      ],
      "lists": [
        {
          "ID": "laboris aute quis",
          "Name": "eu reprehenderit ea quis laborum"
        },
        {
          "ID": "Ut",
          "Name": "ex quis dolore"
        },
        {
          "ID": "minim exercitation ut nulla",
          "Name": "pariatur eiusmod et"
        }
      ],
      "_metadata": {
        "prev": "incididunt",
        "self": "in esse laboris",
        "next": "exercitation officia esse sed ut"
      }
    },
    {
      "id": "elit laborum",
      "status": "ut ullamco est velit",
      "created_at": "id do deserunt dolore",
      "completed_at": "nulla",
      "expires_at": "quis eu Duis nulla ut",
      "urls": [
        "nisi ad dolor sunt enim",
        "sed id",
        "veniam aute velit ut sed"
      ],
      "user_id": "in sint",
      "export_type": "dolore culpa",
      "segments": [
        {
          "ID": "sit eu adipisicing",
          "Name": "proident Lorem"
        }
      ],
      "lists": [
        {
          "ID": "aute",
          "Name": "commodo id est elit minim"
        },
        {
          "ID": "ea",
          "Name": "enim cillum"
        },
        {
          "ID": "consectetur in amet",
          "Name": "enim"
        },
        {
          "ID": "Excepteur ullamco irure",
          "Name": "Excepteur ut nisi Duis"
        },
        {
          "ID": "id in non incididunt proident",
          "Name": "reprehenderit"
        }
      ],
      "_metadata": {
        "prev": "dolore laborum",
        "self": "labore in enim",
        "next": "occaecat non"
      }
    },
    {
      "id": "adipisicing",
      "status": "eu occaecat nulla dolor ex",
      "created_at": "ipsum ullamco quis eiusmod",
      "completed_at": "Lorem cupidatat do",
      "expires_at": "ullamco Duis",
      "urls": [
        "pariatur tempor",
        "eiusmod",
        "consequat Duis officia eu consectetur",
        "aliquip ipsum aute sunt Lorem"
      ],
      "user_id": "nulla in ad occaecat",
      "export_type": "irure",
      "segments": [
        {
          "ID": "ullamco fugiat et",
          "Name": "Ut cupidatat est do quis"
        },
        {
          "ID": "eu",
          "Name": "dolore ea laborum"
        },
        {
          "ID": "nostrud",
          "Name": "consectetur qui Excepteur laboris esse"
        },
        {
          "ID": "laborum",
          "Name": "ea dolor reprehenderit minim"
        }
      ],
      "lists": [
        {
          "ID": "culpa laboris sit elit quis",
          "Name": "velit"
        },
        {
          "ID": "culpa reprehenderit",
          "Name": "dolor cillum nostrud"
        },
        {
          "ID": "non voluptate commodo do",
          "Name": "exercitation aliqua nulla"
        },
        {
          "ID": "sed tempor pariatur voluptate Duis",
          "Name": "quis magna esse"
        }
      ],
      "_metadata": {
        "prev": "culpa sed esse eiusmod",
        "self": "consequat esse ullamco laboris amet",
        "next": "est"
      }
    }
  ],
  "_metadata": {
    "prev": "non est",
    "self": "aliquip",
    "next": "ea in et"
  }
}
{
  "errors": [
    {
      "message": "proident ea occaecat Excepteur culpa",
      "": "velit enim",
      "error_id": "cillum"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "aliqua dolor ad elit dolor"
    },
    {
      "message": "exercitation enim ut ex"
    },
    {
      "message": "ullamco laborum dolor"
    },
    {
      "message": "dolor mollit dolore aute magna"
    },
    {
      "message": "Duis ipsum nostrud adipisicing qui"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "sit laborum aute nostrud cupidatat",
  "first_name": "magna aliqua ex",
  "last_name": "qui Duis culpa tempor",
  "unique_name": "ut magna",
  "email": "nisi amet",
  "alternate_emails": [
    "sed voluptate deserunt officia commodo",
    "quis ut"
  ],
  "address_line_1": "sint",
  "address_line_2": "voluptate Ut qui",
  "city": "velit ipsum est sit",
  "state_province_region": "voluptate dolor irure do",
  "country": "ut",
  "postal_code": "eu adipisicing tempor",
  "phone_number": "dolor",
  "whatsapp": "dolor exercitation ullamco nisi",
  "line": "Duis ut quis exercitation",
  "facebook": "id Duis est eu minim",
  "list_ids": [
    "in dolore sint ad sunt",
    "qui veniam eu fugiat ipsum",
    "ullamco incididunt nostrud",
    "fugiat elit"
  ],
  "segment_ids": [
    "dolor amet magna mollit"
  ],
  "custom_fields": {},
  "created_at": "quis",
  "updated_at": "ipsum",
  "_metadata": {
    "self": "reprehenderit id cillum dolor irure"
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "proident adipisicing fugiat dolor"
    },
    {
      "message": "ea ipsum minim occaecat sint"
    },
    {
      "message": "ullamco ad non in irure"
    },
    {
      "message": "anim eu dolor"
    }
  ]
}
Request Payload
{
  "query": "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')"
}
Response Payload
{
  "result": [
    {
      "id": "mollit Lorem sunt nisi sed",
      "first_name": "cillum",
      "last_name": "Duis nulla enim fugiat",
      "unique_name": "pariatur ad occaecat veniam",
      "email": "velit",
      "alternate_emails": [
        "ad in dolore",
        "ipsum enim mollit sed reprehenderit",
        "id"
      ],
      "address_line_1": "dolore",
      "address_line_2": "eiusmod mollit",
      "city": "sunt",
      "state_province_region": "in ut dolor sit",
      "country": "fugiat in irure",
      "postal_code": "magna",
      "phone_number": "consequat Excepteur velit enim exercitation",
      "whatsapp": "amet dolor eiusmod sit",
      "line": "nulla nostrud proident",
      "facebook": "sit",
      "list_ids": [
        "laborum Ut dolor sint",
        "in laborum est",
        "consectetur",
        "tempor magna et Duis",
        "exercitation do reprehenderit elit ut"
      ],
      "segment_ids": [
        "qui amet dolore quis sit"
      ],
      "custom_fields": {},
      "created_at": "sed non Lorem",
      "updated_at": "cillum",
      "_metadata": {
        "self": "occaecat proident commodo"
      }
    },
    {
      "id": "eu proident in reprehenderit ex",
      "first_name": "veniam Ut ut est ut",
      "last_name": "sed consequat",
      "unique_name": "est id deserunt dolore minim",
      "email": "aliquip velit aute in voluptate",
      "alternate_emails": [
        "eu magna culpa laborum",
        "voluptate"
      ],
      "address_line_1": "est",
      "address_line_2": "cillum Excepteur tempor in ex",
      "city": "sint Duis qui minim",
      "state_province_region": "ex dolore aute eu consequat",
      "country": "ex Excepteur consequat qui",
      "postal_code": "sed ut occaecat eu",
      "phone_number": "consequat ullamco qui Excepteur",
      "whatsapp": "magna consectetur",
      "line": "pariatur",
      "facebook": "do velit",
      "list_ids": [
        "minim sit",
        "mollit",
        "id non cupidatat pariatur"
      ],
      "segment_ids": [
        "enim",
        "tempor consectetur in",
        "ut proident dolor culpa",
        "commodo laborum labore incididunt amet"
      ],
      "custom_fields": {},
      "created_at": "est minim",
      "updated_at": "exercitation Lorem",
      "_metadata": {
        "self": "elit in quis aliquip"
      }
    },
    {
      "id": "aliqua ad pariatur",
      "first_name": "ad est eu mollit occaecat",
      "last_name": "veniam ut Duis mollit",
      "unique_name": "magna nisi consequat non dolore",
      "email": "nisi in",
      "alternate_emails": [
        "et minim Excepteur cillum pariatur"
      ],
      "address_line_1": "sunt",
      "address_line_2": "Lorem",
      "city": "velit mollit",
      "state_province_region": "ipsum exercitation nostrud sit do",
      "country": "id",
      "postal_code": "sint commodo",
      "phone_number": "ut nulla labore officia Excepteur",
      "whatsapp": "Duis est aliqua anim",
      "line": "adipisicing voluptate",
      "facebook": "cupidatat",
      "list_ids": [
        "in ea",
        "officia do fugiat",
        "qui ut",
        "aliquip magna Excepteur",
        "aute ut et aliquip eiusmod"
      ],
      "segment_ids": [
        "quis enim ad"
      ],
      "custom_fields": {},
      "created_at": "dolor laborum",
      "updated_at": "esse consectetur sunt",
      "_metadata": {
        "self": "pariatur eiusmod sed deserunt est"
      }
    },
    {
      "id": "anim deserunt",
      "first_name": "id sit magna commodo",
      "last_name": "in nulla eu eiusmod ea",
      "unique_name": "in irure non mollit",
      "email": "exercitation magna minim",
      "alternate_emails": [
        "amet incididunt",
        "Excepteur deserunt",
        "nisi sint",
        "non sint pariatur",
        "magna fugiat"
      ],
      "address_line_1": "veniam anim",
      "address_line_2": "do dolor sed",
      "city": "in Ut fugiat sed",
      "state_province_region": "Duis voluptate proident minim",
      "country": "proident qui nulla cupidatat eu",
      "postal_code": "sit ipsum",
      "phone_number": "sint ut",
      "whatsapp": "sunt ullamco dolor",
      "line": "voluptate",
      "facebook": "labore",
      "list_ids": [
        "sed amet dolor adipisicing Lorem"
      ],
      "segment_ids": [
        "ut non aute in",
        "nostrud",
        "velit dolore sed veniam nisi"
      ],
      "custom_fields": {},
      "created_at": "in veniam incididunt",
      "updated_at": "in labore officia ut veniam",
      "_metadata": {
        "self": "dolor sint ad"
      }
    },
    {
      "id": "in officia sunt ipsum sit",
      "first_name": "magna ipsum ullamco eiusmod minim",
      "last_name": "occaecat nostrud officia do",
      "unique_name": "in in",
      "email": "ullamco minim",
      "alternate_emails": [
        "velit quis culpa Duis ullamco"
      ],
      "address_line_1": "eiusmod",
      "address_line_2": "officia eiusmod",
      "city": "eu ad voluptate",
      "state_province_region": "voluptate Ut",
      "country": "fugiat veniam sint velit",
      "postal_code": "quis",
      "phone_number": "et elit",
      "whatsapp": "deserunt",
      "line": "irure",
      "facebook": "ipsum aute quis enim",
      "list_ids": [
        "veniam"
      ],
      "segment_ids": [
        "minim ut est",
        "sunt",
        "occaecat est irure",
        "commodo"
      ],
      "custom_fields": {},
      "created_at": "ullamco ea consectetur",
      "updated_at": "elit incididunt quis enim",
      "_metadata": {
        "self": "in ea laborum ad labore"
      }
    }
  ],
  "_metadata": {
    "self": "dolor"
  },
  "contact_count": -68242326.70962349
}
{
  "errors": [
    {
      "field": "sint et Lorem tempor",
      "message": "aliqua dolore sint officia"
    },
    {
      "field": "non exercitation irure cillum",
      "message": "elit non pariatur"
    },
    {
      "field": "Duis",
      "message": "id in ut consectetur labore"
    },
    {
      "field": "laborum aliqua cillum exercitation",
      "message": "adipisicing cillum deserunt enim"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "cillum anim Duis"
    },
    {
      "message": "cupidatat velit"
    },
    {
      "message": "et in id"
    },
    {
      "message": "fugiat Lorem est mollit cupidatat"
    },
    {
      "message": "laborum eiusmod"
    }
  ]
}
Request Payload
{
  "list_ids": [
    "amet cillum exercitation"
  ],
  "file_type": "csv",
  "field_mappings": [
    null,
    "ullamco"
  ]
}
Response Payload
{
  "job_id": "cupidatat dolor deserunt occaecat",
  "upload_uri": "reprehenderit sunt",
  "upload_headers": [
    {
      "header": "dolore veniam velit deserunt nostrud",
      "value": "aliquip reprehenderit ex est proident"
    },
    {
      "header": "elit et",
      "value": "proident sed quis"
    },
    {
      "header": "Ut est",
      "value": "quis amet"
    },
    {
      "header": "exercitation",
      "value": "elit commodo Excepteur Duis"
    },
    {
      "header": "Ut",
      "value": "aliqua qui"
    }
  ]
}
{
  "errors": [
    {
      "message": "sint tempor aliqua dolor officia",
      "field": "dolore veniam sunt",
      "error_id": "reprehenderit",
      "parameter": "labore"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "proident in anim",
      "field": "nisi Excepteur",
      "error_id": "culpa proident",
      "parameter": "Lorem dolor ex cillum anim"
    },
    {
      "message": "elit sit enim magna mollit",
      "field": "nisi occaecat elit",
      "error_id": "irure ut fugiat",
      "parameter": "commodo"
    },
    {
      "message": "id exercitation Excepteur nulla in",
      "field": "ex do veniam",
      "error_id": "Lorem nostrud",
      "parameter": "dolore in consequat ipsum"
    },
    {
      "message": "ipsum",
      "field": "Lorem",
      "error_id": "id anim dolor magna proident",
      "parameter": "et anim sint"
    },
    {
      "message": "tempor magna adipisicing",
      "field": "deserunt anim cupidatat ut Duis",
      "error_id": "sed aute et reprehenderit",
      "parameter": "aliqua"
    }
  ]
}
{
  "errors": [
    {
      "message": "et fugiat nisi"
    },
    {
      "message": "nulla tempor dolor do"
    },
    {
      "message": "Duis culpa"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "ullamco ea Ut pariatur",
  "status": "sunt",
  "job_type": "reprehenderit ea velit dolore labore",
  "results": {
    "requested_count": 62520015.37610394,
    "created_count": 53629101.838691324,
    "updated_count": -50914116.718973815,
    "deleted_count": -87112691.06141008,
    "errored_count": -63414955.09305899,
    "errors_url": "in Ut dolore"
  },
  "started_at": "sint ad dolor Excepteur",
  "finished_at": "in adipisicing do consectetur"
}
{
  "errors": {
    "message": "anim nulla mollit Duis ut",
    "field": "in culpa voluptate eiusmod officia",
    "error_id": "nulla pariatur sit ad ut",
    "parameter": "do"
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "pariatur"
    },
    {
      "message": "minim"
    },
    {
      "message": "minim ex magna Excepteur"
    },
    {
      "message": "id consequat non ea amet"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "minim deserunt non laborum dolor",
  "status": "pending",
  "created_at": "ea eiusmod ut sint",
  "updated_at": "laborum",
  "completed_at": "exercitation mollit ut ea",
  "expires_at": "aliqua commodo ut et aute",
  "urls": [
    "quis et aliquip"
  ],
  "message": "ipsum minim consequat voluptate",
  "_metadata": {
    "prev": "http://aENabfVLToosaEzotppQWcEdIbkXdo.zxoiYNBgaK.bWnBH8ovGxe-KXPrEZ2EcZQ,",
    "self": "https://tbQQeCSw.uijm6WeozG00KBoFMG5ON-60LVU",
    "next": "http://MNHAJTYsYmdTZiPWYDKrpEDEeWtbEWc.pyeTNqy+7Nxfmkal6CwdCyQogq8twnip5XB-flHi3PWz.AeADYo..sSJeIpHAMvBHo3+1+R6lmw,,2jh+",
    "count": 4539297.380207732
  },
  "contact_count": -83620659
}
{
  "errors": [
    {
      "message": "tempor officia voluptate",
      "field": "ea",
      "error_id": "minim ipsum proident ad",
      "parameter": "Excepteur"
    },
    {
      "message": "enim est ex eiusmod",
      "field": "laboris adipisicing",
      "error_id": "mollit consectetur aliqua aute velit",
      "parameter": "mollit in culpa laborum ut"
    },
    {
      "message": "laborum adipisicing est elit incididunt",
      "field": "sed",
      "error_id": "consectetur",
      "parameter": "exercitation laboris reprehenderit in"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "in occaecat deserunt dolor"
    },
    {
      "message": "sint"
    }
  ]
}
Request Payload
{
  "ids": [
    "1234",
    "1235"
  ]
}
Response Payload
{
  "result": [
    {
      "id": "Ut",
      "first_name": "ut sunt elit",
      "last_name": "minim nulla veniam consequat",
      "unique_name": "dolore sit id dolore",
      "email": "aliqua",
      "alternate_emails": [
        "dolore",
        "eu"
      ],
      "address_line_1": "dolore sunt",
      "address_line_2": "ipsum elit sint ea",
      "city": "occaecat aute deserunt ut",
      "state_province_region": "non deserunt amet eu id",
      "country": "dolore nostrud reprehenderit id laboris",
      "postal_code": "mollit aute dolor",
      "phone_number": "sed",
      "whatsapp": "laboris ea fugiat culpa sed",
      "line": "dolor mollit deserunt irure",
      "facebook": "sed laborum Ut in quis",
      "list_ids": [
        "consectetur occaecat quis commodo",
        "mollit deserunt occaecat eiusmod ipsum",
        "ex aliquip irure",
        "eu irure commodo nulla ad",
        "cillum"
      ],
      "segment_ids": [
        "nisi aliqua in",
        "aliqua consectetur ullamco voluptate",
        "qui cupidatat aute aliquip in",
        "sunt do"
      ],
      "custom_fields": {},
      "created_at": "fugiat officia",
      "updated_at": "ut anim in esse elit",
      "_metadata": {
        "self": "aute"
      }
    },
    {
      "id": "id",
      "first_name": "eiusmod",
      "last_name": "et consequat amet Ut",
      "unique_name": "nostrud commodo esse consectetur",
      "email": "mollit ut tempor irure consectetur",
      "alternate_emails": [
        "dolore ea mollit enim velit",
        "amet veniam deserunt mollit consequat",
        "sint ipsum velit sunt",
        "in laboris aliquip aute"
      ],
      "address_line_1": "amet cupidatat",
      "address_line_2": "veniam incididunt aute eu enim",
      "city": "sed consequat Duis minim irure",
      "state_province_region": "dolore officia",
      "country": "mollit dolore ut minim",
      "postal_code": "laboris enim voluptate commodo",
      "phone_number": "amet cupidatat Duis velit",
      "whatsapp": "velit occaecat adipisicing",
      "line": "quis",
      "facebook": "ullamco",
      "list_ids": [
        "ullamco dolore",
        "ut aliqua cillum sunt occaecat",
        "cupidatat et sint"
      ],
      "segment_ids": [
        "commodo Excepteur quis",
        "ipsum dolore",
        "consequat amet",
        "est occaecat sed elit sit"
      ],
      "custom_fields": {},
      "created_at": "incididunt anim dolor et do",
      "updated_at": "cillum ad eu",
      "_metadata": {
        "self": "id quis aute irure"
      }
    },
    {
      "id": "amet adipisicing eiusmod irure",
      "first_name": "laboris Excepteur Lorem",
      "last_name": "est ea",
      "unique_name": "Lorem anim proident aliqua",
      "email": "reprehenderit aute consectetur qui voluptate",
      "alternate_emails": [
        "ex dolor laborum",
        "Ut enim aliqua"
      ],
      "address_line_1": "minim incididunt sint cupidatat",
      "address_line_2": "veniam deserunt",
      "city": "irure ullamco",
      "state_province_region": "pariatur",
      "country": "minim adipisicing ut in",
      "postal_code": "anim enim tempor magna",
      "phone_number": "magna do",
      "whatsapp": "non aliquip laboris nostrud",
      "line": "amet dolor",
      "facebook": "in",
      "list_ids": [
        "Lorem enim fugiat reprehenderit",
        "proident ut elit veniam magna",
        "fugiat mollit deserunt",
        "labore"
      ],
      "segment_ids": [
        "non",
        "do ex nulla Duis consequat"
      ],
      "custom_fields": {},
      "created_at": "sed adipisicing ad",
      "updated_at": "eiusmod ea sunt",
      "_metadata": {
        "self": "est nulla incididunt ullamco"
      }
    },
    {
      "id": "occaecat eu",
      "first_name": "cillum",
      "last_name": "deserunt laborum Excepteur aute ut",
      "unique_name": "culpa occaecat et dolor incididunt",
      "email": "nostrud",
      "alternate_emails": [
        "veniam qui dolor aute magna",
        "sed sint",
        "incididunt voluptate"
      ],
      "address_line_1": "voluptate aliqua aliquip",
      "address_line_2": "id voluptate enim deserunt",
      "city": "esse Ut officia in",
      "state_province_region": "consectetur nostrud adipisicing laborum et",
      "country": "veniam voluptate in deserunt ea",
      "postal_code": "occaecat sed",
      "phone_number": "ea ex",
      "whatsapp": "quis",
      "line": "ex quis Excepteur non ea",
      "facebook": "sunt nostrud labore",
      "list_ids": [
        "ut minim tempor laboris nulla",
        "fugiat",
        "eiusmod"
      ],
      "segment_ids": [
        "eiusmod dolore Excepteur",
        "sit dolore aute proident",
        "est aute ex aliqua",
        "anim laboris eu nostrud"
      ],
      "custom_fields": {},
      "created_at": "aute",
      "updated_at": "ex cillum do esse Lorem",
      "_metadata": {
        "self": "et irure tempor"
      }
    },
    {
      "id": "non do irure sed esse",
      "first_name": "dolore adipisicing",
      "last_name": "ipsum non mollit exercitation officia",
      "unique_name": "elit sunt",
      "email": "Ut nulla pariatur Excepteur occaecat",
      "alternate_emails": [
        "veniam dolore reprehenderit",
        "incididunt aute"
      ],
      "address_line_1": "occaecat dolor Duis anim incididunt",
      "address_line_2": "commodo consectetur aliquip anim",
      "city": "deserunt laborum eu",
      "state_province_region": "sed dolore elit",
      "country": "mollit ut",
      "postal_code": "sunt",
      "phone_number": "id dolor",
      "whatsapp": "ullamco",
      "line": "sint",
      "facebook": "adipisicing Excepteur tempor in",
      "list_ids": [
        "et adipisicing dolor",
        "officia exercitation laboris",
        "velit eiusmod eu",
        "nostrud reprehenderit irure",
        "enim aute ullamco proident consequat"
      ],
      "segment_ids": [
        "nulla id dolore in"
      ],
      "custom_fields": {},
      "created_at": "id occaecat incididunt cillum",
      "updated_at": "sed dolor",
      "_metadata": {
        "self": "ex nulla commodo"
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "amet in"
    },
    {
      "message": "proident aliquip nulla"
    }
  ]
}
Request Payload
{
  "emails": [
    "jane_doe@example.com",
    "john_doe@example.com",
    "joann_doe@example.com"
  ]
}
Response Payload
{
  "result": {
    "jane_doe@example.com": {
      "contact": {
        "address_line_1": "",
        "address_line_2": "",
        "alternate_emails": [
          "janedoe@example1.com"
        ],
        "city": "",
        "country": "",
        "email": "jane_doe@example.com",
        "first_name": "Jane",
        "id": "asdf-Jkl-zxCvBNm",
        "last_name": "Doe",
        "list_ids": [],
        "segment_ids": [],
        "postal_code": "",
        "state_province_region": "",
        "phone_number": "",
        "whatsapp": "",
        "line": "",
        "facebook": "",
        "unique_name": "",
        "custom_fields": {},
        "created_at": "2021-03-02T15:25:47Z",
        "updated_at": "2021-03-30T15:26:16Z",
        "_metadata": {
          "self": "<metadata_url>"
        }
      }
    },
    "john_doe@example.com": {
      "contact": {
        "address_line_1": "",
        "address_line_2": "",
        "alternate_emails": [],
        "city": "",
        "country": "",
        "email": "john_doe@example.com",
        "first_name": "Jane",
        "id": "asdf-Jkl-qWeRTy",
        "last_name": "Doe",
        "list_ids": [],
        "segment_ids": [],
        "postal_code": "",
        "state_province_region": "",
        "phone_number": "",
        "whatsapp": "",
        "line": "",
        "facebook": "",
        "unique_name": "",
        "custom_fields": {},
        "created_at": "2020-01-02T15:25:47Z",
        "updated_at": "2020-12-20T15:26:16Z",
        "_metadata": {
          "self": "<metadata_url>"
        }
      }
    },
    "joann_doe@example.com": {
      "error": "contact not found"
    }
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "occaecat Duis cillum"
    }
  ]
}

Segmenting Contacts V2 - Beta(5 operations)

Request Payload
{
  "name": "non reprehenderit dolor labore enim",
  "parent_list_ids": [
    "aliquip dolore"
  ],
  "query_dsl": "Duis ut velit"
}
Response Payload
{
  "id": "42cd1e50-3d10-4483-56dd-aec67095947f",
  "name": "eiusmod",
  "query_dsl": "aute",
  "contacts_count": -51712071,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "anim enim",
  "updated_at": "dolore consequat",
  "sample_updated_at": "esse pariatur minim non",
  "next_sample_update": "id elit",
  "parent_list_ids": [
    "id incididunt",
    "esse commodo"
  ],
  "query_version": "consequat ut proident non",
  "status": {
    "query_validation": "aute fugiat dolor",
    "error_message": "ea"
  }
}
{
  "errors": [
    {
      "field": "ad ea sed aliquip",
      "message": "ipsum magna in officia"
    },
    {
      "field": "eiusmod dolore eu esse",
      "message": "et"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "laboris",
      "message": "in ipsum ullamco aute"
    },
    {
      "field": "quis qui",
      "message": "est qui ullamco"
    },
    {
      "field": "voluptate do",
      "message": "in"
    },
    {
      "field": "in ipsum",
      "message": "labore mollit aliquip esse"
    }
  ]
}
Query Parameter NameExample
parent_list_idssunt in in
no_parent_list_idfalse
Request Payload
Response Payload
{
  "id": "ef6b9fde-cbae-e83c-955e-27b7721057bd",
  "name": "laborum occaecat culpa velit ut",
  "contacts_count": 72743600,
  "created_at": "nulla laboris",
  "updated_at": "dolore Lorem labore est",
  "sample_updated_at": "amet veniam",
  "next_sample_update": "ipsum",
  "parent_list_ids": [
    "nostrud ut enim voluptate laborum"
  ],
  "query_version": "irure sint Ut nisi",
  "_metadata": {
    "prev": "http://ZBzGjaeyWgIxhVIUcQAahPEN.phsy9nXJ8kD",
    "self": "http://xpZdnCwCpKUZJkdPVgyRkKPisEQdHX.zmlqWJ+EUjn5aUidG62qqlQWjP5JA",
    "next": "https://RKOefTSMBKdnraTKdiPLThJ.xazqZSXeobcclaVvk.Ebe8GRtq3CESm0VcYLZd",
    "count": 88126096
  },
  "status": {
    "query_validation": "proident eiusmod aliquip in consequat",
    "error_message": "eu in amet adipisicing in"
  }
}
{
  "errors": [
    {
      "field": "nostrud reprehenderit officia irure cupidatat",
      "message": "nulla minim nisi culpa"
    },
    {
      "field": "esse",
      "message": "Ut deserunt proident"
    },
    {
      "field": "dolore",
      "message": "velit ut"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "cillum exercitation",
      "message": "eu occaecat"
    },
    {
      "field": "laboris Lorem amet",
      "message": "cupidatat"
    },
    {
      "field": "ut irure dolor officia",
      "message": "sunt Lorem est nisi commodo"
    }
  ]
}
Request Payload
{
  "name": "anim",
  "query_dsl": "exercitation commodo aute Lorem consectetur"
}
Response Payload
{
  "id": "598b29c9-b04d-8e75-f925-0b8832350714",
  "name": "est aute",
  "query_dsl": "Excepteur cillum non exercitation ad",
  "contacts_count": 58249426,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "sint",
  "updated_at": "eu tempor laborum Lorem",
  "sample_updated_at": "in tempor sit Ut Lorem",
  "next_sample_update": "exercitation Ut aliquip",
  "parent_list_ids": [
    "exercitation consequat",
    "veniam aliqua ipsum pariatur eiusmod",
    "occaecat",
    "minim"
  ],
  "query_version": "Duis nulla",
  "status": {
    "query_validation": "eu mollit reprehenderit",
    "error_message": "quis consectetur proident Excepteur consequat"
  }
}
{
  "errors": [
    {
      "field": "et",
      "message": "laboris aliquip consectetur deserunt"
    },
    {
      "field": "qui dolore non ea",
      "message": "proident irure dolor reprehenderit et"
    },
    {
      "field": "dolor",
      "message": "proident reprehenderit occaecat cillum elit"
    },
    {
      "field": "ipsum adipisicing",
      "message": "mollit voluptate"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "esse pariatur velit",
      "message": "exercitation laboris"
    },
    {
      "field": "sit anim magna",
      "message": "fugiat Excepteur deserunt culpa"
    },
    {
      "field": "do aute nulla eu",
      "message": "Duis Ut enim exercitation"
    },
    {
      "field": "nostrud incididunt dolore consectetur in",
      "message": "dolore"
    }
  ]
}
Query Parameter NameExample
contacts_sampletrue
Request Payload
Response Payload
{
  "id": "b534c3d4-21aa-aa34-fa5c-8bb29baf5ef4",
  "name": "in",
  "query_dsl": "labore",
  "contacts_count": -50867541,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "Duis ex",
  "updated_at": "ad Duis",
  "sample_updated_at": "amet magna dolore",
  "next_sample_update": "sint dolore irure labore",
  "parent_list_ids": [
    "nostrud"
  ],
  "query_version": "est consequat",
  "status": {
    "query_validation": "sint nulla",
    "error_message": "non cupidatat"
  }
}
{
  "errors": [
    {
      "field": "sunt anim et",
      "message": "do"
    }
  ]
}
{
  "errors": [
    {
      "field": "veniam",
      "message": "reprehenderit proident ex consectetur in"
    },
    {
      "field": "ipsum laborum irure enim qui",
      "message": "pariatur non ut"
    },
    {
      "field": "reprehenderit",
      "message": "commodo"
    },
    {
      "field": "nisi laborum proident ut",
      "message": "ipsum in ea Excepteur"
    },
    {
      "field": "dolor commodo in",
      "message": "aliqua est"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "officia",
      "message": "ea ullamco commodo"
    },
    {
      "field": "exercitation quis in do",
      "message": "nisi velit amet esse elit"
    },
    {
      "field": "incididunt id",
      "message": "ex"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "sint eiusmod labore",
      "message": "Duis enim ullamco occaecat amet"
    },
    {
      "field": "Ut voluptate",
      "message": "quis"
    },
    {
      "field": "labore ipsum",
      "message": "aute aliquip cillum ea"
    },
    {
      "field": "velit mollit magna nulla",
      "message": "dolore consequat"
    },
    {
      "field": "labore ea",
      "message": "in"
    }
  ]
}

Senders

Header NameExample
on-behalf-of"irure"
Request Payload
{
  "nickname": "Example Orders",
  "from": {
    "email": "orders@example.com",
    "name": "Example Orders"
  },
  "reply_to": {
    "email": "support@example.com",
    "name": "Example Support"
  },
  "address": "1234 Fake St.",
  "address_2": "",
  "city": "San Francisco",
  "state": "CA",
  "zip": "94105",
  "country": "United States"
}
Response Payload
{
  "id": 1,
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States",
  "verified": true,
  "updated_at": 1449872165,
  "created_at": 1449872165,
  "locked": false
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "mollit officia non fugiat"
    }
  ]
}

Lists(7 operations)

Request Payload
{
  "name": "list-name"
}
Response Payload
{
  "id": "ca7a3796-e8a8-4029-9ccb-df8937940562",
  "name": "list-name",
  "contact_count": 0,
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/lists/ca7a3796-e8a8-4029-9ccb-df8937940562"
  }
}
{
  "errors": [
    {
      "message": "veniam pariatur cupidatat consectetur",
      "field": "dolor dolor Excepteur ut esse",
      "error_id": "sunt enim",
      "parameter": "ipsum in nostrud cupidatat laboris"
    },
    {
      "message": "commodo occaecat eu deserunt incididunt",
      "field": "dolor",
      "error_id": "sit commodo veniam cillum officia",
      "parameter": "anim"
    },
    {
      "message": "laborum velit ex elit in",
      "field": "laborum ea in",
      "error_id": "ea exercitation anim",
      "parameter": "id amet sunt"
    }
  ]
}
Query Parameter NameExample
page_size431.70260829958096
page_tokennulla qui aliquip consectetur aute
Request Payload
Response Payload
{
  "result": [
    {
      "id": "abc12312-x3y4-1234-abcd-123qwe456rty",
      "name": "list-name",
      "contact_count": 0,
      "_metadata": {
        "self": "https://api.sendgrid.com/v3/marketing/lists/abc12312-x3y4-1234-abcd-123qwe456rty"
      }
    }
  ],
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/lists?page_size=100&page_token="
  }
}
Request Payload
Response Payload
{
  "contact_count": 0,
  "billable_count:": 0
}
{}
Query Parameter NameExample
contact_samplefalse
Request Payload
Response Payload
{
  "contact_count": 2,
  "contact_sample": {
    "id": "c3445f88-5c69-4237-86e6-9ec9de958050",
    "list_ids": [
      "199abb98-0af3-4a8d-b371-6811ff85d062"
    ],
    "created_at": "2620-06-16T17:03:54.867Z",
    "updated_at": "4780-12-06T06:51:30.024Z"
  },
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/lists/199abb98-0af3-4a8d-b371-6811ff85d062"
  },
  "id": "199abb98-0af3-4a8d-b371-6811ff85d062",
  "name": "list-name"
}
[
  {
    "message": "commodo enim anim adipisicing",
    "field": "sint mollit ad",
    "error_id": "cillum nulla ea eiusmod nostrud",
    "parameter": "est ut Duis irure sint"
  }
]
Request Payload
{
  "name": "updated-list-name"
}
Response Payload
{
  "id": "abc12312-x3y4-1234-abcd-123qwe456rty",
  "name": "updated-list-name",
  "contact_count": 0,
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/lists/abc12312-x3y4-1234-abcd-123qwe456rty"
  }
}
{
  "errors": [
    {
      "message": "in adipisicing",
      "field": "mollit cupidatat elit incididunt",
      "error_id": "ea voluptate",
      "parameter": "dolore officia Duis nisi Ut"
    }
  ]
}
{}
Query Parameter NameExample
delete_contactsfalse
Request Payload
Response Payload
{
  "job_id": "abc12312-x3y4-1234-abcd-123qwe456rty"
}
ex elit minim consectetur
{
  "errors": []
}
Query Parameter NameExample
contact_ids*ex laboris
Request Payload
Response Payload
{
  "job_id": "nulla reprehenderit velit"
}
{
  "message": "eiusmod",
  "field": "mollit voluptate",
  "error_id": "velit",
  "parameter": "proident"
}
{
  "description": "If the specified list id does not exist. If the specified contact does not exist."
}

Custom Fields(4 operations)

Request Payload
{
  "name": "custom_field_name",
  "field_type": "Text"
}
Response Payload
{
  "id": "a1_T",
  "name": "custom_field_name",
  "field_type": "Text",
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/field_definitions/a1_B"
  }
}
{
  "errors": [
    {
      "message": "elit laborum sunt",
      "field": "dolore minim voluptate in culpa",
      "error_id": "quis cupidatat aute sed commodo",
      "parameter": "Lorem anim ex"
    },
    {
      "message": "ipsum et",
      "field": "Ut in irure consectetur",
      "error_id": "reprehenderit deserunt",
      "parameter": "fugiat reprehenderit"
    },
    {
      "message": "ex sit laborum fugiat occaecat",
      "field": "consequat sint in",
      "error_id": "aute tempor ut",
      "parameter": "cillum nostrud adipisicing"
    }
  ]
}
Request Payload
Response Payload
{
  "custom_fields": [
    {
      "id": "w1",
      "name": "num_orders",
      "field_type": "Number"
    },
    {
      "id": "w2",
      "name": "dob",
      "field_type": "Date"
    }
  ],
  "reserved_fields": [
    {
      "id": "_rf0_T",
      "name": "first_name",
      "field_type": "Text"
    },
    {
      "id": "_rf1_T",
      "name": "last_name",
      "field_type": "Text"
    },
    {
      "id": "_rf2_T",
      "name": "email",
      "field_type": "Text"
    },
    {
      "id": "_rf3_T",
      "name": "alternate_emails",
      "field_type": "Text"
    },
    {
      "id": "_rf4_T",
      "name": "address_line_1",
      "field_type": "Text"
    },
    {
      "id": "_rf5_T",
      "name": "address_line_2",
      "field_type": "Text"
    },
    {
      "id": "_rf6_T",
      "name": "city",
      "field_type": "Text"
    },
    {
      "id": "_rf7_T",
      "name": "state_province_region",
      "field_type": "Text"
    },
    {
      "id": "_rf8_T",
      "name": "postal_code",
      "field_type": "Text"
    },
    {
      "id": "_rf9_T",
      "name": "country",
      "field_type": "Text"
    },
    {
      "id": "_rf10_T",
      "name": "phone_number",
      "field_type": "Text"
    },
    {
      "id": "_rf11_T",
      "name": "whatsapp",
      "field_type": "Text"
    },
    {
      "id": "_rf12_T",
      "name": "line",
      "field_type": "Text"
    },
    {
      "id": "_rf13_T",
      "name": "facebook",
      "field_type": "Text"
    },
    {
      "id": "_rf14_T",
      "name": "unique_name",
      "field_type": "Text"
    },
    {
      "id": "_rf15_T",
      "name": "email_domains",
      "field_type": "Text",
      "read_only": true
    },
    {
      "id": "_rf16_D",
      "name": "last_clicked",
      "field_type": "Date",
      "read_only": true
    },
    {
      "id": "_rf17_D",
      "name": "last_opened",
      "field_type": "Date",
      "read_only": true
    },
    {
      "id": "_rf18_D",
      "name": "last_emailed",
      "field_type": "Date",
      "read_only": true
    },
    {
      "id": "_rf19_T",
      "name": "singlesend_id",
      "field_type": "Text",
      "read_only": true
    },
    {
      "id": "_rf20_T",
      "name": "automation_id",
      "field_type": "Text",
      "read_only": true
    },
    {
      "id": "_rf21_D",
      "name": "created_at",
      "field_type": "Date",
      "read_only": true
    },
    {
      "id": "_rf22_D",
      "name": "updated_at",
      "field_type": "Date",
      "read_only": true
    },
    {
      "id": "_rf23_T",
      "name": "contact_id",
      "field_type": "Text",
      "read_only": true
    }
  ],
  "_metadata": {
    "self": "https://example.com/marketing/field_definitions"
  }
}
Request Payload
{
  "name": "new_custom_field_name"
}
Response Payload
{
  "id": "a1_T",
  "name": "custom_field_name",
  "field_type": "Text",
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/field_definitions/a1_B"
  }
}
{
  "errors": [
    {
      "message": "exercitation",
      "field": "Lorem pariatur occaecat",
      "error_id": "reprehenderit dolore",
      "parameter": "elit"
    }
  ]
}
{
  "errors": [
    {
      "message": "laborum non sint voluptate fugiat",
      "field": "ullamco ex esse enim",
      "error_id": "fugiat enim",
      "parameter": "laborum sed Duis ut"
    },
    {
      "message": "sint laboris ad do incididunt",
      "field": "veniam proident",
      "error_id": "elit",
      "parameter": "ad cillum"
    },
    {
      "message": "mollit",
      "field": "proident aliqua Excepteur dolore",
      "error_id": "id veniam",
      "parameter": "aliqua"
    },
    {
      "message": "ea Ut nisi irure do",
      "field": "consequat in culpa",
      "error_id": "ad",
      "parameter": "dolor veniam cupidatat nostrud pariatur"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "eiusmod in dolore ut",
      "field": "tempor non et",
      "error_id": "ut labore tempor",
      "parameter": "velit occaecat Excepteur tempor sint"
    },
    {
      "message": "incididunt in adipisicing est",
      "field": "ullamco Duis dolor ipsum occaecat",
      "error_id": "nulla",
      "parameter": "consectetur esse"
    },
    {
      "message": "dolor minim et",
      "field": "enim minim velit labore occaecat",
      "error_id": "exercitation incididunt ut eu cupidatat",
      "parameter": "elit velit commodo eu"
    }
  ]
}

segmenting contacts(5 operations)

Request Payload
{
  "name": "deserunt eu Ut",
  "parent_list_ids": [
    "irure sint consequat",
    "cupidatat qui quis eu sit",
    "non culpa minim"
  ],
  "query_dsl": "ad irure velit in amet",
  "parent_list_id": "9eb70894-e7e7-f28a-dc35-1c07fc57f763"
}
Response Payload
{
  "id": "864feb2e-5e93-47bf-b63e-21746c988105",
  "contacts_count": 0,
  "created_at": "mollit labore aute deserunt ad",
  "sample_updated_at": "enim culpa in",
  "updated_at": "minim",
  "contact_summary": {
    "contact_id": "1a541ca7-9fef-42c8-8947-f3f8a3b33ffe",
    "primary_email": "D8OsYF5ok@YtX.kcg",
    "first_name": "exercitation Duis nisi",
    "last_name": "aut",
    "address_line_1": "ut sunt Duis eu",
    "address_line_2": "in culpa esse non",
    "city": "ÔXƫɋƄř",
    "state_province_region": "consequat culpa in",
    "postal_code": -88086402,
    "country": "eiusmod",
    "custom_fields": {
      "custom_field_name2": "dolore cillum",
      "custom_field_name1": "est mollit officia adipisicing dolo"
    },
    "list_ids": [
      "c856a255-12f1-4b55-8564-218fd7eb34a7",
      "130c8813-0d6f-4b9e-b154-736bb9db2ff8",
      "c245021d-4444-4086-a498-3ffee7fa8cdf"
    ]
  },
  "name": "aute amet deserunt adipisicing",
  "query_dsl": "email LIKE %twilio.com",
  "next_sample_update": "culpa sit occaecat fugiat quis"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "sed ipsum aute tempor"
    },
    {
      "message": "ut eiusmod proident voluptate mollit"
    },
    {
      "message": "quis ex ea est"
    },
    {
      "message": "cillum proident pariatur consequat"
    }
  ]
}
Query Parameter NameExample
parent_list_idselit ex tempor dolor
no_parent_list_idfalse
Request Payload
Response Payload
{
  "results": [
    {
      "id": "12099613-91e5-4d09-a900-df7626325288",
      "contacts_count": 78434802,
      "created_at": "2921-01-27T19:33:36.479Z",
      "sample_updated_at": "4685-11-26T07:05:04.660Z",
      "updated_at": "2883-07-10T13:13:37.697Z"
    },
    {
      "id": "60c37015-3734-4c8e-b293-68cfa2ae4fa5",
      "contacts_count": 34177253,
      "created_at": "2575-07-26T23:17:20.984Z",
      "sample_updated_at": "3074-09-04T09:49:58.127Z",
      "updated_at": "5116-10-15T07:37:40.838Z",
      "parent_list_id": "fd38af3d-3f69-4947-8dca-5fa967e7be82",
      "name": "amet"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "esse"
    },
    {
      "message": "laborum eiusmod ex dolor"
    }
  ]
}
Query Parameter NameExample
query_jsonfalse
Request Payload
Response Payload
{
  "id": "3b049926-0a54-4a91-83f0-086ace63c530",
  "contacts_count": -83213117,
  "created_at": "voluptate sunt non fugiat",
  "sample_updated_at": "labore occaecat sunt enim",
  "updated_at": "sunt aliqui",
  "contacts_sample": [
    {
      "contact_id": "e70eac25-1431-4231-bccd-1cfab432301e",
      "primary_email": "KLTF@SurgGzlAxCPOqhOUHYNBLsfpfE.trh",
      "alternate_emails": [
        "dTeJZgU5uN9UYSo@nfIB.ijxg"
      ],
      "first_name": "ullamco esse culpa do",
      "last_name": "officia laboris veniam consequat",
      "address_line_1": "in occaecat labore est tempor",
      "address_line_2": "magna adipisicing",
      "city": "ƞó",
      "state_province_region": "culpa ut",
      "postal_code": -75218567,
      "country": "voluptate in in reprehenderit aliquip",
      "custom_fields": {
        "custom_field_name1": "amet deserunt mollit",
        "custom_field_name2": "minim consequat id"
      }
    },
    {
      "contact_id": "db637d33-bce1-462c-ae9c-91ec4f761de6",
      "primary_email": "t7N5TjDmKhC0@gfdifW.ua",
      "alternate_emails": [
        "gQol@Xcfilli.hc",
        "n4K7OdaVQh@YfsnF.ie",
        "TdnvS3nMStREn@miFjGzNDCPZWhiswJNxrFnOYdUAZEpesQ.yxpu",
        "xRzGDTTzzbYK@eJ.wpgb",
        "iI1rOpx2ct@aZhuYGZBxJLZ.phr"
      ],
      "first_name": "ea et eu",
      "last_name": "velit Ut laborum ipsu",
      "address_line_1": "labore",
      "address_line_2": "non",
      "city": "ĔȸąŸÂ¸ȠɏbɄ",
      "state_province_region": "deserunt dolore",
      "postal_code": -95171713,
      "country": "do",
      "list_ids": [
        "c712288b-2300-4069-bef4-2e05b5948ec3",
        "9003ef29-5eb7-4951-898b-1b102e490d6e"
      ]
    }
  ],
  "name": "enim et anim",
  "query_dsl": "nostrud"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "sint id eiusmod adipisicing",
      "field": "dolor"
    },
    {
      "message": "aute laborum dolor",
      "field": "culpa dolor nostrud ullamco"
    }
  ]
}
{
  "errors": [
    {
      "message": "exercitation sed"
    },
    {
      "message": "dolore dolor"
    },
    {
      "message": "ex laboris irure"
    },
    {
      "message": "sed adipisicing"
    },
    {
      "message": "laboris anim"
    }
  ]
}
Request Payload
{
  "name": "deseru",
  "parent_list_ids": [
    "ut id enim ad aliquip",
    "voluptate",
    "officia",
    "sint in Ut officia"
  ],
  "query_dsl": "Duis"
}
Response Payload
{
  "id": "5fff6250-b766-4959-a183-2e1fa565c4ce",
  "contacts_count": -35493018,
  "created_at": "2014-12-23T17:18:52.907Z",
  "sample_updated_at": "2146-04-13T16:46:32.328Z",
  "updated_at": "4389-06-21T16:59:51.403Z",
  "contacts_sample": [
    {
      "contact_id": "4cff9fdf-1bee-44f7-95dc-a101f9ed3cfe",
      "primary_email": "exmS@KIzibBSmaUUHQa.uvv",
      "alternate_emails": [
        "qXP-RD97fLl@oEDaUynqnNRHJHdoJAWVGXwvI.qlv",
        "W0ngFWmR@WcQuSbPFVPZvLrjCFadfimFi.eqf",
        "mYBC0ea5UxFI@qwO.jh",
        "Nhf1OmY@KCSjTQsXYpbKrBUsQFHrnLuY.oef"
      ],
      "first_name": "consequat nulla in",
      "last_name": "irure nostrud elit eu",
      "address_line_1": "deserunt cillum aliqua nostrud ullamco",
      "address_line_2": "sint",
      "city": "ŷ(ç",
      "state_province_region": "minim",
      "postal_code": 62721676,
      "country": "consectetur quis voluptate",
      "list_ids": [
        "f9d5987d-7a01-4a66-b77e-1f08a392304b",
        "b4e3b028-01d4-428b-9ef5-24bcd90fa02c",
        "fedab84f-9aa5-449d-99e2-7b1361f8ee61"
      ]
    },
    {
      "contact_id": "093a66b8-bca8-4d8a-b32a-091d939c1928",
      "primary_email": "atNeYGC4nbF42@VOCUWuGaYr.ystm",
      "alternate_emails": [
        "Zs6vnQbMU@XTamDsXEGJWBMMEacOc.hitv",
        "Epl@ySBrQCFJZnjggkAYLu.ppta"
      ],
      "first_name": "est",
      "last_name": "in",
      "address_line_1": "culpa eu eiusmod sint",
      "address_line_2": "sed velit sint",
      "city": "BĊJ",
      "state_province_region": "Lorem Ut aliqua elit",
      "postal_code": 33736880,
      "country": "in laboris Excepteur consequat",
      "custom_fields": {
        "custom_field_name2": "culpa Excepteur",
        "custom_field_name1": "esse magna Ut"
      }
    },
    {
      "contact_id": "08939f9c-2c87-4639-bd07-16d41f90a5eb",
      "primary_email": "Jx660QHClqRrC@SavQvcdRpJlLqepwoEUCm.ar",
      "alternate_emails": [
        "S8u@ZVGjHsXdSWtlhhad.ximc",
        "GA1MN72v3uA@MPDvMUmTYjwFCsEaGnFnvVzJVqUTl.ehws"
      ],
      "first_name": "sed eu veli",
      "last_name": "aliqua sit culpa",
      "address_line_1": "occaecat aute enim",
      "address_line_2": "ipsum quis in",
      "city": "ɌſĕĝȤ¶Ǖ",
      "state_province_region": "ut nisi sed esse",
      "postal_code": -66445052,
      "country": "occaecat veniam"
    },
    {
      "contact_id": "0667ed97-7b7b-44aa-a115-0301067660d7",
      "primary_email": "AnoFtJq@IolRDmfj.njt",
      "alternate_emails": [
        "F5WhHCA3oL6Ix@wOKzwIsvHbFi.mrlc"
      ],
      "first_name": "do mollit velit",
      "last_name": "voluptate dolor",
      "address_line_1": "et incididunt",
      "address_line_2": "veniam quis non exercitation Duis",
      "city": "DzƐȹŲdž",
      "state_province_region": "occaecat",
      "postal_code": -19694583,
      "country": "reprehenderit",
      "custom_fields": {
        "custom_field_name1": "dolor aute irure Excepteur"
      },
      "list_ids": [
        "ffd225a8-2008-4457-87af-1cffff5b1ccb"
      ]
    },
    {
      "contact_id": "449767ca-d446-45f1-aa9b-432f441b5ca1",
      "primary_email": "kF4@gYYdAxzetJrWszLAHuBUTu.rzq",
      "alternate_emails": [
        "ksqbx6BInlB@ouWBjjxwFBwVQjdnEKXy.xi",
        "TAe7F2m8dFlF@SirYykzbe.aj",
        "T9c2Y@HjVQY.zz",
        "p7ShfET@vMMnTUqoqngPSEqbpyoeWN.jlqn",
        "0VJSIhIUT2k@mJXVtdZVKKswW.xoca"
      ],
      "first_name": "irure laboris minim",
      "last_name": "id nostrud aliqua sit",
      "address_line_1": "dolor",
      "address_line_2": "elit ex labore sunt aliquip",
      "city": "ÝǘźƝǝƉ‘Ɲ",
      "state_province_region": "nostrud Duis non nulla laborum",
      "postal_code": 60466925,
      "country": "id sunt nisi",
      "custom_fields": {
        "custom_field_name2": "enim quis",
        "custom_field_name1": "amet"
      },
      "list_ids": [
        "2870627c-b9ea-4dcf-bde0-36c3e0e3eca9",
        "575d86aa-4dcc-4b7d-b7de-ded856913198",
        "fb82a17f-5777-439d-9b8c-2c565c8ddf20"
      ]
    }
  ],
  "name": "List Name",
  "query_dsl": "Email LIKE %twilio.com"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ea eu exercitation",
      "field": "ullamco dolore anim dolor"
    },
    {
      "message": "officia fugiat veniam do",
      "field": "do aliqua"
    },
    {
      "message": "id",
      "field": "labore incididunt do Lorem"
    }
  ]
}
{
  "errors": [
    {
      "message": "est dolor proident"
    },
    {
      "message": "Duis Lorem culpa aute nisi"
    },
    {
      "message": "incididunt cillum"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "aliqua sint",
      "field": "do pariatur ad in"
    },
    {
      "message": "eiusmod aliqua aliquip ipsum exercitation",
      "field": "est"
    },
    {
      "message": "eiusmod",
      "field": "et"
    }
  ]
}
{
  "errors": [
    {
      "message": "deserunt proident"
    },
    {
      "message": "Excepteur nulla Ut sit in"
    }
  ]
}

Segmenting Contacts

Request Payload
{
  "ids": [
    "a14dcc63-d651-4c57-9826-4a3705f5c78d",
    "f3de551e-dc5c-4d42-bd08-c7f87f87f0e8",
    "1b8107b5-adf4-401c-8865-fa84ba178fb9",
    "d7900715-c904-4728-acff-9ab79627579e",
    "16641f5b-cfa3-41b9-9626-244488ee85b1"
  ]
}
Response Payload
{
  "errors": [
    {
      "id": "minim Excepteur in",
      "error": "consequat",
      "resources": {
        "type": "incididunt",
        "ids": [
          "cupidatat",
          "irure Duis in cupidatat ea"
        ]
      }
    },
    {
      "id": "proident aliquip dolore non in",
      "error": "minim reprehenderit anim",
      "resources": {
        "type": "aliquip deserunt ullamco dolor",
        "ids": [
          "dolore veniam exercitation reprehenderit",
          "commodo cillum",
          "enim sed culpa"
        ]
      }
    },
    {
      "id": "pariatur enim",
      "error": "proident",
      "resources": {
        "type": "ut laborum anim ea",
        "ids": [
          "Duis quis in dolor velit",
          "proident consequat anim in ipsum",
          "anim reprehenderit do in dolor"
        ]
      }
    },
    {
      "id": "ea",
      "error": "Lorem est cillum dolore ea",
      "resources": {
        "type": "occaecat sed fugiat",
        "ids": [
          "in fugiat eu",
          "Lorem non labore",
          "velit consequat"
        ]
      }
    }
  ]
}
{}
{
  "errors": [
    {
      "field": "dolore fugiat",
      "message": "aliquip sed labore eu"
    },
    {
      "field": "dolore ut reprehenderit commodo",
      "message": "et"
    },
    {
      "field": "adipisicing et",
      "message": "sint"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "est et reprehenderit sit aliqua"
    },
    {
      "message": "enim nisi"
    },
    {
      "message": "exercitation"
    }
  ]
}

Single Sends(11 operations)

Request Payload
{
  "name": "Example API Created Single Send",
  "categories": [
    "unique opens"
  ],
  "send_to": {
    "all": true
  },
  "email_config": {
    "design_id": "<your-design-id>",
    "editor": "design",
    "suppression_group_id": 12345,
    "sender_id": 1234567
  }
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "field": "tempor nostrud est",
      "message": "mollit qui in",
      "error_id": "ut deserunt officia commodo"
    },
    {
      "field": "ut ut velit fugiat proident",
      "message": "tempor",
      "error_id": "sunt cillum fugiat qui"
    },
    {
      "field": "incididunt",
      "message": "esse fugiat",
      "error_id": "Excepteur incididunt et"
    }
  ]
}
{
  "errors": [
    {
      "field": "enim",
      "message": "est pariatur nisi esse sed",
      "error_id": "Lorem enim aute fugiat amet"
    },
    {
      "field": "qui consequat minim",
      "message": "id sint ut sed",
      "error_id": "est ullamco adipisicing magna"
    },
    {
      "field": "eu in ex labore non",
      "message": "commodo",
      "error_id": "Ut enim"
    },
    {
      "field": "officia deserunt",
      "message": "Ut in culpa",
      "error_id": "pariatur minim dolor qui"
    }
  ]
}
Query Parameter NameExample
page_size40682004
page_tokentempor et dolor mollit sunt
Request Payload
Response Payload
{
  "result": [
    {
      "id": "2879e607-980d-cc7f-4322-897e2138391c",
      "name": "velit nostrud esse in eiusmod",
      "abtest": {
        "type": "subject",
        "winner_criteria": "manual",
        "test_percentage": -68399983,
        "duration": "nisi",
        "winning_template_id": "aute laboris dolore",
        "winner_selected_at": "dolore",
        "expiration_date": "nulla"
      },
      "status": "triggered",
      "categories": [
        "eiusmod ex Excepteur",
        "exercitation culpa nisi do",
        "irure eu in proident",
        "aliquip officia exercitation ea in",
        "Lorem sint culpa aliquip",
        "dolor ut aliqua amet",
        "amet tempor ea anim",
        "fugiat consectetur Lorem laboris do",
        "do officia ipsum Excepteur",
        "voluptate cupidatat adipisicing"
      ],
      "send_at": "1921-09-08T01:01:17.0Z",
      "is_abtest": false,
      "updated_at": "1966-09-05T05:06:25.0Z",
      "created_at": "1942-11-30T22:43:59.0Z"
    },
    {
      "id": "f9d25a28-e4ce-a213-9366-75a61bae465b",
      "name": "consequat enim",
      "abtest": {
        "type": "content",
        "winner_criteria": "open",
        "test_percentage": 8361251,
        "duration": "cupidatat",
        "winning_template_id": "tempor eiusmod ut",
        "winner_selected_at": "magna quis ut",
        "expiration_date": null
      },
      "status": "triggered",
      "categories": [
        "nisi in elit",
        "reprehenderit",
        "nostrud est exercitation labore",
        "nisi",
        "aute",
        "amet exercitation ut",
        "commodo Duis",
        "incididunt laboris",
        "Ut adipisicing",
        "Excepteur nisi"
      ],
      "send_at": "1958-04-14T08:39:47.0Z",
      "is_abtest": false,
      "updated_at": "1936-05-22T16:53:30.0Z",
      "created_at": "1899-10-27T04:30:22.0Z"
    },
    {
      "id": "fbdd38d3-bb08-9db5-7827-307ae600cb68",
      "name": "commodo laboris eu ad",
      "abtest": null,
      "status": "scheduled",
      "categories": [
        "ad dolor in non Duis",
        "laborum ullamco eu",
        "Duis Excepteur veniam",
        "et in adipisicing",
        "dolore consectetur laboris ullamco sint",
        "nulla cupidatat enim",
        "consectetur officia",
        "Lorem",
        "sunt proident",
        "adipisicing eu dolore deserunt ullamco"
      ],
      "send_at": "1922-03-06T03:56:42.0Z",
      "is_abtest": true,
      "updated_at": "1969-12-04T04:37:52.0Z",
      "created_at": "1894-08-08T01:02:16.0Z"
    },
    {
      "id": "6b159d41-9128-61bd-61aa-121393072c98",
      "name": "officia fugiat Excepteur et",
      "abtest": null,
      "status": "triggered",
      "categories": [
        "sint in",
        "tempor",
        "sint reprehenderit Ut cupidatat officia",
        "in",
        "enim",
        "ex dolore in sit",
        "quis consectetur ipsum",
        "adipisicing dolor proident dolore do",
        "non aliquip sunt occaecat in",
        "nulla"
      ],
      "send_at": "1961-04-01T02:11:30.0Z",
      "is_abtest": false,
      "updated_at": "1896-03-20T14:38:20.0Z",
      "created_at": "1921-10-16T19:37:20.0Z"
    },
    {
      "id": "2e2df11c-452e-3c4d-485b-9722cd817398",
      "name": "amet",
      "abtest": {
        "type": "subject",
        "winner_criteria": "open",
        "test_percentage": 36546931,
        "duration": "officia voluptate pariatur cillum",
        "winning_template_id": "laboris dolor sit elit Lorem",
        "winner_selected_at": "dolor cillum",
        "expiration_date": null
      },
      "status": "draft",
      "categories": [
        "nostrud cillum laboris dolor et",
        "aliquip nisi anim",
        "dolore laborum sed Duis irure",
        "dolore",
        "officia tempor Ut ad",
        "exercitation dolor incididunt anim",
        "culpa qui nostrud Duis ut",
        "dolore consectetur laborum sunt",
        "cupidatat veniam Excepteur aute",
        "in tempor"
      ],
      "send_at": "1930-01-14T10:32:56.0Z",
      "is_abtest": true,
      "updated_at": "1904-05-23T03:22:08.0Z",
      "created_at": "1930-06-12T08:34:25.0Z"
    }
  ],
  "_metadata": {
    "prev": "https://BuKVTk.ywkyNM1uwAvlNsh.1go1-67vA",
    "self": "https://CtyIetWomSMzaVGeWWOaFnYIRUk.lzKQBVp2ACnxP3QnzcmpeNrB-Z7pcIfutCQ",
    "next": "http://nmoTprkXM.fvcmNq-T,sj",
    "count": 1160833
  }
}
{
  "errors": [
    {
      "field": "consectetur voluptate",
      "message": "eiusmod occaecat",
      "error_id": "deserunt in ut minim aliquip"
    },
    {
      "field": "exercitation qui",
      "message": "proident",
      "error_id": "in labore"
    }
  ]
}
Query Parameter NameExample
ids["minim","consequat cillum laborum minim veniam","fugiat in dolor","ut pariatur dolore","ut Excepteur exercitation consequat anim","laborum sed aliquip cillum ex","veniam cillum","nulla sunt","minim sit quis","ad dolor dolore dolore dolor"]
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "velit culpa dolore",
      "message": "occaecat velit minim",
      "error_id": "ut in"
    },
    {
      "field": "pariatur Ut ipsum ut",
      "message": "Excepteur amet irure",
      "error_id": "nulla laborum"
    }
  ]
}
{
  "errors": [
    {
      "field": "in ullamco nostrud",
      "message": "in dolor sunt non",
      "error_id": "cupidatat aliquip officia esse"
    },
    {
      "field": "do ea adipisicing Excepteur",
      "message": "sunt ea",
      "error_id": "eu enim"
    },
    {
      "field": "velit sint",
      "message": "laboris",
      "error_id": "sint aliqua velit incididunt laborum"
    }
  ]
}
Request Payload
{
  "name": "culpa ipsum"
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "field": "fugiat amet sit",
      "message": "reprehenderit dolore incididunt",
      "error_id": "quis"
    },
    {
      "field": "eiusmod",
      "message": "adipisicing occaecat",
      "error_id": "labore cupidatat id laborum nisi"
    },
    {
      "field": "aliqua mollit sit labore Lorem",
      "message": "adipisicing est nulla aliquip",
      "error_id": "laboris"
    }
  ]
}
{
  "errors": [
    {
      "field": "ullamco dolore",
      "message": "in incididunt est",
      "error_id": "irure ea"
    },
    {
      "field": "amet Ut dolore",
      "message": "laborum",
      "error_id": "qui ipsum dolore eiusmod"
    },
    {
      "field": "cillum sed quis irure deserunt",
      "message": "ut qui in commodo",
      "error_id": "qui sint in"
    },
    {
      "field": "consequat culpa",
      "message": "ut",
      "error_id": "incididunt fugiat sint Lorem minim"
    }
  ]
}
Request Payload
{
  "name": "ipsum elit Excepteur",
  "categories": [
    "reprehenderit minim anim dolore voluptate",
    "ea sint nulla deserunt",
    "reprehenderit est nulla cillum et",
    "aliquip est",
    "ut cupidatat",
    "amet adipisicing Ut",
    "dolore elit non consequat",
    "ut velit",
    "dolor aliquip magna",
    "velit exercitation esse amet Lorem"
  ],
  "send_at": "1893-02-08T01:25:52.0Z",
  "send_to": {
    "list_ids": [
      "e1b1acd7-9e1d-180e-7c9f-b5cde248cf74",
      "0b2b7d72-d28f-b923-4cd5-797d7ac67f37",
      "4780b108-88a8-8f3c-7da1-e1200dc60c79",
      "2b64a9ec-64b1-886c-3cb2-88ab07a66c5c",
      "0211ef79-ce4d-b88a-64c9-8ea3b9d43cac",
      "639456ef-cf38-e4f2-b0c2-0763f9deb1bf",
      "4b52af0e-fe22-5a9e-af1f-483d480344f1",
      "b8c0fdd8-f36c-02ba-9593-ea37bd7075f2",
      "3c61647d-ffba-adae-aab8-8bfb61431cac",
      "b8821db9-a310-04fd-7e2c-59d08eed14b7"
    ],
    "segment_ids": [
      "1401856d-7af6-8267-a541-32433ac97893",
      "9d806248-335a-3b7e-0bed-4518760d8997",
      "9de8d2c3-a230-89df-bc2c-222bf53a7b4d",
      "b01494b4-3919-807c-6f87-b751cee33210",
      "19f098a4-59e0-085a-3b92-9bcd0f72ec66",
      "8d1ff358-e181-b6dd-bc12-0f6a349373fe",
      "512b276b-1b16-8c14-600c-2dcfff370cc0",
      "0573e0a8-e74a-250f-49b3-7a65245304e0",
      "4fe5a50c-97a2-f6ff-8b05-e36798d1a460",
      "e1405a85-3dd5-e346-3afd-d78d692fc7ea"
    ],
    "all": false
  },
  "email_config": {
    "subject": "fugiat ex aliquip sed ipsum",
    "html_content": "mollit dolore cillum pariatur tempor",
    "plain_content": "commodo",
    "generate_plain_content": false,
    "design_id": "proident minim",
    "editor": "code",
    "suppression_group_id": -48613447,
    "custom_unsubscribe_url": "https://km.nvmaK",
    "sender_id": -91316160,
    "ip_pool": null
  }
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "field": "sed in ipsum",
      "message": "sed ex sunt irure",
      "error_id": "eiusmod exercitation in magna"
    },
    {
      "field": "adipisicing eiusmod nisi do",
      "message": "magna",
      "error_id": "laboris"
    },
    {
      "field": "dolor dolor mollit",
      "message": "nostrud dolore dolore",
      "error_id": "ad deserunt velit"
    },
    {
      "field": "ex laboris et ipsum",
      "message": "eu",
      "error_id": "sed anim dolore"
    }
  ]
}
{
  "errors": [
    {
      "field": "in est dolore",
      "message": "cillum amet quis exercitation in",
      "error_id": "do Lorem ut"
    },
    {
      "field": "reprehenderit enim magna",
      "message": "Ut",
      "error_id": "aliqua irure enim"
    },
    {
      "field": "cillum Excepteur consectetur",
      "message": "cillum",
      "error_id": "do"
    },
    {
      "field": "consequat adipisicing",
      "message": "enim id in",
      "error_id": "dolore eu Excepteur nisi"
    }
  ]
}
{
  "errors": [
    {
      "field": "reprehenderit sed voluptate",
      "message": "nisi ad elit ex laborum",
      "error_id": "Ut adipisicing voluptate dolore eu"
    }
  ]
}
Request Payload
Response Payload
{
  "name": "single-send-1",
  "id": "2f6dec81-43b9-4c67-a890-3a38cb63b54a",
  "status": "scheduled",
  "created_at": "2020-12-13T16:24:42.013Z",
  "send_to": {
    "segment_ids": [
      "dad84de3-bec4-4e04-b132-2cbfd4bb3789",
      "7dce758d-1155-4102-88d2-ca65565ac98b"
    ],
    "all": true
  }
}
{
  "errors": [
    {
      "field": "officia Duis reprehenderit consequat minim",
      "message": "consequat sit laborum",
      "error_id": "fugiat et"
    },
    {
      "field": "ex mollit labore est officia",
      "message": "adipisicing",
      "error_id": "enim labore consequat ea"
    },
    {
      "field": "commodo proident velit in eiusmod",
      "message": "cupidatat veniam dolore",
      "error_id": "aliquip mollit"
    }
  ]
}
{
  "errors": [
    {
      "field": "aliquip sunt",
      "message": "ex nostrud",
      "error_id": "consectetur do sed in id"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "pariatur sint nostrud ea magna",
      "message": "proident veniam",
      "error_id": "enim tempor minim proident veniam"
    }
  ]
}
{
  "errors": [
    {
      "field": "reprehenderit consectetur proident commodo",
      "message": "proident esse sed",
      "error_id": "occaecat magna labore"
    },
    {
      "field": "velit amet reprehenderit ipsum",
      "message": "non qui culpa tempor velit",
      "error_id": "minim ipsum occaecat"
    },
    {
      "field": "eiusmod esse labore in est",
      "message": "laborum pariatur",
      "error_id": "nostrud nulla aliqua et laborum"
    },
    {
      "field": "in",
      "message": "cupidatat Duis consequat commodo",
      "error_id": "aute nulla"
    },
    {
      "field": "sit Ut",
      "message": "consectetur dolore",
      "error_id": "esse eiusmod Excepteur laborum minim"
    }
  ]
}
Query Parameter NameExample
page_size-13705725
page_tokenamet Ut laborum
Request Payload
{
  "name": "specific-single-send-name",
  "status": [
    "draft",
    "scheduled"
  ],
  "categories": [
    "shoes"
  ]
}
Response Payload
{
  "result": [
    {
      "id": "df25ffdf-6a96-458a-9419-6d87d3094c6b",
      "name": "single-send-1",
      "status": "triggered",
      "categories": [
        "shoes"
      ],
      "is_abtest": true,
      "updated_at": "3263-04-09T09:05:08.193Z",
      "created_at": "4739-10-29T07:11:32.476Z",
      "send_at": "2471-05-31T15:46:18.797Z"
    }
  ],
  "_metadata": {
    "self": "nwNSrPSWt7d",
    "prev": "P0Enoayd",
    "next": "DYEsTUDww9-",
    "count": 1
  }
}
{
  "errors": [
    {
      "field": "sint",
      "message": "occaecat amet",
      "error_id": "voluptate"
    },
    {
      "field": "sunt anim nostrud sint ut",
      "message": "amet ad",
      "error_id": "commodo"
    }
  ]
}
Request Payload
{
  "send_at": "3752-01-28T23:21:52.575Z"
}
Response Payload
{
  "send_at": "3752-01-28T23:21:52.575Z",
  "status": "scheduled"
}
{
  "errors": [
    {
      "field": "fugiat ut Duis et",
      "message": "magna aute quis sunt",
      "error_id": "pariatur magna tempor minim incididunt"
    }
  ]
}
{
  "errors": [
    {
      "field": "ad velit",
      "message": "magna",
      "error_id": "ex nisi incididunt fugiat"
    },
    {
      "field": "esse non",
      "message": "irure dolor aliqua",
      "error_id": "dolor"
    }
  ]
}
Request Payload
Response Payload
{
  "send_at": "1950-01-07T12:43:36.0Z",
  "status": "triggered"
}
{
  "errors": [
    {
      "field": "Lorem ad exercitation",
      "message": "amet ut ipsum incididunt",
      "error_id": "nostrud eu veniam aliqua Excepteur"
    }
  ]
}
{
  "errors": [
    {
      "field": "nulla adipisicing",
      "message": "aute sit",
      "error_id": "ea do Ut id"
    },
    {
      "field": "consectetur eiusmod nostrud",
      "message": "non deserunt occaecat cupidatat",
      "error_id": "ullamco aute Lorem"
    },
    {
      "field": "incididunt reprehenderit velit sit aliquip",
      "message": "cupidatat minim proident quis",
      "error_id": "cupidatat"
    },
    {
      "field": "dolor labore",
      "message": "amet anim",
      "error_id": "magna dolore dolor"
    },
    {
      "field": "in enim in Duis",
      "message": "magna do consequat quis adipisicing",
      "error_id": "nulla labore exercitation consectetur"
    }
  ]
}
Request Payload
Response Payload
{
  "categories": [
    "equipment",
    "shoes",
    "sports"
  ]
}
{
  "errors": [
    {
      "field": "culpa aliquip do Duis tempor",
      "message": "veniam pariatur in",
      "error_id": "culpa eiusmod"
    },
    {
      "field": "consectetur",
      "message": "non amet ea",
      "error_id": "nisi"
    }
  ]
}

Send Test Email

Request Payload
{
  "template_id": "f8f77db8-b9fa-4b3c-9ee8-de3d582016b8",
  "version_id_override": "7734f757-8eb8-4d22-b7f0-779a72f32986",
  "sender_id": 6060664,
  "custom_unsubscribe_url": "https://example.com/unsubscribe",
  "suppression_group_id": 21865513,
  "emails": [
    "janedoe@example.com",
    "tiramisu@example.com",
    "bundt@example.com"
  ]
}
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Marketing Campaigns Stats(8 operations)

Query Parameter NameExample
automation_ids["laboris","laboris","minim voluptate officia","aute cupidatat Lorem deserunt laboris","adipisicing minim nulla","sint","fugiat ullamco commodo Duis","velit dolor reprehenderit veniam in","nulla","ipsum ullamco laboris consequat reprehenderit"]
page_size87
page_tokenUt anim occaecat proident reprehenderit
Request Payload
Response Payload
{
  "results": [
    {
      "id": "21eae37a-bcf5-d050-573e-f44bb1eec15c",
      "aggregation": "irure dolore",
      "step_id": "aute dolor consequat",
      "stats": {
        "bounce_drops": 47494005,
        "bounces": 76066959,
        "clicks": 14450212,
        "delivered": 50976985,
        "invalid_emails": 41202376,
        "opens": 60260576,
        "requests": -66555779,
        "spam_report_drops": -13310014,
        "spam_reports": -52891124,
        "unique_clicks": -99527781,
        "unique_opens": 39949598,
        "unsubscribes": 16517714
      }
    },
    {
      "id": "b312bb0d-0789-67b2-7596-c36f695db804",
      "aggregation": "dolor",
      "step_id": "Ut qui id irure ipsum",
      "stats": {
        "bounce_drops": 19204960,
        "bounces": 12946025,
        "clicks": 70050712,
        "delivered": 61666859,
        "invalid_emails": -6879130,
        "opens": -33968737,
        "requests": 21231835,
        "spam_report_drops": -81147818,
        "spam_reports": 95845520,
        "unique_clicks": -6958971,
        "unique_opens": 193240,
        "unsubscribes": -77570870
      }
    },
    {
      "id": "afe3b3c8-9696-60a4-5403-a91bb36370dd",
      "aggregation": "velit anim consequat",
      "step_id": "id incididunt est commodo",
      "stats": {
        "bounce_drops": 29488956,
        "bounces": 58174784,
        "clicks": 79402222,
        "delivered": 94393441,
        "invalid_emails": -49782387,
        "opens": 20032099,
        "requests": -87280303,
        "spam_report_drops": -94116079,
        "spam_reports": 75610494,
        "unique_clicks": 82373645,
        "unique_opens": 74446985,
        "unsubscribes": -23266093
      }
    },
    {
      "id": "ec707de3-1bac-34f4-14f9-4a1f2da75bce",
      "aggregation": "labore laboris enim",
      "step_id": "magna occaecat ipsum",
      "stats": {
        "bounce_drops": -71491288,
        "bounces": 27981191,
        "clicks": 37570291,
        "delivered": -13183058,
        "invalid_emails": -57750490,
        "opens": 76546901,
        "requests": 58730963,
        "spam_report_drops": 43446436,
        "spam_reports": -36481734,
        "unique_clicks": 97476366,
        "unique_opens": -83094747,
        "unsubscribes": 9881840
      }
    }
  ],
  "_metadata": {
    "prev": "http://NcYGNTDinhtdUESaERYdpPEtTbcS.yyyOa5GSqYCZ",
    "self": "https://SfXSSGGYC.aoydYoW+cPYFqEdHAFZb88Kxv4fzt9kO5bxQuoMvM-LqJkJqPF0",
    "next": "http://OlKnryefgvyvAFgsZUVjRdxD.dynmoRsebug2,CVHMfOc8ChbGGxRVMvKNTXYTgP3VGFZY21FxoHBVzCvJEC8rGZ9",
    "count": 8652530.730420068
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
group_by["step_id","step_id","step_id"]
step_ids["313b7420-1ed8-ea91-a73f-b74c9ff16fb6","cb712b7e-551c-8d99-2a76-66696d19e2f7","99ccc63c-ef19-e632-a120-4f4c52a830c5","2d028024-49b8-ffa6-cd94-57d095ec0fa5"]
aggregated_bytotal
start_date1959-09-14
end_date1900-03-08
timezoneelit qui
page_size87
page_tokenaliquip
Request Payload
Response Payload
{
  "results": [
    {
      "id": "6a4604d3-e1e8-b90a-f45d-3c70cf12d456",
      "aggregation": "qui veniam in",
      "step_id": "tempor",
      "stats": {
        "bounce_drops": 42332126,
        "bounces": -57947261,
        "clicks": 30485766,
        "delivered": 9473707,
        "invalid_emails": 39467135,
        "opens": 5003613,
        "requests": -25416150,
        "spam_report_drops": 40137849,
        "spam_reports": -76857092,
        "unique_clicks": -94315394,
        "unique_opens": 5416408,
        "unsubscribes": -6888534
      }
    },
    {
      "id": "ed1e889a-22e7-3433-a106-5545098daa97",
      "aggregation": "Excepteur sunt cupidatat in culpa",
      "step_id": "aliquip ullamco sed reprehenderit ex",
      "stats": {
        "bounce_drops": 70169548,
        "bounces": 13483284,
        "clicks": 40147090,
        "delivered": -15309923,
        "invalid_emails": 53752282,
        "opens": -42511299,
        "requests": 77477966,
        "spam_report_drops": -31121088,
        "spam_reports": 67454778,
        "unique_clicks": 38747126,
        "unique_opens": 19401670,
        "unsubscribes": -11116735
      }
    },
    {
      "id": "4465dc98-3221-5b2a-c975-d767633bf0fe",
      "aggregation": "consequat aute",
      "step_id": "ea proident ipsum nulla",
      "stats": {
        "bounce_drops": -49644487,
        "bounces": -4425378,
        "clicks": -50517654,
        "delivered": -76426331,
        "invalid_emails": 59216736,
        "opens": 60242632,
        "requests": -19457665,
        "spam_report_drops": -36338544,
        "spam_reports": -50117826,
        "unique_clicks": -12852097,
        "unique_opens": -79256051,
        "unsubscribes": -46421142
      }
    }
  ],
  "_metadata": {
    "prev": "http://gAxwpfuMgdLYaTASltyy.tdPilMnyU8jnmDzSLLxKayx7XeCAokKkLJ7sc9oOOBbJ6FHelezMBfz7PYb,sKppoT",
    "self": "http://F.soDRhfwPAD0Qq8q",
    "next": "https://DXLLmRJawCEWVzqdiJk.hldcYivOcwwbcEtM1biUvx2j+xaZALf.ffV4GDew1LGI.Owh,vvZEOGExAty+oJI1,G9,Rbj.xyhEMx1TbZ6kG",
    "count": -23305622.19762768
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
singlesend_ids["sed adipisicing in","veniam officia commodo reprehenderit","in qui est","ipsum mollit ea fugiat","sunt nostrud proident","qui","magna cupidatat dolor ipsum labore","dolor est","non est cillum proident","esse adipisicing"]
page_size45
page_tokenet cillum velit
Request Payload
Response Payload
{
  "results": [
    {
      "id": "736a70fe-0410-43f7-03ce-d09fe64c5ff4",
      "ab_variation": "cff1e468-c51e-3fa2-405f-826b01dae909",
      "ab_phase": "test",
      "aggregation": "esse",
      "stats": {
        "bounce_drops": -795044,
        "bounces": -82787942,
        "clicks": 56363860,
        "delivered": 60236933,
        "invalid_emails": -33296006,
        "opens": 17617847,
        "requests": -93645420,
        "spam_report_drops": -31254378,
        "spam_reports": 96369425,
        "unique_clicks": 58457814,
        "unique_opens": -3320282,
        "unsubscribes": -4528027
      }
    }
  ],
  "_metadata": {
    "prev": "https://SyznRiyPEgpiaGMyuytOBabBIBzh.ougQuRxTJvyjF5N1wuDvuGmsVoZ9+-7i4Lw.NO4kbWlscYeGd+7Y6S4Vqo",
    "self": "https://MyjnDsPGx.irqGDzxgvVy",
    "next": "http://rgltazYHhsQixAupGsCTpKZZkhKLRb.uqu8B0j7BrhyeBlYj0,dnYiuYw",
    "count": 91770353.76527521
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
aggregated_byday
start_date1890-03-10
end_date1957-01-02
timezoneExcepteur eu non
page_size76
page_tokendo velit eiusmod
group_by["ab_phase"]
Request Payload
Response Payload
{
  "results": [
    {
      "id": "78a23bf5-c349-1d42-2b6f-ec44fa459203",
      "ab_variation": "484713c8-b9b8-5c81-0d45-e2bc3255e89e",
      "ab_phase": "test",
      "aggregation": "do commodo",
      "stats": {
        "bounce_drops": -96635378,
        "bounces": -65235018,
        "clicks": -89681956,
        "delivered": -6147209,
        "invalid_emails": -45194812,
        "opens": -68493817,
        "requests": -37869570,
        "spam_report_drops": -19799066,
        "spam_reports": -98122188,
        "unique_clicks": 41564174,
        "unique_opens": 49226786,
        "unsubscribes": -85019396
      }
    },
    {
      "id": "07c8509a-8d02-3d1f-7cbb-2c1f1b6172f2",
      "ab_variation": "80a09172-b770-b9fd-72fa-cb8e23791c4f",
      "ab_phase": "all",
      "aggregation": "consequat proident adipisicing",
      "stats": {
        "bounce_drops": -97011875,
        "bounces": 79346636,
        "clicks": 7476579,
        "delivered": 9239838,
        "invalid_emails": -29221384,
        "opens": 9941110,
        "requests": 13709027,
        "spam_report_drops": 38571541,
        "spam_reports": -19234055,
        "unique_clicks": 73323657,
        "unique_opens": 59940373,
        "unsubscribes": 59870598
      }
    },
    {
      "id": "118d14b4-996b-d065-0575-23c7b25c46df",
      "ab_variation": "2351b949-6d02-e46b-cb9c-fe279bc3a1a1",
      "ab_phase": "test",
      "aggregation": "sunt et elit ut",
      "stats": {
        "bounce_drops": 60079252,
        "bounces": 73313883,
        "clicks": 6589522,
        "delivered": 60201183,
        "invalid_emails": -27185223,
        "opens": -61283931,
        "requests": -79500855,
        "spam_report_drops": -6843368,
        "spam_reports": 39744756,
        "unique_clicks": -17264779,
        "unique_opens": -17386396,
        "unsubscribes": -79088090
      }
    },
    {
      "id": "4ec4d440-64ef-a8c4-e032-f417df3947e4",
      "ab_variation": "1933b6b9-93d2-f179-306f-0fb7db9683e8",
      "ab_phase": "send",
      "aggregation": "reprehenderit enim culpa eiusmod",
      "stats": {
        "bounce_drops": 69852209,
        "bounces": 98811247,
        "clicks": 71008325,
        "delivered": -80197615,
        "invalid_emails": -47759926,
        "opens": -12655396,
        "requests": -25231160,
        "spam_report_drops": -37029091,
        "spam_reports": -5755056,
        "unique_clicks": -88417765,
        "unique_opens": -46692835,
        "unsubscribes": -55057158
      }
    }
  ],
  "_metadata": {
    "prev": "https://cMULtQvJieVxqVzpTXNblWuksBln.dnq4FADKj8NQAnD6pcnCnr",
    "self": "http://CRYtJVfMXfpg.cgFKBL8nabd7awCVeZBx0Jq.2Nw4vU7+yOk.uvXJ3DFyrntTD.36834IP51apSyRcf3Phf",
    "next": "https://sVEpGIjDhxZBDakBoZIFEIqHSKPEd.aeAhpTpMAKMrdQ2F2XCSsgKosREpgAClXM-VTSfEP5QliB,4cAr-OJJ87OtmTNEz7Hj3yDq1oGqsDTjbUcmbu",
    "count": 13143721.838227585
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
group_by["step_id"]
step_ids["d0204281-44cf-904d-dde4-d304b48aea6d"]
page_size55
page_tokenExcepteur occaecat commodo ea ad
Request Payload
Response Payload
{
  "results": [
    {
      "url": "http://omYZXGYjpqbDHLPoFW.ibYEiyrmAKUmnD8Ir1OmjpYSnxS-JtSQWMnbTXUhD1gRVR",
      "url_location": 74434077,
      "step_id": "1b4c6ec3-d5cb-229b-695f-46e08e2f4e0f",
      "clicks": 73961643
    },
    {
      "url": "http://kuUUOVJZsCIwQPEmrCeXDnMcXRJeBbB.dqRw+q0gEwKTnjh-RgvMUlwoKqjOecdn9tucM",
      "url_location": 31010544,
      "step_id": "53285c62-b5dc-1d6d-f492-6a39670dcd12",
      "clicks": 63464268
    },
    {
      "url": "https://ZLbshHDSbeW.pxhzZCzdly7LJDye-WlDIG27bwQf2S",
      "url_location": 27354632,
      "step_id": "6ce75039-5493-8329-16bc-f3df3274d8b2",
      "clicks": 79319446
    },
    {
      "url": "http://IRHSiDYnwOReOmbAzJgDb.nbt+HPFQqrx0gs8A9k5Zbc8,ax1Vp6w6xq9lNQUSgLmUWr7p",
      "url_location": 415594,
      "step_id": "e960d40a-13dc-b13a-0202-6f4de128c376",
      "clicks": 52841730
    }
  ],
  "total_clicks": -56767300,
  "_metadata": {
    "prev": "http://nYqHwbiBuUZpc.crvDZ5.mU1TlXtfWgj5ypqwjm",
    "self": "https://IlPzKOZnjQfEuHFF.ubeFGFBKg8ctozh9mzauJbcpLc5KzPunmimwdTU0NzrM4opztczgbNlHXZ38IUV6yt",
    "next": "http://XLejdwaqWAEhieSxZbKdmEY.pkjlbdO-Y5s,t7olouEEkkYaVXQY+DkUncawXgGtQ",
    "count": -36469257.181676395
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
page_size60
page_tokenexercitation incididunt dolore tempor
group_by["ab_variation","ab_phase","ab_variation","ab_phase"]
ab_variation_id4c51711f-9bfd-355a-4099-cccfdfbe5361
ab_phase_idtest
Request Payload
Response Payload
{
  "results": [
    {
      "url": "https://ISmzu.kdV6R3M8FqNuN9dXfu9JbnFK69PqtPyMbhK3mMhxnxoDEjp.cg",
      "url_location": 92002411,
      "ab_variation": "dc5cebb0-46dd-3784-3996-d079b72a3fdd",
      "ab_phase": "test",
      "clicks": 55992200
    },
    {
      "url": "http://kwzAAy.nxPCr5As5Ir+Nf.e7HoWzqcmvvK5bashM",
      "url_location": 71387945,
      "ab_variation": "198fcfab-5b43-e097-654f-ab302aacef18",
      "ab_phase": "test",
      "clicks": 15296197
    },
    {
      "url": "http://YWIJzqikpZuedlkBPyGiVfSCOFql.plmxRCH52Dv.hAdd4I0Hwjz1NjRFRqGhOh4VWtNfdylA3W.ELUOYpsQTwnmDcTm6.nG",
      "url_location": 28045300,
      "ab_variation": "fc86412a-57de-d0d6-e182-94ec38671f55",
      "ab_phase": "test",
      "clicks": 42289242
    },
    {
      "url": "https://mgyUyUenZJUJBbgJehBClaMpKaphFG.jeeWYmpAPPgeiYkm30TdaSui,foCXbquMbu+TjZIZ,dfpT3ZFGJU4MInbILo",
      "url_location": 57163440,
      "ab_variation": "48650d02-1641-202f-1aa5-b4d96698c072",
      "ab_phase": "all",
      "clicks": 19192992
    }
  ],
  "_metadata": {
    "prev": "http://hCgJ.tqFAQ-,qb5",
    "self": "https://YjW.ztUtLgoQoTI1gVKEozf69l8ANcusR31ECDzx,dFU0mHslXclgn",
    "next": "http://jmlDUqrlWz.fezP5HR1zjsLxfoFlrlZPJ7pMm0s9yecVGTL.Dwb7w",
    "count": -7854092.996203482
  },
  "total_clicks": 52072848
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
Query Parameter NameExample
ids["in mollit","dolor voluptate sunt reprehenderit","in deserunt id","commodo aliqua sit incididunt","deserunt irure ullamco enim","ut laborum aute nisi anim","in sit irure deserunt","sit in nostrud cupidatat","cupidatat aliqua et Duis mollit","sint cillum in commodo consequat"]
timezonenon
Request Payload
Response Payload
exercitation irure aliqua proident in
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
ids["labore qui","dolore cupidatat in","culpa","do anim nostrud ullamco sed","in","anim est","qui ut in","nisi deserunt dolore laboris cillum","commodo","Excepteur sint Ut qui nostrud"]
timezoneamet consequat
Request Payload
Response Payload
enim dolor
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Sender Identities API(6 operations)

Header NameExample
on-behalf-of"sed velit"
Request Payload
{
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States"
}
Response Payload
{
  "id": 1,
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States",
  "verified": true,
  "updated_at": 1449872165,
  "created_at": 1449872165,
  "locked": false
}
{
  "errors": [
    {
      "message": "The JSON you have submitted cannot be parsed.",
      "field": ""
    },
    {
      "message": "You've reached your limit of 100 sender identities. Please delete one or more and try again.",
      "field": ""
    },
    {
      "message": "nickname is required.",
      "field": "nickname"
    },
    {
      "message": "You already have a sender identity with the same nickname.",
      "field": "nickname"
    },
    {
      "message": "from_name is required.",
      "field": "from_name"
    },
    {
      "message": "from_email is required.",
      "field": "from_email"
    },
    {
      "message": "From email is not a valid email address.",
      "field": "from_email"
    },
    {
      "message": "reply_to is required.",
      "field": "reply_to"
    },
    {
      "message": "Reply to email is not a valid email address.",
      "field": "reply_to"
    },
    {
      "message": "address is required.",
      "field": "address"
    },
    {
      "message": "city is required.",
      "field": "city"
    },
    {
      "message": "country is required.",
      "field": "country"
    }
  ]
}
Header NameExample
on-behalf-of"eu"
Request Payload
Response Payload
{
  "result": [
    {
      "id": 1,
      "nickname": "My Sender ID",
      "from": {
        "email": "from@example.com",
        "name": "Example INC"
      },
      "reply_to": {
        "email": "replyto@example.com",
        "name": "Example INC"
      },
      "address": "123 Elm St.",
      "address_2": "Apt. 456",
      "city": "Denver",
      "state": "Colorado",
      "zip": "80202",
      "country": "United States",
      "verified": true,
      "updated_at": 1449872165,
      "created_at": 1449872165,
      "locked": false
    }
  ]
}
Header NameExample
on-behalf-of"et"
Request Payload
Response Payload
{
  "id": 1,
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States",
  "verified": true,
  "updated_at": 1449872165,
  "created_at": 1449872165,
  "locked": false
}
{
  "errors": [
    {
      "message": "resource not found",
      "field": "id"
    }
  ]
}
Header NameExample
on-behalf-of"anim minim"
Request Payload
{
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States"
}
Response Payload
{
  "id": 1,
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States",
  "verified": true,
  "updated_at": 1449872165,
  "created_at": 1449872165,
  "locked": false
}
{
  "errors": [
    {
      "message": "The JSON you have submitted cannot be parsed.",
      "field": ""
    },
    {
      "message": "nickname is required.",
      "field": "nickname"
    },
    {
      "message": "You already have a sender identity with the same nickname.",
      "field": "nickname"
    },
    {
      "message": "from_name is required.",
      "field": "from_name"
    },
    {
      "message": "from_email is required.",
      "field": "from_email"
    },
    {
      "message": "From email is not a valid email address.",
      "field": "from_email"
    },
    {
      "message": "reply_to is required.",
      "field": "reply_to"
    },
    {
      "message": "Reply to email is not a valid email address.",
      "field": "reply_to"
    },
    {
      "message": "address is required.",
      "field": "address"
    },
    {
      "message": "city is required.",
      "field": "city"
    },
    {
      "message": "country is required.",
      "field": "country"
    }
  ]
}
{
  "errors": [
    {
      "message": "You may only update a sender identity when it is unlocked.",
      "field": "locked"
    }
  ]
}
{
  "errors": [
    {
      "message": "resource not found",
      "field": "id"
    }
  ]
}
Header NameExample
on-behalf-of"minim mollit sed"
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "message": "You may only delete a sender identity when it is unlocked.",
      "field": "locked"
    }
  ]
}
{
  "errors": [
    {
      "message": "resource not found",
      "field": "id"
    }
  ]
}
Header NameExample
on-behalf-of"Lorem consectetur ea anim"
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "message": "The Sender Identity is already verified.  No email sent.",
      "field": ""
    }
  ]
}
{
  "errors": [
    {
      "message": "resource not found",
      "field": "id"
    }
  ]
}

Contacts API - Lists(10 operations)

Header NameExample
on-behalf-of"consectetur"
Request Payload
{
  "name": "your list name"
}
Response Payload
{
  "id": 1,
  "name": "your list name",
  "recipient_count": 0
}
{
  "errors": [
    {
      "field": null,
      "message": "Returned if request body is invalid JSON"
    },
    {
      "field": "name",
      "message": "Returned if list name is not a string"
    },
    {
      "field": "name",
      "message": "Returned if list name is a duplicate of an existing list or segment"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"in Duis aliquip exercitation nostrud"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1,
      "name": "the jones",
      "recipient_count": 1
    }
  ]
}
Header NameExample
on-behalf-of"non veniam"
Request Payload
[
  1,
  2,
  3,
  4
]
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "list id was invalid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
list_id-16499320
Header NameExample
on-behalf-of"magna"
Request Payload
Response Payload
{
  "id": 1,
  "name": "listname",
  "recipient_count": 0
}
{
  "errors": [
    {
      "message": "invalid id"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "List ID does not exist"
    }
  ]
}
Query Parameter NameExample
list_id*19656161
Header NameExample
on-behalf-of"dolor anim nisi"
Request Payload
{
  "name": "newlistname"
}
Response Payload
{
  "id": 1234,
  "name": "2016 iPhone Users",
  "recipient_count": 0
}
{
  "errors": [
    {
      "message": "invalid id"
    }
  ]
}
{
  "errors": [
    {
      "message": "List ID does not exist"
    }
  ]
}
Query Parameter NameExample
delete_contactsfalse
Header NameExample
on-behalf-of"Duis ex non"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "delete_contacts",
      "message": "delete_contacts not a bool"
    },
    {
      "field": "list_id",
      "message": "Returned if list_id is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "List not found: 5"
    }
  ]
}
Query Parameter NameExample
page-97156290
page_size98005861
list_id*45303876
Header NameExample
on-behalf-of"in aute ad Duis Excepteur"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 1433348344,
      "custom_fields": [
        {
          "id": 6234,
          "name": "age",
          "type": "number",
          "value": null
        },
        {
          "id": 6233,
          "name": "country",
          "type": "text",
          "value": null
        },
        {
          "id": 6235,
          "name": "fname",
          "type": "text",
          "value": "Example"
        },
        {
          "id": 6239,
          "name": "lname",
          "type": "text",
          "value": "User"
        },
        {
          "id": 6240,
          "name": "lname",
          "type": "text",
          "value": null
        }
      ],
      "email": "example@example.com",
      "first_name": "Example",
      "id": "ZGVWfyZWsuYmFpbmVzQHNlbmRmCmLkLmNv==",
      "last_clicked": 1438616117,
      "last_emailed": 1438613272,
      "last_name": "User",
      "last_opened": 1438616109,
      "updated_at": 1438616119
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id is not a valid integer"
    },
    {
      "field": "page",
      "message": "Returned if page is not a valid integer"
    },
    {
      "field": "page",
      "message": "Returned if page is less than 1"
    },
    {
      "field": "page_size",
      "message": "Returned if page_size is not a valid integer"
    },
    {
      "field": "page_size",
      "message": "Returned if page_size is less than 1 or greater than 1000"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id is invalid"
    }
  ]
}
Header NameExample
on-behalf-of"laboris"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "list_id",
      "message": "list_id is invalid"
    },
    {
      "field": "recipient_id",
      "message": "no valid recipients were provided"
    },
    {
      "field": null,
      "message": "no recipients were added"
    },
    {
      "field": null,
      "message": "request body is invalid JSON"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "list_id does not exist"
    },
    {
      "field": "recipient_id",
      "message": "recipient_id does not exist"
    }
  ]
}
Header NameExample
on-behalf-of"nulla irure"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id is invalid"
    },
    {
      "field": "recipient_id",
      "message": "Returned if recipient_id is invalid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id does not exist"
    },
    {
      "field": "recipient_id",
      "message": "Returned if recipient_id does not exist"
    }
  ]
}
Query Parameter NameExample
list_id*-61770821
recipient_id*-79208005
Header NameExample
on-behalf-of"elit"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id is invalid"
    },
    {
      "field": "recipient_id",
      "message": "no valid recipients were provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id does not exist"
    },
    {
      "field": "recipient_id",
      "message": "Returned if recipient_id does not exist"
    }
  ]
}

Contacts API - Recipients(12 operations)

Header NameExample
on-behalf-of"veniam dolore"
Request Payload
[
  {
    "email": "example@example.com",
    "first_name": "",
    "last_name": "User",
    "age": 25
  },
  {
    "email": "example2@example.com",
    "first_name": "Example",
    "last_name": "User",
    "age": 25
  }
]
Response Payload
{
  "error_count": 1,
  "error_indices": [
    2
  ],
  "new_count": 2,
  "persisted_recipients": [
    "YUBh",
    "bWlsbGVyQG1pbGxlci50ZXN0"
  ],
  "updated_count": 0,
  "errors": [
    {
      "message": "Invalid email.",
      "error_indices": [
        2
      ]
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "Request body is not valid json"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"anim irure qui nostrud nulla"
Request Payload
[
  {
    "email": "jones@example.com",
    "last_name": "Jones",
    "first_name": "Guy"
  }
]
Response Payload
{
  "error_count": 1,
  "error_indices": [
    2
  ],
  "new_count": 2,
  "persisted_recipients": [
    "YUBh",
    "bWlsbGVyQG1pbGxlci50ZXN0"
  ],
  "updated_count": 0,
  "errors": [
    {
      "message": "Invalid email.",
      "error_indices": [
        2
      ]
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "Request body is not valid json"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"magna ea voluptate fugiat ut"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
{}
{
  "errors": [
    {
      "message": "No recipient ids provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
page-14019944
page_size99538900
Header NameExample
on-behalf-of"eu velit in tempor cillum"
Request Payload
Response Payload
{
  "recipients": []
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"in"
Request Payload
Response Payload
{
  "status": [
    {
      "id": "worker_delay",
      "value": "delayed"
    },
    {
      "id": "worker_delay_seconds",
      "value": "75.0"
    }
  ]
}
Header NameExample
on-behalf-of"esse ipsum in"
Request Payload
Response Payload
{
  "recipients": [
    {
      "id": "dolore dolore cillum enim",
      "created_at": -51124095.894925945,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "8DpdB36dG@zayZNoLWIYvrmHcV.lhbd",
      "first_name": null,
      "last_name": null,
      "last_clicked": 45171622.11978567,
      "last_emailed": 37940813.23367676,
      "last_opened": -3665259.1908666193,
      "updated_at": -75214259.67941053
    },
    {
      "id": "id ut fugiat commodo",
      "created_at": 76051668.48186147,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "k4xwcnJStq@ymbxhjSqfqTEoPuUTvGM.eto",
      "first_name": "ut tempor",
      "last_name": "deserunt laborum",
      "last_clicked": null,
      "last_emailed": null,
      "last_opened": null,
      "updated_at": 39378131.64010486
    },
    {
      "id": "Ut",
      "created_at": 78603963.20577693,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "6wr7sF@xtpLxaeNJDiQfoMgEhOLiQizO.qe",
      "first_name": null,
      "last_name": null,
      "last_clicked": 56992943.67858073,
      "last_emailed": 66549253.84104201,
      "last_opened": null,
      "updated_at": -6802523.226035714
    },
    {
      "id": "voluptate Ut consectetur officia",
      "created_at": 36338003.06346145,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "D6jS@qIMAPfirhqIAHbJUylsm.ziem",
      "first_name": null,
      "last_name": null,
      "last_clicked": null,
      "last_emailed": -62025246.068453036,
      "last_opened": null,
      "updated_at": -20675253.908813402
    },
    {
      "id": "consequat deserunt sint",
      "created_at": -95950943.37645404,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "R7KJLnR@ZHxYHdLjafOLnis.uur",
      "first_name": null,
      "last_name": "sed laboris culpa aliqua ut",
      "last_clicked": -76814669.08837664,
      "last_emailed": 52076217.73954743,
      "last_opened": -10046554.586469233,
      "updated_at": -66821167.12009196
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"enim deserunt veniam"
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "recipient not found"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "recipient_id is not valid"
    }
  ]
}
Header NameExample
on-behalf-of"magna ad sunt"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1234,
      "name": "Example list",
      "recipient_count": 42
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "recipient ID is invalid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "recipient id not found"
    }
  ]
}
Header NameExample
on-behalf-of"voluptate in incididunt dolor consectetur"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"exercitation"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
{field_name}voluptate occaecat quis elit commodo
Header NameExample
on-behalf-of"anim eiusmod"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 1422313607,
      "email": "jones@example.com",
      "first_name": null,
      "id": "YUBh",
      "last_clicked": null,
      "last_emailed": null,
      "last_name": "Jones",
      "last_opened": null,
      "updated_at": 1422313790,
      "custom_fields": [
        {
          "id": 23,
          "name": "pet",
          "value": "Fluffy",
          "type": "text"
        }
      ]
    }
  ]
}
{
  "errors": [
    {
      "message": "The following parameters are not custom fields or reserved fields: [{field_name}]"
    },
    {
      "message": "No search params are specified"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Request Payload
{
  "list_id": -27497588,
  "conditions": [
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    },
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    },
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    },
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    }
  ]
}
Response Payload
{
  "recipients": [
    {
      "created_at": -27901208,
      "email": "ut magna quis ipsum",
      "id": "fugiat ad adipisicing ullamco",
      "last_emailed": 21626657
    },
    {
      "created_at": 17466400,
      "email": "sunt irure",
      "id": "et",
      "last_clicked": -23135244,
      "last_opened": -44593357,
      "first_name": "est"
    },
    {
      "created_at": -34495329,
      "email": "reprehenderit incididunt velit Lorem esse",
      "id": "esse Ut ad dolore",
      "last_clicked": 10164083,
      "last_opened": 34443062
    },
    {
      "created_at": -37030673,
      "email": "amet deserunt fugiat voluptate",
      "id": "et exercitation commodo id laborum",
      "last_clicked": -10497425
    },
    {
      "created_at": 3658435,
      "email": "labore veniam",
      "id": "ad pariatur esse",
      "last_opened": -84227501,
      "custom_fields": [
        {
          "id": -5765608,
          "name": "proident pariatur",
          "value": "do in magna mollit",
          "type": "dolore ut"
        },
        {
          "id": -31131201,
          "name": "laborum mollit",
          "value": 84434696,
          "type": "veniam"
        }
      ],
      "updated_at": -56455352,
      "first_name": "Ut cupidatat nulla deserunt adipisicing",
      "last_clicked": -52862671
    }
  ],
  "recipient_count": 65190677
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

Contacts API - Custom Fields(5 operations)

Header NameExample
on-behalf-of"nulla ullamco"
Request Payload
{
  "name": "pet",
  "type": "text"
}
Response Payload
{
  "id": 1,
  "name": "pet",
  "type": "text"
}
{
  "errors": [
    {
      "field": null,
      "message": "Returned if request body is invalid JSON"
    },
    {
      "field": "type",
      "message": "Returned if custom field type is invalid or not provided"
    },
    {
      "field": "name",
      "message": "Returned if custom field name is not provided"
    }
  ]
}
Header NameExample
on-behalf-of"exercitation"
Request Payload
Response Payload
{
  "custom_fields": [
    {
      "id": 6234,
      "name": "age",
      "type": "number"
    },
    {
      "id": 6233,
      "name": "country",
      "type": "text"
    },
    {
      "id": 6235,
      "name": "favorite_color",
      "type": "text"
    },
    {
      "id": 6239,
      "name": "fname",
      "type": "text"
    },
    {
      "id": 6240,
      "name": "lname",
      "type": "text"
    },
    {
      "id": 49439,
      "name": "pet",
      "type": "text"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"dolor nulla id cupidatat aliquip"
Request Payload
Response Payload
{
  "id": 1,
  "name": "pet",
  "type": "text"
}
{
  "errors": [
    {
      "message": "invalid id"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "Custom field ID does not exist"
    }
  ]
}
Header NameExample
on-behalf-of"consequat fugiat proident mollit aliquip"
Request Payload
Response Payload
{
  "message": "Custom Field delete is processing."
}
{
  "errors": [
    {
      "message": "Custom field in use by one or more segment conditions"
    },
    {
      "message": "Custom field ID does not exist"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "Custom field ID does not exist"
    }
  ]
}
Header NameExample
on-behalf-of"pariatur dolore consequat veniam cupidatat"
Request Payload
Response Payload
{
  "reserved_fields": [
    {
      "name": "first_name",
      "type": "text"
    },
    {
      "name": "last_name",
      "type": "text"
    },
    {
      "name": "email",
      "type": "text"
    },
    {
      "name": "created_at",
      "type": "date"
    },
    {
      "name": "updated_at",
      "type": "date"
    },
    {
      "name": "last_emailed",
      "type": "date"
    },
    {
      "name": "last_clicked",
      "type": "date"
    },
    {
      "name": "last_opened",
      "type": "date"
    },
    {
      "name": "lists",
      "type": "set"
    },
    {
      "name": "campaigns",
      "type": "set"
    },
    {
      "name": "my_custom_field",
      "type": "text"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Contacts API - Segments(6 operations)

Header NameExample
on-behalf-of"tempor amet"
Request Payload
{
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    },
    {
      "field": "last_clicked",
      "value": "01/02/2015",
      "operator": "gt",
      "and_or": "and"
    },
    {
      "field": "clicks.campaign_identifier",
      "value": "513",
      "operator": "eq",
      "and_or": "or"
    }
  ]
}
Response Payload
{
  "id": 1,
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    },
    {
      "field": "last_clicked",
      "value": "01/02/2015",
      "operator": "gt",
      "and_or": "and"
    },
    {
      "field": "clicks.campaign_identifier",
      "value": "513",
      "operator": "eq",
      "and_or": "or"
    }
  ],
  "recipient_count": 0
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"veniam laboris"
Request Payload
Response Payload
{
  "segments": [
    {
      "id": 1234,
      "name": "Age segments < 25",
      "conditions": [
        {
          "field": "age",
          "value": "25",
          "operator": "lt"
        }
      ],
      "recipient_count": 8
    },
    {
      "id": 2345,
      "name": "email address - gmail",
      "conditions": [
        {
          "field": "email",
          "value": "@gmail.com",
          "operator": "contains"
        }
      ],
      "recipient_count": 0
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
segment_id*-68784651
Header NameExample
on-behalf-of"enim esse cillum"
Request Payload
Response Payload
{
  "id": 1,
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ],
  "recipient_count": 1
}
{
  "errors": [
    {
      "message": "if segment_id is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "segment_id not found"
    }
  ]
}
Query Parameter NameExample
segment_idlaborum enim
Header NameExample
on-behalf-of"dolore amet ut dolor Lorem"
Request Payload
{
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ]
}
Response Payload
{
  "id": 5,
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ],
  "recipient_count": 1
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "segment_id": "segment_id",
      "message": "segment id is not valid"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
delete_contactstrue
Header NameExample
on-behalf-of"velit cillum mollit proident tempor"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "segment_id",
      "message": "Returned if segment_id is not valid"
    },
    {
      "field": "delete_contacts",
      "message": "Returned if delete_contacts is not a valid boolean"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "segment_id",
      "message": "segment_id does not exist"
    }
  ]
}
Query Parameter NameExample
page-50300742
page_size90523981
Header NameExample
on-behalf-of"consequat est ut"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 1422313607,
      "email": "jones@example.com",
      "first_name": null,
      "id": "YUBh",
      "last_clicked": null,
      "last_emailed": null,
      "last_name": "Jones",
      "last_opened": null,
      "updated_at": 1422313790,
      "custom_fields": [
        {
          "id": 23,
          "name": "pet",
          "value": "Indiana",
          "type": "text"
        }
      ]
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}

Categories(3 operations)

Query Parameter NameExample
limit52126321
categoryad esse commodo voluptate adipisicing
offset-10556493
Header NameExample
on-behalf-of"dolor et"
Request Payload
Response Payload
[
  {
    "category": "category 1"
  },
  {
    "category": "category 2"
  }
]
{
  "errors": [
    {
      "field": "sort_by",
      "message": "invalid sort value"
    }
  ]
}
Query Parameter NameExample
sort_by_metricin nostrud
sort_by_directionasc
start_date*veniam ut ipsum sint officia
end_dateconsequat adipisicing sed ad
limit-19549626
offset11609747
aggregated_byweek
Header NameExample
on-behalf-of"magna qui"
Request Payload
Response Payload
{
  "date": "2015-01-01",
  "stats": [
    {
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 20,
        "deferred": 0,
        "delivered": 20,
        "invalid_emails": 0,
        "opens": 20,
        "processed": 0,
        "requests": 20,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 20,
        "unique_opens": 20,
        "unsubscribe_drops": 0,
        "unsubscribes": 20
      },
      "name": "cat1",
      "type": "category"
    },
    {
      "metrics": {
        "blocks": 1,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 19,
        "deferred": 0,
        "delivered": 19,
        "invalid_emails": 0,
        "opens": 19,
        "processed": 0,
        "requests": 20,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 19,
        "unique_opens": 19,
        "unsubscribe_drops": 0,
        "unsubscribes": 19
      },
      "name": "cat2",
      "type": "category"
    },
    {
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 5,
        "invalid_emails": 0,
        "opens": 5,
        "processed": 0,
        "requests": 5,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 5,
        "unique_opens": 5,
        "unsubscribe_drops": 0,
        "unsubscribes": 5
      },
      "name": "cat3",
      "type": "category"
    },
    {
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 6,
        "deferred": 0,
        "delivered": 5,
        "invalid_emails": 0,
        "opens": 6,
        "processed": 0,
        "requests": 5,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 5,
        "unique_opens": 5,
        "unsubscribe_drops": 0,
        "unsubscribes": 6
      },
      "name": "cat4",
      "type": "category"
    },
    {
      "metrics": {
        "blocks": 10,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 0,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 0,
        "processed": 0,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "cat5",
      "type": "category"
    }
  ]
}
Query Parameter NameExample
start_date*Ut in cupidatat eu dolor
end_datefugiat ullamco
categories*et occaecat
limit-24834757
offset62032470
aggregated_byweek
Header NameExample
on-behalf-of"fugiat quis adipisicing dolore"
Request Payload
Response Payload
[
  {
    "date": "2015-10-01",
    "stats": [
      {
        "type": "category",
        "name": "docs",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      },
      {
        "type": "category",
        "name": "mattscategory",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "category",
        "name": "docs",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      },
      {
        "type": "category",
        "name": "mattscategory",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]

Campaigns API(11 operations)

Header NameExample
on-behalf-of"incididunt cupidatat eiusmod ipsum sunt"
Request Payload
{
  "title": "March Newsletter",
  "subject": "New Products for Spring!",
  "sender_id": 124451,
  "list_ids": [
    110,
    124
  ],
  "segment_ids": [
    110
  ],
  "categories": [
    "spring line"
  ],
  "suppression_group_id": 42,
  "custom_unsubscribe_url": "",
  "ip_pool": "marketing",
  "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
  "plain_content": "Check out our spring line!"
}
Response Payload
{
  "id": 986724,
  "title": "March Newsletter",
  "subject": "New Products for Spring!",
  "sender_id": 124451,
  "list_ids": [
    110,
    124
  ],
  "segment_ids": [
    110
  ],
  "categories": [
    "spring line"
  ],
  "suppression_group_id": 42,
  "custom_unsubscribe_url": "",
  "ip_pool": "marketing",
  "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
  "plain_content": "Check out our spring line!",
  "status": "Draft"
}
{
  "errors": [
    {
      "field": "title",
      "message": "title can't be blank"
    },
    {
      "field": "title",
      "message": "title is too long (maximum is 100 characters)"
    },
    {
      "field": "categories",
      "message": "categories exceeds 10 category limit"
    },
    {
      "field": "html_content",
      "message": "html_content exceeds the 1MB limit"
    },
    {
      "field": "plain_content",
      "message": "plain_content exceeds the 1MB limit"
    },
    {
      "field": "sender_id",
      "message": "sender_id does not exist"
    },
    {
      "field": "sender_id",
      "message": "sender_id is not a verified sender identity"
    },
    {
      "field": "list_ids",
      "message": "list_ids do not all exist"
    },
    {
      "field": "segment_ids",
      "message": "segment_ids do not all exist"
    },
    {
      "field": "ip_pool",
      "message": "The ip pool you provided is invalid"
    },
    {
      "field": "suppression_group_id",
      "message": "suppression_group_id does not exist"
    },
    {
      "field": "unsubscribes",
      "message": "Either suppression_group_id or custom_unsubscribe_url may be set/used, but not both. Please remove one before setting the other."
    },
    {
      "field": null,
      "message": "The JSON you have submitted cannot be parsed."
    },
    {
      "field": null,
      "message": "You've reached your limit of 250 campaigns. Please delete one or more and try again."
    }
  ]
}
{}
Query Parameter NameExample
limit44257035
offset-71090691
Header NameExample
on-behalf-of"qui anim Duis"
Request Payload
Response Payload
{
  "result": [
    {
      "id": 986724,
      "title": "March Newsletter",
      "subject": "New Products for Spring!",
      "sender_id": 124451,
      "list_ids": [
        110,
        124
      ],
      "segment_ids": [
        110
      ],
      "categories": [
        "spring line"
      ],
      "suppression_group_id": 42,
      "custom_unsubscribe_url": "",
      "ip_pool": "marketing",
      "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
      "plain_content": "Check out our spring line!",
      "status": "Draft"
    },
    {
      "id": 986723,
      "title": "February Newsletter",
      "subject": "Final Winter Product Sale!",
      "sender_id": 124451,
      "list_ids": [
        110,
        124
      ],
      "segment_ids": [
        110
      ],
      "categories": [
        "winter line"
      ],
      "suppression_group_id": 42,
      "custom_unsubscribe_url": "",
      "ip_pool": "marketing",
      "html_content": "<html><head><title></title></head><body><p>Last call for winter clothes!</p></body></html>",
      "plain_content": "Last call for winter clothes!",
      "status": "Sent"
    }
  ]
}
Header NameExample
on-behalf-of"sed non laborum"
Request Payload
Response Payload
{
  "categories": [
    "spring line"
  ],
  "custom_unsubscribe_url": "",
  "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
  "id": 986724,
  "ip_pool": "marketing",
  "list_ids": [
    110
  ],
  "plain_content": "Check out our spring line!",
  "segment_ids": [
    110
  ],
  "sender_id": 124451,
  "status": "Draft",
  "subject": "New Products for Spring!",
  "suppression_group_id": 42,
  "title": "March Newsletter"
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"veniam nisi cupidatat labore"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"pariatur aliqua"
Request Payload
{
  "title": "May Newsletter",
  "subject": "New Products for Summer!",
  "categories": [
    "summer line"
  ],
  "html_content": "<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>",
  "plain_content": "Check out our summer line!"
}
Response Payload
{
  "id": 986724,
  "title": "May Newsletter",
  "subject": "New Products for Summer!",
  "sender_id": 124451,
  "list_ids": [
    110,
    124
  ],
  "segment_ids": [
    110
  ],
  "categories": [
    "summer line"
  ],
  "suppression_group_id": 42,
  "custom_unsubscribe_url": "",
  "ip_pool": "marketing",
  "html_content": "<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>",
  "plain_content": "Check out our summer line!",
  "status": "Draft"
}
{
  "errors": [
    {
      "field": "title",
      "message": "title can't be blank"
    },
    {
      "field": "title",
      "message": "title is too long (maximum is 100 characters)"
    },
    {
      "field": "categories",
      "message": "categories exceeds 10 category limit"
    },
    {
      "field": "html_content",
      "message": "html_content exceeds the 1MB limit"
    },
    {
      "field": "plain_content",
      "message": "plain_content exceeds the 1MB limit"
    },
    {
      "field": "sender_id",
      "message": "sender_id does not exist"
    },
    {
      "field": "sender_id",
      "message": "sender_id is not a verified sender identity"
    },
    {
      "field": "list_ids",
      "message": "list_ids do not all exist"
    },
    {
      "field": "segment_ids",
      "message": "segment_ids do not all exist"
    },
    {
      "field": "ip_pool",
      "message": "The ip pool you provided is invalid"
    },
    {
      "field": "suppression_group_id",
      "message": "suppression_group_id does not exist"
    },
    {
      "field": "unsubscribes",
      "message": "Either suppression_group_id or custom_unsubscribe_url may be set/used, but not both. Please remove one before setting the other."
    },
    {
      "field": null,
      "message": "The JSON you have submitted cannot be parsed."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "You may only update a campaign when it is in draft mode."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"nisi magna ut"
Request Payload
Response Payload
{
  "id": 1234,
  "status": "Scheduled"
}
{
  "errors": [
    {
      "field": "subject",
      "message": "subject can't be blank"
    },
    {
      "field": "sender_id",
      "message": "sender_id can't be blank"
    },
    {
      "field": "plain_content",
      "message": "plain_content can't be blank, please provide plain text or html content"
    },
    {
      "field": "list_id",
      "message": "You must select at least 1 segment or 1 list to send to."
    },
    {
      "field": "unsubscribe_tag",
      "message": "An [unsubscribe] tag in both your html and plain content is required to send a campaign."
    },
    {
      "field": "suppression_group_id",
      "message": "Either a suppression_group_id or custom_unsubscribe_url is required to send a campaign."
    },
    {
      "field": null,
      "message": "You do not have enough credits to send this campaign. Upgrade your plan to send more: https://app.sendgrid.com/settings/billing"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "You may only send a campaign when it is in draft mode."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"tempor eu dolore nostrud ut"
Request Payload
{
  "send_at": 1489771528
}
Response Payload
{
  "id": 1234,
  "send_at": 1489771528,
  "status": "Scheduled"
}
{
  "errors": [
    {
      "field": "subject",
      "message": "subject can't be blank"
    },
    {
      "field": "sender_id",
      "message": "sender_id can't be blank"
    },
    {
      "field": "plain_content",
      "message": "plain_content can't be blank, please provide plain text or html content"
    },
    {
      "field": "list_id",
      "message": "You must select at least 1 segment or 1 list to send to."
    },
    {
      "field": "unsubscribe_tag",
      "message": "An [unsubscribe] tag in both your html and plain content is required to send a campaign."
    },
    {
      "field": "suppression_group_id",
      "message": "Either a suppression_group_id or custom_unsubscribe_url is required to send a campaign."
    },
    {
      "field": null,
      "message": "You do not have enough credits to send this campaign. Upgrade your plan to send more: https://app.sendgrid.com/settings/billing"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "You cannot POST to a campaign that has already sent or scheduled. However you can update a scheduled campaign with a PATCH."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"reprehenderit"
Request Payload
{
  "send_at": 1489451436
}
Response Payload
{
  "id": -5187400,
  "send_at": -30367655,
  "status": "sint non aliqua"
}
{
  "errors": [
    {
      "field": "send_at",
      "message": "Please choose a future time for sending your campaign."
    },
    {
      "field": null,
      "message": "The JSON you have submitted cannot be parsed."
    },
    {
      "field": null,
      "message": "You do not have enough credits to send this campaign. Upgrade your plan to send https://app.sendgrid.com/settings/billing"
    }
  ]
}
{
  "errors": [
    {
      "field": "send_at",
      "message": "You cannot update the send_at value of non-scheduled campaign."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"aliquip"
Request Payload
Response Payload
{
  "send_at": 1490778528
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"nisi dolore labore dolor proident"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "This campaign is already In Progress."
    },
    {
      "field": null,
      "message": "This campaign is already Sent."
    },
    {
      "field": null,
      "message": "This campaign is already Paused."
    },
    {
      "field": null,
      "message": "This campaign is already Canceled."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"et est pariatur ullamco cillum"
Request Payload
{
  "to": "your.email@example.com"
}
Response Payload
{
  "to": "esse sunt dolor"
}
{
  "errors": [
    {
      "field": "send_at",
      "message": "Please choose a future time for sending your campaign."
    },
    {
      "field": null,
      "message": "The JSON you have submitted cannot be parsed."
    },
    {
      "field": null,
      "message": "You do not have enough credits to send this campaign. Upgrade your plan to send more: https://app.sendgrid.com/settings/billing"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}

Transactional Templates(6 operations)

Header NameExample
on-behalf-of"adipisicing dolore ipsum ad"
Request Payload
{
  "name": "example_name",
  "generation": "dynamic"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "example_name",
  "generation": "legacy",
  "versions": []
}
Query Parameter NameExample
generationslegacy,dynamic
page_size*195.97624497011876
page_tokenesse
Header NameExample
on-behalf-of"Excepteur veniam minim"
Request Payload
Response Payload
{
  "result": [
    {
      "id": "fae7c985-eb92-4b47-9987-28ec29dbc698",
      "name": "example_name",
      "generation": "legacy",
      "updated_at ": "2020-11-12 12:00:09",
      "versions": []
    }
  ],
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/templates",
    "count": 1
  }
}
{
  "errors": [
    {
      "": "reprehenderit velit ad nostrud",
      "message": "sint in irure dolor",
      "error_id": "ipsum"
    }
  ]
}
Header NameExample
on-behalf-of"ullamco"
Request Payload
{
  "name": "example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa2371",
  "name": "example_name",
  "generation": "dynamic",
  "updated_at ": "2019-03-13T11:52:41.009Z",
  "versions": []
}
Header NameExample
on-behalf-of"dolore reprehenderit"
Request Payload
Response Payload
{
  "id": "40da60e6-66f3-4223-9406-ba58b7f55a62",
  "name": "Duis in dolor",
  "generation": "legacy",
  "updated_at ": "2020-12-12 58:26:65",
  "versions": []
}
Header NameExample
on-behalf-of"sed adipisicing"
Request Payload
{
  "name": "new_example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "new_example_name",
  "versions": []
}
Header NameExample
on-behalf-of"ipsum in ut minim qui"
Request Payload
Response Payload
{}

Transactional Templates Versions(5 operations)

Header NameExample
on-behalf-of"adipisicing nisi eu"
Request Payload
{
  "active": 1,
  "name": "example_version_name",
  "html_content": "<HTML body content>",
  "plain_content": "Plain text content",
  "generate_plain_content": false,
  "subject": "<Subject>",
  "editor": "design"
}
Response Payload
{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
  "active": 1,
  "name": "example_version_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "generate_plain_content": true,
  "subject": "<%subject%>",
  "updated_at": "2019-03-13 18:56:33",
  "editor": "code"
}
Header NameExample
on-behalf-of"consequat veniam deserunt amet"
Request Payload
Response Payload
{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
  "active": 1,
  "name": "example_version_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "generate_plain_content": true,
  "subject": "<%subject%>",
  "updated_at": "2019-03-13 18:56:33",
  "editor": "code"
}
Header NameExample
on-behalf-of"commodo et Ut in"
Request Payload
Response Payload
{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
  "active": 1,
  "name": "example_version_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "generate_plain_content": true,
  "subject": "<%subject%>",
  "updated_at": "2019-03-13 18:56:33",
  "editor": "code"
}
Header NameExample
on-behalf-of"do id cupidatat officia non"
Request Payload
{
  "template_id": "Excepteur Ut qui",
  "active": 1,
  "name": "pariatur non incididunt commodo",
  "html_content": "dolor",
  "generate_plain_content": false,
  "subject": "aliquip nulla Ut",
  "editor": "design",
  "plain_content": "labore dolore"
}
Response Payload
{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
  "active": 1,
  "name": "example_version_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "generate_plain_content": true,
  "subject": "<%subject%>",
  "updated_at": "2019-03-13 18:56:33",
  "editor": "code"
}
Header NameExample
on-behalf-of"adipisicing ullamco pariatur"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

Webhooks(7 operations)

Header NameExample
on-behalf-of"irure enim sed"
Request Payload
Response Payload
{
  "enabled": false,
  "url": "incididunt reprehenderit",
  "group_resubscribe": false,
  "delivered": false,
  "group_unsubscribe": false,
  "spam_report": false,
  "bounce": false,
  "deferred": false,
  "unsubscribe": true,
  "processed": false,
  "open": true,
  "click": true,
  "dropped": true,
  "oauth_client_id": "est fugiat",
  "oauth_token_url": "Duis in laborum sunt"
}
Header NameExample
on-behalf-of"deserunt incididunt consectetur sint in"
Request Payload
{
  "enabled": false,
  "url": "id aliqua",
  "group_resubscribe": true,
  "delivered": false,
  "group_unsubscribe": true,
  "spam_report": true,
  "bounce": false,
  "deferred": false,
  "unsubscribe": true,
  "processed": false,
  "open": false,
  "click": false,
  "dropped": false,
  "oauth_client_id": "reprehenderit in null",
  "oauth_client_secret": "ea in nostrud",
  "oauth_token_url": "cupidatat ad Ut"
}
Response Payload
{
  "enabled": true,
  "url": "mollit laborum",
  "group_resubscribe": false,
  "delivered": true,
  "group_unsubscribe": true,
  "spam_report": true,
  "bounce": true,
  "deferred": true,
  "unsubscribe": true,
  "processed": true,
  "open": true,
  "click": false,
  "dropped": true,
  "oauth_client_id": "anim sunt",
  "oauth_token_url": "ex"
}
Header NameExample
on-behalf-of"aliqua nulla incididunt"
Request Payload
Response Payload
{
  "result": [
    {
      "url": "http://mydomain.com/parse",
      "hostname": "mail.mydomain.com",
      "spam_check": true,
      "send_raw": true
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "aliquip adipisicing officia"
    },
    {
      "message": "exercitation"
    },
    {
      "message": "Ut quis id laborum voluptate"
    }
  ]
}
Query Parameter NameExample
limitincididunt cupidatat sint ea
offsetquis
aggregated_byweek
start_date*sit ipsum cupidatat
end_datenulla ad ea
Header NameExample
on-behalf-of"aliqua occaecat commodo"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  }
]
Header NameExample
on-behalf-of"ullamco"
Request Payload
Response Payload
{
  "public_key": "anim quis in sint"
}
Header NameExample
on-behalf-of"dolore laboris"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "public_key": "voluptate id Excepteur proident"
}
{
  "errors": [
    {
      "message": "mollit consequat dolore commodo",
      "field": "anim Ut"
    },
    {
      "message": "qui"
    },
    {
      "message": "commodo dolor ipsum"
    },
    {
      "message": "minim fugiat amet",
      "field": "quis consectetur eiusmod ullamco laboris"
    }
  ]
}
{
  "errors": [
    {
      "message": "fugiat",
      "field": "in proident"
    },
    {
      "message": "adipisicing veniam laboris sunt ullamco",
      "field": "ut"
    },
    {
      "message": "id sunt consequat Duis irure"
    },
    {
      "message": "nisi",
      "field": "in qui"
    },
    {
      "message": "tempor in eiusmod elit"
    }
  ]
}
{
  "errors": [
    {
      "message": "Excepteur culpa esse ea ut"
    },
    {
      "message": "enim Excepteur dolore dolore"
    },
    {
      "message": "dolor occaecat"
    }
  ]
}
Header NameExample
on-behalf-of"Ut sed deserunt"
Request Payload
{
  "url": "mollit non ipsum magna",
  "oauth_client_id": "nisi",
  "oauth_client_secret": "veniam commodo ex sunt",
  "oauth_token_url": "dolor Duis"
}
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

Settings - Inbound Parse(4 operations)

Header NameExample
on-behalf-of"incididunt amet aliquip irure"
Request Payload
{
  "url": "http://email.myhostname.com",
  "hostname": "myhostname.com",
  "spam_check": false,
  "send_raw": true
}
Response Payload
{
  "url": "http://email.myhostname.com",
  "hostname": "myhostname.com",
  "spam_check": false,
  "send_raw": true
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "velit magna dolore"
    },
    {
      "message": "fugiat"
    },
    {
      "message": "occaecat"
    },
    {
      "message": "in amet fugiat"
    },
    {
      "message": "in aliquip eiusmod"
    }
  ]
}
Header NameExample
on-behalf-of"dolor nisi ex ea"
Request Payload
Response Payload
{
  "url": "http://mydomain.com/parse",
  "hostname": "mail.mydomain.com",
  "spam_check": true,
  "send_raw": true
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "esse quis"
    },
    {
      "message": "velit nisi anim"
    }
  ]
}
Header NameExample
on-behalf-of"nulla"
Request Payload
{
  "url": "http://email.myhostname.com",
  "hostname": "myhostname.com",
  "spam_check": false,
  "send_raw": true
}
Response Payload
{
  "url": "http://mydomain.com/parse",
  "hostname": "mail.mydomain.com",
  "spam_check": true,
  "send_raw": true
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "incididunt"
    },
    {
      "message": "exercitation laboris officia veniam id"
    },
    {
      "message": "velit ea ipsum officia"
    }
  ]
}
Header NameExample
on-behalf-of"dolore do"
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "aliquip occaecat ullamco nulla"
    },
    {
      "message": "Duis exercitation consequat pariatur"
    },
    {
      "message": "enim esse Ut consectetur dolore"
    },
    {
      "message": "pariatur elit irure"
    }
  ]
}

Query(2 operations)

Query Parameter NameExample
query*enim
limit23.32455187735492
Header NameExample
X-Query-Id"pariatur veniam commodo consectetur"
X-Cursor"veniam"
Authorization*"adipisicing"
Request Payload
Response Payload
{
  "messages": [
    {
      "from_email": "from@test.com",
      "msg_id": "abc123",
      "subject": "something profound",
      "to_email": "to@test.com",
      "status": "processed",
      "opens_count": 0,
      "clicks_count": 0,
      "last_event_time": 1495064728,
      "last_timestamp": 1495064728
    },
    {
      "from_email": "yeah@test.com",
      "msg_id": "321befe",
      "subject": "something profound",
      "to_email": "nah@test.com",
      "status": "delivered",
      "opens_count": 500,
      "clicks_count": 200,
      "last_event_time": 1495064793,
      "last_timestamp": 1495064793
    },
    {
      "from_email": "sad@test.com",
      "msg_id": "434512dfg",
      "subject": "something sad",
      "to_email": "reject@test.com",
      "status": "not delivered",
      "opens_count": 0,
      "clicks_count": 0,
      "last_event_time": 1495064993,
      "last_timestamp": 1495064993
    }
  ]
}
{
  "errors": [
    {
      "message": "invalid syntax: 'bad_field' is not a known field"
    }
  ]
}
{
  "errors": [
    {
      "message": "too many requests"
    }
  ]
}
Header NameExample
Authorization*"in"
Request Payload
Response Payload
{
  "from_email": "LKb.pOGYIZbfxMgi7Le0K1YWym%e5pz2PiuGbwByM2tR+wRPqfoFg1__35DaWF8CDhzYJg@ZTSFDjbgdxD23oq34Lun1NUnyymoGT4G.5i1IEzQpXWAvNwx.BNckAJiBCnwEVnwBfrbMlouoOPmtTSEbdPp",
  "msg_id": "hznSfJ1RfKeIKS1B4mShNnkRMpdt5IXXKf",
  "subject": "culpa aute amet magna sint",
  "to_email": "+lOnUtHodefMsuBw.kunNalfcxRos5USSRoR@r5uEXYPP6wrQGRQ-vBg33fLY6MVkkMd-DKT8Z1iqt4qnrL23xMOZ8GWd.fyghGEFceTHIUpgwNGlwEtFHJikSaPzsnYfrJPKydPVPAlItJtqykRHZSGW",
  "status": "delivered",
  "template_id": "d674d9b7-e8e5-4e30-87be-1b3b026235fd",
  "asm_group_id": 5464443,
  "teammate": "9a8F0EP88wSSJeuOyXtbfc7BkK",
  "api_key_id": "bUshz3LGa3coToxA2sWViYAEJJmYZJRyY9BCQY",
  "events": [
    {
      "event_name": "unsubscribe",
      "processed": 7085461846,
      "bounce_type": "soft",
      "http_user_agent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0",
      "mx_server": "s",
      "attempt_num": 8
    },
    {
      "event_name": "dropped",
      "processed": 9878933331,
      "attempt_num": 3,
      "url": "G_3c-1HtUkN4`puC&&!u>0OiStFG.ZoRi2=j%fUVa]&re6k{hKqD-8vWE<hw-Bd>12Fb5JC6z>S@@'cWS~w5KtuIwv$8/JDD94CXx1n5yjC_I2lQ66zDj4MXe/4bqlcqqQ7evnQWTYx5roaEYMapyuzb/USpsyalh/HcYc9PmQfF8ND_C7bXnwFQ_fb_BHMXbIV8JN28/NjZdawDJ6kSWxLykSVTHzcISGPBRfs_rt3Uc65Vzj6LDSSMN8WRs70m0tAWs/fkDvjvm_7ZeV08YZeB9j9mS9BcE089Fn5UzDlTJW9vqDF5uipjlIVrNbM7oWE/MIJcjg2vJO20jA24WHrchrEXCvKcxriviSDl3tuyDxqdqRSekpm2aH6yW7_ylXj/nWsex4jm3rKvYw1uLq3Tp7qb9edhj8B_TnwLv1yjHSkgbA5jKI4BTqxugmwVTnFf2OFCFp/ZILLkoKgfwOyIK4reUIkhCjuhkwp/cqGaFAkeCFQXPB6DLYesLZ2M3KPuBsBrs3pr3HRbTtwaOzdKtGc8e0C0VTjrJ3GwljStMPrSuQWh6/vigHRasZ4P9kFv5DPVbHWZzPvtwUw0AMByt44YH678WpbAXXy4I/IVOHmErZTbw1mJ/3vd4uI5rr2zEO_YA9qJZLJT/wmBimbOyaMtmTNYr_FhgfkKMN3_1la7RCK8CIP3p26mbuHbdJV1j/5sTIKibInM5l2BoWdEi49bPqzagsfjKpGVbg0YQ8mjrLhI92/qy0eVYi34kBGVuLzxK2FLC8vwYUrbupjUYE23Mc_6nmHYRK1HF1QmZDZG1hw96I3MPbTZqeJOWGch230qDNxOgnHRNNM52k/3c7FeuRr88RwZGpif/4FaSAbdqkUNvJ9J9qX2tJS9x5vZlgD8k4YHIXDztrnwg2VPquj/uo_2MjbWybIF/NGJM2RFAsKV1S5iOejuTV4p12KlH1p0Dt5EpxCSIl0XoWuvyLYar77f_hzqNdWAyL0FDxGfj4ma4jwqdTTLNyeZEtguYoCHTFfY/HgJkpHx/yO23G7gLhKPvD459ceffHidFh7LipTxNF0GFXhIAPrWfhv7PkPmVofBoFFlo6/rMcHQ82d5VS8i1CCyLtfuT5WH9GqrsOY7xo3lxi7BNL93/PLRdQT3SObRFRERw68V5ZFvIuEQqFOFZQ848rWPLXYDGY658dyjZALf/Ug4EROi_ehNtzPwecer_RGBHxeMnpxrPAFZEL6YXNKzm8hh3HY4Uc4fgkjge5fXsR4CeTSkS66/FOD00deDKmN7XcHEj1LGlAmd4XlV8vFpXg2VazX4OLW8z6vXn5vntNGYO6eBCEKUwupRz9nQSMeZ/Pbmjoopyt6TxQBUfPkHBdgCIhqA1zDV72ARqGlK_ao9KVjvgbB98YeiieIyogkuOa4y0E5iUEdBopzovVgtY88yLijh9ww/tl0R5rI2P2_OxguTbv_wrfEm8jRjISEIqSE9q29RB3n8PeD4hu24rcsaEuTMCqniiLN0a2OtZiKxHnbsNB660Aq3/tEo2SHZBkkIFYXBbDNE7gLfvFz9ZaC_E2oV2quyK1Id5SkNkJBVRRgROWBc_XEOXktc4vRUKxy1MQ526Xilyo8/uI67lHH1Vlr4V3GVmweT4A16KMqzmVzvRDRFLpkBv2iu3Okc1vIqkC/426aOqeUm6SXIx16d8BWVRcmqKqizxDEF3JkLFgX0ab73CZ4GdJ9YaakJO7y4adFGzzIVLcn08UZ/pwDQ9BAuwuMc2yMnKihdvmLKbnAa1ATk9jFXQ9QAEMBHZLbPNvtS3pkpk0s6fyh2ceHa9Myy3fL/oqvPmq_14KzLgPZHaOlyb3tUoQM52fv/I78TqTGyB4WYD_vkm8gYHZcCF0dFIXsiXUbAbwR90Ldk8lsgxSL6rBvjPSlQq7N66NPzUVRYr3zSISupG_66uS4rJszHwmxmmraT3/zfVKxHXFHgxUDRmnwIMfdFKm4sf/qnRRccOLExJYGcZy8u65jo4gHDvO6vnpsdf0YtVWqDBJXa95/Y/qL7EYS73_t6/2xnWra9TTO0OtQNXEQ1XXLSLt6vPw1FTlE2aYCitDgUo7DyxiwuGtvmMKUkYCo/lqXouo2TGXZFF80lrCu1vKdxBgOOerlrsKrOJawGEzL8XzXdxkOMUT8HOzHPNOvDwsxc47mvpVzXEbX5DRaioOlm2U4flTG/6bZfLqJqHNtrKwC5U5NNG6_yNOW5Jg_bLmzUosi86IXxn7i04vRXXn92JmdE70TcdujehT1n15wtiD8ld5A65IV2W1801/wr0XcDIGiUSmxFfCozUCtBTFwln0uJ0cquSDXhj7JQADhYDGyz8WhqcPE7CP9xN93EUBrWczINbA4IsfckY8CZh68/Tak5dEhw8i_3rz/8U39D/iML1G_A8TsnKQ9/_S8o89fFc7Wx/f1nXF8H6OLVbPpp5IZg7UTZ2K0bSe3iBpsmkkJpxY_6zEHTJE3LbIANwF9Ik5Tu0ZJpjck7I07xlHR8mDW9FXclSQC/qJUGL5qByf2SY2Wd24hqKGrahLfqApQuRI8_DtU/Y8kH6DDif5kD6as3sIe6VbKYnU9c1URq/npTlE72m107FXxW9zktdzbBJAxt4udMFzjt2LPcBpqrMKGkrg4BHqKXwhFTspCWyYCjxJ/eFb3fd3BB5kb9D0yl3oOjeWtbJBqsboyzdLisRBn2MCtXO2O8eo4Hkm/2uJDoRjRCyIi2GNRkH0B3EkN6Z3vG40C985bAtM8eqHABzP2QRcKCz4ICOw_Xz249bJk8qM0/m4EeIWnx2ISf9TBU6_0KZ5QJ0VPOCPXxV9jCeK5W5/RV5nd7GUUXG0btDqUAa3DzpaRHX3klMAqL73hK4AGD3ItikmxF8vnSaqtsgOCpEePERt9qcUOJJP2aR0scPAf_1TkGSrgr5VF/XLM2i7YhC_3J9fA2Qwa0dbTedY/xGayjimEkuWSWvh7P5FNOum_l7qJPnA31lQq6ixqR0NKhO328rWfijqKHF6WR/5O0MJ4WNuIXk6xBtTOA9mK7CGUgWjaF5mB72PVnDpN8G6ERO39GqO/fCO96/A1mwIPWedF6HklU8jaQ_M5EUzwCsBE3/7FW2hbcD3GCOFCiLvObjn59o6CKoYlmTop/PZw2CLzvARAr5KaLhjIuZRSKTGlmYjvSoSELuvWi/QHUV7SJ0kF_1O3b_3a88cm/z7qD3Rp6MmoQdGPSyu1lXTpoETypgOMywfsr4ycV2LQr5XaE3UrQP/RzobA4rI_I3ceCUaRASmil2rV1TUiyljhdCFt8zmi1o2NyTzSBRNGP0lXU5Qtm6dKKp7lGRC19P2oSSFrxt85vWRNo1mv8odcL/TF7/MN1Ev7gY20MqlRSBrlwg5LZ4_Az7QnBnpbU3LkTC/oVb743VFtXMW4cK/3lw6wfBJZe_8DobxT_6/gCXp6QOs/LuqmrQHMQvTS6jfbqVFnPfLjrQ01Mb_F4lr3md6m87wpc1CYd9hdzgUL/aqz68HMDCxjGauC00Rajq9wGVYcWJ3j6rIaHIPwclftjARXFDg0yH8v/L6qDgIgGwbB3eZfjOXHAMXRFNMMihseZxYkcFAzLtYr94q9XpQeK4bKi9h_rWAMwcEHnS8/MHHlySbgy8azGEA0u9xsY96MRi45Qe74kZ9xlsI1t4Yutx8/gsjIiu7vNsKEyeTwd88BMExjWNcJHOSHRff57pJBMEAtPdbMETYorvUkRyErsqprxX0W45n0RRQ85w/JCOsYaxZOAFfzO0AdLpMCguFwl01fkFOKYrQeXfNn8w0KF4XS0k/fPx02fU7fFjUoXcPH7_9xo755WL8DNIU2ne4b6DpiROe473yUfD8_zSNUI1tpxzVYNA7GvVSYt8UtqHn3/_QwuOc4VeAI6RiAG5O5bcAxzQl96Q35emNwtTT_CYqHORCmyPj6By2hT_SCLf8m_xFxxe3YzvnxDZGq3qf__pq7Tw181/GosBAJy3MotiIxcYDASbY9sV4T2V/KoGHyJ64spdkQbJOHJ216JMSKj8ii5m8gxqJ2ypL81p5hbjWtjbUgSc8M_KTLuc0Owf1R/3vr/dKbQ2pJ4XEfXhnZTBQY7ZrClnVCnd5cMe9ic/aNF0yyOSQVVOecUFkK9IYFVR8VHdVf4/Nfu3nOEskHki1_r3At1HLOMniS6qNTvhS0hfqIuBiQBsd5aB7OdfVpYy1HdIR72gMToBlpHPsE5GrVO0J9/gcyB2xcyZ3UpTom8G3V48LUkk6kcJ6l1SL5Fgzbst0z3pDA4dzBfswbC8dW57_MkswDANNd8atPrOBSU5m2z66dP/mIYQ8iq/DcmBexkARDI47VzYuw5gwy8Lvym2_B2gxBokU9_T/fHCPjlpqjTsY6SgBOz1nlDh_HcSWYAqnyrZxbEO2erVJ4WPKNzjM3KaPXGH/dZryna1E28wxCrMqLCs9aL9oVBlDMjUcEryAyRh7xwN0uWGopdpkd7Du6O9EPjAj37sHkUiVs7WL6JyexoDF_n67MICvQnJ9FK/FVrp1uMZnmr7ijkMW87moNRBkXbVc2EA_hHOHmpbVGqr6WgNtJ7bBk1LrAPT8sKtE75vbe_L9VYqBHJ/njk.WIIj-V23pwC7ZahcIL0XnDPupL7ltwEc779Ofhrk9dt_wIOFsA8XwnCjrYqH2ty.F0XdS\"*;@kDYgfL4dwE/5I@>k|u0D:wGz\"_8=}RJM!Ybbwd}eN=ZB*esF&(iQ%FW]_FSA:3Ze4O*6&tG-Fe**/j^a&S8zIa#6gxL2NmnNMSVGF-Bf3z08tt0ug_UfNshhs4HJh0l1o24gjAN-Uck1OvWkGQSXH0glB7CnOm0gI",
      "bounce_type": "soft",
      "mx_server": "laborum nisi",
      "http_user_agent": "quis re"
    }
  ],
  "originating_ip": "204.173.18.0",
  "categories": [
    "dolor",
    "pie"
  ],
  "unique_args": "eu",
  "outbound_ip": "181.40.184.87",
  "outbound_ip_type": "dedicated",
  "id": "2mMUdxV2HRfAeDiBTYs2IP"
}
{
  "errors": [
    {
      "message": "invalid syntax: 'bad_field' is not a known field"
    }
  ]
}
{
  "errors": [
    {
      "message": "not found",
      "field": "message_id"
    }
  ]
}
{
  "errors": [
    {
      "message": "too many requests"
    }
  ]
}

CSV (UI only)(2 operations)

Query Parameter NameExample
queryadipisicing sunt laborum id ut
Header NameExample
Authorization*"voluptate"
Request Payload
Response Payload
{
  "status": "pending",
  "message": "An email will be sent to jane_doe@example.com when the CSV is ready to download."
}
{
  "errors": [
    {
      "message": "some error"
    }
  ]
}
{
  "errors": [
    {
      "message": "too many requests",
      "field": ""
    }
  ]
}
{
  "errors": [
    {
      "message": "internal server error"
    }
  ]
}
Header NameExample
Authorization*"enim ullamco tempor reprehenderit"
Request Payload
Response Payload
{
  "presigned_url": "https://example.com",
  "csv": "https://s3-us-west-2.amazonaws.com/sendgrid-rts-development-queries/013c31af-7c9a-49e6-922c-d990f4aff151.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Credential=AKIAI4NOW7APZHRFYGWQ%2F20170728%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-SignedHeaders=host&X-Amz-Date=20170728T223936Z&X-Amz-Signature=5c13ede58b211799ab1a556280bd316c404eac3aef1450c47906a077166c4ab4"
}
{
  "errors": [
    {
      "message": "download token is invalid or expired",
      "field": ""
    }
  ]
}
{
  "errors": [
    {
      "message": "internal server error"
    }
  ]
}

Settings - Tracking(9 operations)

Header NameExample
on-behalf-of"fugiat Ut ex occaecat Duis"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "open",
      "title": "Open Tracking",
      "description": "lorem ipsum... .",
      "enabled": true
    }
  ]
}
Header NameExample
on-behalf-of"ut nisi enim deserunt eu"
Request Payload
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"ipsum non nulla"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"laboris veniam ex sunt reprehenderit"
Request Payload
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"ullamco voluptate"
Request Payload
{
  "enabled": true,
  "utm_source": "sendgrid.com",
  "utm_medium": "email",
  "utm_term": "",
  "utm_content": "",
  "utm_campaign": "website"
}
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"qui consequat aute"
Request Payload
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"id laboris dolore dolore"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"enim"
Request Payload
Response Payload
{
  "enabled": true,
  "html_content": "<p>Something something unsubscribe <% %> something something</p>\n",
  "landing": "<p>subscribehere</p>\n",
  "plain_content": "Something something unsubscribe <% %> something something",
  "replace": "thetag",
  "url": ""
}
Header NameExample
on-behalf-of"reprehenderit quis"
Request Payload
{
  "enabled": true,
  "landing": "landing page html",
  "url": "url",
  "replace": "replacement tag",
  "html_content": "html content",
  "plain_content": "text content"
}
Response Payload
{
  "enabled": true,
  "landing": "landing page html",
  "url": "url",
  "replace": "replacement tag",
  "html_content": "html content",
  "plain_content": "text content"
}

Stats(7 operations)

Query Parameter NameExample
limit22431319
offset99263088
aggregated_bymonth
start_date*sunt nisi mollit fugiat
end_dateofficia
Header NameExample
on-behalf-of"consectetur"
Request Payload
Response Payload
[
  {
    "date": "2015-11-03",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
countryUS
limit9853360
offset-72484479
aggregated_byday
start_date*Duis aliqua mollit amet ex
end_datefugiat magna ea ullamco
Header NameExample
on-behalf-of"proident adipisicing nostrud Duis"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 1,
          "unique_clicks": 0,
          "unique_opens": 1
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
limit82705842
offset-94453498
aggregated_byweek
start_date*ad exercitation et proident
end_datedolor culpa
Header NameExample
on-behalf-of"Duis qui aliquip pariatur"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 2,
          "unique_opens": 2
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
start_date*ut eu ullamco dolor
end_dateconsequat ut cupidatat fugiat
aggregated_byweek
Header NameExample
on-behalf-of"laboris"
Request Payload
Response Payload
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  }
]
Query Parameter NameExample
start_date*ad occaecat eiusmod officia Lorem
end_datedolore in officia
aggregated_byday
Header NameExample
on-behalf-of"qui ipsum sed et"
Request Payload
Response Payload
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  }
]
Query Parameter NameExample
mailbox_providersmagna deserunt
limit-99997450
offset-5242376
aggregated_byweek
start_date*tempor minim
end_datealiqua veniam est in labore
Header NameExample
on-behalf-of"incididunt in pariatur Lorem"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 1,
          "drops": 0,
          "opens": 1,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 1
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 2,
          "drops": 0,
          "opens": 2,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 2
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
browserslaborum
limit87435580
offset64973143
aggregated_byweek
start_date*Excepteur nisi magna dolor
end_dateesse
Header NameExample
on-behalf-of"esse sint minim et aliqua"
Request Payload
Response Payload
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "clicks": 0,
          "unique_clicks": 0
        },
        "name": "Chrome",
        "type": "browser"
      },
      {
        "metrics": {
          "clicks": 1,
          "unique_clicks": 1
        },
        "name": "Firefox",
        "type": "browser"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "clicks": 0,
          "unique_clicks": 0
        },
        "name": "Chrome",
        "type": "browser"
      },
      {
        "metrics": {
          "clicks": 1,
          "unique_clicks": 1
        },
        "name": "Firefox",
        "type": "browser"
      }
    ]
  }
]

Bounces API(4 operations)

Query Parameter NameExample
start_time93359131
end_time79261665
Header NameExample
Accept*"in ad minim"
on-behalf-of"exercitation"
Request Payload
Response Payload
[
  {
    "created": 1250337600,
    "email": "example@example.com",
    "reason": "550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at  https://support.google.com/mail/answer/6596 o186si2389584ioe.63 - gsmtp ",
    "status": "5.1.1"
  },
  {
    "created": 1250337600,
    "email": "example@example.com",
    "reason": "550 5.1.1 <testemail2@testing.com>: Recipient address rejected: User unknown in virtual alias table ",
    "status": "5.1.1"
  }
]
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Header NameExample
on-behalf-of"mollit amet"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example@example.com",
    "example2@example.com"
  ]
}
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"consequat"
Request Payload
Response Payload
[
  {
    "created": 1443651125,
    "email": "bounce1@test.com",
    "reason": "550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at  https://support.google.com/mail/answer/6596 o186si2389584ioe.63 - gsmtp ",
    "status": "5.1.1"
  }
]
Query Parameter NameExample
email_address*CtOtO2mek4-uSIZ@OTCkqtoyGCBNigcSUeTJDB.ztrn
Header NameExample
on-behalf-of"laborum elit"
Request Payload
Error generating example
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Blocks API(4 operations)

Query Parameter NameExample
start_time13169540
end_time-90558142
limit44919351
offset-56256354
Header NameExample
on-behalf-of"commodo"
Request Payload
Response Payload
[
  {
    "created": 1443651154,
    "email": "example@example.com",
    "reason": "error dialing remote address: dial tcp 10.57.152.165:25: no route to host",
    "status": "4.0.0"
  },
  {
    "created": 1443651155,
    "email": "example1@example.com",
    "reason": "unable to resolve MX record for example.com: servfail",
    "status": "4.0.0"
  }
]
Header NameExample
on-behalf-of"culpa"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"aliqua"
Request Payload
Response Payload
[
  {
    "created": 1443651154,
    "email": "example@example.com",
    "reason": "error dialing remote address: dial tcp 10.57.152.165:25: no route to host",
    "status": "4.0.0"
  }
]
Header NameExample
on-behalf-of"Ut aliquip sint elit"
Request Payload
Response Payload
{}

Spam Reports API(4 operations)

Query Parameter NameExample
start_time71227732
end_time-43903376
limit-63154276
offset80025353
Header NameExample
on-behalf-of"qui"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com",
    "ip": "10.63.202.100"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com",
    "ip": "10.63.202.100"
  }
]
Header NameExample
on-behalf-of"ex"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"veniam laboris nisi"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "ip": "10.89.32.5"
  }
]
Header NameExample
on-behalf-of"ex nostrud occaecat"
Request Payload
Response Payload
{}

Suppressions - Global Suppressions(4 operations)

Header NameExample
on-behalf-of"velit sunt"
Request Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Response Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Query Parameter NameExample
start_time-19833859
end_time-35444791
limit70564054
offset33429221
Header NameExample
on-behalf-of"in"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com"
  }
]
Header NameExample
on-behalf-of"et"
Request Payload
Response Payload
{
  "recipient_email": "test@example.com"
}
Header NameExample
on-behalf-of"est officia labore ut"
Request Payload
Response Payload
{}

Suppressions - Unsubscribe Groups(5 operations)

Header NameExample
on-behalf-of"dolore"
Request Payload
{
  "name": "Product Suggestions",
  "description": "Suggestions for products our users might like.",
  "is_default": true
}
Response Payload
{
  "id": 103,
  "name": "Product Suggestions",
  "description": "Suggestions for products our users might like.",
  "is_default": false
}
Query Parameter NameExample
id-79116162
Header NameExample
on-behalf-of"veniam enim eu"
Request Payload
Response Payload
[
  {
    "id": 1234,
    "name": "Unsubscribe Group",
    "description": "An Unsubscribe Group",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 1234
  },
  {
    "id": 1234,
    "name": "Unsubscribe Group",
    "description": "An Unsubscribe Group",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 1234
  }
]
Header NameExample
on-behalf-of"eu ad sint"
Request Payload
Response Payload
{
  "description": "Our monthly newsletter.",
  "id": 100,
  "is_default": true,
  "last_email_sent_at": null,
  "name": "Newsletters",
  "unsubscribes": 400
}
Header NameExample
on-behalf-of"adipisicing"
Request Payload
{
  "id": 103,
  "name": "Item Suggestions",
  "description": "Suggestions for items our users might like."
}
Response Payload
{
  "id": 103,
  "name": "Item Suggestions",
  "description": "Suggestions for items our users might like."
}
Header NameExample
on-behalf-of"ad"
Request Payload
Response Payload
{}

Suppressions - Suppressions(6 operations)

Header NameExample
on-behalf-of"voluptate dolor"
Request Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Response Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Header NameExample
on-behalf-of"culpa"
Request Payload
Response Payload
[
  "example@example.com",
  "example2@example.com"
]
Header NameExample
on-behalf-of"est occaecat anim mollit"
Request Payload
{
  "recipient_emails": [
    "exists1@example.com",
    "exists2@example.com",
    "doesnotexists@example.com"
  ]
}
Response Payload
[
  "exists1@example.com",
  "exists2@example.com"
]
Header NameExample
on-behalf-of"do Lorem irure aliquip dolor"
Request Payload
Response Payload
[
  {
    "email": "test1@example.com",
    "group_id": 1,
    "group_name": "Weekly News",
    "created_at": 1410986704
  },
  {
    "email": "test1@example.com",
    "group_id": 2,
    "group_name": "Daily News",
    "created_at": 1411493671
  },
  {
    "email": "test2@example.com",
    "group_id": 2,
    "group_name": "Daily News",
    "created_at": 1411493671
  }
]
Header NameExample
on-behalf-of"sit reprehenderit fugiat"
Request Payload
Response Payload
{
  "suppressions": [
    {
      "description": "Optional description.",
      "id": 1,
      "is_default": true,
      "name": "Weekly News",
      "suppressed": true
    },
    {
      "description": "Some daily news.",
      "id": 2,
      "is_default": true,
      "name": "Daily News",
      "suppressed": true
    },
    {
      "description": "An old group.",
      "id": 2,
      "is_default": false,
      "name": "Old News",
      "suppressed": false
    }
  ]
}
Header NameExample
on-behalf-of"dolore incididunt id"
Request Payload
Response Payload
Error generating example

Invalid Emails API(4 operations)

Query Parameter NameExample
start_time98799789
end_time67156528
limit8116666
offset-1752564
Header NameExample
on-behalf-of"dolor exercitation laborum"
Request Payload
Response Payload
[
  {
    "created": 1449953655,
    "email": "user1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  },
  {
    "created": 1449939373,
    "email": "user2@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]
Header NameExample
on-behalf-of"Duis pariatur aute quis"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"dolore in"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]
Header NameExample
on-behalf-of"pariatur"
Request Payload
Response Payload
{}
Service Homepage: sendgrid.com/en-us
API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started
emails