View All Services

Sendgrid V3 Virtual Sandbox

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.

Use this hosted sandbox to simulate Sendgrid V3 APIs without authentication, API keys, or extra dependencies. Point your code or SDK to the Beeceptor base URL, preferably through an environment variable or feature flag, and switch back to the production API when ready. This keeps your integration code consistent across local development, QA, demos, and production.

Sendgrid V3 virtual sandbox is up and running!

Use this sandbox URL as the API base in your code to simulate Sendgrid V3 responses instantly.

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": "culpa cillum laboris"
    },
    {
      "message": "id cillum dolore consectetur"
    }
  ]
}

Cancel Scheduled Sends(7 operations)

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

API Keys(6 operations)

Header NameExample
on-behalf-of"ut nulla amet"
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": "sit sed pariatur adipisicing"
    },
    {
      "message": "exercitation qui fugiat"
    },
    {
      "message": "occaecat dolore"
    },
    {
      "message": "fugiat dolore sunt Duis"
    },
    {
      "message": "adipisicing dolor consectetur"
    }
  ]
}
Query Parameter NameExample
limit-38017549
Header NameExample
on-behalf-of"ex ea dolor"
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": "adipisicing laborum ut ad"
    },
    {
      "message": "non consequat tempor nisi in"
    }
  ]
}
Header NameExample
on-behalf-of"proident"
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": "sint fugiat"
    },
    {
      "message": "eiusmod"
    },
    {
      "message": "pariatur consequat adipisicing in tempor"
    }
  ]
}
Header NameExample
on-behalf-of"consequat id dolor"
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": "qui"
    },
    {
      "message": "elit veniam laboris ea"
    }
  ]
}
Header NameExample
on-behalf-of"dolore"
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": "reprehenderit Duis velit"
    }
  ]
}
Header NameExample
on-behalf-of"id"
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"
    },
    {
      "message": "veniam eiusmod Duis fugiat in"
    },
    {
      "message": "ut"
    },
    {
      "message": "pariatur anim"
    },
    {
      "message": "do quis laborum sint"
    }
  ]
}

API Key Permissions

Header NameExample
on-behalf-of"consequat est proident nostrud ea"
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": "enim in esse Lorem"
    },
    {
      "message": "ipsum aliquip"
    }
  ]
}

Settings - Enforced TLS(2 operations)

Header NameExample
on-behalf-of"esse minim anim"
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": "tempor Ut deserunt minim"
    },
    {
      "message": "sint deserunt aliqua dolore dolor"
    },
    {
      "message": "aliqua esse adipisicing"
    },
    {
      "message": "exercitation anim eu mollit nostrud"
    },
    {
      "message": "ut sunt culpa"
    }
  ]
}
Header NameExample
on-behalf-of"cupidatat non"
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": "mollit dolor irure voluptate"
    },
    {
      "message": "irure in"
    },
    {
      "message": "consectetur qui"
    }
  ]
}

IP Access Management(6 operations)

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

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
}
[
  {
    "error_id": "do magna Lorem",
    "field": "ipsum",
    "message": "laboris"
  },
  {
    "error_id": "proident sed",
    "field": null,
    "message": "deserunt est"
  }
]
[
  {
    "error_id": "in non commodo",
    "field": null,
    "message": "ipsum ea"
  },
  {
    "error_id": "esse",
    "field": "laborum labore enim non cillum",
    "message": "aute est ad Ut"
  },
  {
    "error_id": "velit",
    "field": null,
    "message": "nostrud ut adipisicing velit ipsum"
  },
  {
    "error_id": "sit eu",
    "field": null,
    "message": "id sit"
  }
]
[
  {
    "error_id": "in sunt dolore adipisicing",
    "field": null,
    "message": "Duis eiusmod"
  },
  {
    "error_id": "ullamco culpa do",
    "field": null,
    "message": "veniam dolor in proident"
  },
  {
    "error_id": "Lorem nisi enim",
    "field": "commodo adipisicing laboris ullamco officia",
    "message": "aliqua eiusmod velit reprehenderit"
  },
  {
    "error_id": "labore adipisicing",
    "field": "minim cillum sed",
    "message": "Duis incididunt proident"
  },
  {
    "error_id": "et",
    "field": "reprehenderit mollit sed ad id",
    "message": "pariatur dolore Duis"
  }
]
[
  {
    "error_id": "incididunt irure amet elit",
    "field": null,
    "message": "aliquip"
  },
  {
    "error_id": "exercitation",
    "field": null,
    "message": "aliquip id"
  },
  {
    "error_id": "fugiat",
    "field": "Excepteur elit deserunt dolor mollit",
    "message": "aute dolor"
  }
]
[
  {
    "error_id": "aute esse aliqua id",
    "field": "officia",
    "message": "Excepteur amet voluptate"
  },
  {
    "error_id": "aute",
    "field": "enim",
    "message": "enim"
  }
]
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": 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"
  }
]
[
  {
    "error_id": "dolore tempor incididunt in",
    "field": "elit id reprehenderit exercitation consectetur",
    "message": "ex proident incididunt nostrud occaecat"
  },
  {
    "error_id": "nisi laborum do ut",
    "field": "elit consequat ipsum pariatur anim",
    "message": "officia commodo occaecat ex"
  },
  {
    "error_id": "ea consectetur proident",
    "field": null,
    "message": "esse velit"
  },
  {
    "error_id": "eiusmod aliquip non laborum elit",
    "field": null,
    "message": "deserunt"
  }
]
[
  {
    "error_id": "enim dolore mollit",
    "field": "deserunt fugiat",
    "message": "consectetur"
  },
  {
    "error_id": "deserunt magna Duis consectetur",
    "field": null,
    "message": "qui cupidatat dolore"
  },
  {
    "error_id": "tempor incididunt",
    "field": null,
    "message": "ut"
  },
  {
    "error_id": "nulla fugiat sunt",
    "field": "Excepteur proident id aute do",
    "message": "magna non"
  }
]
[
  {
    "error_id": "proident minim incididunt et qui",
    "field": null,
    "message": "ad ex consequat"
  }
]
[
  {
    "error_id": "aliquip dolore eu",
    "field": "pariatur ut nostrud",
    "message": "dolor ut ipsum consequat ut"
  }
]
[
  {
    "error_id": "culpa laborum eiusmod",
    "field": null,
    "message": "sit sed"
  },
  {
    "error_id": "veniam dolore minim cillum ut",
    "field": "nulla",
    "message": "dolore non irure"
  },
  {
    "error_id": "sint laborum sunt",
    "field": null,
    "message": "Excepteur labore"
  },
  {
    "error_id": "nisi",
    "field": null,
    "message": "amet veniam ut Lorem"
  }
]
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": 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"
}
[
  {
    "error_id": "dolor",
    "field": "ea est dolor id sed",
    "message": "in do ut id"
  },
  {
    "error_id": "ex veniam",
    "field": null,
    "message": "consectetur ut anim Lorem"
  },
  {
    "error_id": "cupidatat ut",
    "field": null,
    "message": "in magna ut Duis anim"
  }
]
[
  {
    "error_id": "Excepteur",
    "field": null,
    "message": "ullamco minim ipsum culpa"
  }
]
[
  {
    "error_id": "irure in Duis",
    "field": null,
    "message": "adipisicing eiusmod"
  },
  {
    "error_id": "Duis non nisi quis voluptate",
    "field": null,
    "message": "aute dolore ullamco ea"
  }
]
[
  {
    "error_id": "reprehenderit",
    "field": "est aute sed",
    "message": "sit ullamco"
  }
]
[
  {
    "error_id": "enim Duis",
    "field": "laboris proident exercitation sint amet",
    "message": "veniam"
  },
  {
    "error_id": "Duis cupidatat culpa laboris",
    "field": "pariatur do in ut",
    "message": "consequat deserunt id incididunt fugiat"
  }
]
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"
}
[
  {
    "error_id": "aute",
    "field": null,
    "message": "id consequat"
  },
  {
    "error_id": "dolore nulla consectetur culpa commodo",
    "field": null,
    "message": "eiusmod"
  },
  {
    "error_id": "officia",
    "field": null,
    "message": "deserunt qui mollit"
  },
  {
    "error_id": "Lorem aute laboris nulla",
    "field": "est adipisicing nostrud",
    "message": "est"
  }
]
[
  {
    "error_id": "exercitation",
    "field": null,
    "message": "fugiat minim"
  },
  {
    "error_id": "ad eiusmod in",
    "field": "nostrud minim Lorem reprehenderit",
    "message": "nisi sit proident"
  },
  {
    "error_id": "pariatur sit velit",
    "field": "ut do Excepteur ex consectetur",
    "message": "dolore qui voluptate"
  }
]
[
  {
    "error_id": "labore in aute",
    "field": "do nulla commodo officia",
    "message": "in aute dolor tempor"
  },
  {
    "error_id": "in pariatur reprehenderit",
    "field": "aliquip",
    "message": "consequat"
  }
]
[
  {
    "error_id": "laborum sit Duis",
    "field": "sunt consectetur pariatur Lorem enim",
    "message": "irure voluptate sint in ex"
  },
  {
    "error_id": "ad in",
    "field": null,
    "message": "pariatur laborum"
  },
  {
    "error_id": "amet fugiat commodo magna nostrud",
    "field": "aute laboris ullamco velit",
    "message": "amet occaecat"
  }
]
[
  {
    "error_id": "aliquip",
    "field": null,
    "message": "laboris sint"
  },
  {
    "error_id": "magna in",
    "field": null,
    "message": "esse aliquip dolore elit id"
  },
  {
    "error_id": "voluptate in aliquip aute",
    "field": "elit Ut",
    "message": "ut tempor"
  },
  {
    "error_id": "Ut ipsum proident",
    "field": "ut nostrud labore",
    "message": "ad sint"
  },
  {
    "error_id": "in dolore Lorem exercitation",
    "field": null,
    "message": "aute est occaecat qui"
  }
]
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
[
  {
    "error_id": "sed sint non ad velit",
    "field": "Ut dolor",
    "message": "elit"
  },
  {
    "error_id": "est dolor",
    "field": "irure dolore aute occaecat elit",
    "message": "mollit irure commodo in"
  },
  {
    "error_id": "nostrud in consequat cillum",
    "field": "anim in officia magna eiusmod",
    "message": "adipisicing voluptate"
  }
]
[
  {
    "error_id": "cillum in magna deserunt",
    "field": null,
    "message": "dolore"
  }
]
[
  {
    "error_id": "veniam id in reprehenderit",
    "field": null,
    "message": "sed irure cillum"
  },
  {
    "error_id": "consequat",
    "field": null,
    "message": "dolore pariatur in elit"
  }
]
[
  {
    "error_id": "elit Lorem anim",
    "field": "ullamco adipisicing non sit",
    "message": "laboris"
  },
  {
    "error_id": "ea dolor in incididunt consectetur",
    "field": "Lorem minim",
    "message": "in"
  }
]
[
  {
    "error_id": "culpa nostrud ex mollit",
    "field": "incididunt occaecat ullamco",
    "message": "enim"
  },
  {
    "error_id": "commodo incididunt",
    "field": null,
    "message": "fugiat incididunt non"
  }
]

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
}
[
  {
    "error_id": "occaecat cupidatat irure",
    "field": "tempor aute esse",
    "message": "aute et dolor ex"
  },
  {
    "error_id": "in incididunt",
    "field": "dolor",
    "message": "occaecat"
  },
  {
    "error_id": "ut Excepteur irure",
    "field": "Duis ad Ut proident labore",
    "message": "et voluptate in"
  },
  {
    "error_id": "ex consectetur irure",
    "field": "commodo Duis",
    "message": "adipisicing laboris laborum esse"
  }
]
[
  {
    "error_id": "anim ad labore eu Duis",
    "field": null,
    "message": "id in"
  }
]
[
  {
    "error_id": "laboris",
    "field": null,
    "message": "ea"
  },
  {
    "error_id": "Ut ut",
    "field": null,
    "message": "dolore aliqua"
  },
  {
    "error_id": "occaecat sunt ut",
    "field": "aliqua dolor ut qui",
    "message": "exercitation pariatur proident aliqua occaecat"
  },
  {
    "error_id": "pariatur adipisicing labore",
    "field": "ex",
    "message": "culpa"
  },
  {
    "error_id": "enim",
    "field": "sunt",
    "message": "quis id dolore magna"
  }
]
[
  {
    "error_id": "quis sunt mollit et amet",
    "field": null,
    "message": "ullamco in"
  },
  {
    "error_id": "amet id velit in sed",
    "field": "in reprehenderit nisi",
    "message": "cillum fugiat"
  },
  {
    "error_id": "eiusmod",
    "field": "commodo irure est aliqua ipsum",
    "message": "voluptate nulla tempor est"
  }
]
[
  {
    "error_id": "ut Lorem laborum",
    "field": null,
    "message": "commodo do magna"
  },
  {
    "error_id": "quis",
    "field": "consequat ad qui",
    "message": "commodo minim"
  },
  {
    "error_id": "deserunt commodo consectetur",
    "field": null,
    "message": "do nisi in"
  }
]
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"
}
[
  {
    "error_id": "fugiat dolor aliquip eu non",
    "field": "commodo Duis laborum officia exercitation",
    "message": "do est"
  },
  {
    "error_id": "nisi",
    "field": null,
    "message": "adipisicing consequat"
  },
  {
    "error_id": "voluptate dolor ex",
    "field": "tempor",
    "message": "irure"
  },
  {
    "error_id": "ullamco Lorem ut deserunt cupidatat",
    "field": null,
    "message": "consequat"
  }
]
[
  {
    "error_id": "ex veniam consectetur do exercitation",
    "field": null,
    "message": "exercitation labore pariatur magna"
  }
]
[
  {
    "error_id": "minim ad velit",
    "field": null,
    "message": "velit"
  },
  {
    "error_id": "ea irure sint occaecat",
    "field": null,
    "message": "reprehenderit exercitation nostrud ut"
  },
  {
    "error_id": "non aute",
    "field": "proident irure officia",
    "message": "exercitation"
  },
  {
    "error_id": "Duis enim",
    "field": "ipsum aute ea irure enim",
    "message": "Ut irure qui"
  }
]
[
  {
    "error_id": "quis adipisicing Ut nisi",
    "field": "sint cillum",
    "message": "ex"
  }
]
[
  {
    "error_id": "sunt",
    "field": "in laboris cillum consectetur",
    "message": "in est irure"
  },
  {
    "error_id": "esse aliqua exercitation",
    "field": "incididunt",
    "message": "in officia magna fugiat"
  },
  {
    "error_id": "dolore voluptate",
    "field": null,
    "message": "eu"
  }
]

Settings - Mail(13 operations)

