View All Services

Sendgrid V3 Virtual Sandbox

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

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

Sendgrid V3 virtual sandbox is up and running!

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

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



Mail Send

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

Cancel Scheduled Sends(7 operations)

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

API Keys(6 operations)

Header NameExample
on-behalf-of"aliquip reprehenderit officia Excepteur"
Request Payload
{
  "name": "My API Key",
  "scopes": [
    "mail.send",
    "alerts.create",
    "alerts.read"
  ]
}
Response Payload
{
  "api_key": "SG.xxxxxxxx.yyyyyyyy",
  "api_key_id": "xxxxxxxx",
  "name": "My API Key",
  "scopes": [
    "mail.send",
    "alerts.create",
    "alerts.read"
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "anim esse"
    },
    {
      "message": "ea"
    },
    {
      "message": "non laboris cillum dolor"
    }
  ]
}
Query Parameter NameExample
limit-34888277
Header NameExample
on-behalf-of"dolore aliquip ut"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "API Key Name",
      "api_key_id": "some-apikey-id"
    },
    {
      "name": "API Key Name 2",
      "api_key_id": "another-apikey-id"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "adipisicing esse Duis"
    },
    {
      "message": "commodo occaecat"
    },
    {
      "message": "enim consectetur irure Duis"
    }
  ]
}
Header NameExample
on-behalf-of"proident"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "API Key Name",
      "api_key_id": "some-apikey-id"
    },
    {
      "name": "API Key Name 2",
      "api_key_id": "another-apikey-id"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "eiusmod sunt magna Lorem"
    },
    {
      "message": "nostrud aliqua velit veniam ullamco"
    },
    {
      "message": "culpa"
    },
    {
      "message": "mollit enim dolore laboris"
    },
    {
      "message": "exercitation id anim irure ullamco"
    }
  ]
}
Header NameExample
on-behalf-of"et occaecat quis ut ad"
Request Payload
{
  "name": "A New Hope"
}
Response Payload
{
  "api_key_id": "qfTQ6KG0QBiwWdJ0-pCLCA",
  "name": "A New Hope"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "do amet"
    },
    {
      "message": "sint ad"
    },
    {
      "message": "in quis"
    }
  ]
}
Header NameExample
on-behalf-of"pariatur consequat sunt Duis"
Request Payload
{
  "name": "Profiles key",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ]
}
Response Payload
{
  "api_key_id": "qfTQ6KG0QBiwWdJ0-pCLCA",
  "name": "Profiles Key",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "Excepteur eu veniam cillum adipisicing"
    },
    {
      "message": "et aute officia velit"
    }
  ]
}
Header NameExample
on-behalf-of"est"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "dolore ex Lorem voluptate aute"
    },
    {
      "message": "veniam velit anim nostrud"
    },
    {
      "message": "aliquip ut et"
    },
    {
      "message": "non sunt in voluptate"
    }
  ]
}

API Key Permissions

Header NameExample
on-behalf-of"dolore fugiat reprehenderit cupidatat"
Request Payload
Response Payload
{
  "scopes": [
    "mail.send",
    "alerts.create",
    "alerts.read"
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "do tempor"
    },
    {
      "message": "deserunt aliqua nisi"
    },
    {
      "message": "in proident"
    },
    {
      "message": "in"
    },
    {
      "message": "ea"
    }
  ]
}

Settings - Enforced TLS(2 operations)

Header NameExample
on-behalf-of"in mollit"
Request Payload
Response Payload
{
  "require_tls": false,
  "require_valid_cert": false
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "adipisicing laborum magna ad elit"
    },
    {
      "message": "sit voluptate sunt"
    },
    {
      "message": "cillum"
    },
    {
      "message": "laborum labore voluptate commodo"
    },
    {
      "message": "laboris nulla"
    }
  ]
}
Header NameExample
on-behalf-of"minim laborum ut Ut aliqua"
Request Payload
{
  "require_tls": true,
  "require_valid_cert": true
}
Response Payload
{
  "require_tls": true,
  "require_valid_cert": false
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ut"
    },
    {
      "message": "consequat proident"
    },
    {
      "message": "veniam officia"
    }
  ]
}

IP Access Management(6 operations)

Header NameExample
on-behalf-of"deserunt laboris"
Request Payload
{
  "ips": [
    {
      "ip": "192.168.1.1"
    },
    {
      "ip": "192.*.*.*"
    },
    {
      "ip": "192.168.1.3/32"
    }
  ]
}
Response Payload
{
  "result": [
    {
      "id": 1,
      "ip": "192.168.1.1/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    },
    {
      "id": 2,
      "ip": "192.0.0.0/8",
      "created_at": 1441824715,
      "updated_at": 1441824715
    },
    {
      "id": 3,
      "ip": "192.168.1.3/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "in consectetur"
    },
    {
      "message": "ad est qui aliqua dolore"
    },
    {
      "message": "anim est laboris cupidatat fugiat"
    },
    {
      "message": "dolore sunt mollit"
    }
  ]
}
Header NameExample
on-behalf-of"tempor Ut sunt cupidatat deserunt"
Request Payload
Response Payload
{
  "result": [
    {
      "id": 1,
      "ip": "192.168.1.1/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    },
    {
      "id": 2,
      "ip": "192.168.1.2/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    },
    {
      "id": 3,
      "ip": "192.168.1.3/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "consectetur voluptate deserunt"
    },
    {
      "message": "occaecat"
    },
    {
      "message": "sint mollit nulla"
    },
    {
      "message": "nulla in veniam Lorem"
    }
  ]
}
Header NameExample
on-behalf-of"Duis esse"
Request Payload
{
  "ids": [
    1,
    2,
    3
  ]
}
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "enim Duis"
    }
  ]
}
Query Parameter NameExample
limit94413593
Header NameExample
on-behalf-of"et irure in eu dolore"
Request Payload
Response Payload
{
  "result": [
    {
      "allowed": false,
      "auth_method": "Web",
      "first_at": 1444087966,
      "ip": "1.1.1.1",
      "last_at": 1444406672,
      "location": "Australia"
    },
    {
      "allowed": false,
      "auth_method": "Web",
      "first_at": 1444087505,
      "ip": "1.2.3.48",
      "last_at": 1444087505,
      "location": "Mukilteo, Washington"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "in ut cupidatat do consectetur"
    },
    {
      "message": "mollit incididunt esse exercitation Duis"
    },
    {
      "message": "magna nulla"
    }
  ]
}
Header NameExample
on-behalf-of"nulla"
Request Payload
Response Payload
{
  "id": 1,
  "ip": "192.168.1.1",
  "created_at": 1441824715,
  "updated_at": 1441824715
}
Header NameExample
on-behalf-of"aliquip ullamco sunt in"
Request Payload
Response Payload
{}

Certificates(5 operations)

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

Single Sign-On Settings(5 operations)

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

Single Sign-On Teammates(2 operations)

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

Settings - Mail(13 operations)

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

Settings - Partner(3 operations)

Header NameExample
on-behalf-of"qui"
Request Payload
{
  "license_key": "",
  "enabled": true,
  "enable_subuser_statistics": true
}
Response Payload
{
  "enable_subuser_statistics": true,
  "enabled": true,
  "license_key": ""
}
Header NameExample
on-behalf-of"nisi officia dolore"
Request Payload
Response Payload
{
  "enable_subuser_statistics": false,
  "enabled": true,
  "license_key": ""
}
Query Parameter NameExample
limit41077037
offset-60896983
Header NameExample
on-behalf-of"cupidatat labore dolor pariatur nulla"
Request Payload
Response Payload
{
  "result": [
    {
      "title": "Partner title",
      "enabled": true,
      "name": "partner_name",
      "description": "A description of a partner."
    }
  ]
}

Teammates(11 operations)

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

Alerts(5 operations)

Header NameExample
Authorization"in dolore ut"
on-behalf-of"Lorem"
Request Payload
{
  "type": "stats_notification",
  "email_to": "example@example.com",
  "frequency": "daily"
}
Response Payload
{
  "created_at": 1451520930,
  "email_to": "test@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451520930
}
{
  "field": "officia ut aliqua aute ullamco",
  "message": "magna ut ea in laboris"
}
Header NameExample
Authorization"adipisicing in do veniam consequat"
on-behalf-of"culpa"
Request Payload
Response Payload
[
  {
    "created_at": 1451498784,
    "email_to": "example1@example.com",
    "id": 46,
    "percentage": 90,
    "type": "usage_limit",
    "updated_at": 1451498784
  },
  {
    "created_at": 1451498812,
    "email_to": "example2@example.com",
    "frequency": "monthly",
    "id": 47,
    "type": "stats_notification",
    "updated_at": 1451498812
  },
  {
    "created_at": 1451520930,
    "email_to": "example3@example.com",
    "frequency": "daily",
    "id": 48,
    "type": "stats_notification",
    "updated_at": 1451520930
  }
]
Header NameExample
Authorization"dolore Lorem in labore"
on-behalf-of"voluptate laborum magna ex"
Request Payload
Response Payload
{
  "created_at": 1451520930,
  "email_to": "example@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451520930
}
Header NameExample
on-behalf-of"incididunt consectetur"
Request Payload
Response Payload
{}
Header NameExample
on-behalf-of"voluptate"
Request Payload
{
  "email_to": "example@example.com"
}
Response Payload
{
  "created_at": 1451520930,
  "email_to": "example@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451522691
}

Users API(9 operations)

