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": "adipisicing ipsum nulla reprehenderit id"
    },
    {
      "message": "consequat"
    },
    {
      "message": "quis incididunt"
    }
  ]
}

Cancel Scheduled Sends(7 operations)

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

API Keys(6 operations)

Header NameExample
on-behalf-of"proident eiusmod"
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": "eiusmod dolore et"
    },
    {
      "message": "do laborum laboris"
    },
    {
      "message": "id amet"
    },
    {
      "message": "anim labore Excepteur Lorem non"
    }
  ]
}
Query Parameter NameExample
limit-36525918
Header NameExample
on-behalf-of"minim"
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": "qui Lorem"
    }
  ]
}
Header NameExample
on-behalf-of"Ut labore enim"
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": "aliqua dolor"
    },
    {
      "message": "proident cupidatat labore deserunt"
    },
    {
      "message": "voluptate exercitation anim et"
    },
    {
      "message": "consectetur aliquip dolor"
    }
  ]
}
Header NameExample
on-behalf-of"ex ullamco ut reprehenderit"
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 ipsum"
    }
  ]
}
Header NameExample
on-behalf-of"minim fugiat"
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": "esse"
    },
    {
      "message": "sint elit sunt"
    },
    {
      "message": "laborum nisi"
    }
  ]
}
Header NameExample
on-behalf-of"ut culpa"
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": "est sunt nisi esse"
    },
    {
      "message": "ad"
    },
    {
      "message": "id irure in culpa"
    }
  ]
}

API Key Permissions

Header NameExample
on-behalf-of"in fugiat culpa irure"
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": "anim ex aute ullamco"
    }
  ]
}

Settings - Enforced TLS(2 operations)

Header NameExample
on-behalf-of"incididunt et Excepteur eiusmod"
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": "exercitation sit"
    },
    {
      "message": "fugiat esse ut ut"
    },
    {
      "message": "ipsum cupidatat nostrud"
    }
  ]
}
Header NameExample
on-behalf-of"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": "in"
    },
    {
      "message": "ex sed sint Excepteur"
    },
    {
      "message": "id esse nulla et"
    },
    {
      "message": "ex consectetur tempor id"
    },
    {
      "message": "ut ex labore eu irure"
    }
  ]
}

IP Access Management(6 operations)

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

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

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

Settings - Mail(13 operations)

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

Settings - Partner(3 operations)

Header NameExample
on-behalf-of"esse est cillum laborum"
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"qui amet consequat"
Request Payload
Response Payload
{
  "enable_subuser_statistics": false,
  "enabled": true,
  "license_key": ""
}
Query Parameter NameExample
limit-9457765
offset19946468
Header NameExample
on-behalf-of"ea aute Duis incididunt nisi"
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"do sunt aute sit aliqua"
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": "qui cillum ullamco occaecat",
      "message": "tempor adipisicing"
    },
    {
      "field": "non ut",
      "message": "tempor"
    },
    {
      "field": "ipsum ea",
      "message": "ad Lorem"
    },
    {
      "field": "est",
      "message": "occaecat culpa eu non fugiat"
    }
  ]
}
Query Parameter NameExample
limit343
offset38958987
Header NameExample
on-behalf-of"in 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"occaecat dolor sit"
Request Payload
Response Payload
{
  "pending_id": "abc123abc",
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}
{
  "errors": [
    {
      "message": "invalid pending key",
      "field": "pending_key"
    }
  ]
}
Query Parameter NameExample
limit-2199351
offset70654244
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"Duis et eu qui commodo"
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"culpa et labore exercitation"
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"fugiat ipsum do et"
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"Excepteur ex"
Request Payload
Response Payload
{
  "errors": [
    {
      "field": "consectetur consequat",
      "message": "pariatur nisi anim ex esse"
    },
    {
      "field": "sit incididunt Excepteur dolore",
      "message": "aliquip"
    }
  ]
}
{
  "errors": [
    {
      "message": "username not found",
      "field": "username"
    }
  ]
}
Request Payload
Response Payload
{
  "scope_group_name": "Stats"
}
{}
{
  "errors": [
    {
      "field": "commodo",
      "message": "aute"
    },
    {
      "field": "ipsum nisi",
      "message": "nisi est fugiat nulla pariatur"
    },
    {
      "field": "nulla cillum",
      "message": "ullamco culpa magna sunt aliqua"
    },
    {
      "field": "fugiat Excepteur",
      "message": "ex consequat"
    },
    {
      "field": "cillum nulla",
      "message": "deserunt"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "Cannot find request",
      "field": "request_id"
    }
  ]
}
Header NameExample
on-behalf-of"proident pariatur consectetur dolore"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "et Lorem",
      "message": "velit pariatur"
    },
    {
      "field": "in cillum",
      "message": "ex"
    },
    {
      "field": "pariatur",
      "message": "ullamco officia"
    },
    {
      "field": "ex commodo sed",
      "message": "exercitation dolore dolor mollit est"
    }
  ]
}

Alerts(5 operations)

Header NameExample
Authorization"consequat eiusmod exercitation"
on-behalf-of"dolor in id voluptate laborum"
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": "id in dolore officia",
  "message": "mollit proident ad exercitation sit"
}
Header NameExample
Authorization"deserunt ut"
on-behalf-of"est ullamco sed ad officia"
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"proident Ut"
on-behalf-of"proident do nulla qui"
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"minim"
Request Payload
Response Payload
{}
Header NameExample
on-behalf-of"Lorem irure aute"
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"aliquip qui"
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"consequat"
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"eu aute eiusmod labore Ut"
Request Payload
Response Payload
{
  "reputation": 100,
  "type": "paid"
}
Header NameExample
on-behalf-of"non eu laborum"
Request Payload
Response Payload
{
  "email": "test@example.com"
}
Header NameExample
on-behalf-of"ea"
Request Payload
{
  "email": "example@example.com"
}
Response Payload
{
  "email": "example@example.com"
}
Header NameExample
on-behalf-of"dolor Lorem elit velit"
Request Payload
Response Payload
{
  "username": "test_username",
  "user_id": 1
}
Header NameExample
on-behalf-of"ullamco"
Request Payload
{
  "username": "test_username"
}
Response Payload
{
  "username": "test_username"
}
Header NameExample
on-behalf-of"ad do laboris sed"
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"nisi sunt"
Request Payload
{
  "new_password": "new_password",
  "old_password": "old_password"
}
Response Payload
{}

Subusers API(6 operations)

Query Parameter NameExample
usernameipsum
limit-75117219
offset95383663
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
usernamesnisi Duis 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*Duis
sort_by_metricdo Excepteur Duis ea
sort_by_directionasc
limit-22294024
offset28034050
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*exercitation velit ipsum
subuseraliqua voluptate
sort_by_metricrequests
sort_by_directiondesc
limit-70630705
offset-29935424
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*fugiat cillum nisi amet
end_dateoccaecat sunt labore
limit-93150616
offset43384613
aggregated_byirure quis ea fugiat
sort_by_metriclabore dolor proident occaecat
Request Payload
Response Payload
{
  "date": "2015-10-11",
  "stats": []
}
Query Parameter NameExample
limit-53017795
offset-99296793
aggregated_byweek
subusers*tempor Ut sit voluptate
start_date*elit esse voluptate amet
end_dateet
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"amet incididunt"
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
limit-89087983
offset-52915533
ipadipisicing tempor
Header NameExample
on-behalf-of"nostrud Lorem officia enim"
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"in fugiat deserunt esse"
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"elit sint Excepteur fugiat"
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"aliquip veniam labore ipsum eiusmod"
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": "Excepteur",
    "field": "sit proident"
  }
}

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
ipculpa aliquip esse do mollit
exclude_whitelabelstrue
limit72835748
offset68561554
subusermollit nisi ullamco non
sort_by_directionasc
Request Payload
Response Payload
[
  {
    "ip": "192.168.1.1",
    "pools": [
      "pool1",
      "pool2"
    ],
    "whitelabeled": false,
    "start_date": 1409616000,
    "subusers": [
      "tim@sendgrid.net"
    ],
    "warmup": false,
    "assigned_at": 1482883200
  },
  {
    "ip": "208.115.214.22",
    "pools": [],
    "whitelabeled": true,
    "rdns": "o1.email.burgermail.com",
    "start_date": 1409616000,
    "subusers": [],
    "warmup": false,
    "assigned_at": 1482883200
  }
]
Request Payload
Response Payload
{
  "results": [
    {
      "remaining": 2,
      "period": "month",
      "price_per_ip": 20
    }
  ]
}
Request Payload
Response Payload
[
  {
    "ip": "167.89.21.3",
    "pools": [
      "new_test5"
    ],
    "warmup": true,
    "start_date": 1409616000
  }
]
Request Payload
Response Payload
{
  "ip": "000.00.00.0",
  "subusers": [
    "subuser1",
    "subuser2"
  ],
  "rdns": "o1.em.example.com",
  "pools": [
    "test1"
  ],
  "warmup": false,
  "start_date": null,
  "whitelabeled": true
}

Domain Authentication(12 operations)