Query Parameter NameExample
limit86272705
offset-70995889
Header NameExample
on-behalf-of"est dolore in nisi"
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": "occaecat cupidatat",
      "field": "eiusmod nulla incididunt",
      "message": "dolor laborum consequat aliquip mollit",
      "parameter": "labore Lorem"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "proident eu ut Duis aliquip",
      "field": "do",
      "message": "consectetur deserunt ipsum et adipisicing",
      "parameter": "ut consectetur fugiat"
    },
    {
      "error_id": "laboris dolore velit eu",
      "field": "deserunt in",
      "message": "laborum labore do aliqua",
      "parameter": "fugiat cupidatat aute id cillum"
    },
    {
      "error_id": "adipisicing ullamco",
      "field": "nisi nostrud laboris reprehenderit ullamco",
      "message": "minim",
      "parameter": "occaecat cupidatat Excepteur"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "id commodo reprehenderit in",
      "field": "amet",
      "message": "Duis dolor minim sit",
      "parameter": "deserunt"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ut",
      "field": null,
      "message": "dolore",
      "parameter": "ut"
    },
    {
      "error_id": "irure tempor ipsum",
      "field": null,
      "message": "elit ea dolore voluptate",
      "parameter": "eu"
    },
    {
      "error_id": "pariatur",
      "field": null,
      "message": "cillum elit dolor et cupidatat",
      "parameter": "commodo"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "consectetur consequat proident",
      "field": "incididunt cupidatat do ex laborum",
      "message": "Duis",
      "parameter": "fugiat"
    },
    {
      "error_id": "officia cillum ullamco sit occaecat",
      "field": "laboris sunt do officia",
      "message": "fugiat dolor id nisi",
      "parameter": "dolor ex reprehenderit elit irure"
    },
    {
      "error_id": "irure quis esse",
      "field": "est pariatur Ut aliquip dolor",
      "message": "qui in eu laborum occaecat",
      "parameter": "consectetur"
    },
    {
      "error_id": "pariatur et",
      "field": null,
      "message": "culpa",
      "parameter": "quis pariatur cupidatat"
    },
    {
      "error_id": "eu tempor Duis",
      "field": "aliquip",
      "message": "dolore quis ipsum",
      "parameter": "do quis"
    }
  ]
}
Header NameExample
on-behalf-of"est ex"
Request Payload
{
  "enabled": true,
  "list": [
    "email1@example.com",
    "example.com"
  ]
}
Response Payload
{
  "enabled": true,
  "list": [
    "email1@example.com"
  ]
}
{
  "errors": [
    {
      "error_id": "voluptate minim commodo",
      "field": "sed",
      "message": "sint ad eiusmod dolore cupidatat",
      "parameter": "veniam deserunt"
    },
    {
      "error_id": "nisi ut",
      "field": null,
      "message": "aliqua mollit Duis",
      "parameter": "anim Ut"
    },
    {
      "error_id": "in sit voluptate ad",
      "field": "exercitation laborum adipisicing",
      "message": "deserunt et in veniam ad",
      "parameter": "do"
    },
    {
      "error_id": "ut dolor in",
      "field": "pariatur",
      "message": "ea minim quis laborum Ut",
      "parameter": "velit labore id"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "quis anim ut",
      "field": null,
      "message": "reprehenderit enim aliquip dolor",
      "parameter": "deserunt"
    },
    {
      "error_id": "ex magna id",
      "field": "sit nostrud proident",
      "message": "nulla tempor mollit ut",
      "parameter": "Excepteur mollit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ullamco tempor veniam esse",
      "field": "dolor sed",
      "message": "culpa tempor anim",
      "parameter": "non Duis cupidatat sint"
    },
    {
      "error_id": "enim",
      "field": "nisi esse aliqua",
      "message": "magna et laboris Duis",
      "parameter": "exercitation"
    },
    {
      "error_id": "laboris veniam minim Lorem",
      "field": "minim cupidatat nostrud do",
      "message": "voluptate dolor enim",
      "parameter": "proident irure enim id ut"
    },
    {
      "error_id": "veniam reprehenderit",
      "field": "aliquip tempor culpa mollit",
      "message": "mollit",
      "parameter": "sint dolor qui do laborum"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ipsum sit quis",
      "field": "et",
      "message": "minim dolor",
      "parameter": "amet sit"
    },
    {
      "error_id": "Excepteur commodo Ut eu enim",
      "field": null,
      "message": "Ut velit",
      "parameter": "nulla et occaecat velit est"
    },
    {
      "error_id": "labore",
      "field": "anim et in sit",
      "message": "incididunt",
      "parameter": "elit quis dolore nisi aliquip"
    },
    {
      "error_id": "deserunt tempor eiusmod non veniam",
      "field": null,
      "message": "laborum irure tempor",
      "parameter": "sed ut ipsum"
    },
    {
      "error_id": "mollit",
      "field": "in cupidatat dolore",
      "message": "ut ut pariatur",
      "parameter": "laborum proident dolor"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "labore",
      "field": "Ut",
      "message": "in sint laborum",
      "parameter": "anim"
    }
  ]
}
Header NameExample
on-behalf-of"laboris Excepteur"
Request Payload
Response Payload
{
  "enabled": true,
  "list": [
    "example.com",
    "jane_doe@example1.com"
  ]
}
{
  "errors": [
    {
      "error_id": "nulla aute cillum in ex",
      "field": "sint ex ullamco sed",
      "message": "officia in minim",
      "parameter": "laboris ullamco ut"
    },
    {
      "error_id": "exercitation sit",
      "field": null,
      "message": "magna ullamco ex eiusmod commodo",
      "parameter": "exercitation ullamco nulla dolore"
    },
    {
      "error_id": "dolor sint do Ut",
      "field": "tempor sint occaecat commodo",
      "message": "nisi cillum",
      "parameter": "velit minim"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sed nostrud do irure",
      "field": null,
      "message": "voluptate",
      "parameter": "cupidatat"
    },
    {
      "error_id": "cupidatat laborum sed fugiat",
      "field": null,
      "message": "culpa",
      "parameter": "in"
    },
    {
      "error_id": "proident minim fugiat in",
      "field": "in in laborum",
      "message": "ut culpa",
      "parameter": "reprehenderit eu quis dolor sint"
    },
    {
      "error_id": "voluptate sunt aute commodo",
      "field": null,
      "message": "nostrud veniam velit pariatur",
      "parameter": "occaecat non fugiat sint"
    },
    {
      "error_id": "ut veniam",
      "field": "eu ut",
      "message": "ut mollit cillum ullamco",
      "parameter": "cupidatat in mollit enim cillum"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "cupidatat ad",
      "field": null,
      "message": "magna ut non sunt",
      "parameter": "ex ipsum dolor dolore"
    },
    {
      "error_id": "aliqua dolore tempor Ut",
      "field": null,
      "message": "et culpa fugiat minim",
      "parameter": "ea voluptate id velit enim"
    },
    {
      "error_id": "ex voluptate Lorem culpa",
      "field": "aute elit dolor magna occaecat",
      "message": "veniam commodo ad",
      "parameter": "aliqua deserunt proident sint sed"
    },
    {
      "error_id": "anim",
      "field": null,
      "message": "proident sunt pariatur",
      "parameter": "Lorem quis occaecat incididunt dolore"
    },
    {
      "error_id": "officia",
      "field": null,
      "message": "enim sunt",
      "parameter": "reprehenderit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "dolore",
      "field": "Excepteur",
      "message": "ut",
      "parameter": "consequat laboris aute Excepteur enim"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "nulla",
      "field": "laborum esse sed adipisicing sint",
      "message": "aliqua officia in ipsum",
      "parameter": "voluptate"
    }
  ]
}
Header NameExample
on-behalf-of"ex in in do sed"
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": "ullamco magna sint ut aliquip",
      "field": "adipisicing dolor in sed eu",
      "message": "in non aliqua",
      "parameter": "culpa et cillum ea ipsum"
    },
    {
      "error_id": "proident fugiat Duis eiusmod",
      "field": "qui",
      "message": "in adipisicing ea Ut",
      "parameter": "in exercitation ex"
    },
    {
      "error_id": "cupidatat sunt elit",
      "field": "non consequat",
      "message": "sint exercitation eiusmod labore",
      "parameter": "mollit"
    },
    {
      "error_id": "dolor incididunt",
      "field": "ut labore id anim",
      "message": "incididunt non proident mollit",
      "parameter": "reprehenderit non amet"
    },
    {
      "error_id": "proident ullamco consectetur in",
      "field": null,
      "message": "dolor reprehenderit",
      "parameter": "velit aliquip incididunt dolor adipisicing"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "Ut",
      "field": null,
      "message": "sit",
      "parameter": "do magna"
    },
    {
      "error_id": "officia ea in laboris",
      "field": "consequat id",
      "message": "tempor id",
      "parameter": "nisi sunt et tempor"
    },
    {
      "error_id": "enim laborum sed",
      "field": null,
      "message": "ipsum eu",
      "parameter": "elit"
    },
    {
      "error_id": "laborum consequat",
      "field": null,
      "message": "reprehenderit et ad sint dolor",
      "parameter": "aliqua"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sit veniam aute in",
      "field": null,
      "message": "esse incididunt laboris Ut laborum",
      "parameter": "anim velit labore deserunt"
    },
    {
      "error_id": "voluptate eu",
      "field": "enim",
      "message": "in quis",
      "parameter": "deserunt"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "culpa proident",
      "field": null,
      "message": "ut",
      "parameter": "ipsum elit quis"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ullamco ea occaecat proident",
      "field": null,
      "message": "ut nisi",
      "parameter": "consectetur"
    },
    {
      "error_id": "minim sed irure",
      "field": null,
      "message": "cupidatat ex reprehenderit aute",
      "parameter": "in reprehenderit consequat Excepteur"
    },
    {
      "error_id": "nulla reprehenderit in",
      "field": "voluptate sed sunt amet Ut",
      "message": "Lorem ipsum non amet",
      "parameter": "dolore adipisicing"
    },
    {
      "error_id": "mollit Duis",
      "field": null,
      "message": "do ullamco",
      "parameter": "enim aliqua"
    },
    {
      "error_id": "sint",
      "field": "do commodo",
      "message": "dolor exercitation",
      "parameter": "ullamco occaecat cupidatat"
    }
  ]
}
Header NameExample
on-behalf-of"id et eu"
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": "Lorem cillum adipisicing",
      "field": "laborum",
      "message": "cupidatat dolore sed dolor deserunt",
      "parameter": "dolor"
    },
    {
      "error_id": "ipsum dolore velit",
      "field": null,
      "message": "ut officia",
      "parameter": "commodo"
    },
    {
      "error_id": "dolore culpa",
      "field": "id do commodo sint",
      "message": "Lorem",
      "parameter": "sit laborum tempor"
    },
    {
      "error_id": "aliqua nostrud cupidatat quis",
      "field": null,
      "message": "minim tempor irure",
      "parameter": "ullamco nisi elit reprehenderit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ut",
      "field": "ipsum aute non mollit",
      "message": "ut incididunt ad elit",
      "parameter": "irure amet"
    },
    {
      "error_id": "commodo qui",
      "field": "est tempor anim labore Ut",
      "message": "ipsum ea quis velit sit",
      "parameter": "in nulla"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "laboris",
      "field": "commodo velit magna deserunt",
      "message": "adipisicing occaecat",
      "parameter": "elit tempor"
    },
    {
      "error_id": "dolore est ut nostrud eiusmod",
      "field": "ex",
      "message": "consectetur aute irure commodo",
      "parameter": "ad do nulla minim enim"
    },
    {
      "error_id": "adipisicing in non ex laborum",
      "field": null,
      "message": "nulla est amet eu",
      "parameter": "enim consectetur mollit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "commodo",
      "field": "irure",
      "message": "et voluptate",
      "parameter": "Excepteur laborum dolore"
    },
    {
      "error_id": "mollit",
      "field": null,
      "message": "consectetur incididunt ut Ut",
      "parameter": "Excepteur"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ullamco culpa exercitation laboris",
      "field": null,
      "message": "magna",
      "parameter": "officia ut est"
    }
  ]
}
Header NameExample
on-behalf-of"tempor"
Request Payload
{
  "email": "abuse@example.com",
  "enabled": true
}
Response Payload
{
  "email": "abuse@example.com",
  "enabled": true
}
{
  "errors": [
    {
      "error_id": "laboris sed eiusmod",
      "field": "ad ullamco reprehenderit nostrud Lorem",
      "message": "Lorem dolor Ut consequat eiusmod",
      "parameter": "do"
    },
    {
      "error_id": "ullamco adipisicing sed reprehenderit",
      "field": "exercitation reprehenderit voluptate",
      "message": "sint aliquip aliqua labore",
      "parameter": "aute ex proident"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ad est",
      "field": null,
      "message": "cupidatat labore eiusmod Excepteur",
      "parameter": "ut"
    },
    {
      "error_id": "dolore laborum ad enim",
      "field": "occaecat proident nisi anim nulla",
      "message": "elit ut",
      "parameter": "velit officia commodo laborum"
    },
    {
      "error_id": "ut nulla laboris est non",
      "field": "ad aliqua",
      "message": "dolor nulla",
      "parameter": "et"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sed dolore ex",
      "field": "mollit",
      "message": "laborum do non veniam",
      "parameter": "consequat nisi quis"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "Excepteur aliquip proident",
      "field": "sit ea magna irure",
      "message": "consequat",
      "parameter": "dolor"
    },
    {
      "error_id": "mollit",
      "field": null,
      "message": "qui",
      "parameter": "enim"
    },
    {
      "error_id": "velit Lorem in enim labore",
      "field": null,
      "message": "laboris pariatur",
      "parameter": "aute aliqua"
    },
    {
      "error_id": "aute veniam enim commodo",
      "field": "exercitation ut",
      "message": "amet in minim",
      "parameter": "dolore"
    },
    {
      "error_id": "enim aute",
      "field": "nisi cillum",
      "message": "aute qui consectetur irure",
      "parameter": "ea"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "Duis Ut proident anim velit",
      "field": "minim commodo",
      "message": "quis",
      "parameter": "nostrud laboris ea est fugiat"
    }
  ]
}
Header NameExample
on-behalf-of"occaecat aliqua consectetur fugiat Lorem"
Request Payload
Response Payload
{
  "email": "abuse@example.com",
  "enabled": true
}
{
  "errors": [
    {
      "error_id": "deserunt",
      "field": null,
      "message": "laboris in adipisicing sit irure",
      "parameter": "pariatur eiusmod in id"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "eu enim anim occaecat exercitation",
      "field": null,
      "message": "Lorem nulla laboris",
      "parameter": "est amet"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "adipisicing commodo",
      "field": null,
      "message": "pariatur officia commodo",
      "parameter": "Lorem aliquip incididunt eiusmod"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "cupidatat ullamco tempor nostrud",
      "field": "sed irure",
      "message": "quis",
      "parameter": "voluptate eu est"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "quis minim cillum",
      "field": null,
      "message": "aute",
      "parameter": "amet laborum irure anim ut"
    },
    {
      "error_id": "culpa Lorem anim esse minim",
      "field": null,
      "message": "magna culpa voluptate",
      "parameter": "nulla nostrud"
    },
    {
      "error_id": "id labore dolore sunt enim",
      "field": null,
      "message": "ex occaecat",
      "parameter": "dolor incididunt in"
    },
    {
      "error_id": "occaecat dolor eu in",
      "field": "eu Lorem dolor",
      "message": "nisi magna fugiat aute",
      "parameter": "ex sint sit dolore"
    }
  ]
}
Header NameExample
on-behalf-of"laboris in nostrud"
Request Payload
{
  "enabled": true,
  "html_content": "<% body %>"
}
Response Payload
{
  "enabled": false,
  "html_content": "<p><% body %>Example</p>\n"
}
{
  "errors": [
    {
      "error_id": "amet id ex est",
      "field": "amet anim est sed qui",
      "message": "incididunt voluptate Lorem",
      "parameter": "culpa"
    },
    {
      "error_id": "ut",
      "field": null,
      "message": "non commodo",
      "parameter": "in aliquip do anim"
    },
    {
      "error_id": "veniam dolor",
      "field": null,
      "message": "deserunt",
      "parameter": "minim enim magna ullamco"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ex do voluptate",
      "field": "in non anim esse",
      "message": "sint id",
      "parameter": "nulla dolore amet"
    },
    {
      "error_id": "eu non",
      "field": "exercitation anim sunt consequat",
      "message": "irure aliquip",
      "parameter": "eu tempor Ut est aliqua"
    },
    {
      "error_id": "commodo laborum Excepteur",
      "field": "laborum",
      "message": "cillum quis officia",
      "parameter": "ex velit"
    },
    {
      "error_id": "cillum",
      "field": null,
      "message": "dolore fugiat nisi",
      "parameter": "dolor veniam ipsum do laboris"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "occaecat in",
      "field": null,
      "message": "exercitation cillum esse sunt aliquip",
      "parameter": "voluptate magna incididunt ut reprehenderit"
    },
    {
      "error_id": "irure et Ut",
      "field": null,
      "message": "voluptate ullamco labore",
      "parameter": "proident et"
    },
    {
      "error_id": "cillum",
      "field": "et",
      "message": "laborum do ad ullamco commodo",
      "parameter": "culpa consequat"
    },
    {
      "error_id": "aute esse",
      "field": null,
      "message": "sit ut",
      "parameter": "culpa sed id aute cillum"
    },
    {
      "error_id": "in sint",
      "field": null,
      "message": "cupidatat nisi in id",
      "parameter": "dolor in commodo"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "et",
      "field": "occaecat exercitation anim est enim",
      "message": "aute qui deserunt sunt",
      "parameter": "pariatur proident eiusmod"
    },
    {
      "error_id": "esse",
      "field": "est sit nostrud",
      "message": "incididunt est",
      "parameter": "deserunt in cupidatat velit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sed et",
      "field": "exercitation ex",
      "message": "cillum adipisicing",
      "parameter": "consequat culpa"
    },
    {
      "error_id": "nisi do ea in",
      "field": "fugiat dolore dolor ad nulla",
      "message": "sed dolor do dolor non",
      "parameter": "et ea esse"
    }
  ]
}
Header NameExample
on-behalf-of"cupidatat et fugiat deserunt"
Request Payload
Response Payload
{
  "enabled": false,
  "html_content": "<p><% body %>Example</p>\n"
}
{
  "errors": [
    {
      "error_id": "sunt nisi est reprehenderit",
      "field": null,
      "message": "enim officia",
      "parameter": "Ut id"
    },
    {
      "error_id": "voluptate enim ut aute",
      "field": "sunt aliqua",
      "message": "aliqua labore non dolor",
      "parameter": "Duis velit mollit laborum ut"
    },
    {
      "error_id": "incididunt ipsum deserunt consequat",
      "field": null,
      "message": "ex",
      "parameter": "magna"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "Ut reprehenderit",
      "field": null,
      "message": "anim qui",
      "parameter": "non dolore officia dolore dolor"
    },
    {
      "error_id": "quis",
      "field": null,
      "message": "deserunt tempor fugiat magna",
      "parameter": "labore Lorem"
    },
    {
      "error_id": "sed ut",
      "field": "adipisicing eiusmod",
      "message": "elit cillum dolor",
      "parameter": "nostrud in"
    },
    {
      "error_id": "id occaecat dolore",
      "field": "dolor do ea",
      "message": "nostrud occaecat in do",
      "parameter": "Duis in"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "cillum ut",
      "field": "elit aliquip nulla deserunt",
      "message": "anim quis exercitation dolore sed",
      "parameter": "elit dolor"
    },
    {
      "error_id": "eiusmod dolore laboris eu",
      "field": "Lorem proident ut id",
      "message": "ad exercitation in laboris",
      "parameter": "labore"
    },
    {
      "error_id": "minim Duis id",
      "field": null,
      "message": "Ut in laborum deserunt",
      "parameter": "ullamco consequat"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "enim ut aliqua consequat",
      "field": "tempor nulla nisi non",
      "message": "sint velit",
      "parameter": "elit officia Duis"
    },
    {
      "error_id": "cupidatat eiusmod incididunt",
      "field": "in labore",
      "message": "esse",
      "parameter": "tempor mollit amet"
    },
    {
      "error_id": "commodo aliqua exercitation sit esse",
      "field": null,
      "message": "pariatur et consectetur",
      "parameter": "culpa"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "id dolore",
      "field": "enim eu in non",
      "message": "ad ut aute aliqua",
      "parameter": "ut ut sunt"
    }
  ]
}
Header NameExample
on-behalf-of"officia anim"
Request Payload
{
  "enabled": true,
  "hard_bounces": 5,
  "soft_bounces": 5
}
Response Payload
{
  "enabled": false,
  "hard_bounces": 5,
  "soft_bounces": 5
}
{
  "errors": [
    {
      "error_id": "et tempor minim reprehenderit",
      "field": "sint",
      "message": "consectetur voluptate",
      "parameter": "sed nulla proident Ut nostrud"
    },
    {
      "error_id": "eu amet",
      "field": "Excepteur sunt esse",
      "message": "commodo aute occaecat laborum qui",
      "parameter": "sed enim esse voluptate qui"
    },
    {
      "error_id": "consectetur",
      "field": null,
      "message": "dolor magna pariatur nostrud",
      "parameter": "non ipsum"
    },
    {
      "error_id": "dolore enim eiusmod dolore deserunt",
      "field": null,
      "message": "sint culpa Ut aliquip id",
      "parameter": "eiusmod in sit voluptate enim"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sunt",
      "field": "qui ut aute sunt",
      "message": "labore in",
      "parameter": "adipisicing"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "anim et est in culpa",
      "field": "eu exercitation dolore Duis",
      "message": "in",
      "parameter": "ut sint"
    },
    {
      "error_id": "aliquip veniam",
      "field": "voluptate in esse laborum magna",
      "message": "in ad nulla consectetur id",
      "parameter": "officia"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "pariatur eiusmod minim",
      "field": "ut",
      "message": "labore consequat ex fugiat ut",
      "parameter": "dolor"
    },
    {
      "error_id": "Ut labore sint dolor mollit",
      "field": "labore in dolor in",
      "message": "deserunt laborum",
      "parameter": "sunt"
    },
    {
      "error_id": "ad in cupidatat",
      "field": "laboris dolore ut",
      "message": "et cillum",
      "parameter": "laborum dolor incididunt fugiat do"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "proident",
      "field": "quis tempor est",
      "message": "irure reprehenderit anim sed incididunt",
      "parameter": "laborum"
    },
    {
      "error_id": "ea enim ipsum sunt",
      "field": "consequat",
      "message": "proident ipsum cupidatat",
      "parameter": "in aute proident mollit"
    }
  ]
}
Header NameExample
on-behalf-of"in elit deserunt"
Request Payload
Response Payload
{
  "enabled": false,
  "soft_bounces": 5,
  "hard_bounces": 5
}
{
  "errors": [
    {
      "error_id": "cupidatat proident",
      "field": "non incididunt sed",
      "message": "voluptate aute",
      "parameter": "sit in eu in"
    },
    {
      "error_id": "sunt",
      "field": "in Excepteur cupidatat velit",
      "message": "officia commodo minim sed in",
      "parameter": "Excepteur in elit qui"
    },
    {
      "error_id": "Lorem in nisi eiusmod",
      "field": null,
      "message": "dolor deserunt",
      "parameter": "elit magna"
    },
    {
      "error_id": "velit nostrud laboris ipsum proident",
      "field": "ea magna",
      "message": "sunt Excepteur",
      "parameter": "incididunt in commodo officia nostrud"
    },
    {
      "error_id": "officia dolore",
      "field": null,
      "message": "et culpa pariatur nulla",
      "parameter": "est id sed incididunt ut"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "aliquip",
      "field": "nulla in id aute",
      "message": "anim ea",
      "parameter": "eu ad do"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "elit in",
      "field": "minim",
      "message": "aliquip",
      "parameter": "Ut amet ipsum commodo"
    },
    {
      "error_id": "in",
      "field": "elit commodo Ut labore nostrud",
      "message": "Lorem proident in ut Excepteur",
      "parameter": "in"
    },
    {
      "error_id": "anim officia sit aute culpa",
      "field": null,
      "message": "cillum in elit nulla",
      "parameter": "dolore occaecat"
    },
    {
      "error_id": "et sunt dolore",
      "field": "ex",
      "message": "sint non",
      "parameter": "ut enim"
    },
    {
      "error_id": "non aliqua",
      "field": "minim reprehenderit esse enim officia",
      "message": "pariatur enim ut aliqua occaecat",
      "parameter": "ullamco sunt dolor"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "est",
      "field": null,
      "message": "quis",
      "parameter": "Duis"
    },
    {
      "error_id": "commodo tempor ea laborum",
      "field": null,
      "message": "do eiusmod",
      "parameter": "cillum"
    },
    {
      "error_id": "in velit dolore id",
      "field": "adipisicing incididunt",
      "message": "irure Lorem sunt nulla",
      "parameter": "et nisi Lorem exercitation"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sunt",
      "field": null,
      "message": "qui culpa",
      "parameter": "est magna"
    },
    {
      "error_id": "esse cupidatat",
      "field": "sunt voluptate anim",
      "message": "ex sed",
      "parameter": "Ut"
    },
    {
      "error_id": "deserunt",
      "field": "Lorem culpa dolore commodo et",
      "message": "culpa veniam",
      "parameter": "ut ut"
    },
    {
      "error_id": "enim ullamco pariatur ad dolor",
      "field": null,
      "message": "nulla in ipsum in dolore",
      "parameter": "aliqua nostrud laboris"
    },
    {
      "error_id": "est esse",
      "field": null,
      "message": "sed id",
      "parameter": "laborum sed elit"
    }
  ]
}
Header NameExample
on-behalf-of"dolor incididunt"
Request Payload
{
  "enabled": true,
  "email": "bounces@example.com"
}
Response Payload
{
  "email": "bounces@example.com",
  "enabled": true
}
{
  "errors": [
    {
      "error_id": "quis ullamco",
      "field": null,
      "message": "cupidatat sint proident",
      "parameter": "deserunt voluptate sunt exercitation anim"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "anim ipsum quis",
      "field": null,
      "message": "et cillum",
      "parameter": "quis cupidatat"
    },
    {
      "error_id": "in",
      "field": "fugiat irure",
      "message": "dolore",
      "parameter": "eiusmod dolor"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "dolore ut sunt incididunt aute",
      "field": "officia nostrud aliqua consectetur",
      "message": "eu",
      "parameter": "enim"
    },
    {
      "error_id": "dolor esse ullamco",
      "field": "officia dolor esse ipsum",
      "message": "sed sit",
      "parameter": "laborum occaecat dolor"
    },
    {
      "error_id": "exercitation proident et officia",
      "field": null,
      "message": "ea minim amet Excepteur",
      "parameter": "elit"
    },
    {
      "error_id": "ut enim voluptate non",
      "field": "voluptate eiusmod quis ut",
      "message": "veniam velit",
      "parameter": "sunt"
    },
    {
      "error_id": "commodo",
      "field": null,
      "message": "laboris Duis officia sed in",
      "parameter": "tempor ut sit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "esse pariatur sunt in",
      "field": null,
      "message": "sit ex in sunt",
      "parameter": "adipisicing nulla"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "Lorem reprehenderit in",
      "field": null,
      "message": "sint non labore",
      "parameter": "ut consequat enim labore elit"
    },
    {
      "error_id": "occaecat",
      "field": null,
      "message": "aliquip fugiat",
      "parameter": "id consequat enim irure"
    },
    {
      "error_id": "non",
      "field": null,
      "message": "non dolore Lorem deserunt anim",
      "parameter": "dolore laborum Duis in anim"
    },
    {
      "error_id": "in ut consequat",
      "field": "Excepteur Ut qui",
      "message": "dolor exercitation nulla",
      "parameter": "sit"
    }
  ]
}
Header NameExample
on-behalf-of"occaecat consequat pariatur minim dolor"
Request Payload
Response Payload
{
  "enabled": true,
  "email": "bounces@example.com"
}
{
  "errors": [
    {
      "error_id": "veniam est voluptate",
      "field": "ullamco deserunt consectetur quis",
      "message": "occaecat commodo velit consequat ut",
      "parameter": "nisi"
    },
    {
      "error_id": "ad veniam ipsum",
      "field": "ex aute in ea aliquip",
      "message": "anim",
      "parameter": "laboris"
    },
    {
      "error_id": "nostrud",
      "field": "ipsum ex cillum officia dolor",
      "message": "amet sit quis",
      "parameter": "adipisicing id consectetur sit"
    },
    {
      "error_id": "dolor in quis enim",
      "field": "aliqua ipsum",
      "message": "fugiat quis",
      "parameter": "non quis exercitation Duis"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "eu exercitation in",
      "field": "dolore in ex sed nulla",
      "message": "Ut in nulla Duis",
      "parameter": "reprehenderit est laborum eiusmod"
    },
    {
      "error_id": "esse dolore eu voluptate ad",
      "field": null,
      "message": "esse aliquip tempor id",
      "parameter": "consequat"
    },
    {
      "error_id": "enim",
      "field": "consectetur ut in aliqua",
      "message": "Ut irure",
      "parameter": "deserunt ipsum Excepteur in qui"
    },
    {
      "error_id": "consectetur sint velit",
      "field": null,
      "message": "sint in non Ut Lorem",
      "parameter": "incididunt ut do"
    },
    {
      "error_id": "aliqua cupidatat ut deserunt",
      "field": "ut velit",
      "message": "do in sed",
      "parameter": "enim"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "pariatur amet dolor consectetur dolor",
      "field": null,
      "message": "ex nisi enim laboris",
      "parameter": "velit Duis"
    },
    {
      "error_id": "ipsum culpa",
      "field": null,
      "message": "nostrud ut",
      "parameter": "aute cillum laborum sed quis"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ut exercitation mollit cupidatat sint",
      "field": null,
      "message": "velit qui enim magna fugiat",
      "parameter": "sint aliquip reprehenderit ut Lorem"
    },
    {
      "error_id": "mollit ut adipisicing quis",
      "field": null,
      "message": "in esse culpa",
      "parameter": "sit non reprehenderit culpa"
    },
    {
      "error_id": "qui id dolore",
      "field": "in velit non",
      "message": "ex nisi aliquip eiusmod in",
      "parameter": "aliqua consectetur velit laborum"
    },
    {
      "error_id": "culpa",
      "field": null,
      "message": "laboris qui",
      "parameter": "Duis id"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "veniam",
      "field": "culpa esse dolore laboris",
      "message": "Excepteur consectetur Ut amet magna",
      "parameter": "Excepteur"
    },
    {
      "error_id": "ut",
      "field": "sunt",
      "message": "enim labore eiusmod",
      "parameter": "culpa ut sed"
    },
    {
      "error_id": "amet id nisi nostrud officia",
      "field": null,
      "message": "officia laboris",
      "parameter": "eu ullamco"
    },
    {
      "error_id": "aliquip",
      "field": null,
      "message": "elit non aliquip",
      "parameter": "voluptate eu veniam nostrud ut"
    },
    {
      "error_id": "minim",
      "field": "est ea in",
      "message": "cupidatat",
      "parameter": "Ut aliquip eiusmod in"
    }
  ]
}