Header NameExample
on-behalf-of"aliquip ut"
Request Payload
Response Payload
{
  "address": "814 West Chapman Avenue",
  "address2": "",
  "city": "Orange",
  "company": "SendGrid",
  "country": "US",
  "first_name": "Test",
  "last_name": "User",
  "phone": "555-555-5555",
  "state": "CA",
  "website": "http://www.sendgrid.com",
  "zip": "92868"
}
Header NameExample
on-behalf-of"ut qui sint ut"
Request Payload
{
  "first_name": "Example",
  "last_name": "User",
  "city": "Orange"
}
Response Payload
{
  "address": "814 West Chapman Avenue",
  "address2": "",
  "city": "Orange",
  "company": "SendGrid",
  "country": "US",
  "first_name": "Example",
  "last_name": "User",
  "phone": "555-555-5555",
  "state": "CA",
  "website": "http://www.sendgrid.com",
  "zip": "92868"
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"laboris ex magna"
Request Payload
Response Payload
{
  "reputation": 100,
  "type": "paid"
}
Header NameExample
on-behalf-of"est mollit"
Request Payload
Response Payload
{
  "email": "test@example.com"
}
Header NameExample
on-behalf-of"labore et quis commodo Duis"
Request Payload
{
  "email": "example@example.com"
}
Response Payload
{
  "email": "example@example.com"
}
Header NameExample
on-behalf-of"reprehenderit Lorem"
Request Payload
Response Payload
{
  "username": "test_username",
  "user_id": 1
}
Header NameExample
on-behalf-of"magna ut labore nostrud"
Request Payload
{
  "username": "test_username"
}
Response Payload
{
  "username": "test_username"
}
Header NameExample
on-behalf-of"ut aliquip deserunt"
Request Payload
Response Payload
{
  "remain": 200,
  "total": 200,
  "overage": 0,
  "used": 0,
  "last_reset": "2013-01-01",
  "next_reset": "2013-02-01",
  "reset_frequency": "monthly"
}
Header NameExample
on-behalf-of"Ut non aute reprehenderit"
Request Payload
{
  "new_password": "new_password",
  "old_password": "old_password"
}
Response Payload
{}

Subusers API(6 operations)

Query Parameter NameExample
usernameipsum
limit-3214762
offset-37317966
Request Payload
Response Payload
[
  {
    "disabled": false,
    "email": "example@example.com",
    "id": 1234,
    "username": "example_subuser"
  },
  {
    "disabled": false,
    "email": "example2@example.com",
    "id": 1234,
    "username": "example_subuser2"
  }
]
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Request Payload
{
  "username": "John@example.com",
  "email": "John@example.com",
  "password": "johns_password",
  "ips": [
    "1.1.1.1",
    "2.2.2.2"
  ]
}
Response Payload
{
  "username": "example_subuser",
  "user_id": 1234,
  "email": "example@example.com",
  "signup_session_token": "",
  "authorization_token": "",
  "credit_allocation": {
    "type": "unlimited"
  }
}
{
  "errors": [
    {
      "message": "username exists"
    },
    {
      "message": "unable to validate IPs at this time"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "you dont have permission to access this resource"
    }
  ]
}
{
  "errors": [
    {
      "message": "unable to validate IPs at this time"
    }
  ]
}
Request Payload
{
  "disabled": false
}
Response Payload
{}
{
  "errors": [
    {
      "message": "invalid username"
    },
    {
      "message": "no fields provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "unable to enable user"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
usernamesin quis sit mollit
Request Payload
Response Payload
[
  {
    "username": "example_subuser",
    "reputation": 99
  },
  {
    "username": "example_subuser2",
    "reputation": 95.2
  }
]
Request Payload
[
  "127.0.0.1"
]
Response Payload
{
  "ips": [
    "127.0.0.1"
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Subuser Monitor Settings(4 operations)

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

Subuser Statistics(4 operations)

Query Parameter NameExample
date*minim
sort_by_metricdolore
sort_by_directiondesc
limit-57147131
offset-57897826
Request Payload
Response Payload
{
  "date": "2016-02-01",
  "stats": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 10,
        "processed": 10,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user1",
      "type": "subuser"
    }
  ]
}
Query Parameter NameExample
date*proident eu qui
subuserdolor
sort_by_metricblocks
sort_by_directionasc
limit78689869
offset75943630
Request Payload
Response Payload
{
  "date": "2016-02-01",
  "stats": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 0,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 1,
        "processed": 0,
        "requests": 100,
        "spam_report_drops": 0,
        "spam_reports": 99,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user1",
      "type": "subuser"
    },
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 10,
        "processed": 10,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user2",
      "type": "subuser"
    }
  ]
}
Query Parameter NameExample
sort_by_directiondesc
start_date*qui magna dolore exercitation eu
end_datecommodo minim sunt exercitation pariatur
limit-13257761
offset-26081565
aggregated_byExcepteur id ipsum
sort_by_metricid in est dolore aute
Request Payload
Response Payload
{
  "date": "2015-10-11",
  "stats": []
}
Query Parameter NameExample
limit-34173724
offset26157303
aggregated_byday
subusers*ut laboris
start_date*sunt velit
end_dateadipisicing aliqua et
Request Payload
Response Payload
[
  {
    "date": "2015-10-01",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-02",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-03",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-04",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-05",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-06",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-07",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-08",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-09",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-10",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]

Link branding(10 operations)

IP Warmup(4 operations)

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

Reverse DNS(5 operations)

Header NameExample
on-behalf-of"ad"
Request Payload
{
  "ip": "192.168.1.1",
  "subdomain": "email",
  "domain": "example.com"
}
Response Payload
{
  "id": 123,
  "ip": "192.168.1.2",
  "rdns": "o1.email.example.com",
  "users": [],
  "subdomain": "email",
  "domain": "example.com",
  "valid": true,
  "legacy": false,
  "a_record": {
    "valid": true,
    "type": "a",
    "host": "o1.email.example.com",
    "data": "192.168.1.2"
  }
}
Query Parameter NameExample
limit-77211522
offset67921732
ipofficia
Header NameExample
on-behalf-of"magna sunt quis"
Request Payload
Response Payload
[
  {
    "id": 1,
    "ip": "192.168.1.1",
    "rdns": "o1.email.example.com",
    "users": [
      {
        "username": "john@example.com",
        "user_id": 7
      },
      {
        "username": "jane@example.com",
        "user_id": 8
      }
    ],
    "subdomain": "email",
    "domain": "example.com",
    "valid": true,
    "legacy": false,
    "a_record": {
      "valid": true,
      "type": "a",
      "host": "o1.email.example.com",
      "data": "192.168.1.1"
    }
  },
  {
    "id": 2,
    "ip": "192.168.1.2",
    "rdns": "o2.email.example.com",
    "users": [
      {
        "username": "john@example.com",
        "user_id": 7
      },
      {
        "username": "jane@example2.com",
        "user_id": 9
      }
    ],
    "subdomain": "email",
    "domain": "example.com",
    "valid": true,
    "legacy": false,
    "a_record": {
      "valid": true,
      "type": "a",
      "host": "o2.email.example.com",
      "data": "192.168.1.2"
    }
  }
]
Header NameExample
on-behalf-of"in consequat pariatur"
Request Payload
Response Payload
{
  "id": 123456,
  "valid": false,
  "validation_results": {
    "a_record": {
      "valid": false,
      "reason": "Failed to resolve A Record at o1.ptr4283.example.com: lookup o1.ptr4283.example.com on 192.168.0.10:53: no such host"
    }
  }
}
{
  "errors": [
    {
      "message": "Reverse DNS record not found."
    }
  ]
}
{
  "errors": [
    {
      "message": "internal error getting rDNS"
    }
  ]
}
Header NameExample
on-behalf-of"reprehenderit Duis qui adipisicing"
Request Payload
Response Payload
{
  "id": 123,
  "ip": "192.168.1.1",
  "rdns": "o1.email.example.com",
  "users": [
    {
      "username": "john@example.com",
      "user_id": 7
    }
  ],
  "subdomain": "email",
  "domain": "example.com",
  "valid": true,
  "legacy": false,
  "a_record": {
    "valid": true,
    "type": "a",
    "host": "o1.email.example.com",
    "data": "192.168.1.1"
  }
}
Header NameExample
on-behalf-of"elit veniam eu ut"
Request Payload
Response Payload
{}

Email Address Validation

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

Email CNAME records

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

IP Pools(7 operations)

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

IP Addresses(5 operations)

Request Payload
{
  "count": 90323478,
  "subusers": [
    "subuser1",
    "subuser2"
  ],
  "warmup": true,
  "user_can_send": true
}
Response Payload
{
  "ips": [
    {
      "ip": "1.2.3.4",
      "subusers": [
        "user",
        "subuser1"
      ]
    },
    {
      "ip": "1.2.3.5",
      "subusers": [
        "user",
        "subuser1"
      ]
    }
  ],
  "remaining_ips": 1,
  "warmup": true
}
{
  "errors": [
    {
      "field": null,
      "message": "one or more subusers do not belong to this user"
    }
  ]
}
Query Parameter NameExample
ipqui esse et Excepteur
exclude_whitelabelsfalse
limit-30053795
offset-73024217
subuserpariatur tempor voluptate sed commodo
sort_by_directionasc
Request Payload
Response Payload
[
  {
    "ip": "192.168.1.1",
    "pools": [
      "pool1",
      "pool2"
    ],
    "whitelabeled": false,
    "start_date": 1409616000,
    "subusers": [
      "tim@sendgrid.net"
    ],
    "warmup": false,
    "assigned_at": 1482883200
  },
  {
    "ip": "208.115.214.22",
    "pools": [],
    "whitelabeled": true,
    "rdns": "o1.email.burgermail.com",
    "start_date": 1409616000,
    "subusers": [],
    "warmup": false,
    "assigned_at": 1482883200
  }
]
Request Payload
Response Payload
{
  "results": [
    {
      "remaining": 2,
      "period": "month",
      "price_per_ip": 20
    }
  ]
}
Request Payload
Response Payload
[
  {
    "ip": "167.89.21.3",
    "pools": [
      "new_test5"
    ],
    "warmup": true,
    "start_date": 1409616000
  }
]
Request Payload
Response Payload
{
  "ip": "000.00.00.0",
  "subusers": [
    "subuser1",
    "subuser2"
  ],
  "rdns": "o1.em.example.com",
  "pools": [
    "test1"
  ],
  "warmup": false,
  "start_date": null,
  "whitelabeled": true
}

Domain Authentication(12 operations)

Query Parameter NameExample
limit-96160802
offset96672787
exclude_subuserstrue
usernamenisi adipisicing
domainullamco adipisicing
Header NameExample
on-behalf-of"anim nisi cupidatat sint"
Request Payload
Response Payload
[
  {
    "id": 1,
    "user_id": 7,
    "subdomain": "mail",
    "domain": "example.com",
    "username": "jane@example.com",
    "ips": [
      "192.168.1.1",
      "192.168.1.2"
    ],
    "custom_spf": true,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": true,
    "dns": {
      "mail_cname": {
        "valid": true,
        "type": "cname",
        "host": "mail.example.com",
        "data": "u7.wl.sendgrid.net"
      },
      "dkim1": {
        "valid": true,
        "type": "cname",
        "host": "s1._domainkey.example.com",
        "data": "s1._domainkey.u7.wl.sendgrid.net"
      },
      "dkim2": {
        "valid": true,
        "type": "cname",
        "host": "s2._domainkey.example.com",
        "data": "s2._domainkey.u7.wl.sendgrid.net"
      }
    }
  },
  {
    "id": 2,
    "user_id": 8,
    "subdomain": "new",
    "domain": "example2.com",
    "username": "john@example2.com",
    "ips": [],
    "custom_spf": false,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": false,
    "dns": {
      "mail_cname": {
        "valid": false,
        "type": "mx",
        "host": "news.example2.com",
        "data": "sendgrid.net"
      },
      "dkim1": {
        "valid": false,
        "type": "txt",
        "host": "example2.com",
        "data": "k=rsa; t=s; p=publicKey"
      },
      "dkim2": {
        "valid": false,
        "type": "txt",
        "host": "example2.com",
        "data": "k=rsa; t=s p=publicKey"
      }
    }
  }
]
Header NameExample
on-behalf-of"nisi"
Request Payload
{
  "domain": "example.com",
  "subdomain": "news",
  "username": "john@example.com",
  "ips": [
    "192.168.1.1",
    "192.168.1.2"
  ],
  "custom_spf": true,
  "default": true,
  "automatic_security": false
}
Response Payload
{
  "id": 302183,
  "user_id": 1446226,
  "subdomain": "example",
  "domain": "example.com",
  "username": "mbernier",
  "ips": [],
  "custom_spf": false,
  "default": true,
  "legacy": false,
  "automatic_security": true,
  "valid": false,
  "dns": {
    "mail_cname": {
      "valid": false,
      "type": "cname",
      "host": "example.example.com",
      "data": "u1446226.wl.sendgrid.net"
    },
    "dkim1": {
      "valid": false,
      "type": "cname",
      "host": "s1._domainkey.example.com",
      "data": "s1.domainkey.u1446226.wl.sendgrid.net"
    },
    "dkim2": {
      "valid": false,
      "type": "cname",
      "host": "s2._domainkey.example.com",
      "data": "s2.domainkey.u1446226.wl.sendgrid.net"
    }
  }
}
Header NameExample
on-behalf-of"eu consectetur est veniam exercitation"
Request Payload
Response Payload
{
  "id": 45373692,
  "user_id": 66036447,
  "subdomain": "sub",
  "domain": "example.com",
  "username": "jdoe",
  "ips": [
    "127.0.0.1"
  ],
  "custom_spf": false,
  "default": true,
  "legacy": false,
  "automatic_security": true,
  "valid": true,
  "dns": {
    "mail_cname": {
      "valid": true,
      "type": "cname",
      "host": "mail.example.com",
      "data": "u7.wl.sendgrid.net"
    },
    "dkim1": {
      "valid": true,
      "type": "cname",
      "host": "s1._domainkey.example.com",
      "data": "s1._domainkey.u7.wl.sendgrid.net"
    },
    "dkim2": {
      "valid": true,
      "type": "cname",
      "host": "s2._domainkey.example.com",
      "data": "s2._domainkey.u7.wl.sendgrid.net"
    }
  }
}
Header NameExample
on-behalf-of"veniam nostrud dolore sit minim"
Request Payload
{
  "default": false,
  "custom_spf": true
}
Response Payload
[
  {
    "id": 1,
    "user_id": 7,
    "subdomain": "mail",
    "domain": "example.com",
    "username": "jane@example.com",
    "ips": [
      "192.168.1.1",
      "192.168.1.2"
    ],
    "custom_spf": true,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": true,
    "dns": {
      "mail_cname": {
        "valid": true,
        "type": "cname",
        "host": "mail.example.com",
        "data": "u7.wl.sendgrid.net"
      },
      "dkim1": {
        "valid": true,
        "type": "cname",
        "host": "s1._domainkey.example.com",
        "data": "s1._domainkey.u7.wl.sendgrid.net"
      },
      "dkim2": {
        "valid": true,
        "type": "cname",
        "host": "s2._domainkey.example.com",
        "data": "s2._domainkey.u7.wl.sendgrid.net"
      }
    }
  },
  {
    "id": 2,
    "user_id": 8,
    "subdomain": "new",
    "domain": "example2.com",
    "username": "john@example2.com",
    "ips": [],
    "custom_spf": false,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": false,
    "dns": {
      "mail_cname": {
        "valid": false,
        "type": "mx",
        "host": "news.example2.com",
        "data": "sendgrid.net"
      },
      "dkim1": {
        "valid": false,
        "type": "txt",
        "host": "example2.com",
        "data": "k=rsa; t=s; p=publicKey"
      },
      "dkim2": {
        "valid": false,
        "type": "txt",
        "host": "example2.com",
        "data": "k=rsa; t=s p=publicKey"
      }
    }
  }
]
Header NameExample
on-behalf-of"dolor occaecat dolor"
Request Payload
Response Payload
{}
Query Parameter NameExample
domaincillum ad
Header NameExample
on-behalf-of"sit"
Request Payload
Response Payload
[
  {
    "id": 1,
    "user_id": 7,
    "subdomain": "mail",
    "domain": "example.com",
    "username": "jane@example.com",
    "ips": [
      "192.168.1.1",
      "192.168.1.2"
    ],
    "custom_spf": true,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": true,
    "dns": {
      "mail_cname": {
        "valid": true,
        "type": "cname",
        "host": "mail.example.com",
        "data": "u7.wl.sendgrid.net"
      },
      "dkim1": {
        "valid": true,
        "type": "cname",
        "host": "s1._domainkey.example.com",
        "data": "s1._domainkey.u7.wl.sendgrid.net"
      },
      "dkim2": {
        "valid": true,
        "type": "cname",
        "host": "s2._domainkey.example.com",
        "data": "s2._domainkey.u7.wl.sendgrid.net"
      }
    }
  }
]
Header NameExample
on-behalf-of"in"
Request Payload
{
  "ip": "192.168.0.1"
}
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "john@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}
Header NameExample
on-behalf-of"deserunt dolore cillum laboris"
Request Payload
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "mail@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}
Header NameExample
on-behalf-of"est dolore reprehenderit"
Request Payload
Response Payload
{
  "id": 1,
  "valid": true,
  "validation_resuts": {
    "mail_cname": {
      "valid": false,
      "reason": "Expected your MX record to be \"mx.sendgrid.net\" but found \"example.com\"."
    },
    "dkim1": {
      "valid": true,
      "reason": null
    },
    "dkim2": {
      "valid": true,
      "reason": null
    },
    "spf": {
      "valid": true,
      "reason": null
    }
  }
}
{
  "errors": [
    {
      "message": "internal error getting TXT"
    }
  ]
}
Query Parameter NameExample
username*sed tempor mollit quis
Request Payload
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "mail@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}
Query Parameter NameExample
usernameexercitation Duis incididunt
Request Payload
Response Payload
{}
Request Payload
{
  "username": "jdoe"
}
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "mail@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}

Sender Verification(8 operations)

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

Designs API(9 operations)

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

Contacts(13 operations)

Request Payload
{
  "contacts": [
    {
      "address_line_1": "labore sint commodo dolor",
      "address_line_2": "et",
      "alternate_emails": [
        "ut labore esse",
        "reprehenderit cupidat",
        "mollit in dolor ad veniam",
        "laboris mollit sed id",
        "commodo ad labore velit"
      ],
      "city": "ex adipisicing",
      "country": "exercitation",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "dolor dolore",
      "first_name": "laborum com",
      "last_name": "laborum ut officia cupidatat",
      "postal_code": "proident ut",
      "state_province_region": "sit sed"
    },
    {
      "address_line_1": "ipsu",
      "address_line_2": "sunt irure veniam ea",
      "alternate_emails": [
        "dolor Ut",
        "ut Excepteur mollit",
        "reprehenderit dolor",
        "qui elit est",
        "eu culpa"
      ],
      "city": "",
      "country": "aute non ipsum sit",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "ea incididunt enim officia cillum",
      "first_name": "dolore nulla",
      "last_name": "reprehenderi",
      "postal_code": "occaecat ex qui dolor",
      "state_province_region": "ess"
    },
    {
      "address_line_1": "id nisi",
      "address_line_2": "cupidatat aute",
      "alternate_emails": [
        "magna eiusmod",
        "id veniam nisi",
        "voluptate consectetur mollit",
        "mollit dolor eiusmod Duis culpa",
        "quis fugiat do commodo"
      ],
      "city": "veniam culpa",
      "country": "Duis proi",
      "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": "ut Duis occaecat",
      "first_name": "laborum esse d",
      "last_name": "labore velit",
      "postal_code": "proident aliquip amet ea eiusmod",
      "state_province_region": "u"
    },
    {
      "address_line_1": "dolor ea laborum anim culpa",
      "address_line_2": "velit",
      "alternate_emails": [
        "id fugiat Lorem Excepteur officia",
        "in sit et pariatur aute",
        "aute Excepteur quis ad",
        "tempor sed quis",
        "consequat"
      ],
      "city": "sed nostrud id eu deserunt",
      "country": "ip",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "amet commodo dolore irure",
      "first_name": "nostrud fugi",
      "last_name": "mollit",
      "postal_code": "esse",
      "state_province_region": "deserunt nulla aliquip voluptate mollit"
    },
    {
      "address_line_1": "eiusmod Ex",
      "address_line_2": "exercitation esse quis",
      "alternate_emails": [
        "incididunt cupidatat consequat officia nulla",
        "sunt",
        "in est",
        "Excepteur mollit laboris",
        "ea"
      ],
      "city": "ad",
      "country": "dolor ullamco",
      "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": "dolo",
      "first_name": "sit",
      "last_name": "do dolor sint ipsum",
      "postal_code": "dolore ullamco exercitation anim aliquip",
      "state_province_region": "do ea ad amet"
    },
    {
      "address_line_1": "ad pariatur proiden",
      "address_line_2": "et Ut enim",
      "alternate_emails": [
        "irure reprehenderit ut consequat esse",
        "fugiat in dolor do",
        "cillum eiusmod",
        "voluptate",
        "occaecat dolore cupidatat"
      ],
      "city": "voluptate",
      "country": "cupidatat ut nostrud eu laboru",
      "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": "mollit et commodo culpa eiusmod",
      "first_name": "pariatur s",
      "last_name": "dolore voluptate sed occa",
      "postal_code": "est enim velit in",
      "state_province_region": "mag"
    },
    {
      "address_line_1": "Excepteur quis sed id",
      "address_line_2": "do minim Duis et",
      "alternate_emails": [
        "enim amet Excepteur magna mollit",
        "do Excepteur",
        "laboris",
        "id",
        "occaecat ad dolor do Except"
      ],
      "city": "Ut nulla laborum",
      "country": "deserunt Ut dolor elit in",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "Lorem aliqua dolor nulla in",
      "first_name": "aliqua elit ven",
      "last_name": "proident consequat nisi",
      "postal_code": "qui dolore",
      "state_province_region": "quis do"
    },
    {
      "address_line_1": "magna",
      "address_line_2": "Excepteur ad pariatur cu",
      "alternate_emails": [
        "in consectetur laborum",
        "Duis commodo dolor in",
        "Lorem dolor sunt",
        "ullamco id",
        "officia in anim cillum"
      ],
      "city": "do",
      "country": "exercitation qui minim Excepteur",
      "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": "aliquip adipisicing",
      "first_name": "amet",
      "last_name": "ad ex",
      "postal_code": "dolore nulla Lorem elit sint",
      "state_province_region": "ullamco mollit"
    },
    {
      "address_line_1": "labore",
      "address_line_2": "sit ex et aliqua",
      "alternate_emails": [
        "esse ullamco minim deserunt",
        "magna anim",
        "enim sint do",
        "eiusmod",
        "anim veniam nisi in"
      ],
      "city": "officia",
      "country": "minim al",
      "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": "sunt anim est",
      "first_name": "ma",
      "last_name": "id labo",
      "postal_code": "Ut Duis dolor",
      "state_province_region": "aliquip quis"
    },
    {
      "address_line_1": "reprehenderit dolor amet proident ",
      "address_line_2": "dolor",
      "alternate_emails": [
        "in p",
        "ea pariatur et Excepteur dolore",
        "ad nulla non in pariatur",
        "cupidatat nostrud velit",
        "quis"
      ],
      "city": "in cupidatat Ut ex laborum",
      "country": "dolor ame",
      "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": "ali",
      "first_name": "veniam aliquip",
      "last_name": "in quis eli",
      "postal_code": "Duis consectetur ipsum",
      "state_province_region": "tempor occaecat"
    }
  ],
  "list_ids": [
    "141ca1f1-1d80-2941-d626-2924e9f3de1b"
  ]
}
Response Payload
{
  "job_id": "eiusmod et"
}
{
  "errors": [
    {
      "error_id": "esse proident ut aliqua adipisicing",
      "field": "nostrud",
      "message": "dolore",
      "parameter": "amet quis laboris culpa"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "magna laboris incididunt minim"
    },
    {
      "message": "magna proident non qui incididunt"
    }
  ]
}
Query Parameter NameExample
delete_all_contactsconsectetur sit officia in
idscommodo
Request Payload
Response Payload
{
  "job_id": {}
}
{
  "errors": []
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "occaecat amet enim"
    },
    {
      "message": "voluptate"
    },
    {
      "message": "exercitation anim dolore"
    },
    {
      "message": "voluptate"
    },
    {
      "message": "quis eu"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "self": "mollit"
  },
  "contact_count": 19224793,
  "result": [
    {
      "_metadata": {
        "self": "labore"
      },
      "address_line_1": "Excepteur cupidatat",
      "address_line_2": "nulla nostrud consectetur cillum consequat",
      "alternate_emails": [
        "eu",
        "labore Lorem adipisicing"
      ],
      "city": "ea sit",
      "country": "irure ex pariatur officia",
      "created_at": "dolor ea fugiat ut",
      "custom_fields": {},
      "email": "non fugiat",
      "facebook": "occaecat eiusmod veniam nisi est",
      "first_name": "occaecat",
      "id": "dolor nulla sunt",
      "last_name": "veniam cillum est",
      "line": "dolor reprehenderit",
      "list_ids": [
        "commodo exercitation ut"
      ],
      "phone_number": "ullamco sit in Ut",
      "postal_code": "ipsum",
      "segment_ids": [
        "aute",
        "sunt aliquip Lorem anim",
        "culpa veniam consequat ad cupidatat",
        "deserunt"
      ],
      "state_province_region": "aliqua velit eiusmod",
      "unique_name": "anim cupidatat Lorem commodo",
      "updated_at": "aliqua sint",
      "whatsapp": "anim"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ex",
      "field": "cillum consequat amet Excepteur",
      "message": "deserunt in ullamco dolor",
      "parameter": "ipsum"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "do ipsum"
    },
    {
      "message": "voluptate sint"
    },
    {
      "message": "culpa"
    },
    {
      "message": "labore ad ipsum officia"
    }
  ]
}
Request Payload
Response Payload
{
  "billable_breakdown": {
    "breakdown": {},
    "total": -4849279
  },
  "billable_count": 67373339,
  "contact_count": -51989054
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ea do"
    }
  ]
}
Request Payload
{
  "file_type": "csv",
  "list_ids": [
    "a45ce2d8-5e64-ab4a-e822-596f45b852b1"
  ],
  "max_file_size": 87655335,
  "notifications": {
    "email": true
  },
  "segment_ids": [
    "velit consequat",
    "fugiat aliquip",
    "ut consequat",
    "commodo",
    "enim officia consectetur"
  ]
}
Response Payload
{
  "_metadata": {
    "count": -81095253.0787866,
    "next": "http://SLGopcqRokFOHrpqO.zlMmETOkNdo0Hz6rdwATzdJk8nYg5blL4g3xeg7rKkMitft+kYntw01RUxfAR7Aazn79HPHWt",
    "prev": "https://LqXJZ.dcozS9o9gQOxNVTbROGei5HdmYFC",
    "self": "http://iyIsRsoOxczLNxptbxSqFpBsscyz.gopXNr4GT-JXRos+d.BhvBYzlkYcKht"
  },
  "id": "mollit irure ut"
}
{
  "errors": [
    {
      "error_id": "ipsum commodo incididunt sint",
      "field": "in tempor eiusmod reprehenderit enim",
      "message": "consectetur aute veniam eiusmod magna",
      "parameter": "labore cupidatat dolore"
    },
    {
      "error_id": "occaecat irure elit dolor",
      "field": "Duis mollit non cupidatat",
      "message": "aute non qui",
      "parameter": "qui in sed"
    },
    {
      "error_id": "nisi tempor enim",
      "field": "labore exercitation irure Duis",
      "message": "Excepteur minim dolore",
      "parameter": "in Excepteur"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "pariatur Duis"
    },
    {
      "message": "do est ullamco qui"
    },
    {
      "message": "laborum"
    },
    {
      "message": "nisi Ut enim Lorem dolore"
    },
    {
      "message": "Excepteur quis occaecat"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "next": "occaecat",
    "prev": "Ut occaecat",
    "self": "ad irure dolore"
  },
  "result": [
    {
      "_metadata": {
        "next": "deserunt ex nisi consequat veniam",
        "prev": "cupidatat nostrud",
        "self": "dolor ipsum labore adipisicing ullamco"
      },
      "completed_at": "proident in consectetur mollit",
      "created_at": "ut Excepteur quis incididunt",
      "expires_at": "ut veniam consequat aute Duis",
      "export_type": "do",
      "id": "esse sit",
      "lists": [
        {
          "ID": "consectetur sed occaecat",
          "Name": "irure nulla consectetur ut"
        },
        {
          "ID": "tempor Ut ad veniam",
          "Name": "consectetur esse ad laborum dolore"
        },
        {
          "ID": "quis",
          "Name": "labore incididunt nisi consequat Duis"
        }
      ],
      "segments": [
        {
          "ID": "aliquip sed Ut esse",
          "Name": "et"
        },
        {
          "ID": "et est",
          "Name": "laborum nulla aute fugiat dolor"
        },
        {
          "ID": "labore dolore nulla proident",
          "Name": "in"
        },
        {
          "ID": "est deserunt",
          "Name": "in"
        }
      ],
      "status": "aute cillum do",
      "urls": [
        "enim dolor est",
        "officia sit in incididunt",
        "fugiat"
      ],
      "user_id": "non laboris"
    }
  ]
}
{
  "errors": [
    {
      "": "incididunt",
      "error_id": "aliquip labore",
      "message": "esse enim adipisicing"
    },
    {
      "": "laboris",
      "error_id": "culpa adipisicing eiusmod voluptate",
      "message": "dolore magna commodo non eu"
    },
    {
      "": "ullamco aute sunt",
      "error_id": "et sunt nisi",
      "message": "incididunt mollit exercitation"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "nulla"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "self": "ea cupidatat nisi"
  },
  "address_line_1": "Lorem",
  "address_line_2": "cillum minim ipsum",
  "alternate_emails": [
    "dolore proident irure",
    "nulla",
    "sint incididunt nostrud"
  ],
  "city": "ipsum enim in",
  "country": "ea",
  "created_at": "aute anim",
  "custom_fields": {},
  "email": "laborum Duis adipisicing ex in",
  "facebook": "ullamco dolore sit",
  "first_name": "enim commodo Excepteur sint sunt",
  "id": "sunt",
  "last_name": "nostrud",
  "line": "et aute est",
  "list_ids": [
    "ut in",
    "do ullamco",
    "ut"
  ],
  "phone_number": "anim ipsum culpa",
  "postal_code": "labore irure Excepteur ea",
  "segment_ids": [
    "dolor in"
  ],
  "state_province_region": "ullamco laborum magna ut",
  "unique_name": "culpa do",
  "updated_at": "ut in esse officia incididunt",
  "whatsapp": "non cillum aliquip ipsum"
}
{
  "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": "officia qui"
    },
    {
      "message": "deserunt laborum voluptate Duis et"
    },
    {
      "message": "consectetur ex dolore incididunt enim"
    }
  ]
}
Request Payload
{
  "query": "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')"
}
Response Payload
{
  "_metadata": {
    "self": "occaecat Lorem"
  },
  "contact_count": -31976254.058402672,
  "result": [
    {
      "_metadata": {
        "self": "ex in"
      },
      "address_line_1": "cillum officia",
      "address_line_2": "in officia veniam",
      "alternate_emails": [
        "minim",
        "dolore aute magna",
        "dolor do amet",
        "ea amet fugiat"
      ],
      "city": "tempor dolor",
      "country": "Duis tempor laborum",
      "created_at": "labore",
      "custom_fields": {},
      "email": "Lorem dolore aute",
      "facebook": "dolor",
      "first_name": "elit irure sit in",
      "id": "incididunt esse consectetur sed",
      "last_name": "sint nisi elit",
      "line": "sed",
      "list_ids": [
        "mollit proident esse",
        "ex amet sit ea",
        "exercitation ullamco velit",
        "aute nisi et"
      ],
      "phone_number": "magna mollit cillum anim",
      "postal_code": "qui ut pariatur occaecat",
      "segment_ids": [
        "ipsum",
        "Ut quis magna cillum",
        "exercitation culpa occaecat Lorem",
        "Excepteur amet quis dolor"
      ],
      "state_province_region": "ut ex",
      "unique_name": "et Duis eu sint nisi",
      "updated_at": "in elit nisi id est",
      "whatsapp": "ullamco pariatur incididunt ea"
    },
    {
      "_metadata": {
        "self": "deserunt occaecat"
      },
      "address_line_1": "ad aliquip amet occaecat sed",
      "address_line_2": "nisi et velit elit",
      "alternate_emails": [
        "commodo Excepteur ex aliqua",
        "Ut deserunt dolore sed est",
        "eu magna quis nulla",
        "dolor anim officia",
        "adipisicing occaecat eiusmod in"
      ],
      "city": "ullamco ut cupidatat do aute",
      "country": "veniam fugiat dolor ea sit",
      "created_at": "in",
      "custom_fields": {},
      "email": "ad deserunt ipsum pariatur",
      "facebook": "tempor",
      "first_name": "ad in",
      "id": "magna pariatur",
      "last_name": "ad incididunt adipisicing",
      "line": "dolore ea",
      "list_ids": [
        "laborum"
      ],
      "phone_number": "aute",
      "postal_code": "quis ullamco dolore cupidatat occaecat",
      "segment_ids": [
        "minim",
        "nulla commodo",
        "Lorem laborum incididunt dolore"
      ],
      "state_province_region": "ut commodo incididunt",
      "unique_name": "elit sint qui quis",
      "updated_at": "irure amet",
      "whatsapp": "Ut non"
    },
    {
      "_metadata": {
        "self": "officia"
      },
      "address_line_1": "pariatur irure ex labore in",
      "address_line_2": "ut Duis adipisicing",
      "alternate_emails": [
        "id exercitation sunt reprehenderit",
        "labore in culpa ut do",
        "nostrud adipisicing",
        "nisi ipsum anim amet dolor",
        "incididunt"
      ],
      "city": "et mollit fugiat ex",
      "country": "tempor aliqua eiusmod Excepteur",
      "created_at": "sit Ut consectetur",
      "custom_fields": {},
      "email": "sunt",
      "facebook": "dolor nisi",
      "first_name": "exercitation",
      "id": "Lorem nostrud",
      "last_name": "eu in adipisicing laboris",
      "line": "proident in",
      "list_ids": [
        "magna commodo",
        "Duis cupidatat qui pariatur",
        "magna ex labore",
        "sint dolor nostrud irure",
        "non in tempor in et"
      ],
      "phone_number": "mollit Ut pariatur",
      "postal_code": "amet voluptate",
      "segment_ids": [
        "in nostrud ex adipisicing qui",
        "magna dolore exercitation tempor",
        "dolore",
        "sint"
      ],
      "state_province_region": "enim",
      "unique_name": "sit nisi do ex nostrud",
      "updated_at": "ipsum non fugiat sit ullamco",
      "whatsapp": "voluptate sint"
    },
    {
      "_metadata": {
        "self": "amet ut"
      },
      "address_line_1": "minim in exercitation Excepteur velit",
      "address_line_2": "elit dolor aliquip eiusmod laborum",
      "alternate_emails": [
        "proident anim",
        "Ut",
        "velit tempor"
      ],
      "city": "reprehenderit",
      "country": "enim",
      "created_at": "laborum exercitation do nostrud",
      "custom_fields": {},
      "email": "non cupidatat officia ea elit",
      "facebook": "non ipsum dolore",
      "first_name": "officia et nisi qui pariatur",
      "id": "dolor magna nulla aliquip",
      "last_name": "aute adipisicing",
      "line": "Duis minim",
      "list_ids": [
        "velit id",
        "tempor cupidatat id",
        "eiusmod",
        "consequat sint magna"
      ],
      "phone_number": "commodo elit consectetur sit",
      "postal_code": "consequat aliqua",
      "segment_ids": [
        "sit velit incididunt",
        "est in Excepteur fugiat",
        "aliqua"
      ],
      "state_province_region": "dolore deserunt Lorem",
      "unique_name": "officia in laborum ullamco proident",
      "updated_at": "ad",
      "whatsapp": "ut exercitation ex aliquip sed"
    },
    {
      "_metadata": {
        "self": "sunt commodo aliqua consectetur"
      },
      "address_line_1": "voluptate veniam",
      "address_line_2": "reprehenderit cillum laboris",
      "alternate_emails": [
        "proident ipsum Duis elit",
        "nisi reprehenderit deserunt aliquip"
      ],
      "city": "dolore aute",
      "country": "labore commodo exercitation",
      "created_at": "officia",
      "custom_fields": {},
      "email": "irure qui dolor pariatur",
      "facebook": "sunt nulla Ut",
      "first_name": "sint",
      "id": "Ut aute",
      "last_name": "aliquip tempor",
      "line": "eu velit qui adipisicing",
      "list_ids": [
        "proident laborum",
        "in ad Excepteur enim",
        "in adipisicing aute eu in",
        "eu pariatur id ea"
      ],
      "phone_number": "adipisicing magna occaecat sunt",
      "postal_code": "laborum cupidatat",
      "segment_ids": [
        "ipsum",
        "Lorem proident labore fugiat",
        "dolor do irure"
      ],
      "state_province_region": "quis",
      "unique_name": "velit pariatur incididunt deserunt cupidatat",
      "updated_at": "do est",
      "whatsapp": "occaecat nisi nostrud aliquip sed"
    }
  ]
}
{
  "errors": [
    {
      "field": "consectetur",
      "message": "commodo"
    },
    {
      "field": "dolor consectetur eu elit nostrud",
      "message": "exercitation labore"
    },
    {
      "field": "quis tempor minim id",
      "message": "dolor aute do"
    },
    {
      "field": "ex reprehenderit",
      "message": "est eu dolor voluptate mollit"
    }
  ]
}
{
  "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": "Lorem fugiat labore officia"
    },
    {
      "message": "ut adipisicing incididunt veniam"
    }
  ]
}
Request Payload
{
  "field_mappings": [
    "est",
    null
  ],
  "file_type": "csv",
  "list_ids": [
    "cupidatat elit nulla in",
    "aliquip ut"
  ]
}
Response Payload
{
  "job_id": "eu ut aliqua",
  "upload_headers": [
    {
      "header": "occaecat cillum Excepteur eu",
      "value": "sit"
    }
  ],
  "upload_uri": "sed consequat sunt ad sint"
}
{
  "errors": [
    {
      "error_id": "velit aute consequat magna pariatur",
      "field": "amet id dolore nulla",
      "message": "laborum Duis dolor sint id",
      "parameter": "est nulla id"
    },
    {
      "error_id": "cillum consectetur Excepteur irure",
      "field": "elit aliqua Duis laboris nostrud",
      "message": "ad",
      "parameter": "reprehenderit cillum labore anim"
    },
    {
      "error_id": "officia fugiat non in cillum",
      "field": "culpa",
      "message": "nulla proident enim dolore",
      "parameter": "labore sunt laborum pariatur occaecat"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "irure velit occaecat ex",
      "field": "amet Lorem proident",
      "message": "laboris labore fugiat eiusmod",
      "parameter": "consectetur non reprehenderit"
    },
    {
      "error_id": "laboris qui amet",
      "field": "aliquip",
      "message": "ut id voluptate deserunt eu",
      "parameter": "consequat ut eu"
    },
    {
      "error_id": "qui dolor",
      "field": "eu",
      "message": "irure",
      "parameter": "aute pariatur dolore"
    }
  ]
}
{
  "errors": [
    {
      "message": "sed do Excepteur non consectetur"
    },
    {
      "message": "irure"
    },
    {
      "message": "nostrud enim ea non"
    },
    {
      "message": "consequat"
    },
    {
      "message": "dolore"
    }
  ]
}
Request Payload
Response Payload
{
  "finished_at": "sint elit",
  "id": "sunt ut cupidatat",
  "job_type": "cupidatat",
  "results": {
    "created_count": 55115431.996760845,
    "deleted_count": 73027983.3482174,
    "errored_count": -84592331.44748928,
    "errors_url": "magna aliquip nulla mollit minim",
    "requested_count": -25938142.658793777,
    "updated_count": 46567419.530704826
  },
  "started_at": "in sed deserunt ipsum enim",
  "status": "aliquip occaecat aute ad veniam"
}
{
  "errors": {
    "error_id": "deserunt ipsum Lorem veniam",
    "field": "officia adipisicing nostrud",
    "message": "aliqua cillum nostrud consectetur",
    "parameter": "Ut magna"
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "Duis dolore proident ea"
    },
    {
      "message": "aute"
    },
    {
      "message": "tempor Excepteur"
    },
    {
      "message": "dolore nulla ipsum mollit"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "count": -6610191.515801534,
    "next": "http://n.mqjilhhmUkEVEnUpCr2hwevYIDfDT-qe26jiDLGGNJ1nfMlqNCGhVQA,BVeavU1KX.2srrFtck",
    "prev": "https://dtrCYQQDsSlJZeBFVPajdPs.utdyyTG7W0dpR,IHW,bJxpPppxYCpLVaclkk.Z.sCiZglq9,,eXc",
    "self": "https://aYThyEOPLLKjxt.zeA9cqr"
  },
  "completed_at": "dolor sit quis irure labore",
  "contact_count": 86398311,
  "created_at": "anim aliquip",
  "expires_at": "nulla",
  "id": "reprehenderit proident",
  "message": "Excepteur anim",
  "status": "pending",
  "updated_at": "qui culpa do",
  "urls": [
    "Duis laborum"
  ]
}
{
  "errors": [
    {
      "error_id": "aliquip",
      "field": "et laborum ullamco eiusmod minim",
      "message": "incididunt ullamco",
      "parameter": "non reprehenderit ad"
    },
    {
      "error_id": "eu",
      "field": "ut nisi",
      "message": "incididunt et ut",
      "parameter": "elit"
    },
    {
      "error_id": "dolor",
      "field": "do occaecat in dolore",
      "message": "dolor",
      "parameter": "exercitation"
    },
    {
      "error_id": "nisi ut culpa sed Lorem",
      "field": "veniam",
      "message": "Excepteur reprehenderit",
      "parameter": "ad aliqua"
    },
    {
      "error_id": "Ut laborum amet sunt dolore",
      "field": "sit aliquip tempor mollit commodo",
      "message": "tempor",
      "parameter": "ea sed irure adipisicing"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "id sed"
    },
    {
      "message": "consectetur"
    }
  ]
}
Request Payload
{
  "ids": [
    "1234",
    "1235"
  ]
}
Response Payload
{
  "result": [
    {
      "_metadata": {
        "self": "in"
      },
      "address_line_1": "mollit est Lorem laborum consectetur",
      "address_line_2": "non ex",
      "alternate_emails": [
        "quis laborum in in do",
        "dolor magna Excepteur",
        "nisi",
        "proident ut cupidatat nulla",
        "labore"
      ],
      "city": "elit exercitation voluptate sint in",
      "country": "veniam",
      "created_at": "labore",
      "custom_fields": {},
      "email": "eiusmod incididunt",
      "facebook": "elit sed reprehenderit",
      "first_name": "in dolor Ut",
      "id": "ipsum dolor",
      "last_name": "ut",
      "line": "commodo enim",
      "list_ids": [
        "ut laboris eiusmod",
        "exercitation in ut anim",
        "mollit amet"
      ],
      "phone_number": "incididunt nulla",
      "postal_code": "nisi ipsum Excepteur",
      "segment_ids": [
        "adipisicing",
        "sint in incididunt do eu",
        "est Lorem",
        "voluptate ipsum laboris",
        "ea dolore in irure aliquip"
      ],
      "state_province_region": "aliquip",
      "unique_name": "laboris",
      "updated_at": "quis cillum labore consectetur ipsum",
      "whatsapp": "occaecat Excepteur dolore deserunt"
    },
    {
      "_metadata": {
        "self": "cillum deserunt non Lorem consectetur"
      },
      "address_line_1": "amet ut dolor ut",
      "address_line_2": "dolor",
      "alternate_emails": [
        "elit incididunt esse"
      ],
      "city": "laborum ut ullamco ut",
      "country": "qui commodo sed dolor ipsum",
      "created_at": "ullamco nisi",
      "custom_fields": {},
      "email": "eu fugiat",
      "facebook": "elit",
      "first_name": "cupidatat amet ut enim qui",
      "id": "cillum ex",
      "last_name": "dolore voluptate Ut",
      "line": "non consectetur",
      "list_ids": [
        "commodo amet sunt",
        "mollit exercitation dolore et",
        "aliqua exercitation culpa",
        "mollit",
        "sint consequat reprehenderit incididunt nisi"
      ],
      "phone_number": "in incididunt",
      "postal_code": "consequat",
      "segment_ids": [
        "in Duis in minim elit",
        "mollit proident esse ut labore"
      ],
      "state_province_region": "aliqua minim ut sed",
      "unique_name": "amet adipisicing",
      "updated_at": "eu aute tempor cillum irure",
      "whatsapp": "aliqua nisi"
    },
    {
      "_metadata": {
        "self": "do mollit aute eiusmod ipsum"
      },
      "address_line_1": "sunt commodo velit ad",
      "address_line_2": "magna",
      "alternate_emails": [
        "et dolor cupidatat in",
        "laboris incididunt"
      ],
      "city": "nulla ut magna cupidatat",
      "country": "et aliqua mollit reprehenderit",
      "created_at": "consequat aute ea sit reprehenderit",
      "custom_fields": {},
      "email": "quis",
      "facebook": "irure voluptate",
      "first_name": "in commodo mollit magna voluptate",
      "id": "fugiat dolore id nulla aliquip",
      "last_name": "minim sit reprehenderit pariatur dolore",
      "line": "velit commodo magna ex nostrud",
      "list_ids": [
        "aliqua minim",
        "Excepteur",
        "sit velit anim nostrud cillum"
      ],
      "phone_number": "enim elit exercitation qui",
      "postal_code": "aute adipisicing sit in ut",
      "segment_ids": [
        "anim occaecat elit",
        "exercitation"
      ],
      "state_province_region": "ad ea eu anim",
      "unique_name": "cupidatat fugiat dolor eu",
      "updated_at": "amet consequat ad",
      "whatsapp": "laborum"
    },
    {
      "_metadata": {
        "self": "commodo"
      },
      "address_line_1": "aliqua consectetur in",
      "address_line_2": "in",
      "alternate_emails": [
        "in non ipsum et reprehenderit",
        "sed do id",
        "ipsum consectetur",
        "ut adipisicing aliqua proident ea",
        "cillum"
      ],
      "city": "esse in",
      "country": "tempor nulla",
      "created_at": "ut cillum",
      "custom_fields": {},
      "email": "id dolore deserunt aliqua",
      "facebook": "laboris consequat esse dolore enim",
      "first_name": "ut proident aliquip",
      "id": "Ut consectetur veniam esse",
      "last_name": "id reprehenderit nulla culpa velit",
      "line": "dolor et sit",
      "list_ids": [
        "velit cillum fugiat deserunt",
        "non in"
      ],
      "phone_number": "ea Excepteur in",
      "postal_code": "Duis",
      "segment_ids": [
        "reprehenderit sint anim",
        "sed laborum reprehenderit cillum mollit"
      ],
      "state_province_region": "ullamco ea",
      "unique_name": "Excepteur aute reprehenderit Ut",
      "updated_at": "consectetur deserunt quis qui labore",
      "whatsapp": "enim tempor"
    },
    {
      "_metadata": {
        "self": "Ut"
      },
      "address_line_1": "nostrud deserunt",
      "address_line_2": "cupidatat incididunt",
      "alternate_emails": [
        "anim amet",
        "sed esse proident"
      ],
      "city": "eu amet sint ut",
      "country": "ipsum in officia",
      "created_at": "velit nostrud",
      "custom_fields": {},
      "email": "consectetur Duis aute Excepteur",
      "facebook": "sunt Duis ea elit velit",
      "first_name": "ut est veniam exercitation in",
      "id": "ut sit ea",
      "last_name": "proident commodo amet occaecat",
      "line": "sed incididunt aliquip",
      "list_ids": [
        "tempor ipsum mollit non veniam",
        "occaecat Lorem veniam in",
        "sunt pariatur",
        "sit ut in commodo adipisicing"
      ],
      "phone_number": "amet in",
      "postal_code": "ut reprehenderit in deserunt mollit",
      "segment_ids": [
        "incididunt Ut non",
        "Excepteur in esse",
        "aliqua in dolor do"
      ],
      "state_province_region": "tempor commodo nostrud aute",
      "unique_name": "non enim minim",
      "updated_at": "ut veniam Ut",
      "whatsapp": "aliqua"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "ut ipsum do Excepteur"
    },
    {
      "message": "laboris Lorem"
    },
    {
      "message": "sunt aliqua dolore"
    },
    {
      "message": "minim"
    }
  ]
}
Request Payload
{
  "emails": [
    "jane_doe@example.com",
    "john_doe@example.com",
    "joann_doe@example.com"
  ]
}
Response Payload
{
  "result": {
    "jane_doe@example.com": {
      "contact": {
        "address_line_1": "",
        "address_line_2": "",
        "alternate_emails": [
          "janedoe@example1.com"
        ],
        "city": "",
        "country": "",
        "email": "jane_doe@example.com",
        "first_name": "Jane",
        "id": "asdf-Jkl-zxCvBNm",
        "last_name": "Doe",
        "list_ids": [],
        "segment_ids": [],
        "postal_code": "",
        "state_province_region": "",
        "phone_number": "",
        "whatsapp": "",
        "line": "",
        "facebook": "",
        "unique_name": "",
        "custom_fields": {},
        "created_at": "2021-03-02T15:25:47Z",
        "updated_at": "2021-03-30T15:26:16Z",
        "_metadata": {
          "self": "<metadata_url>"
        }
      }
    },
    "john_doe@example.com": {
      "contact": {
        "address_line_1": "",
        "address_line_2": "",
        "alternate_emails": [],
        "city": "",
        "country": "",
        "email": "john_doe@example.com",
        "first_name": "Jane",
        "id": "asdf-Jkl-qWeRTy",
        "last_name": "Doe",
        "list_ids": [],
        "segment_ids": [],
        "postal_code": "",
        "state_province_region": "",
        "phone_number": "",
        "whatsapp": "",
        "line": "",
        "facebook": "",
        "unique_name": "",
        "custom_fields": {},
        "created_at": "2020-01-02T15:25:47Z",
        "updated_at": "2020-12-20T15:26:16Z",
        "_metadata": {
          "self": "<metadata_url>"
        }
      }
    },
    "joann_doe@example.com": {
      "error": "contact not found"
    }
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ut"
    },
    {
      "message": "dolor id"
    }
  ]
}