Query Parameter NameExample
limit-89492414
offset-24192643
exclude_subuserstrue
usernamenostrud veniam incididunt ea non
domainesse cillum
Header NameExample
on-behalf-of"ullamco adipisicing officia"
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"mollit aliquip sint dolore consectetur"
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"dolor aute consequat laborum"
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"cillum culpa aliqua reprehenderit"
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"velit"
Request Payload
Response Payload
{}
Query Parameter NameExample
domainvelit mollit
Header NameExample
on-behalf-of"aliqua deserunt exercitation laboris"
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"minim occaecat elit voluptate"
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"tempor minim"
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"tempor sunt"
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*magna
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
usernamesit ullamco anim quis 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": "aliquip voluptate"
    },
    {
      "message": "est magna pariatur"
    }
  ]
}
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": "pariatur consectetur commodo ipsum"
    }
  ]
}
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": "ex mollit",
      "field": "elit",
      "message": "ut aliqua non nisi"
    },
    {
      "error_id": "aliqua consequat dolor et esse",
      "field": "fugiat cupidatat qui",
      "message": "eu aute minim"
    },
    {
      "error_id": "eiusmod id dolore",
      "field": "irure fugiat in anim dolore",
      "message": "eu voluptate aliquip tempor magna"
    },
    {
      "error_id": "laboris eiusmod pariatur velit irure",
      "field": "laborum mollit",
      "message": "nulla sit"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "sint veniam Duis nostrud"
    },
    {
      "message": "cupidatat cillum"
    }
  ]
}
Query Parameter NameExample
limit-94778769.33265938
lastSeenID262371.2410579622
id-17510058
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": "Duis officia labore aute"
    },
    {
      "message": "sunt dolore eiusmod quis"
    },
    {
      "message": "ea veniam Ut consectetur ad"
    },
    {
      "message": "in nostrud sit"
    }
  ]
}
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": "adipisicing elit",
      "message": "dolor nisi dolor"
    },
    {
      "error_id": "irure elit nulla consequat",
      "message": "est sint nostrud"
    },
    {
      "error_id": "anim fugiat reprehenderit deserunt adipisicing",
      "message": "sed"
    }
  ]
}
{
  "errors": [
    {
      "message": "Excepteur"
    },
    {
      "message": "occaecat nisi aliqua culpa"
    }
  ]
}
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": "elit reprehenderit",
      "field": "ex in",
      "message": "amet Lorem sunt eu"
    },
    {
      "error_id": "et elit nulla sunt ad",
      "field": "deserunt mollit",
      "message": "in dolor laboris anim deserunt"
    },
    {
      "error_id": "dolor et ut",
      "field": "eu Excepteur reprehenderit elit cupidatat",
      "message": "anim Duis culpa"
    },
    {
      "error_id": "cupidatat ipsum nulla deserunt mollit",
      "field": "est cupidatat consequat",
      "message": "eu Duis officia cupidatat"
    },
    {
      "error_id": "commodo ut tempor voluptate minim",
      "field": "minim",
      "message": "officia incididunt ad ullamco exercitation"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "Ut in ad",
      "message": "dolore elit Ut aute minim"
    },
    {
      "error_id": "laboris sunt",
      "message": "aliquip pariatur minim anim ut"
    },
    {
      "error_id": "in incididunt irure cillum velit",
      "message": "in"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "irure nulla consectetur officia laboris",
      "message": "non"
    },
    {
      "error_id": "sit elit sunt laborum",
      "message": "velit dolore esse"
    },
    {
      "error_id": "elit nostrud irure",
      "message": "nulla ex cillum non ut"
    },
    {
      "error_id": "amet cupidatat elit ea",
      "message": "nostrud in aliqua culpa"
    },
    {
      "error_id": "dolore",
      "message": "do non anim velit aute"
    }
  ]
}
{
  "errors": [
    {
      "message": "dolore voluptate"
    },
    {
      "message": "dolore est nisi"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sit aute tempor proident",
      "message": "dolor laboris tempor in sit"
    },
    {
      "error_id": "exercitation eiusmod voluptate consequat in",
      "message": "laboris ullamco aliqua est anim"
    },
    {
      "error_id": "tempor nulla culpa quis",
      "message": "nulla dolore"
    },
    {
      "error_id": "deserunt",
      "message": "in ad"
    },
    {
      "error_id": "do consequat culpa ipsum",
      "message": "consectetur reprehenderit aliquip"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "aute ullamco ad exercitation sunt",
      "message": "laborum proident"
    },
    {
      "error_id": "in nisi laboris nostrud",
      "message": "consequat elit ex magna"
    }
  ]
}
{
  "errors": [
    {
      "message": "esse sunt ea magna in"
    },
    {
      "message": "in"
    },
    {
      "message": "exercitation voluptate sint"
    },
    {
      "message": "elit non Ut veniam"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "error_id": "fugiat incididunt elit esse occaecat",
      "message": "in sint exercitation ad"
    },
    {
      "error_id": "magna nisi",
      "message": "culpa"
    },
    {
      "error_id": "eiusmod labore",
      "message": "ex ad cillum irure tempor"
    },
    {
      "error_id": "laborum in elit commodo Lorem",
      "message": "nulla"
    },
    {
      "error_id": "Ut officia sit id adipisicing",
      "message": "cillum velit occaecat consequat sed"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "amet",
      "message": "nostrud cupidatat"
    },
    {
      "error_id": "mollit et",
      "message": "elit minim Lorem esse"
    },
    {
      "error_id": "officia incididunt mollit culpa in",
      "message": "ea ipsum et"
    },
    {
      "error_id": "nostrud aliquip",
      "message": "exercitation laborum mollit deserunt"
    }
  ]
}
{
  "errors": [
    {
      "message": "laboris consequat nisi"
    }
  ]
}

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 Duis nulla sunt",
  "field": "aliquip ex velit ullamco in",
  "message": "laborum"
}
{
  "errors": [
    {
      "error_id": "sit eiusmod aute dolore cillum",
      "field": "aute",
      "message": "consectetur enim"
    },
    {
      "error_id": "deserunt elit occaecat in",
      "field": "nulla",
      "message": "do incididunt consequat dolore"
    },
    {
      "error_id": "id dolore exercitation anim",
      "field": "do sit",
      "message": "in"
    },
    {
      "error_id": "consequat occaecat voluptate cupidatat",
      "field": "minim",
      "message": "dolor dolore"
    }
  ]
}
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": "est",
      "field": "anim velit fugiat",
      "message": "eu sunt dolore commodo esse"
    },
    {
      "error_id": "qui in",
      "field": "Ut aliqua nulla",
      "message": "sed"
    },
    {
      "error_id": "sed",
      "field": "veniam exercitation irure sit ex",
      "message": "cillum aute dolor ut consectetur"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "culpa fugiat",
      "field": "cupidatat ex",
      "message": "dolor esse"
    },
    {
      "error_id": "labore adipisicing velit",
      "field": "ea",
      "message": "sint labore dolor culpa"
    }
  ]
}
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": "Excepteur laboris",
      "field": "eiusmod incididunt tempor Excepteur amet",
      "message": "esse elit labore"
    },
    {
      "error_id": "nisi Excepteur dolore ad Ut",
      "field": "ad",
      "message": "nisi cupidatat Ut incididunt"
    },
    {
      "error_id": "sed exercitation minim cillum Duis",
      "field": "consequat fugiat cupidatat",
      "message": "sit enim"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "non Lorem sed qui dolor",
      "field": "eu magna",
      "message": "sit aute"
    },
    {
      "error_id": "culpa officia dolor in Lorem",
      "field": "aliquip dolore velit exercitation",
      "message": "aliquip"
    },
    {
      "error_id": "Ut Lorem",
      "field": "esse proident",
      "message": "do ut"
    },
    {
      "error_id": "dolore",
      "field": "incididunt ex magna eu elit",
      "message": "ut qui"
    },
    {
      "error_id": "sint",
      "field": "ad sint eiusmod laboris",
      "message": "tempor reprehenderit amet nulla"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "error_id": "officia tempor laborum laboris",
      "field": "veniam nostrud incididunt",
      "message": "sed minim reprehenderit veniam laborum"
    },
    {
      "error_id": "ea sit Excepteur fugiat",
      "field": "nostrud culpa",
      "message": "minim esse nostrud dolore"
    },
    {
      "error_id": "cillum",
      "field": "aliqua laboris",
      "message": "nostrud Duis ad"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "veniam dolore tempor in",
      "field": "voluptate elit enim proident cillum",
      "message": "in"
    },
    {
      "error_id": "sed dolore",
      "field": "irure sint aliquip",
      "message": "ipsum exercitation adipisicing ex"
    }
  ]
}
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": "Lorem",
      "field": "amet officia pariatur ut non",
      "message": "in laborum"
    },
    {
      "error_id": "in sed anim laboris",
      "field": "minim ut",
      "message": "velit veniam sunt quis"
    },
    {
      "error_id": "minim eiusmod culpa adipisicing",
      "field": "dolor eu sint eiusmod officia",
      "message": "dolore"
    },
    {
      "error_id": "aute Lorem sunt in",
      "field": "id fugiat exercitation quis dolor",
      "message": "officia consequat"
    }
  ]
}
Query Parameter NameExample
page_size60875842
page_tokenaute fugiat sit qui
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": "fugiat quis aliqua officia",
      "field": "consectetur aute voluptate fugiat sint",
      "message": "ut sunt sed exercitation"
    },
    {
      "error_id": "sit nulla labore et",
      "field": "ex",
      "message": "sed dolor ut Lorem"
    },
    {
      "error_id": "do",
      "field": "reprehenderit adipisicing dolor aute",
      "message": "Ut"
    },
    {
      "error_id": "id laborum consequat in Excepteur",
      "field": "qui ullamco pariatur dolor dolore",
      "message": "deserunt anim irure nisi"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "labore Lorem proident quis consectetur",
      "field": "aliqua ut nisi",
      "message": "ut"
    },
    {
      "error_id": "dolor proident Ut magna",
      "field": "pariatur mollit laboris",
      "message": "nulla sint consectetur"
    },
    {
      "error_id": "enim ullamco",
      "field": "est laboris enim",
      "message": "id Duis"
    }
  ]
}
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": "in voluptate irure consectetur",
      "field": "nostrud labore pariatur aliqua",
      "message": "esse ex laboris commodo est"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "amet et Lorem ea",
      "field": "Duis eu deserunt",
      "message": "in"
    },
    {
      "error_id": "dolore ullamco",
      "field": "sint",
      "message": "elit tempor commodo qui Ut"
    },
    {
      "error_id": "commodo elit Ut adipisicing incididunt",
      "field": "incididunt",
      "message": "in"
    },
    {
      "error_id": "voluptate sunt labore deserunt",
      "field": "adipisicing mollit ut id",
      "message": "elit do dolore sunt"
    },
    {
      "error_id": "ipsum pariatur adipisicing",
      "field": "sunt reprehenderit",
      "message": "nisi minim dolor deserunt"
    }
  ]
}
Query Parameter NameExample
page_size85698305
page_tokenculpa nostrud Ut ut id
summarytrue
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": "qui ipsum ut tempor fugiat",
      "address_line_2": "sed mollit exercitation",
      "alternate_emails": [
        "sed in exercitation laborum non",
        "elit irure qui",
        "minim",
        "eu ipsum et Duis",
        "magna incididunt laboris velit elit"
      ],
      "city": "eiusmod",
      "country": "qui deserunt minim do",
      "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": "m",
      "first_name": "adipisicing Excepteur ipsum Duis",
      "last_name": "ipsum ad in la",
      "postal_code": "fugiat adipisicing exercitation veniam",
      "state_province_region": "irure"
    },
    {
      "address_line_1": "minim",
      "address_line_2": "labore ipsum est adipisicing",
      "alternate_emails": [
        "dolor in dolore sit cupidatat",
        "amet iru",
        "eu laborum incididunt magna",
        "Excepteur dolore irure cillum",
        "ut aute"
      ],
      "city": "magna sit labore do",
      "country": "ipsum sed eu dolo",
      "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": "adipisicing",
      "first_name": "pariatur",
      "last_name": "esse",
      "postal_code": "cillum",
      "state_province_region": "commodo"
    },
    {
      "address_line_1": "exercitation ullamco esse fugiat tempor",
      "address_line_2": "irure proident paria",
      "alternate_emails": [
        "exercitation ex nostrud est magna",
        "aliquip reprehenderit",
        "ipsum nulla eu deserunt",
        "aute",
        "dolor consectetur adipisicing irure"
      ],
      "city": "com",
      "country": "magna adipisicing enim eiusmod",
      "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": "aute reprehenderit sint aliquip ea",
      "first_name": "irure",
      "last_name": "officia co",
      "postal_code": "ullamco do eiusmod voluptate",
      "state_province_region": "amet aute commodo sit"
    },
    {
      "address_line_1": "qu",
      "address_line_2": "anim dolore cillum quis aliquip",
      "alternate_emails": [
        "exercitation in aliq",
        "quis irure eu Excepteur ea",
        "incididunt in id laboris labore",
        "in labore",
        "eu Duis anim"
      ],
      "city": "Lorem commodo ",
      "country": "anim in in ad",
      "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": "amet dolor ullamco Ut sunt",
      "first_name": "irure quis et veniam",
      "last_name": "aliqua deserunt amet",
      "postal_code": "dolore ut labore magna proident",
      "state_province_region": "veniam proident "
    },
    {
      "address_line_1": "exercitatio",
      "address_line_2": "eiusmod consectetur comm",
      "alternate_emails": [
        "minim consectetur in quis mollit",
        "Lorem ipsum eiusmod irure anim",
        "dolore ullamco amet proident",
        "ipsum ut commodo eu mollit",
        "qui"
      ],
      "city": "voluptate sit",
      "country": "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": "minim ex exercitation",
      "first_name": "sed et i",
      "last_name": "magna ut",
      "postal_code": "sit voluptate nulla",
      "state_province_region": "dolor a"
    },
    {
      "address_line_1": "dolor amet ipsum",
      "address_line_2": "commodo",
      "alternate_emails": [
        "in est ullamco",
        "in aliquip exercitation ut",
        "labore exercitation magna ea",
        "ullamco aliquip ut",
        "in aliqua"
      ],
      "city": "consequat culpa ",
      "country": "Ut magna tempor ",
      "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": "quis",
      "first_name": "veniam",
      "last_name": "ex",
      "postal_code": "do",
      "state_province_region": "elit esse Lorem"
    },
    {
      "address_line_1": "officia anim eu",
      "address_line_2": "irure magna nisi do",
      "alternate_emails": [
        "culpa",
        "reprehenderit sint",
        "elit",
        "anim",
        "veniam sit cillum do amet"
      ],
      "city": "cupidatat dolore minim",
      "country": "quis voluptate elit esse",
      "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 nisi occaecat velit et",
      "first_name": "ut",
      "last_name": "ess",
      "postal_code": "Lorem in reprehenderit",
      "state_province_region": "mollit reprehenderit sunt consecte"
    },
    {
      "address_line_1": "quis",
      "address_line_2": "ex in",
      "alternate_emails": [
        "commodo",
        "et tempor id",
        "ad et",
        "ipsum ex",
        "ut in"
      ],
      "city": "enim sunt anim",
      "country": "ut quis fugiat",
      "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": "quis ea in elit",
      "first_name": "do et sit ipsum",
      "last_name": "dolor quis sunt velit v",
      "postal_code": "proident dolore dolor",
      "state_province_region": "in"
    },
    {
      "address_line_1": "elit",
      "address_line_2": "ut dolore tempor in",
      "alternate_emails": [
        "Duis proident ut ut cupidatat",
        "anim sint occaecat",
        "ullamco minim irure sit tempor",
        "in in",
        "ut"
      ],
      "city": "in elit",
      "country": "cillum",
      "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": "deserunt minim proident consectetur",
      "first_name": "enim sit do id adipisicing",
      "last_name": "velit laborum amet in tempor",
      "postal_code": "nulla sit do dolor",
      "state_province_region": "et incididunt deserunt"
    },
    {
      "address_line_1": "Excepteur consequat in Duis",
      "address_line_2": "mollit ipsum minim dolor",
      "alternate_emails": [
        "in ea dolore consequat velit",
        "eu",
        "quis irure voluptate deserunt occaecat",
        "pariatur aliqua laboris aute",
        "officia"
      ],
      "city": "in enim tempor",
      "country": "veniam",
      "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",
      "first_name": "occa",
      "last_name": "deserunt",
      "postal_code": "occaecat id",
      "state_province_region": "esse aliquip commodo mollit labore"
    }
  ],
  "list_ids": [
    "6db0716f-84eb-c7fe-5622-ea13a6c4ad82",
    "71be711f-9b9a-2377-ea66-df45fae9fc4b",
    "39f5b746-ba09-1f53-9b50-b159bfa2c50b"
  ]
}
Response Payload
{
  "job_id": "esse ut enim"
}
{
  "errors": [
    {
      "error_id": "consequat in",
      "field": "pariatur aliquip laboris nulla proident",
      "message": "tempor",
      "parameter": "labore elit occaecat nulla"
    },
    {
      "error_id": "in",
      "field": "magna deserunt proident occaecat minim",
      "message": "quis cupidatat sit dolor",
      "parameter": "in in consequat sit officia"
    },
    {
      "error_id": "Excepteur veniam anim",
      "field": "elit",
      "message": "exercitation reprehenderit",
      "parameter": "dolore nulla sint"
    },
    {
      "error_id": "Lorem",
      "field": "voluptate veniam pariatur nostrud consequat",
      "message": "mollit eiusmod",
      "parameter": "ut ad"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "sunt"
    }
  ]
}
Query Parameter NameExample
delete_all_contactssint aute in
idsconsectetur labore officia
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": "commodo deserunt Duis"
    },
    {
      "message": "esse"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "self": "anim nulla"
  },
  "contact_count": -17351784,
  "result": [
    {
      "_metadata": {
        "self": "qui exercitation sed eiusmod cillum"
      },
      "address_line_1": "ut irure",
      "address_line_2": "Ut consectetur",
      "alternate_emails": [
        "amet ad nulla dolore occaecat",
        "sunt",
        "nisi",
        "laborum consequat",
        "aliqua nulla veniam"
      ],
      "city": "anim nostrud",
      "country": "velit ipsum in amet eu",
      "created_at": "do esse ipsum nostrud",
      "custom_fields": {},
      "email": "do anim exercitation incididunt",
      "facebook": "id cillum adipisicing",
      "first_name": "adipisicing enim",
      "id": "dolore Ut",
      "last_name": "ullamco nisi occaecat",
      "line": "occaecat ad",
      "list_ids": [
        "ut laborum ad dolor",
        "ullamco",
        "amet est dolor",
        "Ut amet esse",
        "commodo ullamco fugiat"
      ],
      "phone_number": "et",
      "postal_code": "Lorem ut eu cupidatat",
      "segment_ids": [
        "pariatur occaecat aliquip Excepteur"
      ],
      "state_province_region": "in",
      "unique_name": "esse",
      "updated_at": "culpa ex ut quis",
      "whatsapp": "in cillum dolore laboris dolor"
    },
    {
      "_metadata": {
        "self": "velit ad ex"
      },
      "address_line_1": "laborum voluptate qui occaecat amet",
      "address_line_2": "deserunt aliquip dolore",
      "alternate_emails": [
        "dolore in elit proident",
        "esse sunt amet elit",
        "laborum dolor",
        "irure ut sed",
        "qui"
      ],
      "city": "sit enim est",
      "country": "tempor est ad",
      "created_at": "esse elit",
      "custom_fields": {},
      "email": "commodo nulla reprehenderit laborum ut",
      "facebook": "ipsum amet eiusmod dolore",
      "first_name": "enim incididunt",
      "id": "sit labore Ut ut aute",
      "last_name": "quis incididunt",
      "line": "ut",
      "list_ids": [
        "eiusmod quis",
        "eiusmod ad"
      ],
      "phone_number": "id Ut",
      "postal_code": "officia reprehenderit mollit do sed",
      "segment_ids": [
        "pariatur laborum",
        "sed",
        "anim"
      ],
      "state_province_region": "pariatur ad minim irure",
      "unique_name": "aliquip",
      "updated_at": "ut",
      "whatsapp": "id velit"
    },
    {
      "_metadata": {
        "self": "qui ea"
      },
      "address_line_1": "do",
      "address_line_2": "aliqua commodo",
      "alternate_emails": [
        "Ut proident do",
        "dolor irure in consectetur"
      ],
      "city": "nulla in dolor sunt",
      "country": "elit amet",
      "created_at": "proident non cillum elit",
      "custom_fields": {},
      "email": "exercitation aliquip Lorem Ut ut",
      "facebook": "sint proident fugiat amet",
      "first_name": "dolor veniam laborum sit",
      "id": "tempor labore",
      "last_name": "minim in do",
      "line": "incididunt mollit ut voluptate qui",
      "list_ids": [
        "minim Ut velit",
        "enim eiusmod",
        "et",
        "aute commodo cupidatat minim",
        "do incididunt"
      ],
      "phone_number": "culpa",
      "postal_code": "eiusmod culpa",
      "segment_ids": [
        "in ipsum laboris aliqua",
        "magna quis ipsum deserunt"
      ],
      "state_province_region": "consequat reprehenderit in ut sit",
      "unique_name": "sed ad",
      "updated_at": "dolore Duis sint id nostrud",
      "whatsapp": "sit exercitation velit mollit culpa"
    },
    {
      "_metadata": {
        "self": "cillum Duis ex fugiat elit"
      },
      "address_line_1": "ullamco ut",
      "address_line_2": "in",
      "alternate_emails": [
        "in labore ut anim",
        "esse ex id veniam",
        "exercitation nulla",
        "dolore"
      ],
      "city": "magna elit reprehenderit in non",
      "country": "esse",
      "created_at": "pariatur dolore",
      "custom_fields": {},
      "email": "consectetur esse ipsum irure Excepteur",
      "facebook": "Lorem",
      "first_name": "ipsum Duis mollit occaecat",
      "id": "ex et sed aute",
      "last_name": "dolor ex officia in",
      "line": "aliqua velit Excepteur",
      "list_ids": [
        "culpa consectetur elit"
      ],
      "phone_number": "eu sed irure Excepteur",
      "postal_code": "ipsum nostrud",
      "segment_ids": [
        "deserunt anim Ut est",
        "ad"
      ],
      "state_province_region": "ut voluptate minim ea irure",
      "unique_name": "eiusmod exercitation occaecat",
      "updated_at": "aliqua dolore",
      "whatsapp": "nostrud Excepteur quis exercitation"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "laboris",
      "field": "eu anim non",
      "message": "Duis mollit amet",
      "parameter": "dolor mollit"
    },
    {
      "error_id": "in fugiat dolore",
      "field": "qui mollit ea",
      "message": "nulla",
      "parameter": "eu officia quis ullamco cillum"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "qui reprehenderit"
    },
    {
      "message": "mollit sunt ut labore adipisicing"
    },
    {
      "message": "pariatur in occaecat"
    },
    {
      "message": "mollit cillum aute eiusmod"
    }
  ]
}
Request Payload
Response Payload
{
  "billable_breakdown": {
    "breakdown": {},
    "total": -18159071
  },
  "billable_count": 61647950,
  "contact_count": 94030893
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "reprehenderit elit in"
    },
    {
      "message": "dolore mollit sunt"
    }
  ]
}
Request Payload
{
  "file_type": "json",
  "list_ids": [
    "582f37b5-d30e-5331-f1ab-e58ed05b394e",
    "d6abdd68-7381-552c-583e-6ca5c6cbc98a",
    "23d318d0-4b01-74f7-c308-da035d570cbd",
    "3cc24c32-2ad5-f6b8-0d71-703957475ecc"
  ],
  "max_file_size": -59459021,
  "notifications": {
    "email": false
  },
  "segment_ids": [
    "sed",
    "id",
    "mollit amet",
    "commodo dolor",
    "exercitation"
  ]
}
Response Payload
{
  "_metadata": {
    "count": -8869911.991075113,
    "next": "http://BMiXsfYqp.gkboOoyJYLMtnaz2z+v+eYbGQJzKxPrxncrgArz,ku",
    "prev": "https://IudBwsggjjWXNrZSeF.wgtpW.r,eza",
    "self": "http://xsrrEYKXDvaoPP.hbrkfp9ZuY56RTP3NionV84PAlxxZ.28YSWj72c30"
  },
  "id": "ullamco do elit Duis"
}
{
  "errors": [
    {
      "error_id": "incididunt occaecat culpa laborum",
      "field": "velit aliquip voluptate laborum",
      "message": "deserunt sit reprehenderit exercitation",
      "parameter": "nisi"
    },
    {
      "error_id": "sunt sint anim",
      "field": "ex anim velit et pariatur",
      "message": "do officia",
      "parameter": "culpa minim Duis"
    },
    {
      "error_id": "mollit enim aliquip",
      "field": "ipsum Ut",
      "message": "dolor",
      "parameter": "ex sed irure"
    },
    {
      "error_id": "eiusmod",
      "field": "cupidatat exercitation non",
      "message": "ipsum",
      "parameter": "non"
    },
    {
      "error_id": "deserunt do ex ipsum",
      "field": "esse",
      "message": "esse ut laborum",
      "parameter": "ullamco magna eu eiusmod consequat"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "pariatur nisi in dolor"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "next": "est in in nisi",
    "prev": "ut",
    "self": "anim Duis Ut Excepteur"
  },
  "result": [
    {
      "_metadata": {
        "next": "ex",
        "prev": "commodo",
        "self": "enim culpa dolore voluptate dolor"
      },
      "completed_at": "et aliqua occaecat aliquip anim",
      "created_at": "incididunt ex quis",
      "expires_at": "velit laborum sit cillum ipsum",
      "export_type": "in nulla",
      "id": "cupidatat amet",
      "lists": [
        {
          "ID": "non aliquip",
          "Name": "ea"
        },
        {
          "ID": "est",
          "Name": "ut dolore laboris Ut"
        },
        {
          "ID": "labore",
          "Name": "in exercitation occaecat sint ullamco"
        },
        {
          "ID": "reprehenderit in eiusmod",
          "Name": "laborum do deserunt dolor sit"
        }
      ],
      "segments": [
        {
          "ID": "qui laboris do exercitation",
          "Name": "sint nulla"
        },
        {
          "ID": "ullamco ea",
          "Name": "veniam amet ad ipsum"
        },
        {
          "ID": "ipsum",
          "Name": "non et velit"
        },
        {
          "ID": "do nostrud voluptate",
          "Name": "ex quis veniam laboris in"
        }
      ],
      "status": "nulla in id",
      "urls": [
        "id laborum",
        "sint quis",
        "occaecat Lorem",
        "consectetur"
      ],
      "user_id": "dolor id ipsum aute"
    },
    {
      "_metadata": {
        "next": "sed veniam fugiat amet",
        "prev": "mollit aliquip",
        "self": "reprehenderit"
      },
      "completed_at": "ipsum velit ea cillum",
      "created_at": "ad ipsum",
      "expires_at": "nostrud",
      "export_type": "ipsum Lorem commodo",
      "id": "consequat in laboris Excepteur in",
      "lists": [
        {
          "ID": "enim est ex",
          "Name": "tempor mollit culpa"
        }
      ],
      "segments": [
        {
          "ID": "consequat do ut commodo sit",
          "Name": "fugiat occaecat"
        },
        {
          "ID": "occaecat",
          "Name": "officia voluptate eu"
        }
      ],
      "status": "ex do",
      "urls": [
        "cupidatat",
        "ullamco cillum eu non officia"
      ],
      "user_id": "pariatur labore magna veniam laborum"
    }
  ]
}
{
  "errors": [
    {
      "": "in occaecat officia",
      "error_id": "id amet",
      "message": "irure ullamco"
    },
    {
      "": "Duis sit",
      "error_id": "reprehenderit ullamco ad voluptate",
      "message": "exercitation commodo quis cupidatat"
    },
    {
      "": "amet Ut irure",
      "error_id": "ut",
      "message": "et ullamco"
    },
    {
      "": "in non enim occaecat magna",
      "error_id": "sed voluptate",
      "message": "nulla velit"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "dolor labore"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "self": "eiusmod enim non adipisicing"
  },
  "address_line_1": "non consectetur",
  "address_line_2": "id tempor cupidatat",
  "alternate_emails": [
    "fugiat aute",
    "proident ipsum",
    "ad anim"
  ],
  "city": "ullamco proident Excepteur dolore",
  "country": "officia nulla",
  "created_at": "id velit incididunt",
  "custom_fields": {},
  "email": "voluptate",
  "facebook": "ullamco non",
  "first_name": "ipsum Excepteur sit",
  "id": "irure dolore Excepteur culpa reprehenderit",
  "last_name": "consectetur ut est dolore dolor",
  "line": "et ea dolore",
  "list_ids": [
    "veniam",
    "dolor officia dolor amet ea"
  ],
  "phone_number": "ad aliqua elit",
  "postal_code": "nulla",
  "segment_ids": [
    "aliqua Ut ad",
    "deserunt",
    "nulla nostrud ullamco laborum",
    "incididunt officia non",
    "nulla"
  ],
  "state_province_region": "cupidatat sunt ex pariatur cillum",
  "unique_name": "nisi",
  "updated_at": "magna exercitation fugiat",
  "whatsapp": "amet"
}
{
  "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": "Excepteur"
    },
    {
      "message": "est"
    },
    {
      "message": "deserunt incididunt"
    },
    {
      "message": "anim proident consequat sint occaecat"
    }
  ]
}
Request Payload
{
  "query": "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')"
}
Response Payload
{
  "_metadata": {
    "self": "sunt aliqua ex culpa ut"
  },
  "contact_count": 94817928.68593213,
  "result": [
    {
      "_metadata": {
        "self": "veniam"
      },
      "address_line_1": "incididunt aliqua",
      "address_line_2": "aliquip Excepteur labore Lorem dolor",
      "alternate_emails": [
        "dolore",
        "in velit",
        "in sed nostrud pariatur in",
        "nisi ullamco minim ipsum ut"
      ],
      "city": "in ipsum labore",
      "country": "enim consequat",
      "created_at": "eu",
      "custom_fields": {},
      "email": "enim",
      "facebook": "aliqua commodo",
      "first_name": "dolore nulla elit sit",
      "id": "commodo in et aliquip consectetur",
      "last_name": "labore aliqua nisi et ex",
      "line": "consequat sunt mollit magna",
      "list_ids": [
        "qui Duis adipisicing"
      ],
      "phone_number": "adipisicing amet sint in Duis",
      "postal_code": "Ut",
      "segment_ids": [
        "anim qui"
      ],
      "state_province_region": "commodo cillum ea magna",
      "unique_name": "exercitation in tempor aliquip",
      "updated_at": "officia veniam aliquip",
      "whatsapp": "in sit sunt cillum labore"
    }
  ]
}
{
  "errors": [
    {
      "field": "esse",
      "message": "cupidatat minim tempor ipsum id"
    },
    {
      "field": "labore esse culpa quis incididunt",
      "message": "id dolor dolor"
    },
    {
      "field": "ea sed Duis Excepteur elit",
      "message": "fugiat officia eiusmod"
    },
    {
      "field": "deserunt Excepteur fugiat enim ex",
      "message": "consectetur laborum exercitation"
    }
  ]
}
{
  "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": "magna deserunt sint eu"
    },
    {
      "message": "officia culpa eu"
    },
    {
      "message": "in deserunt Duis sed"
    },
    {
      "message": "consectetur Excepteur cupidatat ipsum anim"
    },
    {
      "message": "laborum in et laboris"
    }
  ]
}
Request Payload
{
  "field_mappings": [
    "esse ut Ut sint"
  ],
  "file_type": "csv",
  "list_ids": [
    "nostrud et consequat",
    "velit",
    "pariatur fugiat do nisi"
  ]
}
Response Payload
{
  "job_id": "cillum Ut consectetur",
  "upload_headers": [
    {
      "header": "magna",
      "value": "id eu deserunt amet"
    },
    {
      "header": "dolore sint pariatur",
      "value": "labore dolore fugiat"
    },
    {
      "header": "et aliqua reprehenderit magna occaecat",
      "value": "nostrud"
    },
    {
      "header": "laboris non occaecat",
      "value": "sint incididunt"
    }
  ],
  "upload_uri": "aute"
}
{
  "errors": [
    {
      "error_id": "ullamco non amet",
      "field": "cillum do ut",
      "message": "mollit adipisicing",
      "parameter": "id ullamco voluptate officia laborum"
    },
    {
      "error_id": "aute exercitation labore",
      "field": "ea",
      "message": "adipisicing",
      "parameter": "ad occaecat ut officia nulla"
    },
    {
      "error_id": "Lorem occaecat in magna in",
      "field": "in irure id deserunt",
      "message": "ad sunt aute qui",
      "parameter": "Excepteur ipsum Ut culpa"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "dolore dolore eiusmod ipsum",
      "field": "dolor",
      "message": "consectetur quis aliquip",
      "parameter": "reprehenderit in Duis"
    },
    {
      "error_id": "Excepteur",
      "field": "ea officia",
      "message": "ipsum veniam enim",
      "parameter": "adipisicing dolore"
    }
  ]
}
{
  "errors": [
    {
      "message": "eiusmod"
    },
    {
      "message": "adipisicing dolore cupidatat"
    },
    {
      "message": "cillum Duis"
    }
  ]
}
Request Payload
Response Payload
{
  "finished_at": "minim",
  "id": "cupidatat ut do Lorem veniam",
  "job_type": "officia dolore aliquip",
  "results": {
    "created_count": -64743210.78789749,
    "deleted_count": -66839728.8620048,
    "errored_count": 82642872.70196092,
    "errors_url": "qui esse laborum",
    "requested_count": 7050321.4473975,
    "updated_count": 15210824.401157811
  },
  "started_at": "occaecat fugiat nisi laboris dolore",
  "status": "laboris in proident"
}
{
  "errors": {
    "error_id": "consequat dolore consectetur",
    "field": "ut do Excepteur",
    "message": "aliquip nostrud",
    "parameter": "labore eu nisi ad eiusmod"
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "dolor"
    },
    {
      "message": "consequat qui voluptate laborum"
    },
    {
      "message": "non id do"
    },
    {
      "message": "veniam voluptate nostrud eu ut"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "count": -15114376.68238251,
    "next": "http://LisSMeNZ.jeRovhDZ7NKnMw3BM7ieVjCXN8sjx18wvVlj1kv0bAYtlQAEoxCr3O-Bpj6-gPyVnbosXjsc0",
    "prev": "https://KjaADkcDoOXiJjYlmIf.pvptfmY,rk7AuIcqRua0ZS+saUk.w+WJy3QWrm",
    "self": "http://dbFGZHtSJReBwPS.cmdl8ygD5PNThm395Ek-WwxgK63NWGFlnaSMptxr+SYQEgHIqAK3rU3,Sk,J9UqvhX6UDi"
  },
  "completed_at": "ea aliqua qui dolore tempor",
  "contact_count": 85004513,
  "created_at": "aliquip mollit do",
  "expires_at": "dolore Duis mollit consequat",
  "id": "nulla velit labore fugiat aliqua",
  "message": "officia deserunt ex magna",
  "status": "ready",
  "updated_at": "minim proident Ut commodo",
  "urls": [
    "aute quis eiusmod officia"
  ]
}
{
  "errors": [
    {
      "error_id": "eu Ut ullamco Excepteur in",
      "field": "commodo adipisicing",
      "message": "fugiat Excepteur",
      "parameter": "ut proident Lorem"
    },
    {
      "error_id": "laborum ut sit",
      "field": "in officia pariatur",
      "message": "nulla aliquip cupidatat sint",
      "parameter": "in ipsum commodo non"
    },
    {
      "error_id": "sunt aute reprehenderit non",
      "field": "ex sed ut sunt",
      "message": "dolore",
      "parameter": "Duis"
    }
  ]
}
{
  "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"
    }
  ]
}
Request Payload
{
  "ids": [
    "1234",
    "1235"
  ]
}
Response Payload
{
  "result": [
    {
      "_metadata": {
        "self": "nostrud quis ullamco"
      },
      "address_line_1": "reprehenderit sint",
      "address_line_2": "dolore",
      "alternate_emails": [
        "sint",
        "ad"
      ],
      "city": "culpa",
      "country": "et fugiat in",
      "created_at": "irure laboris cupidatat nisi ullamco",
      "custom_fields": {},
      "email": "officia id qui",
      "facebook": "officia ex in",
      "first_name": "ut ad",
      "id": "occaecat anim reprehenderit exercitation",
      "last_name": "tempor enim anim magna",
      "line": "qui commodo",
      "list_ids": [
        "in cupidatat",
        "exercitation aute ea",
        "nulla",
        "Lorem"
      ],
      "phone_number": "velit nostrud nisi dolor ipsum",
      "postal_code": "ullamco incididunt laboris officia",
      "segment_ids": [
        "in ex pariatur"
      ],
      "state_province_region": "proident eiusmod quis ea Ut",
      "unique_name": "sint",
      "updated_at": "incididunt reprehenderit id",
      "whatsapp": "dolor"
    },
    {
      "_metadata": {
        "self": "in eu cillum"
      },
      "address_line_1": "tempor",
      "address_line_2": "est incididunt esse dolore minim",
      "alternate_emails": [
        "aute",
        "laborum pariatur eiusmod quis qui",
        "ullamco sit dolor tempor dolor",
        "ipsum dolore anim officia",
        "occaecat velit in"
      ],
      "city": "ut",
      "country": "id veniam",
      "created_at": "anim reprehenderit do Duis",
      "custom_fields": {},
      "email": "eiusmod",
      "facebook": "aute eiusmod",
      "first_name": "do mollit tempor",
      "id": "cupidatat ea",
      "last_name": "consequat veniam",
      "line": "in officia nulla",
      "list_ids": [
        "cillum in",
        "id non exercitation aliqua dolore",
        "tempor exercitation ad consequat officia",
        "ullamco Duis",
        "proident dolore sint voluptate ex"
      ],
      "phone_number": "labore culpa",
      "postal_code": "amet ipsum non",
      "segment_ids": [
        "magna",
        "minim",
        "Lorem sunt eiusmod Ut",
        "amet sunt Lorem aliquip"
      ],
      "state_province_region": "Excepteur dolor nostrud qui",
      "unique_name": "sit deserunt",
      "updated_at": "ullamco Duis mollit amet",
      "whatsapp": "amet aliqua in"
    },
    {
      "_metadata": {
        "self": "anim in"
      },
      "address_line_1": "in fugiat",
      "address_line_2": "voluptate ut in dolore",
      "alternate_emails": [
        "laboris",
        "do ullamco laboris consectetur veniam",
        "sunt ut nostrud eiusmod Excepteur",
        "officia ipsum",
        "et consequat dolor Ut reprehenderit"
      ],
      "city": "do",
      "country": "elit sed dolor",
      "created_at": "voluptate anim",
      "custom_fields": {},
      "email": "ex id",
      "facebook": "culpa non",
      "first_name": "consectetur velit ipsum",
      "id": "ex in reprehenderit veniam minim",
      "last_name": "veniam est officia dolore",
      "line": "dolor irure Excepteur sit",
      "list_ids": [
        "eiusmod Ut dolor dolor nisi",
        "minim aliqua nisi in",
        "voluptate anim et consequat elit",
        "dolore ut quis",
        "et ut reprehenderit elit proident"
      ],
      "phone_number": "reprehenderit Ut sunt",
      "postal_code": "et in commodo consequat Excepteur",
      "segment_ids": [
        "cupidatat ad",
        "nostrud deserunt mollit officia laboris",
        "nulla mollit nostrud commodo dolore",
        "consequat in sit",
        "velit"
      ],
      "state_province_region": "dolore",
      "unique_name": "sit",
      "updated_at": "cillum nostrud nulla aliqua sunt",
      "whatsapp": "ullamco magna Duis dolore"
    },
    {
      "_metadata": {
        "self": "in do est commodo nostrud"
      },
      "address_line_1": "laborum",
      "address_line_2": "aliquip dolor",
      "alternate_emails": [
        "Lorem veniam laboris id",
        "qui sit",
        "sint Lorem",
        "pariatur"
      ],
      "city": "dolore minim consectetur mollit sed",
      "country": "nisi aliqua minim sunt consectetur",
      "created_at": "ut",
      "custom_fields": {},
      "email": "dolor labore",
      "facebook": "dolor pariatur",
      "first_name": "in Lorem quis proident minim",
      "id": "consequat ad",
      "last_name": "cillum",
      "line": "Duis ad labore",
      "list_ids": [
        "labore consectetur in enim esse"
      ],
      "phone_number": "adipisicing aliqua in enim deserunt",
      "postal_code": "in Lorem anim consequat aliqua",
      "segment_ids": [
        "labore",
        "reprehenderit sed minim"
      ],
      "state_province_region": "consectetur proident",
      "unique_name": "aliquip",
      "updated_at": "consequat pariatur deserunt enim",
      "whatsapp": "occaecat elit eu"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "non"
    },
    {
      "message": "in ipsum consectetur"
    },
    {
      "message": "eiusmod"
    },
    {
      "message": "est id adipisicing irure consectetur"
    }
  ]
}
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": "sint dolore id"
    },
    {
      "message": "pariatur tempor"
    },
    {
      "message": "in amet cillum tempor"
    }
  ]
}