Settings - Partner(3 operations)

Header NameExample
on-behalf-of"incididunt eiusmod amet"
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"ullamco ipsum eiusmod"
Request Payload
Response Payload
{
  "enable_subuser_statistics": false,
  "enabled": true,
  "license_key": ""
}
Query Parameter NameExample
limit34506676
offset-79594373
Header NameExample
on-behalf-of"reprehenderit tempor aute"
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"aliqua exercitation fugiat adipisicing"
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": [
    {
      "field": "officia pariatur est Duis sunt",
      "message": "officia"
    },
    {
      "field": "qui",
      "message": "aute ut dolor"
    },
    {
      "field": "laborum",
      "message": "Ut do dolore"
    },
    {
      "field": "laborum",
      "message": "velit voluptate Ut aliquip minim"
    }
  ]
}
Query Parameter NameExample
limit78
offset25136421
Header NameExample
on-behalf-of"velit ut"
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"esse commodo"
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
limit5416729
offset-65668626
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"ut Duis irure cupidatat"
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"esse eiusmod velit"
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"aliqua do ullamco ut"
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"qui ipsum"
Request Payload
Response Payload
{
  "errors": [
    {
      "field": "sit aliqua anim",
      "message": "ut aliquip et in amet"
    },
    {
      "field": "dolore exercitation ea",
      "message": "reprehenderit et"
    },
    {
      "field": "magna pariatur",
      "message": "velit minim"
    },
    {
      "field": "non dolore enim cillum",
      "message": "qui aliquip"
    }
  ]
}
{
  "errors": [
    {
      "message": "username not found",
      "field": "username"
    }
  ]
}
Request Payload
Response Payload
{
  "scope_group_name": "Stats"
}
{}
{
  "errors": [
    {
      "field": "est voluptate Excepteur",
      "message": "enim"
    },
    {
      "field": "sunt tempor id consectetur",
      "message": "nisi consequat"
    },
    {
      "field": "pariatur quis do veniam aliqua",
      "message": "culpa occaecat ea dolor in"
    }
  ]
}
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"ex irure veniam"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "elit culpa",
      "message": "enim do nulla laborum labore"
    },
    {
      "field": "esse ea",
      "message": "aliqua"
    },
    {
      "field": "ipsum officia",
      "message": "Lorem"
    }
  ]
}

Alerts(5 operations)

Header NameExample
Authorization"ut cupidatat laboris dolor"
on-behalf-of"id"
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": "mollit in non Excepteur sit",
  "message": "ex ut irure"
}
Header NameExample
Authorization"Ut dolore"
on-behalf-of"sunt ullamco officia eu"
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"labore deserunt"
on-behalf-of"proident reprehenderit aute"
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"labore officia"
Request Payload
Response Payload
{}
Header NameExample
on-behalf-of"id quis eiusmod"
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"quis enim dolor"
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"et"
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"et ea"
Request Payload
Response Payload
{
  "reputation": 100,
  "type": "paid"
}
Header NameExample
on-behalf-of"est"
Request Payload
Response Payload
{
  "email": "test@example.com"
}
Header NameExample
on-behalf-of"id labore"
Request Payload
{
  "email": "example@example.com"
}
Response Payload
{
  "email": "example@example.com"
}
Header NameExample
on-behalf-of"aute velit deserunt"
Request Payload
Response Payload
{
  "username": "test_username",
  "user_id": 1
}
Header NameExample
on-behalf-of"cillum exercitation ex"
Request Payload
{
  "username": "test_username"
}
Response Payload
{
  "username": "test_username"
}
Header NameExample
on-behalf-of"cillum ullamco adipisicing reprehenderit ut"
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"pariatur minim"
Request Payload
{
  "new_password": "new_password",
  "old_password": "old_password"
}
Response Payload
{}

Subusers API(6 operations)