Segmenting Contacts V2 - Beta(5 operations)

Request Payload
{
  "name": "in deserunt",
  "parent_list_ids": [
    "exercitation nulla laboris"
  ],
  "query_dsl": "amet velit quis sit"
}
Response Payload
{
  "contacts_count": -25672294,
  "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": "dolore consequat ea ex esse",
  "id": "ca72961b-cb44-d263-76c8-cf4dc931878a",
  "name": "minim",
  "next_sample_update": "deserunt",
  "parent_list_ids": [
    "dolore nisi",
    "nisi",
    "deserunt ipsum dolore elit"
  ],
  "query_dsl": "nulla nisi",
  "query_version": "cupidatat",
  "sample_updated_at": "velit enim",
  "status": {
    "error_message": "amet aliqua",
    "query_validation": "culpa Duis dolore ipsum"
  },
  "updated_at": "in velit magna aliqua ad"
}
{
  "errors": [
    {
      "field": "elit laboris non",
      "message": "reprehenderit anim"
    }
  ]
}
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": "commodo ut ullamco Ut dolore",
      "message": "adipisicing nisi"
    }
  ]
}
Query Parameter NameExample
parent_list_idsea
no_parent_list_idtrue
Request Payload
Response Payload
{
  "_metadata": {
    "count": 6087152,
    "next": "https://GUQdkmEkwEyFEjcx.nsgkywygdXhiJlba2AF",
    "prev": "http://ghZddIHMyZSg.cdvh+hH",
    "self": "https://ZcWzIeIfmEbAyDILkaSBjhkdlCERiNre.nyqQu"
  },
  "contacts_count": 5896434,
  "created_at": "aliqua quis",
  "id": "a1c8b30e-45b9-1bc2-f427-518146a25117",
  "name": "E",
  "next_sample_update": "consectetur Duis est dolor",
  "parent_list_ids": [
    "cupidatat incididunt adipisicing culpa cillum",
    "est adipisicing ea",
    "irure",
    "do enim reprehenderit consequat voluptate"
  ],
  "query_version": "in occaecat enim pariatur",
  "sample_updated_at": "irure ex mollit culpa",
  "status": {
    "error_message": "eiusmod",
    "query_validation": "Ut"
  },
  "updated_at": "commodo nostrud veniam"
}
{
  "errors": [
    {
      "field": "ex officia",
      "message": "velit qui ex esse"
    },
    {
      "field": "irure et commodo",
      "message": "commodo reprehenderit"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "non",
      "message": "culpa ut"
    },
    {
      "field": "magna proident velit eiusmod",
      "message": "commodo"
    },
    {
      "field": "eu",
      "message": "ipsum incididunt cupidatat aliquip"
    }
  ]
}
Request Payload
{
  "name": "ut cillum ea consec",
  "query_dsl": "enim cillum mollit"
}
Response Payload
{
  "contacts_count": -90284046,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "minim in",
  "id": "9d11b215-c05b-dd34-e29f-e175c27ee478",
  "name": "elit aliquip dolore reprehenderit",
  "next_sample_update": "sunt in laboris laborum reprehenderit",
  "parent_list_ids": [
    "irure sint eu reprehenderit",
    "in",
    "commodo",
    "esse Duis velit sit"
  ],
  "query_dsl": "fugiat proident ad",
  "query_version": "mollit ullamco eiusmod cupidatat",
  "sample_updated_at": "eiusmod sit Duis",
  "status": {
    "error_message": "occaecat",
    "query_validation": "do"
  },
  "updated_at": "qui esse dolor magna Excepteur"
}
{
  "errors": [
    {
      "field": "reprehenderit",
      "message": "id ad enim velit occaecat"
    },
    {
      "field": "mollit cillum elit",
      "message": "ad cupidatat labore in"
    },
    {
      "field": "nulla",
      "message": "id exercitation"
    },
    {
      "field": "laboris commodo",
      "message": "do"
    },
    {
      "field": "in Ut",
      "message": "commodo et"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "nulla elit aliqua",
      "message": "voluptate qui consectetur"
    },
    {
      "field": "mollit ipsum enim incididunt",
      "message": "sint amet consequat"
    },
    {
      "field": "reprehenderit ut et",
      "message": "anim"
    },
    {
      "field": "sint",
      "message": "ex officia minim ad aliqua"
    }
  ]
}
Query Parameter NameExample
contacts_samplefalse
Request Payload
Response Payload
{
  "contacts_count": -20818259,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "Duis ipsum",
  "id": "94727c33-d5b2-5c7c-b72b-02d3bda26fb4",
  "name": "dolor reprehenderit m",
  "next_sample_update": "Excepteur commodo",
  "parent_list_ids": [
    "eu officia eiusmod"
  ],
  "query_dsl": "magna consectetur labore sed ullamco",
  "query_version": "reprehenderit eu adipisicing",
  "sample_updated_at": "occaecat veniam nulla",
  "status": {
    "error_message": "est",
    "query_validation": "deserunt nulla do veniam culpa"
  },
  "updated_at": "elit nostrud aliquip mollit"
}
{
  "errors": [
    {
      "field": "commodo officia",
      "message": "ipsum dolore aliqua aute"
    },
    {
      "field": "labore cillum qui incididunt",
      "message": "ut Lorem id eu sit"
    },
    {
      "field": "ea qui reprehenderit dolor veniam",
      "message": "ut laboris"
    },
    {
      "field": "eu laboris mollit in sint",
      "message": "laborum eiusmod"
    }
  ]
}
{
  "errors": [
    {
      "field": "eu Lorem ea minim",
      "message": "sunt veniam"
    },
    {
      "field": "culpa",
      "message": "qui cillum aliqua laborum"
    },
    {
      "field": "ut non nisi sunt",
      "message": "incididunt"
    },
    {
      "field": "exercitation nisi culpa sunt ad",
      "message": "ea"
    },
    {
      "field": "ut veniam culpa",
      "message": "minim amet quis"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "sed occaecat",
      "message": "laborum dolor"
    },
    {
      "field": "officia proident consectetur amet voluptate",
      "message": "consequat sint"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "veniam qui enim officia in",
      "message": "proident deserunt fugiat voluptate irure"
    }
  ]
}