Segmenting Contacts V2 - Beta(5 operations)

Request Payload
{
  "name": "dolore ea id mollit dolore",
  "parent_list_ids": [
    "eiusmod Excepteur dolor",
    "ad",
    "occaecat ullamco esse incididunt",
    "eiusmod ut labore ea"
  ],
  "query_dsl": "fugiat ex non Excepteur"
}
Response Payload
{
  "contacts_count": 89288439,
  "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": "tempor consequat nisi",
  "id": "17b1ac05-d16b-57ab-cf67-1ff06330d8b5",
  "name": "est Duis ut",
  "next_sample_update": "officia",
  "parent_list_ids": [
    "nulla id",
    "aute",
    "nulla"
  ],
  "query_dsl": "proident dolore",
  "query_version": "velit dolore deserunt",
  "sample_updated_at": "ut laboris dolore adipisicing",
  "status": {
    "error_message": "dolor dolore ex qui Duis",
    "query_validation": "do minim tempor cillum"
  },
  "updated_at": "et officia"
}
{
  "errors": [
    {
      "field": "dolor",
      "message": "sed consequat labore"
    },
    {
      "field": "laborum sunt fugiat nostrud",
      "message": "Excepteur Duis laborum nisi"
    },
    {
      "field": "mollit sint proident",
      "message": "id"
    },
    {
      "field": "ipsum eu labore amet",
      "message": "elit labore"
    }
  ]
}
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": "eiusmod sed minim labore reprehenderit",
      "message": "sint exercitation non aliqua"
    },
    {
      "field": "in sed sint amet voluptate",
      "message": "pariatur sint consectetur elit"
    },
    {
      "field": "do",
      "message": "qui reprehenderit in labore"
    }
  ]
}
Query Parameter NameExample
parent_list_idsincididunt Duis minim sunt
no_parent_list_idtrue
Request Payload
Response Payload
{
  "_metadata": {
    "count": 42244734,
    "next": "http://rpCNfJuEAyxXInzRp.laEv.AUcr6LAGPpu4uRsVitIwgmT6",
    "prev": "http://osV.cezhq1nnQ3twnrk8Z7Anwdfa.RPmYo",
    "self": "https://ydEIrZutvqFWP.fznjtApf"
  },
  "contacts_count": 17999521,
  "created_at": "proident ex",
  "id": "6be492d7-24ec-5257-6cb7-d85f0a4d59e8",
  "name": "elit",
  "next_sample_update": "culpa non tempor",
  "parent_list_ids": [
    "pariatur commodo anim amet",
    "labore magna consequat in aliquip"
  ],
  "query_version": "exercitation",
  "sample_updated_at": "culpa",
  "status": {
    "error_message": "officia ipsum nisi",
    "query_validation": "reprehenderit in Ut"
  },
  "updated_at": "dolore voluptate nisi cupidatat do"
}
{
  "errors": [
    {
      "field": "veniam proident quis in dolore",
      "message": "nulla"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "dolore ut cillum reprehenderit",
      "message": "aute velit exercitation anim"
    },
    {
      "field": "non tempor elit quis velit",
      "message": "sint adipisicing nisi Lorem"
    }
  ]
}
Request Payload
{
  "name": "elit aliqua ex",
  "query_dsl": "sed consectetur magna eu enim"
}
Response Payload
{
  "contacts_count": -47186221,
  "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"
    },
    {
      "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": "culpa Duis sit incididunt",
  "id": "cf1954b4-b5ec-5a5d-dc7f-8778b0de66b9",
  "name": "adipisicing",
  "next_sample_update": "Ut Lorem ex",
  "parent_list_ids": [
    "ea id",
    "commodo"
  ],
  "query_dsl": "minim velit",
  "query_version": "Duis laboris elit Lorem Ut",
  "sample_updated_at": "et eu cupidatat reprehenderit in",
  "status": {
    "error_message": "dolor",
    "query_validation": "do"
  },
  "updated_at": "officia"
}
{
  "errors": [
    {
      "field": "labore dolore aliquip Excepteur",
      "message": "sed sunt"
    },
    {
      "field": "sunt",
      "message": "qui"
    },
    {
      "field": "veniam Ut dolore ex laborum",
      "message": "qui sed voluptate dolore aliqua"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "deserunt eiusmod ut quis consequat",
      "message": "Duis"
    }
  ]
}
Query Parameter NameExample
contacts_sampletrue
Request Payload
Response Payload
{
  "contacts_count": 80417800,
  "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"
    },
    {
      "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": "non id eu",
  "id": "dde6a04c-8a9c-04aa-2087-42b183cafd51",
  "name": "reprehenderit exercitation",
  "next_sample_update": "in",
  "parent_list_ids": [
    "velit dolor qui id aute",
    "enim consectetur velit",
    "irure consequat Lorem mollit",
    "Ut"
  ],
  "query_dsl": "consequat cupidatat",
  "query_version": "cupidatat voluptate",
  "sample_updated_at": "reprehenderit",
  "status": {
    "error_message": "in",
    "query_validation": "Lorem culpa dolor in Ut"
  },
  "updated_at": "fugiat minim anim"
}
{
  "errors": [
    {
      "field": "dolore consequat in sit",
      "message": "cillum"
    }
  ]
}
{
  "errors": [
    {
      "field": "Duis",
      "message": "mollit consectetur sunt ullamco Ut"
    },
    {
      "field": "quis ullamco",
      "message": "ex"
    },
    {
      "field": "ex",
      "message": "sit occaecat laboris esse"
    },
    {
      "field": "in fugiat incididunt tempor",
      "message": "eu do cupidatat esse dolore"
    },
    {
      "field": "velit eu",
      "message": "Lorem in"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "dolore",
      "message": "in eu non mollit"
    },
    {
      "field": "nisi aliquip",
      "message": "deserunt sed consequat eiusmod sint"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "sed veniam laboris quis dolore",
      "message": "commodo ut ut ad"
    },
    {
      "field": "aliqua",
      "message": "do sint fugiat"
    },
    {
      "field": "do ut sint proident irure",
      "message": "ut labore est do eu"
    }
  ]
}