Query Parameter NameExample
usernameDuis fugiat
limit-93823437
offset-59923801
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
usernamesaute quis reprehenderit
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*in nulla magna
sort_by_metricdolore
sort_by_directiondesc
limit-2398024
offset66267963
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*eiusmod in amet in
subusercommodo exercitation anim non
sort_by_metricunsubscribes
sort_by_directiondesc
limit5992468
offset-56013570
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*id
end_datereprehenderit aliquip
limit54195220
offset95690381
aggregated_bysint
sort_by_metricnisi laborum sunt
Request Payload
Response Payload
{
  "date": "2015-10-11",
  "stats": []
}
Query Parameter NameExample
limit-12204703
offset-2694806
aggregated_byweek
subusers*quis culpa commodo laboris est
start_date*in et
end_dateipsum Duis consequat elit
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"fugiat qui consequat officia nostrud"
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
limit53518990
offset-28128823
ipadipisicing proident dolor labore laboris
Header NameExample
on-behalf-of"sit non Lorem deserunt ex"
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"sunt labore aliqua cupidatat minim"
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 labore est nostrud cillum"
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"veniam consequat velit"
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": "voluptate",
    "field": "Lorem ad proident ullamco aliquip"
  }
}

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
ipsunt cupidatat irure ad
exclude_whitelabelstrue
limit54351342
offset98596260
subuserdeserunt dolore Ut occaecat dolor
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
limit17674114
offset84189921
exclude_subuserstrue
usernameut in fugiat
domainin non culpa Duis cillum
Header NameExample
on-behalf-of"velit ad incididunt et ipsum"
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"labore"
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"ullamco enim veniam elit"
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"Ut ut dolor occaecat elit"
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"dolore"
Request Payload
Response Payload
{}
Query Parameter NameExample
domainvelit ad anim in
Header NameExample
on-behalf-of"elit in in commodo"
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"deserunt"
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"enim"
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"aute aliqua non minim"
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*in
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
usernameut non quis irure dolor
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": "voluptate nostrud"
    },
    {
      "message": "sint"
    },
    {
      "message": "reprehenderit officia ipsum sunt"
    },
    {
      "message": "eiusmod consectetur Ut laboris"
    }
  ]
}
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": "aliqua esse exercitation et laboris"
    }
  ]
}
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": [
    {
      "error_id": "non",
      "field": "ipsum non eu Duis",
      "message": "do dolore incididunt occaecat"
    },
    {
      "error_id": "est fugiat aliqua consequat",
      "field": "Duis proident mollit",
      "message": "laboris"
    },
    {
      "error_id": "incididunt officia sunt enim",
      "field": "est",
      "message": "ut"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "in reprehenderit labore"
    },
    {
      "message": "eu reprehenderit"
    },
    {
      "message": "quis Lorem"
    },
    {
      "message": "culpa nisi esse non ipsum"
    }
  ]
}
Query Parameter NameExample
limit7591241.131841198
lastSeenID-22240197.555823296
id43868550
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": "nostrud ipsum"
    },
    {
      "message": "sit sed"
    },
    {
      "message": "pariatur ad"
    },
    {
      "message": "pariatur laboris ut sint"
    },
    {
      "message": "voluptate sed"
    }
  ]
}
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": [
    {
      "error_id": "occaecat est adipisicing",
      "message": "consectetur esse"
    },
    {
      "error_id": "sed aute cillum sit consequat",
      "message": "fugiat nostrud"
    }
  ]
}
{
  "errors": [
    {
      "message": "voluptate ullamco culpa sit sed"
    },
    {
      "message": "laboris Duis"
    },
    {
      "message": "Ut sit"
    },
    {
      "message": "officia mollit in pariatur"
    }
  ]
}
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": [
    {
      "error_id": "Lorem quis Duis velit",
      "field": "Ut adipisicing elit",
      "message": "commodo in cillum"
    },
    {
      "error_id": "in sint mollit deserunt sunt",
      "field": "cillum",
      "message": "sunt non fugiat dolor"
    },
    {
      "error_id": "sed incididunt cillum esse",
      "field": "aute ea anim amet",
      "message": "ex voluptate aliqua id"
    },
    {
      "error_id": "cupidatat fugiat consectetur veniam deserunt",
      "field": "occaecat est",
      "message": "fugiat enim aliquip Duis ea"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ad reprehenderit cupidatat qui",
      "message": "dolor"
    },
    {
      "error_id": "magna exercitation nulla occaecat",
      "message": "id pariatur"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "aliqua consectetur sint est non",
      "message": "exercitation eiusmod"
    },
    {
      "error_id": "esse est",
      "message": "dolor sed consectetur"
    }
  ]
}
{
  "errors": [
    {
      "message": "voluptate minim Ut"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "consequat ut aliqua",
      "message": "in qui incididunt ex"
    },
    {
      "error_id": "ipsum dolor laborum",
      "message": "do quis Excepteur occaecat"
    },
    {
      "error_id": "mollit voluptate ad sunt",
      "message": "velit reprehenderit laboris in"
    },
    {
      "error_id": "Duis",
      "message": "aliqua Lorem esse"
    },
    {
      "error_id": "fugiat esse mollit Ut dolor",
      "message": "pariatur velit et cupidatat Duis"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "Ut minim ipsum Duis ut",
      "message": "do dolor"
    },
    {
      "error_id": "irure",
      "message": "mollit nostrud"
    }
  ]
}
{
  "errors": [
    {
      "message": "culpa nulla sunt veniam exercitation"
    },
    {
      "message": "elit eu officia dolore"
    },
    {
      "message": "quis sed"
    },
    {
      "message": "ut enim"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "error_id": "qui in mollit",
      "message": "elit et"
    },
    {
      "error_id": "voluptate",
      "message": "sunt"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "cillum adipisicing eu in dolor",
      "message": "nulla eiusmod nostrud in aliquip"
    },
    {
      "error_id": "exercitation cillum esse aute",
      "message": "et"
    },
    {
      "error_id": "consequat qui ut sed",
      "message": "ut aute labore"
    },
    {
      "error_id": "dolore",
      "message": "dolor id esse"
    },
    {
      "error_id": "eu ex esse ut magna",
      "message": "est"
    }
  ]
}
{
  "errors": [
    {
      "message": "laboris magna"
    }
  ]
}

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": []
}
{
  "error_id": "in Lorem in esse",
  "field": "enim ut est consectetur",
  "message": "sed quis"
}
{
  "errors": [
    {
      "error_id": "in enim tempor magna",
      "field": "in eiusmod dolore enim dolor",
      "message": "proident deserunt et"
    }
  ]
}
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": [
    {
      "error_id": "adipisicing irure deserunt dolore ullamco",
      "field": "adipisicing nostrud dolore",
      "message": "Ut aliquip eu aute"
    },
    {
      "error_id": "mollit proident dolor cupidatat",
      "field": "cupidatat aute",
      "message": "amet occaecat cillum nostrud"
    },
    {
      "error_id": "aliquip irure aute",
      "field": "dolore Excepteur sed irure pariatur",
      "message": "culpa sed voluptate tempor cillum"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "elit",
      "field": "labore aute dolore",
      "message": "pariatur"
    },
    {
      "error_id": "in ea qui dolore occaecat",
      "field": "adipisicing exercitation occaecat mollit sunt",
      "message": "aliqua do"
    }
  ]
}
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": [
    {
      "error_id": "sunt in",
      "field": "Ut dolor cupidatat fugiat do",
      "message": "Ut officia in"
    },
    {
      "error_id": "sunt nisi cillum laborum",
      "field": "cupidatat esse cillum reprehenderit",
      "message": "ea pariatur commodo est velit"
    },
    {
      "error_id": "enim id in aliquip",
      "field": "ex non in adipisicing",
      "message": "consequat"
    },
    {
      "error_id": "dolore",
      "field": "mollit occaecat",
      "message": "sunt exercitation Lorem"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "anim",
      "field": "cupidatat ipsum minim",
      "message": "labore elit ea dolore esse"
    },
    {
      "error_id": "et",
      "field": "magna aute nisi",
      "message": "commodo eiusmod nostrud proident"
    },
    {
      "error_id": "ullamco Lorem Excepteur",
      "field": "reprehenderit",
      "message": "incididunt tempor officia pariatur"
    },
    {
      "error_id": "commodo labore ullamco elit",
      "field": "amet irure",
      "message": "sed voluptate amet cillum cupidatat"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "error_id": "amet ut veniam",
      "field": "proident eu nulla officia",
      "message": "adipisicing"
    },
    {
      "error_id": "ullamco voluptate dolor et",
      "field": "mollit est dolor ipsum laboris",
      "message": "in quis occaecat"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ut Duis in eiusmod enim",
      "field": "fugiat ullamco sunt minim",
      "message": "velit Ut id ullamco anim"
    }
  ]
}
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": [
    {
      "error_id": "mollit officia esse",
      "field": "sit occaecat",
      "message": "eiusmod"
    },
    {
      "error_id": "tempor mollit quis incididunt",
      "field": "dolor aliquip incididunt",
      "message": "minim"
    },
    {
      "error_id": "nulla ullamco eu consectetur",
      "field": "qui fugiat",
      "message": "mollit deserunt dolor Lorem"
    },
    {
      "error_id": "consectetur culpa eiusmod enim",
      "field": "est in",
      "message": "officia sed"
    }
  ]
}
Query Parameter NameExample
page_size45085613
page_tokentempor
summarytrue
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": [
    {
      "error_id": "in ullamco",
      "field": "exercitation sed esse",
      "message": "ea aliqua dolor ex"
    },
    {
      "error_id": "dolor incididunt",
      "field": "Duis ipsum",
      "message": "elit sunt amet qui in"
    },
    {
      "error_id": "occaecat consequat ut cillum aliqua",
      "field": "elit veniam",
      "message": "commodo"
    },
    {
      "error_id": "sed",
      "field": "Lorem",
      "message": "exercitation deserunt"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "anim in sint consectetur",
      "field": "laborum sed ad ut in",
      "message": "in Ut eiusmod Excepteur"
    }
  ]
}
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": [
    {
      "error_id": "labore laboris eiusmod in",
      "field": "mollit laborum anim veniam elit",
      "message": "reprehenderit enim"
    },
    {
      "error_id": "occaecat Excepteur consequat Duis proident",
      "field": "commodo irure ad",
      "message": "incididunt"
    },
    {
      "error_id": "exercitation laborum est culpa nisi",
      "field": "aliqua eiusmod",
      "message": "eiusmod"
    },
    {
      "error_id": "Ut sunt dolor",
      "field": "adipisicing aliqua",
      "message": "et in"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "anim aliquip sed",
      "field": "minim cupidatat",
      "message": "tempor non ut dolore"
    },
    {
      "error_id": "anim in",
      "field": "dolore nostrud",
      "message": "Lorem voluptate Ut id"
    },
    {
      "error_id": "incididunt do Ut",
      "field": "consectetur",
      "message": "proident dolore dolore voluptate sit"
    },
    {
      "error_id": "sunt mollit dolor",
      "field": "ad nulla adipisicing fugiat anim",
      "message": "et in occaecat"
    },
    {
      "error_id": "officia ex quis",
      "field": "reprehenderit",
      "message": "in quis laboris"
    }
  ]
}
Query Parameter NameExample
page_size4081710
page_tokenreprehenderit nostrud sit
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
{
  "contacts": [
    {
      "address_line_1": "dolor ea",
      "address_line_2": "deserunt aliqua ut aute",
      "alternate_emails": [
        "adipisicing nulla irure mollit",
        "aliquip sint nisi est",
        "consequat ut quis",
        "Ut",
        "non"
      ],
      "city": "deserunt",
      "country": "sed in laborum",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "aliqua Lorem sint",
      "first_name": "consequ",
      "last_name": "velit",
      "postal_code": "consequat officia in",
      "state_province_region": "Duis commodo enim ipsum cillu"
    },
    {
      "address_line_1": "ut ad aliqua Excepteur",
      "address_line_2": "consectetur cupidatat commodo adipisici",
      "alternate_emails": [
        "fugiat aute Excepteur cupidatat",
        "esse laborum Lorem pariatur eu",
        "est tempor voluptate eu ipsum",
        "sunt elit fugiat",
        "Duis"
      ],
      "city": "occaecat cillum quis",
      "country": "nisi Lorem veniam reprehenderit n",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "pariatur mollit amet est",
      "first_name": "sed ea",
      "last_name": "amet occaecat ullamco et",
      "postal_code": "Excepteur laboris commodo",
      "state_province_region": "paria"
    },
    {
      "address_line_1": "quis in sun",
      "address_line_2": "commodo in",
      "alternate_emails": [
        "non",
        "do eiusmod exercitation voluptate",
        "esse culpa aliquip mollit non",
        "sint anim minim",
        "anim"
      ],
      "city": "ut fugiat nulla",
      "country": "dolor ut aliqua amet",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "anim in do",
      "first_name": "proident exercitation nostrud adipisi",
      "last_name": "exercitation ",
      "postal_code": "mollit officia laborum",
      "state_province_region": "tempor in"
    },
    {
      "address_line_1": "officia eu",
      "address_line_2": "occaecat",
      "alternate_emails": [
        "officia aliqua in in",
        "in elit eiusmod amet qui",
        "dolor in nostrud occaecat sit",
        "sed",
        "adipisicing cillum consectetur nulla voluptate"
      ],
      "city": "aute id",
      "country": "nisi in",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "dolor ut ex",
      "first_name": "aliqua",
      "last_name": "aute Duis elit exercitation",
      "postal_code": "dolore minim",
      "state_province_region": "do"
    },
    {
      "address_line_1": "sit dolor et",
      "address_line_2": "officia ut",
      "alternate_emails": [
        "adipisicing nostrud mini",
        "in deserunt",
        "ex",
        "commodo",
        "qui ipsum"
      ],
      "city": "moll",
      "country": "in dolor dolor consequat",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "nulla enim deserunt laborum id",
      "first_name": "incididunt proident",
      "last_name": "minim do",
      "postal_code": "labore eiusmod consectetur",
      "state_province_region": "cupidatat"
    },
    {
      "address_line_1": "consectetur",
      "address_line_2": "sed consectetur sint nisi veniam",
      "alternate_emails": [
        "mollit fugiat",
        "quis nostrud",
        "pariatur sint velit ullamco ea",
        "dolor laboris id",
        "sunt"
      ],
      "city": "nostrud officia",
      "country": "nisi proident laborum laboris",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "non amet sint occaecat",
      "first_name": "enim",
      "last_name": "Duis et in",
      "postal_code": "deserunt dolor ex",
      "state_province_region": "dolore fugia"
    },
    {
      "address_line_1": "aute do laborum",
      "address_line_2": "exercitation Excepteur veniam ex",
      "alternate_emails": [
        "sit ut Lorem ullamco consectetur",
        "id cupidatat labore dolore",
        "ullamco consequat sunt",
        "est Lorem",
        "Lorem ipsum exercitation"
      ],
      "city": "aute aliqua enim",
      "country": "est",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "ea laboris consequat qui",
      "first_name": "esse",
      "last_name": "culpa magna labore eiusmod",
      "postal_code": "aliqua qui",
      "state_province_region": "qui deserunt"
    },
    {
      "address_line_1": "esse magna",
      "address_line_2": "in",
      "alternate_emails": [
        "pariatur",
        "irure amet sunt consectetur",
        "consequat",
        "qui consequat",
        "elit adipisicing anim laborum"
      ],
      "city": "ullamco d",
      "country": "",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "consequat ut",
      "first_name": "nisi aliquip in aute",
      "last_name": "proident ",
      "postal_code": "mollit in est aliqua dolore",
      "state_province_region": "sed dolor"
    },
    {
      "address_line_1": "esse",
      "address_line_2": "adipisicing aute minim Duis",
      "alternate_emails": [
        "ex nulla",
        "tempor commodo proident",
        "deserunt ullamco",
        "reprehenderit aliqua",
        "et"
      ],
      "city": "ea",
      "country": "aliqu",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "occaecat cupidatat",
      "first_name": "commodo ea in velit",
      "last_name": "anim proident qui culpa",
      "postal_code": "eu voluptate eiusmod",
      "state_province_region": "tempor esse"
    },
    {
      "address_line_1": "in elit irure pariatur esse",
      "address_line_2": "velit ullamco",
      "alternate_emails": [
        "in dolore",
        "cillum eiusmod",
        "irure",
        "ea exercitation",
        "voluptate in sed"
      ],
      "city": "aliqua voluptate",
      "country": "",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "Duis ipsum",
      "first_name": "al",
      "last_name": "ullamco",
      "postal_code": "consequat esse",
      "state_province_region": "nulla mollit proident tempo"
    }
  ],
  "list_ids": [
    "b14ecc44-35d4-4d72-64b9-668f852dccbf",
    "b3862d7c-3389-384f-20a9-9e71a40e8940",
    "133938aa-8e9d-e2c1-737b-0f505b2adcfc",
    "e6d45e0d-7b66-1508-16b1-e145c20fbfcd"
  ]
}
Response Payload
{
  "job_id": "exercitation pariatur magna tempor"
}
{
  "errors": [
    {
      "error_id": "quis",
      "field": "pariatur dolor officia non voluptate",
      "message": "in dolor cillum occaecat esse",
      "parameter": "culpa in ad"
    },
    {
      "error_id": "exercitation nostrud",
      "field": "veniam",
      "message": "reprehenderit",
      "parameter": "dolor"
    },
    {
      "error_id": "laborum occaecat dolor",
      "field": "Lorem reprehenderit",
      "message": "aliquip",
      "parameter": "qui Excepteur nisi"
    },
    {
      "error_id": "nisi in adipisicing Ut mollit",
      "field": "reprehenderit adipisicing in",
      "message": "est deserunt",
      "parameter": "nulla laborum in"
    },
    {
      "error_id": "Lorem",
      "field": "exercitation anim sed",
      "message": "id culpa laboris incididunt",
      "parameter": "Ut occaecat in fugiat"
    }
  ]
}
{
  "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"
    },
    {
      "message": "sit esse laboris voluptate"
    },
    {
      "message": "adipisicing sunt ex"
    },
    {
      "message": "minim occaecat deserunt Duis dolor"
    }
  ]
}
Query Parameter NameExample
delete_all_contactsanim ex
idsoccaecat id dolore
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": "nostrud anim"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "self": "pariatur sed quis esse Ut"
  },
  "contact_count": -24675503,
  "result": [
    {
      "_metadata": {
        "self": "consequat mollit deserunt do consectetur"
      },
      "address_line_1": "velit sit aute",
      "address_line_2": "laborum veniam culpa in",
      "alternate_emails": [
        "sint in ut aute ipsum",
        "sit",
        "ipsum officia nostrud"
      ],
      "city": "enim magna sunt in minim",
      "country": "labore dolore sint exercitation amet",
      "created_at": "non",
      "custom_fields": {},
      "email": "ea pariatur aliqua in",
      "facebook": "deserunt officia qui",
      "first_name": "dolore Duis Lorem fugiat in",
      "id": "voluptate dolor laboris reprehenderit",
      "last_name": "id",
      "line": "exercitation quis ex",
      "list_ids": [
        "dolor",
        "ad"
      ],
      "phone_number": "ad aliquip eu sit sed",
      "postal_code": "in",
      "segment_ids": [
        "reprehenderit id",
        "occaecat eu",
        "voluptate"
      ],
      "state_province_region": "incididunt",
      "unique_name": "velit in",
      "updated_at": "adipisicing anim Lorem magna",
      "whatsapp": "officia non eiusmod"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "consectetur enim",
      "field": "est culpa aliqua in exercitation",
      "message": "quis voluptate ad Ut aute",
      "parameter": "officia est dolor"
    },
    {
      "error_id": "mollit",
      "field": "minim laborum",
      "message": "ipsum",
      "parameter": "adipisicing est nostrud irure nisi"
    },
    {
      "error_id": "ea anim eiusmod aliquip",
      "field": "amet sint elit culpa",
      "message": "incididunt esse pariatur",
      "parameter": "ut minim laborum exercitation aliqua"
    },
    {
      "error_id": "velit Lorem aliquip dolore",
      "field": "veniam exercitation dolore do",
      "message": "exercitation ut in ullamco",
      "parameter": "proident deserunt enim"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "dolore cupidatat quis commodo"
    },
    {
      "message": "veniam"
    },
    {
      "message": "velit occaecat veniam eiusmod nulla"
    },
    {
      "message": "esse"
    }
  ]
}
Request Payload
Response Payload
{
  "billable_breakdown": {
    "breakdown": {},
    "total": -45569586
  },
  "billable_count": 47238468,
  "contact_count": -96536544
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "laboris"
    },
    {
      "message": "laboris"
    }
  ]
}
Request Payload
{
  "file_type": "csv",
  "list_ids": [
    "bdda8767-71e5-86b7-0821-f313cf810070",
    "7256688a-0a4d-e14c-dbdc-d3e86dc19844",
    "bae71e34-1bce-9a92-8e39-bde1c20fb8a6",
    "084614ca-91b2-f8b6-4564-8f95548972a8"
  ],
  "max_file_size": 31774098,
  "notifications": {
    "email": true
  },
  "segment_ids": [
    "nostrud dolor in mollit ipsum"
  ]
}
Response Payload
{
  "_metadata": {
    "count": -61794970.509625815,
    "next": "http://ItsvBXKfiDExajbRfGUEe.liYl9VMcM9aj4EoGyG9HdufLAi",
    "prev": "http://rhjbqYVBVpfmJkzoHsQTGvVOR.zzcjvzz.oU7YiuQkWs+3GoU-HEkaWtWLdRrddp-bA1WZL7VqiZWOjyM6m",
    "self": "http://AASanfqwjPKNQZIstPSyDYqNhhc.hiRF8pt-lTX3UZkV64uc"
  },
  "id": "occaecat exercitation velit enim cillum"
}
{
  "errors": [
    {
      "error_id": "mollit culpa enim",
      "field": "ex laboris pariatur elit eu",
      "message": "Ut ea",
      "parameter": "adipisicing aute"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "exercitation eu veniam in id"
    },
    {
      "message": "nisi ut"
    },
    {
      "message": "nisi irure non nostrud"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "next": "laborum",
    "prev": "elit Duis nisi labore in",
    "self": "anim"
  },
  "result": [
    {
      "_metadata": {
        "next": "non fugiat eu ullamco",
        "prev": "anim ut",
        "self": "exercitation laborum culpa nisi"
      },
      "completed_at": "est ea",
      "created_at": "id aliquip exercitation",
      "expires_at": "cillum culpa reprehenderit Lorem elit",
      "export_type": "anim nulla in incididunt dolor",
      "id": "amet nisi elit",
      "lists": [
        {
          "ID": "minim consectetur id",
          "Name": "dolor laboris aute"
        },
        {
          "ID": "officia consequat",
          "Name": "incididunt qui eu laboris"
        }
      ],
      "segments": [
        {
          "ID": "consequat sit dolore",
          "Name": "Duis"
        }
      ],
      "status": "dolor sunt",
      "urls": [
        "non veniam",
        "deserunt ad esse irure et",
        "exercitation labore non",
        "amet",
        "ullamco dolore ipsum enim"
      ],
      "user_id": "culpa"
    },
    {
      "_metadata": {
        "next": "ex exercitation elit ad",
        "prev": "veniam in aliquip",
        "self": "aute do tempor"
      },
      "completed_at": "magna enim non",
      "created_at": "amet anim",
      "expires_at": "labore ex",
      "export_type": "dolore voluptate",
      "id": "veniam ut nulla laboris officia",
      "lists": [
        {
          "ID": "minim",
          "Name": "elit"
        },
        {
          "ID": "pariatur",
          "Name": "et"
        }
      ],
      "segments": [
        {
          "ID": "ut non nostrud eu",
          "Name": "veniam cupidatat"
        },
        {
          "ID": "aliquip fugiat Lorem velit",
          "Name": "dolor amet mollit sed incididunt"
        },
        {
          "ID": "magna laboris est occaecat",
          "Name": "quis fugiat et nisi"
        },
        {
          "ID": "commodo",
          "Name": "est sit aliqua velit"
        }
      ],
      "status": "consequat",
      "urls": [
        "dolor ut pariatur",
        "cillum ut non commodo",
        "exercitation cupidatat ea",
        "amet cupidatat ut nulla",
        "aliqua officia"
      ],
      "user_id": "ipsum ullamco cupidatat cillum"
    }
  ]
}
{
  "errors": [
    {
      "": "et ut reprehenderit",
      "error_id": "magna ut in officia",
      "message": "enim voluptate"
    },
    {
      "": "sunt",
      "error_id": "mollit cupidatat culpa",
      "message": "elit Excepteur"
    },
    {
      "": "officia dolore",
      "error_id": "Excepteur sed non irure",
      "message": "consequat cillum"
    },
    {
      "": "do ut nostrud ipsum sint",
      "error_id": "irure sunt commodo Lorem eiusmod",
      "message": "Ut"
    },
    {
      "": "mollit Lorem tempor velit dolore",
      "error_id": "ut",
      "message": "in labore consequat ut"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ut dolore laboris aliqua"
    },
    {
      "message": "sed aliquip"
    },
    {
      "message": "sed dolore"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "self": "et nisi minim sunt"
  },
  "address_line_1": "nisi dolore dolore",
  "address_line_2": "do exercitation eiusmod",
  "alternate_emails": [
    "ullamco laboris",
    "amet sit laborum in officia",
    "quis",
    "in Excepteur incididunt anim commodo"
  ],
  "city": "officia",
  "country": "do ullamco",
  "created_at": "exercitation id qui",
  "custom_fields": {},
  "email": "ut non sed ad dolor",
  "facebook": "amet ad in veniam aute",
  "first_name": "dolor ad nisi",
  "id": "nisi voluptate elit",
  "last_name": "voluptate consequat aliqua pariatur",
  "line": "officia cillum ullamco",
  "list_ids": [
    "commodo nostrud",
    "amet officia",
    "cillum esse nisi",
    "ullamco"
  ],
  "phone_number": "nostrud aliquip anim officia eiusmod",
  "postal_code": "reprehenderit dolore ipsum",
  "segment_ids": [
    "consequat sint"
  ],
  "state_province_region": "do",
  "unique_name": "voluptate Duis ut est incididunt",
  "updated_at": "occaecat ad minim dolore",
  "whatsapp": "adipisicing sed mollit officia minim"
}
{
  "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": "anim tempor ullamco"
    },
    {
      "message": "eu"
    },
    {
      "message": "magna dolore labore nostrud"
    },
    {
      "message": "dolore consectetur ut amet ex"
    }
  ]
}
Request Payload
{
  "query": "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')"
}
Response Payload
{
  "_metadata": {
    "self": "dolore Ut enim est"
  },
  "contact_count": 82820617.49385527,
  "result": [
    {
      "_metadata": {
        "self": "in consequat sint in"
      },
      "address_line_1": "Ut eu",
      "address_line_2": "veniam",
      "alternate_emails": [
        "occaecat",
        "Lorem dolore non",
        "et elit Duis sunt",
        "qui nisi sed"
      ],
      "city": "Excepteur",
      "country": "sed id qui irure",
      "created_at": "minim proident",
      "custom_fields": {},
      "email": "voluptate ex ullamco deserunt",
      "facebook": "adipisicing elit qui commodo",
      "first_name": "aliquip sit dolor labore do",
      "id": "culpa mollit aliquip in",
      "last_name": "sit",
      "line": "minim ipsum ullamco sint",
      "list_ids": [
        "et culpa ut",
        "est adipisicing cillum reprehenderit",
        "aute consectetur commodo",
        "nisi irure esse"
      ],
      "phone_number": "nisi adipisicing eu",
      "postal_code": "adipisicing in occaecat",
      "segment_ids": [
        "amet quis"
      ],
      "state_province_region": "sunt mollit magna",
      "unique_name": "eu est cupidatat nisi esse",
      "updated_at": "in",
      "whatsapp": "irure proident et"
    },
    {
      "_metadata": {
        "self": "enim sed in incididunt elit"
      },
      "address_line_1": "culpa voluptate dolor fugiat",
      "address_line_2": "aliquip Ut in",
      "alternate_emails": [
        "mollit labore",
        "Duis ex",
        "ut",
        "commodo pariatur est in"
      ],
      "city": "Excepteur ad qui cillum",
      "country": "ut proident",
      "created_at": "aliquip ad",
      "custom_fields": {},
      "email": "ipsum elit ut id dolor",
      "facebook": "ex culpa",
      "first_name": "nulla",
      "id": "mollit voluptate",
      "last_name": "sit magna",
      "line": "voluptate",
      "list_ids": [
        "aute esse anim nulla",
        "proident occaecat magna"
      ],
      "phone_number": "esse ullamco dolore amet culpa",
      "postal_code": "in tempor",
      "segment_ids": [
        "laborum cillum reprehenderit non",
        "id Lorem",
        "consectetur nulla",
        "dolore nostrud",
        "laboris aliqua minim"
      ],
      "state_province_region": "dolor sint in ex",
      "unique_name": "elit ipsum",
      "updated_at": "veniam dolor ut ex adipisicing",
      "whatsapp": "esse"
    },
    {
      "_metadata": {
        "self": "dolore occaecat Ut"
      },
      "address_line_1": "velit ut anim veniam dolor",
      "address_line_2": "veniam laboris",
      "alternate_emails": [
        "pariatur ut ea reprehenderit est",
        "aliqua in nulla laborum Excepteur",
        "minim ut do",
        "est ipsum eu",
        "elit ea adipisicing labore dolor"
      ],
      "city": "esse est ex",
      "country": "eu occaecat",
      "created_at": "tempor eiusmod",
      "custom_fields": {},
      "email": "deserunt esse anim aliquip",
      "facebook": "Ut ea Excepteur in incididunt",
      "first_name": "exercitation minim enim",
      "id": "cillum exercitation do eiusmod",
      "last_name": "occaecat eu enim non",
      "line": "proident",
      "list_ids": [
        "culpa sit"
      ],
      "phone_number": "ut fugiat sit officia",
      "postal_code": "non id",
      "segment_ids": [
        "dolore pariatur Ut"
      ],
      "state_province_region": "laboris",
      "unique_name": "Duis aute esse deserunt in",
      "updated_at": "ex id non anim",
      "whatsapp": "ea"
    },
    {
      "_metadata": {
        "self": "elit labore ut cillum dolore"
      },
      "address_line_1": "labore",
      "address_line_2": "laborum voluptate",
      "alternate_emails": [
        "in anim consequat"
      ],
      "city": "pariatur elit id irure magna",
      "country": "nisi amet proident",
      "created_at": "nostrud",
      "custom_fields": {},
      "email": "Ut dolore deserunt",
      "facebook": "anim dolor",
      "first_name": "elit ipsum voluptate occaecat laboris",
      "id": "ex mollit",
      "last_name": "magna fugiat voluptate deserunt aliqua",
      "line": "tempor pariatur",
      "list_ids": [
        "id laborum",
        "non eu",
        "do"
      ],
      "phone_number": "esse labore aliqua ea",
      "postal_code": "ad do mollit est",
      "segment_ids": [
        "culpa in elit sint",
        "laborum proident"
      ],
      "state_province_region": "anim in aute adipisicing",
      "unique_name": "et sit Excepteur veniam",
      "updated_at": "ipsum",
      "whatsapp": "velit tempor aliqua officia"
    },
    {
      "_metadata": {
        "self": "aute"
      },
      "address_line_1": "dolore do",
      "address_line_2": "est dolor proident",
      "alternate_emails": [
        "do officia sunt dolore consequat",
        "id eiusmod aliqua ea dolor",
        "dolore Excepteur eiusmod reprehenderit"
      ],
      "city": "ex minim officia sint",
      "country": "quis",
      "created_at": "cupidatat elit exercitation et consequat",
      "custom_fields": {},
      "email": "nostrud est",
      "facebook": "labore exercitation in eu nostrud",
      "first_name": "enim nostrud",
      "id": "mollit id est ut",
      "last_name": "consequat",
      "line": "cupidatat",
      "list_ids": [
        "et",
        "ipsum incididunt",
        "voluptate",
        "elit officia"
      ],
      "phone_number": "in",
      "postal_code": "laborum minim",
      "segment_ids": [
        "Ut magna",
        "ad",
        "aliqua Lorem dolore nulla",
        "quis cillum Excepteur elit consectetur",
        "labore voluptate in ut"
      ],
      "state_province_region": "eiusmod nulla ipsum consequat nostrud",
      "unique_name": "qui sint proident ad ut",
      "updated_at": "reprehenderit Ut",
      "whatsapp": "dolore dolor pariatur"
    }
  ]
}
{
  "errors": [
    {
      "field": "qui commodo aliqua anim",
      "message": "ex proident minim"
    },
    {
      "field": "enim qui",
      "message": "Ut"
    }
  ]
}
{
  "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": "deserunt quis"
    },
    {
      "message": "aliquip labore"
    }
  ]
}
Request Payload
{
  "field_mappings": [
    "eiusmod nostrud",
    null,
    null,
    null,
    null
  ],
  "file_type": "csv",
  "list_ids": [
    "elit sit",
    "officia voluptate est",
    "sed ipsum",
    "exercitation",
    "commodo Lorem culpa voluptate ea"
  ]
}
Response Payload
{
  "job_id": "esse deserunt",
  "upload_headers": [
    {
      "header": "laborum",
      "value": "ut aliquip"
    },
    {
      "header": "elit qui irure",
      "value": "in officia"
    }
  ],
  "upload_uri": "ea sit velit amet"
}
{
  "errors": [
    {
      "error_id": "eiusmod cillum cupidatat in elit",
      "field": "irure cillum aliquip dolore",
      "message": "eu Excepteur Lorem in",
      "parameter": "quis culpa sed"
    },
    {
      "error_id": "commodo eu",
      "field": "tempor aute sit",
      "message": "nostrud reprehenderit adipisicing minim",
      "parameter": "adipisicing aliqua Ut ex"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "consectetur incididunt adipisicing in ullamco",
      "field": "ipsum sint laborum dolor nisi",
      "message": "proident occaecat et",
      "parameter": "aute ut tempor"
    },
    {
      "error_id": "ut",
      "field": "in Ut laborum",
      "message": "tempor Excepteur minim incididunt do",
      "parameter": "nostrud cupidatat adipisicing"
    }
  ]
}
{
  "errors": [
    {
      "message": "ex do cillum cupidatat"
    },
    {
      "message": "aliqua dolor"
    }
  ]
}
Request Payload
Response Payload
{
  "finished_at": "esse ut",
  "id": "consequat voluptate et",
  "job_type": "laboris cillum",
  "results": {
    "created_count": 81404084.43252766,
    "deleted_count": 22037522.112905756,
    "errored_count": 63478825.006474584,
    "errors_url": "anim ex minim",
    "requested_count": 19640850.467551857,
    "updated_count": 31297585.021881506
  },
  "started_at": "deserunt",
  "status": "exercitation incididunt labore"
}
{
  "errors": {
    "error_id": "id proident",
    "field": "ea nostrud ex",
    "message": "occaecat non laborum",
    "parameter": "minim aliquip occaecat"
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "deserunt amet qui quis ea"
    },
    {
      "message": "in veniam id dolore eu"
    },
    {
      "message": "nulla in laboris"
    },
    {
      "message": "irure magna tempor occaecat voluptate"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "count": 7322293.093073279,
    "next": "https://WMcfIJIFisfyxsBtMzwsXMsboMgb.yhdoBoXDVxcvbAGP-AGdw,cn1mQWKv",
    "prev": "https://wVML.ocqwy3Xf4Gi5.P4AMwXuzo8Rf",
    "self": "http://FCyoYqHqBJbkJy.vgccNd4SZV,EyfFoIEs6j,+CUkBctX8k5tQ+mho,9DbAWO,7695JQ53rOzRzCH03eewDm"
  },
  "completed_at": "dolor occaecat dolor",
  "contact_count": 78554511,
  "created_at": "dolore ut dolor officia Duis",
  "expires_at": "voluptate Lorem proident",
  "id": "tempor in nisi occaecat sit",
  "message": "nulla",
  "status": "failure",
  "updated_at": "Ut enim sed Excepteur",
  "urls": [
    "nisi",
    "Ut",
    "Excepteur nostrud"
  ]
}
{
  "errors": [
    {
      "error_id": "in aliqua labore officia",
      "field": "non sint",
      "message": "cillum velit quis tempor",
      "parameter": "tempor ut deserunt"
    },
    {
      "error_id": "enim nisi est",
      "field": "commodo",
      "message": "veniam culpa voluptate id",
      "parameter": "culpa sit"
    },
    {
      "error_id": "Duis magna nostrud",
      "field": "veniam pariatur nulla elit dolore",
      "message": "mollit enim in Duis",
      "parameter": "pariatur"
    },
    {
      "error_id": "nisi",
      "field": "eu commodo ex dolore in",
      "message": "dolore consequat quis commodo",
      "parameter": "aliquip sit proident ut"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "consectetur velit eu fugiat"
    },
    {
      "message": "cupidatat"
    },
    {
      "message": "ipsum tempor et"
    }
  ]
}
Request Payload
{
  "ids": [
    "1234",
    "1235"
  ]
}
Response Payload
{
  "result": [
    {
      "_metadata": {
        "self": "laborum in velit eiusmod"
      },
      "address_line_1": "aliqua",
      "address_line_2": "Ut enim",
      "alternate_emails": [
        "qui officia voluptate",
        "cillum consectetur in irure Duis",
        "labore ea"
      ],
      "city": "esse Lorem",
      "country": "dolor",
      "created_at": "adipisicing do sit eu",
      "custom_fields": {},
      "email": "eu aliqua",
      "facebook": "laborum in ad dolore consectetur",
      "first_name": "magna",
      "id": "magna officia",
      "last_name": "quis aliqua in sint",
      "line": "qui nisi sit",
      "list_ids": [
        "qui esse",
        "culpa eiusmod sint",
        "ut eiusmod deserunt consequat",
        "pariatur nostrud tempor ex sed",
        "aliquip pariatur officia esse sint"
      ],
      "phone_number": "eu exercitation",
      "postal_code": "labore amet sed eu quis",
      "segment_ids": [
        "sunt",
        "sint consectetur cillum commodo",
        "anim tempor sunt sed ipsum"
      ],
      "state_province_region": "quis nisi ullamco dolor",
      "unique_name": "eiusmod tempor consequat ex Lorem",
      "updated_at": "dolore consequat nulla dolor ea",
      "whatsapp": "nulla magna"
    },
    {
      "_metadata": {
        "self": "ut"
      },
      "address_line_1": "dolore sunt ut amet sint",
      "address_line_2": "fugiat aliqua adipisicing do",
      "alternate_emails": [
        "et in id",
        "Lorem"
      ],
      "city": "non labore consectetur occaecat exercitation",
      "country": "nisi do laborum ex quis",
      "created_at": "est Ut irure",
      "custom_fields": {},
      "email": "eu nulla sed",
      "facebook": "eiusmod reprehenderit laboris ullamco",
      "first_name": "mollit enim dolor voluptate",
      "id": "magna elit labore reprehenderit",
      "last_name": "do voluptate Duis ullamco",
      "line": "in do",
      "list_ids": [
        "ut dolor",
        "eu id in sint",
        "consequat",
        "aliquip et esse Ut",
        "eu dolore ipsum in"
      ],
      "phone_number": "minim",
      "postal_code": "culpa Duis fugiat",
      "segment_ids": [
        "esse elit",
        "ut aliquip ad aute velit"
      ],
      "state_province_region": "sint sit",
      "unique_name": "eu esse dolor magna est",
      "updated_at": "nostrud laboris",
      "whatsapp": "ex et cillum in"
    },
    {
      "_metadata": {
        "self": "non sint nostrud quis"
      },
      "address_line_1": "dolor laborum commodo",
      "address_line_2": "in adipisicing velit do",
      "alternate_emails": [
        "cillum",
        "Ut est nisi",
        "in consectetur",
        "culpa occaecat laboris velit",
        "aute proident"
      ],
      "city": "incididunt ut",
      "country": "nisi",
      "created_at": "magna nostrud ut reprehenderit",
      "custom_fields": {},
      "email": "reprehenderit aliquip",
      "facebook": "ipsum ex velit",
      "first_name": "dolore esse eu culpa consectetur",
      "id": "amet deserunt laborum proident",
      "last_name": "Lorem mollit velit irure",
      "line": "ex",
      "list_ids": [
        "voluptate laboris ex pariatur",
        "dolore ut consectetur laborum exercitation",
        "eiusmod sed",
        "Lorem Ut sint",
        "non mollit aute"
      ],
      "phone_number": "culpa anim quis",
      "postal_code": "Ut velit ipsum",
      "segment_ids": [
        "tempor do ipsum",
        "nulla quis incididunt ex",
        "do laboris ex"
      ],
      "state_province_region": "dolore non officia labore Ut",
      "unique_name": "Lorem in",
      "updated_at": "non culpa velit",
      "whatsapp": "dolor ut proident non irure"
    },
    {
      "_metadata": {
        "self": "aute Lorem officia sint"
      },
      "address_line_1": "aute",
      "address_line_2": "eu ullamco culpa",
      "alternate_emails": [
        "do sed veniam",
        "occaecat velit"
      ],
      "city": "est tempor",
      "country": "sed enim pariatur in aliqua",
      "created_at": "laborum",
      "custom_fields": {},
      "email": "nulla laboris est aliquip consequat",
      "facebook": "mollit",
      "first_name": "in et nulla dolor",
      "id": "sunt minim consectetur",
      "last_name": "est elit cupidatat",
      "line": "est",
      "list_ids": [
        "commodo ut minim proident exercitation",
        "id tempor elit sed laborum"
      ],
      "phone_number": "ullamco",
      "postal_code": "voluptate enim Excepteur consectetur sed",
      "segment_ids": [
        "commodo non officia sed id",
        "sit",
        "anim eiusmod",
        "enim amet eu aute dolor",
        "Lorem mollit ipsum velit minim"
      ],
      "state_province_region": "dolore aliqua cillum Ut",
      "unique_name": "culpa sit in",
      "updated_at": "Ut tempor velit",
      "whatsapp": "commodo nostrud"
    },
    {
      "_metadata": {
        "self": "et non do sed magna"
      },
      "address_line_1": "aliquip",
      "address_line_2": "et aliquip",
      "alternate_emails": [
        "esse qui ex deserunt Ut",
        "commodo dolor velit",
        "est"
      ],
      "city": "sint",
      "country": "cupidatat",
      "created_at": "irure nulla",
      "custom_fields": {},
      "email": "Ut Lorem officia nisi quis",
      "facebook": "irure sunt ea non Ut",
      "first_name": "laborum Lorem cupidatat eiusmod",
      "id": "commodo dolor ullamco elit anim",
      "last_name": "ea labore occaecat",
      "line": "eiusmod nulla",
      "list_ids": [
        "cillum aute ut magna",
        "minim aliqua dolor Excepteur",
        "sunt",
        "laboris reprehenderit"
      ],
      "phone_number": "adipisicing laborum culpa dolore",
      "postal_code": "elit et incididunt",
      "segment_ids": [
        "proident dolore cupidatat Ut nulla",
        "non",
        "exercitation ut adipisicing"
      ],
      "state_province_region": "reprehenderit deserunt",
      "unique_name": "voluptate",
      "updated_at": "consequat quis dolore",
      "whatsapp": "esse dolore eiusmod labore"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "et fugiat nostrud Ut enim"
    },
    {
      "message": "amet fugiat ex"
    },
    {
      "message": "sint mollit Duis in"
    },
    {
      "message": "in ad dolor qui"
    }
  ]
}
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": "reprehenderit ea laborum fugiat ex"
    },
    {
      "message": "culpa"
    }
  ]
}

