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.
Mail Send
POST
{
"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
}
}
}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": "dolore"
},
{
"message": "dolor Excepteur nostrud tempor"
},
{
"message": "dolor eiusmod"
}
]
}Cancel Scheduled Sends(7 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "ut aliqua sit sed est" |
{
"batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi"
}{
"errors": [
{
"field": "eiusmod ut occaecat",
"help": {},
"message": "nostrud aute ex Excepteur"
}
],
"id": "nisi"
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "do in in"
},
{
"message": "officia eiusmod"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "deserunt" |
{
"batch_id": "YOUR_BATCH_ID",
"status": "pause"
}{
"batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi",
"status": "pause"
}{
"errors": [
{
"field": "Excepteur dolor est labore aute",
"help": {},
"message": "non tempor eiusmod"
},
{
"field": "ad pariatur",
"help": {},
"message": "et cillum laborum"
},
{
"field": "veniam mollit ad",
"help": {},
"message": "sed"
},
{
"field": "sit id",
"help": {},
"message": "Ut occaecat adipisicing non"
},
{
"field": "dolore",
"help": {},
"message": "dolor Excepteur irure"
}
],
"id": "eiusmod fugiat aliqua Lorem culpa"
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "adipisicing anim non"
},
{
"message": "ut amet"
},
{
"message": "Lorem"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "in cillum aliqua" |
[
{
"batch_id": "QzZmYzLTVWIwYgYzJlM2NhNWI",
"status": "cancel"
},
{
"batch_id": "mQzZmYzLTVlM2NhNWIwYgYzJl",
"status": "cancel"
}
]{
"errors": [
{
"field": "est eu nostrud",
"help": {},
"message": "nisi voluptate amet Ut"
},
{
"field": "sint occaecat eu aliqua anim",
"help": {},
"message": "tempor"
},
{
"field": "consequat do dolore ex non",
"help": {},
"message": "fugiat occaecat"
}
],
"id": "voluptate pariatur Excepteur consequat laborum"
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "dolore"
},
{
"message": "Excepteur et consequat"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "elit ad laborum" |
{
"batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi"
}{
"errors": [
{
"field": "ad laboris enim",
"help": {},
"message": "in laborum nulla"
},
{
"field": "non aute ex consequat ut",
"help": {},
"message": "eu ullamco Excepteur est voluptate"
},
{
"field": "sit anim commodo",
"help": {},
"message": "nulla ipsum"
}
],
"id": "velit sed culpa 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": "cupidatat irure fugiat nisi"
},
{
"message": "dolore in"
},
{
"message": "in"
},
{
"message": "veniam sit consectetur"
},
{
"message": "in deserunt dolor elit Duis"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "dolor" |
[
{
"batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi",
"status": "cancel"
},
{
"batch_id": "IbLdyLYULb7Rj8GKSx7u025ouWVlAiMg",
"status": "pause"
}
]{
"errors": [
{
"field": "nostrud pariatur officia ut Lorem",
"help": {},
"message": "dolor commodo"
}
],
"id": "Excepteur"
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "est enim dolore quis commodo"
},
{
"message": "adipisicing in"
},
{
"message": "amet occaecat"
},
{
"message": "amet Excepteur"
},
{
"message": "irure aliqua elit do"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "amet laborum" |
{
"status": "pause"
}Error generating example{
"errors": [
{
"field": "Duis sit culpa ullamco amet",
"help": {},
"message": "adipisicing qui"
},
{
"field": "exercitation in non",
"help": {},
"message": "in labore tempor nisi mollit"
},
{
"field": "occaecat dolor et proident",
"help": {},
"message": "non"
},
{
"field": "Ut",
"help": {},
"message": "in commodo incididunt pariatur magna"
}
],
"id": "officia"
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "tempor"
},
{
"message": "laborum incididunt"
},
{
"message": "non"
},
{
"message": "nisi"
},
{
"message": "enim dolore fugiat"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "qui nostrud voluptate exercitation" |
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"field": "cupidatat velit incididunt aute",
"help": {},
"message": "nulla dolore sed"
},
{
"field": "in",
"help": {},
"message": "qui reprehenderit exercitation enim"
},
{
"field": "ea cupidatat",
"help": {},
"message": "mollit nisi consectetur fugiat"
},
{
"field": "adipisicing commodo",
"help": {},
"message": "ut"
}
],
"id": "Lorem"
}{
"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": "sed proident elit laboris"
},
{
"message": "dolore esse sit eiusmod"
}
]
}API Keys(6 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "nostrud qui occaecat laboris" |
{
"name": "My API Key",
"scopes": [
"mail.send",
"alerts.create",
"alerts.read"
]
}{
"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": "aliqua dolore"
},
{
"message": "do enim aliqua elit cillum"
},
{
"message": "dolore sit ipsum Lorem culpa"
},
{
"message": "ut"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
limit | 33011873 |
| Header Name | Example |
|---|---|
on-behalf-of | "fugiat" |
{
"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": "dolor quis"
},
{
"message": "incididunt id in cillum in"
},
{
"message": "adipisicing anim"
},
{
"message": "voluptate cillum pariatur"
},
{
"message": "aute aliquip veniam in"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "eiusmod sit" |
{
"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": "dolor qui laborum"
},
{
"message": "Lorem"
},
{
"message": "in dolore fugiat est"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "commodo aliquip" |
{
"name": "A New Hope"
}{
"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": "eiusmod ullamco velit Excepteur in"
},
{
"message": "in officia"
},
{
"message": "proident"
},
{
"message": "irure incididunt sit aliqua"
},
{
"message": "dolor eiusmod Ut eu"
}
]
}PUT
| Header Name | Example |
|---|---|
on-behalf-of | "reprehenderit ex voluptate tempor" |
{
"name": "Profiles key",
"scopes": [
"user.profile.read",
"user.profile.update"
]
}{
"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": "dolore reprehenderit ut velit labore"
},
{
"message": "voluptate consectetur"
},
{
"message": "in laborum"
},
{
"message": "dolor nisi laborum anim veniam"
},
{
"message": "ut"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "velit ea incididunt" |
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": "nostrud occaecat"
}
]
}API Key Permissions
GET
| Header Name | Example |
|---|---|
on-behalf-of | "adipisicing commodo ut deserunt" |
{
"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": "aute laborum Lorem culpa"
}
]
}Settings - Enforced TLS(2 operations)
GET
| Header Name | Example |
|---|---|
on-behalf-of | "Lorem aliqua" |
{
"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": "consequat pariatur"
},
{
"message": "in Duis qui in velit"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "ut est et dolor pariatur" |
{
"require_tls": true,
"require_valid_cert": true
}{
"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": "esse proident ad adipisicing"
},
{
"message": "labore"
},
{
"message": "ut velit in ipsum commodo"
},
{
"message": "eiusmod nisi"
}
]
}IP Access Management(6 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "id elit Ut" |
{
"ips": [
{
"ip": "192.168.1.1"
},
{
"ip": "192.*.*.*"
},
{
"ip": "192.168.1.3/32"
}
]
}{
"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": "Duis quis cupidatat"
},
{
"message": "ex id Duis ad"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "sit nulla" |
{
"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": "sit"
},
{
"message": "cillum consequat dolore"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "Lorem officia sit dolor anim" |
{
"ids": [
1,
2,
3
]
}{}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "reprehenderit aute irure"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
limit | -27670940 |
| Header Name | Example |
|---|---|
on-behalf-of | "et Excepteur eu Lorem" |
{
"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": "cupidatat sint fugiat aliquip"
},
{
"message": "dolor velit tempor exercitation"
},
{
"message": "elit aliquip"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "laborum cupidatat in" |
{
"id": 1,
"ip": "192.168.1.1",
"created_at": 1441824715,
"updated_at": 1441824715
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "labore est non ullamco laboris" |
{}Certificates(5 operations)
POST
{
"public_certificate": "<your x509 certificate>",
"enabled": false,
"integration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}{
"public_certificate": "<your x509 certificate>",
"id": 66138975,
"not_before": 1621289880,
"not_after": 1621289880,
"intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}[
{
"error_id": "sunt Duis",
"field": "non",
"message": "esse dolore eiusmod"
},
{
"error_id": "magna consectetur ex minim voluptate",
"field": null,
"message": "pariatur veniam et tempor"
},
{
"error_id": "aliquip officia sunt",
"field": null,
"message": "ut exercitation sint"
}
][
{
"error_id": "esse laborum reprehenderit",
"field": null,
"message": "voluptate elit aute dolore"
},
{
"error_id": "fugiat anim quis",
"field": "elit in cupidatat culpa",
"message": "fugiat in"
}
][
{
"error_id": "eu minim do proident",
"field": "ad ea consequat in tempor",
"message": "culpa esse adipisicing"
},
{
"error_id": "velit voluptate",
"field": null,
"message": "cupidatat aute culpa mollit irure"
},
{
"error_id": "ipsum fugiat dolor tempor",
"field": null,
"message": "voluptate Ut in"
},
{
"error_id": "nulla cillum",
"field": "ullamco",
"message": "eu"
},
{
"error_id": "Ut laboris nostrud ad Excepteur",
"field": null,
"message": "cupidatat"
}
][
{
"error_id": "ea est sit dolore",
"field": null,
"message": "ullamco aliquip incididunt"
}
][
{
"error_id": "pariatur id sit enim",
"field": "ut sit commodo",
"message": "sit ad Excepteur"
},
{
"error_id": "velit minim consequat veniam aliqua",
"field": null,
"message": "in et fugiat est aliquip"
},
{
"error_id": "Ut eu Excepteur",
"field": null,
"message": "exercitation"
}
]GET
[
{
"public_certificate": "<your x509 certificate>",
"id": 66138975,
"not_before": 1621289880,
"not_after": 1621289880,
"intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}
][
{
"error_id": "ea Duis do",
"field": "est",
"message": "nulla Ut"
},
{
"error_id": "voluptate ea labore",
"field": null,
"message": "qui incididunt veniam Ut in"
},
{
"error_id": "ut pariatur veniam",
"field": null,
"message": "laboris pariatur"
}
][
{
"error_id": "cupidatat dolor",
"field": "eu exercitation aliqua",
"message": "officia sint in"
},
{
"error_id": "consectetur proident aliquip enim ullamco",
"field": "sed in pariatur mollit ut",
"message": "reprehenderit"
}
][
{
"error_id": "Ut nostrud ipsum reprehenderit enim",
"field": null,
"message": "ad laboris"
},
{
"error_id": "eu occaecat et cupidatat id",
"field": null,
"message": "in ad"
},
{
"error_id": "reprehenderit amet occaecat nisi Excepteur",
"field": "commodo",
"message": "proident sunt"
},
{
"error_id": "proident incididunt ut nostrud",
"field": "ut laboris incididunt proident in",
"message": "eu"
}
][
{
"error_id": "irure tempor id enim do",
"field": "sed",
"message": "voluptate do"
}
][
{
"error_id": "non adipisicing Excepteur",
"field": null,
"message": "occaecat commodo sint laborum pariatur"
},
{
"error_id": "incididunt anim enim",
"field": "cillum",
"message": "in aute ipsum"
},
{
"error_id": "sit dolor nulla fugiat",
"field": "veniam",
"message": "laborum elit irure amet"
}
]GET
{
"public_certificate": "<your x509 certificate>",
"id": 66138975,
"not_before": 1621289880,
"not_after": 1621289880,
"intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}[
{
"error_id": "aliquip sed mollit consectetur",
"field": null,
"message": "eu voluptate labore incididunt ad"
},
{
"error_id": "quis voluptate esse",
"field": "ea cillum",
"message": "consectetur do elit"
},
{
"error_id": "anim commodo",
"field": "consectetur sunt pariatur eiusmod non",
"message": "sint quis Lorem officia"
},
{
"error_id": "cillum Duis nisi ullamco",
"field": "velit ullamco cillum",
"message": "anim"
}
][
{
"error_id": "commodo sunt voluptate",
"field": null,
"message": "anim velit reprehenderit amet adipisicing"
},
{
"error_id": "commodo consequat ut",
"field": "eu officia magna aliqua",
"message": "et enim eu nulla"
},
{
"error_id": "nulla id laborum est minim",
"field": null,
"message": "dolore id culpa aliquip officia"
},
{
"error_id": "irure aliquip qui",
"field": null,
"message": "eu"
}
][
{
"error_id": "ut sint",
"field": null,
"message": "ipsum deserunt et"
},
{
"error_id": "voluptate id anim",
"field": "voluptate officia tempor in",
"message": "sint"
},
{
"error_id": "laborum cupidatat dolor",
"field": "fugiat eiusmod exercitation magna",
"message": "non do aute deserunt occaecat"
}
][
{
"error_id": "et deserunt irure enim minim",
"field": null,
"message": "culpa eiusmod"
},
{
"error_id": "pariatur esse minim",
"field": "sunt",
"message": "sed voluptate nulla"
},
{
"error_id": "Lorem amet cupidatat enim",
"field": null,
"message": "anim et mollit"
}
][
{
"error_id": "adipisicing deserunt et laboris voluptate",
"field": null,
"message": "adipisicing ut consequat cupidatat mollit"
}
]PATCH
{
"public_certificate": "<your x509 certificate>",
"enabled": false,
"intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}[
{
"error_id": "Excepteur laboris",
"field": "elit aliqua sint eu ad",
"message": "veniam"
},
{
"error_id": "esse",
"field": null,
"message": "aute consequat culpa ipsum"
},
{
"error_id": "aliquip in ad culpa nostrud",
"field": null,
"message": "laboris anim"
}
][
{
"error_id": "ut qui sunt dolor do",
"field": "minim",
"message": "dolor do quis"
},
{
"error_id": "ullamco anim",
"field": null,
"message": "anim laborum sint reprehenderit"
},
{
"error_id": "ipsum esse Lorem laboris",
"field": "dolor",
"message": "dolore laboris tempor velit"
},
{
"error_id": "ut consequat laborum et",
"field": null,
"message": "et Duis"
}
][
{
"error_id": "amet",
"field": "nisi cillum Duis",
"message": "et"
}
][
{
"error_id": "Duis amet dolor dolor",
"field": "amet reprehenderit id consectetur ut",
"message": "elit nostrud exercitation enim est"
},
{
"error_id": "in",
"field": "cupidatat",
"message": "reprehenderit ea"
},
{
"error_id": "Excepteur adipisicing",
"field": "sunt ipsum occaecat Ut exercitation",
"message": "dolor"
}
][
{
"error_id": "ut pariatur est",
"field": "id quis voluptate aliquip officia",
"message": "amet cupidatat ea qui reprehenderit"
}
]DELETE
{
"public_certificate": "<your x509 certificate>",
"id": 66138975,
"not_before": 1621289880,
"not_after": 1621289880,
"intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}[
{
"error_id": "culpa eu deserunt esse dolore",
"field": "incididunt est",
"message": "in"
}
][
{
"error_id": "aliquip anim consequat culpa",
"field": null,
"message": "sint consectetur elit ad sit"
},
{
"error_id": "qui Ut reprehenderit",
"field": "sunt aute amet",
"message": "incididunt enim Duis dolor cillum"
},
{
"error_id": "magna laborum",
"field": null,
"message": "sed elit irure"
},
{
"error_id": "mollit ea sed in nisi",
"field": "non culpa deserunt",
"message": "et commodo eu"
}
][
{
"error_id": "et consequat dolore esse",
"field": null,
"message": "ad tempor aliquip"
},
{
"error_id": "labore incididunt fugiat in",
"field": "eiusmod Duis mollit pariatur elit",
"message": "aliquip"
},
{
"error_id": "dolore aute officia consequat velit",
"field": "sed cillum ea eu id",
"message": "non sit"
},
{
"error_id": "sed aute Duis non nostrud",
"field": null,
"message": "aliquip"
}
][
{
"error_id": "sed deserunt anim",
"field": "laborum commodo enim adipisicing ad",
"message": "consectetur aliquip"
},
{
"error_id": "culpa",
"field": null,
"message": "commodo adipisicing et"
},
{
"error_id": "laborum reprehenderit",
"field": "exercitation Excepteur",
"message": "aliquip ea"
}
][
{
"error_id": "in",
"field": "aliquip officia commodo",
"message": "aliqua"
}
]Single Sign-On Settings(5 operations)
POST
{
"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"
}{
"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 Lorem et reprehenderit qui",
"field": null,
"message": "velit in magna ullamco"
},
{
"error_id": "pariatur minim laborum",
"field": "Duis est adipisicing",
"message": "do sint sit"
}
][
{
"error_id": "nulla velit culpa anim",
"field": "dolor",
"message": "irure enim ipsum pariatur est"
},
{
"error_id": "sed enim incididunt",
"field": "laboris",
"message": "sunt non sed"
}
][
{
"error_id": "sunt",
"field": "nisi amet sint",
"message": "eu sunt in tempor dolore"
}
][
{
"error_id": "sed in ipsum quis",
"field": null,
"message": "cupidatat amet ad magna tempor"
},
{
"error_id": "officia ipsum exercitation sed do",
"field": null,
"message": "in proident sunt ea nisi"
},
{
"error_id": "consectetur ullamco",
"field": null,
"message": "nostrud elit eu aliquip"
}
][
{
"error_id": "dolore elit aliqua do ut",
"field": "qui ea consequat ut",
"message": "esse"
}
]GET
| Query Parameter Name | Example |
|---|---|
si | true |
[
{
"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": "Duis consectetur Excepteur exercitation sunt",
"field": "commodo do veniam",
"message": "dolor et velit ex nisi"
},
{
"error_id": "adipisicing",
"field": null,
"message": "aliquip veniam velit"
},
{
"error_id": "culpa",
"field": "laboris dolore pariatur laborum",
"message": "id sit occaecat"
},
{
"error_id": "ex Excepteur officia consequat",
"field": "magna eu Ut culpa",
"message": "enim est sunt cupidatat Ut"
}
][
{
"error_id": "aliqua elit",
"field": "proident ut quis fugiat minim",
"message": "anim"
},
{
"error_id": "enim",
"field": "ea",
"message": "ipsum"
},
{
"error_id": "eu dolor id irure",
"field": "officia",
"message": "aliquip eu magna tempor veniam"
}
][
{
"error_id": "aute sed labore ut pariatur",
"field": "Ut",
"message": "voluptate in"
},
{
"error_id": "dolor ut Excepteur",
"field": null,
"message": "aliqua tempor in sint culpa"
},
{
"error_id": "consectetur mollit nostrud sit",
"field": null,
"message": "aliqua eu amet aute"
},
{
"error_id": "ipsum in est",
"field": "in occaecat eiusmod magna",
"message": "fugiat aliqua aliquip in eu"
}
][
{
"error_id": "enim minim",
"field": "dolore nulla",
"message": "eiusmod est enim"
},
{
"error_id": "mollit sunt officia in cupidatat",
"field": null,
"message": "Lorem"
},
{
"error_id": "in magna",
"field": null,
"message": "aliquip reprehenderit adipisicing elit dolor"
},
{
"error_id": "amet eiusmod labore nulla sit",
"field": "dolore nulla anim",
"message": "enim Ut nostrud"
}
][
{
"error_id": "ea est",
"field": "anim cupidatat amet",
"message": "exercitation Ut sunt aliquip veniam"
},
{
"error_id": "laborum",
"field": "ipsum dolor",
"message": "et adipisicing aliquip"
},
{
"error_id": "aliquip eu",
"field": null,
"message": "labore laborum non"
},
{
"error_id": "esse ut veniam",
"field": null,
"message": "anim"
}
]GET
| Query Parameter Name | Example |
|---|---|
si | false |
{
"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": "amet",
"field": null,
"message": "occaecat Excepteur aliqua minim"
},
{
"error_id": "consequat ut ullamco veniam labore",
"field": "in",
"message": "esse"
},
{
"error_id": "dolor quis mollit Lorem",
"field": null,
"message": "occaecat consectetur"
},
{
"error_id": "voluptate do ex qui",
"field": "Ut sit labore",
"message": "Lorem nulla exercitation"
}
][
{
"error_id": "enim do nisi",
"field": "veniam eiusmod sed",
"message": "dolor sunt"
},
{
"error_id": "incididunt fugiat nostrud minim cillum",
"field": null,
"message": "consectetur aliquip ea laboris"
},
{
"error_id": "et",
"field": null,
"message": "quis Ut"
},
{
"error_id": "exercitation consectetur Duis occaecat",
"field": "qui mollit",
"message": "incididunt ut Lorem velit sit"
}
][
{
"error_id": "exercitation",
"field": null,
"message": "sint"
},
{
"error_id": "cupidatat exercitation esse eu",
"field": null,
"message": "commodo laboris minim irure"
},
{
"error_id": "cillum",
"field": null,
"message": "esse"
}
][
{
"error_id": "non",
"field": "aliqua voluptate",
"message": "in aute adipisicing"
},
{
"error_id": "do",
"field": "ad dolor reprehenderit",
"message": "incididunt veniam consequat"
}
][
{
"error_id": "consequat adipisicing laborum elit proident",
"field": "in culpa voluptate Duis",
"message": "ex nostrud laboris velit adipisicing"
},
{
"error_id": "labore quis",
"field": "eiusmod nisi incididunt commodo",
"message": "ea consequat Ut irure"
},
{
"error_id": "ad magna",
"field": "elit sunt ullamco",
"message": "proident velit sit commodo"
}
]PATCH
| Query Parameter Name | Example |
|---|---|
si | false |
{
"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
}{
"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": "in incididunt dolore",
"field": "pariatur minim reprehenderit ea mollit",
"message": "ad sed"
},
{
"error_id": "dolor occaecat",
"field": null,
"message": "anim labore in nisi"
},
{
"error_id": "officia",
"field": "commodo",
"message": "veniam irure pariatur culpa ut"
},
{
"error_id": "deserunt ad et cupidatat Duis",
"field": null,
"message": "et sed proident cupidatat irure"
},
{
"error_id": "Ut",
"field": "aliquip non eiusmod",
"message": "dolor voluptate veniam consequat irure"
}
][
{
"error_id": "deserunt",
"field": null,
"message": "Duis deserunt sunt laboris nisi"
},
{
"error_id": "est consequat",
"field": null,
"message": "dolor"
},
{
"error_id": "id cupidatat in eu",
"field": "dolore culpa sunt",
"message": "eiusmod pariatur dolor"
},
{
"error_id": "culpa in do ut laboris",
"field": "dolore laboris aliqua laborum eiusmod",
"message": "deserunt"
},
{
"error_id": "in",
"field": null,
"message": "ea in"
}
][
{
"error_id": "id",
"field": null,
"message": "ad in dolore consequat"
}
][
{
"error_id": "nostrud",
"field": "non",
"message": "consequat occaecat ea"
}
][
{
"error_id": "amet non",
"field": null,
"message": "anim deserunt elit ut laboris"
},
{
"error_id": "aliquip",
"field": null,
"message": "sed"
},
{
"error_id": "minim officia",
"field": "pariatur",
"message": "ad"
},
{
"error_id": "ea",
"field": "dolore culpa",
"message": "est voluptate sit"
}
]DELETE
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.[
{
"error_id": "aliqua nisi dolore",
"field": "cupidatat eu ut",
"message": "sint nulla elit"
},
{
"error_id": "sed",
"field": null,
"message": "culpa aute officia"
},
{
"error_id": "dolor sed ipsum ad",
"field": null,
"message": "dolore tempor reprehenderit"
},
{
"error_id": "adipisicing ullamco do aliqua",
"field": null,
"message": "dolor occaecat elit tempor sit"
},
{
"error_id": "consectetur qui sit",
"field": null,
"message": "sed ut nulla dolore laboris"
}
][
{
"error_id": "eiusmod reprehenderit et in in",
"field": null,
"message": "quis enim est in"
},
{
"error_id": "sint quis adipisicing in",
"field": null,
"message": "ipsum exercitation proident nostrud"
},
{
"error_id": "velit aute amet tempor dolore",
"field": "eu voluptate sed",
"message": "enim"
},
{
"error_id": "esse",
"field": null,
"message": "culpa"
}
][
{
"error_id": "elit amet officia ut",
"field": null,
"message": "dolor eiusmod in"
}
][
{
"error_id": "quis",
"field": "mollit ex enim cupidatat",
"message": "ea ipsum"
}
][
{
"error_id": "aute in",
"field": null,
"message": "proident officia mollit do"
},
{
"error_id": "deserunt minim ut",
"field": null,
"message": "amet ipsum"
}
]Single Sign-On Teammates(2 operations)
POST
{
"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"
]
}{
"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": "deserunt amet sed",
"field": null,
"message": "qui reprehenderit"
}
][
{
"error_id": "officia consequat reprehenderit",
"field": "laboris veniam",
"message": "eu eiusmod"
}
][
{
"error_id": "consequat velit ex fugiat",
"field": "ex ullamco",
"message": "pariatur incididunt sit"
},
{
"error_id": "ut",
"field": null,
"message": "cillum exercitation dolore"
},
{
"error_id": "dolor",
"field": null,
"message": "ut occaecat do sunt reprehenderit"
},
{
"error_id": "Ut sint ut enim",
"field": "amet minim",
"message": "dolor nostrud"
},
{
"error_id": "ea amet consequat cillum ipsum",
"field": "aute ut esse exercitation ex",
"message": "ullamco adipisicing nulla"
}
][
{
"error_id": "ad in adipisicing",
"field": null,
"message": "minim culpa"
},
{
"error_id": "ut",
"field": "ullamco est Lorem",
"message": "do est"
},
{
"error_id": "velit Ut pariatur",
"field": "Lorem et ad",
"message": "in"
}
][
{
"error_id": "nisi sit in",
"field": null,
"message": "fugiat et aliqua nostrud Duis"
},
{
"error_id": "qui exercitation",
"field": null,
"message": "aliqua anim fugiat"
},
{
"error_id": "pariatur anim laboris amet",
"field": null,
"message": "magna"
},
{
"error_id": "sed nostrud enim ad in",
"field": "sit in",
"message": "sunt anim ipsum"
},
{
"error_id": "in id adipisicing irure tempor",
"field": null,
"message": "do cupidatat"
}
]PATCH
{
"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
}{
"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": "eu ex",
"field": null,
"message": "commodo adipisicing nulla id sunt"
},
{
"error_id": "occaecat do laborum ipsum exercitation",
"field": "ipsum deserunt fugiat sunt",
"message": "ipsum occaecat deserunt sit"
},
{
"error_id": "esse sint aute",
"field": "aute",
"message": "commodo velit pariatur dolor"
},
{
"error_id": "consectetur laborum aliqua",
"field": "ullamco",
"message": "exercitation ea enim"
}
][
{
"error_id": "tempor adipisicing",
"field": "quis",
"message": "exercitation in velit"
},
{
"error_id": "amet laborum consectetur aliqua",
"field": null,
"message": "cillum incididunt magna nostrud consequat"
}
][
{
"error_id": "sunt enim id incididunt ut",
"field": "Duis dolor",
"message": "in"
},
{
"error_id": "qui esse laboris amet",
"field": null,
"message": "dolore"
},
{
"error_id": "reprehenderit ea esse dolor",
"field": "laboris dolor labore",
"message": "deserunt culpa"
},
{
"error_id": "Ut et quis",
"field": null,
"message": "tempor occaecat ut"
}
][
{
"error_id": "ea id",
"field": null,
"message": "irure"
},
{
"error_id": "velit labore sed esse dolore",
"field": null,
"message": "sint irure eu nisi ut"
}
][
{
"error_id": "aliquip officia elit reprehenderit non",
"field": "consequat qui",
"message": "mollit"
},
{
"error_id": "consequat consectetur fugiat dolore veniam",
"field": null,
"message": "ad ex anim ipsum consectetur"
},
{
"error_id": "eiusmod pariatur veniam esse",
"field": null,
"message": "in"
}
]Settings - Mail(13 operations)
GET
| Query Parameter Name | Example |
|---|---|
limit | 21429030 |
offset | -52093111 |
| Header Name | Example |
|---|---|
on-behalf-of | "eu laborum deserunt occaecat" |
{
"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": "labore",
"field": "cillum laboris adipisicing",
"message": "Duis in",
"parameter": "officia"
},
{
"error_id": "amet fugiat",
"field": "eiusmod",
"message": "dolor cillum quis officia",
"parameter": "est Excepteur labore consectetur"
},
{
"error_id": "ea cupidatat ipsum",
"field": "Excepteur minim ea Duis",
"message": "dolor incididunt",
"parameter": "laborum consectetur nisi"
},
{
"error_id": "dolor sunt velit aute ipsum",
"field": null,
"message": "Excepteur laboris dolore adipisicing",
"parameter": "commodo eiusmod Ut"
}
]
}{
"errors": [
{
"error_id": "enim amet Duis et eiusmod",
"field": "Ut ullamco ex sed anim",
"message": "ut adipisicing mollit commodo ut",
"parameter": "exercitation est labore veniam irure"
},
{
"error_id": "ea sint cupidatat in in",
"field": null,
"message": "dolor sed",
"parameter": "cillum consectetur occaecat Ut"
}
]
}{
"errors": [
{
"error_id": "nisi voluptate labore Ut deserunt",
"field": "dolore",
"message": "sint Lorem nostrud",
"parameter": "labore sunt cillum reprehenderit laboris"
},
{
"error_id": "fugiat id",
"field": null,
"message": "laborum sit id do ea",
"parameter": "est"
},
{
"error_id": "deserunt dolore ullamco nulla",
"field": "est ad occaecat elit",
"message": "ut exercitation in",
"parameter": "reprehenderit"
},
{
"error_id": "cupidatat anim laborum quis eiusmod",
"field": "fugiat non exercitation",
"message": "aliqua Lorem veniam",
"parameter": "officia deserunt ex proident enim"
}
]
}{
"errors": [
{
"error_id": "dolore Lorem sed et nulla",
"field": null,
"message": "consectetur Ut",
"parameter": "Lorem"
},
{
"error_id": "reprehenderit Excepteur aliqua",
"field": null,
"message": "qui aliquip quis",
"parameter": "ipsum nisi enim occaecat"
},
{
"error_id": "enim",
"field": "cillum Duis dolore aliquip",
"message": "Ut voluptate aliqua id",
"parameter": "magna Ut"
},
{
"error_id": "culpa in enim ea ad",
"field": null,
"message": "ullamco irure quis",
"parameter": "sint quis nulla fugiat id"
}
]
}{
"errors": [
{
"error_id": "proident ex velit Lorem",
"field": null,
"message": "sint",
"parameter": "ea"
},
{
"error_id": "culpa velit",
"field": null,
"message": "anim",
"parameter": "quis est velit id"
},
{
"error_id": "id fugiat cillum in",
"field": "aliqua",
"message": "consequat nisi ex dolore non",
"parameter": "fugiat ut sunt Ut officia"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "irure tempor Excepteur pariatur" |
{
"enabled": true,
"list": [
"email1@example.com",
"example.com"
]
}{
"enabled": true,
"list": [
"email1@example.com"
]
}{
"errors": [
{
"error_id": "irure",
"field": "velit do",
"message": "eiusmod deserunt Lorem",
"parameter": "commodo do esse aliquip"
}
]
}{
"errors": [
{
"error_id": "esse ullamco",
"field": null,
"message": "dolore officia sunt dolor",
"parameter": "officia cupidatat veniam ipsum"
},
{
"error_id": "ullamco cupidatat sint aliquip",
"field": "voluptate labore",
"message": "laborum laboris dolore aliqua",
"parameter": "velit cillum cupidatat sit sed"
}
]
}{
"errors": [
{
"error_id": "ullamco id nostrud",
"field": "consequat aliquip eu",
"message": "in fugiat",
"parameter": "dolore ut in enim sit"
}
]
}{
"errors": [
{
"error_id": "ullamco",
"field": "exercitation pariatur proident",
"message": "ex proident",
"parameter": "non anim dolor id reprehenderit"
},
{
"error_id": "reprehenderit",
"field": "tempor occaecat",
"message": "ut eu",
"parameter": "laboris ullamco non ipsum"
},
{
"error_id": "aute eu labore est",
"field": "ea esse aliquip ullamco",
"message": "ullamco ad",
"parameter": "voluptate dolor nostrud enim eu"
},
{
"error_id": "aliquip cupidatat sed",
"field": null,
"message": "sunt qui dolore",
"parameter": "ullamco cupidatat"
},
{
"error_id": "dolor nisi esse incididunt",
"field": "dolor fugiat incididunt in laborum",
"message": "ad",
"parameter": "deserunt"
}
]
}{
"errors": [
{
"error_id": "mollit ullamco",
"field": null,
"message": "nostrud",
"parameter": "culpa aute"
},
{
"error_id": "in dolor",
"field": null,
"message": "irure dolor nisi",
"parameter": "velit exercitation elit mollit"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "sint occaecat" |
{
"enabled": true,
"list": [
"example.com",
"jane_doe@example1.com"
]
}{
"errors": [
{
"error_id": "Excepteur officia",
"field": "ut dolor ex fugiat",
"message": "enim consequat fugiat do",
"parameter": "Lorem"
}
]
}{
"errors": [
{
"error_id": "adipisicing Ut ut",
"field": "fugiat nisi",
"message": "esse",
"parameter": "sit"
},
{
"error_id": "Duis",
"field": "est Duis fugiat eu magna",
"message": "eu",
"parameter": "dolore tempor"
},
{
"error_id": "Excepteur",
"field": null,
"message": "velit",
"parameter": "quis proident nulla"
},
{
"error_id": "dolor quis proident ea reprehenderit",
"field": null,
"message": "ipsum enim",
"parameter": "labore dolore"
}
]
}{
"errors": [
{
"error_id": "anim commodo sint elit",
"field": null,
"message": "eiusmod",
"parameter": "Lorem nostrud nisi non ut"
},
{
"error_id": "officia fugiat eu",
"field": "officia dolore non in eiusmod",
"message": "nostrud minim Lorem",
"parameter": "ut proident"
},
{
"error_id": "in id",
"field": "ex officia",
"message": "culpa commodo",
"parameter": "aliqua"
},
{
"error_id": "esse",
"field": null,
"message": "ipsum dolor in",
"parameter": "dolor"
},
{
"error_id": "adipisicing eu",
"field": null,
"message": "enim eu nisi eiusmod",
"parameter": "deserunt"
}
]
}{
"errors": [
{
"error_id": "labore officia",
"field": null,
"message": "non sit do proident velit",
"parameter": "et eiusmod magna"
},
{
"error_id": "laboris ipsum",
"field": null,
"message": "veniam",
"parameter": "Excepteur"
},
{
"error_id": "dolore cupidatat consequat",
"field": "in",
"message": "ut mollit tempor aute",
"parameter": "pariatur"
},
{
"error_id": "voluptate non",
"field": "occaecat dolore cillum dolor sunt",
"message": "magna",
"parameter": "laboris reprehenderit enim deserunt velit"
},
{
"error_id": "dolor in",
"field": "aliquip",
"message": "aute nulla nisi cillum",
"parameter": "ut"
}
]
}{
"errors": [
{
"error_id": "amet",
"field": null,
"message": "Excepteur",
"parameter": "officia"
},
{
"error_id": "dolore",
"field": null,
"message": "sit et",
"parameter": "sunt"
},
{
"error_id": "commodo sint proident nisi",
"field": null,
"message": "sunt",
"parameter": "consequat tempor Ut"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "cupidatat enim" |
{
"enabled": true,
"html_content": "<p><a href=\"http://example.com\" target=\"_blank\">Ahoy, World!</a></p>\n",
"plain_content": ""
}{
"enabled": true,
"html_content": "<p><a href=\"http://example.com\" target=\"_blank\">Ahoy, World!</a></p>\n",
"plain_content": ""
}{
"errors": [
{
"error_id": "qui",
"field": null,
"message": "ullamco non velit adipisicing sunt",
"parameter": "qui"
}
]
}{
"errors": [
{
"error_id": "aliquip",
"field": null,
"message": "culpa",
"parameter": "in laborum eiusmod sunt"
},
{
"error_id": "ipsum id Lorem",
"field": "eu",
"message": "pariatur",
"parameter": "esse aliquip sint Ut"
}
]
}{
"errors": [
{
"error_id": "tempor",
"field": "dolor",
"message": "nisi pariatur",
"parameter": "est aliqua in dolor ut"
},
{
"error_id": "ut occaecat deserunt in",
"field": null,
"message": "ex nulla elit commodo consectetur",
"parameter": "dolor ullamco dolore cupidatat"
},
{
"error_id": "voluptate Excepteur",
"field": null,
"message": "eu elit nulla culpa",
"parameter": "et"
},
{
"error_id": "sed id",
"field": null,
"message": "ad ut eiusmod mollit",
"parameter": "sit adipisicing eiusmod velit commodo"
}
]
}{
"errors": [
{
"error_id": "Duis officia laboris dolor reprehenderit",
"field": "aliqua amet ipsum mollit",
"message": "aute officia consectetur non dolor",
"parameter": "sint Lorem"
},
{
"error_id": "reprehenderit sit eiusmod",
"field": "ad aute ut",
"message": "qui sed",
"parameter": "mollit laboris"
},
{
"error_id": "nisi enim nostrud consectetur",
"field": "proident sunt nulla adipisicing",
"message": "est",
"parameter": "veniam mollit in"
},
{
"error_id": "sint Duis eiusmod adipisicing dolor",
"field": "non laboris",
"message": "ipsum Lorem nostrud dolor laborum",
"parameter": "labore"
}
]
}{
"errors": [
{
"error_id": "consequat in occaecat",
"field": "labore anim proident nostrud",
"message": "culpa dolore laborum",
"parameter": "ut in"
},
{
"error_id": "Ut",
"field": "aliqua",
"message": "sit proident sint ad elit",
"parameter": "id"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "aute cupidatat deserunt" |
{
"enabled": true,
"html_content": "<p><a href=\"http://example.com\" target=\"_blank\">Ahoy, World!</a></p>\n",
"plain_content": ""
}{
"errors": [
{
"error_id": "ex in",
"field": null,
"message": "consectetur nulla labore id esse",
"parameter": "officia exercitation elit"
},
{
"error_id": "esse nostrud consequat proident laborum",
"field": null,
"message": "consequat culpa ad",
"parameter": "dolore amet dolore aute"
}
]
}{
"errors": [
{
"error_id": "ea labore",
"field": "cupidatat dolore",
"message": "veniam aliqua Lorem occaecat labore",
"parameter": "exercitation consequat velit"
},
{
"error_id": "sed in anim nulla exercitation",
"field": null,
"message": "Ut dolore mollit sit ut",
"parameter": "nisi"
},
{
"error_id": "ex sed ullamco",
"field": null,
"message": "magna dolor adipisicing laboris",
"parameter": "ex esse minim mollit"
},
{
"error_id": "Lorem incididunt",
"field": "in occaecat",
"message": "eu Ut esse deserunt commodo",
"parameter": "ut enim"
},
{
"error_id": "fugiat aute",
"field": "in",
"message": "ex laborum culpa id",
"parameter": "ea"
}
]
}{
"errors": [
{
"error_id": "reprehenderit proident",
"field": null,
"message": "cillum culpa",
"parameter": "fugiat nostrud laboris proident"
}
]
}{
"errors": [
{
"error_id": "proident",
"field": null,
"message": "do exercitation consectetur",
"parameter": "enim amet voluptate"
},
{
"error_id": "laboris eiusmod aliqua proident consectetur",
"field": "in Lorem Ut Duis",
"message": "occaecat in ad veniam",
"parameter": "laboris ad"
},
{
"error_id": "ea",
"field": null,
"message": "laborum quis nisi aute",
"parameter": "qui fugiat veniam adipisicing"
},
{
"error_id": "in",
"field": "deserunt",
"message": "commodo ut",
"parameter": "nisi ut laboris"
},
{
"error_id": "Excepteur commodo",
"field": null,
"message": "officia ipsum esse dolor minim",
"parameter": "Excepteur sint"
}
]
}{
"errors": [
{
"error_id": "do ut Excepteur",
"field": "in pariatur",
"message": "elit anim",
"parameter": "dolore minim cillum"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "in in sunt reprehenderit mollit" |
{
"email": "abuse@example.com",
"enabled": true
}{
"email": "abuse@example.com",
"enabled": true
}{
"errors": [
{
"error_id": "esse",
"field": null,
"message": "ullamco laborum Lorem eiusmod enim",
"parameter": "ea in exercitation reprehenderit"
},
{
"error_id": "ipsum",
"field": "esse sed deserunt consequat do",
"message": "est ullamco Ut",
"parameter": "eu esse sint"
},
{
"error_id": "et cupidatat",
"field": null,
"message": "pariatur deserunt",
"parameter": "aute"
},
{
"error_id": "anim amet aliquip labore",
"field": null,
"message": "est non",
"parameter": "Ut sint ea"
}
]
}{
"errors": [
{
"error_id": "dolore tempor",
"field": "aliqua cillum",
"message": "sed",
"parameter": "adipisicing esse nostrud proident deserunt"
},
{
"error_id": "Lorem",
"field": null,
"message": "Excepteur ut tempor",
"parameter": "minim pariatur qui voluptate"
},
{
"error_id": "adipisicing qui laborum",
"field": "esse sed dolore consequat proident",
"message": "fugiat",
"parameter": "sit"
}
]
}{
"errors": [
{
"error_id": "culpa",
"field": "proident in",
"message": "sed Ut et ipsum incididunt",
"parameter": "velit Duis fugiat"
},
{
"error_id": "amet eu veniam",
"field": "anim",
"message": "consequat officia nisi",
"parameter": "officia"
},
{
"error_id": "dolor do magna",
"field": "minim deserunt et Excepteur",
"message": "pariatur occaecat elit laborum",
"parameter": "occaecat in Lorem"
},
{
"error_id": "laborum",
"field": null,
"message": "voluptate officia reprehenderit commodo veniam",
"parameter": "Duis"
}
]
}{
"errors": [
{
"error_id": "aliquip anim",
"field": "Ut ut non dolore adipisicing",
"message": "nulla nostrud adipisicing fugiat",
"parameter": "ad"
},
{
"error_id": "consectetur mollit id ut",
"field": "sit sed labore",
"message": "dolor non nisi",
"parameter": "cupidatat voluptate dolore eu"
}
]
}{
"errors": [
{
"error_id": "Ut dolore ut",
"field": "occaecat deserunt",
"message": "mollit sit Ut esse",
"parameter": "eu eiusmod Duis ea tempor"
},
{
"error_id": "Lorem id sit cupidatat",
"field": "est dolor anim in",
"message": "Duis consequat do Excepteur elit",
"parameter": "ad veniam non"
},
{
"error_id": "incididunt consectetur officia enim",
"field": null,
"message": "Lorem deserunt",
"parameter": "occaecat nulla culpa"
},
{
"error_id": "mollit proident in non culpa",
"field": null,
"message": "nisi in",
"parameter": "reprehenderit incididunt nisi"
},
{
"error_id": "enim",
"field": "deserunt sed nulla ullamco ipsum",
"message": "id velit nisi commodo culpa",
"parameter": "nulla irure quis"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "Lorem dolor magna officia ex" |
{
"email": "abuse@example.com",
"enabled": true
}{
"errors": [
{
"error_id": "nostrud in",
"field": "voluptate Duis nisi",
"message": "eu",
"parameter": "laborum aute"
},
{
"error_id": "reprehenderit dolor",
"field": null,
"message": "dolore velit nulla in Excepteur",
"parameter": "eiusmod anim do"
},
{
"error_id": "laboris enim",
"field": "pariatur aliquip et ad sunt",
"message": "pariatur proident officia nisi in",
"parameter": "aliquip quis Duis"
},
{
"error_id": "incididunt nisi",
"field": null,
"message": "Duis",
"parameter": "in dolore aute nulla elit"
}
]
}{
"errors": [
{
"error_id": "sed Ut",
"field": null,
"message": "occaecat veniam non ullamco",
"parameter": "eu"
},
{
"error_id": "nisi",
"field": "mollit officia voluptate dolor",
"message": "Lorem et do cillum",
"parameter": "enim"
},
{
"error_id": "est elit pariatur",
"field": "ullamco",
"message": "enim ut pariatur",
"parameter": "labore eu nisi pariatur do"
},
{
"error_id": "anim ex est tempor",
"field": "do qui ad ut tempor",
"message": "non",
"parameter": "nulla labore do in"
}
]
}{
"errors": [
{
"error_id": "fugiat",
"field": null,
"message": "laboris",
"parameter": "pariatur sint nisi in"
},
{
"error_id": "proident",
"field": "sed Lorem",
"message": "pariatur id magna consectetur veniam",
"parameter": "proident do quis consequat dolor"
}
]
}{
"errors": [
{
"error_id": "esse sed ut",
"field": "laborum officia ullamco in",
"message": "in",
"parameter": "incididunt Duis culpa ipsum in"
},
{
"error_id": "dolor",
"field": "velit et in ipsum dolor",
"message": "cupidatat incididunt laborum sit velit",
"parameter": "deserunt Lorem"
},
{
"error_id": "occaecat qui exercitation",
"field": "est fugiat aliqua qui sunt",
"message": "incididunt reprehenderit Ut ut ad",
"parameter": "ut"
}
]
}{
"errors": [
{
"error_id": "irure incididunt mollit ex ea",
"field": "in pariatur ut laborum",
"message": "elit occaecat adipisicing Lorem in",
"parameter": "nostrud laborum deserunt"
},
{
"error_id": "proident culpa labore in nulla",
"field": null,
"message": "eu",
"parameter": "in incididunt consectetur"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "consectetur anim nisi aute enim" |
{
"enabled": true,
"html_content": "<% body %>"
}{
"enabled": false,
"html_content": "<p><% body %>Example</p>\n"
}{
"errors": [
{
"error_id": "culpa nisi occaecat eiusmod",
"field": null,
"message": "ea dolor minim",
"parameter": "veniam Excepteur amet consequat nisi"
},
{
"error_id": "reprehenderit",
"field": null,
"message": "non fugiat sed nisi officia",
"parameter": "ea irure in ad"
}
]
}{
"errors": [
{
"error_id": "ipsum tempor exercitation",
"field": null,
"message": "velit Duis aliquip ullamco",
"parameter": "do ipsum quis ex reprehenderit"
}
]
}{
"errors": [
{
"error_id": "Ut Lorem",
"field": null,
"message": "in",
"parameter": "dolor laboris Lorem"
},
{
"error_id": "qui",
"field": null,
"message": "magna velit aliqua nulla reprehenderit",
"parameter": "mollit esse in et"
},
{
"error_id": "veniam non",
"field": "veniam ea",
"message": "enim sint",
"parameter": "dolore exercitation sit"
}
]
}{
"errors": [
{
"error_id": "proident Ut fugiat in",
"field": null,
"message": "magna",
"parameter": "non qui consequat"
},
{
"error_id": "Excepteur veniam ad",
"field": "Duis ipsum quis dolor veniam",
"message": "culpa",
"parameter": "ea occaecat"
}
]
}{
"errors": [
{
"error_id": "adipisicing Lorem nisi sint ipsum",
"field": null,
"message": "ut voluptate ad Ut eiusmod",
"parameter": "officia dolor deserunt"
},
{
"error_id": "enim fugiat minim consequat",
"field": "amet proident",
"message": "nisi pariatur ipsum cupidatat",
"parameter": "consequat quis qui laboris Ut"
},
{
"error_id": "nostrud",
"field": null,
"message": "laborum est Excepteur",
"parameter": "ut in"
},
{
"error_id": "incididunt laborum Ut anim",
"field": null,
"message": "do ea ut sint elit",
"parameter": "ullamco laboris"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "incididunt reprehenderit ex" |
{
"enabled": false,
"html_content": "<p><% body %>Example</p>\n"
}{
"errors": [
{
"error_id": "labore non enim sunt",
"field": null,
"message": "reprehenderit pariatur quis qui",
"parameter": "ea proident velit enim commodo"
},
{
"error_id": "ex quis",
"field": "consequat ad",
"message": "anim",
"parameter": "magna"
},
{
"error_id": "fugiat laboris ullamco",
"field": null,
"message": "ut sit nostrud magna",
"parameter": "Duis ullamco"
}
]
}{
"errors": [
{
"error_id": "minim dolore ut",
"field": null,
"message": "sunt laboris exercitation deserunt",
"parameter": "est ex nisi minim et"
},
{
"error_id": "Lorem dolore amet ad eu",
"field": "qui id",
"message": "laborum",
"parameter": "adipisicing sed dolor et officia"
},
{
"error_id": "irure",
"field": null,
"message": "do eu aliquip sint consequat",
"parameter": "dolor quis irure consequat"
},
{
"error_id": "elit ut pariatur sint Ut",
"field": "exercitation sunt",
"message": "dolore et adipisicing",
"parameter": "dolore est"
},
{
"error_id": "non ipsum id",
"field": null,
"message": "sed qui eiusmod reprehenderit",
"parameter": "voluptate ipsum"
}
]
}{
"errors": [
{
"error_id": "laborum aliqua pariatur anim ipsum",
"field": null,
"message": "nulla qui ut enim dolore",
"parameter": "nulla aliquip aliqua in"
},
{
"error_id": "id eu magna et voluptate",
"field": null,
"message": "Ut",
"parameter": "incididunt in qui"
},
{
"error_id": "elit dolor aliqua",
"field": "eu qui",
"message": "minim ut",
"parameter": "nulla irure sed occaecat"
},
{
"error_id": "eiusmod nostrud Excepteur qui pariatur",
"field": "proident minim Excepteur aliqua",
"message": "Excepteur",
"parameter": "sunt Ut pariatur"
}
]
}{
"errors": [
{
"error_id": "sed tempor",
"field": "nostrud",
"message": "eu minim enim ut",
"parameter": "labore reprehenderit"
}
]
}{
"errors": [
{
"error_id": "do Duis esse in in",
"field": null,
"message": "cillum minim",
"parameter": "aliquip dolore velit"
},
{
"error_id": "Ut velit dolore enim",
"field": "anim adipisicing occaecat esse sed",
"message": "eu non veniam",
"parameter": "qui exercitation dolor"
},
{
"error_id": "Ut",
"field": "elit",
"message": "nostrud nisi et incididunt amet",
"parameter": "id occaecat"
},
{
"error_id": "proident elit",
"field": "ut",
"message": "voluptate",
"parameter": "do nulla"
},
{
"error_id": "ea ut dolor laborum voluptate",
"field": "tempor adipisicing nisi enim incididunt",
"message": "culpa nisi consectetur nostrud anim",
"parameter": "Ut"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "ut sunt nulla" |
{
"enabled": true,
"hard_bounces": 5,
"soft_bounces": 5
}{
"enabled": false,
"hard_bounces": 5,
"soft_bounces": 5
}{
"errors": [
{
"error_id": "elit nulla ut adipisicing",
"field": null,
"message": "mollit",
"parameter": "in et"
},
{
"error_id": "in labore",
"field": "in enim",
"message": "ea sit nostrud",
"parameter": "laboris aliquip tempor mollit Lorem"
},
{
"error_id": "consequat deserunt",
"field": "aliquip",
"message": "dolore est aute",
"parameter": "sint aute"
},
{
"error_id": "mollit nostrud cillum voluptate ut",
"field": "anim",
"message": "dolore Excepteur sunt nulla magna",
"parameter": "eu Excepteur"
}
]
}{
"errors": [
{
"error_id": "quis",
"field": null,
"message": "dolor sit amet culpa",
"parameter": "aliqua magna exercitation"
},
{
"error_id": "voluptate incididunt",
"field": null,
"message": "eu ut in enim",
"parameter": "tempor consectetur"
},
{
"error_id": "et",
"field": "ipsum",
"message": "Excepteur ullamco Duis sint velit",
"parameter": "enim aliquip nisi consequat"
}
]
}{
"errors": [
{
"error_id": "pariatur amet labore eu aliqua",
"field": null,
"message": "ex irure esse dolore",
"parameter": "Duis esse velit"
}
]
}{
"errors": [
{
"error_id": "aute deserunt commodo dolor ut",
"field": null,
"message": "fugiat ea nisi et",
"parameter": "nulla reprehenderit"
},
{
"error_id": "ipsum",
"field": null,
"message": "Excepteur in sit fugiat aliquip",
"parameter": "proident consectetur ut"
},
{
"error_id": "tempor in ut Lorem cillum",
"field": null,
"message": "ad eu nostrud Excepteur",
"parameter": "ex"
},
{
"error_id": "mollit et Lorem",
"field": null,
"message": "ex culpa",
"parameter": "ut aliquip minim"
},
{
"error_id": "anim dolore",
"field": "irure magna cillum",
"message": "est consectetur",
"parameter": "nulla"
}
]
}{
"errors": [
{
"error_id": "amet sed aliqua in",
"field": null,
"message": "sint",
"parameter": "cupidatat"
},
{
"error_id": "do",
"field": "cupidatat ipsum magna Ut eu",
"message": "nostrud proident incididunt commodo",
"parameter": "officia cupidatat ad veniam"
},
{
"error_id": "Ut quis voluptate",
"field": "sit id Excepteur",
"message": "non",
"parameter": "nulla dolore"
},
{
"error_id": "tempor qui",
"field": null,
"message": "dolor eiusmod voluptate",
"parameter": "incididunt voluptate"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "velit" |
{
"enabled": false,
"soft_bounces": 5,
"hard_bounces": 5
}{
"errors": [
{
"error_id": "anim",
"field": null,
"message": "magna labore",
"parameter": "id enim dolore"
}
]
}{
"errors": [
{
"error_id": "velit aliqua Ut magna Duis",
"field": "officia aliquip occaecat consequat anim",
"message": "dolor",
"parameter": "Duis id"
},
{
"error_id": "occaecat",
"field": "officia aliqua",
"message": "culpa Duis ut irure commodo",
"parameter": "in magna ea sit"
},
{
"error_id": "Ut tempor officia irure reprehenderit",
"field": null,
"message": "ullamco",
"parameter": "laborum Lorem ut aute sed"
},
{
"error_id": "commodo",
"field": null,
"message": "magna culpa anim",
"parameter": "ad esse do ut"
}
]
}{
"errors": [
{
"error_id": "qui Lorem reprehenderit magna in",
"field": null,
"message": "labore Lorem mollit qui",
"parameter": "dolor aliquip mollit consectetur velit"
}
]
}{
"errors": [
{
"error_id": "sed esse aliquip",
"field": "Ut elit",
"message": "fugiat dolore ea",
"parameter": "aliqua nostrud Duis pariatur laboris"
},
{
"error_id": "nulla non sit ea",
"field": "ullamco Ut",
"message": "cillum fugiat ut aliqua",
"parameter": "sunt eiusmod sed"
}
]
}{
"errors": [
{
"error_id": "amet laboris",
"field": "esse fugiat sunt",
"message": "nulla et in reprehenderit",
"parameter": "minim aliqua Duis in laboris"
},
{
"error_id": "tempor aute",
"field": null,
"message": "tempor anim dolor sit dolore",
"parameter": "pariatur Ut sit deserunt ea"
},
{
"error_id": "eiusmod ex id Ut",
"field": "incididunt deserunt Lorem veniam id",
"message": "aliquip",
"parameter": "enim dolor"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "eu" |
{
"enabled": true,
"email": "bounces@example.com"
}{
"email": "bounces@example.com",
"enabled": true
}{
"errors": [
{
"error_id": "voluptate",
"field": null,
"message": "elit",
"parameter": "aliquip ullamco reprehenderit"
},
{
"error_id": "veniam deserunt in",
"field": null,
"message": "incididunt",
"parameter": "fugiat"
}
]
}{
"errors": [
{
"error_id": "aliquip qui ad in dolore",
"field": null,
"message": "id enim in velit",
"parameter": "veniam ut enim dolor cupidatat"
},
{
"error_id": "Excepteur",
"field": "eiusmod incididunt exercitation",
"message": "veniam",
"parameter": "et exercitation cillum nulla occaecat"
}
]
}{
"errors": [
{
"error_id": "eu dolor quis",
"field": "velit cillum",
"message": "dolore",
"parameter": "dolore enim in magna"
},
{
"error_id": "Duis",
"field": null,
"message": "ex cupidatat",
"parameter": "culpa ut non"
},
{
"error_id": "est tempor",
"field": null,
"message": "in consequat",
"parameter": "nostrud incididunt dolore"
}
]
}{
"errors": [
{
"error_id": "reprehenderit est dolor sed",
"field": null,
"message": "labore Excepteur nulla in ea",
"parameter": "amet"
},
{
"error_id": "esse adipisicing deserunt",
"field": null,
"message": "magna",
"parameter": "veniam eu"
},
{
"error_id": "fugiat esse sunt velit",
"field": "nulla dolore dolore nisi",
"message": "in officia",
"parameter": "in adipisicing commodo voluptate"
}
]
}{
"errors": [
{
"error_id": "elit",
"field": "cupidatat",
"message": "magna adipisicing",
"parameter": "ad"
},
{
"error_id": "laborum esse aute",
"field": "nostrud in",
"message": "dolor",
"parameter": "ad"
},
{
"error_id": "pariatur velit qui nisi esse",
"field": "consequat labore dolore consectetur ut",
"message": "irure officia",
"parameter": "irure"
},
{
"error_id": "proident",
"field": "magna consectetur quis fugiat eiusmod",
"message": "consequat laboris",
"parameter": "sed"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "enim" |
{
"enabled": true,
"email": "bounces@example.com"
}{
"errors": [
{
"error_id": "eiusmod fugiat anim voluptate et",
"field": null,
"message": "elit exercitation mollit Excepteur ipsum",
"parameter": "occaecat"
},
{
"error_id": "esse mollit enim",
"field": "aliquip proident esse voluptate",
"message": "pariatur",
"parameter": "et dolore dolor deserunt sint"
}
]
}{
"errors": [
{
"error_id": "officia sit laborum sed aliqua",
"field": null,
"message": "minim dolor",
"parameter": "laboris sed id fugiat officia"
},
{
"error_id": "in mollit in sint",
"field": "Lorem eu anim sit",
"message": "sed dolore velit",
"parameter": "amet irure"
}
]
}{
"errors": [
{
"error_id": "eu minim quis",
"field": null,
"message": "ipsum irure magna",
"parameter": "est quis"
},
{
"error_id": "tempor amet velit",
"field": null,
"message": "id in ut ad",
"parameter": "in in"
},
{
"error_id": "anim dolore eu et",
"field": "ipsum consectetur",
"message": "adipisicing in",
"parameter": "do dolore"
},
{
"error_id": "elit eiusmod nulla est aliqua",
"field": "est",
"message": "proident labore pariatur Lorem",
"parameter": "anim ullamco nostrud enim reprehenderit"
},
{
"error_id": "voluptate nostrud magna elit",
"field": "voluptate labore minim cupidatat officia",
"message": "est mollit",
"parameter": "amet culpa ut sed Excepteur"
}
]
}{
"errors": [
{
"error_id": "non ex",
"field": null,
"message": "ad pariatur id non",
"parameter": "aliquip Ut eu ut qui"
}
]
}{
"errors": [
{
"error_id": "cupidatat ut",
"field": null,
"message": "in ipsum consectetur",
"parameter": "ut dolore Ut in sint"
},
{
"error_id": "consectetur dolor eu ipsum id",
"field": "dolore",
"message": "Ut exercitation",
"parameter": "aliqua ex velit labore proident"
},
{
"error_id": "amet dolor",
"field": "eiusmod Lorem",
"message": "proident ex laboris",
"parameter": "reprehenderit pariatur dolore"
},
{
"error_id": "eiusmod",
"field": null,
"message": "dolore sint",
"parameter": "anim deserunt dolor voluptate"
},
{
"error_id": "sint",
"field": "quis dolor",
"message": "consectetur dolor qui reprehenderit nulla",
"parameter": "in"
}
]
}Settings - Partner(3 operations)
PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "laboris mollit incididunt" |
{
"license_key": "",
"enabled": true,
"enable_subuser_statistics": true
}{
"enable_subuser_statistics": true,
"enabled": true,
"license_key": ""
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "et" |
{
"enable_subuser_statistics": false,
"enabled": true,
"license_key": ""
}GET
| Query Parameter Name | Example |
|---|---|
limit | -55770236 |
offset | -45833220 |
| Header Name | Example |
|---|---|
on-behalf-of | "fugiat dolor" |
{
"result": [
{
"title": "Partner title",
"enabled": true,
"name": "partner_name",
"description": "A description of a partner."
}
]
}Teammates(11 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "elit incididunt Excepteur nostrud" |
{
"email": "teammate1@example.com",
"scopes": [
"user.profile.read",
"user.profile.update"
],
"is_admin": false
}{
"email": "teammate1@example.com",
"scopes": [
"user.profile.read",
"user.profile.update"
],
"is_admin": false
}{
"errors": [
{
"field": "sint velit veniam et",
"message": "ut veniam"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
limit | 40 |
offset | 51387904 |
| Header Name | Example |
|---|---|
on-behalf-of | "velit aute quis Excepteur" |
{
"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"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "quis qui irure ullamco sed" |
{
"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"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
limit | -34555442 |
offset | 42963865 |
[
{
"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"
}
]GET
| Header Name | Example |
|---|---|
on-behalf-of | "dolore esse" |
{
"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
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "in ipsum qui" |
{
"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"
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "irure et exercitation" |
{
"scopes": [
"user.profile.read",
"user.profile.edit"
],
"is_admin": false
}{
"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"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "dolore commodo sed mollit ipsum" |
{
"errors": [
{
"field": "aliquip voluptate",
"message": "voluptate nulla"
},
{
"field": "elit enim",
"message": "consectetur"
},
{
"field": "pariatur voluptate tempor",
"message": "dolor"
}
]
}{
"errors": [
{
"message": "username not found",
"field": "username"
}
]
}PATCH
{
"scope_group_name": "Stats"
}{}{
"errors": [
{
"field": "ad sit exercitation labore",
"message": "deserunt est Lorem tempor"
},
{
"field": "irure ad reprehenderit enim incididunt",
"message": "in"
},
{
"field": "nulla anim id ut",
"message": "cillum ex voluptate"
}
]
}DELETE
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"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "ut est Lorem velit" |
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"field": "officia voluptate sit laborum mollit",
"message": "et nulla tempor ut"
},
{
"field": "sit culpa",
"message": "aliquip et eu consequat ut"
},
{
"field": "eu nisi quis esse exercitation",
"message": "minim ullamco eiusmod adipisicing"
},
{
"field": "eu aute in ex",
"message": "cupidatat est dolor"
}
]
}Alerts(5 operations)
POST
| Header Name | Example |
|---|---|
Authorization | "dolor occaecat ullamco in mollit" |
on-behalf-of | "dolor anim qui officia" |
{
"type": "stats_notification",
"email_to": "example@example.com",
"frequency": "daily"
}{
"created_at": 1451520930,
"email_to": "test@example.com",
"frequency": "daily",
"id": 48,
"type": "stats_notification",
"updated_at": 1451520930
}{
"field": "laboris sed tempor quis",
"message": "nisi ex aute aliqua elit"
}GET
| Header Name | Example |
|---|---|
Authorization | "dolore" |
on-behalf-of | "fugiat dolor" |
[
{
"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
}
]GET
| Header Name | Example |
|---|---|
Authorization | "sed pariatur" |
on-behalf-of | "eu labore" |
{
"created_at": 1451520930,
"email_to": "example@example.com",
"frequency": "daily",
"id": 48,
"type": "stats_notification",
"updated_at": 1451520930
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "in proident dolore amet" |
{}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "consectetur veniam est non" |
{
"email_to": "example@example.com"
}{
"created_at": 1451520930,
"email_to": "example@example.com",
"frequency": "daily",
"id": 48,
"type": "stats_notification",
"updated_at": 1451522691
}Users API(9 operations)
GET
| Header Name | Example |
|---|---|
on-behalf-of | "eiusmod reprehenderit ex irure fugiat" |
{
"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"
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "ut exercitation" |
{
"first_name": "Example",
"last_name": "User",
"city": "Orange"
}{
"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"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "laborum" |
{
"reputation": 100,
"type": "paid"
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "labore ipsum quis cupidatat" |
{
"email": "test@example.com"
}PUT
| Header Name | Example |
|---|---|
on-behalf-of | "in nisi sint ullamco" |
{
"email": "example@example.com"
}{
"email": "example@example.com"
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "labore proident quis deserunt pariatur" |
{
"username": "test_username",
"user_id": 1
}PUT
| Header Name | Example |
|---|---|
on-behalf-of | "sint exercitation ea esse et" |
{
"username": "test_username"
}{
"username": "test_username"
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "ut mollit" |
{
"remain": 200,
"total": 200,
"overage": 0,
"used": 0,
"last_reset": "2013-01-01",
"next_reset": "2013-02-01",
"reset_frequency": "monthly"
}PUT
| Header Name | Example |
|---|---|
on-behalf-of | "Duis" |
{
"new_password": "new_password",
"old_password": "old_password"
}{}Subusers API(6 operations)
GET
| Query Parameter Name | Example |
|---|---|
username | laboris amet ad occaecat |
limit | 79469379 |
offset | -19033944 |
[
{
"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"
}
]
}POST
{
"username": "John@example.com",
"email": "John@example.com",
"password": "johns_password",
"ips": [
"1.1.1.1",
"2.2.2.2"
]
}{
"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"
}
]
}PATCH
{
"disabled": false
}{}{
"errors": [
{
"message": "invalid username"
},
{
"message": "no fields provided"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"message": "unable to enable user"
}
]
}DELETE
{}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
usernames | fugiat cillum dolore cupidatat |
[
{
"username": "example_subuser",
"reputation": 99
},
{
"username": "example_subuser2",
"reputation": 95.2
}
]PUT
[
"127.0.0.1"
]{
"ips": [
"127.0.0.1"
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}Subuser Monitor Settings(4 operations)
GET
{
"email": "example@example.com",
"frequency": 500
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"field": null,
"message": "No monitor settings for this user"
}
]
}POST
{
"email": "example@example.com",
"frequency": 50000
}{
"email": "example@example.com",
"frequency": 50000
}{
"errors": [
{
"field": null,
"message": "User already has a monitor"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}PUT
{
"email": "example@example.com",
"frequency": 50000
}{
"email": "example@example.com",
"frequency": 500
}{
"errors": [
{
"field": "email",
"message": "Email is required"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}DELETE
{}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"field": null,
"message": "No monitor settings for this user"
}
]
}Subuser Statistics(4 operations)
GET
| Query Parameter Name | Example |
|---|---|
date* | anim esse dolore |
sort_by_metric | id Lorem adipisicing cupidatat |
sort_by_direction | asc |
limit | -50898222 |
offset | 56737742 |
{
"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"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
date* | reprehenderit deserunt |
subuser | occaecat |
sort_by_metric | blocks |
sort_by_direction | asc |
limit | -3782927 |
offset | -75317109 |
{
"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"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
sort_by_direction | desc |
start_date* | consequat magna |
end_date | aute |
limit | -70902519 |
offset | -89547314 |
aggregated_by | ullamco |
sort_by_metric | dolore non sunt |
{
"date": "2015-10-11",
"stats": []
}GET
| Query Parameter Name | Example |
|---|---|
limit | -29019414 |
offset | 24533647 |
aggregated_by | week |
subusers* | ut |
start_date* | tempor |
end_date | aliquip Lorem Ut |
[
{
"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)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "tempor sed commodo irure" |
{
"domain": "example.com",
"subdomain": "mail",
"default": true
}{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "john@example.com",
"user_id": 7,
"default": false,
"valid": true,
"legacy": false,
"dns": {
"domain_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "sendgrid.net"
},
"owner_cname": {
"valid": true,
"type": "cname",
"host": "7.example.com",
"data": "sendgrid.net"
}
}
}GET
| Query Parameter Name | Example |
|---|---|
limit | -70012084 |
| Header Name | Example |
|---|---|
on-behalf-of | "mollit nisi dolor" |
[
{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "john@example.com",
"user_id": 7,
"default": true,
"valid": true,
"legacy": false,
"dns": {
"domain_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "sendgrid.net"
},
"owner_cname": {
"valid": true,
"type": "cname",
"host": "7.example.com",
"data": "sendgrid.net"
}
}
},
{
"id": 2,
"domain": "example2.com",
"subdomain": "news",
"username": "john@example.com",
"user_id": 8,
"default": false,
"valid": false,
"legacy": false,
"dns": {
"domain_cname": {
"valid": true,
"type": "cname",
"host": "news.example2.com",
"data": "sendgrid.net"
},
"owner_cname": {
"valid": false,
"type": "cname",
"host": "8.example2.com",
"data": "sendgrid.net"
}
}
}
]POST
| Header Name | Example |
|---|---|
on-behalf-of | "commodo Duis dolor" |
{
"id": 1,
"valid": true,
"validation_results": {
"domain_cname": {
"valid": false,
"reason": "Expected CNAME to match \"sendgrid.net.\" but found \"example.com.\"."
},
"owner_cname": {
"valid": true,
"reason": null
}
}
}{
"errors": [
{
"message": "internal error getting CNAME"
}
]
}POST
{
"username": "jane@example.com"
}{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "john@example.com",
"user_id": 7,
"default": false,
"valid": true,
"legacy": false,
"dns": {
"domain_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "sendgrid.net"
},
"owner_cname": {
"valid": true,
"type": "cname",
"host": "7.example.com",
"data": "sendgrid.net"
}
}
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "adipisicing amet fugiat" |
{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "john@example.com",
"user_id": 7,
"default": false,
"valid": true,
"legacy": false,
"dns": {
"domain_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "sendgrid.net"
},
"owner_cname": {
"valid": true,
"type": "cname",
"host": "7.example.com",
"data": "sendgrid.net"
}
}
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "sunt consequat" |
{
"default": true
}{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "john@example.com",
"user_id": 7,
"default": true,
"valid": true,
"legacy": false,
"dns": {
"domain_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "sendgrid.net"
},
"owner_cname": {
"valid": true,
"type": "cname",
"host": "7.example.com",
"data": "sendgrid.net"
}
}
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "adipisicing ea incididunt dolor" |
{}GET
| Query Parameter Name | Example |
|---|---|
domain | officia aliqua |
| Header Name | Example |
|---|---|
on-behalf-of | "nulla" |
{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "john@example.com",
"user_id": 7,
"default": false,
"valid": true,
"legacy": false,
"dns": {
"domain_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "sendgrid.net"
},
"owner_cname": {
"valid": true,
"type": "cname",
"host": "7.example.com",
"data": "sendgrid.net"
}
}
}GET
| Query Parameter Name | Example |
|---|---|
username* | consectetur nisi ut labore incididunt |
{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "john@example.com",
"user_id": 7,
"default": false,
"valid": true,
"legacy": false,
"dns": {
"domain_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "sendgrid.net"
},
"owner_cname": {
"valid": true,
"type": "cname",
"host": "7.example.com",
"data": "sendgrid.net"
}
}
}DELETE
| Query Parameter Name | Example |
|---|---|
username* | dolore in sed |
{}IP Warmup(4 operations)
POST
{
"ip": "0.0.0.0"
}[
{
"ip": "0.0.0.0",
"start_date": 1409616000
}
]{
"errors": [
{
"field": null,
"message": "resource not found"
}
]
}GET
[
{
"ip": "0.0.0.0",
"start_date": 1409616000
}
]GET
[
{
"ip": "0.0.0.0",
"start_date": 1409616000
}
]{
"errors": [
{
"field": null,
"message": "resource not found"
}
]
}DELETE
{}{
"errors": [
{
"field": null,
"message": "resource not found"
}
]
}Reverse DNS(5 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "anim" |
{
"ip": "192.168.1.1",
"subdomain": "email",
"domain": "example.com"
}{
"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"
}
}GET
| Query Parameter Name | Example |
|---|---|
limit | 19651530 |
offset | 49894071 |
ip | anim sunt cillum |
| Header Name | Example |
|---|---|
on-behalf-of | "Excepteur et sint voluptate" |
[
{
"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"
}
}
]POST
| Header Name | Example |
|---|---|
on-behalf-of | "culpa eiusmod do" |
{
"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"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "adipisicing id qui officia" |
{
"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"
}
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "consequat anim nulla occaecat" |
{}Email Address Validation
POST
{
"email": "example@example.com",
"source": "signup"
}{
"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
POST
{
"link_id": 29719392,
"domain_id": 46873408,
"email": "my_colleague@example.com",
"message": "DNS Record for verification"
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": {
"error": "cillum deserunt",
"field": "nostrud sunt occaecat qui Ut"
}
}IP Pools(7 operations)
POST
{
"name": "marketing"
}{
"name": "marketing"
}GET
[
{
"name": "marketing"
},
{
"name": "transactional"
}
]POST
{
"ip": "0.0.0.0"
}{
"ip": "000.00.00.0",
"pools": [
"test1"
],
"start_date": 1409616000,
"warmup": true
}{
"errors": [
{
"field": null,
"message": "resource not found"
}
]
}GET
{
"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"
}
]
}PUT
{
"name": "new_pool_name"
}{
"name": "new_pool_name"
}{
"errors": [
{
"field": null,
"message": "ip pool not found"
}
]
}DELETE
{}{
"error": "Unable to locate specified IPs Pool"
}DELETE
{}{
"error": "Unable to locate specified IPs Pool"
}IP Addresses(5 operations)
POST
{
"count": 90323478,
"subusers": [
"subuser1",
"subuser2"
],
"warmup": true,
"user_can_send": true
}{
"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"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
ip | Ut |
exclude_whitelabels | false |
limit | -42388793 |
offset | 93723865 |
subuser | cillum |
sort_by_direction | asc |
[
{
"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
}
]GET
{
"results": [
{
"remaining": 2,
"period": "month",
"price_per_ip": 20
}
]
}GET
[
{
"ip": "167.89.21.3",
"pools": [
"new_test5"
],
"warmup": true,
"start_date": 1409616000
}
]GET
{
"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)
GET
| Query Parameter Name | Example |
|---|---|
limit | -6014433 |
offset | 66762658 |
exclude_subusers | true |
username | amet sit adipisicing |
domain | non |
| Header Name | Example |
|---|---|
on-behalf-of | "fugiat minim" |
[
{
"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"
}
}
}
]POST
| Header Name | Example |
|---|---|
on-behalf-of | "voluptate" |
{
"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
}{
"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"
}
}
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "velit eu Lorem labore adipisicing" |
{
"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"
}
}
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "et enim quis cillum esse" |
{
"default": false,
"custom_spf": true
}[
{
"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"
}
}
}
]DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "sint consequat cupidatat aliquip" |
{}GET
| Query Parameter Name | Example |
|---|---|
domain | ex id |
| Header Name | Example |
|---|---|
on-behalf-of | "laboris magna in ea do" |
[
{
"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"
}
}
}
]POST
| Header Name | Example |
|---|---|
on-behalf-of | "laboris occaecat sint sunt" |
{
"ip": "192.168.0.1"
}{
"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
}
}
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "reprehenderit tempor elit in est" |
{
"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
}
}
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "nisi amet commodo Excepteur laborum" |
{
"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"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
username* | nostrud ut veniam |
{
"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
}
}
}DELETE
| Query Parameter Name | Example |
|---|---|
username | exercitation occaecat quis |
{}POST
{
"username": "jdoe"
}{
"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)
GET
{
"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": "officia"
},
{
"message": "et sit officia magna in"
}
]
}GET
{
"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 dolore"
},
{
"message": "Excepteur reprehenderit magna"
},
{
"message": "ullamco id"
}
]
}POST
{
"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"
}{
"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": "laborum culpa fugiat",
"field": "elit officia sed do",
"message": "est in aliqua"
},
{
"error_id": "eiusmod aliquip cillum Excepteur",
"field": "ipsum ex occaecat",
"message": "proident incididunt do occaecat"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "et laborum Duis dolore"
},
{
"message": "consectetur Excepteur dolor"
},
{
"message": "culpa anim nulla ad eiusmod"
},
{
"message": "consectetur magna qui ad aliquip"
},
{
"message": "qui sunt enim cupidatat"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
limit | 69039528.99853835 |
lastSeenID | 62236236.69034451 |
id | 70948573 |
{
"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": "voluptate"
},
{
"message": "mollit commodo Duis laborum adipisicing"
},
{
"message": "ullamco Ut cupidatat sed"
},
{
"message": "irure ullamco minim dolor dolore"
},
{
"message": "Lorem aliquip"
}
]
}GET
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": "laborum",
"message": "fugiat Excepteur tempor mollit"
}
]
}{
"errors": [
{
"message": "magna in Ut Lorem"
},
{
"message": "cillum consequat do deserunt"
}
]
}PATCH
{
"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"
}{
"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": "cupidatat non dolore sint",
"field": "sed enim",
"message": "culpa cillum consequat"
},
{
"error_id": "consectetur",
"field": "nulla in enim Ut",
"message": "sit ut ut incididunt Ut"
},
{
"error_id": "magna sunt in",
"field": "culpa nulla elit cillum nostrud",
"message": "amet consequat"
},
{
"error_id": "commodo id est aute",
"field": "amet ipsum aliqua",
"message": "ea Excepteur"
},
{
"error_id": "in amet in",
"field": "aliquip labore",
"message": "in dolore"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"error_id": "proident nulla reprehenderit ipsum consectetur",
"message": "voluptate anim eiusmod tempor"
},
{
"error_id": "et",
"message": "laboris exercitation anim"
},
{
"error_id": "nisi ut",
"message": "pariatur sunt Lorem laborum"
},
{
"error_id": "velit sed",
"message": "mollit"
},
{
"error_id": "Ut officia enim fugiat",
"message": "deserunt voluptate"
}
]
}{
"errors": [
{
"error_id": "fugiat in anim",
"message": "amet dolor est minim"
},
{
"error_id": "velit elit nulla reprehenderit labore",
"message": "irure proident sunt ut enim"
}
]
}{
"errors": [
{
"message": "magna Duis"
},
{
"message": "fugiat ipsum in amet irure"
},
{
"message": "dolor aliquip Duis"
},
{
"message": "in sed nisi elit ex"
}
]
}DELETE
{}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"error_id": "Lorem",
"message": "reprehenderit ea ipsum id"
},
{
"error_id": "sint elit eiusmod qui eu",
"message": "eiusmod ad"
},
{
"error_id": "proident dolore elit in sunt",
"message": "officia"
},
{
"error_id": "minim ipsum",
"message": "ex fugiat velit"
}
]
}{
"errors": [
{
"error_id": "Duis",
"message": "sint consectetur"
},
{
"error_id": "qui laborum et",
"message": "cillum aliquip id"
},
{
"error_id": "in sed aliquip",
"message": "esse Ut"
},
{
"error_id": "aliquip culpa occaecat enim sed",
"message": "et"
}
]
}{
"errors": [
{
"message": "sint sed Excepteur"
},
{
"message": "in dolor"
},
{
"message": "ipsum sunt"
},
{
"message": "sunt ipsum id irure anim"
},
{
"message": "deserunt dolore non"
}
]
}POST
{}{
"errors": [
{
"error_id": "do dolore",
"message": "proident"
},
{
"error_id": "ut non consectetur fugiat",
"message": "sit nisi minim aute laboris"
},
{
"error_id": "irure Excepteur est deserunt",
"message": "ad adipisicing sint"
},
{
"error_id": "dolor commodo cupidatat mollit",
"message": "sit deserunt"
},
{
"error_id": "officia deserunt",
"message": "sint adipisicing cupidatat dolore"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"error_id": "esse aliqua ut ea culpa",
"message": "in ut adipisicing labore"
},
{
"error_id": "ut",
"message": "culpa enim fugiat eiusmod"
},
{
"error_id": "eiusmod dolore Lorem laborum",
"message": "dolor pariatur aliquip"
},
{
"error_id": "esse incididunt dolor cillum mollit",
"message": "sed in aliqua quis"
}
]
}{
"errors": [
{
"message": "culpa magna"
},
{
"message": "pariatur"
}
]
}Designs API(9 operations)
POST
{
"name": "Ahoy, Cake or Pie Cafe!",
"editor": "design"
}{
"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": "dolore eu cillum qui cupidatat",
"field": "ad qui in nisi dolore",
"message": "ad deserunt"
}{
"errors": [
{
"error_id": "anim deserunt labore",
"field": "non in laboris",
"message": "Duis pariatur nisi mollit ut"
}
]
}GET
{
"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": "quis magna dolore",
"field": "ipsum",
"message": "laboris"
},
{
"error_id": "enim",
"field": "ad",
"message": "in dolore"
},
{
"error_id": "in minim",
"field": "veniam aute mollit",
"message": "in reprehenderit ea et in"
}
]
}{
"errors": [
{
"error_id": "dolore",
"field": "proident anim",
"message": "exercitation adipisicing esse do elit"
},
{
"error_id": "esse dolor in consectetur",
"field": "in est id",
"message": "nostrud aliquip cupidatat ex et"
},
{
"error_id": "in ea",
"field": "dolore nulla occaecat amet cillum",
"message": "adipisicing mollit nostrud sit"
},
{
"error_id": "commodo sunt nostrud ut tempor",
"field": "ipsum adipisicing sint dolor tempor",
"message": "voluptate Ut culpa"
},
{
"error_id": "Ut anim ex fugiat proident",
"field": "do mollit amet",
"message": "occaecat mollit consectetur dolore velit"
}
]
}PATCH
{
"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"
]
}{
"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": "sit veniam non labore nulla",
"field": "mollit",
"message": "exercitation qui sunt"
},
{
"error_id": "mollit",
"field": "proident",
"message": "pariatur incididunt irure"
},
{
"error_id": "laboris veniam",
"field": "sed",
"message": "ipsum"
},
{
"error_id": "voluptate Lorem elit",
"field": "in amet",
"message": "amet ipsum quis"
}
]
}{
"errors": [
{
"error_id": "anim minim mollit dolor",
"field": "ex nulla",
"message": "in ullamco incididunt dolore"
},
{
"error_id": "velit do",
"field": "dolor consectetur aliqua dolore",
"message": "esse"
},
{
"error_id": "eu",
"field": "proident aute consectetur mollit sint",
"message": "et occaecat"
},
{
"error_id": "aute",
"field": "non sit nostrud fugiat",
"message": "in"
},
{
"error_id": "fugiat proident",
"field": "in incididunt et quis nostrud",
"message": "incididunt"
}
]
}DELETE
{}{
"errors": [
{
"error_id": "aute et id",
"field": "in",
"message": "sed"
},
{
"error_id": "sint voluptate occaecat mollit",
"field": "laboris",
"message": "cillum esse in ullamco ad"
},
{
"error_id": "in magna pariatur Ut",
"field": "do ullamco",
"message": "in eiusmod fugiat id"
},
{
"error_id": "in commodo",
"field": "nostrud eiusmod non qui",
"message": "aute culpa id"
}
]
}{
"errors": [
{
"error_id": "mollit veniam nisi consectetur",
"field": "non sint ut",
"message": "id"
},
{
"error_id": "est",
"field": "pariatur est Lorem deserunt",
"message": "eiusmod ea dolor"
},
{
"error_id": "sint aliqua minim",
"field": "veniam ipsum sint ea",
"message": "do in eiusmod voluptate quis"
}
]
}POST
{
"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}}} )"
}{
"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": "sunt",
"field": "dolor irure",
"message": "aliquip Excepteur"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
page_size | 66172734 |
page_token | dolore deserunt |
summary | true |
{
"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
}
}POST
{
"name": "Ahoy, Cake or Pie Cafe!",
"editor": "design"
}{
"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\"> </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\"> </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": "dolore aliquip Ut",
"field": "cillum dolore quis officia aliqua",
"message": "deserunt culpa ullamco"
},
{
"error_id": "proident magna quis Duis",
"field": "non do Lorem officia",
"message": "ex"
},
{
"error_id": "dolore",
"field": "magna deserunt proident officia mollit",
"message": "eu irure"
}
]
}{
"errors": [
{
"error_id": "dolor ut enim deserunt aute",
"field": "laboris",
"message": "irure"
},
{
"error_id": "et occaecat dolore laborum",
"field": "nostrud sed ullamco",
"message": "cupidatat irure laboris"
},
{
"error_id": "nisi",
"field": "ut et incididunt laboris do",
"message": "voluptate ut aliqua"
},
{
"error_id": "pariatur enim ipsum amet",
"field": "culpa veniam velit ex",
"message": "do anim incididunt aliquip"
}
]
}GET
{
"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\"> </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\"> </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": "sit officia magna anim",
"field": "eu sed culpa consequat anim",
"message": "sed elit"
}
]
}{
"errors": [
{
"error_id": "enim dolor",
"field": "deserunt Duis fugiat",
"message": "in est minim Excepteur"
},
{
"error_id": "dolor ut ut sunt nulla",
"field": "magna quis",
"message": "quis"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
page_size | 270241 |
page_token | Lorem veniam ut et |
summary | false |
{
"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)
PUT
{
"contacts": [
{
"address_line_1": "fugiat qui sunt aliq",
"address_line_2": "cupidatat nulla ex",
"alternate_emails": [
"voluptate id in adipisicing",
"reprehenderit",
"officia cillum culpa",
"enim la",
"irure culpa sed laboris"
],
"city": "sit sunt elit ad qui",
"country": "e",
"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": "ipsum",
"first_name": "cillum sunt d",
"last_name": "voluptate e",
"postal_code": "irure ut",
"state_province_region": "in non ullamco velit"
},
{
"address_line_1": "sint dolore",
"address_line_2": "Excepteur",
"alternate_emails": [
"quis ad magna occaecat voluptate",
"ullamco reprehenderit nulla incididunt",
"fugiat eiusmod ut aliquip",
"dolore",
"esse"
],
"city": "enim aute",
"country": "ea laborum el",
"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": "Excepteur eiusmod minim est laborum",
"first_name": "ullamco",
"last_name": "aliqua occaecat cillum eiusmod ut",
"postal_code": "est aliqua",
"state_province_region": "ut amet"
},
{
"address_line_1": "nostrud commodo laboris pariatur",
"address_line_2": "sit incididunt nulla",
"alternate_emails": [
"nulla dolore commodo in Lorem",
"consectetur cupidatat nisi aliquip in",
"dolore et",
"consectetur ex laboris",
"dolor culpa"
],
"city": "s",
"country": "deserunt",
"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": "nostrud",
"first_name": "mollit e",
"last_name": "molli",
"postal_code": "est pariatur exercitation eiusmod",
"state_province_region": "ut"
},
{
"address_line_1": "nulla",
"address_line_2": "eu labore",
"alternate_emails": [
"irure labore",
"adipisicing dolore",
"eiusmod amet",
"dolor deserunt in",
"irure laborum cupidatat est reprehenderit"
],
"city": "anim velit",
"country": "fugia",
"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": "commodo",
"first_name": "culpa Lorem ve",
"last_name": "in dolore",
"postal_code": "sed deserunt incididunt laboris",
"state_province_region": "irure"
},
{
"address_line_1": "adipisicing",
"address_line_2": "in sint labore qui",
"alternate_emails": [
"incididunt",
"occaecat s",
"in irure",
"esse aliqua cupidatat Duis fugiat",
"sit Duis"
],
"city": "ut fugiat do ea",
"country": "est n",
"custom_fields": {
"e2": "Coffee is a beverage that puts one to sleep when not drank.",
"w1": "2002-10-02T15:00:00Z",
"w33": 9.5
},
"email": "velit",
"first_name": "nisi aliquip",
"last_name": "ut labore sit",
"postal_code": "in consectetur fugiat occaecat id",
"state_province_region": "labor"
},
{
"address_line_1": "commodo laboris eiusmod amet proident",
"address_line_2": "labore nisi in incididunt Ut",
"alternate_emails": [
"commodo",
"est officia et",
"sint reprehenderit",
"enim",
"ad consectetur adipisicing"
],
"city": "consequat pariatur reprehenderit",
"country": "voluptate nisi qui aliq",
"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": "dolore occaecat deserunt quis",
"first_name": "officia fugiat",
"last_name": "magna elit dolore",
"postal_code": "dolore qui Ut reprehenderit",
"state_province_region": "sint fugiat cupidatat"
},
{
"address_line_1": "aliqua ipsum",
"address_line_2": "cupidatat aliqua",
"alternate_emails": [
"do in sit dolore aliquip",
"ut",
"quis",
"laborum ut nostrud non Ut",
"reprehenderit quis"
],
"city": "et velit ad",
"country": "Duis ut consequat incididunt",
"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": "et",
"first_name": "null",
"last_name": "dolore",
"postal_code": "id commodo",
"state_province_region": "aute veniam cillum enim"
},
{
"address_line_1": "sunt quis elit Duis nisi",
"address_line_2": "adipisicing eiusmod dolor qu",
"alternate_emails": [
"dolore Duis",
"magna sit reprehenderit",
"deserunt",
"ex nisi",
"tempo"
],
"city": "dolor ipsum dolore culpa",
"country": "non",
"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": "culpa commodo do",
"first_name": "sunt consectetur nul",
"last_name": "Duis nulla est",
"postal_code": "laborum",
"state_province_region": "in"
},
{
"address_line_1": "pariatur do nisi dol",
"address_line_2": "commodo reprehenderit ea",
"alternate_emails": [
"nisi esse pariatur",
"eiusmod minim",
"nisi ad exercitation",
"do eiusmod ullamco sint dolore",
"sed"
],
"city": "est sed dolor voluptate cupidatat",
"country": "ipsum",
"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": "eiusmod eu veniam incididunt dolor",
"first_name": "sunt of",
"last_name": "proident ipsum",
"postal_code": "tempor",
"state_province_region": "elit "
},
{
"address_line_1": "in deserunt occaecat sed",
"address_line_2": "anim ipsum dolor proident quis",
"alternate_emails": [
"sunt occaecat minim consectetur Lorem",
"ullamco do deserunt in",
"in consectetur qui in minim",
"non adipisicing reprehenderit",
"fugiat ullamco"
],
"city": "officia ",
"country": "aute culpa Ut nulla",
"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": "nisi ex nulla in",
"first_name": "in",
"last_name": "Ut",
"postal_code": "labore anim commodo occaecat",
"state_province_region": "sint"
}
],
"list_ids": [
"e35b43ac-ba9a-e2ad-e258-f99a08bf2db1",
"702f1b7b-fbff-276f-404d-19334b8d3f94",
"28edbed7-6fb2-bb03-3ee9-67f24d7b1baf"
]
}{
"job_id": "dolor"
}{
"errors": [
{
"error_id": "qui",
"field": "voluptate ea",
"message": "irure nostrud occaecat quis",
"parameter": "sit qui ea eiusmod"
},
{
"error_id": "occaecat ad",
"field": "qui",
"message": "consequat ut aliqua proident",
"parameter": "in id proident"
},
{
"error_id": "dolore",
"field": "qui mollit Excepteur id nulla",
"message": "amet",
"parameter": "labore Excepteur anim culpa ea"
},
{
"error_id": "reprehenderit velit pariatur ut consectetur",
"field": "fugiat cupidatat pariatur do tempor",
"message": "esse ullamco ut",
"parameter": "veniam reprehenderit culpa exercitation"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "irure officia"
}
]
}DELETE
| Query Parameter Name | Example |
|---|---|
delete_all_contacts | ea in est amet |
ids | velit sint non |
{
"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": "Lorem reprehenderit"
},
{
"message": "eiusmod reprehenderit"
},
{
"message": "et minim elit"
},
{
"message": "proident"
}
]
}GET
{
"_metadata": {
"self": "et ut est do"
},
"contact_count": 79150299,
"result": [
{
"_metadata": {
"self": "officia laborum adipisicing labore"
},
"address_line_1": "ea exercitation Excepteur ex fugiat",
"address_line_2": "aliquip incididunt",
"alternate_emails": [
"Ut voluptate nisi ullamco incididunt",
"officia dolor eiusmod do minim",
"est dolore fugiat Excepteur sit"
],
"city": "pariatur labore",
"country": "in consectetur reprehenderit",
"created_at": "cillum dolore commodo",
"custom_fields": {},
"email": "culpa et velit occaecat consequat",
"facebook": "cillum in labore Excepteur",
"first_name": "labore elit adipisicing in ea",
"id": "nostrud in",
"last_name": "dolor magna dolor sit",
"line": "cupidatat deserunt sed",
"list_ids": [
"aute nostrud anim voluptate consequat",
"consequat"
],
"phone_number": "sed exercitation Excepteur",
"postal_code": "labore ea",
"segment_ids": [
"sunt ullamco sed laboris",
"est esse laboris sit",
"et quis esse",
"occaecat anim irure nostrud esse",
"ut exercitation ex veniam"
],
"state_province_region": "dolor velit",
"unique_name": "eu et voluptate",
"updated_at": "fugiat ipsum",
"whatsapp": "do id est officia sint"
}
]
}{
"errors": [
{
"error_id": "proident",
"field": "mollit est exercitation cupidatat",
"message": "enim",
"parameter": "ut enim do"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{}{
"errors": [
{
"message": "sed id Ut"
}
]
}GET
{
"billable_breakdown": {
"breakdown": {},
"total": 70637015
},
"billable_count": 55483269,
"contact_count": 89695266
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "dolor anim velit consequat"
},
{
"message": "dolor tempor"
},
{
"message": "minim deserunt dolor consectetur"
}
]
}POST
{
"file_type": "json",
"list_ids": [
"c7695699-1b2a-efd3-af89-6478a05dc5e0"
],
"max_file_size": -62506535,
"notifications": {
"email": false
},
"segment_ids": [
"enim quis voluptate amet id",
"consequat"
]
}{
"_metadata": {
"count": 53798059.102663845,
"next": "https://p.heuxpBAyGXe+gEV5CtrAf0XQ2Zv7bYmYTlA9vs+oGPz",
"prev": "http://bvxFxXeopMGfZErxHzVkF.icevlYFPDe6Ottys2NlwLMkqgAscmylk7v,u",
"self": "http://fmk.dklcyMrVgGOmtyj5qvRntJzMHpWUKwZ+-deUt3te4-a"
},
"id": "dolor do eu voluptate"
}{
"errors": [
{
"error_id": "adipisicing nulla qui",
"field": "fugiat cupidatat aliqua irure laborum",
"message": "sit pariatur laboris nisi",
"parameter": "laborum sint voluptate do"
},
{
"error_id": "incididunt tempor",
"field": "dolor consectetur adipisicing",
"message": "non nulla ex dolor",
"parameter": "reprehenderit"
},
{
"error_id": "ut aliqua laboris do irure",
"field": "do et dolor aliqua",
"message": "aute aliqua minim reprehenderit",
"parameter": "sit officia sed"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "laborum culpa voluptate"
},
{
"message": "eu ad do in consectetur"
},
{
"message": "Ut"
},
{
"message": "dolor velit commodo ad"
},
{
"message": "exercitation ex deserunt"
}
]
}GET
{
"_metadata": {
"next": "ad esse Ut in",
"prev": "in id",
"self": "incididunt laborum enim ex in"
},
"result": [
{
"_metadata": {
"next": "eu proident Duis nisi laboris",
"prev": "elit ex id ut",
"self": "pariatur dolor in cillum sed"
},
"completed_at": "voluptate dolore eu anim",
"created_at": "pariatur adipisicing mollit non ipsum",
"expires_at": "est Lorem dolor eiusmod dolor",
"export_type": "deserunt esse do",
"id": "aute deserunt",
"lists": [
{
"ID": "incididunt",
"Name": "Lorem non"
}
],
"segments": [
{
"ID": "magna in dolore esse ut",
"Name": "adipisicing mollit nostrud labore irure"
},
{
"ID": "est laboris velit",
"Name": "aute Ut do"
},
{
"ID": "laboris anim Excepteur dolor",
"Name": "laborum amet sunt ipsum mollit"
},
{
"ID": "nostrud sunt ipsum",
"Name": "amet elit veniam"
}
],
"status": "dolore",
"urls": [
"exercitation",
"sunt quis"
],
"user_id": "nulla pariatur sit tempor"
},
{
"_metadata": {
"next": "laboris",
"prev": "eu",
"self": "pariatur sunt ut veniam"
},
"completed_at": "officia veniam irure et in",
"created_at": "nulla mollit culpa ipsum",
"expires_at": "pariatur",
"export_type": "exercitation anim ex",
"id": "est anim",
"lists": [
{
"ID": "qui ut sint enim cupidatat",
"Name": "ut eu ut cupidatat"
},
{
"ID": "exercitation dolore fugiat mollit dolor",
"Name": "Duis officia exercitation labore enim"
},
{
"ID": "est nisi",
"Name": "sit velit"
},
{
"ID": "elit pariatur nulla veniam",
"Name": "Lorem"
},
{
"ID": "in",
"Name": "ea laborum"
}
],
"segments": [
{
"ID": "ex adipisicing qui aliqua",
"Name": "ipsum ea Duis consectetur"
},
{
"ID": "do dolor consectetur",
"Name": "magna dolore dolor"
},
{
"ID": "laboris ex ipsum cupidatat cillum",
"Name": "id proident magna voluptate"
}
],
"status": "cupidatat nostrud",
"urls": [
"est sint",
"do et"
],
"user_id": "ad pariatur quis aute ut"
},
{
"_metadata": {
"next": "nostrud Duis officia",
"prev": "qui dolore officia sit",
"self": "Duis enim"
},
"completed_at": "sint occaecat do tempor",
"created_at": "ea enim labore tempor ipsum",
"expires_at": "ipsum",
"export_type": "Lorem Excepteur sit fugiat eu",
"id": "pariatur officia cillum",
"lists": [
{
"ID": "nulla mollit voluptate Duis deserunt",
"Name": "cillum"
},
{
"ID": "Lorem ipsum",
"Name": "laboris nostrud tempor enim"
}
],
"segments": [
{
"ID": "pariatur occaecat esse aliquip irure",
"Name": "id"
}
],
"status": "id ullamco",
"urls": [
"incididunt sit magna"
],
"user_id": "in non laboris"
},
{
"_metadata": {
"next": "dolore consectetur deserunt enim",
"prev": "sunt reprehenderit proident ex dolor",
"self": "ut mollit irure nulla"
},
"completed_at": "pariatur enim culpa minim fugiat",
"created_at": "id deserunt",
"expires_at": "minim exercitation elit",
"export_type": "amet nisi occaecat nulla",
"id": "in ut",
"lists": [
{
"ID": "nostrud do",
"Name": "dolore ex laborum"
},
{
"ID": "reprehenderit commodo",
"Name": "id dolore ullamco"
},
{
"ID": "incididunt in minim est eiusmod",
"Name": "id"
}
],
"segments": [
{
"ID": "sed sunt ipsum ea magna",
"Name": "irure qui esse sed"
},
{
"ID": "aute non Lorem",
"Name": "sit Excepteur nostrud occaecat"
},
{
"ID": "laborum minim sed commodo",
"Name": "consectetur"
}
],
"status": "est sit",
"urls": [
"fugiat in",
"fugiat officia",
"et ullamco eu",
"aliqua exercitation minim cillum id",
"qui"
],
"user_id": "magna do"
},
{
"_metadata": {
"next": "consectetur ullamco aliquip",
"prev": "adipisicing",
"self": "deserunt aute"
},
"completed_at": "adipisicing",
"created_at": "quis",
"expires_at": "minim magna eiusmod",
"export_type": "qui ut",
"id": "est dolore non amet",
"lists": [
{
"ID": "cillum elit et ullamco",
"Name": "aliqua et labore ea Lorem"
},
{
"ID": "culpa ullamco nulla labore",
"Name": "deserunt voluptate mollit minim id"
},
{
"ID": "aliquip cupidatat et ea proident",
"Name": "est tempor dolor"
},
{
"ID": "culpa",
"Name": "velit consequat sunt sint aute"
}
],
"segments": [
{
"ID": "consequat irure exercitation in dolor",
"Name": "aliquip id occaecat ipsum"
}
],
"status": "in magna proident dolore esse",
"urls": [
"do reprehenderit",
"aliquip eiusmod occaecat",
"aliquip Ut"
],
"user_id": "cillum quis culpa cupidatat eiusmod"
}
]
}{
"errors": [
{
"": "ut anim amet laborum",
"error_id": "Duis id",
"message": "Lorem dolore culpa adipisicing"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "magna exercitation dolor ullamco adipisicing"
}
]
}GET
{
"_metadata": {
"self": "consequat officia amet dolore dolore"
},
"address_line_1": "fugiat labore occaecat nisi aliquip",
"address_line_2": "Ut eu in",
"alternate_emails": [
"anim sed reprehenderit Ut irure",
"irure Ut tempor"
],
"city": "Lorem quis",
"country": "laboris dolor Duis anim sit",
"created_at": "in minim in nostrud",
"custom_fields": {},
"email": "fugiat cupidatat veniam officia labore",
"facebook": "eiusmod cillum id",
"first_name": "dolor",
"id": "ea pariatur in",
"last_name": "elit labore non",
"line": "Lorem aute ipsum",
"list_ids": [
"dolor",
"quis culpa pariatur adipisicing elit",
"fugiat voluptate do"
],
"phone_number": "eu et amet tempor in",
"postal_code": "ut ea nulla",
"segment_ids": [
"consectetur pariatur aliqua"
],
"state_province_region": "commodo ullamco",
"unique_name": "et magna non",
"updated_at": "aliqua dolore sed",
"whatsapp": "id tempor ex"
}{
"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": "ex ad in esse officia"
},
{
"message": "Lorem et voluptate ut nisi"
},
{
"message": "labore dolore"
},
{
"message": "Ut ipsum occaecat"
},
{
"message": "ex"
}
]
}POST
{
"query": "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')"
}{
"_metadata": {
"self": "est pariatur"
},
"contact_count": -2597296.178440362,
"result": [
{
"_metadata": {
"self": "nulla"
},
"address_line_1": "exercitation sint fugiat incididunt",
"address_line_2": "sint",
"alternate_emails": [
"anim sunt",
"cupidatat do fugiat",
"consectetur reprehenderit eiusmod enim",
"nulla id laboris",
"labore Lorem nulla ipsum"
],
"city": "non sunt",
"country": "dolore",
"created_at": "culpa pariatur qui adipisicing",
"custom_fields": {},
"email": "eu in et voluptate",
"facebook": "est et aute",
"first_name": "nisi consequat minim anim occaecat",
"id": "ut elit ex nisi",
"last_name": "dolore id enim officia",
"line": "aute esse ea occaecat laborum",
"list_ids": [
"fugiat amet ut do dolor"
],
"phone_number": "laborum amet est Duis dolore",
"postal_code": "eu",
"segment_ids": [
"minim in",
"fugiat voluptate amet dolore"
],
"state_province_region": "et",
"unique_name": "nulla Lorem",
"updated_at": "Duis id sit elit ex",
"whatsapp": "labore ea non laborum dolor"
},
{
"_metadata": {
"self": "Lorem tempor sint in"
},
"address_line_1": "irure do Duis velit aute",
"address_line_2": "non",
"alternate_emails": [
"Ut fugiat enim veniam",
"culpa occaecat",
"pariatur"
],
"city": "ipsum ut sed in",
"country": "ut ipsum incididunt sunt",
"created_at": "velit",
"custom_fields": {},
"email": "adipisicing",
"facebook": "exercitation adipisicing dolor sit",
"first_name": "non eu proident sit",
"id": "sed in ad",
"last_name": "culpa proident dolor",
"line": "ad Duis in nulla",
"list_ids": [
"pariatur in dolore",
"et",
"officia",
"est",
"et esse ad"
],
"phone_number": "dolore reprehenderit",
"postal_code": "irure nostrud ad",
"segment_ids": [
"velit sunt"
],
"state_province_region": "fugiat cupidatat culpa",
"unique_name": "ipsum minim ut culpa",
"updated_at": "mollit incididunt",
"whatsapp": "sunt in consectetur"
},
{
"_metadata": {
"self": "Lorem ipsum nisi deserunt"
},
"address_line_1": "velit amet fugiat",
"address_line_2": "mollit",
"alternate_emails": [
"eiusmod Ut deserunt"
],
"city": "nulla tempor ea",
"country": "quis in",
"created_at": "deserunt",
"custom_fields": {},
"email": "Excepteur eu amet",
"facebook": "Excepteur in deserunt eiusmod",
"first_name": "cupidatat",
"id": "minim id ea",
"last_name": "aliquip amet",
"line": "non velit anim eiusmod",
"list_ids": [
"ipsum Excepteur",
"adipisicing ut aute cillum",
"ut ut esse sit fugiat"
],
"phone_number": "ex commodo",
"postal_code": "laboris anim in esse",
"segment_ids": [
"dolore",
"in ex"
],
"state_province_region": "ut eu",
"unique_name": "dolore",
"updated_at": "est enim",
"whatsapp": "culpa"
},
{
"_metadata": {
"self": "ex nisi aliquip veniam irure"
},
"address_line_1": "pariatur",
"address_line_2": "eiusmod",
"alternate_emails": [
"cillum",
"nisi sed ad",
"et"
],
"city": "ut",
"country": "reprehenderit anim dolor",
"created_at": "eiusmod sit",
"custom_fields": {},
"email": "sint cupidatat consectetur adipisicing cillum",
"facebook": "dolore in ullamco",
"first_name": "fugiat non in commodo dolor",
"id": "sunt",
"last_name": "reprehenderit quis qui ut",
"line": "mollit sit",
"list_ids": [
"aliquip incididunt qui Duis cupidatat",
"dolore",
"magna"
],
"phone_number": "eiusmod consectetur",
"postal_code": "eu in Ut voluptate nostrud",
"segment_ids": [
"labore in enim reprehenderit dolor",
"ipsum ad enim irure",
"dolor"
],
"state_province_region": "minim amet eu irure commodo",
"unique_name": "officia Ut ex irure cillum",
"updated_at": "eu aliqua",
"whatsapp": "in ullamco non cillum"
},
{
"_metadata": {
"self": "est enim in ipsum"
},
"address_line_1": "dolor est irure in",
"address_line_2": "in",
"alternate_emails": [
"exercitation cillum voluptate quis"
],
"city": "exercitation ea eiusmod minim",
"country": "cupidatat ex Excepteur Duis",
"created_at": "reprehenderit voluptate non Duis ad",
"custom_fields": {},
"email": "in",
"facebook": "nulla consectetur",
"first_name": "magna ipsum adipisicing sit",
"id": "Ut dolore",
"last_name": "labore",
"line": "ea reprehenderit laborum veniam",
"list_ids": [
"magna sit"
],
"phone_number": "cupidatat",
"postal_code": "sed Excepteur ut proident",
"segment_ids": [
"Duis",
"magna Duis",
"mollit ea sit",
"in ut",
"Duis Ut deserunt Lorem"
],
"state_province_region": "dolor sed veniam dolore",
"unique_name": "culpa ipsum",
"updated_at": "ex in sit esse",
"whatsapp": "do commodo"
}
]
}{
"errors": [
{
"field": "ad",
"message": "Ut amet tempor sint ex"
},
{
"field": "et eiusmod",
"message": "in sed"
}
]
}{
"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": "ad ipsum aute Excepteur ea"
}
]
}PUT
{
"field_mappings": [
"Excepteur anim",
"est reprehenderit ut"
],
"file_type": "csv",
"list_ids": [
"Lorem Ut dolore pariatur"
]
}{
"job_id": "velit",
"upload_headers": [
{
"header": "consequat reprehenderit commodo dolor",
"value": "eiusmod sit"
},
{
"header": "ut cupidatat",
"value": "et id ex Duis nisi"
},
{
"header": "minim qui",
"value": "enim"
}
],
"upload_uri": "voluptate consectetur laboris aliquip sed"
}{
"errors": [
{
"error_id": "commodo nisi ipsum magna",
"field": "consectetur tempor culpa",
"message": "ex velit sunt ea",
"parameter": "ullamco dolor Ut"
},
{
"error_id": "ad",
"field": "anim amet",
"message": "esse irure eu ipsum",
"parameter": "quis ea voluptate"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"error_id": "aliqua magna nostrud sit officia",
"field": "sunt in officia",
"message": "occaecat do Lorem mollit voluptate",
"parameter": "aute nostrud in do"
},
{
"error_id": "sit ut irure",
"field": "ullamco Lorem ex mollit est",
"message": "irure in dolore labore",
"parameter": "cillum nisi laboris non in"
},
{
"error_id": "aliquip ullamco esse",
"field": "exercitation est amet ut",
"message": "ad sint nisi velit",
"parameter": "consectetur et qui dolore sit"
}
]
}{
"errors": [
{
"message": "amet ut eiusmod nulla"
},
{
"message": "officia labore"
},
{
"message": "proident reprehenderit"
}
]
}GET
{
"finished_at": "cupidatat officia Ut non elit",
"id": "nulla tempor",
"job_type": "consequat do proident magna id",
"results": {
"created_count": -95293094.35772419,
"deleted_count": 15439923.63012059,
"errored_count": -11855765.871153563,
"errors_url": "in velit adipisicing",
"requested_count": 65257493.61315212,
"updated_count": 50272657.52177411
},
"started_at": "dolor",
"status": "adipisicing mollit"
}{
"errors": {
"error_id": "laborum ut",
"field": "exercitation labore cillum ea",
"message": "consectetur aliquip culpa",
"parameter": "voluptate laborum amet eiusmod exercitation"
}
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "ullamco deserunt commodo"
},
{
"message": "sit"
},
{
"message": "pariatur nisi"
},
{
"message": "et qui dolor irure"
}
]
}GET
{
"_metadata": {
"count": -10989726.025176823,
"next": "https://exqkjxbHkMTuXLaafXwYJuZveSJrhenQB.hnnfY66XSeEmXD8RZlHqqfq",
"prev": "https://jYyVkKOPxNiSTsfPkfRTHUXMRbc.ehwvQf6OpYaEvDEZXnw.-+ptsSFdnxJ6hyKP3U1Gdtl1nu",
"self": "http://CbGwZCCCGLPwDJ.xqgJmPBABWLJHIpbnavYN+ahOYsS8Z"
},
"completed_at": "culpa proident nisi aliquip",
"contact_count": 78197935,
"created_at": "officia",
"expires_at": "in Lorem ut",
"id": "eiusmod dolor consequat sunt",
"message": "et ut",
"status": "pending",
"updated_at": "nulla",
"urls": [
"id",
"laboris aute veniam quis",
"pariatur"
]
}{
"errors": [
{
"error_id": "officia ad",
"field": "id Ut eiusmod aute",
"message": "ullamco et elit cillum ut",
"parameter": "dolore ea aliqua"
},
{
"error_id": "et",
"field": "Lorem nulla reprehenderit",
"message": "Lorem ad",
"parameter": "veniam commodo anim Excepteur"
},
{
"error_id": "officia Excepteur fugiat labore",
"field": "proident aliqua dolore",
"message": "in",
"parameter": "ex Lorem"
},
{
"error_id": "voluptate magna",
"field": "voluptate ex in exercitation",
"message": "labore deserunt dolore exercitation",
"parameter": "occaecat commodo in pariatur"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "quis"
},
{
"message": "occaecat ut magna est"
},
{
"message": "mollit irure laborum"
},
{
"message": "cillum eu ad"
},
{
"message": "eu sunt ad anim"
}
]
}POST
{
"ids": [
"1234",
"1235"
]
}{
"result": [
{
"_metadata": {
"self": "eu"
},
"address_line_1": "ad veniam do reprehenderit",
"address_line_2": "Ut fugiat in",
"alternate_emails": [
"velit in",
"velit qui",
"consectetur non",
"in occaecat ullamco",
"magna incididunt"
],
"city": "velit occaecat",
"country": "est do adipisicing sit",
"created_at": "in Ut sint in",
"custom_fields": {},
"email": "irure aute in nisi",
"facebook": "Excepteur",
"first_name": "Lorem anim voluptate",
"id": "qui",
"last_name": "laborum",
"line": "officia nulla commodo voluptate",
"list_ids": [
"commodo voluptate occaecat",
"anim culpa",
"velit enim magna",
"anim quis do et",
"est ut"
],
"phone_number": "deserunt",
"postal_code": "tempor nulla sunt proident",
"segment_ids": [
"esse labore aliqua",
"mollit dolore nisi laboris ipsum"
],
"state_province_region": "ex consectetur commodo magna ut",
"unique_name": "velit amet",
"updated_at": "magna adipisicing ipsum ea ad",
"whatsapp": "officia labore consequat dolor enim"
},
{
"_metadata": {
"self": "sit veniam cillum"
},
"address_line_1": "voluptate do nulla Duis ut",
"address_line_2": "minim Duis nostrud cillum sint",
"alternate_emails": [
"aliqua laborum irure",
"qui ut eiusmod",
"dolore pariatur consequat"
],
"city": "dolore nisi",
"country": "sed est nisi proident mollit",
"created_at": "nisi ex consequat enim irure",
"custom_fields": {},
"email": "sit cupidatat dolore ea",
"facebook": "cupidatat sit dolor labore irure",
"first_name": "laboris tempor veniam in anim",
"id": "ea",
"last_name": "sunt nostrud",
"line": "voluptate mollit pariatur est veniam",
"list_ids": [
"tempor sed labore deserunt ad",
"consectetur nostrud",
"adipisicing anim",
"nisi mollit ipsum proident ullamco"
],
"phone_number": "exercitation",
"postal_code": "ipsum sunt ut adipisicing Excepteur",
"segment_ids": [
"consectetur qui",
"dolore quis velit"
],
"state_province_region": "et",
"unique_name": "eiusmod fugiat",
"updated_at": "sed in",
"whatsapp": "qui deserunt voluptate ullamco"
},
{
"_metadata": {
"self": "cupidatat anim exercitation"
},
"address_line_1": "in consequat velit",
"address_line_2": "reprehenderit ullamco deserunt nisi",
"alternate_emails": [
"tempor aute fugiat",
"magna nulla",
"ut eu"
],
"city": "eiusmod magna ut officia",
"country": "mollit",
"created_at": "dolore dolor esse",
"custom_fields": {},
"email": "incididunt ullamco ea",
"facebook": "laborum reprehenderit culpa cillum",
"first_name": "ad",
"id": "cillum",
"last_name": "dolor ut in elit mollit",
"line": "amet ad aute",
"list_ids": [
"ut quis"
],
"phone_number": "reprehenderit irure exercitation",
"postal_code": "tempor dolore minim labore do",
"segment_ids": [
"elit cillum minim reprehenderit",
"nisi elit",
"non eu sunt",
"aliquip ea veniam commodo adipisicing",
"sunt"
],
"state_province_region": "consectetur",
"unique_name": "Excepteur consequat cupidatat",
"updated_at": "occaecat nisi",
"whatsapp": "mollit"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{}{
"errors": [
{
"message": "ut anim aliqua"
}
]
}POST
{
"emails": [
"jane_doe@example.com",
"john_doe@example.com",
"joann_doe@example.com"
]
}{
"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": "Excepteur Lorem"
},
{
"message": "eu ea"
},
{
"message": "do laboris eu"
},
{
"message": "est"
},
{
"message": "proident mollit non irure adipisicing"
}
]
}Segmenting Contacts V2 - Beta(5 operations)
POST
{
"name": "voluptate anim fugiat nisi",
"parent_list_ids": [
"sint",
"ipsum et",
"eiusmod et",
"nostrud pariatur cillum elit qui"
],
"query_dsl": "enim consequat ut in"
}{
"contacts_count": 91468077,
"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": "esse voluptate",
"id": "b10052f0-a7c1-3494-7376-86262c40a140",
"name": "id nisi minim aliquip irure",
"next_sample_update": "ad in",
"parent_list_ids": [
"proident sed nulla ipsum quis",
"officia velit Lorem enim dolore",
"ut non anim"
],
"query_dsl": "dolor cupidatat voluptate",
"query_version": "in dolore sed",
"sample_updated_at": "dolor in Excepteur tempor incididunt",
"status": {
"error_message": "officia",
"query_validation": "aute nulla"
},
"updated_at": "aliqua sit"
}{
"errors": [
{
"field": "Excepteur",
"message": "ut"
},
{
"field": "laborum sint anim cillum",
"message": "est sint dolor tempor sed"
},
{
"field": "dolore dolor laboris exercitation",
"message": "est ipsum"
},
{
"field": "dolor",
"message": "labore Lorem"
}
]
}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": "aliqua adipisicing do",
"message": "qui veniam laborum aute"
},
{
"field": "irure laboris est",
"message": "dolore quis est"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
parent_list_ids | proident magna ut nisi |
no_parent_list_id | true |
{
"_metadata": {
"count": 95253931,
"next": "https://IwSkOAIHbTaceiBdUYMBCDEqz.zvyBYWMK",
"prev": "https://SBrMJTswzCeEimMQbUFgNgGulQovjO.dygwWrUsh4qCVlenFI24Y3MDRiqv.,mL3MTDABveXeNVwWvu5N.4,pJ4J3W0.d3TSOY",
"self": "https://QKXmFretxjDOZmbntd.camdlKpgrBnw4ZLFdSDDqTK-TKDBAFo"
},
"contacts_count": -39482515,
"created_at": "ipsum",
"id": "e77565ec-d4c7-d7a8-adee-8f59a5d2890b",
"name": "culpa Lorem occaecat do",
"next_sample_update": "consectetur fugiat",
"parent_list_ids": [
"sint"
],
"query_version": "laborum non",
"sample_updated_at": "labore elit magna tempor",
"status": {
"error_message": "magna non veniam aliqua",
"query_validation": "laboris labore"
},
"updated_at": "incididunt dolor sunt officia"
}{
"errors": [
{
"field": "esse non",
"message": "qui veniam in et"
},
{
"field": "nulla",
"message": "minim"
}
]
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"field": "aliqua",
"message": "sint pariatur proident"
},
{
"field": "dolor Duis",
"message": "qui"
},
{
"field": "dolore sunt sed adipisicing",
"message": "sed ea nisi"
}
]
}PATCH
{
"name": "dolore minim reprehenderit nulla",
"query_dsl": "veniam"
}{
"contacts_count": -39973450,
"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": "minim proident",
"id": "0d7cbdb1-0859-0a98-6d62-26c48bd89bb3",
"name": "in adipisicing voluptate",
"next_sample_update": "in",
"parent_list_ids": [
"Excepteur",
"labore culpa pariatur Ut aute",
"do in quis qui"
],
"query_dsl": "tempor",
"query_version": "in",
"sample_updated_at": "incididunt voluptate consectetur quis pariatur",
"status": {
"error_message": "reprehenderit amet eiusmod sed consequat",
"query_validation": "esse ut laboris"
},
"updated_at": "proident"
}{
"errors": [
{
"field": "Excepteur mollit eu ex",
"message": "Duis occaecat"
}
]
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"field": "commodo est",
"message": "anim ex id velit proident"
},
{
"field": "deserunt culpa",
"message": "commodo sint minim ut"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
contacts_sample | false |
{
"contacts_count": -73614691,
"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": "do laboris Duis Excepteur Lorem",
"id": "5656f1d9-6366-3c14-6710-fdfc275a85c3",
"name": "enim cupidatat ullamco",
"next_sample_update": "in exercitation non ullamco",
"parent_list_ids": [
"velit cupidatat nostrud",
"et dolor reprehenderit",
"ut commodo eu enim quis",
"eiusmod in aliquip nulla",
"in sunt Excepteur non"
],
"query_dsl": "ut officia aute culpa",
"query_version": "aliqua ut veniam",
"sample_updated_at": "eu amet do",
"status": {
"error_message": "laborum do anim consectetur ullamco",
"query_validation": "adipisicing dolore eiusmod culpa"
},
"updated_at": "incididunt officia"
}{
"errors": [
{
"field": "nostrud non",
"message": "consectetur cillum nostrud reprehenderit Ut"
},
{
"field": "occaecat mollit non ea",
"message": "nostrud esse sit est"
},
{
"field": "qui deserunt eu pariatur ut",
"message": "cupidatat"
},
{
"field": "minim",
"message": "tempor enim ad reprehenderit pariatur"
}
]
}{
"errors": [
{
"field": "do",
"message": "ipsum in minim pariatur"
}
]
}DELETE
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"field": "in ut laboris consequat",
"message": "irure fugiat voluptate Lorem"
}
]
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"field": "Lorem sunt dolor",
"message": "veniam"
},
{
"field": "sed aliqua nostrud",
"message": "est tempor ea in nisi"
},
{
"field": "in",
"message": "veniam sint pariatur sunt id"
},
{
"field": "fugiat laborum voluptate laboris",
"message": "qui ex"
}
]
}Senders
POST
| Header Name | Example |
|---|---|
on-behalf-of | "Lorem dolore esse ipsum" |
{
"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"
}{
"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": "ullamco sit deserunt consequat cupidatat"
},
{
"message": "est ad incididunt irure magna"
},
{
"message": "ad"
}
]
}Lists(7 operations)
POST
{
"name": "list-name"
}{
"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": "dolore tempor",
"field": "est",
"message": "esse occaecat",
"parameter": "ea incididunt ipsum"
},
{
"error_id": "amet esse eiusmod",
"field": "labore Duis veniam occaecat sunt",
"message": "ipsum",
"parameter": "laboris Ut dolore consectetur elit"
},
{
"error_id": "laboris",
"field": "tempor",
"message": "ea ipsum qui sed",
"parameter": "pariatur eiusmod labore sint adipisicing"
},
{
"error_id": "do sed consectetur aliqua",
"field": "veniam",
"message": "laborum dolor",
"parameter": "laboris"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
page_size | 65.32472149304573 |
page_token | consequat in nisi culpa commodo |
{
"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="
}
}GET
{
"contact_count": 0,
"billable_count:": 0
}{}GET
| Query Parameter Name | Example |
|---|---|
contact_sample | true |
{
"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": "cupidatat sit commodo",
"field": "ut esse",
"message": "non",
"parameter": "sunt consectetur Duis in sed"
},
{
"error_id": "in dolore esse aliquip sint",
"field": "eiusmod",
"message": "cillum esse veniam labore ut",
"parameter": "irure dolor ex"
}
]PATCH
{
"name": "updated-list-name"
}{
"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": "adipisicing quis",
"field": "cupidatat id proident",
"message": "nisi",
"parameter": "nostrud quis voluptate ut"
},
{
"error_id": "ipsum cillum",
"field": "elit minim deserunt sit aliqua",
"message": "quis",
"parameter": "dolore ut consectetur exercitation consequat"
}
]
}{}DELETE
| Query Parameter Name | Example |
|---|---|
delete_contacts | true |
{
"job_id": "abc12312-x3y4-1234-abcd-123qwe456rty"
}culpa sit Duis{
"errors": []
}DELETE
| Query Parameter Name | Example |
|---|---|
contact_ids* | consectetur |
{
"job_id": "officia"
}{
"error_id": "dolor sint consequat et",
"field": "eiusmod proident ad",
"message": "Lorem esse in eu",
"parameter": "voluptate"
}{
"description": "If the specified list id does not exist. If the specified contact does not exist."
}Custom Fields(4 operations)
POST
{
"name": "custom_field_name",
"field_type": "Text"
}{
"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 mollit",
"field": "dolor esse sunt",
"message": "dolore dolore reprehenderit in",
"parameter": "proident fugiat pariatur dolore irure"
},
{
"error_id": "tempor est ex consectetur",
"field": "in",
"message": "Ut enim commodo aliqua",
"parameter": "dolor"
}
]
}GET
{
"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"
}
}PATCH
{
"name": "new_custom_field_name"
}{
"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": "nulla dolore Duis nisi",
"field": "id Excepteur",
"message": "tempor",
"parameter": "occaecat sed"
},
{
"error_id": "ea aliqua dolor",
"field": "aliqua Duis minim anim ipsum",
"message": "Lorem veniam ullamco",
"parameter": "commodo"
},
{
"error_id": "irure sed ipsum",
"field": "tempor nostrud",
"message": "aute dolore",
"parameter": "officia proident exercitation Excepteur minim"
}
]
}{
"errors": [
{
"error_id": "nulla culpa mollit",
"field": "eu cupidatat",
"message": "in",
"parameter": "Duis labore"
},
{
"error_id": "amet anim sint exercitation ullamco",
"field": "sed irure sint nisi adipisicing",
"message": "consequat sunt",
"parameter": "elit magna ut Duis in"
},
{
"error_id": "laboris cupidatat veniam",
"field": "laboris",
"message": "amet laborum culpa anim",
"parameter": "exercitation anim"
},
{
"error_id": "sed incididunt eiusmod",
"field": "nostrud qui laborum minim fugiat",
"message": "magna exercitation Lorem in",
"parameter": "id in"
},
{
"error_id": "dolor",
"field": "incididunt",
"message": "sunt",
"parameter": "consequat cillum reprehenderit adipisicing"
}
]
}DELETE
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"error_id": "elit cillum",
"field": "dolore",
"message": "voluptate incididunt",
"parameter": "quis"
},
{
"error_id": "dolor sint",
"field": "dolore Lorem incididunt ipsum",
"message": "non exercitation pariatur sit Lorem",
"parameter": "tempor aliqua"
}
]
}segmenting contacts(5 operations)
POST
{
"name": "enim quis labore ut",
"parent_list_id": "8c0bb17d-b7aa-6000-77c3-b4db4bfa6962",
"parent_list_ids": [
"occaecat",
"dolor enim",
"deserunt sed Lorem irure"
],
"query_dsl": "cupidatat reprehenderit incididunt fugiat eu"
}{
"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": "commodo dolore in Lorem"
},
{
"message": "veniam consectetur"
},
{
"message": "non sint quis"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
parent_list_ids | nostrud eu cupidatat |
no_parent_list_id | true |
{
"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": "tempor"
},
{
"message": "voluptate sit eiusmod anim"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
query_json | true |
{
"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": "do",
"message": "laboris ad"
},
{
"field": "dolore voluptate culpa Duis",
"message": "Duis occaecat"
},
{
"field": "in veniam Ut elit culpa",
"message": "veniam dolor velit"
}
]
}{
"errors": [
{
"message": "aute"
},
{
"message": "esse sint in ex qui"
}
]
}PATCH
{
"name": "in sin",
"parent_list_ids": [
"sint non",
"laborum est dolor minim deserunt",
"et nisi Ut aute",
"dolor minim"
],
"query_dsl": "Ut voluptate quis sed do"
}{
"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": "qui nisi cupidatat do",
"message": "sed nulla adipisicing aliqua eu"
},
{
"field": "nisi dolore commodo",
"message": "ut qui officia"
},
{
"field": "reprehenderit",
"message": "reprehenderit ullamco sint"
}
]
}{
"errors": [
{
"message": "anim reprehenderit sint"
},
{
"message": "enim"
}
]
}DELETE
{}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "eiusmod ex",
"message": "ut ut laboris"
}
]
}{
"errors": [
{
"message": "in pariatur amet"
},
{
"message": "consectetur tempor sit eiusmod ea"
},
{
"message": "Duis"
},
{
"message": "magna eu tempor sunt"
},
{
"message": "tempor ipsum velit ullamco est"
}
]
}Segmenting Contacts
POST
{
"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"
]
}{
"errors": [
{
"error": "esse",
"id": "quis labore",
"resources": {
"ids": [
"Excepteur",
"consectetur ea ut",
"do culpa"
],
"type": "elit"
}
},
{
"error": "qui in Ut",
"id": "id dolore Ut Excepteur",
"resources": {
"ids": [
"aute irure sint Lorem sed",
"laborum",
"eu dolore",
"id"
],
"type": "sint Duis exercitation"
}
}
]
}{}{
"errors": [
{
"field": "id consequat consectetur",
"message": "et cupidatat culpa"
},
{
"field": "dolor",
"message": "sunt qui"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "enim aute"
}
]
}Single Sends(11 operations)
POST
{
"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
}
}{
"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": "do Lorem veniam consectetur aliqua",
"field": "enim mollit eu adipisicing pariatur",
"message": "cupidatat sunt commodo"
}
]
}{
"errors": [
{
"error_id": "voluptate sit",
"field": "sint incididunt proident",
"message": "fugiat"
},
{
"error_id": "ipsum",
"field": "ea aliquip",
"message": "proident do culpa quis"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
page_size | 11880253 |
page_token | ea Excepteur adipisicing aute |
{
"_metadata": {
"count": 23508219,
"next": "https://NwE.bsxBOY151nwlyV0XdCxEY5wvah-96cf+sdi6lUrXJJrXvpIesq7V66Had+wdmI3OW5A",
"prev": "https://mZQTuzmlLRRJCYnpMcElO.onckLzPkAHLmfR",
"self": "https://MwKKUYkqU.pkma-,Wm.qerfcZhD9CMKE.40BkbuWvMfGyTfZDZpCZ6JyeaFQLrDM7wdoc6SGk"
},
"result": [
{
"abtest": {
"duration": "consequat in nostrud tempor",
"expiration_date": "officia Ut culpa",
"test_percentage": -94360442,
"type": "subject",
"winner_criteria": "open",
"winner_selected_at": null,
"winning_template_id": "qui"
},
"categories": [
"Excepteur do",
"eiusmod et pariatur veniam",
"et in",
"anim magna",
"Duis ea et id",
"proident voluptate Excepteur magna",
"laborum esse in quis",
"nostrud ullamco",
"consequat sunt ad in",
"id tempor proident magna"
],
"created_at": "1925-06-23T17:18:06.0Z",
"id": "6d8595a9-dc69-79b7-36be-738ed4886389",
"is_abtest": true,
"name": "officia est aliqua",
"send_at": "1948-12-10T16:41:24.0Z",
"status": "draft",
"updated_at": "1904-09-14T03:38:41.0Z"
},
{
"abtest": {
"duration": "enim dolore",
"expiration_date": "irure labore",
"test_percentage": -43067486,
"type": "subject",
"winner_criteria": "click",
"winner_selected_at": null,
"winning_template_id": "cillum eu ad in exercitation"
},
"categories": [
"labore qui ut",
"exercitation qui officia in",
"in ea nulla",
"veniam",
"in aliqua fugiat nulla",
"do in sed",
"aute sunt nulla ad et",
"in ad tempor in ipsum",
"nisi anim culpa ea est",
"veniam ea adipisicing magna ex"
],
"created_at": "1908-08-29T23:37:59.0Z",
"id": "cbd8bcb1-07a1-335b-65cb-efe4ef494734",
"is_abtest": true,
"name": "el",
"send_at": "1965-03-22T02:06:33.0Z",
"status": "scheduled",
"updated_at": "1931-09-21T15:10:16.0Z"
}
]
}{
"errors": [
{
"error_id": "ex officia",
"field": "Ut Excepteur eiusmod",
"message": "fugiat voluptate"
},
{
"error_id": "minim ea dolor incididunt culpa",
"field": "laborum non veniam",
"message": "nulla ut Ut in"
},
{
"error_id": "ea",
"field": "sed elit laboris ea ipsum",
"message": "dolore"
}
]
}DELETE
| Query Parameter Name | Example |
|---|---|
ids | ["ut aliqua in consequat","culpa non incididunt dolore velit","eu consequat","ut et sint qui laborum","non aliquip","labore incididunt in","enim dolore qui cillum fugiat","Duis esse dolor","ullamco proident incididunt in","ex eu incididunt"] |
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"error_id": "nulla",
"field": "in",
"message": "id magna sint est"
}
]
}{
"errors": [
{
"error_id": "ullamco dolor labore",
"field": "sit eiusmod ex adipisicing ea",
"message": "cillum"
}
]
}POST
{
"name": "aliquip velit dolor exercitation Ut"
}{
"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": "tempor",
"field": "velit",
"message": "in"
},
{
"error_id": "dolore cillum deserunt enim",
"field": "non dolor",
"message": "in ad"
},
{
"error_id": "mollit aliquip labore fugiat",
"field": "pariatur",
"message": "velit reprehenderit amet"
},
{
"error_id": "magna ea irure labore",
"field": "occaecat dolor ipsum",
"message": "fugiat"
},
{
"error_id": "ipsum ullamco ex",
"field": "Lorem officia",
"message": "nisi veniam culpa"
}
]
}{
"errors": [
{
"error_id": "sit",
"field": "magna Excepteur sed consequat exercitation",
"message": "cillum laboris laborum"
},
{
"error_id": "aute do",
"field": "Duis exercitation ad cillum dolore",
"message": "culpa"
},
{
"error_id": "ut sit nulla ea dolore",
"field": "dolore magna ipsum anim",
"message": "nisi ut ad"
}
]
}PATCH
{
"categories": [
"esse dolor laboris",
"irure ut aliquip sunt",
"ad",
"dolor",
"amet sint mollit",
"reprehenderit proident non elit sed",
"incididunt cupidatat culpa Excepteur dolore",
"Excepteur",
"exercitation enim",
"non occaecat deserunt"
],
"email_config": {
"custom_unsubscribe_url": null,
"design_id": "ex do deserunt elit",
"editor": "code",
"generate_plain_content": false,
"html_content": "nulla consequat deserunt ea",
"ip_pool": null,
"plain_content": "adipisicing laborum ut do",
"sender_id": null,
"subject": "ex veniam est",
"suppression_group_id": -84408829
},
"name": "culpa",
"send_at": "1952-02-27T11:30:51.0Z",
"send_to": {
"all": true,
"list_ids": [
"87ad9470-f332-1fdd-fdae-bd9f8fe1e73b",
"9925b257-50d8-43ca-66f4-7801ec71bb15",
"d92c19dc-df0f-3656-b1cb-a47ae5a85151",
"56515964-3e53-58fe-1d76-0de7285e5c28",
"8b755763-d9b8-a438-608e-62101a4bf928",
"f9879a88-704e-c7ff-5cd7-eb51d1618d10",
"f6382473-13ff-e694-8ee3-4d5708316a70",
"9bd7a947-ebd1-32ef-2f2f-215d67a0faa3",
"979b4ac0-86cb-ecf6-4579-15d1a7018c20",
"29e00d64-93bc-0818-fcf5-b626ecd49b09"
],
"segment_ids": [
"2b21a662-fac9-f7a5-e6d3-a18932cde2cd",
"0282e12e-1ac4-cb24-c1ad-3083c4d584f2",
"fe2bd0c3-f07a-a18a-3d31-35af74236e5a",
"66380ae1-0a39-fc37-469d-c84681551e23",
"39435785-0f02-93f5-a4a6-314516b3fef5",
"c6eeba9e-055f-22f7-00bc-e4a004f2d318",
"9441c465-fed9-2cad-134a-8c020de70eb2",
"92d5018b-7415-0188-5204-d0f500b4b41a",
"c0aa3849-81ea-1a4c-8106-28c980a059f5",
"ebc0481a-5392-3350-b966-f98ef4575c64"
]
}
}{
"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": "ex fugiat proident aliquip",
"field": "labore magna minim in",
"message": "labore veniam ex magna"
},
{
"error_id": "est dolor commodo",
"field": "consequat in amet cillum",
"message": "aute voluptate laborum exercitation sunt"
}
]
}{
"errors": [
{
"error_id": "elit sunt ex laborum",
"field": "ex in eiusmod ea",
"message": "ipsum"
}
]
}{
"errors": [
{
"error_id": "irure anim dolore nostrud",
"field": "amet do id",
"message": "non eu"
}
]
}GET
{
"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": "fugiat cupidatat",
"field": "eu id Duis irure aute",
"message": "enim labore"
},
{
"error_id": "dolore",
"field": "nisi",
"message": "nostrud aute"
},
{
"error_id": "mollit officia labore minim cupidatat",
"field": "eiusmod aliquip labore eu",
"message": "incididunt nostrud aliquip"
},
{
"error_id": "fugiat reprehenderit",
"field": "sit",
"message": "in voluptate magna"
}
]
}{
"errors": [
{
"error_id": "esse veniam sed",
"field": "aliquip incididunt dolor magna",
"message": "Ut nulla consectetur reprehenderit"
},
{
"error_id": "non irure dolore proident",
"field": "est ut",
"message": "aliquip sed cillum"
},
{
"error_id": "ad esse",
"field": "elit aute eu sed",
"message": "sunt sint"
},
{
"error_id": "exercitation enim in veniam",
"field": "ea exercitation",
"message": "labore fugiat"
},
{
"error_id": "commodo occaecat",
"field": "cupidatat",
"message": "cupidatat"
}
]
}DELETE
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"error_id": "est",
"field": "reprehenderit aliqua ex ea",
"message": "adipisicing sint aliquip Excepteur elit"
},
{
"error_id": "nulla",
"field": "fugiat anim commodo aliquip exercitation",
"message": "dolor culpa ut cillum"
},
{
"error_id": "est id adipisicing",
"field": "elit tempor anim",
"message": "laborum mollit"
},
{
"error_id": "adipisicing enim consequat tempor sunt",
"field": "pariatur labore Lorem",
"message": "aliquip"
},
{
"error_id": "dolor labore",
"field": "cupidatat aliqua",
"message": "eiusmod aliquip proident"
}
]
}{
"errors": [
{
"error_id": "nostrud",
"field": "laboris",
"message": "ad"
},
{
"error_id": "proident Excepteur",
"field": "proident",
"message": "reprehenderit eiusmod id Ut"
}
]
}POST
| Query Parameter Name | Example |
|---|---|
page_size | -59004454 |
page_token | incididunt dolor |
{
"name": "specific-single-send-name",
"status": [
"draft",
"scheduled"
],
"categories": [
"shoes"
]
}{
"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": "eu dolor",
"field": "dolore laboris",
"message": "non sunt ullamco anim"
},
{
"error_id": "anim",
"field": "incididunt esse est",
"message": "aute in eu"
},
{
"error_id": "magna consectetur nisi minim do",
"field": "dolor voluptate",
"message": "consectetur"
},
{
"error_id": "aliquip consequat officia incididunt minim",
"field": "adipisicing commodo cupidatat",
"message": "magna"
},
{
"error_id": "dolore nostrud",
"field": "do sit qui",
"message": "amet do culpa aliqua"
}
]
}PUT
{
"send_at": "3752-01-28T23:21:52.575Z"
}{
"send_at": "3752-01-28T23:21:52.575Z",
"status": "scheduled"
}{
"errors": [
{
"error_id": "quis velit",
"field": "ex do",
"message": "proident nulla ea do elit"
}
]
}{
"errors": [
{
"error_id": "enim aliquip",
"field": "sunt dolor irure ut fugiat",
"message": "in"
},
{
"error_id": "culpa eu",
"field": "consequat do ad in occaecat",
"message": "dolor"
},
{
"error_id": "qui aliqua cillum proident",
"field": "magna Ut deserunt",
"message": "Excepteur dolore dolore officia"
},
{
"error_id": "minim",
"field": "exercitation",
"message": "labore tempor et officia"
},
{
"error_id": "cillum deserunt",
"field": "in Lorem est",
"message": "sed cupidatat do aliqua ad"
}
]
}DELETE
{
"send_at": "1921-04-16T01:50:27.0Z",
"status": "scheduled"
}{
"errors": [
{
"error_id": "magna cillum",
"field": "enim",
"message": "do quis ipsum cupidatat qui"
},
{
"error_id": "reprehenderit Duis velit mollit elit",
"field": "nostrud est enim",
"message": "aliqua officia sint deserunt"
},
{
"error_id": "exercitation eu commodo",
"field": "id",
"message": "aliquip irure incididunt"
},
{
"error_id": "amet dolor laboris",
"field": "amet sunt aliqua veniam",
"message": "aliquip"
},
{
"error_id": "culpa non voluptate Duis in",
"field": "proident ex est eu",
"message": "esse occaecat"
}
]
}{
"errors": [
{
"error_id": "in anim eu magna ullamco",
"field": "Duis esse",
"message": "non nostrud"
},
{
"error_id": "tempor",
"field": "esse tempor proident anim",
"message": "in"
},
{
"error_id": "deserunt",
"field": "dolore commodo exercitation",
"message": "culpa in"
},
{
"error_id": "consectetur laboris quis ex",
"field": "sint elit proident",
"message": "Duis sed labore ex fugiat"
}
]
}GET
{
"categories": [
"equipment",
"shoes",
"sports"
]
}{
"errors": [
{
"error_id": "sunt velit occaecat fugiat",
"field": "eiusmod",
"message": "et non"
},
{
"error_id": "veniam ex aute",
"field": "Ut deserunt id",
"message": "nostrud"
},
{
"error_id": "sint magna esse cupidatat",
"field": "sint reprehenderit ex non",
"message": "Duis enim veniam reprehenderit minim"
},
{
"error_id": "aliqua tempor sed sit",
"field": "anim laboris dolore",
"message": "Ut amet eu in"
},
{
"error_id": "Lorem quis sint sit",
"field": "ex reprehenderit proident",
"message": "elit qui fugiat adipisicing"
}
]
}Send Test Email
POST
{
"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"
]
}{}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Marketing Campaigns Stats(8 operations)
GET
| Query Parameter Name | Example |
|---|---|
automation_ids | ["velit ut commodo","sed officia consectetur","dolor elit officia magna do","labore consectetur enim","ad veniam aute","in ad dolore","nostrud","consequat ullamco dolore fugiat","deserunt magna","culpa in voluptate aliquip est"] |
page_size | 71 |
page_token | non velit Duis deserunt |
{
"_metadata": {
"count": 53356767.9837549,
"next": "https://LaAqlAZLXQUGoy.acykdWCeLAw0XRqr-1awh-Zj2JF0+rkGC",
"prev": "http://UsZZswvcDSGCfKfOakufvRXWiiCDsYlZ.fdmDRcjmr6mzF1E1n-W6vmOOXnNqdaD",
"self": "https://EWIHHqxpAOLqLyyPPgzcUUcYiYqAEqIQ.mchcEjn0JaEHe7i2TZkRq2gREuefk4H1qgu1CaK9pqY+IzMgC,wV"
},
"results": [
{
"aggregation": "ea quis tempor",
"id": "977a400c-4579-d2df-7e24-41ba66c5c5ef",
"stats": {
"bounce_drops": 64597236,
"bounces": 81796345,
"clicks": -92764302,
"delivered": -86862137,
"invalid_emails": 52671310,
"opens": 254305,
"requests": -17167874,
"spam_report_drops": 34615595,
"spam_reports": 45597494,
"unique_clicks": 58586594,
"unique_opens": -76775732,
"unsubscribes": 73992492
},
"step_id": "pariatur ipsum labore ullamco"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
group_by | ["step_id","step_id"] |
step_ids | ["33bcb68c-3f9c-832c-063e-07267327680c","d85804a4-c45a-cc9f-844d-b5c243fdc2fb","6d7741b7-5910-4d2e-2bd8-85755790176a"] |
aggregated_by | total |
start_date | 1963-05-26 |
end_date | 1954-04-27 |
timezone | eu laboris elit sit et |
page_size | 18 |
page_token | sed incididunt |
{
"_metadata": {
"count": -54971398.498252854,
"next": "https://diJiKEEDGyiuRPFKn.xmkgkI0F2HQuGYuIrmAYqdwL,ShW+G-yg-hDwxDAVz5InkmJ92MIbG6Ngn+Q",
"prev": "http://lReceJpdBE.zjyYCmROcZa",
"self": "http://P.sfl8PHsG6eTpkrNVAyGaF"
},
"results": [
{
"aggregation": "laborum Ut incididunt",
"id": "e3ff29cf-224e-0192-77df-bb5858669928",
"stats": {
"bounce_drops": -24780837,
"bounces": -82949368,
"clicks": 47964425,
"delivered": -66097677,
"invalid_emails": 5390288,
"opens": 66757333,
"requests": 67585553,
"spam_report_drops": 45714300,
"spam_reports": 39760158,
"unique_clicks": 10684860,
"unique_opens": 89766546,
"unsubscribes": -37909909
},
"step_id": "dolore ad"
},
{
"aggregation": "Duis sit dolore",
"id": "01bbeb10-f17f-66d3-0625-d620011c1360",
"stats": {
"bounce_drops": 77437659,
"bounces": 94090090,
"clicks": -89136742,
"delivered": -94528200,
"invalid_emails": -20794930,
"opens": -18622684,
"requests": -62244052,
"spam_report_drops": -19889254,
"spam_reports": 28357695,
"unique_clicks": -28973041,
"unique_opens": -47074277,
"unsubscribes": 56497451
},
"step_id": "minim proident esse incididunt ea"
},
{
"aggregation": "cupidatat eiusmod consectetur voluptate sunt",
"id": "bf0c63fd-e3fa-efbb-1761-86178a2afc96",
"stats": {
"bounce_drops": -58881184,
"bounces": -39010289,
"clicks": 63470046,
"delivered": -62054356,
"invalid_emails": -3022060,
"opens": -4221410,
"requests": 65913030,
"spam_report_drops": 98035105,
"spam_reports": 81805295,
"unique_clicks": 81478405,
"unique_opens": 53108591,
"unsubscribes": -387255
},
"step_id": "laboris"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
singlesend_ids | ["adipisicing","eiusmod Excepteur","sed","enim eu deserunt ea do","consequat commodo","voluptate dolor ut","irure Excepteur sint anim","ullamco velit laboris","sit dolor","anim nisi"] |
page_size | 74 |
page_token | exercitation et consectetur qui |
{
"_metadata": {
"count": -71892688.69312806,
"next": "https://wGLZsPEg.nsoIrNyb.CngJbfN1mfEsND7mUv9UyFoTWbNlsHaxZtaT6KYk",
"prev": "http://RPuOMTPtdzMRbzlcGHBxUKGxPBinoE.jejx3FoKYZonsGR-PhJMtgk9u.trSRN",
"self": "https://UMVZvyJZNUGcQhDtRvDysnRfWaCiYJ.cotq29F+tkf.B6UTTYPBU.PjcyutDIZ+b.Z"
},
"results": [
{
"ab_phase": "send",
"ab_variation": "213c9fac-4a54-b536-b923-56bf45d64336",
"aggregation": "Duis sunt",
"id": "ced33e39-b3de-6cde-0426-014ebc157688",
"stats": {
"bounce_drops": 34233690,
"bounces": -9548458,
"clicks": 87150317,
"delivered": 29807406,
"invalid_emails": -44764541,
"opens": 81229449,
"requests": -37700130,
"spam_report_drops": -50684939,
"spam_reports": 15979049,
"unique_clicks": -95712479,
"unique_opens": 70794161,
"unsubscribes": -19448335
}
},
{
"ab_phase": "send",
"ab_variation": "bd7d84bc-9faf-613a-ec28-d98e1acf1e4f",
"aggregation": "consequat sit",
"id": "2169b680-2714-6e45-bbf3-604ecf896917",
"stats": {
"bounce_drops": -5123410,
"bounces": 50032652,
"clicks": -30378655,
"delivered": 39692144,
"invalid_emails": -76059438,
"opens": -50580703,
"requests": 95309016,
"spam_report_drops": 76062469,
"spam_reports": -12337270,
"unique_clicks": -81364238,
"unique_opens": 17753314,
"unsubscribes": 61376174
}
},
{
"ab_phase": "test",
"ab_variation": "f0978252-0f19-b707-952a-ac767eb00e09",
"aggregation": "proident eu velit",
"id": "837c2d5d-1574-aa49-3ee5-cafc073c7d8c",
"stats": {
"bounce_drops": 67008048,
"bounces": 88657523,
"clicks": -75563712,
"delivered": -77682234,
"invalid_emails": 54430813,
"opens": 10466941,
"requests": 74205818,
"spam_report_drops": 50780072,
"spam_reports": 59865185,
"unique_clicks": 48575680,
"unique_opens": -10478274,
"unsubscribes": -45121531
}
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
aggregated_by | day |
start_date | 1938-07-17 |
end_date | 1943-11-04 |
timezone | labore |
page_size | 56 |
page_token | amet in voluptate |
group_by | ["ab_phase","ab_variation","ab_variation","ab_variation","ab_variation"] |
{
"_metadata": {
"count": 85002514.25474742,
"next": "https://VCLpQNbLZMjLdnjCoqvHWmmTLOdubVe.urpkeShkeJp0",
"prev": "http://gxLSjgbHnNcLzLNJEspNRfYIEiRTFKkJ.pdjeuO8",
"self": "https://JlTDpiJjpjJapSXvdhbHFBISysTO.djntP-cj5ZJz1fi5DgxMsOjifjBD6bV"
},
"results": [
{
"ab_phase": "test",
"ab_variation": "5421afa5-5975-5e5b-b829-49e8cb10462e",
"aggregation": "in anim aliquip",
"id": "4aa1e7aa-ac34-f557-d864-7628b31fcb4d",
"stats": {
"bounce_drops": -51475036,
"bounces": -22384935,
"clicks": 57394995,
"delivered": 12313060,
"invalid_emails": 23506376,
"opens": -45385067,
"requests": 66001465,
"spam_report_drops": 38520268,
"spam_reports": -40908309,
"unique_clicks": 27630123,
"unique_opens": -28451235,
"unsubscribes": -32688196
}
},
{
"ab_phase": "send",
"ab_variation": "b0b8c20f-138d-fc58-9f50-8a0acb14a5ec",
"aggregation": "aliquip id cupidatat",
"id": "4dbb24dc-0eed-750a-2c57-b633fb8a28b5",
"stats": {
"bounce_drops": 90790952,
"bounces": -29501239,
"clicks": 19218641,
"delivered": 11302583,
"invalid_emails": 48756997,
"opens": -52010607,
"requests": -93612205,
"spam_report_drops": 42746056,
"spam_reports": 87051185,
"unique_clicks": 87809817,
"unique_opens": 13074769,
"unsubscribes": -61430805
}
},
{
"ab_phase": "send",
"ab_variation": "12012591-d2c9-69cc-e0c3-9075858e394a",
"aggregation": "quis consequat in labore aliqua",
"id": "8c2c81d2-619c-3a37-624c-68ae3bbf0042",
"stats": {
"bounce_drops": 76972148,
"bounces": 76906687,
"clicks": -28823224,
"delivered": -19751528,
"invalid_emails": -49429238,
"opens": -86832471,
"requests": -67631806,
"spam_report_drops": -31792201,
"spam_reports": 365901,
"unique_clicks": -36641752,
"unique_opens": 16797668,
"unsubscribes": -61013056
}
},
{
"ab_phase": "send",
"ab_variation": "0ed2aca4-ed18-03e3-3b20-b9b8568afddc",
"aggregation": "tempor sed officia ea incididunt",
"id": "ec939692-9839-5c74-47a7-c69fd3bd8964",
"stats": {
"bounce_drops": 39070,
"bounces": 70696085,
"clicks": 26801705,
"delivered": 1375198,
"invalid_emails": -48135296,
"opens": 75747660,
"requests": 30015994,
"spam_report_drops": -80480043,
"spam_reports": 30512908,
"unique_clicks": -28059271,
"unique_opens": -51527267,
"unsubscribes": -14849232
}
},
{
"ab_phase": "all",
"ab_variation": "f101221d-8c65-f825-0b39-f91bb0460b0c",
"aggregation": "ipsum",
"id": "02bb8eee-ebfc-8e1e-fb11-0d402229a13b",
"stats": {
"bounce_drops": -10661664,
"bounces": -21017325,
"clicks": 4863776,
"delivered": 15231143,
"invalid_emails": -94771217,
"opens": 39055351,
"requests": 88200505,
"spam_report_drops": 39425730,
"spam_reports": 87199180,
"unique_clicks": 14211889,
"unique_opens": 97265685,
"unsubscribes": 95383253
}
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
group_by | ["step_id","step_id"] |
step_ids | ["0a68f4f9-dec2-d08e-3b7b-cf53c19b0820"] |
page_size | 47 |
page_token | minim |
{
"_metadata": {
"count": -32586054.62640664,
"next": "https://lhTkUHnfPpuWTMbFSNdOHP.yuiYOwSclurpaM+rsqfjS6XtYVSrfp8qdsKSZ,WnwhiIuAu3e5xhJOG7tIMMJxT9Cg",
"prev": "http://yQWwAoMqkiKPsRqdbjtiBgdRnpcrNN.otjiNd4QFwAYPEXDP",
"self": "http://xDzCNXxst.teHCql1CeFY6EJBG"
},
"results": [
{
"clicks": 69268227,
"step_id": "a585753f-412a-7975-487b-fce58dfc5451",
"url": "https://e.veij49d,fY8O713muplunh3FABSiMP-SzFwNvIZjhZt0WCR,3vfT",
"url_location": 86360343
}
],
"total_clicks": 16596037
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
page_size | 69 |
page_token | esse mollit ullamco sit |
group_by | ["ab_phase","ab_phase","ab_variation","ab_variation","ab_variation"] |
ab_variation_id | d5431b6a-a152-b906-aa64-4b5d269cf712 |
ab_phase_id | send |
{
"_metadata": {
"count": 91117516.8579525,
"next": "http://hLnNBmdOjBo.wgcj289-H+FwyN7pEE2j5xEYAaPAF+d68Ll3gwl0H0TDBSc2,leWqCT4dCz.t3uzwyoBQOuUc",
"prev": "https://VPROSxkhCXNezBPDAlTTXBgpswMS.sjtt",
"self": "http://MDpASAzQwZmLsKNviYu.miiQKinp4"
},
"results": [
{
"ab_phase": "test",
"ab_variation": "c236e94e-f5c5-0bba-7ebe-7c067106054d",
"clicks": 50408259,
"url": "https://dTROD.ccpUTrKeYbaifSA04bEFZUFRj0aRbj2++hrG52iOdhftSar+rlLM0.+",
"url_location": 84992127
}
],
"total_clicks": -77310277
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{}GET
| Query Parameter Name | Example |
|---|---|
ids | ["officia qui aute voluptate","pariatur fugiat dolor et ullamco","laborum amet irure","est","cupidatat amet qui proident","eu cillum sed Ut id","in labore dolore Excepteur elit","culpa consectetur nostrud","ipsum ex ad","commodo ipsum culpa adipisicing do"] |
timezone | ea Duis reprehenderit in |
in incididunt eaMissing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
ids | ["in qui sint officia","cupidatat mollit commodo","culpa proident Lorem","irure ullamco commodo Duis cillum","dolor","dolore","velit tempor culpa sit","officia ad labore","consequat mollit ut in","voluptate ad velit sint esse"] |
timezone | cupidatat pariatur |
laboris deserunt exercitation non voluptate{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Sender Identities API(6 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "ut cupidatat in Duis" |
{
"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"
}{
"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"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "Ut Excepteur non adipisicing" |
{
"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
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "exercitation" |
{
"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"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "sint" |
{
"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"
}{
"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"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "laborum aute magna incididunt" |
{}{
"errors": [
{
"message": "You may only delete a sender identity when it is unlocked.",
"field": "locked"
}
]
}{
"errors": [
{
"message": "resource not found",
"field": "id"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "cillum quis" |
{}{
"errors": [
{
"message": "The Sender Identity is already verified. No email sent.",
"field": ""
}
]
}{
"errors": [
{
"message": "resource not found",
"field": "id"
}
]
}Contacts API - Lists(10 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "proident Lorem mollit" |
{
"name": "your list name"
}{
"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"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "dolor" |
{
"lists": [
{
"id": 1,
"name": "the jones",
"recipient_count": 1
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "velit" |
[
1,
2,
3,
4
]Error generating example{
"errors": [
{
"field": null,
"message": "list id was invalid"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
list_id | 68729969 |
| Header Name | Example |
|---|---|
on-behalf-of | "pariatur eiusmod elit" |
{
"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"
}
]
}PATCH
| Query Parameter Name | Example |
|---|---|
list_id* | -5657835 |
| Header Name | Example |
|---|---|
on-behalf-of | "elit ipsum" |
{
"name": "newlistname"
}{
"id": 1234,
"name": "2016 iPhone Users",
"recipient_count": 0
}{
"errors": [
{
"message": "invalid id"
}
]
}{
"errors": [
{
"message": "List ID does not exist"
}
]
}DELETE
| Query Parameter Name | Example |
|---|---|
delete_contacts | true |
| Header Name | Example |
|---|---|
on-behalf-of | "consectetur reprehenderit aliquip" |
Error generating exampleError 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"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
page | -25395428 |
page_size | -39300091 |
list_id* | -24978126 |
| Header Name | Example |
|---|---|
on-behalf-of | "occaecat reprehenderit tempor dolore" |
{
"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"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "et" |
[
"recipient_id1",
"recipient_id2"
]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"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "nisi et dolor labore" |
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"
}
]
}DELETE
| Query Parameter Name | Example |
|---|---|
list_id* | -9594410 |
recipient_id* | -95384758 |
| Header Name | Example |
|---|---|
on-behalf-of | "elit dolore nisi eu" |
Error generating exampleError 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)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "dolore ad fugiat do magna" |
[
{
"email": "example@example.com",
"first_name": "",
"last_name": "User",
"age": 25
},
{
"email": "example2@example.com",
"first_name": "Example",
"last_name": "User",
"age": 25
}
]{
"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"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "ex ullamco qui adipisicing" |
[
{
"email": "jones@example.com",
"last_name": "Jones",
"first_name": "Guy"
}
]{
"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"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "ex aliqua culpa ipsum" |
[
"recipient_id1",
"recipient_id2"
]{}{
"errors": [
{
"message": "No recipient ids provided"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
page | 55840752 |
page_size | 55747577 |
| Header Name | Example |
|---|---|
on-behalf-of | "nostrud nisi elit" |
{
"recipients": []
}{}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "sunt non ex" |
{
"status": [
{
"id": "worker_delay",
"value": "delayed"
},
{
"id": "worker_delay_seconds",
"value": "75.0"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "labore consequat eiusmod ipsum id" |
{
"recipients": [
{
"created_at": -59092164.39858751,
"custom_fields": [
{
"name": "first_name",
"type": "text"
}
],
"email": "nnXQsJT9rv@scUGRWKSOGdyArEusxulgdIqbYqZf.hyj",
"first_name": null,
"id": "sed dolor",
"last_clicked": -59211210.829702,
"last_emailed": 24978796.830291077,
"last_name": null,
"last_opened": null,
"updated_at": 16480897.070287347
},
{
"created_at": 85168769.41800785,
"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": "rmoxvtM1vXRCdSx@nhnfbgCPWLjUaVwsGXJUpLljCCaFgaa.yf",
"first_name": null,
"id": "consectetur occaecat",
"last_clicked": 76812216.78266478,
"last_emailed": 13408980.439071923,
"last_name": "nisi esse eu",
"last_opened": null,
"updated_at": 21977278.264565885
}
]
}{}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "dolor in consectetur" |
{}{
"errors": [
{
"field": null,
"message": "recipient not found"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"field": null,
"message": "recipient_id is not valid"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "Excepteur commodo deserunt ad sed" |
{
"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"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "officia" |
{
"recipient_count": 1234
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "eu mollit in ad" |
{
"recipient_count": 1234
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
{field_name} | tempor dolor |
| Header Name | Example |
|---|---|
on-behalf-of | "ea consequat" |
{
"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"
}
]
}POST
{
"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"
}
]
}{
"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)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "velit occaecat quis" |
{
"name": "pet",
"type": "text"
}{
"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"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "eu veniam exercitation" |
{
"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"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "proident laborum" |
{
"id": 1,
"name": "pet",
"type": "text"
}{
"errors": [
{
"message": "invalid id"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"message": "Custom field ID does not exist"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "proident sit est cillum veniam" |
{
"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"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "aliqua in" |
{
"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)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "Excepteur eu" |
{
"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"
}
]
}{
"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"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "est in" |
{
"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"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
segment_id* | 79280566 |
| Header Name | Example |
|---|---|
on-behalf-of | "incididunt" |
{
"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"
}
]
}PATCH
| Query Parameter Name | Example |
|---|---|
segment_id | Ut non id sunt ad |
| Header Name | Example |
|---|---|
on-behalf-of | "cupidatat velit deserunt nostrud" |
{
"name": "The Millers",
"list_id": 5,
"conditions": [
{
"field": "last_name",
"value": "Miller",
"operator": "eq",
"and_or": ""
}
]
}{
"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"
}
]
}DELETE
| Query Parameter Name | Example |
|---|---|
delete_contacts | true |
| Header Name | Example |
|---|---|
on-behalf-of | "occaecat nulla consequat non" |
Error generating exampleError 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"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
page | -18575913 |
page_size | 47361088 |
| Header Name | Example |
|---|---|
on-behalf-of | "officia sint ipsum dolor" |
{
"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)
GET
| Query Parameter Name | Example |
|---|---|
limit | -63421513 |
category | aute elit occaecat fugiat |
offset | 2186288 |
| Header Name | Example |
|---|---|
on-behalf-of | "tempor ut sunt eu" |
[
{
"category": "category 1"
},
{
"category": "category 2"
}
]{
"errors": [
{
"field": "sort_by",
"message": "invalid sort value"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
sort_by_metric | ea |
sort_by_direction | desc |
start_date* | sunt sint |
end_date | tempor dolore deserunt Duis |
limit | -23662421 |
offset | 30262526 |
aggregated_by | day |
| Header Name | Example |
|---|---|
on-behalf-of | "ea eiusmod anim" |
{
"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"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
start_date* | sit laborum sint id aliquip |
end_date | dolore fugiat incididunt in adipisicing |
categories* | magna aliqua laborum enim occaecat |
limit | -58421885 |
offset | 79951796 |
aggregated_by | week |
| Header Name | Example |
|---|---|
on-behalf-of | "Lorem" |
[
{
"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)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "ex" |
{
"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!"
}{
"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."
}
]
}{}GET
| Query Parameter Name | Example |
|---|---|
limit | 84257733 |
offset | 74619021 |
| Header Name | Example |
|---|---|
on-behalf-of | "dolore consectetur deserunt ad" |
{
"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"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "aliqua nulla consequat" |
{
"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"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "laboris" |
Error generating example{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "aute commodo mollit" |
{
"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!"
}{
"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"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "aute eiusmod" |
{
"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"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "nisi nulla cillum pariatur" |
{
"send_at": 1489771528
}{
"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"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "reprehenderit in" |
{
"send_at": 1489451436
}{
"id": -78195445,
"send_at": 90496047,
"status": "deserunt voluptate ipsum Excepteur"
}{
"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"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "esse aliqua commodo non Duis" |
{
"send_at": 1490778528
}{
"errors": [
{
"field": null,
"message": "not found"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "id non Lorem" |
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"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "occaecat consequat in nisi" |
{
"to": "your.email@example.com"
}{
"to": "est nulla"
}{
"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)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "labore proident consequat sunt irure" |
{
"name": "example_name",
"generation": "dynamic"
}{
"id": "733ba07f-ead1-41fc-933a-3976baa23716",
"name": "example_name",
"generation": "legacy",
"versions": []
}GET
| Query Parameter Name | Example |
|---|---|
generations | dynamic |
page_size* | 52.38970568716553 |
page_token | nostrud ut |
| Header Name | Example |
|---|---|
on-behalf-of | "esse" |
{
"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": [
{
"": "eu dolore",
"error_id": "ad velit dolor",
"message": "eiusmod"
},
{
"": "Duis qui ad cupidatat est",
"error_id": "Excepteur",
"message": "in consequat cupidatat"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "aute tempor nulla sed" |
{
"name": "example_name"
}{
"id": "733ba07f-ead1-41fc-933a-3976baa2371",
"name": "example_name",
"generation": "dynamic",
"updated_at ": "2019-03-13T11:52:41.009Z",
"versions": []
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "Lorem quis eiusmod" |
{
"id": "40da60e6-66f3-4223-9406-ba58b7f55a62",
"name": "Duis in dolor",
"generation": "legacy",
"updated_at ": "2020-12-12 58:26:65",
"versions": []
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "mollit enim anim" |
{
"name": "new_example_name"
}{
"id": "733ba07f-ead1-41fc-933a-3976baa23716",
"name": "new_example_name",
"versions": []
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "ut sit deserunt qui" |
{}Transactional Templates Versions(5 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "in labore esse sed" |
{
"active": 1,
"name": "example_version_name",
"html_content": "<HTML body content>",
"plain_content": "Plain text content",
"generate_plain_content": false,
"subject": "<Subject>",
"editor": "design"
}{
"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"
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "ut in velit eiusmod occaecat" |
{
"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"
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "dolore" |
{
"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"
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "enim" |
{
"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"
}{
"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"
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "anim nisi" |
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Webhooks(7 operations)
GET
| Header Name | Example |
|---|---|
on-behalf-of | "nostrud in qui" |
{
"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"
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "ea minim pariatur eiusmod" |
{
"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"
}{
"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"
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "eu officia ipsum in velit" |
{
"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": "adipisicing in"
},
{
"message": "sed eu"
},
{
"message": "do elit in esse"
},
{
"message": "officia"
},
{
"message": "aute reprehenderit labore eu"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
limit | laborum |
offset | reprehenderit qui ullamco |
aggregated_by | month |
start_date* | culpa et laborum |
end_date | tempor amet reprehenderit |
| Header Name | Example |
|---|---|
on-behalf-of | "nulla commodo ex ut" |
[
{
"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
}
}
]
}
]GET
| Header Name | Example |
|---|---|
on-behalf-of | "eu adipisicing" |
{
"public_key": "anim quis in sint"
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "Lorem" |
{
"enabled": true
}{
"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"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "sunt dolor exercitation" |
{
"url": "mollit non ipsum magna",
"oauth_client_id": "nisi",
"oauth_client_secret": "veniam commodo ex sunt",
"oauth_token_url": "dolor Duis"
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Settings - Inbound Parse(4 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "voluptate ad Excepteur" |
{
"url": "http://email.myhostname.com",
"hostname": "myhostname.com",
"spam_check": false,
"send_raw": true
}{
"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": "dolore aliqua ex"
},
{
"message": "ullamco ea ut"
},
{
"message": "mollit pariatur occaecat dolore laborum"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "id dolor Excepteur ipsum tempor" |
{
"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": "laborum sint esse"
},
{
"message": "tempor dolor nostrud Lorem"
},
{
"message": "ullamco do veniam enim"
},
{
"message": "Lorem cillum occaecat"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "voluptate occaecat adipisicing aliquip est" |
{
"url": "http://email.myhostname.com",
"hostname": "myhostname.com",
"spam_check": false,
"send_raw": true
}{
"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 proident reprehenderit dolor"
},
{
"message": "Duis elit"
},
{
"message": "quis ullamco sint occaecat fugiat"
},
{
"message": "consequat est ea deserunt Excepteur"
},
{
"message": "nostrud occaecat enim minim"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "pariatur quis" |
{}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "consequat enim ipsum"
}
]
}Query(2 operations)
GET
| Query Parameter Name | Example |
|---|---|
query* | laboris quis |
limit | 872.5733997498838 |
| Header Name | Example |
|---|---|
X-Query-Id | "aliquip laboris" |
X-Cursor | "qui amet ullamco" |
Authorization* | "culpa" |
{
"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"
}
]
}GET
| Header Name | Example |
|---|---|
Authorization* | "dolore" |
{
"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)
POST
| Query Parameter Name | Example |
|---|---|
query | esse |
| Header Name | Example |
|---|---|
Authorization* | "in do minim consequat ullamco" |
{
"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"
}
]
}GET
| Header Name | Example |
|---|---|
Authorization* | "Duis" |
{
"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)
GET
| Header Name | Example |
|---|---|
on-behalf-of | "nulla irure" |
{
"result": [
{
"name": "open",
"title": "Open Tracking",
"description": "lorem ipsum... .",
"enabled": true
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "dolore velit officia" |
{
"enable_text": false,
"enabled": true
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "laborum nostrud ipsum" |
{
"enabled": true
}{
"enable_text": false,
"enabled": true
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "ipsum" |
{
"enabled": true,
"utm_campaign": "",
"utm_content": "lotsandlotsofcontent",
"utm_medium": "",
"utm_source": "",
"utm_term": ""
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "consectetur" |
{
"enabled": true,
"utm_source": "sendgrid.com",
"utm_medium": "email",
"utm_term": "",
"utm_content": "",
"utm_campaign": "website"
}{
"enabled": true,
"utm_campaign": "",
"utm_content": "lotsandlotsofcontent",
"utm_medium": "",
"utm_source": "",
"utm_term": ""
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "minim dolor dolore" |
{
"enabled": true
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "ut occaecat" |
{
"enabled": true
}{
"enabled": true
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "ipsum in" |
{
"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": ""
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "ut" |
{
"enabled": true,
"landing": "landing page html",
"url": "url",
"replace": "replacement tag",
"html_content": "html content",
"plain_content": "text content"
}{
"enabled": true,
"landing": "landing page html",
"url": "url",
"replace": "replacement tag",
"html_content": "html content",
"plain_content": "text content"
}Stats(7 operations)
GET
| Query Parameter Name | Example |
|---|---|
limit | 12789724 |
offset | 63706326 |
aggregated_by | week |
start_date* | in incididunt proident |
end_date | nulla ex elit eiusmod dolor |
| Header Name | Example |
|---|---|
on-behalf-of | "consequat enim sed velit voluptate" |
[
{
"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
}
}
]
}
]GET
| Query Parameter Name | Example |
|---|---|
country | US |
limit | 74467642 |
offset | -63919325 |
aggregated_by | week |
start_date* | in officia |
end_date | et officia sed |
| Header Name | Example |
|---|---|
on-behalf-of | "et laborum ipsum id aliqua" |
[
{
"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
}
}
]
}
]GET
| Query Parameter Name | Example |
|---|---|
limit | -60721046 |
offset | -97787916 |
aggregated_by | week |
start_date* | occaecat Ut |
end_date | aliqua |
| Header Name | Example |
|---|---|
on-behalf-of | "fugiat est non" |
[
{
"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
}
}
]
}
]GET
| Query Parameter Name | Example |
|---|---|
start_date* | quis sit sed |
end_date | non dolor aliqua |
aggregated_by | week |
| Header Name | Example |
|---|---|
on-behalf-of | "ut eu qui" |
[
{
"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"
}
]
}
]GET
| Query Parameter Name | Example |
|---|---|
start_date* | in exercitation consectetur Lorem |
end_date | nisi veniam nulla dolor |
aggregated_by | day |
| Header Name | Example |
|---|---|
on-behalf-of | "occaecat ipsum aliquip sunt" |
[
{
"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"
}
]
}
]GET
| Query Parameter Name | Example |
|---|---|
mailbox_providers | nisi tempor elit officia occaecat |
limit | -42123604 |
offset | -40885608 |
aggregated_by | week |
start_date* | sed id Duis et enim |
end_date | nulla |
| Header Name | Example |
|---|---|
on-behalf-of | "non eu Ut sint" |
[
{
"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
}
}
]
}
]GET
| Query Parameter Name | Example |
|---|---|
browsers | officia |
limit | -12711268 |
offset | 93560415 |
aggregated_by | month |
start_date* | minim ut do dolor labore |
end_date | est velit ullamco Excepteur |
| Header Name | Example |
|---|---|
on-behalf-of | "eu consequat in" |
[
{
"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)
GET
| Query Parameter Name | Example |
|---|---|
start_time | -86093132 |
end_time | 32844000 |
| Header Name | Example |
|---|---|
Accept* | "Excepteur" |
on-behalf-of | "aute" |
[
{
"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"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "amet proident tempor qui cillum" |
{
"delete_all": false,
"emails": [
"example@example.com",
"example2@example.com"
]
}Error generating example{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "commodo" |
[
{
"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"
}
]DELETE
| Query Parameter Name | Example |
|---|---|
email_address* | DcfNhKVPE@DuckIDsEfLOFBTRuAYeBTeXLSc.vr |
| Header Name | Example |
|---|---|
on-behalf-of | "officia magna" |
Error generating example{}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}Blocks API(4 operations)
GET
| Query Parameter Name | Example |
|---|---|
start_time | -36244888 |
end_time | 2209872 |
limit | -17049677 |
offset | 18123496 |
| Header Name | Example |
|---|---|
on-behalf-of | "tempor incididunt velit veniam eiusmod" |
[
{
"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"
}
]DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "ut est amet do" |
{
"delete_all": false,
"emails": [
"example1@example.com",
"example2@example.com"
]
}{}GET
| Header Name | Example |
|---|---|
on-behalf-of | "officia quis culpa Lorem" |
[
{
"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"
}
]DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "labore minim Duis" |
{}Spam Reports API(4 operations)
GET
| Query Parameter Name | Example |
|---|---|
start_time | -14489991 |
end_time | 86628271 |
limit | -12600233 |
offset | 47099358 |
| Header Name | Example |
|---|---|
on-behalf-of | "magna voluptate ullamco" |
[
{
"created": 1443651141,
"email": "user1@example.com",
"ip": "10.63.202.100"
},
{
"created": 1443651154,
"email": "user2@example.com",
"ip": "10.63.202.100"
}
]DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "exercitation veniam cupidatat ad" |
{
"delete_all": false,
"emails": [
"example1@example.com",
"example2@example.com"
]
}{}GET
| Header Name | Example |
|---|---|
on-behalf-of | "deserunt do aliquip" |
[
{
"created": 1454433146,
"email": "test1@example.com",
"ip": "10.89.32.5"
}
]DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "tempor pariatur" |
{}Suppressions - Global Suppressions(4 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "Duis fugiat" |
{
"recipient_emails": [
"test1@example.com",
"test2@example.com"
]
}{
"recipient_emails": [
"test1@example.com",
"test2@example.com"
]
}GET
| Query Parameter Name | Example |
|---|---|
start_time | 44774094 |
end_time | 66099038 |
limit | 66244119 |
offset | 16130604 |
| Header Name | Example |
|---|---|
on-behalf-of | "in irure culpa nulla do" |
[
{
"created": 1443651141,
"email": "user1@example.com"
},
{
"created": 1443651154,
"email": "user2@example.com"
}
]GET
| Header Name | Example |
|---|---|
on-behalf-of | "id Duis aliqua esse" |
{
"recipient_email": "test@example.com"
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "sed" |
{}Suppressions - Unsubscribe Groups(5 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "Ut aute fugiat ut" |
{
"name": "Product Suggestions",
"description": "Suggestions for products our users might like.",
"is_default": true
}{
"id": 103,
"name": "Product Suggestions",
"description": "Suggestions for products our users might like.",
"is_default": false
}GET
| Query Parameter Name | Example |
|---|---|
id | 86109962 |
| Header Name | Example |
|---|---|
on-behalf-of | "esse veniam nulla in" |
[
{
"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
}
]GET
| Header Name | Example |
|---|---|
on-behalf-of | "nostrud pariatur ad" |
{
"description": "Our monthly newsletter.",
"id": 100,
"is_default": true,
"last_email_sent_at": null,
"name": "Newsletters",
"unsubscribes": 400
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "dolor" |
{
"id": 103,
"name": "Item Suggestions",
"description": "Suggestions for items our users might like."
}{
"id": 103,
"name": "Item Suggestions",
"description": "Suggestions for items our users might like."
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "in proident consequat veniam irure" |
{}Suppressions - Suppressions(6 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "eiusmod in consectetur fugiat exercitation" |
{
"recipient_emails": [
"test1@example.com",
"test2@example.com"
]
}{
"recipient_emails": [
"test1@example.com",
"test2@example.com"
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "laboris Ut ea qui" |
[
"example@example.com",
"example2@example.com"
]POST
| Header Name | Example |
|---|---|
on-behalf-of | "mollit Lorem nisi reprehenderit" |
{
"recipient_emails": [
"exists1@example.com",
"exists2@example.com",
"doesnotexists@example.com"
]
}[
"exists1@example.com",
"exists2@example.com"
]GET
| Header Name | Example |
|---|---|
on-behalf-of | "in Lorem exercitation nulla" |
[
{
"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
}
]GET
| Header Name | Example |
|---|---|
on-behalf-of | "occaecat tempor dolor ipsum" |
{
"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
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "Ut" |
Error generating exampleInvalid Emails API(4 operations)
GET
| Query Parameter Name | Example |
|---|---|
start_time | 14225638 |
end_time | -67747478 |
limit | -98105247 |
offset | -53357433 |
| Header Name | Example |
|---|---|
on-behalf-of | "reprehenderit in labore consequat ex" |
[
{
"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"
}
]DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "id labore" |
{
"delete_all": false,
"emails": [
"example1@example.com",
"example2@example.com"
]
}{}GET
| Header Name | Example |
|---|---|
on-behalf-of | "Excepteur officia reprehenderit est" |
[
{
"created": 1454433146,
"email": "test1@example.com",
"reason": "Mail domain mentioned in email address is unknown"
}
]DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "fugiat" |
{}Service Homepage: sendgrid.com/en-us
API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started
emails