Senders

Header NameExample
on-behalf-of"culpa ullamco"
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": "consectetur pariatur non dolore"
    }
  ]
}

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

segmenting contacts(5 operations)

Request Payload
{
  "name": "velit do nisi",
  "parent_list_id": "bdfb1921-6435-cb4f-fcf5-edfcd8a64f1e",
  "parent_list_ids": [
    "qui eiusmod irure aute ut",
    "sunt Ut dolor"
  ],
  "query_dsl": "ea elit"
}
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": "veniam eiusmod velit"
    },
    {
      "message": "do non ullamco pariatur veniam"
    },
    {
      "message": "velit enim"
    },
    {
      "message": "id veniam"
    },
    {
      "message": "pariatur minim sint"
    }
  ]
}
Query Parameter NameExample
parent_list_idsdeserunt Duis ea
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": "qui in Ut"
    }
  ]
}
Query Parameter NameExample
query_jsonfalse
Request Payload
Response Payload
{
  "id": "3b049926-0a54-4a91-83f0-086ace63c530",
  "contacts_count": -83213117,
  "created_at": "voluptate sunt non fugiat",
  "sample_updated_at": "labore occaecat sunt enim",
  "updated_at": "sunt aliqui",
  "contacts_sample": [
    {
      "contact_id": "e70eac25-1431-4231-bccd-1cfab432301e",
      "primary_email": "KLTF@SurgGzlAxCPOqhOUHYNBLsfpfE.trh",
      "alternate_emails": [
        "dTeJZgU5uN9UYSo@nfIB.ijxg"
      ],
      "first_name": "ullamco esse culpa do",
      "last_name": "officia laboris veniam consequat",
      "address_line_1": "in occaecat labore est tempor",
      "address_line_2": "magna adipisicing",
      "city": "ƞó",
      "state_province_region": "culpa ut",
      "postal_code": -75218567,
      "country": "voluptate in in reprehenderit aliquip",
      "custom_fields": {
        "custom_field_name1": "amet deserunt mollit",
        "custom_field_name2": "minim consequat id"
      }
    },
    {
      "contact_id": "db637d33-bce1-462c-ae9c-91ec4f761de6",
      "primary_email": "t7N5TjDmKhC0@gfdifW.ua",
      "alternate_emails": [
        "gQol@Xcfilli.hc",
        "n4K7OdaVQh@YfsnF.ie",
        "TdnvS3nMStREn@miFjGzNDCPZWhiswJNxrFnOYdUAZEpesQ.yxpu",
        "xRzGDTTzzbYK@eJ.wpgb",
        "iI1rOpx2ct@aZhuYGZBxJLZ.phr"
      ],
      "first_name": "ea et eu",
      "last_name": "velit Ut laborum ipsu",
      "address_line_1": "labore",
      "address_line_2": "non",
      "city": "ĔȸąŸÂ¸ȠɏbɄ",
      "state_province_region": "deserunt dolore",
      "postal_code": -95171713,
      "country": "do",
      "list_ids": [
        "c712288b-2300-4069-bef4-2e05b5948ec3",
        "9003ef29-5eb7-4951-898b-1b102e490d6e"
      ]
    }
  ],
  "name": "enim et anim",
  "query_dsl": "nostrud"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "velit esse officia",
      "message": "sed dolor et"
    },
    {
      "field": "exercitation in enim",
      "message": "ea labore id quis"
    },
    {
      "field": "culpa exercitation consectetur irure voluptate",
      "message": "adipisicing"
    }
  ]
}
{
  "errors": [
    {
      "message": "tempor do"
    },
    {
      "message": "id nostrud"
    },
    {
      "message": "ea ipsum"
    },
    {
      "message": "dolor exercitation"
    },
    {
      "message": "nulla magna minim"
    }
  ]
}
Request Payload
{
  "name": "Excepteur a",
  "parent_list_ids": [
    "id",
    "sed incididunt culpa eiusmod in",
    "consequat commodo"
  ],
  "query_dsl": "ut"
}
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": "aliquip",
      "message": "magna quis est pariatur veniam"
    },
    {
      "field": "proident enim aute",
      "message": "sit commodo dolor"
    },
    {
      "field": "ullamco occaecat aliqua veniam",
      "message": "consequat dolore"
    },
    {
      "field": "dolore ea",
      "message": "dolore veniam sed"
    },
    {
      "field": "Ut Excepteur",
      "message": "minim"
    }
  ]
}
{
  "errors": [
    {
      "message": "consectetur"
    },
    {
      "message": "in irure"
    },
    {
      "message": "nulla Lorem"
    },
    {
      "message": "ut minim anim"
    }
  ]
}
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": "aliqua Lorem laboris amet",
      "message": "amet dolore dolor dolore sed"
    },
    {
      "field": "nulla sint exercitation minim",
      "message": "ex proident elit consectetur aute"
    }
  ]
}
{
  "errors": [
    {
      "message": "magna reprehenderit dolor laboris"
    },
    {
      "message": "in incididunt"
    },
    {
      "message": "deserunt"
    },
    {
      "message": "est adipisicing aliquip"
    },
    {
      "message": "esse tempor incididunt aute"
    }
  ]
}

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": "ad",
      "id": "ut id",
      "resources": {
        "ids": [
          "sit nulla occaecat cupidatat ullamco",
          "exercitation ullamco incididunt deserunt consequat"
        ],
        "type": "deserunt ullamco"
      }
    },
    {
      "error": "ipsum aute voluptate sit",
      "id": "anim occaecat deserunt",
      "resources": {
        "ids": [
          "Duis in eiusmod voluptate pariatur"
        ],
        "type": "ullamco"
      }
    }
  ]
}
{}
{
  "errors": [
    {
      "field": "cillum incididunt laborum ipsum et",
      "message": "aliquip laboris non"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "Excepteur dolore"
    }
  ]
}

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": "qui officia in ullamco",
      "field": "Duis",
      "message": "est ipsum sed id in"
    },
    {
      "error_id": "Lorem ipsum id",
      "field": "officia aliqua deserunt incididunt",
      "message": "eu dolor Excepteur anim proident"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ipsum veniam",
      "field": "aliquip",
      "message": "aliquip cillum"
    }
  ]
}
Query Parameter NameExample
page_size40288639
page_tokensint adipisicing cupidatat tempor amet
Request Payload
Response Payload
{
  "_metadata": {
    "count": 90272294,
    "next": "http://ejtPDsxGALuylyOvCzJQDljgffWbzVW.spqvLX,FaUQ4MMFQN4pkyt9.Q7eIO3",
    "prev": "http://sinlLCwIHTZzDrwiaVvoWnAZMNBHe.ythcXL+wohUwNjqlNrO1OwEgszxiF4,XEY2ibM",
    "self": "https://pqwQakQkDzPksOPLmbJ.ldnjFV"
  },
  "result": [
    {
      "abtest": {
        "duration": "commodo ullamco elit",
        "expiration_date": null,
        "test_percentage": -58697576,
        "type": "subject",
        "winner_criteria": "open",
        "winner_selected_at": "in",
        "winning_template_id": "culpa qui amet reprehenderit minim"
      },
      "categories": [
        "qui Lorem proident pariatur irure",
        "aliquip",
        "ex laborum esse consectetur enim",
        "qui id",
        "quis",
        "aliqua consequat irure",
        "amet",
        "et dolore",
        "in consectetur laboris est veniam",
        "ex veniam"
      ],
      "created_at": "1924-08-25T20:59:57.0Z",
      "id": "b9ed42f7-d213-0ac1-3801-2e8ca1e3d075",
      "is_abtest": true,
      "name": "sint",
      "send_at": "1929-10-16T01:45:18.0Z",
      "status": "triggered",
      "updated_at": "1933-12-08T02:37:12.0Z"
    },
    {
      "abtest": {
        "duration": "id do ut aute",
        "expiration_date": null,
        "test_percentage": 91890787,
        "type": "subject",
        "winner_criteria": "click",
        "winner_selected_at": null,
        "winning_template_id": "dolore occaecat Duis dolore incididunt"
      },
      "categories": [
        "Excepteur anim elit culpa dolor",
        "reprehenderit aliqua Duis consequat mollit",
        "occaecat reprehenderit ipsum nulla sunt",
        "amet",
        "sunt ut dolor",
        "tempor enim ipsum adipisicing",
        "eiusmod ex velit in consequat",
        "nulla mollit Lorem",
        "non",
        "amet elit aute eiusmod dolor"
      ],
      "created_at": "1931-05-24T18:51:55.0Z",
      "id": "467a5bcb-4804-f1d5-15b1-02cf0e0b9505",
      "is_abtest": true,
      "name": "occaecat amet",
      "send_at": "1891-07-21T22:53:57.0Z",
      "status": "scheduled",
      "updated_at": "1961-10-25T07:04:27.0Z"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "laboris",
      "field": "aliquip",
      "message": "ut pariatur nisi aliquip"
    }
  ]
}
Query Parameter NameExample
ids["occaecat elit laboris","in laborum non dolor sunt","dolor officia et elit esse","ex aute","culpa","reprehenderit incididunt","Ut id dolor et sit","Ut","nostrud cillum enim","Excepteur est minim id"]
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "incididunt dolor cillum pariatur",
      "field": "incididunt sunt cillum aliquip",
      "message": "sed"
    },
    {
      "error_id": "aute voluptate",
      "field": "reprehenderit ad",
      "message": "Ut do ut"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ut Excepteur ea veniam dolore",
      "field": "Excepteur proident",
      "message": "cillum incididunt voluptate irure nostrud"
    }
  ]
}
Request Payload
{
  "name": "ut eu mollit non"
}
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": "et exercitation",
      "field": "amet",
      "message": "quis esse velit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "incididunt Duis",
      "field": "velit amet",
      "message": "esse"
    },
    {
      "error_id": "aliqua proident consectetur deserunt dolore",
      "field": "officia eiusmod nulla",
      "message": "eu"
    }
  ]
}
Request Payload
{
  "categories": [
    "proident ut",
    "in ipsum",
    "dolore culpa",
    "dolore eiusmod",
    "adipisicing dolore dolor",
    "aliqua adipisicing",
    "Excepteur fugiat eiusmod ea sed",
    "esse",
    "nostrud est et aute",
    "fugiat"
  ],
  "email_config": {
    "custom_unsubscribe_url": "http://lSDSdRyPgo.ieha+C7RRepDWYAxrFink23KTQVZbCa",
    "design_id": "deserunt qui",
    "editor": "design",
    "generate_plain_content": false,
    "html_content": "ipsum aute proident cupidatat magna",
    "ip_pool": null,
    "plain_content": "occaecat",
    "sender_id": 15056366,
    "subject": "voluptate enim sunt ipsum",
    "suppression_group_id": null
  },
  "name": "veniam pariatur dolor ipsum anim",
  "send_at": "1899-07-23T09:18:48.0Z",
  "send_to": {
    "all": false,
    "list_ids": [
      "78c07e78-4501-a6b8-17b4-ca9d8c425525",
      "d2313c44-5550-85b7-8723-ec6a648bdb23",
      "dfd6f722-35fc-cf3b-adc9-7ac32a57c822",
      "a2c966fd-7db5-f578-e0ad-4ba68ef33b9c",
      "12a7baa3-5b97-0d4c-95b8-f6efacaf47c8",
      "ca9b6e37-02a8-c9a6-451f-2405104183a5",
      "ac990027-6fa4-ebd4-2440-8415fd5b60b1",
      "1c7e23bf-1282-ee3f-3f26-2b0211421edb",
      "c61c3f1c-ecc3-79f6-93ee-cd497761cdfa",
      "7e5b7257-45bf-243f-6c9a-e6bb50ef70fe"
    ],
    "segment_ids": [
      "b72fd655-7eff-8509-26aa-986e85b4e3be",
      "fee0feab-43d7-53c1-d90b-3cfd5f8eba2f",
      "8ec57bea-6b1c-a7f7-610a-b378d1de4030",
      "e5cc5b09-31a8-c7a1-65c1-507fd1b1653e",
      "adfec532-5e5c-95fe-edc5-174cc8b27fc4",
      "0cb7d03b-6dd2-4d25-bc38-c2214cf43975",
      "c15adb97-0f70-2868-756c-589f2b041c5c",
      "6f22d051-1dea-c147-2f9c-74ba01550608",
      "39f2bf06-e3a5-cbb2-5bb7-c94f2f11a108",
      "befa7a18-9b09-32fa-c506-deafdc02f65d"
    ]
  }
}
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": "sint in",
      "field": "et sit Excepteur reprehenderit in",
      "message": "nostrud exercitation in ut cupidatat"
    },
    {
      "error_id": "amet ipsum aliqua Ut sunt",
      "field": "consectetur",
      "message": "nisi"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ullamco",
      "field": "officia Excepteur est",
      "message": "quis pariatur aliqua incididunt"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "dolor",
      "field": "ipsum Ut dolor",
      "message": "Lorem consequat aliquip eiusmod"
    }
  ]
}
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": "cillum proident dolore",
      "field": "in id amet",
      "message": "commodo"
    },
    {
      "error_id": "eiusmod",
      "field": "id Ut",
      "message": "esse Lorem voluptate dolor"
    },
    {
      "error_id": "ad Lorem laboris proident",
      "field": "anim occaecat dolore elit in",
      "message": "quis nisi"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "aliquip id reprehenderit irure ullamco",
      "field": "aliqua eiusmod ex est",
      "message": "Duis quis in Ut"
    },
    {
      "error_id": "voluptate cillum",
      "field": "ea sunt exercitation eiusmod",
      "message": "anim ut aute"
    },
    {
      "error_id": "enim labore",
      "field": "aliqua",
      "message": "officia voluptate anim cupidatat"
    },
    {
      "error_id": "dolore non deserunt",
      "field": "ex Ut ut cupidatat sit",
      "message": "labore adipisicing exercitation esse velit"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "non officia sunt",
      "field": "dolor mollit ipsum deserunt esse",
      "message": "ullamco Excepteur dolor"
    },
    {
      "error_id": "sed minim dolor",
      "field": "Ut veniam anim",
      "message": "et dolor esse ut"
    },
    {
      "error_id": "cupidatat",
      "field": "occaecat deserunt ad fugiat in",
      "message": "ut deserunt occaecat labore minim"
    },
    {
      "error_id": "dolore",
      "field": "laboris consectetur officia",
      "message": "in elit mollit aliqua"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "dolore est qui sunt",
      "field": "nisi laboris tempor ut",
      "message": "Duis consectetur culpa"
    },
    {
      "error_id": "est in",
      "field": "commodo aliquip qui",
      "message": "mollit"
    },
    {
      "error_id": "in Excepteur ullamco dolore",
      "field": "labore",
      "message": "voluptate sed ut consequat"
    },
    {
      "error_id": "anim exercitation cillum",
      "field": "nulla",
      "message": "dolore exercitation dolor sed proident"
    }
  ]
}
Query Parameter NameExample
page_size74370689
page_tokenvelit fugiat deserunt ad
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": "ullamco officia veniam laboris elit",
      "field": "tempor adipisicing ut Excepteur",
      "message": "non in Ut"
    },
    {
      "error_id": "ad amet dolore",
      "field": "ad labore in exercitation",
      "message": "sunt sit fugiat"
    },
    {
      "error_id": "in sit consequat",
      "field": "nostrud",
      "message": "ut anim"
    },
    {
      "error_id": "cupidatat Lorem culpa eu commodo",
      "field": "aliquip non laboris fugiat ex",
      "message": "fugiat in"
    }
  ]
}
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 quis nisi",
      "field": "veniam Ut mollit Duis nulla",
      "message": "nulla exercitation in irure laborum"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "enim cupidatat",
      "field": "veniam non exercitation tempor",
      "message": "ea"
    },
    {
      "error_id": "minim ut sint id",
      "field": "dolor",
      "message": "amet"
    },
    {
      "error_id": "labore sint occaecat",
      "field": "minim qui",
      "message": "dolore eiusmod exercitation nostrud"
    },
    {
      "error_id": "laborum consequat",
      "field": "labore pariatur",
      "message": "enim deserunt"
    }
  ]
}
Request Payload
Response Payload
{
  "send_at": "1915-12-31T11:50:25.0Z",
  "status": "draft"
}
{
  "errors": [
    {
      "error_id": "quis anim",
      "field": "in culpa",
      "message": "incididunt cillum"
    },
    {
      "error_id": "Ut",
      "field": "ut elit",
      "message": "dolor officia amet in cupidatat"
    },
    {
      "error_id": "est quis",
      "field": "ipsum",
      "message": "et"
    },
    {
      "error_id": "eiusmod",
      "field": "cupidatat cillum",
      "message": "Lorem deserunt est"
    },
    {
      "error_id": "laboris dolor",
      "field": "voluptate veniam nostrud ut",
      "message": "Lorem incididunt"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ullamco in qui",
      "field": "elit qui in",
      "message": "sunt amet aute Ut ut"
    },
    {
      "error_id": "aute pariatur ullamco cillum",
      "field": "laborum magna quis non minim",
      "message": "proident"
    },
    {
      "error_id": "Lorem ex exercitation officia",
      "field": "eu",
      "message": "eu"
    },
    {
      "error_id": "incididunt",
      "field": "Duis qui",
      "message": "ad"
    },
    {
      "error_id": "proident eu in nostrud dolor",
      "field": "ea officia",
      "message": "dolore do"
    }
  ]
}
Request Payload
Response Payload
{
  "categories": [
    "equipment",
    "shoes",
    "sports"
  ]
}
{
  "errors": [
    {
      "error_id": "in in nisi minim aliqua",
      "field": "irure quis in commodo pariatur",
      "message": "dolore consequat sint"
    },
    {
      "error_id": "incididunt ipsum do Ut",
      "field": "quis ex sunt aute",
      "message": "ea adipisicing commodo esse sunt"
    },
    {
      "error_id": "consectetur anim voluptate cillum",
      "field": "ullamco esse",
      "message": "exercitation et magna"
    },
    {
      "error_id": "ut dolor et incididunt deserunt",
      "field": "esse exercitation Lorem pariatur Excepteur",
      "message": "consequat"
    }
  ]
}

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["dolor","et pariatur sint","adipisicing dolore pariatur nulla","sed consectetur qui","magna consequat irure deserunt","veniam culpa","ex nostrud dolore","sit do id","nostrud elit deserunt eiusmod ex","esse anim"]
page_size30
page_tokenfugiat voluptate tempor
Request Payload
Response Payload
{
  "_metadata": {
    "count": 43270638.210772336,
    "next": "http://LLRpRCrSonHAjHE.jhnenZe.Dkl7B",
    "prev": "https://wTRbNPagVdBUInUzyCB.yiaOHEW7NTYM3G7WKx",
    "self": "http://lNafiYPsqbouv.pubuliIerr5G3YrcDwanCnkLcYOaEetKzWZAGj"
  },
  "results": [
    {
      "aggregation": "dolore et voluptate laboris consectetur",
      "id": "7bf6d7df-2291-b953-a94b-ca38e4736d80",
      "stats": {
        "bounce_drops": 90071744,
        "bounces": 12439667,
        "clicks": -13978194,
        "delivered": 53636149,
        "invalid_emails": -8205012,
        "opens": 62148535,
        "requests": -8214454,
        "spam_report_drops": 54692781,
        "spam_reports": 82437095,
        "unique_clicks": 90703771,
        "unique_opens": -78145790,
        "unsubscribes": 24896036
      },
      "step_id": "labore consectetur do"
    },
    {
      "aggregation": "labore adipisicing",
      "id": "bae1a1de-c062-e51e-dd78-63911aaba2bd",
      "stats": {
        "bounce_drops": 76068341,
        "bounces": -57568248,
        "clicks": 96741037,
        "delivered": -98437934,
        "invalid_emails": 34408458,
        "opens": 22100739,
        "requests": -79988643,
        "spam_report_drops": 70618281,
        "spam_reports": 74357799,
        "unique_clicks": -93626069,
        "unique_opens": -58460406,
        "unsubscribes": 91986032
      },
      "step_id": "fugiat esse"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
group_by["step_id","step_id","step_id","step_id","step_id"]
step_ids["79179435-9541-e831-681a-47e301edc75d","93e24064-2382-918b-36a0-85798860f0e0","9e16671f-dc9c-9372-0111-1c9a4c002b2e","12aca71e-bd40-075b-5daa-babee63b8ffc"]
aggregated_bytotal
start_date1951-09-11
end_date1930-11-06
timezonemollit eiusmod consectetur consequat sed
page_size76
page_tokenculpa ullamco dolor
Request Payload
Response Payload
{
  "_metadata": {
    "count": 87604871.32451224,
    "next": "https://FAXgbGleDbVOvGtjpR.tmlciXMgrhhrW9d65vj+LcuJorXv71xDr7iKjfvwnNu0BY6YPJlT3xvzN",
    "prev": "http://ipTZpjCBuhDldKHEKqonPVjSReIBNg.ydamCH+aK-kdPmIYES9+NfYd+zHJSOCU-oMnpbuT",
    "self": "https://G.hhue26JGC7YLxRQDxW9K8AONoiwrj0vxbQcbfKI,wVOu4h"
  },
  "results": [
    {
      "aggregation": "dolor",
      "id": "8d7122bf-2a15-e1d4-6e02-c716d519fff0",
      "stats": {
        "bounce_drops": -95251754,
        "bounces": 17653094,
        "clicks": 43808083,
        "delivered": 61521480,
        "invalid_emails": 36989185,
        "opens": -65503900,
        "requests": -96803891,
        "spam_report_drops": -17175740,
        "spam_reports": 8260915,
        "unique_clicks": -37709959,
        "unique_opens": -24292311,
        "unsubscribes": -42659083
      },
      "step_id": "ut sunt cupidatat quis proident"
    }
  ]
}
{
  "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["aliquip exercitation sunt nulla pariatur","velit pariatur ad","ipsum consectetur elit cupidatat","ut ea","exercitation enim","consectetur velit ex culpa","cillum dolore Ut","sint minim","proident","commodo est"]
page_size96
page_tokenLorem tempor
Request Payload
Response Payload
{
  "_metadata": {
    "count": 26873382.190906495,
    "next": "https://yhqPqTPBOwzZMDCNhYMRMfpSEYYeiHG.uholuALP1qUwAfbaW0MXpy7pD.vnUPcT,cZtI7TVjlRub7Ulp+eMUpxhKOc1L4",
    "prev": "https://fVZE.tniuqDY9SAr.10QrdrmM+t1Ja,MUPJa0",
    "self": "https://VQbSlnwMf.xevcjYHtDfH"
  },
  "results": [
    {
      "ab_phase": "all",
      "ab_variation": "c5684e38-665c-7579-7b73-83b82ae41ae0",
      "aggregation": "magna exercitation culpa in commodo",
      "id": "5be8fd37-99ca-839d-fbde-75b18cd18d87",
      "stats": {
        "bounce_drops": -45588111,
        "bounces": -80846483,
        "clicks": -90643827,
        "delivered": -46768157,
        "invalid_emails": 46213483,
        "opens": -66919808,
        "requests": -89288459,
        "spam_report_drops": 35407151,
        "spam_reports": 46477106,
        "unique_clicks": 6261411,
        "unique_opens": 68420360,
        "unsubscribes": -36692690
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
aggregated_bytotal
start_date1911-01-14
end_date1891-08-23
timezonead
page_size33
page_tokenest
group_by["ab_variation"]
Request Payload
Response Payload
{
  "_metadata": {
    "count": 40220967.909202665,
    "next": "http://NdaIFSnGnsYSJUgApfco.efw32xu20lhvC+vSajuAtSbD3vid,17KPWM0MPL2f4BqZaagd5MiB",
    "prev": "http://cVGFimdtaGeVutHqaDXpEdHyZTmCAaRu.mwwh6J8XwgNTPLWGI-flxnHJGuuckm.FkzULCvj",
    "self": "http://AoyPnV.hqojV,ag3OHQO,,IavnHHADkVkqZhQha,iXI7KXAjUdlxgMEWy8jczIC0FmeFwOQKxj,iDFR"
  },
  "results": [
    {
      "ab_phase": "all",
      "ab_variation": "00254900-ae26-1096-a69f-53296a7a7d72",
      "aggregation": "mollit",
      "id": "bb007103-f887-f603-c711-2f76709ed184",
      "stats": {
        "bounce_drops": -35661082,
        "bounces": -82443045,
        "clicks": -27585910,
        "delivered": 15730926,
        "invalid_emails": 55330564,
        "opens": -66818608,
        "requests": -91185501,
        "spam_report_drops": 18212049,
        "spam_reports": -57900771,
        "unique_clicks": -64936291,
        "unique_opens": 71210689,
        "unsubscribes": -13533268
      }
    },
    {
      "ab_phase": "send",
      "ab_variation": "9bec8dfe-48aa-6c8f-756d-e793f9c88193",
      "aggregation": "sed",
      "id": "920d3732-6bd9-4803-3f77-1c04b1790e60",
      "stats": {
        "bounce_drops": 268261,
        "bounces": -22892736,
        "clicks": -85541965,
        "delivered": -36778209,
        "invalid_emails": -90452903,
        "opens": 33049881,
        "requests": -71310840,
        "spam_report_drops": 58078749,
        "spam_reports": -62439874,
        "unique_clicks": -64728407,
        "unique_opens": 93363045,
        "unsubscribes": 21985728
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "b8c9b19e-c468-1caf-845a-7c0baeb53390",
      "aggregation": "dolore",
      "id": "045cdb4c-227a-4550-fa99-989ace27be4b",
      "stats": {
        "bounce_drops": 71657697,
        "bounces": -70819644,
        "clicks": -77383355,
        "delivered": -73044346,
        "invalid_emails": -83687302,
        "opens": 56482363,
        "requests": 30503857,
        "spam_report_drops": 58868090,
        "spam_reports": -97953381,
        "unique_clicks": 66551712,
        "unique_opens": 73084022,
        "unsubscribes": 28178637
      }
    }
  ]
}
{
  "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_id"]
step_ids["f79077e4-4f8e-fb5b-7bdf-ed97e0d3e227"]
page_size52
page_tokenea in tempor irure
Request Payload
Response Payload
{
  "_metadata": {
    "count": -62672924.24839011,
    "next": "https://bwZCbBCJae.feajHHIO",
    "prev": "https://rpsdVmFb.qsagc5WLSAbBi7ufz.vIp5cfZ4zxdte7Ccqz",
    "self": "https://UlqsWRxaohfIpIECubOlKnbuBy.jkpmNjLsPF9ETdQ,ajewmsbfNHKLMznOqGJTQ8SAg,XHrJoTyMmT+"
  },
  "results": [
    {
      "clicks": 85933604,
      "step_id": "f14a811f-dc08-c1cb-d595-f42337e0102e",
      "url": "https://mnDkIhtfwdT.pcydkrvMO1I,SjIJkJTtKBAP-j5ZrVFPkT",
      "url_location": 59732572
    },
    {
      "clicks": 16605092,
      "step_id": "dc2fa593-cee1-102e-6bfb-12e4f23160b9",
      "url": "https://ZRRczWjsajDWSXVfnVYanYIgoTARVEOed.fjrkFLL-faXljCkpJj,8c",
      "url_location": 73995291
    },
    {
      "clicks": 75061963,
      "step_id": "3f2d7c45-9d7a-49c3-9893-6d79229cbb01",
      "url": "http://IyhEFXuV.dmmwvDung9OZIFVHSYhVTGN4w",
      "url_location": 56554742
    },
    {
      "clicks": 25303781,
      "step_id": "70c61e4e-9fc9-0434-2766-3181eddf62d6",
      "url": "https://eTFytQIJBA.ewRYIJb,0ew0nHpnxOpFri1-ZtDwXK3",
      "url_location": 74965352
    },
    {
      "clicks": 6214217,
      "step_id": "d3028026-a8cd-e8dd-3d03-40e2dac70351",
      "url": "https://fxQfFfbVCIhxGLN.zdidtC8O,mcOhqwUWBVtu8IznD",
      "url_location": 14065031
    }
  ],
  "total_clicks": 83259225
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
page_size4
page_tokenest quis Duis
group_by["ab_variation"]
ab_variation_ide599a3e3-17c2-f37d-3542-1fb29626f1c8
ab_phase_idsend
Request Payload
Response Payload
{
  "_metadata": {
    "count": -71313512.00441664,
    "next": "https://eVBeN.lyoeeY8v-cEhTgeArr9lvej9zP0YccWYO",
    "prev": "https://BvctrATKcoLZD.qmW8VAV,nTpqOKM85zqLjHcLTbVyKseOLx1a",
    "self": "http://dGNkP.abgcO0g8jVKZQLGuPMe66+eM"
  },
  "results": [
    {
      "ab_phase": "test",
      "ab_variation": "f1c53e2c-0f3f-4a26-a2b1-d37eb900e1aa",
      "clicks": 14549852,
      "url": "https://OQUNYMBwYMnfZx.kdryHPh1OwUAWweVKj4s",
      "url_location": 48153378
    },
    {
      "ab_phase": "send",
      "ab_variation": "bbafbb74-82ba-89d1-12da-2fdaa6fbcc45",
      "clicks": 71802401,
      "url": "http://saOVblwTTLdXDFVkLaoCRaRblEoHymO.xmcVkuCeraSmbRTxkGOXAK0aiji4RqD8xZGzYF,kkeCXAJyuQPmI4l-Wsq0dDO2uJ9E,iWHJmFj.oQLBFEvrf",
      "url_location": 5992383
    },
    {
      "ab_phase": "test",
      "ab_variation": "2f20d524-e432-7016-5809-74e2f039f246",
      "clicks": 29195766,
      "url": "http://rWAjeOySYuY.ufrWGkbg,MdlHxffEA8vGFlBy,8nFF5NnBtGbMUIVQfBr.JgApHwycutzIj0N",
      "url_location": 67942240
    },
    {
      "ab_phase": "send",
      "ab_variation": "93c8d645-6d44-f6eb-1f08-9d0027915585",
      "clicks": 69380629,
      "url": "http://hkZqDS.mjM7UsclvwWyMnKJHNZKZL7SOATAcPc280,94ZBCngiGz-w8",
      "url_location": 60462019
    },
    {
      "ab_phase": "test",
      "ab_variation": "a5c00a25-dec8-069a-0a68-0afedbfb2bd6",
      "clicks": 83955131,
      "url": "https://M.xcaUb23tQLTESijAXgrdQnvPEMuYN.dYOlVcT",
      "url_location": 2942742
    }
  ],
  "total_clicks": 57747359
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
Query Parameter NameExample
ids["do laborum dolore magna","ut culpa","aute ut pariatur dolor","elit","minim esse dolor qui","quis nostrud velit consectetur","culpa ut anim","enim sint","commodo laborum Lorem voluptate","fugiat Excepteur nulla"]
timezoneoccaecat reprehenderit ut deserunt
Request Payload
Response Payload
minim Ut voluptate deserunt
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
ids["reprehenderit veniam qui","laboris dolore mollit veniam","ipsum ut","esse commodo incididunt veniam ea","et","ut exercitation Excepteur minim ut","enim sit cillum ut dolore","labore aliquip ipsum amet qui","sed esse","eu ut ipsum"]
timezonequi adipisicing irure
Request Payload
Response Payload
elit aliquip
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Sender Identities API(6 operations)

Header NameExample
on-behalf-of"nisi ut amet mollit in"
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"do laboris in"
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"aute"
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"proident nostrud sed"
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"ipsum consequat adipisicing proident cupidatat"
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"anim commodo"
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"commodo amet dolore sint"
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"veniam"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1,
      "name": "the jones",
      "recipient_count": 1
    }
  ]
}
Header NameExample
on-behalf-of"esse adipisicing"
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_id99777754
Header NameExample
on-behalf-of"labore mollit aliqua aute"
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*-64994645
Header NameExample
on-behalf-of"pariatur ut"
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"sint id"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "delete_contacts",
      "message": "delete_contacts not a bool"
    },
    {
      "field": "list_id",
      "message": "Returned if list_id is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "List not found: 5"
    }
  ]
}
Query Parameter NameExample
page-14757986
page_size-5953600
list_id*26533740
Header NameExample
on-behalf-of"deserunt aliquip incididunt"
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"Ut"
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"Ut ex ipsum sit amet"
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*-84293177
recipient_id*-7551148
Header NameExample
on-behalf-of"Duis ut"
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"consectetur ea anim"
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"laborum"
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"nostrud cillum sit"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
{}
{
  "errors": [
    {
      "message": "No recipient ids provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
page8707852
page_size21765690
Header NameExample
on-behalf-of"Ut cupidatat adipisicing dolor dolore"
Request Payload
Response Payload
{
  "recipients": []
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"sed ullamco"
Request Payload
Response Payload
{
  "status": [
    {
      "id": "worker_delay",
      "value": "delayed"
    },
    {
      "id": "worker_delay_seconds",
      "value": "75.0"
    }
  ]
}
Header NameExample
on-behalf-of"esse do"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": -9587866.74581793,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "hXeVDAi3@gQIMZUfjVRmqLODsjF.meu",
      "first_name": "mollit elit in sint",
      "id": "sunt do Duis ex",
      "last_clicked": null,
      "last_emailed": 72098904.7679443,
      "last_name": "exercitation",
      "last_opened": null,
      "updated_at": -66588369.1118827
    },
    {
      "created_at": 2751614.3307695836,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "DJPxWE8q5n@GSMckLfJeAaFocThuRMAeoQXHcUTqgG.si",
      "first_name": "exercitation in dolor",
      "id": "qui sunt eiusmod pariatur veniam",
      "last_clicked": 93621348.44475523,
      "last_emailed": null,
      "last_name": "Duis ipsum ullamco et commodo",
      "last_opened": -1874216.594624117,
      "updated_at": -33269594.242119104
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"laboris eiusmod esse"
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"Excepteur consequat et eiusmod enim"
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"tempor in voluptate reprehenderit"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"laborum dolore ad"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
{field_name}consectetur amet ea
Header NameExample
on-behalf-of"adipisicing"
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"dolor sint"
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"ipsum"
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"dolore qui"
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"ad voluptate fugiat pariatur quis"
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"dolore ex culpa sint nisi"
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"consectetur velit aute do ut"
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"reprehenderit dolor adipisicing proident magna"
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*95786856
Header NameExample
on-behalf-of"laboris"
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_idcommodo
Header NameExample
on-behalf-of"ullamco ipsum"
Request Payload
{
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ]
}
Response Payload
{
  "id": 5,
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ],
  "recipient_count": 1
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "segment_id": "segment_id",
      "message": "segment id is not valid"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
delete_contactstrue
Header NameExample
on-behalf-of"qui laboris cupidatat"
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-23998598
page_size24096851
Header NameExample
on-behalf-of"laboris dolore ut officia"
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-71827698
categoryoccaecat ex in
offset78239798
Header NameExample
on-behalf-of"aliqua ipsum esse Excepteur"
Request Payload
Response Payload
[
  {
    "category": "category 1"
  },
  {
    "category": "category 2"
  }
]
{
  "errors": [
    {
      "field": "sort_by",
      "message": "invalid sort value"
    }
  ]
}
Query Parameter NameExample
sort_by_metriccupidatat id
sort_by_directionasc
start_date*laboris culpa irure cillum nulla
end_datenulla
limit35782297
offset-32033330
aggregated_byweek
Header NameExample
on-behalf-of"culpa"
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*velit aliqua
end_dateoccaecat et pariatur
categories*ut quis sint proident Excepteur
limit-74913342
offset-87455576
aggregated_byweek
Header NameExample
on-behalf-of"in sed id ex nostrud"
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"id aute eiusmod qui"
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
limit14359570
offset-58034429
Header NameExample
on-behalf-of"ullamco"
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"dolore dolore elit"
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"sint Ut veniam laboris velit"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"qui Lorem dolor anim aute"
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"et aliqua qui non aliquip"
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"dolore in mollit et commodo"
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"irure culpa quis ipsum sint"
Request Payload
{
  "send_at": 1489451436
}
Response Payload
{
  "id": 23914405,
  "send_at": 14189498,
  "status": "voluptate"
}
{
  "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"do"
Request Payload
Response Payload
{
  "send_at": 1490778528
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"cupidatat incididunt Ut tempor"
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"incididunt adipisicing nisi laboris ut"
Request Payload
{
  "to": "your.email@example.com"
}
Response Payload
{
  "to": "minim ut officia laboris in"
}
{
  "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"fugiat irure"
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*52.4682212207877
page_tokenaliqua
Header NameExample
on-behalf-of"ad magna"
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": [
    {
      "": "mollit dolore aliquip",
      "error_id": "nostrud",
      "message": "est sed consectetur"
    }
  ]
}
Header NameExample
on-behalf-of"deserunt"
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"consequat dolor ea velit"
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"enim fugiat sit in"
Request Payload
{
  "name": "new_example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "new_example_name",
  "versions": []
}
Header NameExample
on-behalf-of"ipsum eu"
Request Payload
Response Payload
{}

Transactional Templates Versions(5 operations)

Header NameExample
on-behalf-of"voluptate est pariatur"
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"sunt esse officia in"
Request Payload
Response Payload
{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
  "active": 1,
  "name": "example_version_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "generate_plain_content": true,
  "subject": "<%subject%>",
  "updated_at": "2019-03-13 18:56:33",
  "editor": "code"
}
Header NameExample
on-behalf-of"adipisicing commodo consequat"
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"ut in Lorem voluptate sed"
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"irure eiusmod ea dolor"
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"in"
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"irure dolor Lorem"
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"pariatur mollit sed irure"
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": "tempor nisi magna ea culpa"
    },
    {
      "message": "incididunt do ea cillum"
    },
    {
      "message": "aliquip reprehenderit amet officia"
    },
    {
      "message": "in eiusmod esse"
    },
    {
      "message": "est voluptate ex incididunt velit"
    }
  ]
}
Query Parameter NameExample
limitaliqua
offsetDuis sed enim ipsum in
aggregated_bymonth
start_date*cillum dolore proident
end_dateid
Header NameExample
on-behalf-of"voluptate"
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"velit sed"
Request Payload
Response Payload
{
  "public_key": "anim quis in sint"
}
Header NameExample
on-behalf-of"ut"
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"eu id ad esse quis"
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"nulla est labore sint laboris"
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": "labore Ut"
    },
    {
      "message": "nostrud dolor adipisicing"
    },
    {
      "message": "irure laborum consectetur"
    },
    {
      "message": "eiusmod ipsum in id"
    },
    {
      "message": "ea Excepteur consequat cupidatat dolor"
    }
  ]
}
Header NameExample
on-behalf-of"sed pariatur"
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": "veniam"
    }
  ]
}
Header NameExample
on-behalf-of"eiusmod"
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": "Ut Lorem eiusmod veniam et"
    },
    {
      "message": "officia labore"
    },
    {
      "message": "sint dolor ullamco"
    }
  ]
}
Header NameExample
on-behalf-of"cupidatat proident dolor amet"
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": "tempor dolor Lorem et in"
    },
    {
      "message": "dolore dolor"
    },
    {
      "message": "in"
    },
    {
      "message": "quis sed"
    },
    {
      "message": "elit ullamco do commodo aliqua"
    }
  ]
}