Segmenting Contacts V2 - Beta(5 operations)

Request Payload
{
  "name": "deserunt ",
  "parent_list_ids": [
    "minim consectetur",
    "ex",
    "eiusmod ut Ut cillum",
    "aute ullamco do officia",
    "sunt ipsum Excepteur"
  ],
  "query_dsl": "et consequat adipisicing minim"
}
Response Payload
{
  "contacts_count": 53999513,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "ullamco velit in",
  "id": "4a6061fa-443e-d4a9-9c8e-ccd1080342df",
  "name": "dolor Ut",
  "next_sample_update": "sed ea aliqua proident",
  "parent_list_ids": [
    "sed",
    "in nisi",
    "nostrud",
    "veniam tempor dolore aliquip"
  ],
  "query_dsl": "ullamco pariatur",
  "query_version": "quis",
  "sample_updated_at": "in",
  "status": {
    "error_message": "voluptate",
    "query_validation": "reprehenderit est labore"
  },
  "updated_at": "esse et consectetur incididunt"
}
{
  "errors": [
    {
      "field": "nostrud deserunt ad consectetur in",
      "message": "tempor"
    },
    {
      "field": "pariatur fugiat",
      "message": "pariatur dolor amet"
    }
  ]
}
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": "dolore",
      "message": "minim aute"
    },
    {
      "field": "Ut pariatur sed magna sit",
      "message": "consequat"
    },
    {
      "field": "incididunt quis cupidatat dolor",
      "message": "incididunt minim anim"
    },
    {
      "field": "sed",
      "message": "aliqua amet fugiat"
    }
  ]
}
Query Parameter NameExample
parent_list_idsDuis et
no_parent_list_idtrue
Request Payload
Response Payload
{
  "_metadata": {
    "count": 51938931,
    "next": "http://E.owpiGYa8xr3McwrqCgsCnNY51nNpS7+lsYg6g5bPoE.1unxrp4gQbkq-RorYpD",
    "prev": "https://YatdKqNUNOgFlhhjnwCRhtCjpVjj.ybjwllhSJpv13+0GvtCGXsE",
    "self": "https://lThFSJZARTYezw.fhbje8w37-xrHr0HtG0.PJRn3+PWnt1CZ9RJGPpzYgvCWkVupvYIaQfF32wRMBlBV70MJKJ"
  },
  "contacts_count": -68183839,
  "created_at": "dolore aliquip velit elit laboris",
  "id": "bd34b759-ea33-68b0-41fc-d9d44b7fe4aa",
  "name": "et elit",
  "next_sample_update": "commodo",
  "parent_list_ids": [
    "non labore cillum proident fugiat",
    "sit in ullamco nulla",
    "aliqua ea adipisicing enim occaecat",
    "cupidatat sint laborum"
  ],
  "query_version": "irure anim quis commodo",
  "sample_updated_at": "ut elit labore quis",
  "status": {
    "error_message": "ullamco non adipisicing sit",
    "query_validation": "reprehenderit dolore"
  },
  "updated_at": "dolore"
}
{
  "errors": [
    {
      "field": "sunt",
      "message": "irure ea occaecat labore dolor"
    },
    {
      "field": "elit nostrud incididunt",
      "message": "laboris mollit tempor dolore dolore"
    },
    {
      "field": "elit Excepteur pariatur amet ut",
      "message": "eu Excepteur"
    },
    {
      "field": "ut quis laboris fugiat sunt",
      "message": "ex quis"
    },
    {
      "field": "amet Ut ea ipsum",
      "message": "Lorem"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "ut ex",
      "message": "irure nulla"
    },
    {
      "field": "tempor dolor ut velit",
      "message": "Lorem ex"
    },
    {
      "field": "velit",
      "message": "incididunt aliquip"
    },
    {
      "field": "laborum Lorem labore",
      "message": "id sit eiusmod occaecat"
    }
  ]
}
Request Payload
{
  "name": "id elit qui ",
  "query_dsl": "consectetur pariatur"
}
Response Payload
{
  "contacts_count": -75065231,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "minim est ipsum",
  "id": "ffd33431-da0c-8829-ba9e-008b4a5425c2",
  "name": "voluptate",
  "next_sample_update": "quis enim deserunt culpa",
  "parent_list_ids": [
    "adipisicing consequat veniam est",
    "adipisicing"
  ],
  "query_dsl": "nisi irure qui",
  "query_version": "laborum aliqua",
  "sample_updated_at": "ut",
  "status": {
    "error_message": "Duis dolor",
    "query_validation": "nostrud adipisicing sed ex"
  },
  "updated_at": "in tempor est non aliqua"
}
{
  "errors": [
    {
      "field": "in",
      "message": "eu irure aliquip"
    },
    {
      "field": "do exercitation commodo",
      "message": "in sed Excepteur"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "ea quis officia labore ex",
      "message": "Excepteur"
    }
  ]
}
Query Parameter NameExample
contacts_samplefalse
Request Payload
Response Payload
{
  "contacts_count": -96246051,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "minim voluptate Ut anim in",
  "id": "e32485dd-905a-0fbe-1bdb-3832c0223562",
  "name": "Ut",
  "next_sample_update": "ad",
  "parent_list_ids": [
    "dolor eiusmod aute",
    "labore ut amet",
    "eiusmod Duis non ipsum sint",
    "id Duis",
    "culpa cupidatat"
  ],
  "query_dsl": "nulla elit cillum",
  "query_version": "nostrud",
  "sample_updated_at": "dolore",
  "status": {
    "error_message": "commodo ut ex",
    "query_validation": "consequat dolor"
  },
  "updated_at": "officia in minim ut amet"
}
{
  "errors": [
    {
      "field": "eiusmod non ad",
      "message": "aliqua"
    },
    {
      "field": "dolor nostrud sint dolore consequat",
      "message": "ut"
    },
    {
      "field": "Lorem eu minim laborum eiusmod",
      "message": "aliquip esse in minim aliqua"
    },
    {
      "field": "ut sunt deserunt",
      "message": "pariatur commodo"
    },
    {
      "field": "fugiat aliquip dolore",
      "message": "deserunt aliquip consequat"
    }
  ]
}
{
  "errors": [
    {
      "field": "sint consectetur in enim consequat",
      "message": "dolor elit ex"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "reprehenderit nostrud",
      "message": "aliquip"
    },
    {
      "field": "nisi ex in",
      "message": "aliqua"
    },
    {
      "field": "laboris eu commodo",
      "message": "enim"
    },
    {
      "field": "cupidatat velit et sed consectetur",
      "message": "in exercitation sunt qui"
    },
    {
      "field": "in mollit aliqua fugiat",
      "message": "magna dolore"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "consectetur nulla laborum",
      "message": "dolor"
    },
    {
      "field": "dolor voluptate cillum ad",
      "message": "pariatur aute laboris"
    }
  ]
}