Senders

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

Lists(7 operations)

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

Custom Fields(4 operations)

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

segmenting contacts(5 operations)

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

Segmenting Contacts

Request Payload
{
  "ids": [
    "a14dcc63-d651-4c57-9826-4a3705f5c78d",
    "f3de551e-dc5c-4d42-bd08-c7f87f87f0e8",
    "1b8107b5-adf4-401c-8865-fa84ba178fb9",
    "d7900715-c904-4728-acff-9ab79627579e",
    "16641f5b-cfa3-41b9-9626-244488ee85b1"
  ]
}
Response Payload
{
  "errors": [
    {
      "error": "cillum labore dolore est et",
      "id": "eu officia",
      "resources": {
        "ids": [
          "adipisicing commodo"
        ],
        "type": "tempor deserunt aliquip"
      }
    },
    {
      "error": "laboris Lorem",
      "id": "in ipsum sit minim id",
      "resources": {
        "ids": [
          "et cillum ut anim",
          "esse sunt"
        ],
        "type": "eu"
      }
    },
    {
      "error": "in amet et",
      "id": "laborum cillum culpa",
      "resources": {
        "ids": [
          "proident id incididunt mollit veniam",
          "proident tempor veniam"
        ],
        "type": "sed Duis voluptate esse"
      }
    }
  ]
}
{}
{
  "errors": [
    {
      "field": "proident cupidatat aute ullamco enim",
      "message": "irure officia"
    },
    {
      "field": "nulla Excepteur laborum proident reprehenderit",
      "message": "aliquip ad Duis aute deserunt"
    },
    {
      "field": "ipsum",
      "message": "aliqua magna"
    },
    {
      "field": "qui",
      "message": "laboris incididunt Excepteur eiusmod"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "Lorem voluptate"
    },
    {
      "message": "aliqua tempor nulla commodo eu"
    },
    {
      "message": "quis in"
    }
  ]
}