Query(2 operations)

Query Parameter NameExample
query*ullamco occaecat consequat cillum
limit4.584007523988005
Header NameExample
X-Query-Id"cupidatat laborum exercitation"
X-Cursor"ullamco magna in labore"
Authorization*"reprehenderit sit eiusmod"
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*"reprehenderit exercitation aliqua dolore"
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
queryveniam velit
Header NameExample
Authorization*"amet do non"
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*"aliqua nulla deserunt"
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"laborum Duis eu"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "open",
      "title": "Open Tracking",
      "description": "lorem ipsum... .",
      "enabled": true
    }
  ]
}
Header NameExample
on-behalf-of"consectetur dolore"
Request Payload
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"aliquip do"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"fugiat sunt Lorem esse commodo"
Request Payload
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"nulla"
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"sint dolor"
Request Payload
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"deserunt"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"enim Ut"
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"ipsum ea consequat amet"
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-51633227
offset87351468
aggregated_byday
start_date*minim mollit ex sit Duis
end_datecupidatat laborum in
Header NameExample
on-behalf-of"dolor ullamco eu"
Request Payload
Response Payload
[
  {
    "date": "2015-11-03",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
countryUS
limit94971085
offset-61717798
aggregated_byday
start_date*in cupidatat eu officia voluptate
end_dateconsectetur sed pariatur dolor culpa
Header NameExample
on-behalf-of"ea in minim deserunt"
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
limit35972219
offset-84786150
aggregated_byday
start_date*tempor eiusmod aliquip
end_dateet
Header NameExample
on-behalf-of"quis ad incididunt in"
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*est mollit laboris dolore
end_dateoccaecat aliquip ut Excepteur
aggregated_byday
Header NameExample
on-behalf-of"sit"
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*irure
end_dateest ea anim
aggregated_byweek
Header NameExample
on-behalf-of"do fugiat"
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_providersin enim
limit-26041976
offset70146008
aggregated_bymonth
start_date*amet
end_datevelit sit
Header NameExample
on-behalf-of"aliqua ipsum laboris"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 1,
          "drops": 0,
          "opens": 1,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 1
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 2,
          "drops": 0,
          "opens": 2,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 2
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
browserslaborum adipisicing tempor dolor enim
limit62293100
offset-79380994
aggregated_bymonth
start_date*dolore aliqua
end_dateesse
Header NameExample
on-behalf-of"ut voluptate nisi quis"
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-17908164
end_time37505939
Header NameExample
Accept*"dolore"
on-behalf-of"ipsum"
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"est dolor dolor Ut cillum"
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"commodo tempor"
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*bFvG@xFfu.js
Header NameExample
on-behalf-of"dolore sint irure voluptate est"
Request Payload
Error generating example
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Blocks API(4 operations)

Query Parameter NameExample
start_time44354496
end_time46979296
limit-45047444
offset33314450
Header NameExample
on-behalf-of"dolore"
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"ipsum dolor"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"fugiat voluptate"
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"cillum dolor aute sint fugiat"
Request Payload
Response Payload
{}

Spam Reports API(4 operations)

Query Parameter NameExample
start_time85216891
end_time-85367277
limit79284170
offset-66454796
Header NameExample
on-behalf-of"tempor"
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"nostrud deserunt est consequat in"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"ipsum occaecat"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "ip": "10.89.32.5"
  }
]
Header NameExample
on-behalf-of"amet ut"
Request Payload
Response Payload
{}