Senders

Header NameExample
on-behalf-of"tempor Excepteur deserunt in nulla"
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"
    },
    {
      "message": "qui voluptate veniam"
    },
    {
      "message": "est non in cupidatat ad"
    },
    {
      "message": "in quis sunt"
    }
  ]
}

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": [
    {
      "error_id": "Excepteur occaecat",
      "field": "magna eu",
      "message": "reprehenderit pariatur consectetur cillum ullamco",
      "parameter": "ut"
    }
  ]
}
Query Parameter NameExample
page_size559.7473768920905
page_tokenlabore esse
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"
}
[
  {
    "error_id": "et nulla exercitation adipisicing",
    "field": "consequat Duis occaecat fugiat nulla",
    "message": "fugiat",
    "parameter": "fugiat enim"
  },
  {
    "error_id": "ipsum dolor ad",
    "field": "cupidatat laboris fugiat eu",
    "message": "qui ut Ut laboris cupidatat",
    "parameter": "sunt sit culpa do ut"
  },
  {
    "error_id": "laboris",
    "field": "Ut nisi",
    "message": "ut veniam sunt",
    "parameter": "dolore proident enim"
  },
  {
    "error_id": "cillum veniam qui",
    "field": "dolor veniam velit reprehenderit",
    "message": "ipsum do eu sunt",
    "parameter": "fugiat pariatur quis"
  },
  {
    "error_id": "mollit ut occaecat",
    "field": "ad magna sit occaecat Excepteur",
    "message": "est deserunt",
    "parameter": "pariatur exercitation et sed consectetur"
  }
]
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": [
    {
      "error_id": "officia et",
      "field": "laboris",
      "message": "commodo ut",
      "parameter": "ullamco labore esse adipisicing proident"
    },
    {
      "error_id": "ut anim dolor",
      "field": "veniam",
      "message": "aliquip est dolore",
      "parameter": "ad cillum et Duis laboris"
    },
    {
      "error_id": "sunt in",
      "field": "labore elit cupidatat",
      "message": "cillum velit",
      "parameter": "amet esse aliqua"
    },
    {
      "error_id": "do",
      "field": "mollit in ad qui",
      "message": "Lorem ipsum ex",
      "parameter": "Duis"
    }
  ]
}
{}
Query Parameter NameExample
delete_contactstrue
Request Payload
Response Payload
{
  "job_id": "abc12312-x3y4-1234-abcd-123qwe456rty"
}
reprehenderit eu cupidatat mollit nulla
{
  "errors": []
}
Query Parameter NameExample
contact_ids*nostrud
Request Payload
Response Payload
{
  "job_id": "ut non"
}
{
  "error_id": "ut non qui",
  "field": "laborum aliquip magna ex",
  "message": "voluptate",
  "parameter": "sint nisi in"
}
{
  "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": [
    {
      "error_id": "voluptate nisi labore ad",
      "field": "amet est esse",
      "message": "Excepteur aliqua mollit",
      "parameter": "deserunt consectetur"
    },
    {
      "error_id": "Ut adipisicing",
      "field": "magna",
      "message": "Excepteur sunt non",
      "parameter": "dolor est exercitation nulla"
    },
    {
      "error_id": "irure sit nisi",
      "field": "do nisi sunt dolore",
      "message": "proident nisi veniam",
      "parameter": "exercitation Ut ullamco consequat"
    }
  ]
}
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": [
    {
      "error_id": "deserunt amet sint commodo",
      "field": "reprehenderit velit aute in",
      "message": "reprehenderit eiusmod laboris id",
      "parameter": "in ad"
    },
    {
      "error_id": "proident cupidatat",
      "field": "est exercitation sed commodo consectetur",
      "message": "sed",
      "parameter": "minim fugiat"
    },
    {
      "error_id": "aliqua laborum",
      "field": "amet ullamco nulla veniam",
      "message": "proident dolore ut",
      "parameter": "tempor sunt"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "do",
      "field": "nostrud",
      "message": "commodo enim reprehenderit ullamco voluptate",
      "parameter": "culpa velit"
    },
    {
      "error_id": "exercitation",
      "field": "ut",
      "message": "enim officia",
      "parameter": "veniam nisi deserunt"
    },
    {
      "error_id": "in Lorem eu",
      "field": "enim dolor",
      "message": "ut",
      "parameter": "irure consectetur aute"
    },
    {
      "error_id": "aliquip minim dolor",
      "field": "in mollit eu dolore pariatur",
      "message": "magna culpa Excepteur laboris commodo",
      "parameter": "proident ullamco in minim velit"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "aliquip cupidatat",
      "field": "Excepteur",
      "message": "minim cupidatat sit proident aliquip",
      "parameter": "velit"
    },
    {
      "error_id": "et do dolore deserunt",
      "field": "esse qui dolore reprehenderit",
      "message": "exercitation in aliqua",
      "parameter": "cupidatat aute amet laborum"
    },
    {
      "error_id": "aliquip ut",
      "field": "sed sint Lorem sit eu",
      "message": "commodo consectetur adipisicing sunt",
      "parameter": "esse"
    }
  ]
}

segmenting contacts(5 operations)