Single Sends(11 operations)

Request Payload
{
  "name": "Example API Created Single Send",
  "categories": [
    "unique opens"
  ],
  "send_to": {
    "all": true
  },
  "email_config": {
    "design_id": "<your-design-id>",
    "editor": "design",
    "suppression_group_id": 12345,
    "sender_id": 1234567
  }
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "error_id": "laborum sunt dolor qui nulla",
      "field": "amet",
      "message": "dolore tempor sint nulla culpa"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ut",
      "field": "commodo et",
      "message": "amet commodo laborum irure aute"
    }
  ]
}
Query Parameter NameExample
page_size-25359212
page_tokennon exercitation reprehenderit ex sed
Request Payload
Response Payload
{
  "_metadata": {
    "count": 25351058,
    "next": "https://Ptp.hxtdoCQOQxwifOkSNrAL-sd-fHatp9afMhfR1Cfcrrp5HLPHCpDJEJr,-6zPXM5jZ-RssQzbf-owbtd7jb",
    "prev": "https://ucPGlDdPHAnHkcYRtAItG.bqheT5.3XS7H9caTgc8+5.63RUa9nc3o",
    "self": "http://lj.keeMVYaZThxMKKakX+12bHZYYz"
  },
  "result": [
    {
      "abtest": null,
      "categories": [
        "qui labore quis ut",
        "est cupidatat labore deserunt Duis",
        "anim in id proident",
        "cupidatat reprehenderit",
        "dolor occaecat quis cupidatat",
        "esse Excepteur dolore dolore anim",
        "sed voluptate",
        "enim",
        "qui",
        "Duis"
      ],
      "created_at": "1943-07-04T10:08:57.0Z",
      "id": "f8d20227-de95-c703-26a0-28569ae97b69",
      "is_abtest": true,
      "name": "esse anim",
      "send_at": "1951-06-27T01:12:50.0Z",
      "status": "scheduled",
      "updated_at": "1952-07-08T22:49:12.0Z"
    },
    {
      "abtest": null,
      "categories": [
        "voluptate nulla cupidatat irure",
        "quis",
        "est sed commodo amet minim",
        "sed adipisicing tempor irure",
        "laborum quis",
        "eiusmod sint",
        "ullamco Duis occaecat mollit sunt",
        "in ex Ut aute",
        "in veniam aute ut in",
        "voluptate minim cillum"
      ],
      "created_at": "1950-11-02T18:53:56.0Z",
      "id": "de0c4a1d-98b6-06f0-d6c7-000ce7da5d77",
      "is_abtest": true,
      "name": "pr",
      "send_at": "1892-01-01T22:09:03.0Z",
      "status": "scheduled",
      "updated_at": "1960-12-10T15:55:57.0Z"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "adipisicing",
      "field": "labore fugiat commodo laborum",
      "message": "nulla incididunt qui quis elit"
    },
    {
      "error_id": "in",
      "field": "Duis pariatur sunt mollit",
      "message": "voluptate officia"
    },
    {
      "error_id": "quis",
      "field": "Excepteur consectetur",
      "message": "id in"
    },
    {
      "error_id": "cupidatat ullamco in deserunt in",
      "field": "Lorem",
      "message": "minim ea"
    },
    {
      "error_id": "deserunt ex fugiat",
      "field": "Lorem cupidatat adipisicing",
      "message": "cillum qui"
    }
  ]
}
Query Parameter NameExample
ids["velit ipsum aute","dolor","in irure anim sit ullamco","in deserunt aliquip Ut labore","sint","enim est nulla nostrud","incididunt ullamco dolor","incididunt","culpa quis deserunt","incididunt nulla dolor sed aliqua"]
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "exercitation ea",
      "field": "id eiusmod qui",
      "message": "magna voluptate"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "est voluptate incididunt ullamco",
      "field": "aliquip adipisicing velit anim",
      "message": "ullamco nisi nulla proident"
    },
    {
      "error_id": "dolore Lorem incididunt",
      "field": "velit in commodo enim fugiat",
      "message": "est ea ad culpa"
    },
    {
      "error_id": "ex",
      "field": "non",
      "message": "dolor in cupidatat ipsum sint"
    }
  ]
}
Request Payload
{
  "name": "irure dolor incididunt est"
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "error_id": "in anim dolor est laboris",
      "field": "ad ipsum",
      "message": "qui exercitation minim deserunt Duis"
    },
    {
      "error_id": "ipsum incididunt occaecat",
      "field": "ad labore minim Excepteur enim",
      "message": "aute officia culpa"
    },
    {
      "error_id": "anim Ut",
      "field": "commodo",
      "message": "veniam exercitation dolore do"
    },
    {
      "error_id": "Ut",
      "field": "Lorem",
      "message": "esse commodo aliquip est sed"
    },
    {
      "error_id": "cupidatat eu est reprehenderit",
      "field": "et dolor ad labore ullamco",
      "message": "ullamco"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "nisi",
      "field": "anim est veniam esse fugiat",
      "message": "pariatur consectetur voluptate ex Excepteur"
    },
    {
      "error_id": "laboris qui sit consequat",
      "field": "veniam quis",
      "message": "incididunt labore ad"
    },
    {
      "error_id": "officia amet sunt sed Ut",
      "field": "magna sit est reprehenderit sunt",
      "message": "consectetur aliquip voluptate"
    }
  ]
}
Request Payload
{
  "categories": [
    "velit anim",
    "cillum aliquip Duis sit",
    "id occaecat eiusmod",
    "ex proident sunt",
    "aute et ullamco Lorem magna",
    "veniam mollit nulla",
    "magna minim mollit",
    "quis et elit consectetur labore",
    "et Lorem",
    "in dolor do"
  ],
  "email_config": {
    "custom_unsubscribe_url": null,
    "design_id": "voluptate dolor ut",
    "editor": "design",
    "generate_plain_content": true,
    "html_content": "laboris pariatur eu",
    "ip_pool": null,
    "plain_content": "fugiat",
    "sender_id": null,
    "subject": "nostrud dolor ut reprehenderit consectetur",
    "suppression_group_id": 74737390
  },
  "name": "aute et dolore",
  "send_at": "1890-11-22T20:56:16.0Z",
  "send_to": {
    "all": false,
    "list_ids": [
      "5be6cf16-25f8-548d-e584-3f2041bfd8eb",
      "4a0160d0-f892-1a32-c5c5-4cb3a880bcf6",
      "ee27319b-d7a4-d3c2-c39b-88a6a15f8841",
      "016dfab8-53fd-4f95-4792-d134a28825cb",
      "ce93fb99-21c9-9aad-7d82-2b564d996b5d",
      "b581406b-7545-f178-448c-5a5b7e2abf69",
      "507fcf5f-a73b-7df7-00b1-14f9e56b4332",
      "582ac2b7-e18f-7f6b-278d-5c163b79c06f",
      "ebfc6cd7-b6d3-cdca-3d3c-506b71ae13df",
      "252ffec8-ed0c-191b-4d32-45e09d0f7215"
    ],
    "segment_ids": [
      "fd101265-5078-d552-a111-e47f614ca912",
      "3b89e3b3-97d0-cdd1-df5e-28f4b256beac",
      "dc2005dc-c72c-928a-8e63-87b15b25e195",
      "a96041b5-dd57-5366-cdfb-f0f64d5c6f29",
      "da9acb89-0f5d-5fea-bc5d-acb2f8701c80",
      "4c24214a-dbac-e92f-8257-720eda81a091",
      "9e631d5c-4e02-ae26-55e1-cb351eb9b93b",
      "6d015ca4-1e22-aaca-d94d-ff716f5a58db",
      "f6cdf0d7-0a96-d48f-b264-5518085fab2b",
      "bcc85f2e-92a8-07eb-0108-ead23224bd91"
    ]
  }
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "error_id": "Duis sint aliqua",
      "field": "mollit cupidatat esse sed",
      "message": "anim eiusmod exercitation"
    },
    {
      "error_id": "veniam ipsum eu fugiat",
      "field": "dolore irure",
      "message": "veniam dolor"
    },
    {
      "error_id": "elit officia",
      "field": "non dolore",
      "message": "Ut irure nulla anim"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "Duis in in et",
      "field": "fugiat reprehenderit dolore",
      "message": "voluptate proident aliquip dolor"
    },
    {
      "error_id": "tempor ut occaecat et laboris",
      "field": "reprehenderit id Excepteur labore",
      "message": "labore"
    },
    {
      "error_id": "nisi non",
      "field": "aute ullamco ut esse consectetur",
      "message": "ipsum"
    },
    {
      "error_id": "dolor",
      "field": "sint dolore",
      "message": "labore aute voluptate occaecat"
    },
    {
      "error_id": "ea exercitation",
      "field": "aute",
      "message": "laborum aliquip cillum reprehenderit minim"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "Excepteur in consectetur",
      "field": "dolore",
      "message": "occaecat aute Excepteur proident Lorem"
    }
  ]
}
Request Payload
Response Payload
{
  "name": "single-send-1",
  "id": "2f6dec81-43b9-4c67-a890-3a38cb63b54a",
  "status": "scheduled",
  "created_at": "2020-12-13T16:24:42.013Z",
  "send_to": {
    "segment_ids": [
      "dad84de3-bec4-4e04-b132-2cbfd4bb3789",
      "7dce758d-1155-4102-88d2-ca65565ac98b"
    ],
    "all": true
  }
}
{
  "errors": [
    {
      "error_id": "nulla ipsum aliqua sunt",
      "field": "veniam nulla eu pariatur",
      "message": "laborum velit sit ullamco sint"
    },
    {
      "error_id": "exercitation elit",
      "field": "fugiat magna",
      "message": "dolor Ut"
    },
    {
      "error_id": "anim ex nisi",
      "field": "sit eu velit et ea",
      "message": "ea adipisicing commodo ut"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "amet nulla",
      "field": "anim quis ipsum ullamco",
      "message": "adipisicing incididunt in ullamco minim"
    },
    {
      "error_id": "minim et",
      "field": "aliqua eiusmod",
      "message": "sunt Lorem culpa Ut non"
    },
    {
      "error_id": "in",
      "field": "non dolore quis consectetur dolore",
      "message": "sint ad adipisicing et cillum"
    },
    {
      "error_id": "elit",
      "field": "sint",
      "message": "et commodo Excepteur nulla consequat"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "ea",
      "field": "non veniam Ut laboris",
      "message": "id consequat nulla"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "incididunt",
      "field": "ad commodo consequat consectetur",
      "message": "in do"
    },
    {
      "error_id": "culpa dolor do in Excepteur",
      "field": "qui mollit pariatur",
      "message": "sint esse deserunt id labore"
    },
    {
      "error_id": "dolor aute culpa cillum",
      "field": "consequat",
      "message": "aliqua laborum tempor non dolor"
    }
  ]
}
Query Parameter NameExample
page_size-75732450
page_tokennulla Ut fugiat irure ullamco
Request Payload
{
  "name": "specific-single-send-name",
  "status": [
    "draft",
    "scheduled"
  ],
  "categories": [
    "shoes"
  ]
}
Response Payload
{
  "result": [
    {
      "id": "df25ffdf-6a96-458a-9419-6d87d3094c6b",
      "name": "single-send-1",
      "status": "triggered",
      "categories": [
        "shoes"
      ],
      "is_abtest": true,
      "updated_at": "3263-04-09T09:05:08.193Z",
      "created_at": "4739-10-29T07:11:32.476Z",
      "send_at": "2471-05-31T15:46:18.797Z"
    }
  ],
  "_metadata": {
    "self": "nwNSrPSWt7d",
    "prev": "P0Enoayd",
    "next": "DYEsTUDww9-",
    "count": 1
  }
}
{
  "errors": [
    {
      "error_id": "consequat eu nisi labore",
      "field": "culpa",
      "message": "cillum tempor culpa proident"
    },
    {
      "error_id": "ut Excepteur sunt",
      "field": "consequat ut deserunt Lorem Excepteur",
      "message": "aute voluptate Ut"
    }
  ]
}
Request Payload
{
  "send_at": "3752-01-28T23:21:52.575Z"
}
Response Payload
{
  "send_at": "3752-01-28T23:21:52.575Z",
  "status": "scheduled"
}
{
  "errors": [
    {
      "error_id": "non in labore ex",
      "field": "Ut ut",
      "message": "tempor proident officia ex"
    },
    {
      "error_id": "velit reprehenderit mollit in ea",
      "field": "tempor ea do",
      "message": "anim"
    },
    {
      "error_id": "aute",
      "field": "sint fugiat deserunt",
      "message": "Lorem officia tempor nisi"
    },
    {
      "error_id": "consequat Duis ex exercitation aliqua",
      "field": "consectetur sed dolor",
      "message": "eu amet dolore non consequat"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sit aliquip et",
      "field": "sint ad ullamco ex",
      "message": "Ut"
    },
    {
      "error_id": "magna anim non amet voluptate",
      "field": "et qui fugiat irure dolor",
      "message": "dolore minim nostrud reprehenderit"
    },
    {
      "error_id": "non velit",
      "field": "magna sit ipsum",
      "message": "Lorem occaecat"
    }
  ]
}
Request Payload
Response Payload
{
  "send_at": "1949-01-25T06:26:22.0Z",
  "status": "triggered"
}
{
  "errors": [
    {
      "error_id": "ipsum consectetur aute aliqua voluptate",
      "field": "eiusmod exercitation dolore Ut",
      "message": "nostrud"
    },
    {
      "error_id": "officia",
      "field": "quis cillum ex",
      "message": "amet"
    },
    {
      "error_id": "commodo deserunt",
      "field": "consequat sed",
      "message": "dolor ad"
    },
    {
      "error_id": "exercitation commodo tempor in aliquip",
      "field": "exercitation dolore ullamco deserunt officia",
      "message": "dolor dolor magna do est"
    },
    {
      "error_id": "Excepteur quis id culpa sit",
      "field": "dolor nisi ut sint in",
      "message": "in labore irure"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "eiusmod exercitation",
      "field": "consequat in Lorem fugiat",
      "message": "dolore exercitation reprehenderit consectetur"
    },
    {
      "error_id": "sed adipisicing",
      "field": "Ut",
      "message": "ut dolor ex"
    }
  ]
}
Request Payload
Response Payload
{
  "categories": [
    "equipment",
    "shoes",
    "sports"
  ]
}
{
  "errors": [
    {
      "error_id": "ut",
      "field": "sit incididunt Excepteur",
      "message": "fugiat occaecat"
    },
    {
      "error_id": "in voluptate non elit aliquip",
      "field": "ut elit veniam irure",
      "message": "dolore"
    },
    {
      "error_id": "Duis adipisicing",
      "field": "tempor labore sed",
      "message": "non"
    },
    {
      "error_id": "dolore nisi",
      "field": "ipsum",
      "message": "est non ut"
    }
  ]
}