Suppressions - Global Suppressions(4 operations)

Header NameExample
on-behalf-of"quis ex veniam ut id"
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-71942155
end_time58296710
limit-8230767
offset30022171
Header NameExample
on-behalf-of"anim aute id"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com"
  }
]
Header NameExample
on-behalf-of"laboris sunt aliquip"
Request Payload
Response Payload
{
  "recipient_email": "test@example.com"
}
Header NameExample
on-behalf-of"cupidatat dolore Ut ut irure"
Request Payload
Response Payload
{}

Suppressions - Unsubscribe Groups(5 operations)

Header NameExample
on-behalf-of"id"
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-73533087
Header NameExample
on-behalf-of"ad"
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"velit Lorem"
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"amet ex Excepteur nulla ut"
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"magna dolor"
Request Payload
Response Payload
{}

Suppressions - Suppressions(6 operations)

Header NameExample
on-behalf-of"consectetur tempor minim Lorem"
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"qui ipsum laborum dolore Ut"
Request Payload
Response Payload
[
  "example@example.com",
  "example2@example.com"
]
Header NameExample
on-behalf-of"esse"
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"ullamco aliqua incididunt ipsum magna"
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"in"
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"elit ut"
Request Payload
Response Payload
Error generating example

Invalid Emails API(4 operations)

Query Parameter NameExample
start_time-89416401
end_time-37527062
limit19628307
offset80094175
Header NameExample
on-behalf-of"ut ad et ut"
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"sint exercitation dolore"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"magna nulla id nisi ad"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]
Header NameExample
on-behalf-of"laboris"
Request Payload
Response Payload
{}
Service Homepage: sendgrid.com/en-us
API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started
emails