Request Payload
{
  "name": "nisi",
  "parent_list_id": "a6846811-83db-2048-0c9c-1e676aa3bdb0",
  "parent_list_ids": [
    "id laboris deserunt",
    "ut"
  ],
  "query_dsl": "irure Lorem esse mollit"
}
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": "ea qui"
    },
    {
      "message": "ex cillum sed"
    },
    {
      "message": "amet ut aute non occaecat"
    },
    {
      "message": "consectetur dolore magna"
    },
    {
      "message": "incididunt deserunt nulla"
    }
  ]
}
Query Parameter NameExample
parent_list_idslaboris ullamco
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": "aliquip"
    },
    {
      "message": "velit"
    },
    {
      "message": "minim mollit ex laboris ad"
    },
    {
      "message": "sint Duis qui irure id"
    },
    {
      "message": "laborum in aliqua est magna"
    }
  ]
}
Query Parameter NameExample
query_jsontrue
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": [
    {
      "field": "esse",
      "message": "do veniam irure"
    },
    {
      "field": "reprehenderit cupidatat culpa in ullamco",
      "message": "qui"
    }
  ]
}
{
  "errors": [
    {
      "message": "et sint magna quis Ut"
    },
    {
      "message": "incididunt esse"
    },
    {
      "message": "ea officia"
    }
  ]
}
Request Payload
{
  "name": "cupidatat in laborum enim ipsum",
  "parent_list_ids": [
    "enim ex irure reprehenderit culpa",
    "officia occaecat"
  ],
  "query_dsl": "ex mollit pariatur velit"
}
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": [
    {
      "field": "amet ad sunt reprehenderit",
      "message": "velit"
    },
    {
      "field": "nisi consequat",
      "message": "laboris minim"
    },
    {
      "field": "ea in",
      "message": "minim cillum"
    }
  ]
}
{
  "errors": [
    {
      "message": "culpa"
    }
  ]
}
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": [
    {
      "field": "sed consequat nulla",
      "message": "ullamco"
    },
    {
      "field": "aute sed nulla eu",
      "message": "tempor aliqua nisi"
    },
    {
      "field": "Excepteur eiusmod",
      "message": "consectetur do"
    },
    {
      "field": "labore culpa eu Duis adipisicing",
      "message": "nisi fugiat"
    }
  ]
}
{
  "errors": [
    {
      "message": "enim laborum"
    },
    {
      "message": "Ut Duis minim veniam proident"
    }
  ]
}

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": [
    {
      "error": "do",
      "id": "ut",
      "resources": {
        "ids": [
          "est mollit labore eiusmod",
          "cillum sint id aute"
        ],
        "type": "ea voluptate officia sunt"
      }
    },
    {
      "error": "commodo",
      "id": "elit sed fugiat eu",
      "resources": {
        "ids": [
          "in"
        ],
        "type": "dolore velit sunt Duis"
      }
    }
  ]
}
{}
{
  "errors": [
    {
      "field": "ex labore occaecat est esse",
      "message": "nulla in in incididunt fugiat"
    },
    {
      "field": "quis ex dolor id",
      "message": "do nulla"
    },
    {
      "field": "cupidatat proident dolore in",
      "message": "cupidatat mollit voluptate reprehenderit"
    },
    {
      "field": "commodo in",
      "message": "adipisicing ut veniam culpa"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ad sint eu incididunt"
    }
  ]
}

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": [
    {
      "error_id": "cupidatat enim",
      "field": "culpa laborum esse nostrud",
      "message": "minim id sunt esse proident"
    },
    {
      "error_id": "ut Excepteur elit laborum",
      "field": "exercitation aliquip sint ut cupidatat",
      "message": "dolore in"
    },
    {
      "error_id": "Duis",
      "field": "Excepteur ad",
      "message": "in Excepteur consectetur"
    },
    {
      "error_id": "id esse",
      "field": "Lorem et nisi nostrud",
      "message": "ex in minim cupidatat"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "incididunt",
      "field": "enim sit aliqua dolore",
      "message": "magna aute"
    },
    {
      "error_id": "Lorem",
      "field": "mollit",
      "message": "irure"
    },
    {
      "error_id": "officia",
      "field": "aliquip ut aute deserunt",
      "message": "enim eiusmod"
    },
    {
      "error_id": "sed ut",
      "field": "laboris",
      "message": "enim"
    },
    {
      "error_id": "et in labore adipisicing in",
      "field": "veniam non sunt",
      "message": "incididunt"
    }
  ]
}
Query Parameter NameExample
page_size-85852318
page_tokenesse ullamco ut
Request Payload
Response Payload
{
  "_metadata": {
    "count": 10373014,
    "next": "http://PpxTqiQxsaIFBwQVzv.tnbFJFz33S5UTMr9f+sQjRwC4pTFiTLnp7s1QO4GLieQRGs8n+SA7WvZ",
    "prev": "https://V.tblV7KHbuAmX7eRoJfNrJao95duSRNoKxl6QfHrXGCumCJQK",
    "self": "http://XapOHggfRwoTwTYdjCmu.ocaU+5Du6XEJoppW0f2yECw5Vp9IopbP.KRo2E8dIq"
  },
  "result": [
    {
      "abtest": null,
      "categories": [
        "officia ex",
        "officia non sit",
        "id dolor ullamco",
        "culpa in minim anim dolore",
        "ut cillum",
        "Duis minim",
        "ipsum dolor",
        "sint commodo",
        "aliquip exercitation",
        "dolore Duis nisi officia"
      ],
      "created_at": "1904-01-15T15:15:55.0Z",
      "id": "fcec0996-7b93-9c09-4fe6-5369156b0bc6",
      "is_abtest": false,
      "name": "Duis ad irure amet",
      "send_at": "1900-01-09T05:48:29.0Z",
      "status": "draft",
      "updated_at": "1935-12-20T08:09:38.0Z"
    },
    {
      "abtest": null,
      "categories": [
        "id",
        "ex deserunt sunt ut",
        "magna et",
        "voluptate ea",
        "ut nisi veniam dolor quis",
        "in anim ea",
        "Excepteur consectetur elit consequat occaecat",
        "exercitation ullamco Duis nostrud ut",
        "laborum pariatur Lorem proident in",
        "officia in est"
      ],
      "created_at": "1918-03-15T10:13:55.0Z",
      "id": "aac7ff5a-81a6-d754-3aed-d207ed9e54aa",
      "is_abtest": false,
      "name": "dol",
      "send_at": "1962-12-09T17:28:21.0Z",
      "status": "scheduled",
      "updated_at": "1903-02-12T17:35:01.0Z"
    },
    {
      "abtest": {
        "duration": "consequat ad velit esse nisi",
        "expiration_date": null,
        "test_percentage": -15305366,
        "type": "content",
        "winner_criteria": "manual",
        "winner_selected_at": null,
        "winning_template_id": "proident ullamco enim deserunt reprehenderit"
      },
      "categories": [
        "non",
        "fugiat deserunt esse minim anim",
        "in",
        "Duis proident nulla",
        "incididunt quis nulla officia",
        "qui",
        "sunt consequat quis eu ipsum",
        "nisi",
        "Lorem",
        "eu"
      ],
      "created_at": "1962-09-12T21:19:53.0Z",
      "id": "00ee13b9-9453-82aa-c828-16d851966b92",
      "is_abtest": false,
      "name": "sit nostrud reprehenderit",
      "send_at": "1967-05-09T19:46:42.0Z",
      "status": "scheduled",
      "updated_at": "1895-11-19T08:38:08.0Z"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "fugiat Duis",
      "field": "esse velit",
      "message": "voluptate Ut eu Duis"
    },
    {
      "error_id": "ad ut fugiat sit",
      "field": "minim elit non tempor dolor",
      "message": "pariatur"
    },
    {
      "error_id": "mollit",
      "field": "dolor officia qui irure",
      "message": "in voluptate dolore sint"
    },
    {
      "error_id": "dolore esse ullamco non",
      "field": "aliquip qui",
      "message": "esse aliquip minim aute"
    }
  ]
}
Query Parameter NameExample
ids["mollit non id dolor","elit anim sint","eu est ad nostrud sed","occaecat aliqua","veniam dolore id in","Duis eiusmod in","eiusmod in","et ex","ex ipsum","culpa"]
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "mollit aliquip qui",
      "field": "eu reprehenderit adipisicing laboris anim",
      "message": "sed deserunt"
    },
    {
      "error_id": "ad aliqua",
      "field": "nulla cupidatat tempor exercitation",
      "message": "enim"
    },
    {
      "error_id": "fugiat",
      "field": "adipisicing occaecat elit dolore",
      "message": "quis in aute"
    },
    {
      "error_id": "velit et nulla ut commodo",
      "field": "deserunt pariatur",
      "message": "est"
    },
    {
      "error_id": "consectetur occaecat",
      "field": "ea",
      "message": "ipsum dolore consequat magna"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "aliquip",
      "field": "esse voluptate eu",
      "message": "incididunt labore sed"
    }
  ]
}
Request Payload
{
  "name": "proident"
}
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": [
    {
      "error_id": "ut fugiat occaecat in ex",
      "field": "eu aliquip sunt elit",
      "message": "ut fugiat Excepteur sit"
    },
    {
      "error_id": "id ut ea",
      "field": "eiusmod veniam ut",
      "message": "Ut"
    },
    {
      "error_id": "elit enim velit",
      "field": "ad et id ea",
      "message": "nisi do consequat occaecat"
    },
    {
      "error_id": "amet magna eu aute",
      "field": "fugiat",
      "message": "Ut enim ullamco officia cupidatat"
    },
    {
      "error_id": "cupidatat in Lorem",
      "field": "officia",
      "message": "enim ex et"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ut culpa dolore dolor",
      "field": "dolore pariatur ipsum incididunt",
      "message": "occaecat eiusmod dolore voluptate"
    },
    {
      "error_id": "culpa velit adipisicing",
      "field": "et proident sunt in",
      "message": "labore Excepteur Duis"
    },
    {
      "error_id": "officia cillum irure velit nisi",
      "field": "ut sunt anim eiusmod",
      "message": "qui proident tempor cillum dolor"
    }
  ]
}
Request Payload
{
  "categories": [
    "labore magna ea id deserunt",
    "anim",
    "ea dolore incididunt",
    "culpa amet exercitation dolor sit",
    "magna",
    "dolor sint",
    "sit ipsum nulla",
    "commodo proident Lorem",
    "consequat",
    "amet Lorem aute eiusmod"
  ],
  "email_config": {
    "custom_unsubscribe_url": null,
    "design_id": "deserunt esse",
    "editor": "code",
    "generate_plain_content": false,
    "html_content": "Excepteur velit labore in",
    "ip_pool": null,
    "plain_content": "magna mollit pariatur nulla in",
    "sender_id": 38638789,
    "subject": "nostrud incididunt occaecat",
    "suppression_group_id": null
  },
  "name": "laborum consec",
  "send_at": "1964-03-09T01:38:59.0Z",
  "send_to": {
    "all": false,
    "list_ids": [
      "b327d71e-b2ed-910f-040b-4ce6ccd04c65",
      "92b54976-9e54-cba2-8ac7-aaefa7aee4e4",
      "bb8dc6c0-8943-a347-5958-d48b563999a7",
      "c1a94982-fae3-e235-1426-1a26ad01de1f",
      "a017d92a-089e-b44c-a5bd-ae8cd46994d5",
      "631918c3-6bba-d497-c2f4-71f703c9c723",
      "103d49d0-9409-a910-236a-6c4821967bcf",
      "076756e7-9f68-dc02-ed24-9ba00d3484b0",
      "fd18eb77-2ecc-cc6a-c700-ef5e66bd3844",
      "fc6a9564-51e6-c7ee-688b-05c0330ced96"
    ],
    "segment_ids": [
      "fe74861f-e2d4-60e4-579c-a00df6d999ac",
      "85a830e3-6451-837c-7ce9-fc2b705143dc",
      "8ef85267-34e3-cc9e-ee87-96116fe3b1b9",
      "5560ec76-841c-df49-e051-8958a67ab09d",
      "6b3498d1-460e-5dbe-31bc-7adb475a2674",
      "ddf9cfcc-7bd9-70c0-9be1-420b47b72816",
      "3ea9f987-2451-08a9-efee-7c1e453fd653",
      "6e0c70f8-f527-75c0-9031-999f11ffb9f5",
      "606cd059-fe3a-9fc7-2018-1feb3c53023a",
      "b5f0b5aa-b64b-37ea-1503-f61b37824181"
    ]
  }
}
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": [
    {
      "error_id": "eu dolore proident enim",
      "field": "tempor",
      "message": "sunt cupidatat"
    },
    {
      "error_id": "commodo in magna",
      "field": "adipisicing proident quis",
      "message": "proident aute"
    },
    {
      "error_id": "sunt sit incididunt",
      "field": "ipsum",
      "message": "pariatur"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "tempor consequat",
      "field": "magna",
      "message": "fugiat"
    },
    {
      "error_id": "cupidatat non laborum id ut",
      "field": "aliqua consequat nostrud",
      "message": "et veniam deserunt elit occaecat"
    },
    {
      "error_id": "velit",
      "field": "velit",
      "message": "ex laboris"
    },
    {
      "error_id": "est proident Excepteur",
      "field": "Ut",
      "message": "nostrud"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "incididunt eu qui minim",
      "field": "commodo",
      "message": "adipisicing sint"
    },
    {
      "error_id": "nulla dolor pariatur quis minim",
      "field": "mollit laborum",
      "message": "dolor officia"
    },
    {
      "error_id": "cupidatat",
      "field": "do proident Ut",
      "message": "pariatur mollit dolor ipsum"
    }
  ]
}
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": [
    {
      "error_id": "id",
      "field": "sunt aute",
      "message": "voluptate enim ullamco tempor"
    },
    {
      "error_id": "est adipisicing sunt in",
      "field": "sunt labore enim",
      "message": "ullamco irure ut aliqua"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "velit aliquip",
      "field": "id in",
      "message": "ut amet pariatur"
    },
    {
      "error_id": "cupidatat elit dolor",
      "field": "aliqua occaecat in fugiat ea",
      "message": "aute ex amet in incididunt"
    },
    {
      "error_id": "culpa aliquip id dolor voluptate",
      "field": "consequat",
      "message": "fugiat"
    },
    {
      "error_id": "dolor dolore irure",
      "field": "aliqua ut magna",
      "message": "voluptate in pariatur"
    },
    {
      "error_id": "in dolor dolore aliqua",
      "field": "sint dolor ipsum velit",
      "message": "consectetur non pariatur"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "adipisicing",
      "field": "veniam Duis",
      "message": "aute"
    },
    {
      "error_id": "nostrud id Duis ex",
      "field": "Ut quis reprehenderit et",
      "message": "in"
    },
    {
      "error_id": "commodo dolor eu velit minim",
      "field": "magna laboris consequat sed",
      "message": "Duis pariatur Ut dolor enim"
    },
    {
      "error_id": "nostrud dolore eu irure",
      "field": "do amet",
      "message": "in"
    },
    {
      "error_id": "enim",
      "field": "do veniam dolor labore",
      "message": "id"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "laborum irure consequat",
      "field": "qui",
      "message": "nisi"
    },
    {
      "error_id": "velit Duis",
      "field": "magna aliqua",
      "message": "cupidatat sunt ipsum laboris"
    },
    {
      "error_id": "Ut ut esse sunt do",
      "field": "Excepteur sint tempor ex",
      "message": "dolor reprehenderit qui laboris voluptate"
    }
  ]
}
Query Parameter NameExample
page_size27447572
page_tokenvelit mollit
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": [
    {
      "error_id": "incididunt",
      "field": "enim ut exercitation et",
      "message": "sunt dolor"
    },
    {
      "error_id": "in nisi",
      "field": "in officia sunt cupidatat",
      "message": "ut irure minim"
    },
    {
      "error_id": "Excepteur in do sint",
      "field": "ut dolor ex tempor sunt",
      "message": "tempor in fugiat laboris deserunt"
    },
    {
      "error_id": "ipsum incididunt aliqua quis",
      "field": "reprehenderit voluptate Ut",
      "message": "fugiat amet in adipisicing"
    },
    {
      "error_id": "reprehenderit do",
      "field": "ut in laborum",
      "message": "nulla laboris ex aliqua"
    }
  ]
}
Request Payload
{
  "send_at": "3752-01-28T23:21:52.575Z"
}
Response Payload
{
  "send_at": "3752-01-28T23:21:52.575Z",
  "status": "scheduled"
}
{
  "errors": [
    {
      "error_id": "ex nostrud",
      "field": "veniam do aliquip",
      "message": "ut"
    },
    {
      "error_id": "in elit",
      "field": "Duis est nulla eiusmod",
      "message": "ea incididunt culpa"
    },
    {
      "error_id": "ut ipsum enim deserunt",
      "field": "pariatur dolore",
      "message": "Excepteur ad dolore"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "voluptate",
      "field": "dolore consectetur",
      "message": "id do labore proident"
    },
    {
      "error_id": "proident in pariatur aliquip",
      "field": "officia elit culpa commodo eiusmod",
      "message": "dolore"
    },
    {
      "error_id": "Duis laborum",
      "field": "anim id consectetur cupidatat",
      "message": "nulla sit minim"
    },
    {
      "error_id": "voluptate pariatur",
      "field": "ea qui cupidatat mollit",
      "message": "eu sed nisi ut nulla"
    }
  ]
}
Request Payload
Response Payload
{
  "send_at": "1906-05-06T17:45:34.0Z",
  "status": "triggered"
}
{
  "errors": [
    {
      "error_id": "eiusmod ex",
      "field": "deserunt nostrud in sunt proident",
      "message": "sit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "laboris eu dolor nostrud",
      "field": "esse cupidatat irure ut adipisicing",
      "message": "Ut"
    },
    {
      "error_id": "in cupidatat et pariatur",
      "field": "tempor cillum elit commodo",
      "message": "pariatur sit dolor"
    },
    {
      "error_id": "amet in est",
      "field": "esse ex",
      "message": "reprehenderit adipisicing sit deserunt Duis"
    },
    {
      "error_id": "in ea nulla enim",
      "field": "ut",
      "message": "adipisicing tempor ullamco"
    }
  ]
}
Request Payload
Response Payload
{
  "categories": [
    "equipment",
    "shoes",
    "sports"
  ]
}
{
  "errors": [
    {
      "error_id": "aliqua",
      "field": "sit ad enim",
      "message": "reprehenderit"
    },
    {
      "error_id": "officia cillum ut elit tempor",
      "field": "et dolor deserunt in elit",
      "message": "ea"
    },
    {
      "error_id": "do nisi dolor nostrud",
      "field": "cillum sint eu magna",
      "message": "veniam sunt"
    },
    {
      "error_id": "laborum ipsum esse nisi",
      "field": "Duis ut",
      "message": "velit ipsum Duis elit do"
    }
  ]
}

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["cupidatat pariatur ut","labore","Duis","dolor non pariatur esse","esse occaecat","elit ex consequat mollit","qui","in magna est aute","incididunt minim","ut sit ut ex culpa"]
page_size36
page_tokenipsum et eiusmod Duis laborum
Request Payload
Response Payload
{
  "_metadata": {
    "count": -5932217.6107047945,
    "next": "http://QhIEOGdOTOGkB.gdpujwTWuL4b5HaVZHyfyx+F45+KiFW9Jcnz2WGEUKaq8VjJXp8721Tl",
    "prev": "http://ZOHFbzQjxdYOCFPNedIMmSscZhH.evlqODJ.w+Y3GaoLtS5jrXArGkEJeopzeJMqC7NdgkJ",
    "self": "http://DZugjmilBdp.srcA4yxqNyELVMJwKRv,cCvHBilxMSB5gRwVX5jig68Miz5tObogBeth6sckQ"
  },
  "results": [
    {
      "aggregation": "quis",
      "id": "5303a80f-1d36-0183-9826-f00a1839434a",
      "stats": {
        "bounce_drops": -93937673,
        "bounces": -12783905,
        "clicks": 5785893,
        "delivered": 51445083,
        "invalid_emails": -35279082,
        "opens": 80829274,
        "requests": -38346601,
        "spam_report_drops": -89436325,
        "spam_reports": -59981431,
        "unique_clicks": -54298043,
        "unique_opens": 72271796,
        "unsubscribes": -52619771
      },
      "step_id": "magna Ut Duis sint voluptate"
    },
    {
      "aggregation": "dolore sunt culpa dolor velit",
      "id": "7bdb80a4-5725-6c3e-fb80-28be7b6a88b0",
      "stats": {
        "bounce_drops": 84044049,
        "bounces": -82588182,
        "clicks": 22722921,
        "delivered": -85737191,
        "invalid_emails": 98504769,
        "opens": 62012938,
        "requests": -27550544,
        "spam_report_drops": 60314903,
        "spam_reports": 71884783,
        "unique_clicks": 50767799,
        "unique_opens": 63837166,
        "unsubscribes": -43210474
      },
      "step_id": "quis et cillum anim"
    },
    {
      "aggregation": "nostrud occaecat cupidatat eu",
      "id": "ee98854a-19a4-0d4f-5589-45eae4a6485c",
      "stats": {
        "bounce_drops": 93761654,
        "bounces": -2542101,
        "clicks": -12157203,
        "delivered": 54605837,
        "invalid_emails": -56498396,
        "opens": -93458868,
        "requests": -32877030,
        "spam_report_drops": -55636778,
        "spam_reports": -23044680,
        "unique_clicks": 68315281,
        "unique_opens": 47798539,
        "unsubscribes": 21006511
      },
      "step_id": "pariatur"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
group_by["step_id"]
step_ids["fed1a67a-25cd-bac3-0138-795d260e76a0"]
aggregated_byday
start_date1890-09-01
end_date1898-11-27
timezonequi anim officia Lorem consectetur
page_size85
page_tokeneu consequat nisi tempor eiusmod
Request Payload
Response Payload
{
  "_metadata": {
    "count": 91254943.06992051,
    "next": "https://BfSCSfUnOtingV.orxHTQqhLgOnn9MgV,Bavh.2YbPjnd96,uq",
    "prev": "https://rTusffhoidPzwhklJnGh.fsnwtuKgP3-1DKlYcqjo8bdYPKKMHQZh1FwOkYdF90AkV-vGakl",
    "self": "https://LXWsOUy.jxD6I+0mrpLyoDSIwIh,PU2WEkAzE"
  },
  "results": [
    {
      "aggregation": "est ut Lorem",
      "id": "b8c554a0-59e9-cb84-cf03-7e15ce0972b4",
      "stats": {
        "bounce_drops": 14575798,
        "bounces": -46342354,
        "clicks": -38468442,
        "delivered": -32667795,
        "invalid_emails": -88824676,
        "opens": -8965083,
        "requests": 56649249,
        "spam_report_drops": 79158577,
        "spam_reports": -46015587,
        "unique_clicks": 8606748,
        "unique_opens": 43152773,
        "unsubscribes": 42815889
      },
      "step_id": "labore aliqua velit"
    },
    {
      "aggregation": "ea laborum ut sed mollit",
      "id": "c1b09da1-1018-fb8f-c0c5-9d695a756288",
      "stats": {
        "bounce_drops": 33087511,
        "bounces": 12163546,
        "clicks": 79162068,
        "delivered": 46366425,
        "invalid_emails": 29981040,
        "opens": 14914526,
        "requests": 79289981,
        "spam_report_drops": -17750213,
        "spam_reports": 6294632,
        "unique_clicks": 28833301,
        "unique_opens": -58251856,
        "unsubscribes": 1037597
      },
      "step_id": "ex exercitation commodo sint"
    },
    {
      "aggregation": "in",
      "id": "d23fcde0-7d23-6db4-1617-7ba2aa9ff45a",
      "stats": {
        "bounce_drops": -25393764,
        "bounces": 16411906,
        "clicks": 65899757,
        "delivered": -22600004,
        "invalid_emails": 4735784,
        "opens": -59697275,
        "requests": 69183813,
        "spam_report_drops": 82580780,
        "spam_reports": 2994395,
        "unique_clicks": 99465599,
        "unique_opens": 64401739,
        "unsubscribes": 46022763
      },
      "step_id": "sit nulla esse"
    }
  ]
}
{
  "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["consectetur minim esse veniam","culpa proident","esse","est","exercitation proident non","laboris nisi","exercitation sit sed","amet adipisicing anim non sed","mollit dolor labore","cillum velit culpa enim"]
page_size36
page_tokenipsum esse eu id nostrud
Request Payload
Response Payload
{
  "_metadata": {
    "count": 81774064.21385679,
    "next": "https://bA.ghcetCLG.O1Ks,UA4Wm-xTy3ERY1Fz9HKFGpWrRzD9QUhvhqa1xXWiUbJmtJHdhw+btPWpHdUD",
    "prev": "https://wYYZIbfhwWpPQdqbZlsW.hta4zZMXFiRMwiy84PZe7-cufR+SuivE9LMqQDECjuot8hyrWN6tk.6nIF9Lcjw",
    "self": "https://kvBMyO.efrsSAg6mqfAYXxvlQkGB+y736M03Tf-3GjeIeS1MTqX8jlgexm"
  },
  "results": [
    {
      "ab_phase": "test",
      "ab_variation": "f0b97283-db96-b511-67d1-61f555846e72",
      "aggregation": "Lorem Excepteur",
      "id": "56cc9e26-305b-2040-b180-a10a13190a59",
      "stats": {
        "bounce_drops": -97236868,
        "bounces": 86925715,
        "clicks": -58652691,
        "delivered": -21634251,
        "invalid_emails": 22733469,
        "opens": 37163457,
        "requests": -33314338,
        "spam_report_drops": 98144413,
        "spam_reports": 59811912,
        "unique_clicks": 31822267,
        "unique_opens": -65915387,
        "unsubscribes": -11566807
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "92dedc3c-55b9-d950-5337-e24c2438075f",
      "aggregation": "fugiat incididunt",
      "id": "08c07dd3-cf39-496c-fddf-5b7cb0992fb1",
      "stats": {
        "bounce_drops": 93107961,
        "bounces": -54772225,
        "clicks": 82674293,
        "delivered": 38745389,
        "invalid_emails": 64278926,
        "opens": 46135732,
        "requests": 35833067,
        "spam_report_drops": 26241296,
        "spam_reports": -80043886,
        "unique_clicks": -44963503,
        "unique_opens": 7779880,
        "unsubscribes": -26443611
      }
    },
    {
      "ab_phase": "all",
      "ab_variation": "b527964e-69dc-fbaf-084b-e99f7fad6055",
      "aggregation": "in esse do Excepteur ullamco",
      "id": "5d3f9265-a34f-745d-12cc-c4239287f81b",
      "stats": {
        "bounce_drops": -28391713,
        "bounces": 48909737,
        "clicks": -61779899,
        "delivered": 9584002,
        "invalid_emails": 36639573,
        "opens": 42209496,
        "requests": 65593834,
        "spam_report_drops": 85379065,
        "spam_reports": -24266830,
        "unique_clicks": 76174937,
        "unique_opens": -87600051,
        "unsubscribes": 87668398
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "a2997b1b-4832-8bae-2360-e9007e12a257",
      "aggregation": "nostrud ullamco sunt",
      "id": "f171fee0-a857-e244-4580-acfaffa2d8fa",
      "stats": {
        "bounce_drops": -91308591,
        "bounces": 32364420,
        "clicks": -6976513,
        "delivered": -99134473,
        "invalid_emails": 63692824,
        "opens": 48073445,
        "requests": -31696529,
        "spam_report_drops": -33510524,
        "spam_reports": -80561636,
        "unique_clicks": 93113679,
        "unique_opens": -25812824,
        "unsubscribes": 15356284
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "748b1653-1f63-75f5-c907-87fcb91e8a3a",
      "aggregation": "culpa magna occaecat",
      "id": "bfdd9d19-8ac1-d2ec-21e3-58f7130765ec",
      "stats": {
        "bounce_drops": -47227440,
        "bounces": 65005722,
        "clicks": 90943680,
        "delivered": 34781636,
        "invalid_emails": 90301888,
        "opens": -91871612,
        "requests": -28587374,
        "spam_report_drops": -17489357,
        "spam_reports": -49328317,
        "unique_clicks": 65530348,
        "unique_opens": 42341045,
        "unsubscribes": -50072972
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
aggregated_byday
start_date1954-05-27
end_date1934-11-22
timezonelaborum
page_size61
page_tokenculpa
group_by["ab_variation","ab_variation","ab_phase","ab_variation"]
Request Payload
Response Payload
{
  "_metadata": {
    "count": 3764579.395513445,
    "next": "http://gFTdOQnruBuDApItjyD.bcpyaCYswqcYOVDATnY-r54PxFil0nDT6q7kavczVtIrJHLDrcF2+2FbTUfnNSEmMO6gGYKnUHbod",
    "prev": "http://iRDjlcwZGXDsOAkOkRyZ.euzd9Wk1oRvrcm7dN8pbn4Fp6OzUcKHS.n1yZFo-mpUCamrElHnA.R7y",
    "self": "https://DAKRN.lntoEeTMztMRTFQYZSsHZt7eMmVhexl1MqtO5MZfW33p.ngVznR.sdvtO9wJ67,A89mCbo8"
  },
  "results": [
    {
      "ab_phase": "all",
      "ab_variation": "407fffbe-d80f-72be-fa3d-adce8c25d3ac",
      "aggregation": "officia eiusmod occaecat",
      "id": "62e0e65a-bef1-9761-4f85-0fd6e44755e6",
      "stats": {
        "bounce_drops": -6229500,
        "bounces": 46301835,
        "clicks": -93779045,
        "delivered": -33331945,
        "invalid_emails": -36692381,
        "opens": -41928904,
        "requests": 12278452,
        "spam_report_drops": -46702802,
        "spam_reports": -40689147,
        "unique_clicks": -82589148,
        "unique_opens": 54056730,
        "unsubscribes": -97068505
      }
    },
    {
      "ab_phase": "send",
      "ab_variation": "930353e7-1a62-2666-ffb2-292c2ab7f0da",
      "aggregation": "ad est ipsum sint",
      "id": "ca3fea35-b8db-0473-2789-4c99cd3f1fb1",
      "stats": {
        "bounce_drops": 89653797,
        "bounces": 94882152,
        "clicks": 43810107,
        "delivered": 71478536,
        "invalid_emails": -30046982,
        "opens": -32909874,
        "requests": -42413181,
        "spam_report_drops": -62042066,
        "spam_reports": -24023078,
        "unique_clicks": -72262110,
        "unique_opens": -10230489,
        "unsubscribes": -60240284
      }
    },
    {
      "ab_phase": "send",
      "ab_variation": "91fc54ea-718a-a956-ed59-e6a92ac12ee2",
      "aggregation": "exercitation enim",
      "id": "6005f0cb-a793-96d5-9c44-98406a91b2bd",
      "stats": {
        "bounce_drops": 59120815,
        "bounces": -86211112,
        "clicks": -1779159,
        "delivered": 67633813,
        "invalid_emails": -30929233,
        "opens": -93864238,
        "requests": -87646501,
        "spam_report_drops": 90223932,
        "spam_reports": 66617374,
        "unique_clicks": 3677145,
        "unique_opens": 65167940,
        "unsubscribes": 70876493
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "5b79fa1d-3a42-85fb-a9d4-1559ccb08801",
      "aggregation": "id",
      "id": "3c666efd-bae2-cac7-078d-0ad409f088b8",
      "stats": {
        "bounce_drops": -28763741,
        "bounces": -5311887,
        "clicks": 64074754,
        "delivered": -80887754,
        "invalid_emails": 48402130,
        "opens": -78659398,
        "requests": 17297773,
        "spam_report_drops": -29931788,
        "spam_reports": 73858645,
        "unique_clicks": -48099595,
        "unique_opens": -23829866,
        "unsubscribes": 79005475
      }
    },
    {
      "ab_phase": "all",
      "ab_variation": "e3e45823-d035-6584-ce1a-fa851312b783",
      "aggregation": "mollit Duis eiusmod",
      "id": "8044b904-4b64-24f7-78a7-dfe0addb7b54",
      "stats": {
        "bounce_drops": 25871956,
        "bounces": -46041622,
        "clicks": 42338475,
        "delivered": 59375531,
        "invalid_emails": 81475248,
        "opens": -41362681,
        "requests": -69628680,
        "spam_report_drops": 59931460,
        "spam_reports": 21251117,
        "unique_clicks": -75951069,
        "unique_opens": 24912145,
        "unsubscribes": -46123415
      }
    }
  ]
}
{
  "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_id","step_id","step_id"]
step_ids["1b5e5dee-7526-2868-785e-f20a20eee45f"]
page_size32
page_tokendolore anim
Request Payload
Response Payload
{
  "_metadata": {
    "count": -14093105.885813147,
    "next": "https://YXoxqHyVTGusVDkMKKKeiTuoemkILdzZK.juxvFoM6VG2EODuhwZ6Oq",
    "prev": "http://mczPBLQYFxr.bthweP5lrkJUigS35v6fEcrWdbgCtlXfdhPc1RipWaG6P+bNlOWLTFKJYWXlT7LAa+",
    "self": "http://YwRHpqKXDyHDMgInOwfrxQAkJV.bfiFTlvXfUWxKpe0u1I-.FDWYd1IcUVFEQMu75IbxwyrGw"
  },
  "results": [
    {
      "clicks": 5510320,
      "step_id": "17622180-64a9-a707-12ef-f0a08aa333ba",
      "url": "http://PGD.avvriLfY67uEMGxSl",
      "url_location": 92612357
    },
    {
      "clicks": 88754501,
      "step_id": "ba4c2e30-3589-5662-3f3c-d6b51c7f38b7",
      "url": "https://XklEXLheufcNQaoIiGfRtbYokxnwMey.jmgCzAk",
      "url_location": 4681245
    },
    {
      "clicks": 93472140,
      "step_id": "52ff68ed-4c2f-2913-2874-43e873de577c",
      "url": "https://jwWItPUNoiDgQhAfvS.srpJv.STuCaVm.oA1eqW7PlrWnuvjmrOhg2QueVMCIuAMyLOvy6i",
      "url_location": 63461110
    },
    {
      "clicks": 35508909,
      "step_id": "75a1f729-465e-0f5b-acf8-c715f457a28f",
      "url": "http://EoCXMmkefWDtHO.arJ-xrxbFR0Dd8c8sVRVDCDhxEO.9yY9-pxZCTNieQq-Wr",
      "url_location": 67652536
    },
    {
      "clicks": 91423295,
      "step_id": "f1676b16-b0aa-5a4c-3fc3-85597b8c3a20",
      "url": "https://MvTHcCkN.ssqIyZzLIBuH5crF4Gl67MnFf7B6lWasmBWJqy,TXQmVWIfOaubR3qu5KbHK0JXCoR",
      "url_location": 99202025
    }
  ],
  "total_clicks": -7875930
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
page_size70
page_tokenmagna amet consectetur
group_by["ab_phase","ab_variation","ab_phase","ab_variation","ab_phase"]
ab_variation_id04bb9109-6e09-19c6-4a73-89c4bd7775a8
ab_phase_idtest
Request Payload
Response Payload
{
  "_metadata": {
    "count": -24302884.402929246,
    "next": "http://lehqGuIcrcOZMtqzrGHutz.hagtsxZaqTtiXoCPVOROYleh2iIETJxViMNQOTPmnEztY9nN",
    "prev": "https://kHmdbU.kvLRlEs3.XnNfiniUiMDI19bZ1zTV3Sc0hLYejMtbe5UQyzrbF5Vm+dTLCK9ydn4jWWLRquhR",
    "self": "http://DkCIVpHIfYhP.wnuByWPVRWj"
  },
  "results": [
    {
      "ab_phase": "all",
      "ab_variation": "d4cb35e9-1502-05f5-a4f3-7e6dd2f4a7e9",
      "clicks": 73995434,
      "url": "http://bxsalJurJZ.fzesWn7Ic.jnfkXnY8cMAmW4ydzhv7YgOKdQjNM65uvW5ok",
      "url_location": 13589020
    },
    {
      "ab_phase": "test",
      "ab_variation": "0c5d03c8-bdf8-0e31-b6d2-3324ccd1f6d7",
      "clicks": 75567451,
      "url": "https://VJIaSCPjXKRmHaOwyjbqAqeXesYvg.boyqWJYi0dzgxuq90vKCa-ivEZ",
      "url_location": 69618132
    },
    {
      "ab_phase": "send",
      "ab_variation": "13d15190-a774-0bc4-0042-85841b992efb",
      "clicks": 53900376,
      "url": "http://rPMiZJ.sphhfXc3keOJ5NQIYTiglWR",
      "url_location": 981927
    },
    {
      "ab_phase": "all",
      "ab_variation": "3c5ba754-1873-8449-5ac2-419e37803aca",
      "clicks": 2694706,
      "url": "https://ANV.hwmpdBuzLf.sZNe.y+DwpKxUZHO2DpCmVCMMynW",
      "url_location": 18502185
    },
    {
      "ab_phase": "send",
      "ab_variation": "1125f216-382f-592f-aa05-493e66f2d2ec",
      "clicks": 25685795,
      "url": "https://wHxQWsmsiCbjiPz.aqf9Yr0hsMgU6aEmjzXsc-WkbXlMqdK.q64EqLt",
      "url_location": 98920946
    }
  ],
  "total_clicks": -72900415
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
Query Parameter NameExample
ids["exercitation aliqua dolore sit","sunt fugiat","amet dolore non","magna cupidatat qui sunt ipsum","sed culpa","esse tempor est","irure","qui sed sunt in","nostrud ipsum dolore eiusmod","qui"]
timezonedo sunt
Request Payload
Response Payload
anim laborum occaecat proident deserunt
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
ids["consequat dolore","mollit","incididunt","in culpa","nostrud commodo","cillum labore dolor","pariatur Excepteur incididunt ut","nostrud occaecat ullamco","nisi labore consequat culpa","non nostrud"]
timezoneLorem
Request Payload
Response Payload
irure
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Sender Identities API(6 operations)

Header NameExample
on-behalf-of"incididunt"
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"nisi pariatur Lorem ut"
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"quis amet"
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"in 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"anim pariatur eu"
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"amet"
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"laboris ex"
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"Lorem"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1,
      "name": "the jones",
      "recipient_count": 1
    }
  ]
}
Header NameExample
on-behalf-of"dolore occaecat ut"
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-30585393
Header NameExample
on-behalf-of"irure in tempor"
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*42221434
Header NameExample
on-behalf-of"adipisicing est"
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_contactstrue
Header NameExample
on-behalf-of"pariatur quis aliquip elit amet"
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
page7895041
page_size80108542
list_id*48170920
Header NameExample
on-behalf-of"ullamco consectetur deserunt ipsum"
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"sunt in"
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"eiusmod"
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*-5475904
recipient_id*58926804
Header NameExample
on-behalf-of"aliqua do"
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"consequat ex veniam irure 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"in deserunt consequat minim nisi"
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"veniam"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
{}
{
  "errors": [
    {
      "message": "No recipient ids provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
page59949039
page_size6713275
Header NameExample
on-behalf-of"fugiat Lorem"
Request Payload
Response Payload
{
  "recipients": []
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"est ullamco"
Request Payload
Response Payload
{
  "status": [
    {
      "id": "worker_delay",
      "value": "delayed"
    },
    {
      "id": "worker_delay_seconds",
      "value": "75.0"
    }
  ]
}
Header NameExample
on-behalf-of"exercitation qui"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 41726521.58564007,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "ySrHFGyiWlcxhIi@KRzsGxxgTnfQFwyAiJYWECa.qf",
      "first_name": "ea amet ullamco",
      "id": "tempor",
      "last_clicked": 11335501.714941636,
      "last_emailed": null,
      "last_name": null,
      "last_opened": null,
      "updated_at": -19550606.85088484
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"dolor aliquip"
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"laboris"
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"veniam in cillum magna anim"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"et laboris do ipsum"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
{field_name}consequat commodo in elit
Header NameExample
on-behalf-of"proident commodo dolore"
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"Excepteur aute"
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"culpa in"
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"adipisicing culpa tempor ex"
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"ut ea irure dolore cupidatat"
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"nisi labore"
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"nisi"
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"non velit esse sunt"
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*-74056866
Header NameExample
on-behalf-of"reprehenderit esse qui sit amet"
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_iddeserunt
Header NameExample
on-behalf-of"anim qui commodo incididunt"
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_contactsfalse
Header NameExample
on-behalf-of"consequat incididunt do"
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-44511620
page_size-17678116
Header NameExample
on-behalf-of"in"
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
limit-95145287
categorydolor Excepteur ad
offset61789445
Header NameExample
on-behalf-of"ex est deserunt ipsum do"
Request Payload
Response Payload
[
  {
    "category": "category 1"
  },
  {
    "category": "category 2"
  }
]
{
  "errors": [
    {
      "field": "sort_by",
      "message": "invalid sort value"
    }
  ]
}
Query Parameter NameExample
sort_by_metricamet dolore est
sort_by_directionasc
start_date*proident eiusmod
end_dateipsum deserunt
limit73879211
offset60881172
aggregated_byweek
Header NameExample
on-behalf-of"culpa id magna adipisicing"
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*elit est id qui
end_datead esse et adipisicing commodo
categories*in incididunt aliquip ut
limit-57846365
offset-21030643
aggregated_byweek
Header NameExample
on-behalf-of"eu esse Duis"
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"dolor aliqua enim eu"
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
limit9431467
offset-22998440
Header NameExample
on-behalf-of"tempor"
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"occaecat labore"
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"enim veniam minim est qui"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"in elit minim consectetur dolore"
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"cillum"
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"aute"
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"Duis veniam ad"
Request Payload
{
  "send_at": 1489451436
}
Response Payload
{
  "id": -69196053,
  "send_at": 58249784,
  "status": "magna"
}
{
  "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"consequat est"
Request Payload
Response Payload
{
  "send_at": 1490778528
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"aliqua laborum"
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"minim eiusmod do"
Request Payload
{
  "to": "your.email@example.com"
}
Response Payload
{
  "to": "enim nostrud sunt esse anim"
}
{
  "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"incididunt deserunt ullamco sit"
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
page_size*128.17374924045745
page_tokenLorem magna occaecat
Header NameExample
on-behalf-of"voluptate amet sit culpa"
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": [
    {
      "": "id voluptate exercitation anim in",
      "error_id": "sunt dolore proident minim",
      "message": "consequat eu cillum"
    },
    {
      "": "minim proident commodo et irure",
      "error_id": "magna aute dolor",
      "message": "elit nostrud aliquip veniam quis"
    },
    {
      "": "labore quis id proident",
      "error_id": "adipisicing",
      "message": "Lorem"
    }
  ]
}
Header NameExample
on-behalf-of"consectetur"
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"ut non"
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"qui"
Request Payload
{
  "name": "new_example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "new_example_name",
  "versions": []
}
Header NameExample
on-behalf-of"elit officia est"
Request Payload
Response Payload
{}

Transactional Templates Versions(5 operations)

Header NameExample
on-behalf-of"ad ipsum proident"
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"pariatur laborum in reprehenderit tempor"
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"quis commodo tempor Ut"
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"voluptate Duis ut consectetur"
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"elit"
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"Duis pariatur proident elit"
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"ut irure id"
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"et sit eu amet"
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": "in enim ullamco magna culpa"
    },
    {
      "message": "deserunt"
    }
  ]
}
Query Parameter NameExample
limitqui nulla
offsetUt laboris
aggregated_byday
start_date*adipisicing
end_dateid consectetur
Header NameExample
on-behalf-of"nostrud ea nulla est qui"
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"aliqua"
Request Payload
Response Payload
{
  "public_key": "anim quis in sint"
}
Header NameExample
on-behalf-of"aliquip proident ea in"
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"labore"
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"pariatur"
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": "nisi laboris ipsum dolor"
    },
    {
      "message": "sit do elit"
    }
  ]
}
Header NameExample
on-behalf-of"deserunt"
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": "commodo"
    },
    {
      "message": "labore sit ullamco dolore ad"
    },
    {
      "message": "nisi tempor"
    },
    {
      "message": "commodo aliqua qui officia"
    },
    {
      "message": "cupidatat consectetur irure Lorem laborum"
    }
  ]
}
Header NameExample
on-behalf-of"est quis laboris exercitation tempor"
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": "eu"
    },
    {
      "message": "consequat aliquip deserunt cillum officia"
    }
  ]
}
Header NameExample
on-behalf-of"dolor reprehenderit dolore nostrud aliqua"
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": "et adipisicing"
    },
    {
      "message": "culpa Ut laborum"
    },
    {
      "message": "Duis Lorem"
    },
    {
      "message": "et reprehenderit est proident ex"
    }
  ]
}

Query(2 operations)

Query Parameter NameExample
query*in
limit965.1070950973641
Header NameExample
X-Query-Id"nisi et proident cupidatat sit"
X-Cursor"cillum ut"
Authorization*"velit in"
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*"cillum ut veniam"
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
querymollit tempor aute ea
Header NameExample
Authorization*"enim"
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*"quis ut officia sunt in"
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"sunt"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "open",
      "title": "Open Tracking",
      "description": "lorem ipsum... .",
      "enabled": true
    }
  ]
}
Header NameExample
on-behalf-of"anim"
Request Payload
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"laborum tempor consequat minim"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"esse Excepteur ut fugiat sint"
Request Payload
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"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"fugiat laborum"
Request Payload
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"sunt quis ullamco eiusmod"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"aute ex in"
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"esse Excepteur qui"
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
limit-89828823
offset-79161868
aggregated_bymonth
start_date*ad ipsum ea do pariatur
end_dateincididunt esse deserunt
Header NameExample
on-behalf-of"labore adipisicing aute nulla"
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
countryCA
limit-87681886
offset87545449
aggregated_bymonth
start_date*Lorem exercitation anim
end_dateconsequat dolor ipsum adipisicing
Header NameExample
on-behalf-of"reprehenderit aliqua"
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
limit-77201886
offset-32522310
aggregated_byweek
start_date*in nostrud sed dolore
end_datenon
Header NameExample
on-behalf-of"reprehenderit"
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*dolore quis officia Excepteur nostrud
end_dateest consectetur
aggregated_byweek
Header NameExample
on-behalf-of"dolore aute"
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*voluptate dolor
end_dateoccaecat sit consequat
aggregated_bymonth
Header NameExample
on-behalf-of"laborum id dolore"
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_providerslabore ipsum
limit-55575787
offset-7252397
aggregated_byday
start_date*in voluptate cupidatat mollit officia
end_datefugiat sed est eiusmod sint
Header NameExample
on-behalf-of"eu"
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
browsersreprehenderit laboris
limit-27165897
offset98863942
aggregated_byweek
start_date*dolore eu
end_dateincididunt ipsum officia fugiat Lorem
Header NameExample
on-behalf-of"in Excepteur Lorem in"
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_time-63091809
end_time28457812
Header NameExample
Accept*"tempor officia"
on-behalf-of"aliqua"
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"irure in"
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"ad commodo"
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*Ohe0UbfCWvp@iGKHQy.qzx
Header NameExample
on-behalf-of"sit"
Request Payload
Error generating example
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Blocks API(4 operations)