Send Test Email

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

Marketing Campaigns Stats(8 operations)

Query Parameter NameExample
automation_ids["magna","consequat magna id","nisi eiusmod","irure adipisicing exercitation dolor","esse ut do pariatur","do sed cillum cupidatat","incididunt consequat","dolor Lorem cupidatat ex","laborum quis occaecat ex","Duis Excepteur ipsum do"]
page_size20
page_tokencommodo qui et laborum sint
Request Payload
Response Payload
{
  "_metadata": {
    "count": -64935543.53827582,
    "next": "https://VT.fmsgxenIB7,HvXG1hkU3+-QX2RTrC-P2pr5+is4RNAgw-xLmpV8mKKa4Ak",
    "prev": "http://mwnlXPtIU.mhkigD,vIuB.fwZHWVl2k.sJS2.Wctq9JJKGOZ0m3AKoi3dOulkbvftNMG+xTO12",
    "self": "http://nsgiViwJEKeMxVuPcedaStgRCgsXSH.mwgzyDgnc8t8Gtf0eVnHFGbcwEMKihNN+P.O2z1Ue1JY,O+Biihpgyzkp"
  },
  "results": [
    {
      "aggregation": "sunt",
      "id": "f723d1fc-eb8c-a66e-edd1-f8a23c2fe760",
      "stats": {
        "bounce_drops": -64663616,
        "bounces": -50319884,
        "clicks": -7099405,
        "delivered": 38331770,
        "invalid_emails": -80152014,
        "opens": -12170915,
        "requests": 64105219,
        "spam_report_drops": 17050629,
        "spam_reports": -97273630,
        "unique_clicks": 79569859,
        "unique_opens": 26621341,
        "unsubscribes": -8808966
      },
      "step_id": "ea minim"
    },
    {
      "aggregation": "anim",
      "id": "c8b1130d-897d-c6cf-4280-e819a5a698a7",
      "stats": {
        "bounce_drops": -16576291,
        "bounces": 24348380,
        "clicks": 24953161,
        "delivered": 14026250,
        "invalid_emails": 39133209,
        "opens": -92638117,
        "requests": 49758280,
        "spam_report_drops": 82064662,
        "spam_reports": 23386068,
        "unique_clicks": -85639706,
        "unique_opens": 95029985,
        "unsubscribes": 93192247
      },
      "step_id": "aute cupidatat"
    },
    {
      "aggregation": "aute",
      "id": "c50e9bbf-2cd7-7e71-02ab-45266e1a6eaa",
      "stats": {
        "bounce_drops": -82972895,
        "bounces": -58757051,
        "clicks": -74024985,
        "delivered": 5102934,
        "invalid_emails": -60057603,
        "opens": 38167191,
        "requests": -73577723,
        "spam_report_drops": -43868593,
        "spam_reports": 99752799,
        "unique_clicks": -88483842,
        "unique_opens": -38470799,
        "unsubscribes": 40244412
      },
      "step_id": "in"
    },
    {
      "aggregation": "et ut ex amet nulla",
      "id": "8f470a97-90f4-fac7-4b99-e56741c7dc36",
      "stats": {
        "bounce_drops": 8990673,
        "bounces": 43469689,
        "clicks": 14451162,
        "delivered": -41606082,
        "invalid_emails": -35333931,
        "opens": 65251394,
        "requests": -80954609,
        "spam_report_drops": -25231324,
        "spam_reports": 53831351,
        "unique_clicks": 15183736,
        "unique_opens": 66814173,
        "unsubscribes": -5738849
      },
      "step_id": "quis dolore"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
group_by["step_id","step_id","step_id"]
step_ids["2c0cccf5-0fd2-99ca-8dfc-42ff15e0f912","948270db-87c4-e954-0c4e-c83f5fd82ae1","426e5a6d-b9ed-25f1-3a11-f103369d2361"]
aggregated_byday
start_date1935-08-13
end_date1930-10-24
timezoneLorem dolore amet ea mollit
page_size95
page_tokenanim
Request Payload
Response Payload
{
  "_metadata": {
    "count": -53435926.614052184,
    "next": "http://lomIqTmiEUMVaCQeQd.gnGG,XLK2R+dSnseOU5W1KDrAgBTucOR,yn3tG1WqwHZ5vceMJBkk2RKoHCCsDG82N8TF4wt4G+",
    "prev": "https://b.fpzUaiL4Ai6mZ.kXFuo,",
    "self": "https://HhUWSLDsszQFtvDtEEDTXDZPyVFd.kxxoKKisYK8fdJWKjYIcHaKpf6wJ0"
  },
  "results": [
    {
      "aggregation": "eiusmod in",
      "id": "bbb9eb0f-c8dc-e1b4-e00e-e24af60262d2",
      "stats": {
        "bounce_drops": -69503988,
        "bounces": 2808261,
        "clicks": 77469523,
        "delivered": 92853275,
        "invalid_emails": -69352956,
        "opens": 48637162,
        "requests": -16548682,
        "spam_report_drops": -26084196,
        "spam_reports": -873130,
        "unique_clicks": 29790915,
        "unique_opens": -7472690,
        "unsubscribes": -98165922
      },
      "step_id": "consequat esse et dolore"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
singlesend_ids["in veniam ullamco aute proident","ullamco laborum culpa","occaecat esse est magna","enim ad laborum sint","officia aliquip sit occaecat elit","id ex exercitation","laborum","nostrud labore dolore dolor","dolor quis eiusmod","deserunt sint mollit proident tempor"]
page_size7
page_tokenadipisicing
Request Payload
Response Payload
{
  "_metadata": {
    "count": 62460840.78781435,
    "next": "http://HRdiatPGPUEvl.haUGJHbidbGY,9dBlOe6DMpeaIITizQ6k8jkZ1gVPPMZr7",
    "prev": "http://czFnaxCxVUW.cecYwhUG41RF5",
    "self": "https://JmrNEZ.yhpqs6dBZfTSSn5iKTdjjkcFfU2o-1KPeTigkudMtWHLkbJx-aBZ"
  },
  "results": [
    {
      "ab_phase": "send",
      "ab_variation": "594c57a8-59ae-8a58-dac2-52e64cc37a34",
      "aggregation": "deserunt",
      "id": "5490b022-7492-036d-2cc8-7d2757465ea8",
      "stats": {
        "bounce_drops": 6179154,
        "bounces": 94711762,
        "clicks": 82669058,
        "delivered": 61856672,
        "invalid_emails": -13915222,
        "opens": 61801849,
        "requests": -83865507,
        "spam_report_drops": -58522369,
        "spam_reports": -40402498,
        "unique_clicks": 75587979,
        "unique_opens": -34603668,
        "unsubscribes": -93918593
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
aggregated_bytotal
start_date1936-04-25
end_date1935-03-23
timezoneExcepteur
page_size45
page_tokenin voluptate amet ad do
group_by["ab_phase","ab_phase"]
Request Payload
Response Payload
{
  "_metadata": {
    "count": 50734798.15282461,
    "next": "https://tRMbFOBFoBrvOkfedrZKbaeGjQTiMKG.lavMVS9EXiGIM0uv+T5ACV4kTQARB,TRzIAs8d4SeobMU0XBbCKc2FKfdi",
    "prev": "http://MNzVpUHO.hvrkIlBfBOe52ERM0SSfsL7u3QyhjPXYxhQZqh+.PJtV9ljoLyex4e",
    "self": "https://UbkmINijmgwNnmzchUTYrwIneaT.vknydA6uUwrzvFxNOwOONzTKgIHoi"
  },
  "results": [
    {
      "ab_phase": "send",
      "ab_variation": "ab6976d4-f263-b847-7427-8e7fa0c3ec9b",
      "aggregation": "ex esse Ut",
      "id": "0cc83e88-aec4-6805-adb9-537f80333b79",
      "stats": {
        "bounce_drops": 30411186,
        "bounces": -28910275,
        "clicks": 26485404,
        "delivered": -11115753,
        "invalid_emails": 54969575,
        "opens": -31211712,
        "requests": 49223474,
        "spam_report_drops": -14775764,
        "spam_reports": 18523199,
        "unique_clicks": 96731997,
        "unique_opens": 73325413,
        "unsubscribes": 28588951
      }
    },
    {
      "ab_phase": "all",
      "ab_variation": "1e45b910-8c50-69bf-c5d0-55ab5ac32768",
      "aggregation": "adipisicing ipsum elit",
      "id": "4415a861-d63a-a14d-b3ca-44a9cdc71690",
      "stats": {
        "bounce_drops": -45155183,
        "bounces": -480768,
        "clicks": -66709398,
        "delivered": 92295424,
        "invalid_emails": -79222613,
        "opens": -43426618,
        "requests": 47571133,
        "spam_report_drops": -14199219,
        "spam_reports": 52735235,
        "unique_clicks": -52318440,
        "unique_opens": 60704904,
        "unsubscribes": 31679090
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "6d3cf0d5-5b58-979d-05ad-4c3af8e79073",
      "aggregation": "elit",
      "id": "7c2a59fb-048a-71b3-4438-fcf2f48f5dff",
      "stats": {
        "bounce_drops": 7053267,
        "bounces": -35305273,
        "clicks": 89295964,
        "delivered": -79982717,
        "invalid_emails": -15341508,
        "opens": -34419128,
        "requests": -5354636,
        "spam_report_drops": -9816066,
        "spam_reports": -11207188,
        "unique_clicks": -1611793,
        "unique_opens": 70073529,
        "unsubscribes": 35105325
      }
    },
    {
      "ab_phase": "send",
      "ab_variation": "432c3ae1-746d-5b92-bb23-5da49d66deee",
      "aggregation": "Excepteur cillum et ipsum",
      "id": "643a89f0-8128-cd8c-9e9b-b137df5c2d11",
      "stats": {
        "bounce_drops": -81855909,
        "bounces": 10060351,
        "clicks": 64004595,
        "delivered": 93439977,
        "invalid_emails": -1284806,
        "opens": 7065892,
        "requests": -86720445,
        "spam_report_drops": 89220081,
        "spam_reports": -69595557,
        "unique_clicks": 70932724,
        "unique_opens": 64905386,
        "unsubscribes": -71863004
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "e79b8d32-783d-0c99-7d01-e86dec89d9d4",
      "aggregation": "voluptate qui sunt anim ipsum",
      "id": "abb6fdfd-e0b1-2f77-303b-43f4df2fbd4b",
      "stats": {
        "bounce_drops": -24738620,
        "bounces": -97863649,
        "clicks": 40831109,
        "delivered": -19674949,
        "invalid_emails": -67167193,
        "opens": 58633239,
        "requests": 36086138,
        "spam_report_drops": -2253149,
        "spam_reports": -75677400,
        "unique_clicks": -37435837,
        "unique_opens": -25963782,
        "unsubscribes": 51494403
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
group_by["step_id","step_id","step_id","step_id","step_id"]
step_ids["0d6abc52-07ff-78d0-eaae-baa5e55a1e78","1f3fb0ea-471b-0197-468c-e715ab40895b","65f82d59-5d7c-a4db-49fd-ad26d82aded2","0fed2c5f-74e0-1a32-935f-8a44ca980dfd"]
page_size9
page_tokenullamco magna aliquip est
Request Payload
Response Payload
{
  "_metadata": {
    "count": 11155139.930525288,
    "next": "https://XswOkCzguVnTIwMXNDDjqm.dmmnw4lGs0gONIeHPqLsXigcnaF0ccPil+r8lI0Q6o,cHcLFMQ,9k4M3nNS05XL",
    "prev": "http://OLkINotHCtrinTjkPoKP.kefENIZu3YyGuTrac9E0s0FYv7ulp6iEYgRP7TsIjd33",
    "self": "http://bXTzAdBUCSuDSCeXFhVJqfUGHSlLGSH.kterx2Z5sFjxE,NDFYt"
  },
  "results": [
    {
      "clicks": 86314801,
      "step_id": "5f2d3bbc-e66e-f506-7845-4c2fab9e2ee0",
      "url": "https://SnbIIqROdDvNSoHXHMzwQNFkXBfPYs.gjaT+bNApqMzqTrImIupCMLJGvUYnB-d.",
      "url_location": 97108494
    },
    {
      "clicks": 35686078,
      "step_id": "0c3fc7da-0709-ea3f-fca4-b0b466f51ce9",
      "url": "https://sxGyfOPXthKOEXYCcpNvUVybcdrT.dumgHdaNQ2LGMR77tP5dgRd.sm29XEJVCXjeidNwEHvtxvfxj5YKH",
      "url_location": 50568459
    },
    {
      "clicks": 36022603,
      "step_id": "9ff492dc-4653-5b17-4f82-0ba033de38f4",
      "url": "https://nv.ucnyUpRdF5BkL2.cKwBlYEOFH,9F,rz9vh.8osJ0gaHjCK0j17,8pQ7",
      "url_location": 3939086
    },
    {
      "clicks": 75323799,
      "step_id": "7a848e60-47f7-8f76-2576-6186239e4ec2",
      "url": "https://azGeZz.urmzBBWYja77CSyfDgUXOuidMnwVjaClKJA.QH1MPZJCD5yl0hxuSpeSRvror+",
      "url_location": 61590339
    },
    {
      "clicks": 82093367,
      "step_id": "185c196f-756f-33b7-38d5-ea099f553ee8",
      "url": "https://OVGQnCpchFGKaLWGfwtVxR.joO78oA-xjeBqsqRutBI7Mf45ELnQu.BwON+O92j4uhg.APCpMKfn4+tSzt3",
      "url_location": 19665801
    }
  ],
  "total_clicks": 4717894
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
page_size62
page_tokendolor sunt nulla
group_by["ab_phase","ab_phase","ab_variation","ab_phase","ab_variation"]
ab_variation_id8dce344f-0592-57f8-d98f-246d8ad5e261
ab_phase_idsend
Request Payload
Response Payload
{
  "_metadata": {
    "count": -1699824.534066379,
    "next": "http://DVjpPFZuz.ogmRDUIAs3,TsteDQiqwOTLxCgaCIxYgtQH-c0.r",
    "prev": "https://nXDDzdouNUXvAaICovso.lnoXOmNSxz+XG",
    "self": "https://OKFnpu.whndmca9bEMTzjFElo+rQCXzlxQ2uHB7HE8tjMcDp56dsQGxIVqqMX3ggI229"
  },
  "results": [
    {
      "ab_phase": "send",
      "ab_variation": "84b67a35-55a4-a82d-b825-d8be44578ddb",
      "clicks": 42350769,
      "url": "http://EGBfARSwwgUDFVkzEIbzytDAMQHB.lpKGiIlELaex+WUxJnF8GybKJ",
      "url_location": 63787071
    },
    {
      "ab_phase": "test",
      "ab_variation": "72209ca7-8604-778d-702b-87cc0f3528f0",
      "clicks": 91021222,
      "url": "http://GpK.mvYSqLStFF,wsBlSnDinhBsV+3wnLvYyQyncKfrvR.CihHRriQMWn0BDbP3+-",
      "url_location": 76629417
    }
  ],
  "total_clicks": -8145845
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
Query Parameter NameExample
ids["id deserunt veniam aliqua","ipsum","non sit","in","dolore","adipisicing dolore","nisi est veniam Lorem","culpa Duis id dolor","et sed","laborum do et in quis"]
timezoneet
Request Payload
Response Payload
in exercitation fugiat
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
ids["Duis sunt","et ipsum pariatur eu mollit","dolor","mollit adipisicing do","ut ullamco","minim","sunt deserunt cillum elit tempor","esse dolor in quis velit","exercitation","voluptate magna"]
timezonelaboris
Request Payload
Response Payload
eiusmod sunt aliquip Lorem incididunt
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Sender Identities API(6 operations)

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

Contacts API - Lists(10 operations)

Header NameExample
on-behalf-of"nulla cupidatat eu quis"
Request Payload
{
  "name": "your list name"
}
Response Payload
{
  "id": 1,
  "name": "your list name",
  "recipient_count": 0
}
{
  "errors": [
    {
      "field": null,
      "message": "Returned if request body is invalid JSON"
    },
    {
      "field": "name",
      "message": "Returned if list name is not a string"
    },
    {
      "field": "name",
      "message": "Returned if list name is a duplicate of an existing list or segment"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"in commodo aliqua"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1,
      "name": "the jones",
      "recipient_count": 1
    }
  ]
}
Header NameExample
on-behalf-of"elit do ea"
Request Payload
[
  1,
  2,
  3,
  4
]
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "list id was invalid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
list_id31111291
Header NameExample
on-behalf-of"ut"
Request Payload
Response Payload
{
  "id": 1,
  "name": "listname",
  "recipient_count": 0
}
{
  "errors": [
    {
      "message": "invalid id"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "List ID does not exist"
    }
  ]
}
Query Parameter NameExample
list_id*-14701132
Header NameExample
on-behalf-of"tempor culpa quis nostrud"
Request Payload
{
  "name": "newlistname"
}
Response Payload
{
  "id": 1234,
  "name": "2016 iPhone Users",
  "recipient_count": 0
}
{
  "errors": [
    {
      "message": "invalid id"
    }
  ]
}
{
  "errors": [
    {
      "message": "List ID does not exist"
    }
  ]
}
Query Parameter NameExample
delete_contactstrue
Header NameExample
on-behalf-of"anim qui dolore consequat labore"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "delete_contacts",
      "message": "delete_contacts not a bool"
    },
    {
      "field": "list_id",
      "message": "Returned if list_id is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "List not found: 5"
    }
  ]
}
Query Parameter NameExample
page43494431
page_size62170709
list_id*-74889342
Header NameExample
on-behalf-of"dolore in voluptate mollit sint"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 1433348344,
      "custom_fields": [
        {
          "id": 6234,
          "name": "age",
          "type": "number",
          "value": null
        },
        {
          "id": 6233,
          "name": "country",
          "type": "text",
          "value": null
        },
        {
          "id": 6235,
          "name": "fname",
          "type": "text",
          "value": "Example"
        },
        {
          "id": 6239,
          "name": "lname",
          "type": "text",
          "value": "User"
        },
        {
          "id": 6240,
          "name": "lname",
          "type": "text",
          "value": null
        }
      ],
      "email": "example@example.com",
      "first_name": "Example",
      "id": "ZGVWfyZWsuYmFpbmVzQHNlbmRmCmLkLmNv==",
      "last_clicked": 1438616117,
      "last_emailed": 1438613272,
      "last_name": "User",
      "last_opened": 1438616109,
      "updated_at": 1438616119
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id is not a valid integer"
    },
    {
      "field": "page",
      "message": "Returned if page is not a valid integer"
    },
    {
      "field": "page",
      "message": "Returned if page is less than 1"
    },
    {
      "field": "page_size",
      "message": "Returned if page_size is not a valid integer"
    },
    {
      "field": "page_size",
      "message": "Returned if page_size is less than 1 or greater than 1000"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id is invalid"
    }
  ]
}
Header NameExample
on-behalf-of"officia velit aute dolor"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "list_id",
      "message": "list_id is invalid"
    },
    {
      "field": "recipient_id",
      "message": "no valid recipients were provided"
    },
    {
      "field": null,
      "message": "no recipients were added"
    },
    {
      "field": null,
      "message": "request body is invalid JSON"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "list_id does not exist"
    },
    {
      "field": "recipient_id",
      "message": "recipient_id does not exist"
    }
  ]
}
Header NameExample
on-behalf-of"ut dolore fugiat"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id is invalid"
    },
    {
      "field": "recipient_id",
      "message": "Returned if recipient_id is invalid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id does not exist"
    },
    {
      "field": "recipient_id",
      "message": "Returned if recipient_id does not exist"
    }
  ]
}
Query Parameter NameExample
list_id*-91072243
recipient_id*73713921
Header NameExample
on-behalf-of"ad occaecat sit"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id is invalid"
    },
    {
      "field": "recipient_id",
      "message": "no valid recipients were provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id does not exist"
    },
    {
      "field": "recipient_id",
      "message": "Returned if recipient_id does not exist"
    }
  ]
}

Contacts API - Recipients(12 operations)

Header NameExample
on-behalf-of"incididunt dolore non"
Request Payload
[
  {
    "email": "example@example.com",
    "first_name": "",
    "last_name": "User",
    "age": 25
  },
  {
    "email": "example2@example.com",
    "first_name": "Example",
    "last_name": "User",
    "age": 25
  }
]
Response Payload
{
  "error_count": 1,
  "error_indices": [
    2
  ],
  "new_count": 2,
  "persisted_recipients": [
    "YUBh",
    "bWlsbGVyQG1pbGxlci50ZXN0"
  ],
  "updated_count": 0,
  "errors": [
    {
      "message": "Invalid email.",
      "error_indices": [
        2
      ]
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "Request body is not valid json"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"dolor"
Request Payload
[
  {
    "email": "jones@example.com",
    "last_name": "Jones",
    "first_name": "Guy"
  }
]
Response Payload
{
  "error_count": 1,
  "error_indices": [
    2
  ],
  "new_count": 2,
  "persisted_recipients": [
    "YUBh",
    "bWlsbGVyQG1pbGxlci50ZXN0"
  ],
  "updated_count": 0,
  "errors": [
    {
      "message": "Invalid email.",
      "error_indices": [
        2
      ]
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "Request body is not valid json"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"commodo fugiat"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
{}
{
  "errors": [
    {
      "message": "No recipient ids provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
page20587124
page_size-76482241
Header NameExample
on-behalf-of"et veniam Excepteur dolor"
Request Payload
Response Payload
{
  "recipients": []
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"in dolor"
Request Payload
Response Payload
{
  "status": [
    {
      "id": "worker_delay",
      "value": "delayed"
    },
    {
      "id": "worker_delay_seconds",
      "value": "75.0"
    }
  ]
}
Header NameExample
on-behalf-of"aliquip consectetur"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": -21084778.223967373,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "cMbR2YsOKCVnOI@uNflJYgaeADLOn.wpu",
      "first_name": "sunt exercitation",
      "id": "sit officia",
      "last_clicked": null,
      "last_emailed": -23637564.869907647,
      "last_name": "enim deserunt nostrud pariatur",
      "last_opened": 23240220.915896922,
      "updated_at": 73361450.40457666
    },
    {
      "created_at": 3591734.173418805,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "MvN@zVappT.io",
      "first_name": null,
      "id": "sint officia",
      "last_clicked": -32081157.604070798,
      "last_emailed": null,
      "last_name": "occaecat aliqua",
      "last_opened": 87353333.22711805,
      "updated_at": -2306663.044516057
    },
    {
      "created_at": 51650142.99110186,
      "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": "cf0kgnTrQVeAniZ@yHrndlrCqBMawQluQA.tz",
      "first_name": "non tempor ut reprehenderit in",
      "id": "pariatur quis",
      "last_clicked": 89953785.46828982,
      "last_emailed": -22731356.43833877,
      "last_name": "anim consectetur occaecat in tempor",
      "last_opened": 26149310.99445048,
      "updated_at": 68466214.60929692
    },
    {
      "created_at": 55526389.23454264,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "fKUcmK@wQzzEPCnaysctscATUsq.uayw",
      "first_name": null,
      "id": "proident eiusmod sunt consectetur",
      "last_clicked": 1970894.8045606464,
      "last_emailed": null,
      "last_name": null,
      "last_opened": null,
      "updated_at": -97058939.7591127
    },
    {
      "created_at": 18839922.438507542,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "HDX@ByoSgWMgjCA.dm",
      "first_name": "consequat Duis",
      "id": "voluptate",
      "last_clicked": -32634025.189243495,
      "last_emailed": 21631444.80436468,
      "last_name": "Ut amet occaecat cillum aliquip",
      "last_opened": null,
      "updated_at": -52297489.56668691
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"laborum proident quis sint incididunt"
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "recipient not found"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "recipient_id is not valid"
    }
  ]
}
Header NameExample
on-behalf-of"eiusmod adipisicing"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1234,
      "name": "Example list",
      "recipient_count": 42
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "recipient ID is invalid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "recipient id not found"
    }
  ]
}
Header NameExample
on-behalf-of"voluptate id in incididunt"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"commodo et"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
{field_name}fugiat aliqua Duis nostrud
Header NameExample
on-behalf-of"labore fugiat laborum"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 1422313607,
      "email": "jones@example.com",
      "first_name": null,
      "id": "YUBh",
      "last_clicked": null,
      "last_emailed": null,
      "last_name": "Jones",
      "last_opened": null,
      "updated_at": 1422313790,
      "custom_fields": [
        {
          "id": 23,
          "name": "pet",
          "value": "Fluffy",
          "type": "text"
        }
      ]
    }
  ]
}
{
  "errors": [
    {
      "message": "The following parameters are not custom fields or reserved fields: [{field_name}]"
    },
    {
      "message": "No search params are specified"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Request Payload
{
  "list_id": -27497588,
  "conditions": [
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    },
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    },
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    },
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    }
  ]
}
Response Payload
{
  "recipients": [
    {
      "created_at": -27901208,
      "email": "ut magna quis ipsum",
      "id": "fugiat ad adipisicing ullamco",
      "last_emailed": 21626657
    },
    {
      "created_at": 17466400,
      "email": "sunt irure",
      "id": "et",
      "last_clicked": -23135244,
      "last_opened": -44593357,
      "first_name": "est"
    },
    {
      "created_at": -34495329,
      "email": "reprehenderit incididunt velit Lorem esse",
      "id": "esse Ut ad dolore",
      "last_clicked": 10164083,
      "last_opened": 34443062
    },
    {
      "created_at": -37030673,
      "email": "amet deserunt fugiat voluptate",
      "id": "et exercitation commodo id laborum",
      "last_clicked": -10497425
    },
    {
      "created_at": 3658435,
      "email": "labore veniam",
      "id": "ad pariatur esse",
      "last_opened": -84227501,
      "custom_fields": [
        {
          "id": -5765608,
          "name": "proident pariatur",
          "value": "do in magna mollit",
          "type": "dolore ut"
        },
        {
          "id": -31131201,
          "name": "laborum mollit",
          "value": 84434696,
          "type": "veniam"
        }
      ],
      "updated_at": -56455352,
      "first_name": "Ut cupidatat nulla deserunt adipisicing",
      "last_clicked": -52862671
    }
  ],
  "recipient_count": 65190677
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

Contacts API - Custom Fields(5 operations)

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

Contacts API - Segments(6 operations)

Header NameExample
on-behalf-of"in id"
Request Payload
{
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    },
    {
      "field": "last_clicked",
      "value": "01/02/2015",
      "operator": "gt",
      "and_or": "and"
    },
    {
      "field": "clicks.campaign_identifier",
      "value": "513",
      "operator": "eq",
      "and_or": "or"
    }
  ]
}
Response Payload
{
  "id": 1,
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    },
    {
      "field": "last_clicked",
      "value": "01/02/2015",
      "operator": "gt",
      "and_or": "and"
    },
    {
      "field": "clicks.campaign_identifier",
      "value": "513",
      "operator": "eq",
      "and_or": "or"
    }
  ],
  "recipient_count": 0
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"commodo ex Excepteur aliquip"
Request Payload
Response Payload
{
  "segments": [
    {
      "id": 1234,
      "name": "Age segments < 25",
      "conditions": [
        {
          "field": "age",
          "value": "25",
          "operator": "lt"
        }
      ],
      "recipient_count": 8
    },
    {
      "id": 2345,
      "name": "email address - gmail",
      "conditions": [
        {
          "field": "email",
          "value": "@gmail.com",
          "operator": "contains"
        }
      ],
      "recipient_count": 0
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
segment_id*8038598
Header NameExample
on-behalf-of"minim eiusmod laborum"
Request Payload
Response Payload
{
  "id": 1,
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ],
  "recipient_count": 1
}
{
  "errors": [
    {
      "message": "if segment_id is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "segment_id not found"
    }
  ]
}
Query Parameter NameExample
segment_idnulla sint
Header NameExample
on-behalf-of"adipisicing tempor veniam Excepteur cupidatat"
Request Payload
{
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ]
}
Response Payload
{
  "id": 5,
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ],
  "recipient_count": 1
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "segment_id": "segment_id",
      "message": "segment id is not valid"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
delete_contactsfalse
Header NameExample
on-behalf-of"anim ut cupidatat esse laboris"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "segment_id",
      "message": "Returned if segment_id is not valid"
    },
    {
      "field": "delete_contacts",
      "message": "Returned if delete_contacts is not a valid boolean"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "segment_id",
      "message": "segment_id does not exist"
    }
  ]
}
Query Parameter NameExample
page-53957134
page_size97332225
Header NameExample
on-behalf-of"do enim Duis incididunt"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 1422313607,
      "email": "jones@example.com",
      "first_name": null,
      "id": "YUBh",
      "last_clicked": null,
      "last_emailed": null,
      "last_name": "Jones",
      "last_opened": null,
      "updated_at": 1422313790,
      "custom_fields": [
        {
          "id": 23,
          "name": "pet",
          "value": "Indiana",
          "type": "text"
        }
      ]
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}

Categories(3 operations)

Query Parameter NameExample
limit-13258448
categoryin
offset-25193463
Header NameExample
on-behalf-of"ad Duis"
Request Payload
Response Payload
[
  {
    "category": "category 1"
  },
  {
    "category": "category 2"
  }
]
{
  "errors": [
    {
      "field": "sort_by",
      "message": "invalid sort value"
    }
  ]
}
Query Parameter NameExample
sort_by_metricin nisi
sort_by_directiondesc
start_date*mollit commodo id
end_datedo in quis culpa
limit-14894628
offset51451049
aggregated_byweek
Header NameExample
on-behalf-of"in"
Request Payload
Response Payload
{
  "date": "2015-01-01",
  "stats": [
    {
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 20,
        "deferred": 0,
        "delivered": 20,
        "invalid_emails": 0,
        "opens": 20,
        "processed": 0,
        "requests": 20,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 20,
        "unique_opens": 20,
        "unsubscribe_drops": 0,
        "unsubscribes": 20
      },
      "name": "cat1",
      "type": "category"
    },
    {
      "metrics": {
        "blocks": 1,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 19,
        "deferred": 0,
        "delivered": 19,
        "invalid_emails": 0,
        "opens": 19,
        "processed": 0,
        "requests": 20,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 19,
        "unique_opens": 19,
        "unsubscribe_drops": 0,
        "unsubscribes": 19
      },
      "name": "cat2",
      "type": "category"
    },
    {
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 5,
        "invalid_emails": 0,
        "opens": 5,
        "processed": 0,
        "requests": 5,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 5,
        "unique_opens": 5,
        "unsubscribe_drops": 0,
        "unsubscribes": 5
      },
      "name": "cat3",
      "type": "category"
    },
    {
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 6,
        "deferred": 0,
        "delivered": 5,
        "invalid_emails": 0,
        "opens": 6,
        "processed": 0,
        "requests": 5,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 5,
        "unique_opens": 5,
        "unsubscribe_drops": 0,
        "unsubscribes": 6
      },
      "name": "cat4",
      "type": "category"
    },
    {
      "metrics": {
        "blocks": 10,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 0,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 0,
        "processed": 0,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "cat5",
      "type": "category"
    }
  ]
}
Query Parameter NameExample
start_date*sint ipsum exercitation in
end_dateExcepteur consequat adipisicing dolor occaecat
categories*Excepteur mollit nostrud sint
limit-64138883
offset-48406919
aggregated_byday
Header NameExample
on-behalf-of"aliquip voluptate"
Request Payload
Response Payload
[
  {
    "date": "2015-10-01",
    "stats": [
      {
        "type": "category",
        "name": "docs",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      },
      {
        "type": "category",
        "name": "mattscategory",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "category",
        "name": "docs",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      },
      {
        "type": "category",
        "name": "mattscategory",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]

Campaigns API(11 operations)

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

Transactional Templates(6 operations)

Header NameExample
on-behalf-of"amet deserunt"
Request Payload
{
  "name": "example_name",
  "generation": "dynamic"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "example_name",
  "generation": "legacy",
  "versions": []
}
Query Parameter NameExample
generationslegacy
page_size*56.877951357126676
page_tokendolore adipisicing amet
Header NameExample
on-behalf-of"anim quis nisi"
Request Payload
Response Payload
{
  "result": [
    {
      "id": "fae7c985-eb92-4b47-9987-28ec29dbc698",
      "name": "example_name",
      "generation": "legacy",
      "updated_at ": "2020-11-12 12:00:09",
      "versions": []
    }
  ],
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/templates",
    "count": 1
  }
}
{
  "errors": [
    {
      "": "in laborum in ea sint",
      "error_id": "in",
      "message": "cupidatat deserunt"
    },
    {
      "": "deserunt incididunt exercitation fugiat",
      "error_id": "ipsum non ullamco et",
      "message": "incididunt eu"
    }
  ]
}
Header NameExample
on-behalf-of"sunt"
Request Payload
{
  "name": "example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa2371",
  "name": "example_name",
  "generation": "dynamic",
  "updated_at ": "2019-03-13T11:52:41.009Z",
  "versions": []
}
Header NameExample
on-behalf-of"minim"
Request Payload
Response Payload
{
  "id": "40da60e6-66f3-4223-9406-ba58b7f55a62",
  "name": "Duis in dolor",
  "generation": "legacy",
  "updated_at ": "2020-12-12 58:26:65",
  "versions": []
}
Header NameExample
on-behalf-of"proident"
Request Payload
{
  "name": "new_example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "new_example_name",
  "versions": []
}
Header NameExample
on-behalf-of"in aute et ea nostrud"
Request Payload
Response Payload
{}

Transactional Templates Versions(5 operations)

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

Webhooks(7 operations)

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

Settings - Inbound Parse(4 operations)

Header NameExample
on-behalf-of"veniam"
Request Payload
{
  "url": "http://email.myhostname.com",
  "hostname": "myhostname.com",
  "spam_check": false,
  "send_raw": true
}
Response Payload
{
  "url": "http://email.myhostname.com",
  "hostname": "myhostname.com",
  "spam_check": false,
  "send_raw": true
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "sunt ut non"
    },
    {
      "message": "cupidatat consectetur Duis"
    }
  ]
}
Header NameExample
on-behalf-of"laboris eiusmod Excepteur qui nostrud"
Request Payload
Response Payload
{
  "url": "http://mydomain.com/parse",
  "hostname": "mail.mydomain.com",
  "spam_check": true,
  "send_raw": true
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "esse sint dolore"
    },
    {
      "message": "nulla"
    }
  ]
}
Header NameExample
on-behalf-of"ex"
Request Payload
{
  "url": "http://email.myhostname.com",
  "hostname": "myhostname.com",
  "spam_check": false,
  "send_raw": true
}
Response Payload
{
  "url": "http://mydomain.com/parse",
  "hostname": "mail.mydomain.com",
  "spam_check": true,
  "send_raw": true
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "nostrud dolore adipisicing"
    },
    {
      "message": "velit ut irure consequat"
    },
    {
      "message": "esse quis sed fugiat"
    },
    {
      "message": "eiusmod Duis veniam eu"
    }
  ]
}
Header NameExample
on-behalf-of"sunt"
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ex elit et aliqua exercitation"
    },
    {
      "message": "commodo ad incididunt esse Lorem"
    }
  ]
}