Query Parameter NameExample
start_time-10534383
end_time56575863
limit96609337
offset54391693
Header NameExample
on-behalf-of"nostrud non occaecat"
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"quis culpa reprehenderit"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"incididunt"
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 tempor"
Request Payload
Response Payload
{}

Spam Reports API(4 operations)

Query Parameter NameExample
start_time13549025
end_time82782148
limit-56876915
offset18305070
Header NameExample
on-behalf-of"sunt nisi adipisicing nulla nostrud"
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"consectetur laborum anim aliquip"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"qui"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "ip": "10.89.32.5"
  }
]
Header NameExample
on-behalf-of"aliqua ad deserunt"
Request Payload
Response Payload
{}

Suppressions - Global Suppressions(4 operations)

Header NameExample
on-behalf-of"quis cillum"
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-89699165
end_time31204935
limit49875020
offset28103916
Header NameExample
on-behalf-of"cupidatat culpa do"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com"
  }
]
Header NameExample
on-behalf-of"minim in"
Request Payload
Response Payload
{
  "recipient_email": "test@example.com"
}
Header NameExample
on-behalf-of"irure"
Request Payload
Response Payload
{}

Suppressions - Unsubscribe Groups(5 operations)

Header NameExample
on-behalf-of"dolor consequat ex nisi"
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-81715487
Header NameExample
on-behalf-of"do Ut elit"
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"aute ex eu aliqua"
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"voluptate tempor"
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"incididunt culpa"
Request Payload
Response Payload
{}

Suppressions - Suppressions(6 operations)

Header NameExample
on-behalf-of"proident pariatur ipsum"
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"voluptate"
Request Payload
Response Payload
[
  "example@example.com",
  "example2@example.com"
]
Header NameExample
on-behalf-of"incididunt"
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"anim"
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"non dolore aute eu amet"
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"labore irure"
Request Payload
Response Payload
Error generating example

Invalid Emails API(4 operations)

Query Parameter NameExample
start_time92978175
end_time99849052
limit-9830463
offset79825841
Header NameExample
on-behalf-of"exercitation in esse"
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"occaecat"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"ad deserunt"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]
Header NameExample
on-behalf-of"sit"
Request Payload
Response Payload
{}
Service Homepage: sendgrid.com/en-us
API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started
emails