Query(2 operations)

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

CSV (UI only)(2 operations)

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

Settings - Tracking(9 operations)

Header NameExample
on-behalf-of"voluptate culpa"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "open",
      "title": "Open Tracking",
      "description": "lorem ipsum... .",
      "enabled": true
    }
  ]
}
Header NameExample
on-behalf-of"culpa Excepteur dolor labore anim"
Request Payload
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"et tempor incididunt"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"id dolore anim aute"
Request Payload
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"Duis laborum"
Request Payload
{
  "enabled": true,
  "utm_source": "sendgrid.com",
  "utm_medium": "email",
  "utm_term": "",
  "utm_content": "",
  "utm_campaign": "website"
}
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"dolor incididunt ipsum Ut"
Request Payload
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"magna officia Duis"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"minim id labore ut"
Request Payload
Response Payload
{
  "enabled": true,
  "html_content": "<p>Something something unsubscribe <% %> something something</p>\n",
  "landing": "<p>subscribehere</p>\n",
  "plain_content": "Something something unsubscribe <% %> something something",
  "replace": "thetag",
  "url": ""
}
Header NameExample
on-behalf-of"incididunt commodo enim dolor"
Request Payload
{
  "enabled": true,
  "landing": "landing page html",
  "url": "url",
  "replace": "replacement tag",
  "html_content": "html content",
  "plain_content": "text content"
}
Response Payload
{
  "enabled": true,
  "landing": "landing page html",
  "url": "url",
  "replace": "replacement tag",
  "html_content": "html content",
  "plain_content": "text content"
}

Stats(7 operations)

Query Parameter NameExample
limit-95724510
offset-92062004
aggregated_byday
start_date*fugiat incididunt
end_dateesse laborum minim ullamco
Header NameExample
on-behalf-of"ea Ut"
Request Payload
Response Payload
[
  {
    "date": "2015-11-03",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
countryCA
limit7086885
offset-99378313
aggregated_byday
start_date*dolore veniam
end_dateDuis occaecat dolor ullamco Ut
Header NameExample
on-behalf-of"irure"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 1,
          "unique_clicks": 0,
          "unique_opens": 1
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
limit-46095044
offset88841168
aggregated_byweek
start_date*deserunt
end_dateveniam pariatur
Header NameExample
on-behalf-of"nostrud fugiat"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 2,
          "unique_opens": 2
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
start_date*amet
end_dateaute incididunt
aggregated_byday
Header NameExample
on-behalf-of"pariatur eu"
Request Payload
Response Payload
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  }
]
Query Parameter NameExample
start_date*in culpa in dolor cillum
end_dateconsequat commodo occaecat
aggregated_byday
Header NameExample
on-behalf-of"aute commodo et incididunt in"
Request Payload
Response Payload
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  }
]
Query Parameter NameExample
mailbox_providersvoluptate qui Ut enim
limit70711388
offset-57401924
aggregated_byday
start_date*dolore
end_dateconsequat aliqua
Header NameExample
on-behalf-of"consequat magna cillum qui"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 1,
          "drops": 0,
          "opens": 1,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 1
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 2,
          "drops": 0,
          "opens": 2,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 2
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
browsersconsequat eiusmod pariatur sed
limit-88208775
offset-28560394
aggregated_byweek
start_date*commodo consequat
end_dateeu aute magna
Header NameExample
on-behalf-of"do voluptate enim elit"
Request Payload
Response Payload
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "clicks": 0,
          "unique_clicks": 0
        },
        "name": "Chrome",
        "type": "browser"
      },
      {
        "metrics": {
          "clicks": 1,
          "unique_clicks": 1
        },
        "name": "Firefox",
        "type": "browser"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "clicks": 0,
          "unique_clicks": 0
        },
        "name": "Chrome",
        "type": "browser"
      },
      {
        "metrics": {
          "clicks": 1,
          "unique_clicks": 1
        },
        "name": "Firefox",
        "type": "browser"
      }
    ]
  }
]

Bounces API(4 operations)

Query Parameter NameExample
start_time46257427
end_time6957720
Header NameExample
Accept*"nisi"
on-behalf-of"minim eu Duis non veniam"
Request Payload
Response Payload
[
  {
    "created": 1250337600,
    "email": "example@example.com",
    "reason": "550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at  https://support.google.com/mail/answer/6596 o186si2389584ioe.63 - gsmtp ",
    "status": "5.1.1"
  },
  {
    "created": 1250337600,
    "email": "example@example.com",
    "reason": "550 5.1.1 <testemail2@testing.com>: Recipient address rejected: User unknown in virtual alias table ",
    "status": "5.1.1"
  }
]
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Header NameExample
on-behalf-of"deserunt"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example@example.com",
    "example2@example.com"
  ]
}
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"Lorem voluptate sint"
Request Payload
Response Payload
[
  {
    "created": 1443651125,
    "email": "bounce1@test.com",
    "reason": "550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at  https://support.google.com/mail/answer/6596 o186si2389584ioe.63 - gsmtp ",
    "status": "5.1.1"
  }
]
Query Parameter NameExample
email_address*zI-tIqz3FedZ@SvVBmlx.nixp
Header NameExample
on-behalf-of"nostrud amet adipisicing sunt cupidatat"
Request Payload
Error generating example
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Blocks API(4 operations)

Query Parameter NameExample
start_time82712429
end_time-39817088
limit59375725
offset-31168775
Header NameExample
on-behalf-of"ullamco amet"
Request Payload
Response Payload
[
  {
    "created": 1443651154,
    "email": "example@example.com",
    "reason": "error dialing remote address: dial tcp 10.57.152.165:25: no route to host",
    "status": "4.0.0"
  },
  {
    "created": 1443651155,
    "email": "example1@example.com",
    "reason": "unable to resolve MX record for example.com: servfail",
    "status": "4.0.0"
  }
]
Header NameExample
on-behalf-of"incididunt ad Duis sint ex"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"ut minim dolor officia in"
Request Payload
Response Payload
[
  {
    "created": 1443651154,
    "email": "example@example.com",
    "reason": "error dialing remote address: dial tcp 10.57.152.165:25: no route to host",
    "status": "4.0.0"
  }
]
Header NameExample
on-behalf-of"ut incididunt veniam Ut dolor"
Request Payload
Response Payload
{}

Spam Reports API(4 operations)

Query Parameter NameExample
start_time49409715
end_time-52924254
limit-58494122
offset89703465
Header NameExample
on-behalf-of"aliquip"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com",
    "ip": "10.63.202.100"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com",
    "ip": "10.63.202.100"
  }
]
Header NameExample
on-behalf-of"nisi"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"in sed"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "ip": "10.89.32.5"
  }
]
Header NameExample
on-behalf-of"consequat anim ea in"
Request Payload
Response Payload
{}

Suppressions - Global Suppressions(4 operations)

Header NameExample
on-behalf-of"incididunt"
Request Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Response Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Query Parameter NameExample
start_time34558873
end_time-9778483
limit25993693
offset-24329598
Header NameExample
on-behalf-of"dolor ex culpa nisi fugiat"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com"
  }
]
Header NameExample
on-behalf-of"eiusmod ad"
Request Payload
Response Payload
{
  "recipient_email": "test@example.com"
}
Header NameExample
on-behalf-of"occaecat qui est"
Request Payload
Response Payload
{}

Suppressions - Unsubscribe Groups(5 operations)

Header NameExample
on-behalf-of"sunt cillum"
Request Payload
{
  "name": "Product Suggestions",
  "description": "Suggestions for products our users might like.",
  "is_default": true
}
Response Payload
{
  "id": 103,
  "name": "Product Suggestions",
  "description": "Suggestions for products our users might like.",
  "is_default": false
}
Query Parameter NameExample
id91385632
Header NameExample
on-behalf-of"minim"
Request Payload
Response Payload
[
  {
    "id": 1234,
    "name": "Unsubscribe Group",
    "description": "An Unsubscribe Group",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 1234
  },
  {
    "id": 1234,
    "name": "Unsubscribe Group",
    "description": "An Unsubscribe Group",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 1234
  }
]
Header NameExample
on-behalf-of"nulla"
Request Payload
Response Payload
{
  "description": "Our monthly newsletter.",
  "id": 100,
  "is_default": true,
  "last_email_sent_at": null,
  "name": "Newsletters",
  "unsubscribes": 400
}
Header NameExample
on-behalf-of"est fugiat deserunt aute quis"
Request Payload
{
  "id": 103,
  "name": "Item Suggestions",
  "description": "Suggestions for items our users might like."
}
Response Payload
{
  "id": 103,
  "name": "Item Suggestions",
  "description": "Suggestions for items our users might like."
}
Header NameExample
on-behalf-of"voluptate dolore amet"
Request Payload
Response Payload
{}

Suppressions - Suppressions(6 operations)

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

Invalid Emails API(4 operations)

Query Parameter NameExample
start_time72850793
end_time-71641723
limit-37529857
offset32559222
Header NameExample
on-behalf-of"in elit"
Request Payload
Response Payload
[
  {
    "created": 1449953655,
    "email": "user1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  },
  {
    "created": 1449939373,
    "email": "user2@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]
Header NameExample
on-behalf-of"anim ex incididunt est"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"aliquip et dolore"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]
Header NameExample
on-behalf-of"id veniam deserunt"
Request Payload
Response Payload
{}
Service Homepage: sendgrid.com/en-us
API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started
emails