Sendgrid V3 Mock Server
SendGrid is a cloud-based email delivery service that provides developers with a reliable and scalable platform to send transactional and marketing emails. It offers a comprehensive set of features and APIs that enable developers to easily integrate email functionality into their applications, websites, or services.
The hosted mock server empowers you to effortlessly simulate various Sendgrid V3 APIs, and doesn't need any authentication/api-key. The setup is straightforward, you can configure the base URL in your code/SDK. You can also control the base URL using environment variables or a feature flag.
You don't need any additional dependencies, and you can run the same code in both sandbox and production environments.
Mail Send
POST
{
"personalizations": [
{
"to": [
{
"email": "john_doe@example.com",
"name": "John Doe"
},
{
"email": "julia_doe@example.com",
"name": "Julia Doe"
}
],
"cc": [
{
"email": "jane_doe@example.com",
"name": "Jane Doe"
}
],
"bcc": [
{
"email": "james_doe@example.com",
"name": "Jim Doe"
}
]
},
{
"from": {
"email": "sales@example.com",
"name": "Example Sales Team"
},
"to": [
{
"email": "janice_doe@example.com",
"name": "Janice Doe"
}
],
"bcc": [
{
"email": "jordan_doe@example.com",
"name": "Jordan Doe"
}
]
}
],
"from": {
"email": "orders@example.com",
"name": "Example Order Confirmation"
},
"reply_to": {
"email": "customer_service@example.com",
"name": "Example Customer Service Team"
},
"subject": "Your Example Order Confirmation",
"content": [
{
"type": "text/html",
"value": "<p>Hello from Twilio SendGrid!</p><p>Sending with the email service trusted by developers and marketers for <strong>time-savings</strong>, <strong>scalability</strong>, and <strong>delivery expertise</strong>.</p><p>%open-track%</p>"
}
],
"attachments": [
{
"content": "PCFET0NUWVBFIGh0bWw+CjxodG1sIGxhbmc9ImVuIj4KCiAgICA8aGVhZD4KICAgICAgICA8bWV0YSBjaGFyc2V0PSJVVEYtOCI+CiAgICAgICAgPG1ldGEgaHR0cC1lcXVpdj0iWC1VQS1Db21wYXRpYmxlIiBjb250ZW50PSJJRT1lZGdlIj4KICAgICAgICA8bWV0YSBuYW1lPSJ2aWV3cG9ydCIgY29udGVudD0id2lkdGg9ZGV2aWNlLXdpZHRoLCBpbml0aWFsLXNjYWxlPTEuMCI+CiAgICAgICAgPHRpdGxlPkRvY3VtZW50PC90aXRsZT4KICAgIDwvaGVhZD4KCiAgICA8Ym9keT4KCiAgICA8L2JvZHk+Cgo8L2h0bWw+Cg==",
"filename": "index.html",
"type": "text/html",
"disposition": "attachment"
}
],
"categories": [
"cake",
"pie",
"baking"
],
"send_at": 1617260400,
"batch_id": "AsdFgHjklQweRTYuIopzXcVBNm0aSDfGHjklmZcVbNMqWert1znmOP2asDFjkl",
"asm": {
"group_id": 12345,
"groups_to_display": [
12345
]
},
"ip_pool_name": "transactional email",
"mail_settings": {
"bypass_list_management": {
"enable": false
},
"footer": {
"enable": false
},
"sandbox_mode": {
"enable": false
}
},
"tracking_settings": {
"click_tracking": {
"enable": true,
"enable_text": false
},
"open_tracking": {
"enable": true,
"substitution_tag": "%open-track%"
},
"subscription_tracking": {
"enable": false
}
}
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "in"
},
{
"message": "Excepteur aliquip est minim"
},
{
"message": "Ut"
},
{
"message": "do"
}
]
}Cancel Scheduled Sends(7 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "in consectetur qui ipsum id" |
{
"batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi"
}{
"errors": [
{
"message": "nisi dolor",
"field": "consequat",
"help": {}
},
{
"message": "pariatur labore est ipsum",
"field": "veniam voluptate esse eu irure",
"help": {}
},
{
"message": "occaecat voluptate nulla",
"field": "eiusmod id voluptate ullamco",
"help": {}
},
{
"message": "culpa ut id",
"field": "incididunt minim amet",
"help": {}
},
{
"message": "anim",
"field": "aliquip fugiat nisi",
"help": {}
}
],
"id": "irure fugiat voluptate proident dolore"
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "eu cillum"
},
{
"message": "ipsum irure aliqua"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "dolor sunt occaecat" |
{
"batch_id": "YOUR_BATCH_ID",
"status": "pause"
}{
"batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi",
"status": "pause"
}{
"errors": [
{
"message": "mollit ullamco",
"field": "laborum id",
"help": {}
}
],
"id": "aliquip sit Duis"
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "exercitation consectetur magna"
},
{
"message": "laboris elit quis ea mollit"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "nisi anim sit" |
[
{
"batch_id": "QzZmYzLTVWIwYgYzJlM2NhNWI",
"status": "cancel"
},
{
"batch_id": "mQzZmYzLTVlM2NhNWIwYgYzJl",
"status": "cancel"
}
]{
"errors": [
{
"message": "consectetur aute quis nostrud",
"field": "ea veniam",
"help": {}
},
{
"message": "ex ullamco aliquip nisi dolore",
"field": "sit mollit",
"help": {}
},
{
"message": "non",
"field": "voluptate in sit aliqua laboris",
"help": {}
}
],
"id": "eu"
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "quis et minim laborum commodo"
},
{
"message": "ipsum officia deserunt"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "pariatur proident sit do labore" |
{
"batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi"
}{
"errors": [
{
"message": "exercitation in",
"field": "dolor in laborum",
"help": {}
},
{
"message": "ex in incididunt dolor velit",
"field": "sit adipisicing est ullamco in",
"help": {}
}
],
"id": "in tempor consectetur commodo"
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "pariatur occaecat exercitation ut"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "mollit nulla fugiat do" |
[
{
"batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi",
"status": "cancel"
},
{
"batch_id": "IbLdyLYULb7Rj8GKSx7u025ouWVlAiMg",
"status": "pause"
}
]{
"errors": [
{
"message": "anim",
"field": "dolor",
"help": {}
}
],
"id": "velit"
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "eu Duis cupidatat veniam officia"
},
{
"message": "occaecat"
},
{
"message": "commodo dolor irure"
},
{
"message": "cupidatat consequat culpa"
},
{
"message": "ut elit ea"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "ea in" |
{
"status": "pause"
}Error generating example{
"errors": [
{
"message": "labore",
"field": "qui amet fugiat",
"help": {}
},
{
"message": "dolore incididunt magna in exercitation",
"field": "labore ut",
"help": {}
},
{
"message": "nulla deserunt",
"field": "nostrud qui commodo id",
"help": {}
},
{
"message": "veniam",
"field": "magna",
"help": {}
},
{
"message": "mollit sunt nulla consequat in",
"field": "Duis fugiat sint",
"help": {}
}
],
"id": "Ut minim ullamco"
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "eu elit sed culpa nostrud"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "ut Lorem laborum" |
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"message": "quis deserunt est Lorem et",
"field": "anim",
"help": {}
},
{
"message": "officia aliqua sit reprehenderit",
"field": "pariatur do dolor",
"help": {}
}
],
"id": "esse deserunt eiusmod"
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "proident in aliquip"
},
{
"message": "occaecat exercitation in"
}
]
}API Keys(6 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "exercitation nulla reprehenderit ullamco voluptate" |
{
"name": "My API Key",
"scopes": [
"mail.send",
"alerts.create",
"alerts.read"
]
}{
"api_key": "SG.xxxxxxxx.yyyyyyyy",
"api_key_id": "xxxxxxxx",
"name": "My API Key",
"scopes": [
"mail.send",
"alerts.create",
"alerts.read"
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "tempor cupidatat sint esse Lorem"
},
{
"message": "ea Duis anim"
},
{
"message": "ut"
},
{
"message": "reprehenderit consequat voluptate"
},
{
"message": "labore"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
limit | -92411211 |
| Header Name | Example |
|---|---|
on-behalf-of | "ipsum dolore" |
{
"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": "sit nulla cupidatat magna consectetur"
},
{
"message": "veniam ipsum in"
},
{
"message": "veniam Ut"
},
{
"message": "Ut veniam"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "cillum" |
{
"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": "aute in tempor"
},
{
"message": "amet nostrud"
},
{
"message": "in sed officia"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "quis eu est" |
{
"name": "A New Hope"
}{
"api_key_id": "qfTQ6KG0QBiwWdJ0-pCLCA",
"name": "A New Hope"
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "aute sed ipsum"
},
{
"message": "mollit ipsum Lorem amet qui"
}
]
}PUT
| Header Name | Example |
|---|---|
on-behalf-of | "in" |
{
"name": "Profiles key",
"scopes": [
"user.profile.read",
"user.profile.update"
]
}{
"api_key_id": "qfTQ6KG0QBiwWdJ0-pCLCA",
"name": "Profiles Key",
"scopes": [
"user.profile.read",
"user.profile.update"
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "enim fugiat eiusmod exercitation"
},
{
"message": "quis anim"
},
{
"message": "eu dolor in"
},
{
"message": "Excepteur in minim"
},
{
"message": "ut et Ut minim"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "dolore mollit ad" |
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": "reprehenderit"
},
{
"message": "sed"
},
{
"message": "dolor sit consectetur"
},
{
"message": "irure ut ea"
}
]
}API Key Permissions
GET
| Header Name | Example |
|---|---|
on-behalf-of | "tempor exercitation nisi qui" |
{
"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": "laborum cillum"
}
]
}Settings - Enforced TLS(2 operations)
GET
| Header Name | Example |
|---|---|
on-behalf-of | "aliqua do in proident cillum" |
{
"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": "commodo"
},
{
"message": "ex"
},
{
"message": "tempor"
},
{
"message": "aliquip irure ea commodo"
},
{
"message": "Excepteur"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "elit in laborum ad in" |
{
"require_tls": true,
"require_valid_cert": true
}{
"require_tls": true,
"require_valid_cert": false
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "exercitation reprehenderit"
},
{
"message": "sit"
}
]
}IP Access Management(6 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "ad dolor deserunt Lorem reprehenderit" |
{
"ips": [
{
"ip": "192.168.1.1"
},
{
"ip": "192.*.*.*"
},
{
"ip": "192.168.1.3/32"
}
]
}{
"result": [
{
"id": 1,
"ip": "192.168.1.1/32",
"created_at": 1441824715,
"updated_at": 1441824715
},
{
"id": 2,
"ip": "192.0.0.0/8",
"created_at": 1441824715,
"updated_at": 1441824715
},
{
"id": 3,
"ip": "192.168.1.3/32",
"created_at": 1441824715,
"updated_at": 1441824715
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "nulla laboris velit incididunt id"
},
{
"message": "nisi commodo do aliqua"
},
{
"message": "velit nulla et sint consequat"
},
{
"message": "sunt culpa cillum"
},
{
"message": "proident"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "aute ex consequat" |
{
"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": "mollit velit ut Duis nulla"
},
{
"message": "ea consequat"
},
{
"message": "non exercitation do fugiat dolore"
},
{
"message": "veniam magna cupidatat"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "nisi" |
{
"ids": [
1,
2,
3
]
}{}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "nostrud"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
limit | -76514370 |
| Header Name | Example |
|---|---|
on-behalf-of | "sunt in" |
{
"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": "amet occaecat"
},
{
"message": "ea"
},
{
"message": "dolore minim laborum dolor deserunt"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "aliqua dolore anim enim sit" |
{
"id": 1,
"ip": "192.168.1.1",
"created_at": 1441824715,
"updated_at": 1441824715
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "occaecat qui ex in" |
{}Certificates(5 operations)
POST
{
"public_certificate": "<your x509 certificate>",
"enabled": false,
"integration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}{
"public_certificate": "<your x509 certificate>",
"id": 66138975,
"not_before": 1621289880,
"not_after": 1621289880,
"intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}[
{
"message": "voluptate reprehenderit occaecat pariatur",
"field": "anim aliquip officia",
"error_id": "sit pariatur ipsum Lorem labore"
},
{
"message": "voluptate sint",
"field": null,
"error_id": "nulla ut"
},
{
"message": "commodo ut eiusmod tempor",
"field": "ut Ut ipsum",
"error_id": "id ex dolore consectetur ullamco"
},
{
"message": "anim pariatur",
"field": "laboris nulla",
"error_id": "Excepteur dolore"
},
{
"message": "do",
"field": "amet exercitation et magna",
"error_id": "adipisicing tempor"
}
][
{
"message": "reprehenderit sit",
"field": "est labore aliquip",
"error_id": "nostrud id veniam"
},
{
"message": "deserunt aliqua nostrud ex labore",
"field": null,
"error_id": "in quis aliqua"
}
][
{
"message": "consequat in",
"field": "cupidatat magna est veniam in",
"error_id": "pariatur cupidatat dolor non"
},
{
"message": "dolore et",
"field": "deserunt ut",
"error_id": "deserunt velit dolore"
}
][
{
"message": "in ad Lorem quis",
"field": "sed ipsum voluptate aliqua consequat",
"error_id": "Excepteur"
},
{
"message": "Duis incididunt et velit",
"field": "aliqua exercitation sunt consectetur",
"error_id": "esse"
},
{
"message": "sunt magna irure esse aliqua",
"field": null,
"error_id": "nulla"
}
][
{
"message": "ipsum",
"field": null,
"error_id": "laboris"
},
{
"message": "ut eu amet officia qui",
"field": null,
"error_id": "ex adipisicing"
},
{
"message": "reprehenderit veniam sed",
"field": null,
"error_id": "aute"
},
{
"message": "est sint aliquip qui",
"field": null,
"error_id": "Duis non laborum ea ut"
},
{
"message": "aute veniam",
"field": null,
"error_id": "dolore eu consequat"
}
]GET
[
{
"public_certificate": "<your x509 certificate>",
"id": 66138975,
"not_before": 1621289880,
"not_after": 1621289880,
"intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}
][
{
"message": "sit nisi",
"field": null,
"error_id": "esse reprehenderit laborum"
},
{
"message": "ea nostrud eu",
"field": null,
"error_id": "deserunt"
},
{
"message": "amet elit",
"field": "culpa nostrud incididunt reprehenderit",
"error_id": "nisi qui dolore consectetur ut"
},
{
"message": "eiusmod laboris",
"field": null,
"error_id": "nisi ut"
},
{
"message": "est in cillum officia anim",
"field": "magna",
"error_id": "ad ut"
}
][
{
"message": "Duis nostrud Excepteur",
"field": null,
"error_id": "reprehenderit ad in minim"
},
{
"message": "cillum est ut magna",
"field": null,
"error_id": "Duis laboris occaecat"
},
{
"message": "commodo veniam laborum Duis culpa",
"field": null,
"error_id": "dolore id dolor in"
},
{
"message": "proident ipsum Duis",
"field": null,
"error_id": "proident pariatur voluptate irure sed"
}
][
{
"message": "cupidatat occaecat",
"field": "in Ut nostrud",
"error_id": "commodo"
},
{
"message": "mollit",
"field": "nulla ipsum",
"error_id": "eiusmod non fugiat"
},
{
"message": "Lorem amet enim non commodo",
"field": "magna",
"error_id": "consequat"
}
][
{
"message": "Lorem in magna deserunt dolore",
"field": "sint",
"error_id": "consequat"
},
{
"message": "dolor deserunt",
"field": "ut mollit enim minim esse",
"error_id": "Ut amet Duis in"
}
][
{
"message": "ut in exercitation",
"field": null,
"error_id": "dolor officia"
}
]GET
{
"public_certificate": "<your x509 certificate>",
"id": 66138975,
"not_before": 1621289880,
"not_after": 1621289880,
"intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}[
{
"message": "Lorem proident dolor consequat",
"field": "voluptate dolore nostrud pariatur",
"error_id": "culpa in quis"
}
][
{
"message": "non",
"field": null,
"error_id": "sed"
},
{
"message": "mollit anim tempor irure",
"field": null,
"error_id": "ex voluptate in"
},
{
"message": "dolor quis aliqua sint proident",
"field": null,
"error_id": "adipisicing tempor"
},
{
"message": "esse exercitation",
"field": "sed culpa ipsum",
"error_id": "cillum"
},
{
"message": "occaecat dolor deserunt mollit id",
"field": "Duis cillum",
"error_id": "adipisicing non"
}
][
{
"message": "deserunt laboris exercitation pariatur",
"field": null,
"error_id": "et in"
},
{
"message": "eiusmod",
"field": "dolor sint culpa id consequat",
"error_id": "ipsum cupidatat"
}
][
{
"message": "et fugiat tempor sunt eu",
"field": null,
"error_id": "officia quis nostrud incididunt qui"
},
{
"message": "in commodo cupidatat",
"field": null,
"error_id": "adipisicing"
},
{
"message": "irure ut mollit",
"field": null,
"error_id": "occaecat qui minim adipisicing dolor"
},
{
"message": "anim",
"field": null,
"error_id": "veniam nisi"
},
{
"message": "Ut ea",
"field": null,
"error_id": "ex incididunt"
}
][
{
"message": "anim",
"field": null,
"error_id": "aliquip"
},
{
"message": "amet occaecat nulla",
"field": "qui Excepteur",
"error_id": "non ullamco aute"
},
{
"message": "quis dolor",
"field": null,
"error_id": "ad proident fugiat"
},
{
"message": "in proident laborum in consectetur",
"field": "qui",
"error_id": "quis sed"
},
{
"message": "velit esse consectetur sed aute",
"field": null,
"error_id": "cillum enim"
}
]PATCH
{
"public_certificate": "<your x509 certificate>",
"enabled": false,
"intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}[
{
"message": "id in aliqua sed",
"field": "fugiat",
"error_id": "et Ut"
},
{
"message": "nisi sit cupidatat",
"field": "in eu velit",
"error_id": "anim dolor adipisicing"
},
{
"message": "occaecat sed",
"field": "in nostrud deserunt consectetur irure",
"error_id": "aliquip consequat ut sint"
},
{
"message": "consequat sint sit dolore ea",
"field": "veniam et",
"error_id": "ipsum Lorem enim irure adipisicing"
}
][
{
"message": "eu sint anim",
"field": null,
"error_id": "elit irure"
},
{
"message": "non dolor cillum officia",
"field": "cupidatat consequat deserunt",
"error_id": "dolor"
},
{
"message": "sit cillum ex",
"field": null,
"error_id": "incididunt"
}
][
{
"message": "laboris in officia consequat proident",
"field": "incididunt nostrud veniam fugiat",
"error_id": "dolor amet et esse veniam"
},
{
"message": "ullamco proident velit voluptate",
"field": "velit et",
"error_id": "ullamco anim Excepteur"
},
{
"message": "nisi velit veniam",
"field": "ut",
"error_id": "velit eu sint labore id"
},
{
"message": "magna deserunt laboris in",
"field": null,
"error_id": "irure nisi"
}
][
{
"message": "dolor aliquip nisi incididunt Ut",
"field": null,
"error_id": "irure pariatur nulla veniam tempor"
},
{
"message": "labore laborum cupidatat nostrud",
"field": null,
"error_id": "Lorem in sint minim"
},
{
"message": "Lorem",
"field": null,
"error_id": "aliquip"
},
{
"message": "laborum aliquip esse sint et",
"field": "laboris deserunt ipsum exercitation aliquip",
"error_id": "aliqua sit"
}
][
{
"message": "in sint",
"field": "dolore veniam",
"error_id": "laboris"
},
{
"message": "ipsum est sit ut quis",
"field": "est velit sunt sint",
"error_id": "in Ut ut Excepteur"
},
{
"message": "et ea dolor exercitation",
"field": "dolor Lorem nostrud non",
"error_id": "sit Duis consequat"
},
{
"message": "anim laboris pariatur",
"field": null,
"error_id": "adipisicing dolor"
}
]DELETE
{
"public_certificate": "<your x509 certificate>",
"id": 66138975,
"not_before": 1621289880,
"not_after": 1621289880,
"intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}[
{
"message": "tempor minim reprehenderit elit",
"field": "qui nostrud dolore commodo culpa",
"error_id": "irure sint"
},
{
"message": "sit pariatur ipsum",
"field": "adipisicing Ut est nulla",
"error_id": "qui incididunt eu Duis"
},
{
"message": "deserunt",
"field": null,
"error_id": "commodo velit"
}
][
{
"message": "qui",
"field": null,
"error_id": "fugiat"
},
{
"message": "voluptate dolore enim non cupidatat",
"field": null,
"error_id": "labore enim non"
}
][
{
"message": "nisi minim deserunt",
"field": null,
"error_id": "culpa sunt enim esse eu"
}
][
{
"message": "nulla",
"field": "qui enim",
"error_id": "proident do deserunt"
},
{
"message": "consectetur sunt labore reprehenderit et",
"field": null,
"error_id": "veniam consequat occaecat laboris"
}
][
{
"message": "aliqua sunt ad enim Duis",
"field": null,
"error_id": "labore"
},
{
"message": "labore in elit",
"field": "fugiat enim Excepteur",
"error_id": "ex deserunt Ut exercitation"
},
{
"message": "nostrud enim",
"field": "cupidatat",
"error_id": "qui eiusmod Lorem ullamco pariatur"
}
]Single Sign-On Settings(5 operations)
POST
{
"name": "Twilio SendGrid",
"enabled": true,
"signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
"signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
"entity_id": "http://www.okta.com/${org.externalKey}",
"completed_integration": true,
"id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}{
"name": "Twilio SendGrid",
"enabled": true,
"signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
"signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
"entity_id": "http://www.okta.com/${org.externalKey}",
"last_updated": 1621288964
}[
{
"message": "magna est",
"field": "exercitation id in sunt amet",
"error_id": "est irure"
},
{
"message": "ex sint tempor",
"field": "sunt",
"error_id": "est nulla"
},
{
"message": "fugiat",
"field": null,
"error_id": "deserunt sit velit ea"
},
{
"message": "cupidatat Excepteur tempor id commodo",
"field": null,
"error_id": "id ut ut sit"
}
][
{
"message": "est sunt eu",
"field": "ut aliquip",
"error_id": "eu"
}
][
{
"message": "sunt Excepteur ut incididunt ipsum",
"field": "cupidatat eiusmod esse occaecat",
"error_id": "occaecat veniam"
}
][
{
"message": "mollit reprehenderit incididunt exercitation ea",
"field": null,
"error_id": "occaecat commodo laboris"
},
{
"message": "exercitation culpa ullamco velit ut",
"field": null,
"error_id": "cillum voluptate ut sunt"
},
{
"message": "in Lorem",
"field": null,
"error_id": "commodo sint ullamco"
}
][
{
"message": "ipsum ut consequat dolor labore",
"field": null,
"error_id": "qui occaecat mollit"
},
{
"message": "officia in non Lorem exercitation",
"field": null,
"error_id": "voluptate"
},
{
"message": "in",
"field": null,
"error_id": "tempor laborum sit"
},
{
"message": "laboris id non",
"field": "aute quis non id",
"error_id": "Duis dolor dolor enim"
},
{
"message": "aliqua laborum",
"field": null,
"error_id": "et in"
}
]GET
| Query Parameter Name | Example |
|---|---|
si | true |
[
{
"name": "Twilio SendGrid",
"enabled": true,
"signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
"signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
"entity_id": "http://www.okta.com/${org.externalKey}",
"last_updated": 1621288520,
"completed_integration": true,
"id": "b0b98502-9408-4b24-9e3d-31ed7cb15312",
"single_signon_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312",
"audience_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312"
}
][
{
"message": "sunt enim incididunt",
"field": "do aliqua",
"error_id": "veniam occaecat"
},
{
"message": "sint ut enim officia",
"field": "qui enim",
"error_id": "labore minim officia aliqua velit"
},
{
"message": "in incididunt minim in cupidatat",
"field": "ullamco voluptate Duis",
"error_id": "in est occaecat ut"
}
][
{
"message": "Ut laboris dolore fugiat",
"field": null,
"error_id": "dolor sint in et"
},
{
"message": "ut anim esse in",
"field": "enim",
"error_id": "dolor dolore irure"
}
][
{
"message": "Ut",
"field": null,
"error_id": "reprehenderit cupidatat ut amet minim"
},
{
"message": "et consequat ut deserunt Ut",
"field": "sunt amet exercitation laborum occaecat",
"error_id": "deserunt nulla ut Lorem"
},
{
"message": "mollit veniam culpa aliquip nisi",
"field": "laboris velit",
"error_id": "in"
},
{
"message": "dolore do incididunt sunt est",
"field": null,
"error_id": "magna exercitation et sed ipsum"
},
{
"message": "do consectetur",
"field": "culpa esse elit Ut sunt",
"error_id": "veniam exercitation dolor incididunt"
}
][
{
"message": "consequat Duis incididunt",
"field": null,
"error_id": "labore exercitation consectetur reprehenderit Ut"
}
][
{
"message": "laboris veniam mollit esse",
"field": null,
"error_id": "sint"
},
{
"message": "labore Excepteur voluptate cupidatat eiusmod",
"field": "amet occaecat sunt ut",
"error_id": "ut id Duis"
},
{
"message": "tempor veniam ut",
"field": null,
"error_id": "aliqua do velit amet"
},
{
"message": "consectetur veniam velit",
"field": null,
"error_id": "do nulla ea adipisicing"
},
{
"message": "ut incididunt",
"field": "sunt cupidatat Excepteur",
"error_id": "laborum non anim in"
}
]GET
| Query Parameter Name | Example |
|---|---|
si | false |
{
"name": "Twilio SendGrid",
"enabled": true,
"signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
"signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
"entity_id": "http://www.okta.com/${org.externalKey}",
"last_updated": 1621288964,
"completed_integration": true,
"id": "b0b98502-9408-4b24-9e3d-31ed7cb15312",
"audience_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312"
}[
{
"message": "labore sunt proident enim adipisicing",
"field": "aute consectetur veniam sint",
"error_id": "culpa sint tempor esse"
},
{
"message": "aliqua labore adipisicing ut",
"field": "exercitation eiusmod consectetur id laborum",
"error_id": "fugiat nisi consequat"
}
][
{
"message": "dolore laborum cupidatat consequat",
"field": null,
"error_id": "consequat dolor tempor proident"
}
][
{
"message": "ut commodo",
"field": null,
"error_id": "exercitation aliqua"
},
{
"message": "occaecat tempor do",
"field": "proident ad aliqua Ut",
"error_id": "cupidatat exercitation deserunt Duis fugiat"
},
{
"message": "exercitation consectetur laborum",
"field": "dolor",
"error_id": "nisi in"
},
{
"message": "Excepteur elit",
"field": "esse",
"error_id": "esse mollit voluptate"
}
][
{
"message": "amet",
"field": null,
"error_id": "minim cupidatat dolor elit sed"
}
][
{
"message": "laborum eu et in mollit",
"field": "amet labore exercitation incididunt nostrud",
"error_id": "sint enim aliqua"
},
{
"message": "voluptate Ut dolor",
"field": "adipisicing laboris sunt dolor",
"error_id": "occaecat sed dolor"
},
{
"message": "sunt est pariatur ut consequat",
"field": null,
"error_id": "nulla"
}
]PATCH
| Query Parameter Name | Example |
|---|---|
si | true |
{
"name": "Twilio SendGrid",
"enabled": true,
"signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
"signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
"entity_id": "http://www.okta.com/${org.externalKey}",
"last_updated": 1621288964,
"completed_integration": true
}{
"name": "Twilio SendGrid",
"enabled": true,
"signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
"signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
"entity_id": "http://www.okta.com/${org.externalKey}",
"last_updated": 1621288964,
"id": "b0b98502-9408-4b24-9e3d-31ed7cb15312",
"single_signon_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312",
"audience_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312"
}[
{
"message": "velit Excepteur",
"field": "Excepteur dolore Duis",
"error_id": "sed culpa"
},
{
"message": "enim ad deserunt eu",
"field": null,
"error_id": "occaecat irure voluptate sint"
}
][
{
"message": "qui in",
"field": "magna ea quis amet",
"error_id": "enim"
}
][
{
"message": "quis in est",
"field": null,
"error_id": "nisi voluptate anim est"
}
][
{
"message": "Ut laboris ea consequat sed",
"field": null,
"error_id": "laboris elit nisi sunt eiusmod"
},
{
"message": "dolore minim consectetur",
"field": "nostrud Ut",
"error_id": "culpa"
},
{
"message": "ad id qui minim sint",
"field": "ullamco",
"error_id": "consequat"
},
{
"message": "officia cupidatat incididunt irure",
"field": "consectetur nulla",
"error_id": "laborum"
}
][
{
"message": "sint proident esse",
"field": "dolore occaecat ut minim laborum",
"error_id": "fugiat voluptate officia"
},
{
"message": "dolor mollit",
"field": "cupidatat",
"error_id": "sunt in ut esse anim"
},
{
"message": "culpa",
"field": null,
"error_id": "amet nostrud"
},
{
"message": "in commodo eu",
"field": null,
"error_id": "consectetur commodo Duis"
}
]DELETE
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.[
{
"message": "aliqua occaecat cupidatat Lorem",
"field": "veniam anim",
"error_id": "consectetur Ut magna"
},
{
"message": "occaecat Duis nisi",
"field": null,
"error_id": "sed Excepteur amet officia"
},
{
"message": "consequat",
"field": "exercitation",
"error_id": "deserunt incididunt dolor dolore aliquip"
},
{
"message": "Ut non Duis aliqua labore",
"field": null,
"error_id": "ex"
}
][
{
"message": "veniam ut",
"field": "aliquip cillum magna",
"error_id": "elit reprehenderit ea irure"
},
{
"message": "nostrud",
"field": "sunt ut nostrud",
"error_id": "dolore cillum"
},
{
"message": "magna mollit elit officia",
"field": null,
"error_id": "velit mollit fugiat ex"
},
{
"message": "officia",
"field": "proident",
"error_id": "in dolore eu consectetur"
}
][
{
"message": "ex",
"field": null,
"error_id": "in ad Lorem in"
},
{
"message": "magna anim",
"field": null,
"error_id": "officia commodo exercitation tempor"
},
{
"message": "dolore laboris dolore commodo qui",
"field": "ullamco ex non",
"error_id": "culpa dolor velit dolore commodo"
},
{
"message": "dolor sunt Ut",
"field": null,
"error_id": "Ut irure id ex aliqua"
}
][
{
"message": "dolore mollit cupidatat",
"field": "nostrud officia cupidatat",
"error_id": "eiusmod culpa do Excepteur laboris"
},
{
"message": "deserunt",
"field": "Ut exercitation",
"error_id": "in anim Excepteur Duis"
},
{
"message": "dolore",
"field": null,
"error_id": "quis est"
},
{
"message": "non eu minim officia",
"field": null,
"error_id": "amet pariatur labore esse"
}
][
{
"message": "velit commodo",
"field": null,
"error_id": "elit"
},
{
"message": "culpa Lorem amet",
"field": null,
"error_id": "exercitation"
}
]Single Sign-On Teammates(2 operations)
POST
{
"first_name": "Jane",
"last_name": "Doe",
"email": "jane_doe@example.com",
"scopes": [
"mail.batch.create",
"mail.batch.delete",
"mail.batch.read",
"mail.batch.update",
"mail.send"
]
}{
"first_name": "Jane",
"last_name": "Doe",
"email": "jane_doe@example.com",
"is_read_only": true,
"username": "jane_doe@example.com",
"is_sso": true
}[
{
"message": "laboris sed ex amet incididunt",
"field": "non nisi velit ex ad",
"error_id": "ex ad sunt"
},
{
"message": "pariatur quis nisi irure ad",
"field": "commodo eu minim pariatur",
"error_id": "in"
},
{
"message": "enim",
"field": null,
"error_id": "aliqua Ut esse voluptate"
},
{
"message": "sit qui",
"field": null,
"error_id": "est laboris labore"
}
][
{
"message": "eiusmod enim",
"field": "in pariatur proident",
"error_id": "ullamco Ut sed id"
}
][
{
"message": "voluptate",
"field": null,
"error_id": "exercitation veniam cupidatat ex sit"
},
{
"message": "esse nisi voluptate eu",
"field": null,
"error_id": "laborum ut in nisi sed"
},
{
"message": "ea dolor nulla velit",
"field": null,
"error_id": "laborum cillum labore ut aute"
}
][
{
"message": "minim amet tempor sint cillum",
"field": null,
"error_id": "esse consectetur sed nisi"
}
][
{
"message": "non quis occaecat id et",
"field": null,
"error_id": "ea"
}
]PATCH
{
"first_name": "Jane",
"last_name": "Doe",
"email": "jane_doe@example.com",
"scopes": [
"mail.batch.create",
"mail.batch.delete",
"mail.batch.read",
"mail.batch.update",
"mail.send"
],
"is_admin": false
}{
"first_name": "Jane",
"last_name": "Doe",
"email": "jane_doe@example.com",
"is_admin": false,
"username": "jane_doe@example.com",
"is_sso": true,
"address": "1234 Fake St.",
"address2": "Suite 5",
"city": "San Francisco",
"state": "CA",
"zip": "94105",
"Country": "United States",
"phone": "+15555555555",
"user_type": "teammate"
}[
{
"message": "ad dolor cillum",
"field": null,
"error_id": "magna incididunt"
},
{
"message": "eu culpa ut reprehenderit",
"field": "dolore officia fugiat dolor",
"error_id": "pariatur"
}
][
{
"message": "nisi in tempor dolor",
"field": null,
"error_id": "sed proident elit velit ex"
},
{
"message": "pariatur dolore occaecat",
"field": "sit magna Ut Duis",
"error_id": "exercitation velit eu"
},
{
"message": "irure in pariatur",
"field": "nostrud voluptate",
"error_id": "est laboris"
},
{
"message": "quis magna sint proident",
"field": null,
"error_id": "cillum sit occaecat dolor ex"
}
][
{
"message": "adipisicing aliquip ullamco",
"field": null,
"error_id": "minim labore fugiat nisi"
},
{
"message": "laborum non ex eiusmod",
"field": null,
"error_id": "consectetur consequat deserunt qui sint"
},
{
"message": "ipsum laboris Excepteur anim",
"field": null,
"error_id": "occaecat consectetur irure"
},
{
"message": "dolor esse pariatur nisi non",
"field": null,
"error_id": "et labore fugiat ad"
}
][
{
"message": "pariatur Excepteur",
"field": null,
"error_id": "sint fugiat"
},
{
"message": "sint nisi nostrud",
"field": null,
"error_id": "nisi dolor consequat laboris non"
},
{
"message": "culpa incididunt Ut quis",
"field": "ex reprehenderit",
"error_id": "adipisicing aute sint aliqua pariatur"
}
][
{
"message": "Duis anim",
"field": "reprehenderit",
"error_id": "labore elit sed"
},
{
"message": "veniam anim est aute laborum",
"field": "consectetur voluptate dolor",
"error_id": "consequat Excepteur"
},
{
"message": "Lorem",
"field": null,
"error_id": "laboris aute minim occaecat deserunt"
}
]Settings - Mail(13 operations)
GET
| Query Parameter Name | Example |
|---|---|
limit | 87866998 |
offset | -49486786 |
| Header Name | Example |
|---|---|
on-behalf-of | "non" |
{
"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": "ad id ut aliquip Excepteur",
"field": "non Ut",
"message": "nostrud sunt",
"parameter": "et sint est occaecat incididunt"
},
{
"error_id": "irure labore",
"field": "laboris ex anim",
"message": "anim laborum",
"parameter": "aliqua occaecat consequat nisi in"
},
{
"error_id": "mollit incididunt sit commodo",
"field": "proident do magna commodo",
"message": "nostrud nulla",
"parameter": "dolore culpa"
},
{
"error_id": "dolore non laboris",
"field": "Ut velit",
"message": "in amet laborum",
"parameter": "sint commodo"
},
{
"error_id": "velit ullamco",
"field": null,
"message": "Excepteur cupidatat ad",
"parameter": "mollit id"
}
]
}{
"errors": [
{
"error_id": "adipisicing ullamco consectetur",
"field": "commodo est exercitation",
"message": "ex Lorem magna",
"parameter": "eu magna aliqua"
}
]
}{
"errors": [
{
"error_id": "amet ipsum anim",
"field": "incididunt Lorem voluptate magna nostrud",
"message": "mollit cillum nostrud labore Excepteur",
"parameter": "elit amet Ut Excepteur"
},
{
"error_id": "cupidatat eu laboris",
"field": null,
"message": "sunt dolor proident adipisicing reprehenderit",
"parameter": "Lorem sint eu ipsum"
},
{
"error_id": "velit quis adipisicing",
"field": "cillum esse occaecat qui",
"message": "ullamco dolor non",
"parameter": "enim officia sint"
},
{
"error_id": "ipsum",
"field": "nulla ullamco",
"message": "officia Ut in Lorem laborum",
"parameter": "pariatur id est sit"
},
{
"error_id": "amet consectetur reprehenderit occaecat deserunt",
"field": "veniam ut exercitation laboris esse",
"message": "ullamco eiusmod dolor dolore",
"parameter": "exercitation proident consequat non et"
}
]
}{
"errors": [
{
"error_id": "magna irure pariatur velit",
"field": null,
"message": "irure dolor consequat Excepteur",
"parameter": "reprehenderit qui"
},
{
"error_id": "occaecat labore",
"field": null,
"message": "commodo culpa",
"parameter": "enim Duis exercitation mollit pariatur"
},
{
"error_id": "in veniam",
"field": "sed",
"message": "Excepteur velit minim esse",
"parameter": "enim incididunt in"
}
]
}{
"errors": [
{
"error_id": "id esse occaecat nostrud",
"field": "ea",
"message": "Lorem",
"parameter": "Excepteur Duis nulla eu"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "enim voluptate mollit" |
{
"enabled": true,
"list": [
"email1@example.com",
"example.com"
]
}{
"enabled": true,
"list": [
"email1@example.com"
]
}{
"errors": [
{
"error_id": "laborum",
"field": "eu ad voluptate labore",
"message": "elit ea incididunt",
"parameter": "dolore ea veniam laboris in"
},
{
"error_id": "dolore",
"field": "pariatur anim in nulla",
"message": "sed ad ea officia",
"parameter": "do"
},
{
"error_id": "do qui incididunt",
"field": null,
"message": "nisi dolor veniam ut mollit",
"parameter": "magna aliqua labore laboris adipisicing"
},
{
"error_id": "elit",
"field": "ex aute do",
"message": "culpa occaecat officia qui",
"parameter": "aliqua esse qui incididunt"
}
]
}{
"errors": [
{
"error_id": "ex magna",
"field": null,
"message": "magna enim est dolor",
"parameter": "eu ea dolore"
},
{
"error_id": "elit aute consectetur",
"field": null,
"message": "sunt id occaecat ex et",
"parameter": "do"
},
{
"error_id": "occaecat consectetur",
"field": null,
"message": "occaecat ex fugiat exercitation ipsum",
"parameter": "ullamco Excepteur veniam eu"
},
{
"error_id": "dolore aliqua id",
"field": null,
"message": "dolore",
"parameter": "fugiat"
}
]
}{
"errors": [
{
"error_id": "minim",
"field": null,
"message": "consequat dolor eiusmod sit magna",
"parameter": "amet do laborum"
},
{
"error_id": "ad qui voluptate dolor",
"field": null,
"message": "veniam ex fugiat Excepteur",
"parameter": "pariatur id in consectetur"
}
]
}{
"errors": [
{
"error_id": "dolor velit cillum",
"field": null,
"message": "deserunt nulla velit non",
"parameter": "id ut"
}
]
}{
"errors": [
{
"error_id": "dolore proident ea culpa",
"field": "reprehenderit quis adipisicing enim",
"message": "sunt proident elit",
"parameter": "laborum"
},
{
"error_id": "officia ut anim",
"field": null,
"message": "eu",
"parameter": "dolor adipisicing fugiat anim sunt"
},
{
"error_id": "cupidatat non veniam in in",
"field": null,
"message": "et in eiusmod Duis",
"parameter": "velit officia in"
},
{
"error_id": "consectetur elit deserunt reprehenderit",
"field": null,
"message": "ut Duis eu elit Ut",
"parameter": "occaecat"
},
{
"error_id": "amet veniam consectetur est dolor",
"field": "Excepteur ut",
"message": "in fugiat sunt velit consectetur",
"parameter": "do cupidatat sunt dolore"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "irure veniam" |
{
"enabled": true,
"list": [
"example.com",
"jane_doe@example1.com"
]
}{
"errors": [
{
"error_id": "labore laboris veniam adipisicing in",
"field": null,
"message": "irure id fugiat",
"parameter": "sunt"
},
{
"error_id": "sit dolore fugiat",
"field": null,
"message": "elit anim Ut commodo",
"parameter": "aliqua cillum Lorem eu sit"
},
{
"error_id": "deserunt",
"field": null,
"message": "aliqua",
"parameter": "ex cillum laboris amet"
}
]
}{
"errors": [
{
"error_id": "dolor sunt quis",
"field": null,
"message": "consectetur minim sunt",
"parameter": "ullamco dolor velit"
},
{
"error_id": "occaecat minim",
"field": null,
"message": "occaecat sunt",
"parameter": "aliqua ad"
}
]
}{
"errors": [
{
"error_id": "consectetur aliquip sint dolor Duis",
"field": "ut ipsum",
"message": "eiusmod",
"parameter": "nostrud nisi fugiat in"
},
{
"error_id": "id in dolore dolore",
"field": "aliquip nostrud",
"message": "quis voluptate aliquip sed",
"parameter": "velit"
},
{
"error_id": "mollit Lorem sunt",
"field": "velit ea ad cillum",
"message": "Excepteur Ut",
"parameter": "eiusmod Ut dolor"
},
{
"error_id": "commodo est mollit",
"field": "culpa reprehenderit",
"message": "pariatur",
"parameter": "cillum sit amet qui quis"
}
]
}{
"errors": [
{
"error_id": "deserunt qui aute",
"field": "cupidatat enim",
"message": "sit",
"parameter": "sunt sit Ut sed pariatur"
},
{
"error_id": "adipisicing pariatur reprehenderit elit aliqua",
"field": "id sint",
"message": "anim et enim ut",
"parameter": "eiusmod nisi adipisicing"
},
{
"error_id": "occaecat irure magna enim et",
"field": null,
"message": "adipisicing Excepteur",
"parameter": "pariatur aliquip non officia"
}
]
}{
"errors": [
{
"error_id": "est occaecat",
"field": null,
"message": "adipisicing fugiat",
"parameter": "eu sunt quis"
},
{
"error_id": "irure est",
"field": null,
"message": "nostrud",
"parameter": "anim velit Lorem aute"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "laborum in elit" |
{
"enabled": true,
"html_content": "<p><a href=\"http://example.com\" target=\"_blank\">Ahoy, World!</a></p>\n",
"plain_content": ""
}{
"enabled": true,
"html_content": "<p><a href=\"http://example.com\" target=\"_blank\">Ahoy, World!</a></p>\n",
"plain_content": ""
}{
"errors": [
{
"error_id": "proident ut",
"field": "ut reprehenderit",
"message": "pariatur eiusmod sint",
"parameter": "dolor"
},
{
"error_id": "pariatur",
"field": null,
"message": "consectetur sit ut exercitation",
"parameter": "et nisi labore occaecat sunt"
}
]
}{
"errors": [
{
"error_id": "velit aliqua sint elit",
"field": null,
"message": "ad esse laborum eiusmod velit",
"parameter": "laboris proident nisi"
}
]
}{
"errors": [
{
"error_id": "Ut ea ad pariatur",
"field": null,
"message": "incididunt adipisicing qui magna ut",
"parameter": "pariatur voluptate labore magna id"
},
{
"error_id": "amet Excepteur laborum dolore",
"field": "dolor",
"message": "dolor Lorem ex pariatur ut",
"parameter": "esse et eiusmod"
},
{
"error_id": "est fugiat deserunt",
"field": null,
"message": "sit est magna ut",
"parameter": "laboris"
},
{
"error_id": "Excepteur",
"field": "veniam deserunt do",
"message": "pariatur cupidatat dolore ex aliqua",
"parameter": "laborum Duis enim sed"
}
]
}{
"errors": [
{
"error_id": "incididunt est mollit do cupidatat",
"field": "anim laborum sit",
"message": "pariatur Duis laboris velit",
"parameter": "aliqua ut occaecat esse deserunt"
},
{
"error_id": "pariatur aliqua cupidatat ut",
"field": null,
"message": "adipisicing aliqua",
"parameter": "nisi dolore qui aute irure"
}
]
}{
"errors": [
{
"error_id": "ad",
"field": "laboris consectetur",
"message": "nulla nisi proident esse",
"parameter": "ut"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "reprehenderit est deserunt" |
{
"enabled": true,
"html_content": "<p><a href=\"http://example.com\" target=\"_blank\">Ahoy, World!</a></p>\n",
"plain_content": ""
}{
"errors": [
{
"error_id": "ipsum mollit in",
"field": null,
"message": "cupidatat adipisicing ea",
"parameter": "culpa"
},
{
"error_id": "ut minim exercitation aliquip reprehenderit",
"field": null,
"message": "proident veniam anim nisi aliqua",
"parameter": "ad dolor in laborum in"
},
{
"error_id": "aute eiusmod pariatur anim",
"field": "laborum",
"message": "sunt dolor consectetur ullamco officia",
"parameter": "dolor ut"
}
]
}{
"errors": [
{
"error_id": "veniam Lorem",
"field": null,
"message": "velit in ut nisi",
"parameter": "in labore"
},
{
"error_id": "et deserunt",
"field": "irure ipsum",
"message": "non est",
"parameter": "dolor deserunt"
},
{
"error_id": "ut in Ut",
"field": "incididunt",
"message": "enim deserunt nulla",
"parameter": "nulla eu labore"
},
{
"error_id": "do id dolore",
"field": null,
"message": "ullamco Lorem in aliqua",
"parameter": "ad sunt aliqua Excepteur eu"
},
{
"error_id": "reprehenderit Duis ipsum deserunt",
"field": "adipisicing voluptate sed Duis",
"message": "in in",
"parameter": "Lorem"
}
]
}{
"errors": [
{
"error_id": "tempor magna adipisicing",
"field": null,
"message": "consequat sed ut sit",
"parameter": "eiusmod Duis"
},
{
"error_id": "in ut cupidatat proident",
"field": null,
"message": "mollit aliquip",
"parameter": "non Ut eu minim"
}
]
}{
"errors": [
{
"error_id": "ipsum",
"field": "tempor et mollit",
"message": "culpa dolor quis",
"parameter": "exercitation"
},
{
"error_id": "sint sit",
"field": "occaecat",
"message": "culpa cillum adipisicing aliqua",
"parameter": "aliquip consequat nisi pariatur Ut"
},
{
"error_id": "incididunt Ut officia minim",
"field": "nostrud ut cupidatat",
"message": "anim dolor est fugiat",
"parameter": "ullamco ad in anim enim"
},
{
"error_id": "proident et qui",
"field": "sunt ut quis Excepteur proident",
"message": "reprehenderit amet",
"parameter": "Lorem commodo est in cillum"
}
]
}{
"errors": [
{
"error_id": "mollit Lorem Duis ut reprehenderit",
"field": null,
"message": "enim commodo consectetur incididunt eu",
"parameter": "eiusmod Excepteur pariatur dolor nostrud"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "deserunt dolor fugiat" |
{
"email": "abuse@example.com",
"enabled": true
}{
"email": "abuse@example.com",
"enabled": true
}{
"errors": [
{
"error_id": "sunt Lorem",
"field": null,
"message": "esse laboris mollit",
"parameter": "cupidatat nostrud velit et"
},
{
"error_id": "et nulla voluptate",
"field": null,
"message": "magna dolore veniam dolor anim",
"parameter": "magna laboris id elit aute"
}
]
}{
"errors": [
{
"error_id": "aliqua eu velit sunt ea",
"field": "aliqua cupidatat aute qui",
"message": "voluptate in",
"parameter": "nisi sint"
},
{
"error_id": "non irure consectetur ea",
"field": "nulla nisi veniam quis esse",
"message": "ea cupidatat irure consequat officia",
"parameter": "deserunt Duis consequat in"
},
{
"error_id": "aliquip ullamco do ut Excepteur",
"field": "laboris eu ad Ut amet",
"message": "Duis",
"parameter": "aliquip"
},
{
"error_id": "Lorem elit velit",
"field": "consequat ea in aute in",
"message": "cillum ut adipisicing",
"parameter": "veniam"
}
]
}{
"errors": [
{
"error_id": "voluptate elit veniam",
"field": "culpa ad sunt dolor",
"message": "ex",
"parameter": "enim commodo irure"
},
{
"error_id": "incididunt ea",
"field": null,
"message": "nulla voluptate sint enim culpa",
"parameter": "cupidatat Ut"
},
{
"error_id": "veniam",
"field": null,
"message": "dolore proident Lorem veniam",
"parameter": "consequat id ipsum sint"
},
{
"error_id": "pariatur incididunt Duis magna",
"field": null,
"message": "aliquip proident eiusmod laborum",
"parameter": "cillum ea qui aliquip"
},
{
"error_id": "minim esse ut incididunt cupidatat",
"field": "dolor minim Duis enim eu",
"message": "eu",
"parameter": "occaecat Ut enim Lorem"
}
]
}{
"errors": [
{
"error_id": "non",
"field": null,
"message": "anim",
"parameter": "magna anim dolor"
},
{
"error_id": "qui proident irure",
"field": "commodo ut voluptate",
"message": "ex do eiusmod esse laborum",
"parameter": "Lorem dolore velit tempor"
},
{
"error_id": "in aliqua ut tempor",
"field": null,
"message": "elit veniam",
"parameter": "proident anim dolore eiusmod"
},
{
"error_id": "ipsum in",
"field": "sunt reprehenderit ut",
"message": "est consequat elit deserunt officia",
"parameter": "consequat nisi quis"
},
{
"error_id": "ullamco",
"field": "do nostrud Lorem",
"message": "fugiat ipsum do irure",
"parameter": "mollit"
}
]
}{
"errors": [
{
"error_id": "aliquip sit",
"field": null,
"message": "dolor anim",
"parameter": "sint culpa ipsum"
},
{
"error_id": "consequat",
"field": "consectetur irure",
"message": "fugiat",
"parameter": "amet in"
},
{
"error_id": "exercitation commodo Duis eiusmod",
"field": null,
"message": "id",
"parameter": "voluptate"
},
{
"error_id": "enim sit esse non",
"field": null,
"message": "reprehenderit fugiat",
"parameter": "pariatur eiusmod ipsum incididunt veniam"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "Excepteur eu adipisicing" |
{
"email": "abuse@example.com",
"enabled": true
}{
"errors": [
{
"error_id": "do officia non eu",
"field": "culpa est eiusmod deserunt officia",
"message": "nisi voluptate in occaecat proident",
"parameter": "esse"
}
]
}{
"errors": [
{
"error_id": "eiusmod officia laboris ut dolore",
"field": "id",
"message": "culpa in ad ex aute",
"parameter": "consectetur fugiat mollit Ut"
},
{
"error_id": "proident cupidatat ea eiusmod amet",
"field": null,
"message": "non sunt mollit ex",
"parameter": "qui ullamco"
},
{
"error_id": "velit proident in anim in",
"field": null,
"message": "dolore Duis labore",
"parameter": "dolore"
}
]
}{
"errors": [
{
"error_id": "pariatur dolor fugiat",
"field": "in",
"message": "proident sunt",
"parameter": "Excepteur ullamco qui dolor labore"
},
{
"error_id": "consequat in",
"field": "velit cillum nisi ex",
"message": "ex",
"parameter": "eu qui labore dolore ad"
}
]
}{
"errors": [
{
"error_id": "minim adipisicing aute tempor Lorem",
"field": "ut magna incididunt sint",
"message": "est ut occaecat veniam cillum",
"parameter": "sit aliqua nulla"
},
{
"error_id": "Excepteur velit",
"field": null,
"message": "officia exercitation fugiat ad in",
"parameter": "ullamco"
},
{
"error_id": "eiusmod in esse officia amet",
"field": "reprehenderit dolore consequat officia labore",
"message": "qui Excepteur Ut aliquip",
"parameter": "amet laboris"
}
]
}{
"errors": [
{
"error_id": "Ut in mollit minim",
"field": null,
"message": "ad adipisicing in occaecat aliquip",
"parameter": "minim eu irure esse pariatur"
},
{
"error_id": "laboris dolore esse incididunt",
"field": null,
"message": "eu adipisicing",
"parameter": "ea fugiat anim"
},
{
"error_id": "Lorem sunt sed",
"field": null,
"message": "dolore reprehenderit laborum sed",
"parameter": "veniam nulla in sed nisi"
},
{
"error_id": "aliquip",
"field": "et commodo fugiat sint aliqua",
"message": "dolor elit ex",
"parameter": "tempor"
},
{
"error_id": "magna incididunt aliqua qui dolore",
"field": "aliqua",
"message": "labore ad Duis deserunt amet",
"parameter": "in mollit"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "aliqua cupidatat tempor" |
{
"enabled": true,
"html_content": "<% body %>"
}{
"enabled": false,
"html_content": "<p><% body %>Example</p>\n"
}{
"errors": [
{
"error_id": "officia deserunt reprehenderit pariatur ex",
"field": null,
"message": "sint tempor Lorem commodo labore",
"parameter": "aliquip consequat non"
},
{
"error_id": "elit veniam proident",
"field": null,
"message": "ullamco",
"parameter": "aute do"
},
{
"error_id": "occaecat laborum do esse eiusmod",
"field": null,
"message": "occaecat",
"parameter": "est in irure"
},
{
"error_id": "nisi tempor mollit",
"field": "culpa laborum sunt",
"message": "qui commodo",
"parameter": "exercitation tempor veniam Ut"
}
]
}{
"errors": [
{
"error_id": "elit",
"field": "culpa",
"message": "in veniam dolore",
"parameter": "sit"
},
{
"error_id": "nisi consequat aliqua",
"field": null,
"message": "qui proident reprehenderit culpa eiusmod",
"parameter": "laborum aliqua ex"
},
{
"error_id": "ipsum minim laborum",
"field": null,
"message": "ut",
"parameter": "fugiat"
}
]
}{
"errors": [
{
"error_id": "sunt minim",
"field": "adipisicing ex",
"message": "dolore Lorem",
"parameter": "quis"
},
{
"error_id": "Lorem voluptate",
"field": "quis qui ut ipsum ullamco",
"message": "in ad in",
"parameter": "velit"
},
{
"error_id": "et",
"field": null,
"message": "nulla adipisicing cupidatat",
"parameter": "cupidatat ut minim"
},
{
"error_id": "in anim in nulla ad",
"field": null,
"message": "nostrud",
"parameter": "in qui sint et"
},
{
"error_id": "amet",
"field": "anim officia sint cupidatat",
"message": "reprehenderit commodo",
"parameter": "reprehenderit"
}
]
}{
"errors": [
{
"error_id": "dolore pariatur nulla in enim",
"field": "dolor Excepteur in",
"message": "aute dolor",
"parameter": "ea"
},
{
"error_id": "tempor elit ut",
"field": "proident sit nostrud",
"message": "qui laborum ullamco culpa veniam",
"parameter": "dolor consequat nulla culpa"
},
{
"error_id": "aute cupidatat nulla enim do",
"field": "ipsum sit amet",
"message": "pariatur nostrud cillum",
"parameter": "elit eu nisi fugiat veniam"
},
{
"error_id": "reprehenderit esse pariatur deserunt id",
"field": "do Excepteur anim in",
"message": "irure",
"parameter": "sint enim pariatur culpa proident"
},
{
"error_id": "ipsum Ut aliqua",
"field": "adipisicing",
"message": "eu Lorem pariatur qui ad",
"parameter": "non consectetur"
}
]
}{
"errors": [
{
"error_id": "proident enim dolore",
"field": null,
"message": "ut labore",
"parameter": "est sed ut tempor incididunt"
},
{
"error_id": "dolore eiusmod culpa consequat et",
"field": null,
"message": "do",
"parameter": "tempor enim id"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "labore qui velit" |
{
"enabled": false,
"html_content": "<p><% body %>Example</p>\n"
}{
"errors": [
{
"error_id": "aute magna cupidatat labore dolore",
"field": null,
"message": "qui ea",
"parameter": "eiusmod"
},
{
"error_id": "consequat sunt",
"field": "irure commodo consectetur dolor",
"message": "in",
"parameter": "labore in aute minim ea"
},
{
"error_id": "cillum",
"field": "fugiat",
"message": "ex",
"parameter": "deserunt sint ea"
},
{
"error_id": "ullamco ad labore sunt cillum",
"field": null,
"message": "in qui dolor",
"parameter": "labore ea qui"
}
]
}{
"errors": [
{
"error_id": "qui Lorem esse officia aliquip",
"field": null,
"message": "dolore nostrud",
"parameter": "aliquip"
},
{
"error_id": "in veniam tempor",
"field": null,
"message": "reprehenderit dolor",
"parameter": "officia dolore"
},
{
"error_id": "laborum incididunt in enim",
"field": "nulla consequat non laboris",
"message": "reprehenderit",
"parameter": "non aliquip sint sunt"
}
]
}{
"errors": [
{
"error_id": "anim ex culpa consectetur dolor",
"field": null,
"message": "ut",
"parameter": "ad"
},
{
"error_id": "commodo proident",
"field": null,
"message": "do laborum pariatur ullamco nisi",
"parameter": "voluptate adipisicing laboris exercitation"
},
{
"error_id": "dolore laborum",
"field": "consequat proident",
"message": "cupidatat",
"parameter": "ut officia ex"
},
{
"error_id": "eu",
"field": null,
"message": "ullamco magna dolore et mollit",
"parameter": "minim eiusmod in deserunt"
}
]
}{
"errors": [
{
"error_id": "amet sunt labore nostrud culpa",
"field": "in do veniam laborum id",
"message": "culpa",
"parameter": "ea tempor aliquip dolore nostrud"
},
{
"error_id": "ea",
"field": "nostrud Duis in labore",
"message": "consectetur",
"parameter": "exercitation ex minim"
},
{
"error_id": "minim in consequat",
"field": null,
"message": "elit",
"parameter": "ullamco culpa ut sint"
}
]
}{
"errors": [
{
"error_id": "aliquip do eu",
"field": "commodo elit magna",
"message": "officia",
"parameter": "velit eu"
},
{
"error_id": "velit irure eiusmod cupidatat laborum",
"field": "laborum minim in tempor magna",
"message": "incididunt dolore esse nisi quis",
"parameter": "exercitation ex"
},
{
"error_id": "ut Excepteur eu cillum aliquip",
"field": null,
"message": "velit elit",
"parameter": "ullamco culpa sit in"
},
{
"error_id": "ipsum reprehenderit veniam sit officia",
"field": null,
"message": "ut et velit Ut magna",
"parameter": "nostrud"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "laboris exercitation" |
{
"enabled": true,
"hard_bounces": 5,
"soft_bounces": 5
}{
"enabled": false,
"hard_bounces": 5,
"soft_bounces": 5
}{
"errors": [
{
"error_id": "eu",
"field": null,
"message": "velit reprehenderit ipsum do",
"parameter": "adipisicing incididunt nostrud deserunt"
},
{
"error_id": "irure ut",
"field": null,
"message": "eiusmod aliquip voluptate",
"parameter": "dolor minim reprehenderit sit"
}
]
}{
"errors": [
{
"error_id": "do",
"field": "occaecat ut",
"message": "exercitation ex Duis tempor non",
"parameter": "tempor ullamco anim"
},
{
"error_id": "ullamco tempor",
"field": null,
"message": "officia",
"parameter": "ex amet Lorem sunt magna"
}
]
}{
"errors": [
{
"error_id": "cillum sunt",
"field": null,
"message": "commodo",
"parameter": "qui"
},
{
"error_id": "ullamco dolore",
"field": "id non proident tempor minim",
"message": "deserunt aliquip dolore",
"parameter": "pariatur occaecat Ut ad"
}
]
}{
"errors": [
{
"error_id": "est consequat ut",
"field": null,
"message": "Duis ut occaecat Ut",
"parameter": "officia consectetur sunt"
},
{
"error_id": "Excepteur Lorem laborum sed",
"field": null,
"message": "eu qui incididunt cupidatat culpa",
"parameter": "ut commodo Lorem eiusmod aliqua"
},
{
"error_id": "non",
"field": "Ut",
"message": "dolore incididunt officia anim laborum",
"parameter": "velit sint"
}
]
}{
"errors": [
{
"error_id": "occaecat nostrud irure fugiat",
"field": null,
"message": "exercitation nulla",
"parameter": "consequat Duis"
},
{
"error_id": "fugiat ex sint id",
"field": "incididunt non",
"message": "ex tempor minim aliquip cillum",
"parameter": "Lorem qui laboris cillum reprehenderit"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "Excepteur magna" |
{
"enabled": false,
"soft_bounces": 5,
"hard_bounces": 5
}{
"errors": [
{
"error_id": "qui do Duis",
"field": "fugiat non Ut culpa",
"message": "cillum id velit voluptate",
"parameter": "sed ea minim"
},
{
"error_id": "do",
"field": null,
"message": "Lorem enim magna",
"parameter": "nisi dolore Lorem laboris"
}
]
}{
"errors": [
{
"error_id": "cupidatat eiusmod",
"field": null,
"message": "Lorem",
"parameter": "ut id"
},
{
"error_id": "irure commodo officia nostrud",
"field": null,
"message": "dolore officia veniam nostrud",
"parameter": "in adipisicing culpa"
},
{
"error_id": "aliquip mollit Lorem id",
"field": null,
"message": "minim anim",
"parameter": "ullamco aliqua ea sunt enim"
},
{
"error_id": "sed",
"field": null,
"message": "eiusmod id officia",
"parameter": "in enim ut qui aliquip"
},
{
"error_id": "occaecat anim nulla laborum eiusmod",
"field": null,
"message": "ipsum est consequat",
"parameter": "Lorem culpa ipsum"
}
]
}{
"errors": [
{
"error_id": "occaecat enim nulla nostrud",
"field": "in Duis et sit",
"message": "et",
"parameter": "eiusmod qui"
},
{
"error_id": "dolore anim proident do",
"field": null,
"message": "irure nostrud Ut enim",
"parameter": "tempor ut consectetur ullamco culpa"
},
{
"error_id": "qui quis ut",
"field": null,
"message": "est proident",
"parameter": "proident irure laborum"
},
{
"error_id": "ipsum Duis laborum ut",
"field": "cillum esse",
"message": "nostrud consectetur",
"parameter": "et deserunt amet"
},
{
"error_id": "nostrud voluptate",
"field": null,
"message": "in eu consequat magna",
"parameter": "in do enim voluptate"
}
]
}{
"errors": [
{
"error_id": "consectetur fugiat",
"field": "est laborum commodo amet sint",
"message": "irure qui",
"parameter": "cupidatat"
},
{
"error_id": "Lorem ut aute",
"field": "Ut cillum enim",
"message": "in",
"parameter": "laborum"
},
{
"error_id": "dolore et",
"field": "ipsum",
"message": "laboris quis amet",
"parameter": "nulla elit do in reprehenderit"
},
{
"error_id": "Lorem dolor ut dolore",
"field": null,
"message": "non",
"parameter": "fugiat sint"
},
{
"error_id": "nisi ipsum sed",
"field": "ut dolor",
"message": "velit aliqua",
"parameter": "dolore exercitation anim nostrud ut"
}
]
}{
"errors": [
{
"error_id": "veniam in Ut dolor cupidatat",
"field": null,
"message": "amet tempor ex",
"parameter": "enim fugiat amet anim"
},
{
"error_id": "officia aliquip incididunt quis adipisicing",
"field": "cupidatat culpa nisi occaecat quis",
"message": "sed",
"parameter": "sunt esse ad nostrud"
},
{
"error_id": "ipsum et laborum nulla non",
"field": "esse eiusmod commodo ut",
"message": "ex",
"parameter": "do"
},
{
"error_id": "commodo",
"field": null,
"message": "enim dolore qui",
"parameter": "fugiat cillum et tempor laboris"
},
{
"error_id": "sunt eiusmod ad dolore aliquip",
"field": "in",
"message": "proident nulla officia tempor",
"parameter": "laboris"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "laboris" |
{
"enabled": true,
"email": "bounces@example.com"
}{
"email": "bounces@example.com",
"enabled": true
}{
"errors": [
{
"error_id": "in mollit amet laboris",
"field": null,
"message": "eiusmod",
"parameter": "aliquip anim ullamco et laborum"
},
{
"error_id": "pariatur eiusmod",
"field": null,
"message": "elit exercitation ea",
"parameter": "sit sed veniam"
},
{
"error_id": "ea et sit amet nisi",
"field": null,
"message": "aute",
"parameter": "nisi ex"
},
{
"error_id": "enim do id deserunt",
"field": null,
"message": "exercitation in proident magna amet",
"parameter": "eu dolore consequat"
}
]
}{
"errors": [
{
"error_id": "in",
"field": null,
"message": "velit ipsum in nulla",
"parameter": "non ut proident ea"
},
{
"error_id": "tempor",
"field": "Duis pariatur",
"message": "commodo veniam sint culpa sit",
"parameter": "labore elit ea in voluptate"
},
{
"error_id": "ullamco",
"field": null,
"message": "nisi ex",
"parameter": "dolore pariatur Excepteur dolor incididunt"
},
{
"error_id": "est ut",
"field": null,
"message": "ea ex Excepteur non",
"parameter": "quis adipisicing eiusmod consequat"
},
{
"error_id": "et",
"field": null,
"message": "consectetur ea esse sit aute",
"parameter": "Duis et cillum ullamco do"
}
]
}{
"errors": [
{
"error_id": "ipsum minim Ut",
"field": "anim ut",
"message": "consectetur pariatur proident et officia",
"parameter": "ut fugiat"
},
{
"error_id": "in exercitation proident",
"field": null,
"message": "incididunt ullamco",
"parameter": "est fugiat nostrud"
},
{
"error_id": "Duis",
"field": null,
"message": "sit aliquip aliqua est",
"parameter": "nulla cupidatat laborum officia aliqua"
},
{
"error_id": "aute cupidatat officia",
"field": "in sint labore officia amet",
"message": "sint",
"parameter": "Ut proident in non"
}
]
}{
"errors": [
{
"error_id": "ut",
"field": null,
"message": "minim laboris aute",
"parameter": "minim adipisicing"
},
{
"error_id": "laborum est nostrud",
"field": null,
"message": "exercitation deserunt ea nostrud dolore",
"parameter": "est laborum"
},
{
"error_id": "laborum ipsum anim eiusmod voluptate",
"field": "aliqua nisi sint",
"message": "aliqua culpa reprehenderit tempor in",
"parameter": "fugiat laboris non tempor sit"
},
{
"error_id": "ea incididunt",
"field": null,
"message": "laboris commodo sint mollit",
"parameter": "non fugiat officia cupidatat dolor"
}
]
}{
"errors": [
{
"error_id": "occaecat dolor aute consequat",
"field": null,
"message": "Excepteur amet adipisicing dolor dolor",
"parameter": "dolor officia ad qui"
},
{
"error_id": "quis voluptate magna",
"field": null,
"message": "sit",
"parameter": "proident velit non cupidatat occaecat"
},
{
"error_id": "exercitation sunt aliqua enim",
"field": "dolor ea Ut",
"message": "dolor",
"parameter": "velit minim non consectetur"
},
{
"error_id": "reprehenderit ut dolor in",
"field": null,
"message": "sunt",
"parameter": "ex"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "non aliqua" |
{
"enabled": true,
"email": "bounces@example.com"
}{
"errors": [
{
"error_id": "officia nisi",
"field": "laboris",
"message": "esse non",
"parameter": "nulla Ut dolore nostrud Lorem"
},
{
"error_id": "Lorem",
"field": "proident eu",
"message": "ut minim cupidatat veniam consectetur",
"parameter": "officia labore aliquip id"
},
{
"error_id": "ad Excepteur commodo",
"field": null,
"message": "deserunt dolor",
"parameter": "id eu"
},
{
"error_id": "dolore et sunt",
"field": null,
"message": "fugiat ullamco adipisicing sed",
"parameter": "ut dolore cupidatat et"
},
{
"error_id": "pariatur",
"field": "in ut anim cupidatat",
"message": "aliquip laborum do officia quis",
"parameter": "nisi Ut ipsum"
}
]
}{
"errors": [
{
"error_id": "veniam Lorem cillum",
"field": "magna",
"message": "ex sed sit",
"parameter": "Duis veniam laborum Lorem eu"
},
{
"error_id": "commodo Lorem officia labore",
"field": "do in",
"message": "cupidatat",
"parameter": "fugiat deserunt consectetur"
},
{
"error_id": "aliqua cupidatat ut",
"field": null,
"message": "labore cillum Duis in",
"parameter": "nostrud dolore qui id"
}
]
}{
"errors": [
{
"error_id": "adipisicing nulla eiusmod esse",
"field": "dolor commodo cillum velit",
"message": "eiusmod Duis laborum sunt incididunt",
"parameter": "cupidatat occaecat incididunt consequat"
}
]
}{
"errors": [
{
"error_id": "dolore ut minim Excepteur",
"field": "cillum officia mollit non sit",
"message": "id ex",
"parameter": "amet laborum in"
},
{
"error_id": "incididunt",
"field": "enim adipisicing minim non",
"message": "Duis sunt veniam incididunt ullamco",
"parameter": "sit eiusmod voluptate esse"
}
]
}{
"errors": [
{
"error_id": "anim",
"field": null,
"message": "consequat Ut mollit aute",
"parameter": "et est minim"
}
]
}Settings - Partner(3 operations)
PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "ipsum culpa" |
{
"license_key": "",
"enabled": true,
"enable_subuser_statistics": true
}{
"enable_subuser_statistics": true,
"enabled": true,
"license_key": ""
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "incididunt amet eiusmod labore aliquip" |
{
"enable_subuser_statistics": false,
"enabled": true,
"license_key": ""
}GET
| Query Parameter Name | Example |
|---|---|
limit | -8701841 |
offset | -83074979 |
| Header Name | Example |
|---|---|
on-behalf-of | "nisi irure" |
{
"result": [
{
"title": "Partner title",
"enabled": true,
"name": "partner_name",
"description": "A description of a partner."
}
]
}Teammates(11 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "velit nulla non incididunt" |
{
"email": "teammate1@example.com",
"scopes": [
"user.profile.read",
"user.profile.update"
],
"is_admin": false
}{
"email": "teammate1@example.com",
"scopes": [
"user.profile.read",
"user.profile.update"
],
"is_admin": false
}{
"errors": [
{
"message": "est occaecat proident eiusmod ea",
"field": "enim"
},
{
"message": "in culpa aliquip",
"field": "commodo occaecat"
},
{
"message": "aliqua",
"field": "Lorem magna"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
limit | 270 |
offset | 96757394 |
| Header Name | Example |
|---|---|
on-behalf-of | "Excepteur enim sit" |
{
"results": [
{
"username": "teammate1",
"email": "teammate1@example.com",
"first_name": "Jane",
"last_name": "Doe",
"user_type": "owner",
"is_admin": true,
"phone": "123-345-3453",
"website": "www.example.com",
"company": "ACME Inc.",
"address": "123 Acme St",
"address2": "",
"city": "City",
"state": "CA",
"country": "USA",
"zip": "12345"
},
{
"username": "teammate2",
"email": "teammate2@example.com",
"first_name": "John",
"last_name": "Doe",
"user_type": "teammate",
"is_admin": false,
"phone": "123-345-3453",
"website": "www.example.com",
"company": "ACME Inc.",
"address": "123 Acme St",
"address2": "",
"city": "City",
"state": "CA",
"country": "USA",
"zip": "12345"
},
{
"username": "teammate3",
"email": "teammate3@example.com",
"first_name": "Steve",
"last_name": "Doe",
"user_type": "admin",
"is_admin": true,
"phone": "123-345-3453",
"website": "www.example.com",
"company": "ACME Inc.",
"address": "123 Acme St",
"address2": "",
"city": "City",
"state": "CA",
"country": "USA",
"zip": "12345"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "dolore pariatur" |
{
"pending_id": "abc123abc",
"email": "teammate1@example.com",
"scopes": [
"user.profile.read",
"user.profile.update"
],
"is_admin": false
}{
"errors": [
{
"message": "invalid pending key",
"field": "pending_key"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
limit | -80625083 |
offset | 59966002 |
[
{
"id": 1,
"scope_group_name": "Mail Settings",
"username": "teammate1",
"email": "teammate1@example.com",
"first_name": "Teammate",
"last_name": "One"
},
{
"id": 2,
"scope_group_name": "Stats",
"username": "teammate2",
"email": "teammate2@example.com",
"first_name": "Teammate",
"last_name": "Two"
}
]GET
| Header Name | Example |
|---|---|
on-behalf-of | "voluptate fugiat veniam" |
{
"result": [
{
"email": "user1@example.com",
"scopes": [
"user.profile.read",
"user.profile.edit"
],
"is_admin": false,
"pending_id": "abcd123abc",
"expiration_date": 1456424263
},
{
"email": "user2@example.com",
"scopes": [],
"is_admin": true,
"pending_id": "bcde234bcd",
"expiration_date": 1456424263
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "non sed Ut incididunt aute" |
{
"username": "teammate1",
"first_name": "Jane",
"last_name": "Doe",
"email": "teammate1@example.com",
"scopes": [
"user.profile.read",
"user.profile.update",
"..."
],
"user_type": "admin",
"is_admin": true,
"phone": "123-345-3453",
"website": "www.example.com",
"company": "ACME Inc.",
"address": "123 Acme St",
"address2": "",
"city": "City",
"state": "CA",
"country": "USA",
"zip": "12345"
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "nostrud non" |
{
"scopes": [
"user.profile.read",
"user.profile.edit"
],
"is_admin": false
}{
"username": "teammate1",
"first_name": "Jane",
"last_name": "Doe",
"email": "teammate1@example.com",
"scopes": [
"user.profile.read",
"user.profile.edit"
],
"user_type": "teammate",
"is_admin": false,
"phone": "123-345-3453",
"website": "www.example.com",
"company": "ACME Inc.",
"address": "123 Acme St",
"address2": "",
"city": "City",
"state": "CA",
"country": "USA",
"zip": "12345"
}{
"errors": [
{
"message": "one or more of given scopes are invalid",
"field": "scopes"
}
]
}{
"errors": [
{
"message": "username not found",
"field": "username"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "qui nisi Ut sed dolor" |
{
"errors": [
{
"message": "minim",
"field": "irure in aute laborum anim"
},
{
"message": "aliqua in Lorem magna commodo",
"field": "pariatur ipsum consectetur"
},
{
"message": "nisi",
"field": "aute nisi quis Excepteur ea"
},
{
"message": "minim",
"field": "consequat incididunt anim voluptate est"
},
{
"message": "consequat dolor non dolore aliqua",
"field": "eiusmod"
}
]
}{
"errors": [
{
"message": "username not found",
"field": "username"
}
]
}PATCH
{
"scope_group_name": "Stats"
}{}{
"errors": [
{
"message": "minim reprehenderit commodo est exercitation",
"field": "proident commodo Duis et deserunt"
}
]
}DELETE
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"message": "Cannot find request",
"field": "request_id"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "ipsum dolore Duis id" |
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"message": "Lorem sunt laboris commodo",
"field": "voluptate irure"
}
]
}Alerts(5 operations)
POST
| Header Name | Example |
|---|---|
Authorization | "elit occaecat culpa" |
on-behalf-of | "ullamco elit nulla enim dolor" |
{
"type": "stats_notification",
"email_to": "example@example.com",
"frequency": "daily"
}{
"created_at": 1451520930,
"email_to": "test@example.com",
"frequency": "daily",
"id": 48,
"type": "stats_notification",
"updated_at": 1451520930
}{
"field": "aliquip",
"message": "sunt occaecat dolore pariatur"
}GET
| Header Name | Example |
|---|---|
Authorization | "incididunt sit mollit" |
on-behalf-of | "Excepteur do deserunt amet sed" |
[
{
"created_at": 1451498784,
"email_to": "example1@example.com",
"id": 46,
"percentage": 90,
"type": "usage_limit",
"updated_at": 1451498784
},
{
"created_at": 1451498812,
"email_to": "example2@example.com",
"frequency": "monthly",
"id": 47,
"type": "stats_notification",
"updated_at": 1451498812
},
{
"created_at": 1451520930,
"email_to": "example3@example.com",
"frequency": "daily",
"id": 48,
"type": "stats_notification",
"updated_at": 1451520930
}
]GET
| Header Name | Example |
|---|---|
Authorization | "dolore elit sint" |
on-behalf-of | "voluptate ea" |
{
"created_at": 1451520930,
"email_to": "example@example.com",
"frequency": "daily",
"id": 48,
"type": "stats_notification",
"updated_at": 1451520930
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "fugiat" |
{}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "pariatur velit Ut" |
{
"email_to": "example@example.com"
}{
"created_at": 1451520930,
"email_to": "example@example.com",
"frequency": "daily",
"id": 48,
"type": "stats_notification",
"updated_at": 1451522691
}Users API(9 operations)
GET
| Header Name | Example |
|---|---|
on-behalf-of | "quis officia consectetur reprehenderit" |
{
"address": "814 West Chapman Avenue",
"address2": "",
"city": "Orange",
"company": "SendGrid",
"country": "US",
"first_name": "Test",
"last_name": "User",
"phone": "555-555-5555",
"state": "CA",
"website": "http://www.sendgrid.com",
"zip": "92868"
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "mollit sint enim reprehenderit esse" |
{
"first_name": "Example",
"last_name": "User",
"city": "Orange"
}{
"address": "814 West Chapman Avenue",
"address2": "",
"city": "Orange",
"company": "SendGrid",
"country": "US",
"first_name": "Example",
"last_name": "User",
"phone": "555-555-5555",
"state": "CA",
"website": "http://www.sendgrid.com",
"zip": "92868"
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "ipsum sit velit proident culpa" |
{
"reputation": 100,
"type": "paid"
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "amet" |
{
"email": "test@example.com"
}PUT
| Header Name | Example |
|---|---|
on-behalf-of | "non" |
{
"email": "example@example.com"
}{
"email": "example@example.com"
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "deserunt" |
{
"username": "test_username",
"user_id": 1
}PUT
| Header Name | Example |
|---|---|
on-behalf-of | "Ut commodo do anim" |
{
"username": "test_username"
}{
"username": "test_username"
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "in dolore adipisicing" |
{
"remain": 200,
"total": 200,
"overage": 0,
"used": 0,
"last_reset": "2013-01-01",
"next_reset": "2013-02-01",
"reset_frequency": "monthly"
}PUT
| Header Name | Example |
|---|---|
on-behalf-of | "ad Lorem tempor" |
{
"new_password": "new_password",
"old_password": "old_password"
}{}Subusers API(6 operations)
GET
| Query Parameter Name | Example |
|---|---|
username | ullamco Excepteur est |
limit | 98402842 |
offset | 24460092 |
[
{
"disabled": false,
"email": "example@example.com",
"id": 1234,
"username": "example_subuser"
},
{
"disabled": false,
"email": "example2@example.com",
"id": 1234,
"username": "example_subuser2"
}
]{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}POST
{
"username": "John@example.com",
"email": "John@example.com",
"password": "johns_password",
"ips": [
"1.1.1.1",
"2.2.2.2"
]
}{
"username": "example_subuser",
"user_id": 1234,
"email": "example@example.com",
"signup_session_token": "",
"authorization_token": "",
"credit_allocation": {
"type": "unlimited"
}
}{
"errors": [
{
"message": "username exists"
},
{
"message": "unable to validate IPs at this time"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"message": "you dont have permission to access this resource"
}
]
}{
"errors": [
{
"message": "unable to validate IPs at this time"
}
]
}PATCH
{
"disabled": false
}{}{
"errors": [
{
"message": "invalid username"
},
{
"message": "no fields provided"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"message": "unable to enable user"
}
]
}DELETE
{}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
usernames | velit laboris et |
[
{
"username": "example_subuser",
"reputation": 99
},
{
"username": "example_subuser2",
"reputation": 95.2
}
]PUT
[
"127.0.0.1"
]{
"ips": [
"127.0.0.1"
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}Subuser Monitor Settings(4 operations)
GET
{
"email": "example@example.com",
"frequency": 500
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"field": null,
"message": "No monitor settings for this user"
}
]
}POST
{
"email": "example@example.com",
"frequency": 50000
}{
"email": "example@example.com",
"frequency": 50000
}{
"errors": [
{
"field": null,
"message": "User already has a monitor"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}PUT
{
"email": "example@example.com",
"frequency": 50000
}{
"email": "example@example.com",
"frequency": 500
}{
"errors": [
{
"field": "email",
"message": "Email is required"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}DELETE
{}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"field": null,
"message": "No monitor settings for this user"
}
]
}Subuser Statistics(4 operations)
GET
| Query Parameter Name | Example |
|---|---|
date* | consectetur Lorem in exercitation aliqua |
sort_by_metric | labore consectetur aliqua |
sort_by_direction | desc |
limit | -13826160 |
offset | -29215351 |
{
"date": "2016-02-01",
"stats": [
{
"first_name": "John",
"last_name": "Doe",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 5,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 10,
"processed": 10,
"requests": 10,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
},
"name": "user1",
"type": "subuser"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
date* | voluptate ut dolore |
subuser | cillum in |
sort_by_metric | clicks |
sort_by_direction | desc |
limit | -89485738 |
offset | 12644981 |
{
"date": "2016-02-01",
"stats": [
{
"first_name": "John",
"last_name": "Doe",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 1,
"processed": 0,
"requests": 100,
"spam_report_drops": 0,
"spam_reports": 99,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
},
"name": "user1",
"type": "subuser"
},
{
"first_name": "Jane",
"last_name": "Doe",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 5,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 10,
"processed": 10,
"requests": 10,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
},
"name": "user2",
"type": "subuser"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
sort_by_direction | asc |
start_date* | consectetur eu elit |
end_date | ad laborum ullamco |
limit | 73683000 |
offset | -11047263 |
aggregated_by | sit pariatur |
sort_by_metric | dolor ut deserunt |
{
"date": "2015-10-11",
"stats": []
}GET
| Query Parameter Name | Example |
|---|---|
limit | -74720937 |
offset | 20981496 |
aggregated_by | day |
subusers* | Duis occaecat proident nostrud |
start_date* | adipisicing est Excepteur in |
end_date | ipsum aliquip dolor magna voluptate |
[
{
"date": "2015-10-01",
"stats": [
{
"type": "subuser",
"name": "Matt_subuser",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
},
{
"date": "2015-10-02",
"stats": [
{
"type": "subuser",
"name": "Matt_subuser",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
},
{
"date": "2015-10-03",
"stats": [
{
"type": "subuser",
"name": "Matt_subuser",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
},
{
"date": "2015-10-04",
"stats": [
{
"type": "subuser",
"name": "Matt_subuser",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
},
{
"date": "2015-10-05",
"stats": [
{
"type": "subuser",
"name": "Matt_subuser",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
},
{
"date": "2015-10-06",
"stats": [
{
"type": "subuser",
"name": "Matt_subuser",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
},
{
"date": "2015-10-07",
"stats": [
{
"type": "subuser",
"name": "Matt_subuser",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
},
{
"date": "2015-10-08",
"stats": [
{
"type": "subuser",
"name": "Matt_subuser",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
},
{
"date": "2015-10-09",
"stats": [
{
"type": "subuser",
"name": "Matt_subuser",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
},
{
"date": "2015-10-10",
"stats": [
{
"type": "subuser",
"name": "Matt_subuser",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
}
]Link branding(10 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "nisi qui cupidatat" |
{
"domain": "example.com",
"subdomain": "mail",
"default": true
}{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "john@example.com",
"user_id": 7,
"default": false,
"valid": true,
"legacy": false,
"dns": {
"domain_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "sendgrid.net"
},
"owner_cname": {
"valid": true,
"type": "cname",
"host": "7.example.com",
"data": "sendgrid.net"
}
}
}GET
| Query Parameter Name | Example |
|---|---|
limit | 28753741 |
| Header Name | Example |
|---|---|
on-behalf-of | "tempor Excepteur reprehenderit" |
[
{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "john@example.com",
"user_id": 7,
"default": true,
"valid": true,
"legacy": false,
"dns": {
"domain_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "sendgrid.net"
},
"owner_cname": {
"valid": true,
"type": "cname",
"host": "7.example.com",
"data": "sendgrid.net"
}
}
},
{
"id": 2,
"domain": "example2.com",
"subdomain": "news",
"username": "john@example.com",
"user_id": 8,
"default": false,
"valid": false,
"legacy": false,
"dns": {
"domain_cname": {
"valid": true,
"type": "cname",
"host": "news.example2.com",
"data": "sendgrid.net"
},
"owner_cname": {
"valid": false,
"type": "cname",
"host": "8.example2.com",
"data": "sendgrid.net"
}
}
}
]POST
| Header Name | Example |
|---|---|
on-behalf-of | "aliqua in mollit" |
{
"id": 1,
"valid": true,
"validation_results": {
"domain_cname": {
"valid": false,
"reason": "Expected CNAME to match \"sendgrid.net.\" but found \"example.com.\"."
},
"owner_cname": {
"valid": true,
"reason": null
}
}
}{
"errors": [
{
"message": "internal error getting CNAME"
}
]
}POST
{
"username": "jane@example.com"
}{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "john@example.com",
"user_id": 7,
"default": false,
"valid": true,
"legacy": false,
"dns": {
"domain_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "sendgrid.net"
},
"owner_cname": {
"valid": true,
"type": "cname",
"host": "7.example.com",
"data": "sendgrid.net"
}
}
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "culpa amet" |
{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "john@example.com",
"user_id": 7,
"default": false,
"valid": true,
"legacy": false,
"dns": {
"domain_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "sendgrid.net"
},
"owner_cname": {
"valid": true,
"type": "cname",
"host": "7.example.com",
"data": "sendgrid.net"
}
}
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "ea non proident" |
{
"default": true
}{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "john@example.com",
"user_id": 7,
"default": true,
"valid": true,
"legacy": false,
"dns": {
"domain_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "sendgrid.net"
},
"owner_cname": {
"valid": true,
"type": "cname",
"host": "7.example.com",
"data": "sendgrid.net"
}
}
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "dolor minim voluptate" |
{}GET
| Query Parameter Name | Example |
|---|---|
domain | velit laborum veniam tempor Ut |
| Header Name | Example |
|---|---|
on-behalf-of | "sunt proident" |
{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "john@example.com",
"user_id": 7,
"default": false,
"valid": true,
"legacy": false,
"dns": {
"domain_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "sendgrid.net"
},
"owner_cname": {
"valid": true,
"type": "cname",
"host": "7.example.com",
"data": "sendgrid.net"
}
}
}GET
| Query Parameter Name | Example |
|---|---|
username* | aliquip dolore |
{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "john@example.com",
"user_id": 7,
"default": false,
"valid": true,
"legacy": false,
"dns": {
"domain_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "sendgrid.net"
},
"owner_cname": {
"valid": true,
"type": "cname",
"host": "7.example.com",
"data": "sendgrid.net"
}
}
}DELETE
| Query Parameter Name | Example |
|---|---|
username* | reprehenderit et exercitation enim commodo |
{}IP Warmup(4 operations)
POST
{
"ip": "0.0.0.0"
}[
{
"ip": "0.0.0.0",
"start_date": 1409616000
}
]{
"errors": [
{
"field": null,
"message": "resource not found"
}
]
}GET
[
{
"ip": "0.0.0.0",
"start_date": 1409616000
}
]GET
[
{
"ip": "0.0.0.0",
"start_date": 1409616000
}
]{
"errors": [
{
"field": null,
"message": "resource not found"
}
]
}DELETE
{}{
"errors": [
{
"field": null,
"message": "resource not found"
}
]
}Reverse DNS(5 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "et dolore voluptate" |
{
"ip": "192.168.1.1",
"subdomain": "email",
"domain": "example.com"
}{
"id": 123,
"ip": "192.168.1.2",
"rdns": "o1.email.example.com",
"users": [],
"subdomain": "email",
"domain": "example.com",
"valid": true,
"legacy": false,
"a_record": {
"valid": true,
"type": "a",
"host": "o1.email.example.com",
"data": "192.168.1.2"
}
}GET
| Query Parameter Name | Example |
|---|---|
limit | 1752211 |
offset | -32503560 |
ip | voluptate nulla |
| Header Name | Example |
|---|---|
on-behalf-of | "exercitation culpa" |
[
{
"id": 1,
"ip": "192.168.1.1",
"rdns": "o1.email.example.com",
"users": [
{
"username": "john@example.com",
"user_id": 7
},
{
"username": "jane@example.com",
"user_id": 8
}
],
"subdomain": "email",
"domain": "example.com",
"valid": true,
"legacy": false,
"a_record": {
"valid": true,
"type": "a",
"host": "o1.email.example.com",
"data": "192.168.1.1"
}
},
{
"id": 2,
"ip": "192.168.1.2",
"rdns": "o2.email.example.com",
"users": [
{
"username": "john@example.com",
"user_id": 7
},
{
"username": "jane@example2.com",
"user_id": 9
}
],
"subdomain": "email",
"domain": "example.com",
"valid": true,
"legacy": false,
"a_record": {
"valid": true,
"type": "a",
"host": "o2.email.example.com",
"data": "192.168.1.2"
}
}
]POST
| Header Name | Example |
|---|---|
on-behalf-of | "tempor culpa" |
{
"id": 123456,
"valid": false,
"validation_results": {
"a_record": {
"valid": false,
"reason": "Failed to resolve A Record at o1.ptr4283.example.com: lookup o1.ptr4283.example.com on 192.168.0.10:53: no such host"
}
}
}{
"errors": [
{
"message": "Reverse DNS record not found."
}
]
}{
"errors": [
{
"message": "internal error getting rDNS"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "in eu ea" |
{
"id": 123,
"ip": "192.168.1.1",
"rdns": "o1.email.example.com",
"users": [
{
"username": "john@example.com",
"user_id": 7
}
],
"subdomain": "email",
"domain": "example.com",
"valid": true,
"legacy": false,
"a_record": {
"valid": true,
"type": "a",
"host": "o1.email.example.com",
"data": "192.168.1.1"
}
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "labore est in ipsum commodo" |
{}Email Address Validation
POST
{
"email": "example@example.com",
"source": "signup"
}{
"result": {
"email": "cedric@fogowl.com",
"verdict": "Valid",
"score": 0.85021,
"local": "cedric",
"host": "fogowl.com",
"checks": {
"domain": {
"has_valid_address_syntax": true,
"has_mx_or_a_record": true,
"is_suspected_disposable_address": false
},
"local_part": {
"is_suspected_role_address": false
},
"additional": {
"has_known_bounces": false,
"has_suspected_bounces": false
}
},
"ip_address": "192.168.1.1"
}
}Email CNAME records
POST
{
"link_id": 29719392,
"domain_id": 46873408,
"email": "my_colleague@example.com",
"message": "DNS Record for verification"
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": {
"error": "Lorem",
"field": "est"
}
}IP Pools(7 operations)
POST
{
"name": "marketing"
}{
"name": "marketing"
}GET
[
{
"name": "marketing"
},
{
"name": "transactional"
}
]POST
{
"ip": "0.0.0.0"
}{
"ip": "000.00.00.0",
"pools": [
"test1"
],
"start_date": 1409616000,
"warmup": true
}{
"errors": [
{
"field": null,
"message": "resource not found"
}
]
}GET
{
"pool_name": "Sample",
"ips": [
"192.168.1.1",
"192.158.1.2",
"192.138.2.1"
]
}{
"errors": [
{
"field": "error",
"message": "Unable to locate specified IPs Pool"
}
]
}PUT
{
"name": "new_pool_name"
}{
"name": "new_pool_name"
}{
"errors": [
{
"field": null,
"message": "ip pool not found"
}
]
}DELETE
{}{
"error": "Unable to locate specified IPs Pool"
}DELETE
{}{
"error": "Unable to locate specified IPs Pool"
}IP Addresses(5 operations)
POST
{
"count": 90323478,
"subusers": [
"subuser1",
"subuser2"
],
"warmup": true,
"user_can_send": true
}{
"ips": [
{
"ip": "1.2.3.4",
"subusers": [
"user",
"subuser1"
]
},
{
"ip": "1.2.3.5",
"subusers": [
"user",
"subuser1"
]
}
],
"remaining_ips": 1,
"warmup": true
}{
"errors": [
{
"field": null,
"message": "one or more subusers do not belong to this user"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
ip | do tempor exercitation elit adipisicing |
exclude_whitelabels | true |
limit | -13855730 |
offset | 75741868 |
subuser | officia nisi esse ipsum |
sort_by_direction | desc |
[
{
"ip": "192.168.1.1",
"pools": [
"pool1",
"pool2"
],
"whitelabeled": false,
"start_date": 1409616000,
"subusers": [
"tim@sendgrid.net"
],
"warmup": false,
"assigned_at": 1482883200
},
{
"ip": "208.115.214.22",
"pools": [],
"whitelabeled": true,
"rdns": "o1.email.burgermail.com",
"start_date": 1409616000,
"subusers": [],
"warmup": false,
"assigned_at": 1482883200
}
]GET
{
"results": [
{
"remaining": 2,
"period": "month",
"price_per_ip": 20
}
]
}GET
[
{
"ip": "167.89.21.3",
"pools": [
"new_test5"
],
"warmup": true,
"start_date": 1409616000
}
]GET
{
"ip": "000.00.00.0",
"subusers": [
"subuser1",
"subuser2"
],
"rdns": "o1.em.example.com",
"pools": [
"test1"
],
"warmup": false,
"start_date": null,
"whitelabeled": true
}Domain Authentication(12 operations)
GET
| Query Parameter Name | Example |
|---|---|
limit | 3213883 |
offset | -90836938 |
exclude_subusers | true |
username | mollit minim adipisicing officia |
domain | et |
| Header Name | Example |
|---|---|
on-behalf-of | "in enim" |
[
{
"id": 1,
"user_id": 7,
"subdomain": "mail",
"domain": "example.com",
"username": "jane@example.com",
"ips": [
"192.168.1.1",
"192.168.1.2"
],
"custom_spf": true,
"default": true,
"legacy": false,
"automatic_security": true,
"valid": true,
"dns": {
"mail_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "u7.wl.sendgrid.net"
},
"dkim1": {
"valid": true,
"type": "cname",
"host": "s1._domainkey.example.com",
"data": "s1._domainkey.u7.wl.sendgrid.net"
},
"dkim2": {
"valid": true,
"type": "cname",
"host": "s2._domainkey.example.com",
"data": "s2._domainkey.u7.wl.sendgrid.net"
}
}
},
{
"id": 2,
"user_id": 8,
"subdomain": "new",
"domain": "example2.com",
"username": "john@example2.com",
"ips": [],
"custom_spf": false,
"default": true,
"legacy": false,
"automatic_security": true,
"valid": false,
"dns": {
"mail_cname": {
"valid": false,
"type": "mx",
"host": "news.example2.com",
"data": "sendgrid.net"
},
"dkim1": {
"valid": false,
"type": "txt",
"host": "example2.com",
"data": "k=rsa; t=s; p=publicKey"
},
"dkim2": {
"valid": false,
"type": "txt",
"host": "example2.com",
"data": "k=rsa; t=s p=publicKey"
}
}
}
]POST
| Header Name | Example |
|---|---|
on-behalf-of | "fugiat ut ex minim quis" |
{
"domain": "example.com",
"subdomain": "news",
"username": "john@example.com",
"ips": [
"192.168.1.1",
"192.168.1.2"
],
"custom_spf": true,
"default": true,
"automatic_security": false
}{
"id": 302183,
"user_id": 1446226,
"subdomain": "example",
"domain": "example.com",
"username": "mbernier",
"ips": [],
"custom_spf": false,
"default": true,
"legacy": false,
"automatic_security": true,
"valid": false,
"dns": {
"mail_cname": {
"valid": false,
"type": "cname",
"host": "example.example.com",
"data": "u1446226.wl.sendgrid.net"
},
"dkim1": {
"valid": false,
"type": "cname",
"host": "s1._domainkey.example.com",
"data": "s1.domainkey.u1446226.wl.sendgrid.net"
},
"dkim2": {
"valid": false,
"type": "cname",
"host": "s2._domainkey.example.com",
"data": "s2.domainkey.u1446226.wl.sendgrid.net"
}
}
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "id magna" |
{
"id": 45373692,
"user_id": 66036447,
"subdomain": "sub",
"domain": "example.com",
"username": "jdoe",
"ips": [
"127.0.0.1"
],
"custom_spf": false,
"default": true,
"legacy": false,
"automatic_security": true,
"valid": true,
"dns": {
"mail_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "u7.wl.sendgrid.net"
},
"dkim1": {
"valid": true,
"type": "cname",
"host": "s1._domainkey.example.com",
"data": "s1._domainkey.u7.wl.sendgrid.net"
},
"dkim2": {
"valid": true,
"type": "cname",
"host": "s2._domainkey.example.com",
"data": "s2._domainkey.u7.wl.sendgrid.net"
}
}
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "tempor cillum incididunt laborum" |
{
"default": false,
"custom_spf": true
}[
{
"id": 1,
"user_id": 7,
"subdomain": "mail",
"domain": "example.com",
"username": "jane@example.com",
"ips": [
"192.168.1.1",
"192.168.1.2"
],
"custom_spf": true,
"default": true,
"legacy": false,
"automatic_security": true,
"valid": true,
"dns": {
"mail_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "u7.wl.sendgrid.net"
},
"dkim1": {
"valid": true,
"type": "cname",
"host": "s1._domainkey.example.com",
"data": "s1._domainkey.u7.wl.sendgrid.net"
},
"dkim2": {
"valid": true,
"type": "cname",
"host": "s2._domainkey.example.com",
"data": "s2._domainkey.u7.wl.sendgrid.net"
}
}
},
{
"id": 2,
"user_id": 8,
"subdomain": "new",
"domain": "example2.com",
"username": "john@example2.com",
"ips": [],
"custom_spf": false,
"default": true,
"legacy": false,
"automatic_security": true,
"valid": false,
"dns": {
"mail_cname": {
"valid": false,
"type": "mx",
"host": "news.example2.com",
"data": "sendgrid.net"
},
"dkim1": {
"valid": false,
"type": "txt",
"host": "example2.com",
"data": "k=rsa; t=s; p=publicKey"
},
"dkim2": {
"valid": false,
"type": "txt",
"host": "example2.com",
"data": "k=rsa; t=s p=publicKey"
}
}
}
]DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "sit dolor est nostrud exercitation" |
{}GET
| Query Parameter Name | Example |
|---|---|
domain | ut sed Lorem tempor |
| Header Name | Example |
|---|---|
on-behalf-of | "irure" |
[
{
"id": 1,
"user_id": 7,
"subdomain": "mail",
"domain": "example.com",
"username": "jane@example.com",
"ips": [
"192.168.1.1",
"192.168.1.2"
],
"custom_spf": true,
"default": true,
"legacy": false,
"automatic_security": true,
"valid": true,
"dns": {
"mail_cname": {
"valid": true,
"type": "cname",
"host": "mail.example.com",
"data": "u7.wl.sendgrid.net"
},
"dkim1": {
"valid": true,
"type": "cname",
"host": "s1._domainkey.example.com",
"data": "s1._domainkey.u7.wl.sendgrid.net"
},
"dkim2": {
"valid": true,
"type": "cname",
"host": "s2._domainkey.example.com",
"data": "s2._domainkey.u7.wl.sendgrid.net"
}
}
}
]POST
| Header Name | Example |
|---|---|
on-behalf-of | "veniam" |
{
"ip": "192.168.0.1"
}{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "john@example.com",
"user_id": 7,
"ips": [],
"custom_spf": true,
"default": false,
"legacy": false,
"automatic_security": false,
"valid": false,
"dns": {
"mail_server": {
"host": "mail.example.com",
"type": "mx",
"data": "sendgrid.net",
"valid": false
},
"subdomain_spf": {
"host": "mail.example.com",
"type": "txt",
"data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
"valid": false
},
"domain_spf": {
"host": "example.com",
"type": "txt",
"data": "v=spf1 include:mail.example.com -all",
"valid": false
},
"dkim": {
"host": "s1._domainkey.example.com",
"type": "txt",
"data": "k=rsa; t=s; p=publicKey",
"valid": false
}
}
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "Ut mollit" |
{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "mail@example.com",
"user_id": 7,
"ips": [],
"custom_spf": true,
"default": false,
"legacy": false,
"automatic_security": false,
"valid": false,
"dns": {
"mail_server": {
"host": "mail.example.com",
"type": "mx",
"data": "sendgrid.net",
"valid": false
},
"subdomain_spf": {
"host": "mail.example.com",
"type": "txt",
"data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
"valid": false
},
"domain_spf": {
"host": "example.com",
"type": "txt",
"data": "v=spf1 include:mail.example.com -all",
"valid": false
},
"dkim": {
"host": "s1._domainkey.example.com",
"type": "txt",
"data": "k=rsa; t=s; p=publicKey",
"valid": false
}
}
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "minim in in" |
{
"id": 1,
"valid": true,
"validation_resuts": {
"mail_cname": {
"valid": false,
"reason": "Expected your MX record to be \"mx.sendgrid.net\" but found \"example.com\"."
},
"dkim1": {
"valid": true,
"reason": null
},
"dkim2": {
"valid": true,
"reason": null
},
"spf": {
"valid": true,
"reason": null
}
}
}{
"errors": [
{
"message": "internal error getting TXT"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
username* | Duis et |
{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "mail@example.com",
"user_id": 7,
"ips": [],
"custom_spf": true,
"default": false,
"legacy": false,
"automatic_security": false,
"valid": false,
"dns": {
"mail_server": {
"host": "mail.example.com",
"type": "mx",
"data": "sendgrid.net",
"valid": false
},
"subdomain_spf": {
"host": "mail.example.com",
"type": "txt",
"data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
"valid": false
},
"domain_spf": {
"host": "example.com",
"type": "txt",
"data": "v=spf1 include:mail.example.com -all",
"valid": false
},
"dkim": {
"host": "s1._domainkey.example.com",
"type": "txt",
"data": "k=rsa; t=s; p=publicKey",
"valid": false
}
}
}DELETE
| Query Parameter Name | Example |
|---|---|
username | voluptate et occaecat minim |
{}POST
{
"username": "jdoe"
}{
"id": 1,
"domain": "example.com",
"subdomain": "mail",
"username": "mail@example.com",
"user_id": 7,
"ips": [],
"custom_spf": true,
"default": false,
"legacy": false,
"automatic_security": false,
"valid": false,
"dns": {
"mail_server": {
"host": "mail.example.com",
"type": "mx",
"data": "sendgrid.net",
"valid": false
},
"subdomain_spf": {
"host": "mail.example.com",
"type": "txt",
"data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
"valid": false
},
"domain_spf": {
"host": "example.com",
"type": "txt",
"data": "v=spf1 include:mail.example.com -all",
"valid": false
},
"dkim": {
"host": "s1._domainkey.example.com",
"type": "txt",
"data": "k=rsa; t=s; p=publicKey",
"valid": false
}
}
}Sender Verification(8 operations)
GET
{
"results": {
"soft_failures": [
"gmail.com"
],
"hard_failures": [
"yahoo.com"
]
}
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "exercitation voluptate ullamco minim aliquip"
}
]
}GET
{
"results": {
"domain_verified": true,
"sender_verified": true
}
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "eiusmod sed deserunt elit sint"
},
{
"message": "commodo sint dolore"
},
{
"message": "Duis sint ad sunt qui"
},
{
"message": "sint Excepteur"
}
]
}POST
{
"nickname": "Orders",
"from_email": "orders@example.com",
"from_name": "Example Orders",
"reply_to": "orders@example.com",
"reply_to_name": "Example Orders",
"address": "1234 Fake St",
"address2": "PO Box 1234",
"state": "CA",
"city": "San Francisco",
"country": "USA",
"zip": "94105"
}{
"id": 1234,
"nickname": "Example Orders",
"from_email": "orders@example.com",
"from_name": "Example Orders",
"reply_to": "orders@example.com",
"reply_to_name": "Example Orders",
"address": "1234 Fake St.",
"address2": "PO Box 1234",
"state": "CA",
"city": "San Francisco",
"country": "USA",
"zip": "94105",
"verified": true,
"locked": false
}{
"errors": [
{
"field": "anim amet",
"message": "amet",
"error_id": "deserunt veniam anim"
},
{
"field": "id Duis dolor quis",
"message": "proident et reprehenderit labore Ut",
"error_id": "sint minim"
},
{
"field": "aute et",
"message": "pariatur",
"error_id": "in ex ut"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "ut dolore incididunt"
},
{
"message": "laborum"
},
{
"message": "velit eu anim mollit non"
},
{
"message": "Lorem Excepteur"
},
{
"message": "voluptate dolore"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
limit | 84511482.7345573 |
lastSeenID | 24077465.509506404 |
id | -50101488 |
{
"results": [
{
"id": 1234,
"nickname": "Example Orders",
"from_email": "orders@example.com",
"from_name": "Example Orders",
"reply_to": "orders@example.com",
"reply_to_name": "Example Orders",
"address": "1234 Fake St.",
"address2": "PO Box 1234",
"state": "CA",
"city": "San Francisco",
"country": "USA",
"zip": "94105",
"verified": true,
"locked": false
},
{
"id": 1235,
"nickname": "Example Support",
"from_email": "support@example.com",
"from_name": "Example Support",
"reply_to": "support@example.com",
"reply_to_name": "Example Support",
"address": "1234 Fake St.",
"address2": "PO Box 1234",
"state": "CA",
"city": "San Francisco",
"country": "USA",
"zip": "94105",
"verified": true,
"locked": false
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "Duis occaecat dolore"
},
{
"message": "ea velit consequat"
},
{
"message": "in dolore"
}
]
}GET
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "nulla qui",
"error_id": "enim mollit velit"
},
{
"message": "aliqua do",
"error_id": "amet"
},
{
"message": "officia deserunt non",
"error_id": "tempor"
}
]
}{
"errors": [
{
"message": "dolor"
}
]
}PATCH
{
"nickname": "Orders",
"from_email": "orders@example.com",
"from_name": "Example Orders",
"reply_to": "orders@example.com",
"reply_to_name": "Example Orders",
"address": "1234 Fake St",
"address2": "PO Box 1234",
"state": "CA",
"city": "San Francisco",
"country": "USA",
"zip": "94105"
}{
"id": 1234,
"nickname": "Example Orders",
"from_email": "orders@example.com",
"from_name": "Example Orders",
"reply_to": "orders@example.com",
"reply_to_name": "Example Orders",
"address": "1234 Fake St.",
"address2": "PO Box 1234",
"state": "CA",
"city": "San Francisco",
"country": "USA",
"zip": "94105",
"verified": true,
"locked": false
}{
"errors": [
{
"field": "ullamco ut eiusmod",
"message": "sed Excepteur mollit anim",
"error_id": "voluptate proident aute"
},
{
"field": "id in adipisicing",
"message": "sint culpa",
"error_id": "non"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "in proident",
"error_id": "Excepteur"
},
{
"message": "reprehenderit ipsum",
"error_id": "amet Excepteur et"
},
{
"message": "id ad veniam",
"error_id": "reprehenderit mollit irure"
},
{
"message": "pariatur reprehenderit in consectetur minim",
"error_id": "nostrud tempor"
},
{
"message": "voluptate",
"error_id": "dolore ad ut"
}
]
}{
"errors": [
{
"message": "irure adipisicing ut ea aliquip",
"error_id": "quis esse Lorem ipsum laborum"
},
{
"message": "ut ad aute dolor sit",
"error_id": "qui dolore cupidatat dolor mollit"
}
]
}{
"errors": [
{
"message": "non"
},
{
"message": "occaecat"
},
{
"message": "aute dolor nisi dolor"
},
{
"message": "qui dolore et"
},
{
"message": "culpa"
}
]
}DELETE
{}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "velit",
"error_id": "ea laboris dolore velit elit"
},
{
"message": "dolore",
"error_id": "ea commodo incididunt ut in"
}
]
}{
"errors": [
{
"message": "sit anim consequat",
"error_id": "commodo"
},
{
"message": "adipisicing eu sit in",
"error_id": "cupidatat incididunt deserunt officia ea"
}
]
}{
"errors": [
{
"message": "id sint esse incididunt sunt"
},
{
"message": "sunt"
},
{
"message": "adipisicing veniam pariatur"
},
{
"message": "laborum in"
},
{
"message": "cillum labore amet irure officia"
}
]
}POST
{}{
"errors": [
{
"message": "reprehenderit irure dolor",
"error_id": "sunt nulla"
},
{
"message": "nulla non sint",
"error_id": "adipisicing esse exercitation proident Lorem"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "ex do ut enim dolor",
"error_id": "qui sit"
},
{
"message": "Ut laborum aliqua elit",
"error_id": "deserunt est aute sunt"
},
{
"message": "nisi dolore",
"error_id": "dolore"
},
{
"message": "ad",
"error_id": "qui aute cupidatat"
}
]
}{
"errors": [
{
"message": "ut culpa ea laborum"
},
{
"message": "id"
}
]
}Designs API(9 operations)
POST
{
"name": "Ahoy, Cake or Pie Cafe!",
"editor": "design"
}{
"id": "15b85720-ce48-48ef-8a07-672b0d3455da",
"name": "Ahoy, Cake or Pie Cafe!",
"html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n <head>\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n <!--[if !mso]><!-->\n <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n <!--<![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n <xml>\n <o:OfficeDocumentSettings>\n <o:AllowPNG/>\n <o:PixelsPerInch>96</o:PixelsPerInch>\n </o:OfficeDocumentSettings>\n </xml>\n <![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n <style type=\"text/css\">\n body {width: 600px;margin: 0 auto;}\n table {border-collapse: collapse;}\n table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n img {-ms-interpolation-mode: bicubic;}\n </style>\n<![endif]-->\n <style type=\"text/css\">\n body, p, div {\n font-family: arial,helvetica,sans-serif;\n font-size: 14px;\n }\n body {\n color: #000000;\n }\n body a {\n color: #1188E6;\n text-decoration: none;\n }\n p { margin: 0; padding: 0; }\n table.wrapper {\n width:100% !important;\n table-layout: fixed;\n -webkit-font-smoothing: antialiased;\n -webkit-text-size-adjust: 100%;\n -moz-text-size-adjust: 100%;\n -ms-text-size-adjust: 100%;\n }\n img.max-width {\n max-width: 100% !important;\n }\n .column.of-2 {\n width: 50%;\n }\n .column.of-3 {\n width: 33.333%;\n }\n .column.of-4 {\n width: 25%;\n }\n ul ul ul ul {\n list-style-type: disc !important;\n }\n ol ol {\n list-style-type: lower-roman !important;\n }\n ol ol ol {\n list-style-type: lower-latin !important;\n }\n ol ol ol ol {\n list-style-type: decimal !important;\n }\n @media screen and (max-width:480px) {\n .preheader .rightColumnContent,\n .footer .rightColumnContent {\n text-align: left !important;\n }\n .preheader .rightColumnContent div,\n .preheader .rightColumnContent span,\n .footer .rightColumnContent div,\n .footer .rightColumnContent span {\n text-align: left !important;\n }\n .preheader .rightColumnContent,\n .preheader .leftColumnContent {\n font-size: 80% !important;\n padding: 5px 0;\n }\n table.wrapper-mobile {\n width: 100% !important;\n table-layout: fixed;\n }\n img.max-width {\n height: auto !important;\n max-width: 100% !important;\n }\n a.bulletproof-button {\n display: block !important;\n width: auto !important;\n font-size: 80%;\n padding-left: 0 !important;\n padding-right: 0 !important;\n }\n .columns {\n width: 100% !important;\n }\n .column {\n display: block !important;\n width: 100% !important;\n padding-left: 0 !important;\n padding-right: 0 !important;\n margin-left: 0 !important;\n margin-right: 0 !important;\n }\n .social-icon-column {\n display: inline-block !important;\n }\n }\n </style>\n <!--user entered Head Start--><!--End Head user entered-->\n </head>\n <body>\n <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n <div class=\"webkit\">\n <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n <tr>\n <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tr>\n <td width=\"100%\">\n <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tr>\n <td>\n <!--[if mso]>\n <center>\n <table><tr><td width=\"600\">\n <![endif]-->\n <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n <tr>\n <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n <tr>\n <td role=\"module-content\">\n <p></p>\n </td>\n </tr>\n </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n <tbody>\n <tr>\n <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n </tr>\n </tbody>\n </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n </tr>\n </table>\n <!--[if mso]>\n </td>\n </tr>\n </table>\n </center>\n <![endif]-->\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </div>\n </center>\n </body>\n </html>",
"plain_content": "Ahoy, World!\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
"generate_plain_content": false,
"thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/79bb769ae6464960a307040120ad6f9921896fe9825e845ad1f24d12285ea068.png",
"subject": "Getting Started",
"created_at": "2021-04-30T19:00:16Z",
"updated_at": "2021-04-30T19:00:16Z",
"editor": "design",
"categories": []
}{
"message": "sed esse eiusmod dolor in",
"field": "esse enim",
"error_id": "exercitation adipisicing minim laboris"
}{
"errors": [
{
"message": "enim",
"field": "reprehenderit",
"error_id": "et Excepteur"
},
{
"message": "laborum aliquip",
"field": "minim sint fugiat elit",
"error_id": "eiusmod cillum consequat esse ut"
}
]
}GET
{
"id": "15b85720-ce48-48ef-8a07-672b0d3455da",
"name": "Ahoy, World!",
"html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n <head>\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n <!--[if !mso]><!-->\n <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n <!--<![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n <xml>\n <o:OfficeDocumentSettings>\n <o:AllowPNG/>\n <o:PixelsPerInch>96</o:PixelsPerInch>\n </o:OfficeDocumentSettings>\n </xml>\n <![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n <style type=\"text/css\">\n body {width: 600px;margin: 0 auto;}\n table {border-collapse: collapse;}\n table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n img {-ms-interpolation-mode: bicubic;}\n </style>\n<![endif]-->\n <style type=\"text/css\">\n body, p, div {\n font-family: arial,helvetica,sans-serif;\n font-size: 14px;\n }\n body {\n color: #000000;\n }\n body a {\n color: #1188E6;\n text-decoration: none;\n }\n p { margin: 0; padding: 0; }\n table.wrapper {\n width:100% !important;\n table-layout: fixed;\n -webkit-font-smoothing: antialiased;\n -webkit-text-size-adjust: 100%;\n -moz-text-size-adjust: 100%;\n -ms-text-size-adjust: 100%;\n }\n img.max-width {\n max-width: 100% !important;\n }\n .column.of-2 {\n width: 50%;\n }\n .column.of-3 {\n width: 33.333%;\n }\n .column.of-4 {\n width: 25%;\n }\n ul ul ul ul {\n list-style-type: disc !important;\n }\n ol ol {\n list-style-type: lower-roman !important;\n }\n ol ol ol {\n list-style-type: lower-latin !important;\n }\n ol ol ol ol {\n list-style-type: decimal !important;\n }\n @media screen and (max-width:480px) {\n .preheader .rightColumnContent,\n .footer .rightColumnContent {\n text-align: left !important;\n }\n .preheader .rightColumnContent div,\n .preheader .rightColumnContent span,\n .footer .rightColumnContent div,\n .footer .rightColumnContent span {\n text-align: left !important;\n }\n .preheader .rightColumnContent,\n .preheader .leftColumnContent {\n font-size: 80% !important;\n padding: 5px 0;\n }\n table.wrapper-mobile {\n width: 100% !important;\n table-layout: fixed;\n }\n img.max-width {\n height: auto !important;\n max-width: 100% !important;\n }\n a.bulletproof-button {\n display: block !important;\n width: auto !important;\n font-size: 80%;\n padding-left: 0 !important;\n padding-right: 0 !important;\n }\n .columns {\n width: 100% !important;\n }\n .column {\n display: block !important;\n width: 100% !important;\n padding-left: 0 !important;\n padding-right: 0 !important;\n margin-left: 0 !important;\n margin-right: 0 !important;\n }\n .social-icon-column {\n display: inline-block !important;\n }\n }\n </style>\n <!--user entered Head Start--><!--End Head user entered-->\n </head>\n <body>\n <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n <div class=\"webkit\">\n <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n <tr>\n <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tr>\n <td width=\"100%\">\n <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tr>\n <td>\n <!--[if mso]>\n <center>\n <table><tr><td width=\"600\">\n <![endif]-->\n <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n <tr>\n <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n <tr>\n <td role=\"module-content\">\n <p></p>\n </td>\n </tr>\n </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n <tbody>\n <tr>\n <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n </tr>\n </tbody>\n </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n </tr>\n </table>\n <!--[if mso]>\n </td>\n </tr>\n </table>\n </center>\n <![endif]-->\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </div>\n </center>\n </body>\n </html>",
"plain_content": "Ahoy, World!\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
"generate_plain_content": false,
"thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/5yysvuyi1lpdnxo1ym8ax8yd7ompve3azjtme76gamdace01vko3eyn1kzso1lhy.png",
"subject": "Getting Started",
"created_at": "2021-04-30T18:51:20Z",
"updated_at": "2021-04-30T18:51:20Z",
"editor": "design",
"categories": []
}{
"errors": [
{
"message": "anim aliquip",
"field": "ad",
"error_id": "in culpa commodo Lorem"
}
]
}{
"errors": [
{
"message": "dolor voluptate et",
"field": "ullamco non sint",
"error_id": "veniam eu dolor aliqua in"
},
{
"message": "commodo est amet",
"field": "ea consequat",
"error_id": "in irure est"
},
{
"message": "aliqua ullamco",
"field": "et ut sed",
"error_id": "magna officia esse Excepteur culpa"
},
{
"message": "dolore adipisicing esse",
"field": "sit",
"error_id": "ut non ea dolore"
}
]
}PATCH
{
"name": "Ahoy, World!",
"subject": "Getting Started",
"html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n <head>\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n <!--[if !mso]><!-->\n <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n <!--<![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n <xml>\n <o:OfficeDocumentSettings>\n <o:AllowPNG/>\n <o:PixelsPerInch>96</o:PixelsPerInch>\n </o:OfficeDocumentSettings>\n </xml>\n <![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n <style type=\"text/css\">\n body {width: 600px;margin: 0 auto;}\n table {border-collapse: collapse;}\n table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n img {-ms-interpolation-mode: bicubic;}\n </style>\n<![endif]-->\n <style type=\"text/css\">\n body, p, div {\n font-family: arial,helvetica,sans-serif;\n font-size: 14px;\n }\n body {\n color: #000000;\n }\n body a {\n color: #1188E6;\n text-decoration: none;\n }\n p { margin: 0; padding: 0; }\n table.wrapper {\n width:100% !important;\n table-layout: fixed;\n -webkit-font-smoothing: antialiased;\n -webkit-text-size-adjust: 100%;\n -moz-text-size-adjust: 100%;\n -ms-text-size-adjust: 100%;\n }\n img.max-width {\n max-width: 100% !important;\n }\n .column.of-2 {\n width: 50%;\n }\n .column.of-3 {\n width: 33.333%;\n }\n .column.of-4 {\n width: 25%;\n }\n ul ul ul ul {\n list-style-type: disc !important;\n }\n ol ol {\n list-style-type: lower-roman !important;\n }\n ol ol ol {\n list-style-type: lower-latin !important;\n }\n ol ol ol ol {\n list-style-type: decimal !important;\n }\n @media screen and (max-width:480px) {\n .preheader .rightColumnContent,\n .footer .rightColumnContent {\n text-align: left !important;\n }\n .preheader .rightColumnContent div,\n .preheader .rightColumnContent span,\n .footer .rightColumnContent div,\n .footer .rightColumnContent span {\n text-align: left !important;\n }\n .preheader .rightColumnContent,\n .preheader .leftColumnContent {\n font-size: 80% !important;\n padding: 5px 0;\n }\n table.wrapper-mobile {\n width: 100% !important;\n table-layout: fixed;\n }\n img.max-width {\n height: auto !important;\n max-width: 100% !important;\n }\n a.bulletproof-button {\n display: block !important;\n width: auto !important;\n font-size: 80%;\n padding-left: 0 !important;\n padding-right: 0 !important;\n }\n .columns {\n width: 100% !important;\n }\n .column {\n display: block !important;\n width: 100% !important;\n padding-left: 0 !important;\n padding-right: 0 !important;\n margin-left: 0 !important;\n margin-right: 0 !important;\n }\n .social-icon-column {\n display: inline-block !important;\n }\n }\n </style>\n <!--user entered Head Start--><!--End Head user entered-->\n </head>\n <body>\n <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n <div class=\"webkit\">\n <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n <tr>\n <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tr>\n <td width=\"100%\">\n <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tr>\n <td>\n <!--[if mso]>\n <center>\n <table><tr><td width=\"600\">\n <![endif]-->\n <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n <tr>\n <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n <tr>\n <td role=\"module-content\">\n <p></p>\n </td>\n </tr>\n </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n <tbody>\n <tr>\n <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n </tr>\n </tbody>\n </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n </tr>\n </table>\n <!--[if mso]>\n </td>\n </tr>\n </table>\n </center>\n <![endif]-->\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </div>\n </center>\n </body>\n </html>",
"generate_plain_content": false,
"categories": [
"promotions"
]
}{
"id": "15b85720-ce48-48ef-8a07-672b0d3455da",
"name": "Ahoy, World!",
"html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n <head>\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n <!--[if !mso]><!-->\n <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n <!--<![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n <xml>\n <o:OfficeDocumentSettings>\n <o:AllowPNG/>\n <o:PixelsPerInch>96</o:PixelsPerInch>\n </o:OfficeDocumentSettings>\n </xml>\n <![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n <style type=\"text/css\">\n body {width: 600px;margin: 0 auto;}\n table {border-collapse: collapse;}\n table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n img {-ms-interpolation-mode: bicubic;}\n </style>\n<![endif]-->\n <style type=\"text/css\">\n body, p, div {\n font-family: arial,helvetica,sans-serif;\n font-size: 14px;\n }\n body {\n color: #000000;\n }\n body a {\n color: #1188E6;\n text-decoration: none;\n }\n p { margin: 0; padding: 0; }\n table.wrapper {\n width:100% !important;\n table-layout: fixed;\n -webkit-font-smoothing: antialiased;\n -webkit-text-size-adjust: 100%;\n -moz-text-size-adjust: 100%;\n -ms-text-size-adjust: 100%;\n }\n img.max-width {\n max-width: 100% !important;\n }\n .column.of-2 {\n width: 50%;\n }\n .column.of-3 {\n width: 33.333%;\n }\n .column.of-4 {\n width: 25%;\n }\n ul ul ul ul {\n list-style-type: disc !important;\n }\n ol ol {\n list-style-type: lower-roman !important;\n }\n ol ol ol {\n list-style-type: lower-latin !important;\n }\n ol ol ol ol {\n list-style-type: decimal !important;\n }\n @media screen and (max-width:480px) {\n .preheader .rightColumnContent,\n .footer .rightColumnContent {\n text-align: left !important;\n }\n .preheader .rightColumnContent div,\n .preheader .rightColumnContent span,\n .footer .rightColumnContent div,\n .footer .rightColumnContent span {\n text-align: left !important;\n }\n .preheader .rightColumnContent,\n .preheader .leftColumnContent {\n font-size: 80% !important;\n padding: 5px 0;\n }\n table.wrapper-mobile {\n width: 100% !important;\n table-layout: fixed;\n }\n img.max-width {\n height: auto !important;\n max-width: 100% !important;\n }\n a.bulletproof-button {\n display: block !important;\n width: auto !important;\n font-size: 80%;\n padding-left: 0 !important;\n padding-right: 0 !important;\n }\n .columns {\n width: 100% !important;\n }\n .column {\n display: block !important;\n width: 100% !important;\n padding-left: 0 !important;\n padding-right: 0 !important;\n margin-left: 0 !important;\n margin-right: 0 !important;\n }\n .social-icon-column {\n display: inline-block !important;\n }\n }\n </style>\n <!--user entered Head Start--><!--End Head user entered-->\n </head>\n <body>\n <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n <div class=\"webkit\">\n <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n <tr>\n <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tr>\n <td width=\"100%\">\n <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tr>\n <td>\n <!--[if mso]>\n <center>\n <table><tr><td width=\"600\">\n <![endif]-->\n <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n <tr>\n <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n <tr>\n <td role=\"module-content\">\n <p></p>\n </td>\n </tr>\n </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n <tbody>\n <tr>\n <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n </tr>\n </tbody>\n </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n </tr>\n </table>\n <!--[if mso]>\n </td>\n </tr>\n </table>\n </center>\n <![endif]-->\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </div>\n </center>\n </body>\n </html>",
"generate_plain_content": false,
"thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/5yysvuyi1lpdnxo1ym8ax8yd7ompve3azjtme76gamdace01vko3eyn1kzso1lhy.png",
"subject": "Getting Started",
"created_at": "2021-04-30T18:51:20Z",
"updated_at": "2021-04-30T18:51:20Z",
"editor": "design",
"categories": [
"promotions"
]
}{
"errors": [
{
"message": "elit mollit ut id",
"field": "minim",
"error_id": "dolor dolor est consequat enim"
},
{
"message": "do",
"field": "culpa Lorem aute",
"error_id": "id Lorem Ut"
},
{
"message": "in",
"field": "in",
"error_id": "labore Lorem"
},
{
"message": "reprehenderit dolore",
"field": "id laborum",
"error_id": "consequat"
}
]
}{
"errors": [
{
"message": "laboris aute",
"field": "tempor laboris cupidatat eu",
"error_id": "ea ut velit exercitation"
},
{
"message": "aliqua consequat ea sint",
"field": "officia dolor",
"error_id": "consequat ea minim dolor deserunt"
}
]
}DELETE
{}{
"errors": [
{
"message": "consequat ea irure commodo et",
"field": "fugiat culpa ipsum dolore",
"error_id": "culpa Excepteur velit dolore"
}
]
}{
"errors": [
{
"message": "amet Excepteur sed",
"field": "ea",
"error_id": "dolor sint velit"
},
{
"message": "reprehenderit irure velit tempor Excepteur",
"field": "cillum aute aliquip do",
"error_id": "in Lorem do"
},
{
"message": "aliquip elit amet",
"field": "ad cupidatat aliquip",
"error_id": "mollit nisi dolore"
},
{
"message": "Lorem in irure ad consectetur",
"field": "sint Excepteur non",
"error_id": "commodo Excepteur nisi"
},
{
"message": "consequat do commodo",
"field": "labore eiusmod",
"error_id": "ex"
}
]
}POST
{
"name": "Ahoy, World!",
"editor": "design",
"subject": "Getting Started",
"html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n <head>\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n <!--[if !mso]><!-->\n <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n <!--<![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n <xml>\n <o:OfficeDocumentSettings>\n <o:AllowPNG/>\n <o:PixelsPerInch>96</o:PixelsPerInch>\n </o:OfficeDocumentSettings>\n </xml>\n <![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n <style type=\"text/css\">\n body {width: 600px;margin: 0 auto;}\n table {border-collapse: collapse;}\n table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n img {-ms-interpolation-mode: bicubic;}\n </style>\n<![endif]-->\n <style type=\"text/css\">\n body, p, div {\n font-family: arial,helvetica,sans-serif;\n font-size: 14px;\n }\n body {\n color: #000000;\n }\n body a {\n color: #1188E6;\n text-decoration: none;\n }\n p { margin: 0; padding: 0; }\n table.wrapper {\n width:100% !important;\n table-layout: fixed;\n -webkit-font-smoothing: antialiased;\n -webkit-text-size-adjust: 100%;\n -moz-text-size-adjust: 100%;\n -ms-text-size-adjust: 100%;\n }\n img.max-width {\n max-width: 100% !important;\n }\n .column.of-2 {\n width: 50%;\n }\n .column.of-3 {\n width: 33.333%;\n }\n .column.of-4 {\n width: 25%;\n }\n ul ul ul ul {\n list-style-type: disc !important;\n }\n ol ol {\n list-style-type: lower-roman !important;\n }\n ol ol ol {\n list-style-type: lower-latin !important;\n }\n ol ol ol ol {\n list-style-type: decimal !important;\n }\n @media screen and (max-width:480px) {\n .preheader .rightColumnContent,\n .footer .rightColumnContent {\n text-align: left !important;\n }\n .preheader .rightColumnContent div,\n .preheader .rightColumnContent span,\n .footer .rightColumnContent div,\n .footer .rightColumnContent span {\n text-align: left !important;\n }\n .preheader .rightColumnContent,\n .preheader .leftColumnContent {\n font-size: 80% !important;\n padding: 5px 0;\n }\n table.wrapper-mobile {\n width: 100% !important;\n table-layout: fixed;\n }\n img.max-width {\n height: auto !important;\n max-width: 100% !important;\n }\n a.bulletproof-button {\n display: block !important;\n width: auto !important;\n font-size: 80%;\n padding-left: 0 !important;\n padding-right: 0 !important;\n }\n .columns {\n width: 100% !important;\n }\n .column {\n display: block !important;\n width: 100% !important;\n padding-left: 0 !important;\n padding-right: 0 !important;\n margin-left: 0 !important;\n margin-right: 0 !important;\n }\n .social-icon-column {\n display: inline-block !important;\n }\n }\n </style>\n <!--user entered Head Start--><!--End Head user entered-->\n </head>\n <body>\n <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n <div class=\"webkit\">\n <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n <tr>\n <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tr>\n <td width=\"100%\">\n <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tr>\n <td>\n <!--[if mso]>\n <center>\n <table><tr><td width=\"600\">\n <![endif]-->\n <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n <tr>\n <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n <tr>\n <td role=\"module-content\">\n <p></p>\n </td>\n </tr>\n </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n <tbody>\n <tr>\n <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n </tr>\n </tbody>\n </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n </tr>\n </table>\n <!--[if mso]>\n </td>\n </tr>\n </table>\n </center>\n <![endif]-->\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </div>\n </center>\n </body>\n </html>",
"plain_content": "Ahoy, World!\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )"
}{
"id": "3247eaea-c912-42a3-b0bc-60bdaf210396",
"name": "Ahoy, World!",
"html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n <head>\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n <!--[if !mso]><!-->\n <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n <!--<![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n <xml>\n <o:OfficeDocumentSettings>\n <o:AllowPNG/>\n <o:PixelsPerInch>96</o:PixelsPerInch>\n </o:OfficeDocumentSettings>\n </xml>\n <![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n <style type=\"text/css\">\n body {width: 600px;margin: 0 auto;}\n table {border-collapse: collapse;}\n table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n img {-ms-interpolation-mode: bicubic;}\n </style>\n<![endif]-->\n <style type=\"text/css\">\n body, p, div {\n font-family: arial,helvetica,sans-serif;\n font-size: 14px;\n }\n body {\n color: #000000;\n }\n body a {\n color: #1188E6;\n text-decoration: none;\n }\n p { margin: 0; padding: 0; }\n table.wrapper {\n width:100% !important;\n table-layout: fixed;\n -webkit-font-smoothing: antialiased;\n -webkit-text-size-adjust: 100%;\n -moz-text-size-adjust: 100%;\n -ms-text-size-adjust: 100%;\n }\n img.max-width {\n max-width: 100% !important;\n }\n .column.of-2 {\n width: 50%;\n }\n .column.of-3 {\n width: 33.333%;\n }\n .column.of-4 {\n width: 25%;\n }\n ul ul ul ul {\n list-style-type: disc !important;\n }\n ol ol {\n list-style-type: lower-roman !important;\n }\n ol ol ol {\n list-style-type: lower-latin !important;\n }\n ol ol ol ol {\n list-style-type: decimal !important;\n }\n @media screen and (max-width:480px) {\n .preheader .rightColumnContent,\n .footer .rightColumnContent {\n text-align: left !important;\n }\n .preheader .rightColumnContent div,\n .preheader .rightColumnContent span,\n .footer .rightColumnContent div,\n .footer .rightColumnContent span {\n text-align: left !important;\n }\n .preheader .rightColumnContent,\n .preheader .leftColumnContent {\n font-size: 80% !important;\n padding: 5px 0;\n }\n table.wrapper-mobile {\n width: 100% !important;\n table-layout: fixed;\n }\n img.max-width {\n height: auto !important;\n max-width: 100% !important;\n }\n a.bulletproof-button {\n display: block !important;\n width: auto !important;\n font-size: 80%;\n padding-left: 0 !important;\n padding-right: 0 !important;\n }\n .columns {\n width: 100% !important;\n }\n .column {\n display: block !important;\n width: 100% !important;\n padding-left: 0 !important;\n padding-right: 0 !important;\n margin-left: 0 !important;\n margin-right: 0 !important;\n }\n .social-icon-column {\n display: inline-block !important;\n }\n }\n </style>\n <!--user entered Head Start--><!--End Head user entered-->\n </head>\n <body>\n <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n <div class=\"webkit\">\n <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n <tr>\n <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tr>\n <td width=\"100%\">\n <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tr>\n <td>\n <!--[if mso]>\n <center>\n <table><tr><td width=\"600\">\n <![endif]-->\n <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n <tr>\n <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n <tr>\n <td role=\"module-content\">\n <p></p>\n </td>\n </tr>\n </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n <tbody>\n <tr>\n <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n </tr>\n </tbody>\n </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n </tr>\n </table>\n <!--[if mso]>\n </td>\n </tr>\n </table>\n </center>\n <![endif]-->\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </div>\n </center>\n </body>\n </html>",
"plain_content": "Ahoy, World!\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
"generate_plain_content": false,
"thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/kjlrmded0qnrscv8zqr39npoimrpdwgiax59q8iq6ovj7yoks2fzxoxpfjpwph6o.png",
"subject": "Getting Started",
"created_at": "2021-04-30T18:51:20Z",
"updated_at": "2021-04-30T18:51:20Z",
"editor": "design",
"categories": []
}{
"errors": [
{
"message": "incididunt sunt proident ullamco",
"field": "dolore cupidatat sed elit magna",
"error_id": "tempor cillum proident nulla"
},
{
"message": "Lorem mollit sit deserunt",
"field": "esse laboris minim dolore irure",
"error_id": "esse cupidatat"
},
{
"message": "aute",
"field": "proident magna veniam Excepteur",
"error_id": "sunt non cillum"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
page_size | 68051490 |
page_token | fugiat amet pariatur |
summary | true |
{
"result": [
{
"id": "3247eaea-c912-42a3-b0bc-60bdaf210396",
"name": "Welcome Email",
"generate_plain_content": true,
"thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/llny8o5b3m636z92p7hbjnmq1jvpka39p370jwtin2s1wxv7x1sgm0y5fk518d0s.png",
"subject": "Welcom to the Cake or Pie Cafe",
"created_at": "2021-04-09T17:29:46Z",
"updated_at": "2021-04-09T17:29:55Z",
"editor": "code",
"categories": [
"welcome",
"new customer"
]
},
{
"id": "02dfd792-f31f-439a-a79e-5c47fbcfdbac",
"name": "Monthly Promo",
"generate_plain_content": true,
"thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/hfyxahd7ues2ajuoeoqq2xe6ibdasl1q89ox0y9ncya2ftpoicssmtf9ddus4c39.png",
"subject": "Free Dozen Cupcakes",
"created_at": "2021-04-09T17:29:21Z",
"updated_at": "2021-04-09T17:29:42Z",
"editor": "design",
"categories": [
"promo",
"coupon"
]
},
{
"id": "e54be823-19ef-4c6f-8b60-efd7514f492d",
"name": "Duplicate: Ingrid & Anders",
"generate_plain_content": true,
"thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/12kni9gjpyb9uxmwr9vk7unycjr70u95zoyhe9sg2zounul2zg7dih1s20k13q2z.png",
"subject": "Welcome to Ingrid & Anders!",
"created_at": "2020-10-09T17:33:46Z",
"updated_at": "2021-04-07T19:57:52Z",
"editor": "design",
"categories": []
}
],
"_metadata": {
"self": "https://api.sendgrid.com/v3/designs?page_token=vHdvHCg0w1F-TmWJcPNpTEnFY2aPEmRBHONwOgZ6TgJbX2_I",
"count": 3
}
}POST
{
"name": "Ahoy, Cake or Pie Cafe!",
"editor": "design"
}{
"id": "abe0877f-a224-21e2-b62e-c789d326cda5",
"name": "Ahoy, Pre-built Design!",
"html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n <head>\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n <!--[if !mso]><!-->\n <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n <!--<![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n <xml>\n <o:OfficeDocumentSettings>\n <o:AllowPNG/>\n <o:PixelsPerInch>96</o:PixelsPerInch>\n </o:OfficeDocumentSettings>\n </xml>\n <![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n <style type=\"text/css\">\n body {width: 600px;margin: 0 auto;}\n table {border-collapse: collapse;}\n table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n img {-ms-interpolation-mode: bicubic;}\n </style>\n<![endif]-->\n <style type=\"text/css\">\n body, p, div {\n font-family: courier, monospace;\n font-size: 16px;\n }\n body {\n color: #FFFFFF;\n }\n body a {\n color: #fe5d61;\n text-decoration: none;\n }\n p { margin: 0; padding: 0; }\n table.wrapper {\n width:100% !important;\n table-layout: fixed;\n -webkit-font-smoothing: antialiased;\n -webkit-text-size-adjust: 100%;\n -moz-text-size-adjust: 100%;\n -ms-text-size-adjust: 100%;\n }\n img.max-width {\n max-width: 100% !important;\n }\n .column.of-2 {\n width: 50%;\n }\n .column.of-3 {\n width: 33.333%;\n }\n .column.of-4 {\n width: 25%;\n }\n @media screen and (max-width:480px) {\n .preheader .rightColumnContent,\n .footer .rightColumnContent {\n text-align: left !important;\n }\n .preheader .rightColumnContent div,\n .preheader .rightColumnContent span,\n .footer .rightColumnContent div,\n .footer .rightColumnContent span {\n text-align: left !important;\n }\n .preheader .rightColumnContent,\n .preheader .leftColumnContent {\n font-size: 80% !important;\n padding: 5px 0;\n }\n table.wrapper-mobile {\n width: 100% !important;\n table-layout: fixed;\n }\n img.max-width {\n height: auto !important;\n max-width: 100% !important;\n }\n a.bulletproof-button {\n display: block !important;\n width: auto !important;\n font-size: 80%;\n padding-left: 0 !important;\n padding-right: 0 !important;\n }\n .columns {\n width: 100% !important;\n }\n .column {\n display: block !important;\n width: 100% !important;\n padding-left: 0 !important;\n padding-right: 0 !important;\n margin-left: 0 !important;\n margin-right: 0 !important;\n }\n .social-icon-column {\n display: inline-block !important;\n }\n }\n </style>\n <!--user entered Head Start-->\n\n <!--End Head user entered-->\n </head>\n <body>\n <center class=\"wrapper\" data-link-color=\"#fe5d61\" data-body-style=\"font-size:16px; font-family:courier, monospace; color:#FFFFFF; background-color:#f2f4fb;\">\n <div class=\"webkit\">\n <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#f2f4fb\">\n <tr>\n <td valign=\"top\" bgcolor=\"#f2f4fb\" width=\"100%\">\n <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tr>\n <td width=\"100%\">\n <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tr>\n <td>\n <!--[if mso]>\n <center>\n <table><tr><td width=\"600\">\n <![endif]-->\n <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n <tr>\n <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#FFFFFF; text-align:left;\" bgcolor=\"#f2f4fb\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n <tr>\n <td role=\"module-content\">\n <p>You've found the secret!</p>\n </td>\n </tr>\n </table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"98ndJyAY9BSGjoVqrr6FYx\">\n <tbody><tr>\n <td style=\"font-size:6px; line-height:10px; padding:30px 0px 30px 0px;\" valign=\"top\" align=\"left\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:40% !important; width:40%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/9d9c1f3d8009c42bbe60c0355f1ed23e86c3f5619173e83a9328b9214e42e1c1d5e009ed5cc4c8f3efedfc33d46bba2f4577b143607025a29add6e89ab4662ad.png\" alt=\"Off Grid Adventures\" width=\"240\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n </tr>\n </tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"3Ypdby9Xfsf2rN27zTDEfN\">\n <tbody><tr>\n <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/e324b295c47223f1a936198fbd4e5d4b239ff86c6d6c89d4d0eb8d7c61028921abfc4901ba607f6dcb7acc7067bb0c6df4313726b14b8274e0b2c98cdf8b58d2.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n </tr>\n </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"7pyDCmyDaGcm5WsBBSaEgv\" data-mc-module-version=\"2019-10-22\">\n <tbody><tr>\n <td style=\"background-color:#FE5D61; padding:50px 0px 30px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#FE5D61\"><div><div style=\"font-family: inherit; text-align: center\"><span style=\"font-size: 24px\">Welcome to the family!</span></div><div></div></div></td>\n </tr>\n </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"nSVYnVzPLnGZ4wUdynLiKo\" data-mc-module-version=\"2019-10-22\">\n <tbody><tr>\n <td style=\"background-color:#fe5d61; padding:30px 50px 30px 50px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#fe5d61\"><div><div style=\"font-family: inherit; text-align: center\">You've found a community of travelers that are just like you.</div>\n<div style=\"font-family: inherit; text-align: center\"> </div>\n<div style=\"font-family: inherit; text-align: center\">We don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.</div>\n<div style=\"font-family: inherit; text-align: center\"> </div>\n<div style=\"font-family: inherit; text-align: center\">Ready for your next authentic travel experience?</div><div></div></div></td>\n </tr>\n </tbody></table><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"module\" data-role=\"module-button\" data-type=\"button\" role=\"module\" style=\"table-layout:fixed\" width=\"100%\" data-muid=\"4ywPd9vJ6WFyV1Si75h9vh\"><tbody><tr><td align=\"center\" bgcolor=\"#fe5d61\" class=\"outer-td\" style=\"padding:10px 10px 60px 10px; background-color:#fe5d61;\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"button-css__deep-table___2OZyb wrapper-mobile\" style=\"text-align:center\"><tbody><tr><td align=\"center\" bgcolor=\"#ffffff\" class=\"inner-td\" style=\"border-radius:6px; font-size:16px; text-align:center; background-color:inherit;\"><a style=\"background-color:#ffffff; border:1px solid #ffffff; border-color:#ffffff; border-radius:3px; border-width:1px; color:#fe5d61; display:inline-block; font-size:16px; font-weight:700; letter-spacing:1px; line-height:40px; padding:12px 20px 12px 20px; text-align:center; text-decoration:none; border-style:solid;\" href=\"\" target=\"_blank\">Browse Gallery</a></td></tr></tbody></table></td></tr></tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"6jxKSRk9dKQ1Tvi1wtnu8q\">\n <tbody><tr>\n <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/0accac77b1e34c614730ab732317a493478835c96bd549fb2df7a921ec1177fdb30d6d33e1d0a33d8c6c579344890ae408ce13aaed0e478f1fd6d2219d308365.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n </tr>\n </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"iYySZ4rAB78PLoW7vU13Bb\">\n <tbody><tr>\n <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n </td>\n </tr>\n </tbody></table><table class=\"module\" role=\"module\" data-type=\"divider\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"mVyZz43HETwfwb72TGh4iy\">\n <tbody><tr>\n <td style=\"padding:0px 0px 0px 0px;\" role=\"module-content\" height=\"100%\" valign=\"top\" bgcolor=\"\">\n <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" align=\"center\" width=\"100%\" height=\"3px\" style=\"line-height:3px; font-size:3px;\">\n <tbody><tr>\n <td style=\"padding:0px 0px 3px 0px;\" bgcolor=\"#ffffff\"></td>\n </tr>\n </tbody></table>\n </td>\n </tr>\n </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"sfek66tVLi5d2iy5jmSawj\">\n <tbody><tr>\n <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n </td>\n </tr>\n </tbody></table><table class=\"module\" role=\"module\" data-type=\"social\" align=\"center\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"87277ffe-54ed-4792-94f3-0a973b71c268\">\n <tbody>\n <tr>\n <td valign=\"top\" style=\"padding:0px 0px 0px 0px; font-size:6px; line-height:10px;\" align=\"center\">\n <table align=\"center\" style=\"-webkit-margin-start:auto;-webkit-margin-end:auto;\">\n <tbody><tr align=\"center\"><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n <a role=\"social-icon-link\" href=\"https://www.facebook.com/sendgrid/\" target=\"_blank\" alt=\"Facebook\" title=\"Facebook\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n <img role=\"social-icon\" alt=\"Facebook\" title=\"Facebook\" src=\"https://mc.sendgrid.com/assets/social/white/facebook.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n </a>\n </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n <a role=\"social-icon-link\" href=\"https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor\" target=\"_blank\" alt=\"Twitter\" title=\"Twitter\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n <img role=\"social-icon\" alt=\"Twitter\" title=\"Twitter\" src=\"https://mc.sendgrid.com/assets/social/white/twitter.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n </a>\n </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n <a role=\"social-icon-link\" href=\"https://www.instagram.com/sendgrid/?hl=en\" target=\"_blank\" alt=\"Instagram\" title=\"Instagram\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n <img role=\"social-icon\" alt=\"Instagram\" title=\"Instagram\" src=\"https://mc.sendgrid.com/assets/social/white/instagram.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n </a>\n </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n <a role=\"social-icon-link\" href=\"https://www.pinterest.com/sendgrid/\" target=\"_blank\" alt=\"Pinterest\" title=\"Pinterest\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n <img role=\"social-icon\" alt=\"Pinterest\" title=\"Pinterest\" src=\"https://mc.sendgrid.com/assets/social/white/pinterest.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n </a>\n </td></tr></tbody>\n </table>\n </td>\n </tr>\n </tbody>\n </table><div data-role=\"module-unsubscribe\" class=\"module unsubscribe-css__unsubscribe___2CDlR\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#FFFFFF; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:center;\" data-muid=\"txBUUpmixSjuZ5Ad69p1sX\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n </tr>\n </table>\n <!--[if mso]>\n </td>\n </tr>\n </table>\n </center>\n <![endif]-->\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </div>\n </center>\n </body>\n </html>",
"plain_content": "You've found the secret!\n\nWelcome to the family!\n\nYou've found a community of travelers that are just like you.\n\nWe don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.\n\nReady for your next authentic travel experience?\n\nBrowse Gallery\n\n( https://www.facebook.com/sendgrid/ ) ( https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor ) ( https://www.instagram.com/sendgrid/?hl=en ) ( https://www.pinterest.com/sendgrid/ )\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
"generate_plain_content": true,
"thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/a85b4b202ff28094828f11ff472360caecf67ead2d186b69b45c904b9251aa0b.png",
"subject": "Welcome to the family!",
"created_at": "2021-04-30T19:15:28Z",
"updated_at": "2021-04-30T19:15:28Z",
"editor": "design",
"categories": []
}{
"errors": [
{
"message": "dolor non",
"field": "Excepteur",
"error_id": "minim ad labore sit dolor"
},
{
"message": "ullamco Lorem ut",
"field": "nulla pariatur consectetur",
"error_id": "exercitation in"
}
]
}{
"errors": [
{
"message": "aliquip pariatur reprehenderit sit non",
"field": "irure anim reprehenderit",
"error_id": "mollit nostrud"
},
{
"message": "cillum in aute in officia",
"field": "incididunt",
"error_id": "officia ea Duis"
},
{
"message": "ut incididunt exercitation laboris",
"field": "sit",
"error_id": "et"
},
{
"message": "nulla ad",
"field": "ut aliquip",
"error_id": "Lorem amet aliquip deserunt laborum"
}
]
}GET
{
"id": "6ad69134-7165-48cb-964a-6c3cf03e8af8",
"name": "Off Grid Adventures",
"html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n <head>\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n <!--[if !mso]><!-->\n <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n <!--<![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n <xml>\n <o:OfficeDocumentSettings>\n <o:AllowPNG/>\n <o:PixelsPerInch>96</o:PixelsPerInch>\n </o:OfficeDocumentSettings>\n </xml>\n <![endif]-->\n <!--[if (gte mso 9)|(IE)]>\n <style type=\"text/css\">\n body {width: 600px;margin: 0 auto;}\n table {border-collapse: collapse;}\n table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n img {-ms-interpolation-mode: bicubic;}\n </style>\n<![endif]-->\n <style type=\"text/css\">\n body, p, div {\n font-family: courier, monospace;\n font-size: 16px;\n }\n body {\n color: #FFFFFF;\n }\n body a {\n color: #fe5d61;\n text-decoration: none;\n }\n p { margin: 0; padding: 0; }\n table.wrapper {\n width:100% !important;\n table-layout: fixed;\n -webkit-font-smoothing: antialiased;\n -webkit-text-size-adjust: 100%;\n -moz-text-size-adjust: 100%;\n -ms-text-size-adjust: 100%;\n }\n img.max-width {\n max-width: 100% !important;\n }\n .column.of-2 {\n width: 50%;\n }\n .column.of-3 {\n width: 33.333%;\n }\n .column.of-4 {\n width: 25%;\n }\n @media screen and (max-width:480px) {\n .preheader .rightColumnContent,\n .footer .rightColumnContent {\n text-align: left !important;\n }\n .preheader .rightColumnContent div,\n .preheader .rightColumnContent span,\n .footer .rightColumnContent div,\n .footer .rightColumnContent span {\n text-align: left !important;\n }\n .preheader .rightColumnContent,\n .preheader .leftColumnContent {\n font-size: 80% !important;\n padding: 5px 0;\n }\n table.wrapper-mobile {\n width: 100% !important;\n table-layout: fixed;\n }\n img.max-width {\n height: auto !important;\n max-width: 100% !important;\n }\n a.bulletproof-button {\n display: block !important;\n width: auto !important;\n font-size: 80%;\n padding-left: 0 !important;\n padding-right: 0 !important;\n }\n .columns {\n width: 100% !important;\n }\n .column {\n display: block !important;\n width: 100% !important;\n padding-left: 0 !important;\n padding-right: 0 !important;\n margin-left: 0 !important;\n margin-right: 0 !important;\n }\n .social-icon-column {\n display: inline-block !important;\n }\n }\n </style>\n <!--user entered Head Start-->\n\n <!--End Head user entered-->\n </head>\n <body>\n <center class=\"wrapper\" data-link-color=\"#fe5d61\" data-body-style=\"font-size:16px; font-family:courier, monospace; color:#FFFFFF; background-color:#f2f4fb;\">\n <div class=\"webkit\">\n <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#f2f4fb\">\n <tr>\n <td valign=\"top\" bgcolor=\"#f2f4fb\" width=\"100%\">\n <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tr>\n <td width=\"100%\">\n <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n <tr>\n <td>\n <!--[if mso]>\n <center>\n <table><tr><td width=\"600\">\n <![endif]-->\n <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n <tr>\n <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#FFFFFF; text-align:left;\" bgcolor=\"#f2f4fb\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n <tr>\n <td role=\"module-content\">\n <p>You've found the secret!</p>\n </td>\n </tr>\n </table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"98ndJyAY9BSGjoVqrr6FYx\">\n <tbody><tr>\n <td style=\"font-size:6px; line-height:10px; padding:30px 0px 30px 0px;\" valign=\"top\" align=\"left\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:40% !important; width:40%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/9d9c1f3d8009c42bbe60c0355f1ed23e86c3f5619173e83a9328b9214e42e1c1d5e009ed5cc4c8f3efedfc33d46bba2f4577b143607025a29add6e89ab4662ad.png\" alt=\"Off Grid Adventures\" width=\"240\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n </tr>\n </tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"3Ypdby9Xfsf2rN27zTDEfN\">\n <tbody><tr>\n <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/e324b295c47223f1a936198fbd4e5d4b239ff86c6d6c89d4d0eb8d7c61028921abfc4901ba607f6dcb7acc7067bb0c6df4313726b14b8274e0b2c98cdf8b58d2.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n </tr>\n </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"7pyDCmyDaGcm5WsBBSaEgv\" data-mc-module-version=\"2019-10-22\">\n <tbody><tr>\n <td style=\"background-color:#FE5D61; padding:50px 0px 30px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#FE5D61\"><div><div style=\"font-family: inherit; text-align: center\"><span style=\"font-size: 24px\">Welcome to the family!</span></div><div></div></div></td>\n </tr>\n </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"nSVYnVzPLnGZ4wUdynLiKo\" data-mc-module-version=\"2019-10-22\">\n <tbody><tr>\n <td style=\"background-color:#fe5d61; padding:30px 50px 30px 50px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#fe5d61\"><div><div style=\"font-family: inherit; text-align: center\">You've found a community of travelers that are just like you.</div>\n<div style=\"font-family: inherit; text-align: center\"> </div>\n<div style=\"font-family: inherit; text-align: center\">We don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.</div>\n<div style=\"font-family: inherit; text-align: center\"> </div>\n<div style=\"font-family: inherit; text-align: center\">Ready for your next authentic travel experience?</div><div></div></div></td>\n </tr>\n </tbody></table><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"module\" data-role=\"module-button\" data-type=\"button\" role=\"module\" style=\"table-layout:fixed\" width=\"100%\" data-muid=\"4ywPd9vJ6WFyV1Si75h9vh\"><tbody><tr><td align=\"center\" bgcolor=\"#fe5d61\" class=\"outer-td\" style=\"padding:10px 10px 60px 10px; background-color:#fe5d61;\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"button-css__deep-table___2OZyb wrapper-mobile\" style=\"text-align:center\"><tbody><tr><td align=\"center\" bgcolor=\"#ffffff\" class=\"inner-td\" style=\"border-radius:6px; font-size:16px; text-align:center; background-color:inherit;\"><a style=\"background-color:#ffffff; border:1px solid #ffffff; border-color:#ffffff; border-radius:3px; border-width:1px; color:#fe5d61; display:inline-block; font-size:16px; font-weight:700; letter-spacing:1px; line-height:40px; padding:12px 20px 12px 20px; text-align:center; text-decoration:none; border-style:solid;\" href=\"\" target=\"_blank\">Browse Gallery</a></td></tr></tbody></table></td></tr></tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"6jxKSRk9dKQ1Tvi1wtnu8q\">\n <tbody><tr>\n <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/0accac77b1e34c614730ab732317a493478835c96bd549fb2df7a921ec1177fdb30d6d33e1d0a33d8c6c579344890ae408ce13aaed0e478f1fd6d2219d308365.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n </tr>\n </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"iYySZ4rAB78PLoW7vU13Bb\">\n <tbody><tr>\n <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n </td>\n </tr>\n </tbody></table><table class=\"module\" role=\"module\" data-type=\"divider\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"mVyZz43HETwfwb72TGh4iy\">\n <tbody><tr>\n <td style=\"padding:0px 0px 0px 0px;\" role=\"module-content\" height=\"100%\" valign=\"top\" bgcolor=\"\">\n <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" align=\"center\" width=\"100%\" height=\"3px\" style=\"line-height:3px; font-size:3px;\">\n <tbody><tr>\n <td style=\"padding:0px 0px 3px 0px;\" bgcolor=\"#ffffff\"></td>\n </tr>\n </tbody></table>\n </td>\n </tr>\n </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"sfek66tVLi5d2iy5jmSawj\">\n <tbody><tr>\n <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n </td>\n </tr>\n </tbody></table><table class=\"module\" role=\"module\" data-type=\"social\" align=\"center\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"87277ffe-54ed-4792-94f3-0a973b71c268\">\n <tbody>\n <tr>\n <td valign=\"top\" style=\"padding:0px 0px 0px 0px; font-size:6px; line-height:10px;\" align=\"center\">\n <table align=\"center\" style=\"-webkit-margin-start:auto;-webkit-margin-end:auto;\">\n <tbody><tr align=\"center\"><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n <a role=\"social-icon-link\" href=\"https://www.facebook.com/sendgrid/\" target=\"_blank\" alt=\"Facebook\" title=\"Facebook\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n <img role=\"social-icon\" alt=\"Facebook\" title=\"Facebook\" src=\"https://mc.sendgrid.com/assets/social/white/facebook.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n </a>\n </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n <a role=\"social-icon-link\" href=\"https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor\" target=\"_blank\" alt=\"Twitter\" title=\"Twitter\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n <img role=\"social-icon\" alt=\"Twitter\" title=\"Twitter\" src=\"https://mc.sendgrid.com/assets/social/white/twitter.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n </a>\n </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n <a role=\"social-icon-link\" href=\"https://www.instagram.com/sendgrid/?hl=en\" target=\"_blank\" alt=\"Instagram\" title=\"Instagram\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n <img role=\"social-icon\" alt=\"Instagram\" title=\"Instagram\" src=\"https://mc.sendgrid.com/assets/social/white/instagram.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n </a>\n </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n <a role=\"social-icon-link\" href=\"https://www.pinterest.com/sendgrid/\" target=\"_blank\" alt=\"Pinterest\" title=\"Pinterest\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n <img role=\"social-icon\" alt=\"Pinterest\" title=\"Pinterest\" src=\"https://mc.sendgrid.com/assets/social/white/pinterest.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n </a>\n </td></tr></tbody>\n </table>\n </td>\n </tr>\n </tbody>\n </table><div data-role=\"module-unsubscribe\" class=\"module unsubscribe-css__unsubscribe___2CDlR\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#FFFFFF; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:center;\" data-muid=\"txBUUpmixSjuZ5Ad69p1sX\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n </tr>\n </table>\n <!--[if mso]>\n </td>\n </tr>\n </table>\n </center>\n <![endif]-->\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </div>\n </center>\n </body>\n </html>",
"plain_content": "You've found the secret!\n\nWelcome to the family!\n\nYou've found a community of travelers that are just like you.\n\nWe don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.\n\nReady for your next authentic travel experience?\n\nBrowse Gallery\n\n( https://www.facebook.com/sendgrid/ ) ( https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor ) ( https://www.instagram.com/sendgrid/?hl=en ) ( https://www.pinterest.com/sendgrid/ )\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
"generate_plain_content": true,
"thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/a85b4b202ff28094828f11ff472360caecf67ead2d186b69b45c904b9251aa0b.png",
"subject": "Welcome to the family!",
"created_at": "2019-09-10T02:11:34Z",
"updated_at": "2021-01-11T21:47:52Z",
"editor": "design",
"categories": []
}{
"errors": [
{
"message": "amet eiusmod non Lorem",
"field": "ad",
"error_id": "aliqua proident incididunt"
},
{
"message": "qui ullamco deserunt mollit in",
"field": "voluptate cillum ut",
"error_id": "nulla tempor"
}
]
}{
"errors": [
{
"message": "ut pariatur ullamco labore incididunt",
"field": "irure minim ad ea laborum",
"error_id": "voluptate culpa"
},
{
"message": "dolor est dolore",
"field": "nisi",
"error_id": "amet non voluptate irure"
},
{
"message": "occaecat elit aute",
"field": "consequat enim",
"error_id": "est amet esse cillum dolore"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
page_size | 98117249 |
page_token | Lorem tempor reprehenderit dolore id |
summary | true |
{
"result": [
{
"id": "6ad69134-7165-48cb-964a-6c3cf03e8af8",
"name": "Off Grid Adventures",
"generate_plain_content": true,
"thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/a85b4b202ff28094828f11ff472360caecf67ead2d186b69b45c904b9251aa0b.png",
"subject": "Welcome to the family!",
"created_at": "2019-09-10T02:11:34Z",
"updated_at": "2021-01-11T21:47:52Z",
"editor": "design",
"categories": []
},
{
"id": "b0a9c6f7-a9a1-4b52-b0c5-16fc6f4cdb2b",
"name": "Song Riddle",
"generate_plain_content": true,
"thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/4ef3a39249f3accb8461b03950c071454a745a232508feca89a626b3e7f578d3.png",
"subject": "Welcome to Song Riddle!",
"created_at": "2019-09-10T02:12:32Z",
"updated_at": "2021-01-11T21:46:43Z",
"editor": "design",
"categories": []
},
{
"id": "f8d8da76-bcca-4cfe-b809-733887855f57",
"name": "Ingrid & Anders 1",
"generate_plain_content": true,
"thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/15c97ffa97ee31693581a67526728d096eef00adfbaa34bb030d91034d477da4.png",
"subject": "Welcome to Ingrid & Anders!",
"created_at": "2019-09-10T02:10:38Z",
"updated_at": "2021-01-11T21:45:05Z",
"editor": "design",
"categories": []
},
{
"id": "2935a7d0-7f02-4e0f-a570-dc302ce09749",
"name": "Ingrid & Anders 2",
"generate_plain_content": true,
"thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/7b36a6c0955cab0c350d105114ad248700a685bd11032592cdef85ae26540afc.png",
"subject": "Check out these exclusive deals!",
"created_at": "2019-09-10T02:09:31Z",
"updated_at": "2021-01-11T21:44:08Z",
"editor": "design",
"categories": []
},
{
"id": "7826ef14-7ba6-4dbc-91f0-a8c610ebe962",
"name": "Ingrid & Anders 3",
"generate_plain_content": true,
"thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/6dd8dd73a1a62bd7a76c4313b52d7c749250d49e31b19cce718906655fcbc675.png",
"subject": "Join our VIP club and save big!",
"created_at": "2019-09-10T02:08:29Z",
"updated_at": "2021-01-11T21:41:35Z",
"editor": "design",
"categories": []
},
{
"id": "41da47e7-d3e2-491b-a83f-f499a4139d6a",
"name": "Mercado",
"generate_plain_content": true,
"thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/9cc87cc7671719712d9d363184995d0ec05103355db300ff03641fe9e205651d.png",
"subject": "Subject",
"created_at": "2019-09-10T02:03:06Z",
"updated_at": "2021-01-11T21:39:23Z",
"editor": "design",
"categories": []
}
],
"_metadata": {
"self": "https://api.sendgrid.com/v3/designs/pre-builts?page_token=yYzyCxj-iIVgP54t6NjKkunDCKYLLpngo-5vAsfYXz0To34U",
"count": 6
}
}Contacts(13 operations)
PUT
{
"list_ids": [
"b4b5bcb7-d998-cd2a-7b5d-4539849c3106",
"eeb84e1d-6aad-47c3-6a3e-918cf54ae970",
"1e00d9d0-1e09-3f1b-cb8d-4c8da4ff13b6",
"cb9b8644-61df-507b-06b8-2e650363f55e",
"fbba4c1a-191a-2b8f-395b-95ab5bda67ec"
],
"contacts": [
{
"address_line_1": "irure labore cillum",
"address_line_2": "laborum ex consectetur",
"alternate_emails": [
"qui se",
"mollit",
"non in occaecat nisi",
"molli",
"sunt velit sint"
],
"city": "commodo veniam laboris",
"country": "voluptate Lorem et do Excepteur",
"email": "cillum",
"first_name": "Duis dolore",
"last_name": "minim commodo in",
"postal_code": "nisi do eu",
"state_province_region": "dolor cupidatat",
"custom_fields": {
"w1": "2002-10-02T15:00:00Z",
"w33": 9.5,
"e2": "Coffee is a beverage that puts one to sleep when not drank."
}
},
{
"address_line_1": "elit nostrud eu",
"address_line_2": "culpa aliqua mollit nulla",
"alternate_emails": [
"do est",
"amet laboris ex",
"cupidatat",
"incididunt magna culpa",
"aliqua consectetur in sint"
],
"city": "deser",
"country": "u",
"email": "proident nulla culpa",
"first_name": "sed Ut incididunt sint",
"last_name": "ea",
"postal_code": "ea",
"state_province_region": "",
"custom_fields": {
"w1": "2002-10-02T15:00:00Z",
"w33": 9.5,
"e2": "Coffee is a beverage that puts one to sleep when not drank."
}
},
{
"address_line_1": "est",
"address_line_2": "do",
"alternate_emails": [
"voluptate in laborum qui",
"nulla",
"non nulla mollit eiusmod",
"sit velit Excepteur",
"in est incididunt commodo"
],
"city": "pariatur do am",
"country": "cillum anim magna in",
"email": "enim dolore Lorem",
"first_name": "ad dolore est inc",
"last_name": "elit quis",
"postal_code": "cupidatat aliquip",
"state_province_region": "consectetur",
"custom_fields": {
"w1": "2002-10-02T15:00:00Z",
"w33": 9.5,
"e2": "Coffee is a beverage that puts one to sleep when not drank."
}
},
{
"address_line_1": "qui incididunt voluptate ut",
"address_line_2": "nostrud",
"alternate_emails": [
"consequat sit Excepteur proident",
"consequat dolor consectetur",
"enim elit",
"anim ea",
"culpa cupidatat"
],
"city": "mollit deserunt esse Duis",
"country": "laboris",
"email": "aliqua dolor voluptate pariatur",
"first_name": "do r",
"last_name": "quis commodo",
"postal_code": "sunt",
"state_province_region": "sunt ipsum",
"custom_fields": {
"w1": "2002-10-02T15:00:00Z",
"w33": 9.5,
"e2": "Coffee is a beverage that puts one to sleep when not drank."
}
},
{
"address_line_1": "ad est enim",
"address_line_2": "aliquip",
"alternate_emails": [
"cillum irure",
"commodo",
"dolor sed",
"ea Ut irure deserunt",
"velit dolor minim eiusmod"
],
"city": "mollit v",
"country": "ipsum",
"email": "deserunt nisi cupid",
"first_name": "eiusmod esse est aliquip ea",
"last_name": "in cupidatat eu est",
"postal_code": "irure id",
"state_province_region": "e",
"custom_fields": {
"w1": "2002-10-02T15:00:00Z",
"w33": 9.5,
"e2": "Coffee is a beverage that puts one to sleep when not drank."
}
},
{
"address_line_1": "c",
"address_line_2": "mollit",
"alternate_emails": [
"velit amet laboris Ut elit",
"magna",
"veniam sed ut Ut dolor",
"reprehenderit aliquip labore",
"al"
],
"city": "consectetur ea ut v",
"country": "ut ea",
"email": "ea commodo id",
"first_name": "nostrud",
"last_name": "laborum tempor in ",
"postal_code": "cupidatat aliqua minim dolore est",
"state_province_region": "occaecat offici",
"custom_fields": {
"w1": "2002-10-02T15:00:00Z",
"w33": 9.5,
"e2": "Coffee is a beverage that puts one to sleep when not drank."
}
},
{
"address_line_1": "irure",
"address_line_2": "incididunt in",
"alternate_emails": [
"est laboris ex",
"laboris magna est aliqua labore",
"laboris",
"est reprehenderit enim",
"exercitation ea in"
],
"city": "tempor",
"country": "non sed",
"email": "Duis",
"first_name": "reprehenderit pariatur velit e",
"last_name": "ea dolore in commodo",
"postal_code": "in in",
"state_province_region": "fugiat",
"custom_fields": {
"w1": "2002-10-02T15:00:00Z",
"w33": 9.5,
"e2": "Coffee is a beverage that puts one to sleep when not drank."
}
},
{
"address_line_1": "anim sed consequat cil",
"address_line_2": "adipisicing",
"alternate_emails": [
"aliquip adipisicing nulla esse in",
"aliquip",
"occaecat dolor et elit cillum",
"et nisi deserunt ullamco dolor",
"ut magna Duis fugiat minim"
],
"city": "in id Excepteur anim Duis",
"country": "Ut ullamco irure enim",
"email": "irure qui",
"first_name": "elit minim voluptate",
"last_name": "ad deserunt nulla esse",
"postal_code": "eiusmod",
"state_province_region": "incididunt ess",
"custom_fields": {
"w1": "2002-10-02T15:00:00Z",
"w33": 9.5,
"e2": "Coffee is a beverage that puts one to sleep when not drank."
}
},
{
"address_line_1": "magna non commodo",
"address_line_2": "Excepteur",
"alternate_emails": [
"elit aliqua tempor non incididunt",
"dolor pariatur id commo",
"moll",
"tempor veniam ex",
"anim L"
],
"city": "veniam Ut esse labore es",
"country": "amet adipisicing commod",
"email": "mollit aliqua nulla sed",
"first_name": "mo",
"last_name": "sint id labore",
"postal_code": "consectetur ea adipisicing commodo dolor",
"state_province_region": "officia enim",
"custom_fields": {
"w1": "2002-10-02T15:00:00Z",
"w33": 9.5,
"e2": "Coffee is a beverage that puts one to sleep when not drank."
}
},
{
"address_line_1": "amet",
"address_line_2": "laboris tempor",
"alternate_emails": [
"sunt sed ad reprehenderit",
"sed mollit elit eu",
"dolore officia do sint id",
"non in nostrud laborum sint",
"dolore labore"
],
"city": "adipisic",
"country": "magna occaecat tempor",
"email": "reprehende",
"first_name": "nisi do cillum deserunt",
"last_name": "cupi",
"postal_code": "proident dolore fugiat deserunt tempor",
"state_province_region": "dolore nulla fugiat minim",
"custom_fields": {
"w1": "2002-10-02T15:00:00Z",
"w33": 9.5,
"e2": "Coffee is a beverage that puts one to sleep when not drank."
}
}
]
}{
"job_id": "irure nulla"
}{
"errors": [
{
"message": "consectetur",
"field": "ut",
"error_id": "nulla",
"parameter": "Lorem sed"
},
{
"message": "Duis aliquip",
"field": "consectetur Ut exercitation deserunt",
"error_id": "veniam sit commodo",
"parameter": "eu ut dolore ullamco dolore"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "aute irure"
},
{
"message": "ex deserunt nostrud non"
},
{
"message": "quis aliquip"
},
{
"message": "aute"
},
{
"message": "in Lorem"
}
]
}DELETE
| Query Parameter Name | Example |
|---|---|
delete_all_contacts | anim nisi esse eiusmod |
ids | elit Lorem in magna dolore |
{
"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": "dolore sed"
}
]
}GET
{
"result": [
{
"id": "voluptate aliquip consectetur proident Duis",
"first_name": "aliqua",
"last_name": "Ut",
"unique_name": "consectetur dolor veniam",
"email": "cupidatat incididunt pariatur sunt",
"alternate_emails": [
"eu aute est ut",
"consequat dolor"
],
"address_line_1": "incididunt aliqua irure",
"address_line_2": "mollit ad exercitation",
"city": "veniam sunt cupidatat",
"state_province_region": "do anim sit culpa",
"country": "incididunt",
"postal_code": "Duis deserunt",
"phone_number": "et culpa eu incididunt",
"whatsapp": "et sunt irure",
"line": "adipisicing",
"facebook": "id pariatur elit sed amet",
"list_ids": [
"Ut esse",
"laborum"
],
"segment_ids": [
"ea laboris non",
"ullamco id sed",
"fugiat eiusmod",
"nisi aute irure"
],
"custom_fields": {},
"created_at": "ut enim reprehenderit minim consequat",
"updated_at": "consectetur Excepteur",
"_metadata": {
"self": "ut laboris"
}
},
{
"id": "anim",
"first_name": "in minim",
"last_name": "irure nostrud culpa dolore eu",
"unique_name": "in esse id ex",
"email": "id",
"alternate_emails": [
"ut",
"et reprehenderit"
],
"address_line_1": "elit sunt",
"address_line_2": "non dolore occaecat",
"city": "non irure amet ex",
"state_province_region": "sint",
"country": "cillum ut elit",
"postal_code": "aute sint",
"phone_number": "sit elit Duis aute magna",
"whatsapp": "consectetur fugiat dolore",
"line": "amet Ut velit",
"facebook": "sed labore Ut et aliquip",
"list_ids": [
"nulla dolor Excepteur sit exercitation",
"eiusmod id",
"est",
"consectetur nostrud quis"
],
"segment_ids": [
"sed irure minim eu",
"do culpa dolore",
"dolore",
"Excepteur ipsum id"
],
"custom_fields": {},
"created_at": "dolore velit ex",
"updated_at": "dolor aliquip nostrud deserunt",
"_metadata": {
"self": "esse dolore"
}
}
],
"_metadata": {
"self": "consectetur fugiat incididunt"
},
"contact_count": 28836749
}{
"errors": [
{
"message": "sit deserunt sint",
"field": "ad aliquip nostrud velit exercitation",
"error_id": "do irure",
"parameter": "sit"
},
{
"message": "elit",
"field": "laborum reprehenderit Ut",
"error_id": "cupidatat cillum ex",
"parameter": "qui"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{}{
"errors": [
{
"message": "ullamco ea enim"
},
{
"message": "ea cupidatat"
},
{
"message": "Lorem et dolor amet reprehenderit"
},
{
"message": "pariatur"
},
{
"message": "ut"
}
]
}GET
{
"contact_count": -99916787,
"billable_count": 28067886,
"billable_breakdown": {
"total": 90607018,
"breakdown": {}
}
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "Ut nulla"
},
{
"message": "sunt dolor"
}
]
}POST
{
"list_ids": [
"01a67c94-b6c4-d230-26d1-724f32751875",
"bf7ae85e-6106-121c-2ec3-f759bb78ccd3"
],
"segment_ids": [
"Duis Lorem",
"irure",
"anim sunt"
],
"notifications": {
"email": false
},
"file_type": "csv",
"max_file_size": 22862622
}{
"_metadata": {
"prev": "http://vcFFGKbaIzQKVNqbOGmapGTHgYCu.xjAqMjLGp7qiE+8tAwyjRSyllmkKUJuETnX8ukhQCxaNX9nXhpH7jpJrRPbnHqv9te8JbF",
"self": "http://YujCzBLIeXIYQAhMPIqOoFIKDYccPv.fknkdwel37+8L5Dr-HaIW5HxWbT0",
"next": "https://cROeoXPl.bcizQeLr.ueMA8VBw",
"count": 71205221.13076574
},
"id": "est sit occaecat ex nulla"
}{
"errors": [
{
"message": "nulla",
"field": "commodo",
"error_id": "in",
"parameter": "officia ad"
},
{
"message": "laboris",
"field": "laborum minim sint",
"error_id": "esse velit dolor",
"parameter": "Ut"
},
{
"message": "dolore anim eu",
"field": "Duis officia ipsum Lorem et",
"error_id": "aute",
"parameter": "culpa aliquip cillum sint officia"
},
{
"message": "proident",
"field": "incididunt",
"error_id": "dolore tempor",
"parameter": "nulla ipsum"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "deserunt proident ad eu"
},
{
"message": "mollit ipsum non Lorem"
},
{
"message": "nulla proident velit dolore"
},
{
"message": "ad dolore exercitation culpa"
}
]
}GET
{
"result": [
{
"id": "anim Ut exercitation dolor aute",
"status": "et officia",
"created_at": "do ullamco dolore sit ea",
"completed_at": "fugiat cupidatat proident id nisi",
"expires_at": "consectetur",
"urls": [
"sunt sint non qui",
"ullamco ut in"
],
"user_id": "ea proident consequat",
"export_type": "aute adipisicing laboris velit in",
"segments": [
{
"ID": "ut commodo anim aute",
"Name": "ut culpa dolor do proident"
},
{
"ID": "nostrud commodo ut est",
"Name": "dolore"
},
{
"ID": "dolore",
"Name": "ea ipsum consequat"
},
{
"ID": "dolor commodo culpa elit officia",
"Name": "aute aliquip pariatur"
},
{
"ID": "nostrud ut et sint",
"Name": "Duis dolor aute in"
}
],
"lists": [
{
"ID": "incididunt dolore qui ea ex",
"Name": "sit proident consequat"
},
{
"ID": "in ullamco",
"Name": "sit occaecat dolore"
}
],
"_metadata": {
"prev": "officia in",
"self": "id pariatur in",
"next": "ullamco aliqua ut exercitation occaecat"
}
},
{
"id": "aliquip mollit ut commodo sit",
"status": "ea qui Ut",
"created_at": "reprehenderit quis voluptate dolore",
"completed_at": "sed",
"expires_at": "consectetur",
"urls": [
"deserunt cillum veniam enim ad",
"aliquip elit ut ut nulla",
"ullamco ad Lorem",
"nulla minim velit"
],
"user_id": "proident",
"export_type": "Ut deserunt",
"segments": [
{
"ID": "Ut est",
"Name": "cupidatat"
},
{
"ID": "sint enim",
"Name": "dolore adipisicing officia"
},
{
"ID": "dolor sed id anim in",
"Name": "Excepteur"
},
{
"ID": "commodo",
"Name": "dolore"
}
],
"lists": [
{
"ID": "est consectetur",
"Name": "commodo"
},
{
"ID": "irure laboris in",
"Name": "irure"
},
{
"ID": "ad",
"Name": "proident labore anim eu"
},
{
"ID": "commodo ullamco adipisicing",
"Name": "elit nulla Lorem"
},
{
"ID": "mollit id",
"Name": "sed"
}
],
"_metadata": {
"prev": "in ut dolor voluptate sint",
"self": "sint exercitation laboris",
"next": "quis aute magna"
}
}
],
"_metadata": {
"prev": "ut",
"self": "officia in elit aute",
"next": "dolor incididunt"
}
}{
"errors": [
{
"message": "officia ut proident mollit",
"": "voluptate",
"error_id": "esse enim dolor"
},
{
"message": "qui dolore aute",
"": "ea consequat et Excepteur dolore",
"error_id": "tempor"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "dolor sunt eu laboris"
},
{
"message": "exercitation eu veniam laborum ipsum"
},
{
"message": "in"
}
]
}GET
{
"id": "dolor irure eu dolore elit",
"first_name": "commodo Lorem",
"last_name": "esse sed exercitation",
"unique_name": "culpa sint ipsum",
"email": "culpa reprehenderit dolore quis laborum",
"alternate_emails": [
"et",
"id ut culpa reprehenderit magna"
],
"address_line_1": "proident",
"address_line_2": "in eu in mollit dolore",
"city": "ad veniam officia dolore",
"state_province_region": "nulla",
"country": "ea dolore minim voluptate",
"postal_code": "pariatur non",
"phone_number": "ut",
"whatsapp": "culpa Ut dolor eiusmod ut",
"line": "proident cillum exercitation dolore velit",
"facebook": "voluptate id",
"list_ids": [
"esse magna eiusmod",
"minim voluptate do"
],
"segment_ids": [
"ea pariatur",
"Excepteur incididunt Lorem fugiat",
"in sunt"
],
"custom_fields": {},
"created_at": "Excepteur exercitation reprehenderit",
"updated_at": "commodo pariatur culpa anim",
"_metadata": {
"self": "do"
}
}{
"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": "cupidatat"
},
{
"message": "aliquip proident ipsum"
},
{
"message": "eiusmod irure"
},
{
"message": "magna anim"
}
]
}POST
{
"query": "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')"
}{
"result": [
{
"id": "sint dolor laboris qui aliquip",
"first_name": "officia consectetur ut occaecat",
"last_name": "in",
"unique_name": "proident ex aliqua laboris sint",
"email": "laboris",
"alternate_emails": [
"irure nisi",
"ipsum ut Lorem in"
],
"address_line_1": "sit non irure nostrud",
"address_line_2": "voluptate Lorem",
"city": "sint",
"state_province_region": "magna aute",
"country": "dolore amet",
"postal_code": "elit id dolor exercitation",
"phone_number": "do voluptate ut sunt",
"whatsapp": "Ut laboris aliquip dolor",
"line": "pariatur",
"facebook": "in amet esse anim officia",
"list_ids": [
"ad",
"in irure aliqua elit est",
"amet Lorem sit",
"et"
],
"segment_ids": [
"sit adipisicing exercitation enim"
],
"custom_fields": {},
"created_at": "eu",
"updated_at": "eu in ea nostrud Ut",
"_metadata": {
"self": "ex"
}
}
],
"_metadata": {
"self": "ad sint Excepteur dolor"
},
"contact_count": 92176442.4974285
}{
"errors": [
{
"field": "enim reprehenderit ut nostrud sed",
"message": "dolore ut"
},
{
"field": "qui elit culpa occaecat",
"message": "deserunt est"
},
{
"field": "aute velit officia",
"message": "do"
},
{
"field": "in",
"message": "sint elit nulla"
}
]
}{
"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": "aliqua tempor commodo"
},
{
"message": "occaecat ea ut laboris enim"
},
{
"message": "in id"
},
{
"message": "irure ex"
}
]
}PUT
{
"list_ids": [
"anim laboris consectetur velit",
"amet fugiat id"
],
"file_type": "csv",
"field_mappings": [
"irure consectetur",
"sed eu ut non consectetur",
"id",
"eu in"
]
}{
"job_id": "dolor elit cillum fugiat voluptate",
"upload_uri": "laborum culpa ut",
"upload_headers": [
{
"header": "sed laborum ut sit sunt",
"value": "dolore in non officia incididunt"
},
{
"header": "quis sunt in enim non",
"value": "deserunt"
},
{
"header": "reprehenderit",
"value": "nisi fugiat tempor irure"
},
{
"header": "sint culpa ullamco",
"value": "officia quis in Excepteur"
},
{
"header": "sit pariatur",
"value": "Duis Ut Excepteur commodo"
}
]
}{
"errors": [
{
"message": "in aliquip in velit",
"field": "nostrud aliqua",
"error_id": "minim aute et anim",
"parameter": "commodo sint"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "commodo Duis",
"field": "culpa et irure commodo",
"error_id": "commodo eu",
"parameter": "sed ipsum irure cupidatat do"
},
{
"message": "nostrud incididunt dolor",
"field": "ut in pariatur laborum ullamco",
"error_id": "ut occaecat irure minim esse",
"parameter": "proident dolore"
},
{
"message": "dolor officia incididunt nisi cupidatat",
"field": "id culpa in",
"error_id": "in incididunt qui Duis",
"parameter": "Excepteur laborum ut"
},
{
"message": "aute consequat eu commodo",
"field": "cupidatat reprehenderit sunt",
"error_id": "eiusmod sed consectetur",
"parameter": "Ut ut in tempor"
},
{
"message": "minim",
"field": "sed sit amet incididunt",
"error_id": "pariatur dolor proident nisi",
"parameter": "non"
}
]
}{
"errors": [
{
"message": "in Duis laborum"
},
{
"message": "et sint ipsum"
}
]
}GET
{
"id": "sed consectetur in cupidatat ex",
"status": "enim",
"job_type": "dolor pariatur officia proident",
"results": {
"requested_count": 97104930.92194015,
"created_count": -46142357.801831,
"updated_count": -47598123.95491601,
"deleted_count": -33791987.28505233,
"errored_count": -67828339.47726074,
"errors_url": "nulla aliquip magna occaecat"
},
"started_at": "sed adipisicing irure tempor",
"finished_at": "veniam Excepteur minim amet Ut"
}{
"errors": {
"message": "dolore fugiat proident officia",
"field": "anim",
"error_id": "nisi est minim culpa",
"parameter": "ad nisi"
}
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "adipisicing"
},
{
"message": "ad consequat"
},
{
"message": "mollit"
}
]
}GET
{
"id": "dolore commodo ut consequat nulla",
"status": "ready",
"created_at": "ullamco mollit eu in",
"updated_at": "dolore",
"completed_at": "in reprehenderit in non",
"expires_at": "dolor labore Ut in ullamco",
"urls": [
"proident",
"in deserunt velit anim occaecat",
"exercitation",
"dolor eu",
"pariatur"
],
"message": "aute elit laboris",
"_metadata": {
"prev": "http://znrOja.idEyPGXK6uHVrGkdXWf5Oz71lKB6p2vjiabFMLeZ.7rMaawQzwv3QIMQGWrFWJFXu",
"self": "http://ukqxLoA.ngrLs0Y5tZ.3SORhHKaWJpfsxeHI.7mKdjfJAafSXQBlkXaYwe9s9O2mReP19k9.Nz",
"next": "https://gJrCHeqCGhhUOaZvy.misgLCE.-Gqs+EcYlECjo6k79VStUUYbz",
"count": -1807867.285987407
},
"contact_count": -19900910
}{
"errors": [
{
"message": "ullamco voluptate",
"field": "veniam Duis laborum do",
"error_id": "enim",
"parameter": "eu"
},
{
"message": "ipsum officia non",
"field": "esse elit laborum anim",
"error_id": "sit sunt id",
"parameter": "culpa sint esse ad"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "amet reprehenderit ea"
}
]
}POST
{
"ids": [
"1234",
"1235"
]
}{
"result": [
{
"id": "aute cillum nostrud Ut dolore",
"first_name": "pariatur commodo ut qui aliquip",
"last_name": "labore",
"unique_name": "aliqua id Excepteur ad",
"email": "sit",
"alternate_emails": [
"laboris Ut ullamco",
"enim irure incididunt in"
],
"address_line_1": "dolor Excepteur",
"address_line_2": "voluptate dolor veniam incididunt occaecat",
"city": "Excepteur sint",
"state_province_region": "aliqua et voluptate",
"country": "do ipsum reprehenderit nostrud",
"postal_code": "incididunt commodo voluptate laboris",
"phone_number": "aliqua",
"whatsapp": "in",
"line": "sunt sed",
"facebook": "officia ipsum",
"list_ids": [
"eiusmod nulla",
"nisi deserunt minim dolor Excepteur"
],
"segment_ids": [
"labore",
"nulla",
"Duis aliquip",
"ex ad ea dolore ut",
"sint qui est reprehenderit"
],
"custom_fields": {},
"created_at": "nulla enim",
"updated_at": "non commodo",
"_metadata": {
"self": "elit exercitation aute ad veniam"
}
},
{
"id": "pariatur",
"first_name": "ut nostrud ad",
"last_name": "laborum Excepteur",
"unique_name": "reprehenderit",
"email": "ea",
"alternate_emails": [
"dolor nulla ut enim aliquip",
"laboris dolor esse",
"ea",
"Ut eu dolor mollit"
],
"address_line_1": "in eu qui cillum",
"address_line_2": "Excepteur",
"city": "dolore consectetur",
"state_province_region": "nisi occaecat",
"country": "dolor voluptate Ut anim ut",
"postal_code": "id nisi magna Duis",
"phone_number": "velit aute est",
"whatsapp": "Excepteur dolore occaecat",
"line": "culpa sint",
"facebook": "culpa in ut",
"list_ids": [
"est deserunt"
],
"segment_ids": [
"quis cupidatat ut incididunt",
"esse fugiat"
],
"custom_fields": {},
"created_at": "incididunt dolore qui eiusmod",
"updated_at": "veniam",
"_metadata": {
"self": "eiusmod proident sint ut"
}
},
{
"id": "ut labore veniam sed",
"first_name": "tempor",
"last_name": "anim",
"unique_name": "in culpa",
"email": "elit occaecat ad do est",
"alternate_emails": [
"in laborum elit laboris",
"ut",
"est"
],
"address_line_1": "laborum dolor Ut",
"address_line_2": "voluptate veniam",
"city": "id",
"state_province_region": "nulla Lorem",
"country": "sed consectetur Ut veniam",
"postal_code": "Excepteur eiusmod fugiat officia sunt",
"phone_number": "dolore ea",
"whatsapp": "non quis",
"line": "proident ut exercitation Excepteur",
"facebook": "in",
"list_ids": [
"nisi quis amet in",
"nulla",
"ut"
],
"segment_ids": [
"voluptate commodo ad veniam",
"commodo",
"laboris consequat dolore occaecat"
],
"custom_fields": {},
"created_at": "amet nisi",
"updated_at": "do irure deserunt veniam dolor",
"_metadata": {
"self": "aute"
}
},
{
"id": "et dolore Lorem",
"first_name": "nisi officia pariatur",
"last_name": "et do",
"unique_name": "magna nisi",
"email": "et occaecat ut culpa veniam",
"alternate_emails": [
"ex ut amet",
"incididunt sed labore dolore sint",
"velit magna laborum"
],
"address_line_1": "velit do Ut sed",
"address_line_2": "commodo ipsum dolore",
"city": "aliquip",
"state_province_region": "sed do",
"country": "nisi eiusmod amet ut laboris",
"postal_code": "eiusmod amet dolore sint mollit",
"phone_number": "exercitation adipisicing minim veniam dolor",
"whatsapp": "laboris ad Duis non",
"line": "irure Excepteur",
"facebook": "consequat id consectetur qui dolor",
"list_ids": [
"elit Duis",
"consequat labore fugiat officia Ut",
"tempor enim Lorem"
],
"segment_ids": [
"deserunt occaecat",
"irure in sunt anim occaecat"
],
"custom_fields": {},
"created_at": "veniam",
"updated_at": "aliqua occaecat sit dolor elit",
"_metadata": {
"self": "dolore sunt"
}
},
{
"id": "incididunt nostrud",
"first_name": "eiusmod in Duis",
"last_name": "quis sunt",
"unique_name": "commodo irure in sit aliquip",
"email": "ea exercitation",
"alternate_emails": [
"eu dolor",
"Duis",
"nulla",
"dolor",
"aliqua culpa commodo mollit"
],
"address_line_1": "eu",
"address_line_2": "cillum minim eiusmod",
"city": "irure ullamco magna in cillum",
"state_province_region": "consequat proident anim ea Excepteur",
"country": "laborum eu dolor",
"postal_code": "officia sunt quis aliqua dolor",
"phone_number": "ea veniam officia",
"whatsapp": "incididunt aute in velit deserunt",
"line": "laboris sed",
"facebook": "esse in irure quis",
"list_ids": [
"dolor sunt",
"tempor enim sint et",
"anim aute dolore id elit",
"sint in dolore"
],
"segment_ids": [
"ex sint magna et ullamco",
"ipsum aliqua",
"dolor aute"
],
"custom_fields": {},
"created_at": "id et aute",
"updated_at": "sunt exercitation Lorem ex in",
"_metadata": {
"self": "in officia cupidatat"
}
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{}{
"errors": [
{
"message": "laboris voluptate in reprehenderit aute"
},
{
"message": "aliquip eu sint"
},
{
"message": "in consectetur"
},
{
"message": "ullamco minim"
}
]
}POST
{
"emails": [
"jane_doe@example.com",
"john_doe@example.com",
"joann_doe@example.com"
]
}{
"result": {
"jane_doe@example.com": {
"contact": {
"address_line_1": "",
"address_line_2": "",
"alternate_emails": [
"janedoe@example1.com"
],
"city": "",
"country": "",
"email": "jane_doe@example.com",
"first_name": "Jane",
"id": "asdf-Jkl-zxCvBNm",
"last_name": "Doe",
"list_ids": [],
"segment_ids": [],
"postal_code": "",
"state_province_region": "",
"phone_number": "",
"whatsapp": "",
"line": "",
"facebook": "",
"unique_name": "",
"custom_fields": {},
"created_at": "2021-03-02T15:25:47Z",
"updated_at": "2021-03-30T15:26:16Z",
"_metadata": {
"self": "<metadata_url>"
}
}
},
"john_doe@example.com": {
"contact": {
"address_line_1": "",
"address_line_2": "",
"alternate_emails": [],
"city": "",
"country": "",
"email": "john_doe@example.com",
"first_name": "Jane",
"id": "asdf-Jkl-qWeRTy",
"last_name": "Doe",
"list_ids": [],
"segment_ids": [],
"postal_code": "",
"state_province_region": "",
"phone_number": "",
"whatsapp": "",
"line": "",
"facebook": "",
"unique_name": "",
"custom_fields": {},
"created_at": "2020-01-02T15:25:47Z",
"updated_at": "2020-12-20T15:26:16Z",
"_metadata": {
"self": "<metadata_url>"
}
}
},
"joann_doe@example.com": {
"error": "contact not found"
}
}
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "quis tempor enim aliqua"
},
{
"message": "Lorem est"
},
{
"message": "Duis ex pariatur dolor"
}
]
}Segmenting Contacts V2 - Beta(5 operations)
POST
{
"name": "fugiat voluptate laboris id",
"parent_list_ids": [
"dolor"
],
"query_dsl": "pariatur"
}{
"id": "a2926647-30e9-9d4d-d696-7cfeebae2b3f",
"name": "minim commodo eu elit adipisicing",
"query_dsl": "id",
"contacts_count": -67946576,
"contacts_sample": [
{
"id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
"email": "abcd@gmail.com",
"alternate_emails": [
"abcd@yahoo.com",
"abcd@hotmail.com"
],
"first_name": "Ab",
"last_name": "Cd",
"address_line_1": "street address / P.O. box / CompanyName / c/o",
"address_line_2": "apartment, suite, unit, building, floor etc",
"city": "Redwood City",
"state_province_region": "CA",
"postal_code": 94063,
"country": "USA",
"custom_fields": {
"custom_field_name1": "custom_field_value1",
"custom_field_name2": "custom_field_value2"
}
}
],
"created_at": "magna minim",
"updated_at": "consequat aliqua ullamco",
"sample_updated_at": "Excepteur sed",
"next_sample_update": "irure et do Lorem",
"parent_list_ids": [
"esse consequat magna Duis ipsum",
"non esse",
"laboris enim ut",
"commodo dolor ex enim",
"officia consectetur do"
],
"query_version": "amet consectetur in voluptate enim",
"status": {
"query_validation": "esse eiusmod dolore cupidatat anim",
"error_message": "ipsum aliqua"
}
}{
"errors": [
{
"field": "consequat pariatur dolore amet in",
"message": "ullamco aliqua"
},
{
"field": "dolor Ut",
"message": "in"
},
{
"field": "incididunt aliquip dolore irure",
"message": "qui"
},
{
"field": "ad aute",
"message": "nostrud laborum nulla"
}
]
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"field": "dolore aute",
"message": "quis occaecat irure"
},
{
"field": "do veniam qui",
"message": "in"
},
{
"field": "nulla exercitation officia ad irure",
"message": "ut minim aute"
},
{
"field": "qui Ut ad do exercitation",
"message": "dolore"
},
{
"field": "nostrud id",
"message": "sint irure sit ex commodo"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
parent_list_ids | laboris nisi minim amet |
no_parent_list_id | true |
{
"id": "a88e44c8-502f-1a03-d6a1-b61cc8ad3f79",
"name": "voluptate elit laborum culpa",
"contacts_count": -69344335,
"created_at": "non quis consectetur",
"updated_at": "consequat dolor ex",
"sample_updated_at": "aliqua in velit",
"next_sample_update": "reprehenderit commodo adipisicing Duis",
"parent_list_ids": [
"eu Ut fugiat voluptate",
"tempor reprehenderit dolor occaecat consequat",
"deserunt dolor eiusmod voluptate ex",
"amet in"
],
"query_version": "Excepteur",
"_metadata": {
"prev": "http://XFethtjNiU.mxuWRE7k.C42S4mWKKzRAtTodK+ugw2XtGAj9uaNx35",
"self": "https://wpLCcXyTSpmqqlYnEAZyUsGYYsgVDXA.ksuqad+dWXgY6yQ",
"next": "https://dWBNAIuRvuXUHRMToKeDFQQnEeeJ.zeZGqOc326A.Y6A7dwkml0Ht89nBL.rP0jscRyF,wLd,+52Rx.QKa2XHR9gry7kDRmICvwDYdsebmbdXff.y+MWqADAO",
"count": 58277266
},
"status": {
"query_validation": "proident tempor incididunt cupidatat occaecat",
"error_message": "occaecat incididunt eiusmod velit irure"
}
}{
"errors": [
{
"field": "aute",
"message": "labore ut sit laborum"
}
]
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"field": "dolor mollit pariatur",
"message": "in"
},
{
"field": "ullamco",
"message": "proident laborum officia qui"
},
{
"field": "labore Excepteur ullamco dolor et",
"message": "anim incididunt"
}
]
}PATCH
{
"name": "nisi",
"query_dsl": "aliquip exercitation et dolore tempor"
}{
"id": "797ca729-f0f0-487e-0c8a-80f493be5b33",
"name": "vel",
"query_dsl": "proident",
"contacts_count": 2340259,
"contacts_sample": [
{
"id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
"email": "abcd@gmail.com",
"alternate_emails": [
"abcd@yahoo.com",
"abcd@hotmail.com"
],
"first_name": "Ab",
"last_name": "Cd",
"address_line_1": "street address / P.O. box / CompanyName / c/o",
"address_line_2": "apartment, suite, unit, building, floor etc",
"city": "Redwood City",
"state_province_region": "CA",
"postal_code": 94063,
"country": "USA",
"custom_fields": {
"custom_field_name1": "custom_field_value1",
"custom_field_name2": "custom_field_value2"
}
},
{
"id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
"email": "abcd@gmail.com",
"alternate_emails": [
"abcd@yahoo.com",
"abcd@hotmail.com"
],
"first_name": "Ab",
"last_name": "Cd",
"address_line_1": "street address / P.O. box / CompanyName / c/o",
"address_line_2": "apartment, suite, unit, building, floor etc",
"city": "Redwood City",
"state_province_region": "CA",
"postal_code": 94063,
"country": "USA",
"custom_fields": {
"custom_field_name1": "custom_field_value1",
"custom_field_name2": "custom_field_value2"
}
}
],
"created_at": "elit pariatur eu deserunt in",
"updated_at": "elit reprehenderit qui Lorem consectetur",
"sample_updated_at": "enim deserunt",
"next_sample_update": "dolore consequat proident sed dolore",
"parent_list_ids": [
"sit in quis enim incididunt",
"commodo tempor aliqua",
"magna",
"aliquip"
],
"query_version": "Duis dolor esse labore",
"status": {
"query_validation": "dolore",
"error_message": "quis"
}
}{
"errors": [
{
"field": "do Duis laborum in",
"message": "aliqua ea"
},
{
"field": "magna ut id",
"message": "mollit ut quis minim"
},
{
"field": "ipsum mollit ea",
"message": "consectetur commodo deserunt laborum"
},
{
"field": "ex voluptate eiusmod id qui",
"message": "proident esse"
},
{
"field": "culpa",
"message": "commodo consectetur"
}
]
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"field": "amet ut",
"message": "aute officia et Lorem deserunt"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
contacts_sample | false |
{
"id": "3278987d-72bb-b007-201d-257feae355aa",
"name": "velit dolor eiusmod irure dolore",
"query_dsl": "ea",
"contacts_count": 27704820,
"contacts_sample": [
{
"id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
"email": "abcd@gmail.com",
"alternate_emails": [
"abcd@yahoo.com",
"abcd@hotmail.com"
],
"first_name": "Ab",
"last_name": "Cd",
"address_line_1": "street address / P.O. box / CompanyName / c/o",
"address_line_2": "apartment, suite, unit, building, floor etc",
"city": "Redwood City",
"state_province_region": "CA",
"postal_code": 94063,
"country": "USA",
"custom_fields": {
"custom_field_name1": "custom_field_value1",
"custom_field_name2": "custom_field_value2"
}
},
{
"id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
"email": "abcd@gmail.com",
"alternate_emails": [
"abcd@yahoo.com",
"abcd@hotmail.com"
],
"first_name": "Ab",
"last_name": "Cd",
"address_line_1": "street address / P.O. box / CompanyName / c/o",
"address_line_2": "apartment, suite, unit, building, floor etc",
"city": "Redwood City",
"state_province_region": "CA",
"postal_code": 94063,
"country": "USA",
"custom_fields": {
"custom_field_name1": "custom_field_value1",
"custom_field_name2": "custom_field_value2"
}
},
{
"id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
"email": "abcd@gmail.com",
"alternate_emails": [
"abcd@yahoo.com",
"abcd@hotmail.com"
],
"first_name": "Ab",
"last_name": "Cd",
"address_line_1": "street address / P.O. box / CompanyName / c/o",
"address_line_2": "apartment, suite, unit, building, floor etc",
"city": "Redwood City",
"state_province_region": "CA",
"postal_code": 94063,
"country": "USA",
"custom_fields": {
"custom_field_name1": "custom_field_value1",
"custom_field_name2": "custom_field_value2"
}
}
],
"created_at": "officia deserunt in tempor",
"updated_at": "amet",
"sample_updated_at": "enim ullamco culpa dolore magna",
"next_sample_update": "reprehenderit minim sed et",
"parent_list_ids": [
"minim anim in irure incididunt",
"adipisicing",
"Excepteur officia non reprehenderit",
"Excepteur do",
"dolor esse cupidatat sint"
],
"query_version": "tempor aliquip fugiat",
"status": {
"query_validation": "sunt",
"error_message": "Ut cupidatat tempor"
}
}{
"errors": [
{
"field": "consectetur sunt aliquip minim non",
"message": "nulla eu"
}
]
}{
"errors": [
{
"field": "sed qui mollit reprehenderit ea",
"message": "consectetur id laboris eu"
}
]
}DELETE
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"field": "exercitation minim amet aliquip dolor",
"message": "cillum culpa"
},
{
"field": "amet ex",
"message": "in laborum eu ut"
}
]
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"field": "tempor nisi cupidatat eiusmod",
"message": "amet"
},
{
"field": "cupidatat culpa et",
"message": "in"
},
{
"field": "et",
"message": "nulla sit cupidatat ex"
}
]
}Senders
POST
| Header Name | Example |
|---|---|
on-behalf-of | "est commodo" |
{
"nickname": "Example Orders",
"from": {
"email": "orders@example.com",
"name": "Example Orders"
},
"reply_to": {
"email": "support@example.com",
"name": "Example Support"
},
"address": "1234 Fake St.",
"address_2": "",
"city": "San Francisco",
"state": "CA",
"zip": "94105",
"country": "United States"
}{
"id": 1,
"nickname": "My Sender ID",
"from": {
"email": "from@example.com",
"name": "Example INC"
},
"reply_to": {
"email": "replyto@example.com",
"name": "Example INC"
},
"address": "123 Elm St.",
"address_2": "Apt. 456",
"city": "Denver",
"state": "Colorado",
"zip": "80202",
"country": "United States",
"verified": true,
"updated_at": 1449872165,
"created_at": 1449872165,
"locked": false
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "aliqua quis magna id"
},
{
"message": "tempor culpa esse aliqua ut"
},
{
"message": "eu"
}
]
}Lists(7 operations)
POST
{
"name": "list-name"
}{
"id": "ca7a3796-e8a8-4029-9ccb-df8937940562",
"name": "list-name",
"contact_count": 0,
"_metadata": {
"self": "https://api.sendgrid.com/v3/marketing/lists/ca7a3796-e8a8-4029-9ccb-df8937940562"
}
}{
"errors": [
{
"message": "nostrud elit magna labore",
"field": "commodo cupidatat reprehenderit veniam",
"error_id": "consequat officia velit nisi",
"parameter": "ullamco"
},
{
"message": "qui consequat in",
"field": "consectetur labore cillum",
"error_id": "veniam",
"parameter": "incididunt ullamco sit magna"
},
{
"message": "qui",
"field": "tempor magna eiusmod eu",
"error_id": "ut",
"parameter": "voluptate consequat elit"
},
{
"message": "amet",
"field": "proident",
"error_id": "non incididunt nisi",
"parameter": "veniam aliquip"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
page_size | 599.4823355122714 |
page_token | cupidatat |
{
"result": [
{
"id": "abc12312-x3y4-1234-abcd-123qwe456rty",
"name": "list-name",
"contact_count": 0,
"_metadata": {
"self": "https://api.sendgrid.com/v3/marketing/lists/abc12312-x3y4-1234-abcd-123qwe456rty"
}
}
],
"_metadata": {
"self": "https://api.sendgrid.com/v3/marketing/lists?page_size=100&page_token="
}
}GET
{
"contact_count": 0,
"billable_count:": 0
}{}GET
| Query Parameter Name | Example |
|---|---|
contact_sample | true |
{
"contact_count": 2,
"contact_sample": {
"id": "c3445f88-5c69-4237-86e6-9ec9de958050",
"list_ids": [
"199abb98-0af3-4a8d-b371-6811ff85d062"
],
"created_at": "2620-06-16T17:03:54.867Z",
"updated_at": "4780-12-06T06:51:30.024Z"
},
"_metadata": {
"self": "https://api.sendgrid.com/v3/marketing/lists/199abb98-0af3-4a8d-b371-6811ff85d062"
},
"id": "199abb98-0af3-4a8d-b371-6811ff85d062",
"name": "list-name"
}[
{
"message": "dolore labore esse",
"field": "reprehenderit est cillum",
"error_id": "minim",
"parameter": "ex amet enim dolore"
},
{
"message": "dolore mollit",
"field": "enim Excepteur veniam",
"error_id": "ipsum sint",
"parameter": "dolor deserunt aute commodo laborum"
}
]PATCH
{
"name": "updated-list-name"
}{
"id": "abc12312-x3y4-1234-abcd-123qwe456rty",
"name": "updated-list-name",
"contact_count": 0,
"_metadata": {
"self": "https://api.sendgrid.com/v3/marketing/lists/abc12312-x3y4-1234-abcd-123qwe456rty"
}
}{
"errors": [
{
"message": "dolore",
"field": "veniam",
"error_id": "cillum aute sunt ipsum",
"parameter": "Ut dolor nostrud occaecat adipisicing"
},
{
"message": "non qui dolore ex eiusmod",
"field": "non Ut ex dolore",
"error_id": "nulla ea mollit pariatur",
"parameter": "id aliqua"
},
{
"message": "fugiat esse ea labore",
"field": "consequat sunt",
"error_id": "nostrud aliqua sed ipsum labore",
"parameter": "nostrud"
}
]
}{}DELETE
| Query Parameter Name | Example |
|---|---|
delete_contacts | false |
{
"job_id": "abc12312-x3y4-1234-abcd-123qwe456rty"
}et{
"errors": []
}DELETE
| Query Parameter Name | Example |
|---|---|
contact_ids* | magna nostrud |
{
"job_id": "voluptate amet sint in ullamco"
}{
"message": "aute laborum in mollit",
"field": "esse consectetur",
"error_id": "eiusmod eu qui voluptate ipsum",
"parameter": "veniam dolor ea tempor"
}{
"description": "If the specified list id does not exist. If the specified contact does not exist."
}Custom Fields(4 operations)
POST
{
"name": "custom_field_name",
"field_type": "Text"
}{
"id": "a1_T",
"name": "custom_field_name",
"field_type": "Text",
"_metadata": {
"self": "https://api.sendgrid.com/v3/marketing/field_definitions/a1_B"
}
}{
"errors": [
{
"message": "dolore aliquip quis eu",
"field": "in",
"error_id": "laboris esse laborum qui consequat",
"parameter": "ea"
},
{
"message": "do laboris ipsum exercitation Lorem",
"field": "Duis minim aliquip",
"error_id": "eu ad",
"parameter": "deserunt laborum velit dolor ullamco"
},
{
"message": "ea adipisicing anim dolore aute",
"field": "dolore irure",
"error_id": "amet est cillum",
"parameter": "cillum veniam sint in"
},
{
"message": "pariatur dolor Lorem officia dolore",
"field": "nostrud fugiat qui cillum non",
"error_id": "laboris do aliqua",
"parameter": "in voluptate dolore"
},
{
"message": "amet est",
"field": "exercitation ex occaecat voluptate anim",
"error_id": "anim occaecat aute mollit",
"parameter": "qui do nulla"
}
]
}GET
{
"custom_fields": [
{
"id": "w1",
"name": "num_orders",
"field_type": "Number"
},
{
"id": "w2",
"name": "dob",
"field_type": "Date"
}
],
"reserved_fields": [
{
"id": "_rf0_T",
"name": "first_name",
"field_type": "Text"
},
{
"id": "_rf1_T",
"name": "last_name",
"field_type": "Text"
},
{
"id": "_rf2_T",
"name": "email",
"field_type": "Text"
},
{
"id": "_rf3_T",
"name": "alternate_emails",
"field_type": "Text"
},
{
"id": "_rf4_T",
"name": "address_line_1",
"field_type": "Text"
},
{
"id": "_rf5_T",
"name": "address_line_2",
"field_type": "Text"
},
{
"id": "_rf6_T",
"name": "city",
"field_type": "Text"
},
{
"id": "_rf7_T",
"name": "state_province_region",
"field_type": "Text"
},
{
"id": "_rf8_T",
"name": "postal_code",
"field_type": "Text"
},
{
"id": "_rf9_T",
"name": "country",
"field_type": "Text"
},
{
"id": "_rf10_T",
"name": "phone_number",
"field_type": "Text"
},
{
"id": "_rf11_T",
"name": "whatsapp",
"field_type": "Text"
},
{
"id": "_rf12_T",
"name": "line",
"field_type": "Text"
},
{
"id": "_rf13_T",
"name": "facebook",
"field_type": "Text"
},
{
"id": "_rf14_T",
"name": "unique_name",
"field_type": "Text"
},
{
"id": "_rf15_T",
"name": "email_domains",
"field_type": "Text",
"read_only": true
},
{
"id": "_rf16_D",
"name": "last_clicked",
"field_type": "Date",
"read_only": true
},
{
"id": "_rf17_D",
"name": "last_opened",
"field_type": "Date",
"read_only": true
},
{
"id": "_rf18_D",
"name": "last_emailed",
"field_type": "Date",
"read_only": true
},
{
"id": "_rf19_T",
"name": "singlesend_id",
"field_type": "Text",
"read_only": true
},
{
"id": "_rf20_T",
"name": "automation_id",
"field_type": "Text",
"read_only": true
},
{
"id": "_rf21_D",
"name": "created_at",
"field_type": "Date",
"read_only": true
},
{
"id": "_rf22_D",
"name": "updated_at",
"field_type": "Date",
"read_only": true
},
{
"id": "_rf23_T",
"name": "contact_id",
"field_type": "Text",
"read_only": true
}
],
"_metadata": {
"self": "https://example.com/marketing/field_definitions"
}
}PATCH
{
"name": "new_custom_field_name"
}{
"id": "a1_T",
"name": "custom_field_name",
"field_type": "Text",
"_metadata": {
"self": "https://api.sendgrid.com/v3/marketing/field_definitions/a1_B"
}
}{
"errors": [
{
"message": "sint anim occaecat et",
"field": "qui do enim tempor dolor",
"error_id": "nulla ad",
"parameter": "pariatur"
},
{
"message": "elit pariatur ipsum in",
"field": "do consectetur in",
"error_id": "culpa",
"parameter": "officia"
},
{
"message": "occaecat",
"field": "proident elit labore",
"error_id": "incididunt pariatur cillum",
"parameter": "nostrud exercitation"
},
{
"message": "cillum deserunt eiusmod in nulla",
"field": "minim tempor fugiat Excepteur",
"error_id": "magna in proident sunt",
"parameter": "cupidatat ad minim amet"
},
{
"message": "sit ut eu",
"field": "in ullamco",
"error_id": "exercitation elit id in in",
"parameter": "enim"
}
]
}{
"errors": [
{
"message": "ipsum",
"field": "mollit",
"error_id": "dolore esse",
"parameter": "non aliquip magna qui"
}
]
}DELETE
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"message": "in esse dolore",
"field": "pariatur",
"error_id": "sed eiusmod",
"parameter": "ad"
},
{
"message": "veniam amet laborum adipisicing",
"field": "elit exercitation Lorem et tempor",
"error_id": "elit culpa velit ullamco consequat",
"parameter": "Lorem aute Duis esse"
},
{
"message": "officia consectetur",
"field": "ut in officia deserunt sed",
"error_id": "laborum proident",
"parameter": "sunt dolore mollit irure"
},
{
"message": "ad",
"field": "exercitation aliqua anim id tempor",
"error_id": "eiusmod qui sint cupidatat",
"parameter": "minim"
}
]
}segmenting contacts(5 operations)
POST
{
"name": "ea ullamco ut laborum in",
"parent_list_ids": [
"commodo dolor et",
"exercitation",
"est cupidatat elit",
"do irure officia in"
],
"query_dsl": "cillum ea laborum aliquip",
"parent_list_id": "401da6da-cc48-565c-c638-9b877ea0d15c"
}{
"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": "sint ad ipsum laborum Lorem"
},
{
"message": "do sed elit"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
parent_list_ids | quis irure in voluptate |
no_parent_list_id | false |
{
"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": "dolor Ut sunt proident"
},
{
"message": "aliquip"
},
{
"message": "fugiat ipsum in in sint"
},
{
"message": "minim"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
query_json | true |
{
"id": "3b049926-0a54-4a91-83f0-086ace63c530",
"contacts_count": -83213117,
"created_at": "voluptate sunt non fugiat",
"sample_updated_at": "labore occaecat sunt enim",
"updated_at": "sunt aliqui",
"contacts_sample": [
{
"contact_id": "e70eac25-1431-4231-bccd-1cfab432301e",
"primary_email": "KLTF@SurgGzlAxCPOqhOUHYNBLsfpfE.trh",
"alternate_emails": [
"dTeJZgU5uN9UYSo@nfIB.ijxg"
],
"first_name": "ullamco esse culpa do",
"last_name": "officia laboris veniam consequat",
"address_line_1": "in occaecat labore est tempor",
"address_line_2": "magna adipisicing",
"city": "ƞó",
"state_province_region": "culpa ut",
"postal_code": -75218567,
"country": "voluptate in in reprehenderit aliquip",
"custom_fields": {
"custom_field_name1": "amet deserunt mollit",
"custom_field_name2": "minim consequat id"
}
},
{
"contact_id": "db637d33-bce1-462c-ae9c-91ec4f761de6",
"primary_email": "t7N5TjDmKhC0@gfdifW.ua",
"alternate_emails": [
"gQol@Xcfilli.hc",
"n4K7OdaVQh@YfsnF.ie",
"TdnvS3nMStREn@miFjGzNDCPZWhiswJNxrFnOYdUAZEpesQ.yxpu",
"xRzGDTTzzbYK@eJ.wpgb",
"iI1rOpx2ct@aZhuYGZBxJLZ.phr"
],
"first_name": "ea et eu",
"last_name": "velit Ut laborum ipsu",
"address_line_1": "labore",
"address_line_2": "non",
"city": "ĔȸąÂ¸ȠɏbɄ",
"state_province_region": "deserunt dolore",
"postal_code": -95171713,
"country": "do",
"list_ids": [
"c712288b-2300-4069-bef4-2e05b5948ec3",
"9003ef29-5eb7-4951-898b-1b102e490d6e"
]
}
],
"name": "enim et anim",
"query_dsl": "nostrud"
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "labore",
"field": "incididunt cupidatat"
},
{
"message": "nostrud ea ut ad nulla",
"field": "anim nulla"
},
{
"message": "Lorem Ut qui ut",
"field": "consequat Lorem amet sed"
},
{
"message": "dolore aliquip Excepteur elit",
"field": "dolor in velit anim"
}
]
}{
"errors": [
{
"message": "sed"
},
{
"message": "labore culpa sint proident"
}
]
}PATCH
{
"name": "nostrud culpa",
"parent_list_ids": [
"eiusmod enim Duis ipsum est",
"anim nulla occaecat",
"dolore aute"
],
"query_dsl": "velit tempor Excepteur cupidatat aliquip"
}{
"id": "5fff6250-b766-4959-a183-2e1fa565c4ce",
"contacts_count": -35493018,
"created_at": "2014-12-23T17:18:52.907Z",
"sample_updated_at": "2146-04-13T16:46:32.328Z",
"updated_at": "4389-06-21T16:59:51.403Z",
"contacts_sample": [
{
"contact_id": "4cff9fdf-1bee-44f7-95dc-a101f9ed3cfe",
"primary_email": "exmS@KIzibBSmaUUHQa.uvv",
"alternate_emails": [
"qXP-RD97fLl@oEDaUynqnNRHJHdoJAWVGXwvI.qlv",
"W0ngFWmR@WcQuSbPFVPZvLrjCFadfimFi.eqf",
"mYBC0ea5UxFI@qwO.jh",
"Nhf1OmY@KCSjTQsXYpbKrBUsQFHrnLuY.oef"
],
"first_name": "consequat nulla in",
"last_name": "irure nostrud elit eu",
"address_line_1": "deserunt cillum aliqua nostrud ullamco",
"address_line_2": "sint",
"city": "ŷ(ç",
"state_province_region": "minim",
"postal_code": 62721676,
"country": "consectetur quis voluptate",
"list_ids": [
"f9d5987d-7a01-4a66-b77e-1f08a392304b",
"b4e3b028-01d4-428b-9ef5-24bcd90fa02c",
"fedab84f-9aa5-449d-99e2-7b1361f8ee61"
]
},
{
"contact_id": "093a66b8-bca8-4d8a-b32a-091d939c1928",
"primary_email": "atNeYGC4nbF42@VOCUWuGaYr.ystm",
"alternate_emails": [
"Zs6vnQbMU@XTamDsXEGJWBMMEacOc.hitv",
"Epl@ySBrQCFJZnjggkAYLu.ppta"
],
"first_name": "est",
"last_name": "in",
"address_line_1": "culpa eu eiusmod sint",
"address_line_2": "sed velit sint",
"city": "BĊJ",
"state_province_region": "Lorem Ut aliqua elit",
"postal_code": 33736880,
"country": "in laboris Excepteur consequat",
"custom_fields": {
"custom_field_name2": "culpa Excepteur",
"custom_field_name1": "esse magna Ut"
}
},
{
"contact_id": "08939f9c-2c87-4639-bd07-16d41f90a5eb",
"primary_email": "Jx660QHClqRrC@SavQvcdRpJlLqepwoEUCm.ar",
"alternate_emails": [
"S8u@ZVGjHsXdSWtlhhad.ximc",
"GA1MN72v3uA@MPDvMUmTYjwFCsEaGnFnvVzJVqUTl.ehws"
],
"first_name": "sed eu veli",
"last_name": "aliqua sit culpa",
"address_line_1": "occaecat aute enim",
"address_line_2": "ipsum quis in",
"city": "ɌſĕĝȤ¶Ǖ",
"state_province_region": "ut nisi sed esse",
"postal_code": -66445052,
"country": "occaecat veniam"
},
{
"contact_id": "0667ed97-7b7b-44aa-a115-0301067660d7",
"primary_email": "AnoFtJq@IolRDmfj.njt",
"alternate_emails": [
"F5WhHCA3oL6Ix@wOKzwIsvHbFi.mrlc"
],
"first_name": "do mollit velit",
"last_name": "voluptate dolor",
"address_line_1": "et incididunt",
"address_line_2": "veniam quis non exercitation Duis",
"city": "DzƐȹŲdž",
"state_province_region": "occaecat",
"postal_code": -19694583,
"country": "reprehenderit",
"custom_fields": {
"custom_field_name1": "dolor aute irure Excepteur"
},
"list_ids": [
"ffd225a8-2008-4457-87af-1cffff5b1ccb"
]
},
{
"contact_id": "449767ca-d446-45f1-aa9b-432f441b5ca1",
"primary_email": "kF4@gYYdAxzetJrWszLAHuBUTu.rzq",
"alternate_emails": [
"ksqbx6BInlB@ouWBjjxwFBwVQjdnEKXy.xi",
"TAe7F2m8dFlF@SirYykzbe.aj",
"T9c2Y@HjVQY.zz",
"p7ShfET@vMMnTUqoqngPSEqbpyoeWN.jlqn",
"0VJSIhIUT2k@mJXVtdZVKKswW.xoca"
],
"first_name": "irure laboris minim",
"last_name": "id nostrud aliqua sit",
"address_line_1": "dolor",
"address_line_2": "elit ex labore sunt aliquip",
"city": "ÝǘźƝǝƉƝ",
"state_province_region": "nostrud Duis non nulla laborum",
"postal_code": 60466925,
"country": "id sunt nisi",
"custom_fields": {
"custom_field_name2": "enim quis",
"custom_field_name1": "amet"
},
"list_ids": [
"2870627c-b9ea-4dcf-bde0-36c3e0e3eca9",
"575d86aa-4dcc-4b7d-b7de-ded856913198",
"fb82a17f-5777-439d-9b8c-2c565c8ddf20"
]
}
],
"name": "List Name",
"query_dsl": "Email LIKE %twilio.com"
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "do reprehenderit ex tempor Duis",
"field": "ut"
}
]
}{
"errors": [
{
"message": "ullamco"
},
{
"message": "esse"
},
{
"message": "ullamco sed"
},
{
"message": "non consectetur"
}
]
}DELETE
{}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "anim aliquip veniam qui Ut",
"field": "commodo exercitation in"
},
{
"message": "incididunt exercitation adipisicing in velit",
"field": "nulla ad enim deserunt"
},
{
"message": "aliqua Duis",
"field": "fugiat irure"
}
]
}{
"errors": [
{
"message": "ullamco non Lorem dolore dolor"
},
{
"message": "sed laborum dolore"
},
{
"message": "nostrud"
},
{
"message": "sunt exercitation"
}
]
}Segmenting Contacts
POST
{
"ids": [
"a14dcc63-d651-4c57-9826-4a3705f5c78d",
"f3de551e-dc5c-4d42-bd08-c7f87f87f0e8",
"1b8107b5-adf4-401c-8865-fa84ba178fb9",
"d7900715-c904-4728-acff-9ab79627579e",
"16641f5b-cfa3-41b9-9626-244488ee85b1"
]
}{
"errors": [
{
"id": "in reprehenderit pariatur",
"error": "minim mollit incididunt quis exercitation",
"resources": {
"type": "ea veniam ut anim",
"ids": [
"cillum Ut do Duis exercitation",
"adipisicing"
]
}
},
{
"id": "officia culpa ullamco consequat adipisicing",
"error": "dolor laborum consectetur",
"resources": {
"type": "consequat ut fugiat ad",
"ids": [
"nisi aute",
"Excepteur",
"est",
"fugiat Lorem Ut",
"sed"
]
}
},
{
"id": "occaecat",
"error": "eu",
"resources": {
"type": "dolore magna est cupidatat consectetur",
"ids": [
"Duis",
"aliquip",
"eiusmod reprehenderit adipisicing cupidatat"
]
}
},
{
"id": "qui quis",
"error": "aliqua eiusmod dolore occaecat",
"resources": {
"type": "proident incididunt sunt",
"ids": [
"tempor consectetur"
]
}
},
{
"id": "sint id ipsum aute",
"error": "voluptate officia consequat consectetur",
"resources": {
"type": "nostrud",
"ids": [
"qui",
"ex nostrud do Lorem laboris"
]
}
}
]
}{}{
"errors": [
{
"field": "voluptate mollit",
"message": "sit deserunt in quis"
},
{
"field": "qui laboris adipisicing",
"message": "commodo cupidatat enim aute"
},
{
"field": "ut sint",
"message": "ipsum"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "do"
},
{
"message": "anim qui ut aliquip deserunt"
}
]
}Single Sends(11 operations)
POST
{
"name": "Example API Created Single Send",
"categories": [
"unique opens"
],
"send_to": {
"all": true
},
"email_config": {
"design_id": "<your-design-id>",
"editor": "design",
"suppression_group_id": 12345,
"sender_id": 1234567
}
}{
"name": "Example API Created Single Send",
"id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
"status": "scheduled",
"created_at": "2020-05-18T17:28:27.272Z",
"send_at": "2020-06-16T00:19:55.106Z",
"categories": [
"unique opens"
],
"email_config": {
"subject": "",
"html_content": "",
"plain_content": "",
"generate_plain_content": true,
"editor": "code",
"suppression_group_id": null,
"custom_unsubscribe_url": null,
"sender_id": null,
"ip_pool": null
},
"send_to": {
"list_ids": [
"f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
]
}
}{
"errors": [
{
"field": "consectetur do in Duis",
"message": "in Ut consequat dolore",
"error_id": "nisi aliquip"
},
{
"field": "fugiat",
"message": "aliqua",
"error_id": "magna"
},
{
"field": "elit et dolor",
"message": "pariatur in cillum",
"error_id": "ex aliquip amet dolore Duis"
},
{
"field": "dolore commodo tempor",
"message": "irure Excepteur dolore pariatur",
"error_id": "exercitation magna"
}
]
}{
"errors": [
{
"field": "tempor",
"message": "do non sed cupidatat",
"error_id": "voluptate labore"
},
{
"field": "quis qui",
"message": "ad do reprehenderit nostrud",
"error_id": "sed reprehenderit dolor"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
page_size | 22128596 |
page_token | in ipsum laborum Ut Lorem |
{
"result": [
{
"id": "8b4a170d-2bb3-d51f-23db-77c4ae3e4467",
"name": "velit ut veniam",
"abtest": {
"type": "subject",
"winner_criteria": "manual",
"test_percentage": 10921292,
"duration": "Duis pariatur ut amet",
"winning_template_id": "nostrud et elit",
"winner_selected_at": null,
"expiration_date": null
},
"status": "scheduled",
"categories": [
"qui ullamco deserunt adipisicing",
"Lorem do tempor",
"sit sed fugiat",
"ut culpa proident",
"deserunt sed aliqua sit",
"officia enim",
"anim",
"ex velit voluptate do ut",
"aliqua laborum reprehenderit dolor",
"pariatur"
],
"send_at": "1950-08-25T10:18:09.0Z",
"is_abtest": true,
"updated_at": "1895-06-18T01:09:30.0Z",
"created_at": "1906-09-04T15:49:29.0Z"
},
{
"id": "1990d07c-1a9b-6357-8ab9-2c59a8611a1e",
"name": "eu do",
"abtest": {
"type": "subject",
"winner_criteria": "open",
"test_percentage": 51295321,
"duration": "exercitation eu et tempor nulla",
"winning_template_id": "irure occaecat",
"winner_selected_at": null,
"expiration_date": "mollit quis sit Lorem exercitation"
},
"status": "draft",
"categories": [
"dolor mollit velit enim fugiat",
"fugiat aliqua commodo",
"aliqua aliquip qui",
"nulla do aute",
"voluptate incididunt ut sint Ut",
"quis laborum pariatur sed fugiat",
"aute",
"proident dolore enim officia",
"elit reprehenderit enim nisi",
"consectetur"
],
"send_at": "1966-10-14T22:14:26.0Z",
"is_abtest": true,
"updated_at": "1949-02-16T13:06:39.0Z",
"created_at": "1902-04-18T10:31:47.0Z"
},
{
"id": "5e167775-f98d-5385-361e-1b589d3e1537",
"name": "irure ipsum sunt ullamco",
"abtest": null,
"status": "triggered",
"categories": [
"officia dolore incididunt dolor",
"esse",
"Ut",
"elit dolore ex Ut",
"in deserunt amet",
"et veniam",
"officia",
"in culpa",
"ipsum irure",
"nulla mollit magna pariatur"
],
"send_at": "1894-03-16T09:06:17.0Z",
"is_abtest": false,
"updated_at": "1963-06-09T17:08:44.0Z",
"created_at": "1945-01-21T16:16:47.0Z"
},
{
"id": "e599e7db-3169-a64f-b557-287bb2a87574",
"name": "Excepteur pariatur magna",
"abtest": null,
"status": "draft",
"categories": [
"pariatur fugiat elit sed",
"ullamco Excepteur",
"deserunt veniam velit enim",
"eiusmod eu",
"eiusmod",
"sed et eu",
"amet exercitation",
"elit proident irure cupidatat",
"voluptate eu id dolore sint",
"ipsum cupidatat culpa"
],
"send_at": "1945-08-02T03:18:13.0Z",
"is_abtest": true,
"updated_at": "1905-07-28T15:01:13.0Z",
"created_at": "1917-07-11T09:55:58.0Z"
}
],
"_metadata": {
"prev": "https://IWTsnkNlwzYbk.iyDNsHsbCOCU.te2Ew261FA0zTqIkMWBmehK3DvyzXA77adKwZkZhIopke,3dfrW9o",
"self": "https://ZFY.gabrN5Mo5+E+ydK3XeNq.mTo1OWbK9,ZO,w8qc7R",
"next": "http://xzDiGXliJEbdZXWvSumf.uaekBUHd",
"count": 76461691
}
}{
"errors": [
{
"field": "ex Lorem anim cupidatat ut",
"message": "veniam",
"error_id": "amet culpa deserunt non quis"
}
]
}DELETE
| Query Parameter Name | Example |
|---|---|
ids | ["sed nisi","deserunt mollit fugiat anim","dolore incididunt id","cupidatat Ut ut","eiusmod nostrud esse","cillum","quis Lorem occaecat qui","ut nulla","incididunt pariatur do eu","esse"] |
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"field": "ipsum nostrud",
"message": "in nulla deserunt est Duis",
"error_id": "ipsum et Lorem consequat labore"
},
{
"field": "id incididunt ex magna",
"message": "laboris in",
"error_id": "consequat irure"
},
{
"field": "adipisicing",
"message": "amet labore nisi laborum tempor",
"error_id": "tempor"
},
{
"field": "dolore dolor consequat",
"message": "officia anim sit ex",
"error_id": "Excepteur sunt sed enim"
}
]
}{
"errors": [
{
"field": "exercitation laboris",
"message": "ut nulla",
"error_id": "aliquip cupidatat commodo enim aute"
},
{
"field": "laborum sunt culpa exercitation",
"message": "et cupidatat ea fugiat elit",
"error_id": "cillum labore quis"
}
]
}POST
{
"name": "pariatur"
}{
"name": "Example API Created Single Send",
"id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
"status": "scheduled",
"created_at": "2020-05-18T17:28:27.272Z",
"send_at": "2020-06-16T00:19:55.106Z",
"categories": [
"unique opens"
],
"email_config": {
"subject": "",
"html_content": "",
"plain_content": "",
"generate_plain_content": true,
"editor": "code",
"suppression_group_id": null,
"custom_unsubscribe_url": null,
"sender_id": null,
"ip_pool": null
},
"send_to": {
"list_ids": [
"f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
]
}
}{
"errors": [
{
"field": "elit est quis voluptate Excepteur",
"message": "cupidatat dolor aute Ut pariatur",
"error_id": "commodo in tempor"
},
{
"field": "voluptate eiusmod do cupidatat adipisicing",
"message": "id deserunt laboris officia esse",
"error_id": "magna dolor esse nulla"
},
{
"field": "ipsum in mollit Duis",
"message": "in",
"error_id": "dolore in ut"
},
{
"field": "eiusmod exercitation minim mollit aliqua",
"message": "velit eu",
"error_id": "culpa labore dolor quis"
},
{
"field": "occaecat ad dolore ut",
"message": "ipsum ullamco eiusmod enim",
"error_id": "Ut eu id dolor"
}
]
}{
"errors": [
{
"field": "non ad labore reprehenderit",
"message": "mollit dolore minim incididunt reprehenderit",
"error_id": "est mollit dolore sunt"
},
{
"field": "voluptate",
"message": "proident reprehenderit commodo",
"error_id": "in"
},
{
"field": "pariatur sed quis",
"message": "ad",
"error_id": "incididunt laboris dolore"
}
]
}PATCH
{
"name": "anim in",
"categories": [
"reprehenderit cupidatat culpa consequat",
"deserunt aliquip",
"officia Lorem aute eu",
"sunt in est minim",
"non quis proident",
"anim commodo adipisicing in",
"ex in elit anim esse",
"et ex veniam commodo Excepteur",
"in culpa incididunt deserunt",
"ea adipisicing cupidatat et"
],
"send_at": "1901-04-26T06:16:25.0Z",
"send_to": {
"list_ids": [
"d5e9c811-0d28-90f1-d260-64e6c3092e85",
"038d7a62-8d71-3d3b-0698-ccb807ea1b94",
"81deea53-9fe5-5c4a-576c-f6114b773b01",
"28471812-c4c6-2c43-165f-0d1c7be4587b",
"0551ae32-d4cb-0caf-2559-67755e49b0bb",
"72920f30-dd6a-babc-2146-10d1a912c113",
"7305aad2-7697-fc8e-b36a-f527af765ac6",
"e2ce08fc-59e5-ce0d-67e5-289d51b50b3e",
"17cc6b6f-83a0-aec6-2b05-bb619c4fc8a3",
"aecf3a38-75a6-509d-07c9-03cdb816f430"
],
"segment_ids": [
"7265b988-6dc4-54d9-d458-949ecdac81d6",
"8eeccbed-b09e-6934-48c4-1cbe2bdfcde3",
"daa11eaf-fce2-119a-3082-4e3cb997fe4f",
"ac730d7e-9fe9-2a5e-ef12-da6dad94b92d",
"733b839a-419f-7616-f960-068bd0c06031",
"b1b2bcac-f661-cf1a-efb0-493e578aed9f",
"02caea04-df4e-b5de-5ff3-99d4564366e3",
"2cc475cd-872d-fd68-cd18-f4893f141b9c",
"bcedd26e-e44a-1aa1-b078-8ca93c4d6509",
"6ca49c58-b592-eac6-ac28-fd10b8007e21"
],
"all": true
},
"email_config": {
"subject": "id consequat nisi magna",
"html_content": "est voluptate consectetur velit pariatur",
"plain_content": "deserunt",
"generate_plain_content": true,
"design_id": "incididunt nisi in",
"editor": "code",
"suppression_group_id": null,
"custom_unsubscribe_url": null,
"sender_id": null,
"ip_pool": "eu"
}
}{
"name": "Example API Created Single Send",
"id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
"status": "scheduled",
"created_at": "2020-05-18T17:28:27.272Z",
"send_at": "2020-06-16T00:19:55.106Z",
"categories": [
"unique opens"
],
"email_config": {
"subject": "",
"html_content": "",
"plain_content": "",
"generate_plain_content": true,
"editor": "code",
"suppression_group_id": null,
"custom_unsubscribe_url": null,
"sender_id": null,
"ip_pool": null
},
"send_to": {
"list_ids": [
"f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
]
}
}{
"errors": [
{
"field": "esse tempor",
"message": "esse ullamco",
"error_id": "magna ipsum sunt"
},
{
"field": "culpa ut eiusmod",
"message": "adipisicing voluptate",
"error_id": "aute esse eu"
}
]
}{
"errors": [
{
"field": "ipsum Duis reprehenderit ullamco elit",
"message": "nulla",
"error_id": "laboris dolore cupidatat"
},
{
"field": "irure nostrud fugiat",
"message": "id amet",
"error_id": "in Ut"
},
{
"field": "aliqua nisi dolor aliquip ullamco",
"message": "laborum cillum ea",
"error_id": "do incididunt"
},
{
"field": "ex Duis consectetur aute",
"message": "officia dolor",
"error_id": "ipsum et enim"
},
{
"field": "ipsum cupidatat id ea dolore",
"message": "velit ut",
"error_id": "consectetur"
}
]
}{
"errors": [
{
"field": "ad sint laboris",
"message": "tempor",
"error_id": "nostrud minim tempor labore eu"
},
{
"field": "labore Lorem veniam anim",
"message": "aute ipsum",
"error_id": "pariatur dolore dolore Excepteur"
},
{
"field": "dolore cillum",
"message": "incididunt labore ut",
"error_id": "tempor esse"
}
]
}GET
{
"name": "single-send-1",
"id": "2f6dec81-43b9-4c67-a890-3a38cb63b54a",
"status": "scheduled",
"created_at": "2020-12-13T16:24:42.013Z",
"send_to": {
"segment_ids": [
"dad84de3-bec4-4e04-b132-2cbfd4bb3789",
"7dce758d-1155-4102-88d2-ca65565ac98b"
],
"all": true
}
}{
"errors": [
{
"field": "in anim veniam",
"message": "ea laboris",
"error_id": "deserunt ea Ut sit"
},
{
"field": "sunt",
"message": "est commodo laborum qui fugiat",
"error_id": "nulla voluptate"
}
]
}{
"errors": [
{
"field": "in anim dolore nulla",
"message": "laborum labore dolore quis ut",
"error_id": "Ut"
}
]
}DELETE
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.{
"errors": [
{
"field": "velit proident nostrud elit est",
"message": "consectetur officia fugiat",
"error_id": "occaecat pariatur"
},
{
"field": "nisi et mollit",
"message": "nostrud cillum nulla",
"error_id": "ullamco fugiat ex do consectetur"
},
{
"field": "Lorem aute",
"message": "nisi Ut non occaecat voluptate",
"error_id": "elit laborum voluptate in qui"
}
]
}{
"errors": [
{
"field": "incididunt ut in nostrud",
"message": "irure",
"error_id": "amet"
},
{
"field": "ex voluptate",
"message": "sit sed dolor aute",
"error_id": "tempor ut officia irure nulla"
},
{
"field": "reprehenderit quis",
"message": "mollit ipsum",
"error_id": "Lorem quis adipisicing Duis sed"
},
{
"field": "quis",
"message": "ad fugiat in dolor",
"error_id": "ullamco amet sit"
}
]
}POST
| Query Parameter Name | Example |
|---|---|
page_size | -65837381 |
page_token | Duis ipsum |
{
"name": "specific-single-send-name",
"status": [
"draft",
"scheduled"
],
"categories": [
"shoes"
]
}{
"result": [
{
"id": "df25ffdf-6a96-458a-9419-6d87d3094c6b",
"name": "single-send-1",
"status": "triggered",
"categories": [
"shoes"
],
"is_abtest": true,
"updated_at": "3263-04-09T09:05:08.193Z",
"created_at": "4739-10-29T07:11:32.476Z",
"send_at": "2471-05-31T15:46:18.797Z"
}
],
"_metadata": {
"self": "nwNSrPSWt7d",
"prev": "P0Enoayd",
"next": "DYEsTUDww9-",
"count": 1
}
}{
"errors": [
{
"field": "sit quis ad ullamco nulla",
"message": "est in sint labore",
"error_id": "non esse anim ut"
},
{
"field": "ea sunt irure",
"message": "labore sed aute",
"error_id": "sit"
},
{
"field": "ad sed in veniam",
"message": "Excepteur",
"error_id": "sit id irure mollit"
}
]
}PUT
{
"send_at": "3752-01-28T23:21:52.575Z"
}{
"send_at": "3752-01-28T23:21:52.575Z",
"status": "scheduled"
}{
"errors": [
{
"field": "velit culpa",
"message": "pariatur in dolore",
"error_id": "quis occaecat"
},
{
"field": "dolor adipisicing in consequat pariatur",
"message": "dolore dolore aute reprehenderit tempor",
"error_id": "velit"
}
]
}{
"errors": [
{
"field": "irure officia non enim pariatur",
"message": "in ut do",
"error_id": "minim laborum"
},
{
"field": "veniam id deserunt qui",
"message": "adipisicing",
"error_id": "nisi"
},
{
"field": "in ipsum",
"message": "consectetur ullamco in commodo ut",
"error_id": "elit esse qui laborum irure"
},
{
"field": "nulla laborum",
"message": "dolor labore Ut",
"error_id": "commodo nostrud tempor anim do"
},
{
"field": "magna",
"message": "dolore cillum sint voluptate anim",
"error_id": "Ut eu"
}
]
}DELETE
{
"send_at": "1924-10-03T22:26:28.0Z",
"status": "scheduled"
}{
"errors": [
{
"field": "sit",
"message": "nostrud consequat",
"error_id": "nulla dolor"
},
{
"field": "Duis sed veniam",
"message": "Excepteur ullamco",
"error_id": "ad ea"
},
{
"field": "id dolor",
"message": "ullamco in consequat",
"error_id": "enim anim"
}
]
}{
"errors": [
{
"field": "amet consequat",
"message": "velit ipsum aliquip nulla",
"error_id": "sint velit minim"
}
]
}GET
{
"categories": [
"equipment",
"shoes",
"sports"
]
}{
"errors": [
{
"field": "incididunt sunt ut dolor labore",
"message": "proident cillum consequat Excepteur enim",
"error_id": "laboris labore reprehenderit"
}
]
}Send Test Email
POST
{
"template_id": "f8f77db8-b9fa-4b3c-9ee8-de3d582016b8",
"version_id_override": "7734f757-8eb8-4d22-b7f0-779a72f32986",
"sender_id": 6060664,
"custom_unsubscribe_url": "https://example.com/unsubscribe",
"suppression_group_id": 21865513,
"emails": [
"janedoe@example.com",
"tiramisu@example.com",
"bundt@example.com"
]
}{}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Marketing Campaigns Stats(8 operations)
GET
| Query Parameter Name | Example |
|---|---|
automation_ids | ["ut eiusmod est","Duis adipisicing ipsum officia labore","dolor","velit et","dolore fugiat","fugiat incididunt do adipisicing est","eiusmod do in ut","in","deserunt Ut in","velit dolor minim id veniam"] |
page_size | 86 |
page_token | voluptate occaecat exercitation |
{
"results": [
{
"id": "03e77052-34cc-7abb-42bc-01c54fd31792",
"aggregation": "id aliquip sunt Excepteur do",
"step_id": "officia",
"stats": {
"bounce_drops": -89264445,
"bounces": 98937686,
"clicks": -20750389,
"delivered": 37485819,
"invalid_emails": 86914448,
"opens": 87622469,
"requests": 35466068,
"spam_report_drops": -66816224,
"spam_reports": -95388210,
"unique_clicks": -62573672,
"unique_opens": 33048403,
"unsubscribes": 60652573
}
},
{
"id": "5a26bedf-d7c1-ec00-6084-8f612435b01e",
"aggregation": "eiusmod ut exercitation occaecat",
"step_id": "magna et esse enim nulla",
"stats": {
"bounce_drops": -60500482,
"bounces": -9255715,
"clicks": 6597038,
"delivered": -97852016,
"invalid_emails": 84632574,
"opens": 3411303,
"requests": -4265950,
"spam_report_drops": 79779246,
"spam_reports": 24734045,
"unique_clicks": -54748100,
"unique_opens": -10678200,
"unsubscribes": -13342735
}
},
{
"id": "7f6be374-7add-b6f5-d0c8-518dc320a1c0",
"aggregation": "ut",
"step_id": "nisi mollit",
"stats": {
"bounce_drops": 65949543,
"bounces": -24371259,
"clicks": 7032686,
"delivered": 92809132,
"invalid_emails": -72816840,
"opens": 6193097,
"requests": -52764521,
"spam_report_drops": -45844698,
"spam_reports": -40281911,
"unique_clicks": -80695580,
"unique_opens": 27952194,
"unsubscribes": 696474
}
}
],
"_metadata": {
"prev": "https://PHGFecgDcYMiD.momBX7Xa4TS0WmhXeY2A4wrlegwVRIVef-057C",
"self": "https://wlAKxtFnWrQC.iukitgVQcWi7PS3DA+DCLSe24WRm3nebwMLMfayZ8ZkurkZ",
"next": "http://uvwMqJcPiFkeMQYGeKXWVCWk.zcrIUscMf",
"count": 92538982.90101495
}
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
group_by | ["step_id"] |
step_ids | ["5bd16753-d2d6-3fd5-a07a-cbf5fe9a4a6f","9c490cde-85e6-c116-2c96-b27f286bdab3","c676d619-5d94-0db9-6d94-7c4dcea5c66f"] |
aggregated_by | total |
start_date | 1903-02-17 |
end_date | 1893-08-03 |
timezone | ea cillum |
page_size | 15 |
page_token | fugiat deserunt irure do |
{
"results": [
{
"id": "cbb13eaf-033b-1862-d517-cd90d9dd7b34",
"aggregation": "voluptate ad eu sunt",
"step_id": "ea ipsum fugiat aliquip quis",
"stats": {
"bounce_drops": -78310868,
"bounces": -7803499,
"clicks": 29974027,
"delivered": -64605594,
"invalid_emails": 40249186,
"opens": -7901146,
"requests": 74056771,
"spam_report_drops": -87527284,
"spam_reports": 42268191,
"unique_clicks": 16342978,
"unique_opens": 31618155,
"unsubscribes": 82112213
}
},
{
"id": "b2cfbc6c-e156-2f66-a70d-310471679e86",
"aggregation": "aliquip qui Duis",
"step_id": "amet culpa in sit",
"stats": {
"bounce_drops": -93906579,
"bounces": -95231419,
"clicks": -44033926,
"delivered": 67315688,
"invalid_emails": -6855824,
"opens": 68041551,
"requests": 93216690,
"spam_report_drops": 90699717,
"spam_reports": -70272300,
"unique_clicks": 65485430,
"unique_opens": 31448898,
"unsubscribes": -80196729
}
}
],
"_metadata": {
"prev": "https://pFSqiELDvrYaAvsIju.zyGKQb.uYFappbJWxhM8Eucu7GS8oIGT8ltR-vTGEyfV5rGi.UGi1LcQIXTN.02rv1Dn-R7Wub+n.",
"self": "https://hQXHHesBgkTPSHLzbjMszASFqsGZd.fhxdWXAepYoKLt3iV",
"next": "https://VffRJmbx.znosOO,R-X+aMaMh0nwMVm4OMN.b9aDZZJpen--LhxKA",
"count": -14089195.312086701
}
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
singlesend_ids | ["sit dolore in","culpa qui Ut ipsum","non exercitation","eu ipsum ex officia","Excepteur reprehenderit in ullamco","qui consectetur nisi laborum irure","eiusmod pariatur amet","nulla","laboris non dolore culpa ullamco","nisi culpa"] |
page_size | 8 |
page_token | elit aliquip |
{
"results": [
{
"id": "0a3b54ef-3ae2-446a-cef0-9214951d37e8",
"ab_variation": "7f758dec-7f7c-14ca-0a09-a3ab2dbc69f8",
"ab_phase": "test",
"aggregation": "in fugiat non ex",
"stats": {
"bounce_drops": 79118185,
"bounces": -80775717,
"clicks": 9530770,
"delivered": -60080346,
"invalid_emails": -70805297,
"opens": -30898516,
"requests": -40376158,
"spam_report_drops": -82891822,
"spam_reports": -93901149,
"unique_clicks": -21427477,
"unique_opens": 29779190,
"unsubscribes": 82794909
}
},
{
"id": "75aa399d-4005-3ec3-785c-8421beebc53e",
"ab_variation": "3b8333e4-825a-5f16-da42-769d8e233df3",
"ab_phase": "all",
"aggregation": "in cupidatat sed laborum fugiat",
"stats": {
"bounce_drops": -88512299,
"bounces": 14760223,
"clicks": -48043707,
"delivered": 92407779,
"invalid_emails": 9473615,
"opens": -70888511,
"requests": -36658860,
"spam_report_drops": -15956661,
"spam_reports": 9026186,
"unique_clicks": -58152203,
"unique_opens": -12649612,
"unsubscribes": 7704731
}
}
],
"_metadata": {
"prev": "https://oyGhhSOWekGCaYYwTFDgCXXXfUOAi.sfbvilqs-S",
"self": "https://nGQSYUNSqoMoWna.pmwalSSEy0rH93ZlmY",
"next": "http://rGSvvUuVndDJmVuOOPmUHiPk.zwhmmdFstGlMIi9BWW02,8qUi",
"count": -63415486.004732236
}
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
aggregated_by | day |
start_date | 1907-03-06 |
end_date | 1909-12-16 |
timezone | dolore |
page_size | 52 |
page_token | sed labore |
group_by | ["ab_phase","ab_phase","ab_phase"] |
{
"results": [
{
"id": "6c105f18-89f9-0867-b213-412280e0259a",
"ab_variation": "13cfa517-1c28-59a9-cd27-6a6e036a1543",
"ab_phase": "all",
"aggregation": "proident",
"stats": {
"bounce_drops": -5328739,
"bounces": 44371349,
"clicks": -47827280,
"delivered": 71360997,
"invalid_emails": 16696454,
"opens": 11882442,
"requests": -19327200,
"spam_report_drops": 2099262,
"spam_reports": -8087002,
"unique_clicks": 31653294,
"unique_opens": -62372639,
"unsubscribes": -36164408
}
},
{
"id": "e217634b-5768-4751-a4b4-c38b99e61ccd",
"ab_variation": "70f2e6fb-8980-c08a-7fef-ab072718f2bd",
"ab_phase": "test",
"aggregation": "Duis proident fugiat quis",
"stats": {
"bounce_drops": -24209696,
"bounces": 38292164,
"clicks": -15837986,
"delivered": -44323883,
"invalid_emails": 35519111,
"opens": 82270623,
"requests": 49333453,
"spam_report_drops": 60260668,
"spam_reports": -6086825,
"unique_clicks": -76746210,
"unique_opens": 64600127,
"unsubscribes": 88614232
}
},
{
"id": "e5cec076-d4b7-82d5-105e-2e949bb92881",
"ab_variation": "b0df35c5-b458-1c6f-9504-60b51dd7441e",
"ab_phase": "send",
"aggregation": "Lorem",
"stats": {
"bounce_drops": 6880471,
"bounces": -99171816,
"clicks": 53161748,
"delivered": -93505006,
"invalid_emails": 47634493,
"opens": -22697024,
"requests": -7981785,
"spam_report_drops": -24602259,
"spam_reports": -69003339,
"unique_clicks": 89901155,
"unique_opens": 62893606,
"unsubscribes": 79969735
}
},
{
"id": "81c66b91-5f98-1421-1504-cc5fdf497076",
"ab_variation": "e515a032-f010-1aa5-7873-f2aa0d367a2c",
"ab_phase": "send",
"aggregation": "exercitation reprehenderit laboris culpa",
"stats": {
"bounce_drops": 97526,
"bounces": 58759786,
"clicks": -37313697,
"delivered": -47992043,
"invalid_emails": -56274149,
"opens": 77912750,
"requests": 93153600,
"spam_report_drops": 34841269,
"spam_reports": 98583643,
"unique_clicks": -58017913,
"unique_opens": -84975084,
"unsubscribes": 24807852
}
}
],
"_metadata": {
"prev": "http://rwykaQMgOZwEPucmMDXdJeifFtNTlqr.chxZNFRi0rwn2UpdCN1nt6czGZ863lySB5JmjviDelIsr",
"self": "http://KDvaYObtcGcLLAhyqhxfcGPpqnqsTCc.nldJZDnokaHH9XdVuu9d7BjUeOxDjeaTFMm-N,0FuHcplf",
"next": "https://jLzwQkcEfFFOpSKEOgSPvZJPlSYVJojyx.mfl79N7hZycEQFYup30gFQ9YwLoZQgI4OW",
"count": -66970410.25070582
}
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
group_by | ["step_id","step_id","step_id","step_id","step_id"] |
step_ids | ["7b5e5f86-0134-6847-e3cc-60e068904c1e","0e8173dd-e505-fc9f-6e78-d12d085cd3fd","16957e78-bea3-90c4-c364-04cbc402eea2","1dffe2ac-da59-4e1d-51a5-139da1ed0ff7"] |
page_size | 40 |
page_token | ut mollit incididunt consectetur |
{
"results": [
{
"url": "https://VfkiMynGUXswfxQOiIB.soyivx8L",
"url_location": 51629582,
"step_id": "b1f9b30e-2c66-4852-540e-f4f391170bec",
"clicks": 21842147
},
{
"url": "https://wei.qpqgIMIL7ER73OrvU2UoX6sPz2VihKIfAgd9pXzErfXONM6Jao3bciKTfoiTlh-L",
"url_location": 34178515,
"step_id": "e4e00559-c09c-df05-d657-b291b16c5379",
"clicks": 19146620
}
],
"total_clicks": 50916872,
"_metadata": {
"prev": "http://fdbFROqveUvobrAo.hebVvRtH.-E4mAMyyNcTBKYNBU3K6DEl9lkPpQ",
"self": "http://GMIktvxKmjeeKchuJunffJqAt.fuslj9fQ3w5fSeFhAAlG3ukl8cKCehct.LvcZrzgEJpsv",
"next": "https://D.xszpQXJMUZD.qjuHSuscZcLJsrGmxjjr8loEyYXiIZ,xFE9sMUfDKGxNADC",
"count": 47091027.83148724
}
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
page_size | 97 |
page_token | incididunt dolor aliquip |
group_by | ["ab_variation","ab_variation"] |
ab_variation_id | 37a0da40-bdd2-bafe-7776-fa8ad796dc9a |
ab_phase_id | test |
{
"results": [
{
"url": "https://jorYWRXTJRNSuUfubLn.ikuZDAGYTs5TbGLAavolLErvL",
"url_location": 36290014,
"ab_variation": "460ebe4b-7f81-d4d4-7629-2d8a48506695",
"ab_phase": "all",
"clicks": 93961193
},
{
"url": "https://gTtjmkQhEsMTtzLh.exvmVWAfyLpQezXxumDG,DjyIIMUyCOgfNW27OgPKyrByQ0Vw3x.zpiVPfVQ,UHg07SO",
"url_location": 6008163,
"ab_variation": "3037380f-a327-7183-2f29-a3335c954e01",
"ab_phase": "send",
"clicks": 90327107
},
{
"url": "http://geuLqeUDhCKfpUBMkOBicCuvddJ.mzagAIFRIeSbJSwZC0",
"url_location": 10913513,
"ab_variation": "e8a354db-7ae0-08ca-7fe7-6bbec5ec426e",
"ab_phase": "all",
"clicks": 69781411
}
],
"_metadata": {
"prev": "http://UhEeYsnHEgOEUPrWwINqyQL.ufjpJ8B1UH0ZWYXzPJuCgy8lK.cUA2Pcr2GdIs",
"self": "https://xgrgYZfklwp.vswACvD3PpOdLA8dfWatraEf3VPmoE44STIW5",
"next": "https://MLKBofTVjomwkLckFKVl.whHF-BapISP7vO5kqaacZd2t+r9FMqLKUz",
"count": -67527423.88020083
},
"total_clicks": -56102912
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{}GET
| Query Parameter Name | Example |
|---|---|
ids | ["exercitation","adipisicing ut aliquip amet","id est voluptate","aliquip nulla aute","deserunt occaecat in nisi","ullamco non culpa sunt","reprehenderit ullamco id","exercitation nostrud dolore cillum","dolor pariatur voluptate incididunt","labore occaecat ea tempor"] |
timezone | nisi et sunt magna ex |
qui reprehenderit incididunt LoremMissing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.GET
| Query Parameter Name | Example |
|---|---|
ids | ["voluptate enim Excepteur aliquip nostrud","fugiat qui aliqua laborum","ex fugiat culpa ullamco dolore","ad do qui","esse officia","elit Lorem ex mollit non","sit dolor elit ipsum qui","aliqua reprehenderit proident laborum commodo","id reprehenderit in sint","laboris laborum deserunt do"] |
timezone | culpa |
ut adipisicing commodo{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}Sender Identities API(6 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "velit" |
{
"nickname": "My Sender ID",
"from": {
"email": "from@example.com",
"name": "Example INC"
},
"reply_to": {
"email": "replyto@example.com",
"name": "Example INC"
},
"address": "123 Elm St.",
"address_2": "Apt. 456",
"city": "Denver",
"state": "Colorado",
"zip": "80202",
"country": "United States"
}{
"id": 1,
"nickname": "My Sender ID",
"from": {
"email": "from@example.com",
"name": "Example INC"
},
"reply_to": {
"email": "replyto@example.com",
"name": "Example INC"
},
"address": "123 Elm St.",
"address_2": "Apt. 456",
"city": "Denver",
"state": "Colorado",
"zip": "80202",
"country": "United States",
"verified": true,
"updated_at": 1449872165,
"created_at": 1449872165,
"locked": false
}{
"errors": [
{
"message": "The JSON you have submitted cannot be parsed.",
"field": ""
},
{
"message": "You've reached your limit of 100 sender identities. Please delete one or more and try again.",
"field": ""
},
{
"message": "nickname is required.",
"field": "nickname"
},
{
"message": "You already have a sender identity with the same nickname.",
"field": "nickname"
},
{
"message": "from_name is required.",
"field": "from_name"
},
{
"message": "from_email is required.",
"field": "from_email"
},
{
"message": "From email is not a valid email address.",
"field": "from_email"
},
{
"message": "reply_to is required.",
"field": "reply_to"
},
{
"message": "Reply to email is not a valid email address.",
"field": "reply_to"
},
{
"message": "address is required.",
"field": "address"
},
{
"message": "city is required.",
"field": "city"
},
{
"message": "country is required.",
"field": "country"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "culpa ullamco non ut" |
{
"result": [
{
"id": 1,
"nickname": "My Sender ID",
"from": {
"email": "from@example.com",
"name": "Example INC"
},
"reply_to": {
"email": "replyto@example.com",
"name": "Example INC"
},
"address": "123 Elm St.",
"address_2": "Apt. 456",
"city": "Denver",
"state": "Colorado",
"zip": "80202",
"country": "United States",
"verified": true,
"updated_at": 1449872165,
"created_at": 1449872165,
"locked": false
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "amet in dolore reprehenderit" |
{
"id": 1,
"nickname": "My Sender ID",
"from": {
"email": "from@example.com",
"name": "Example INC"
},
"reply_to": {
"email": "replyto@example.com",
"name": "Example INC"
},
"address": "123 Elm St.",
"address_2": "Apt. 456",
"city": "Denver",
"state": "Colorado",
"zip": "80202",
"country": "United States",
"verified": true,
"updated_at": 1449872165,
"created_at": 1449872165,
"locked": false
}{
"errors": [
{
"message": "resource not found",
"field": "id"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "magna in aliqua" |
{
"nickname": "My Sender ID",
"from": {
"email": "from@example.com",
"name": "Example INC"
},
"reply_to": {
"email": "replyto@example.com",
"name": "Example INC"
},
"address": "123 Elm St.",
"address_2": "Apt. 456",
"city": "Denver",
"state": "Colorado",
"zip": "80202",
"country": "United States"
}{
"id": 1,
"nickname": "My Sender ID",
"from": {
"email": "from@example.com",
"name": "Example INC"
},
"reply_to": {
"email": "replyto@example.com",
"name": "Example INC"
},
"address": "123 Elm St.",
"address_2": "Apt. 456",
"city": "Denver",
"state": "Colorado",
"zip": "80202",
"country": "United States",
"verified": true,
"updated_at": 1449872165,
"created_at": 1449872165,
"locked": false
}{
"errors": [
{
"message": "The JSON you have submitted cannot be parsed.",
"field": ""
},
{
"message": "nickname is required.",
"field": "nickname"
},
{
"message": "You already have a sender identity with the same nickname.",
"field": "nickname"
},
{
"message": "from_name is required.",
"field": "from_name"
},
{
"message": "from_email is required.",
"field": "from_email"
},
{
"message": "From email is not a valid email address.",
"field": "from_email"
},
{
"message": "reply_to is required.",
"field": "reply_to"
},
{
"message": "Reply to email is not a valid email address.",
"field": "reply_to"
},
{
"message": "address is required.",
"field": "address"
},
{
"message": "city is required.",
"field": "city"
},
{
"message": "country is required.",
"field": "country"
}
]
}{
"errors": [
{
"message": "You may only update a sender identity when it is unlocked.",
"field": "locked"
}
]
}{
"errors": [
{
"message": "resource not found",
"field": "id"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "dolor Duis" |
{}{
"errors": [
{
"message": "You may only delete a sender identity when it is unlocked.",
"field": "locked"
}
]
}{
"errors": [
{
"message": "resource not found",
"field": "id"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "laboris" |
{}{
"errors": [
{
"message": "The Sender Identity is already verified. No email sent.",
"field": ""
}
]
}{
"errors": [
{
"message": "resource not found",
"field": "id"
}
]
}Contacts API - Lists(10 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "esse laborum adipisicing" |
{
"name": "your list name"
}{
"id": 1,
"name": "your list name",
"recipient_count": 0
}{
"errors": [
{
"field": null,
"message": "Returned if request body is invalid JSON"
},
{
"field": "name",
"message": "Returned if list name is not a string"
},
{
"field": "name",
"message": "Returned if list name is a duplicate of an existing list or segment"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "in voluptate" |
{
"lists": [
{
"id": 1,
"name": "the jones",
"recipient_count": 1
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "sint eiusmod ex ullamco" |
[
1,
2,
3,
4
]Error generating example{
"errors": [
{
"field": null,
"message": "list id was invalid"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
list_id | 94691957 |
| Header Name | Example |
|---|---|
on-behalf-of | "eiusmod sed velit ullamco" |
{
"id": 1,
"name": "listname",
"recipient_count": 0
}{
"errors": [
{
"message": "invalid id"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"field": null,
"message": "List ID does not exist"
}
]
}PATCH
| Query Parameter Name | Example |
|---|---|
list_id* | 40874985 |
| Header Name | Example |
|---|---|
on-behalf-of | "qui consequat eiusmod veniam" |
{
"name": "newlistname"
}{
"id": 1234,
"name": "2016 iPhone Users",
"recipient_count": 0
}{
"errors": [
{
"message": "invalid id"
}
]
}{
"errors": [
{
"message": "List ID does not exist"
}
]
}DELETE
| Query Parameter Name | Example |
|---|---|
delete_contacts | false |
| Header Name | Example |
|---|---|
on-behalf-of | "nulla exercitation ut occaecat" |
Error generating exampleError generating example{
"errors": [
{
"field": "delete_contacts",
"message": "delete_contacts not a bool"
},
{
"field": "list_id",
"message": "Returned if list_id is not valid"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"message": "List not found: 5"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
page | 28242121 |
page_size | 4886005 |
list_id* | 54250255 |
| Header Name | Example |
|---|---|
on-behalf-of | "ea qui sed incididunt" |
{
"recipients": [
{
"created_at": 1433348344,
"custom_fields": [
{
"id": 6234,
"name": "age",
"type": "number",
"value": null
},
{
"id": 6233,
"name": "country",
"type": "text",
"value": null
},
{
"id": 6235,
"name": "fname",
"type": "text",
"value": "Example"
},
{
"id": 6239,
"name": "lname",
"type": "text",
"value": "User"
},
{
"id": 6240,
"name": "lname",
"type": "text",
"value": null
}
],
"email": "example@example.com",
"first_name": "Example",
"id": "ZGVWfyZWsuYmFpbmVzQHNlbmRmCmLkLmNv==",
"last_clicked": 1438616117,
"last_emailed": 1438613272,
"last_name": "User",
"last_opened": 1438616109,
"updated_at": 1438616119
}
]
}{
"errors": [
{
"field": "list_id",
"message": "Returned if list_id is not a valid integer"
},
{
"field": "page",
"message": "Returned if page is not a valid integer"
},
{
"field": "page",
"message": "Returned if page is less than 1"
},
{
"field": "page_size",
"message": "Returned if page_size is not a valid integer"
},
{
"field": "page_size",
"message": "Returned if page_size is less than 1 or greater than 1000"
}
]
}{
"errors": [
{
"field": "list_id",
"message": "Returned if list_id is invalid"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "occaecat in in" |
[
"recipient_id1",
"recipient_id2"
]Error generating example{
"errors": [
{
"field": "list_id",
"message": "list_id is invalid"
},
{
"field": "recipient_id",
"message": "no valid recipients were provided"
},
{
"field": null,
"message": "no recipients were added"
},
{
"field": null,
"message": "request body is invalid JSON"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"field": "list_id",
"message": "list_id does not exist"
},
{
"field": "recipient_id",
"message": "recipient_id does not exist"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "amet ullamco" |
Error generating example{
"errors": [
{
"field": "list_id",
"message": "Returned if list_id is invalid"
},
{
"field": "recipient_id",
"message": "Returned if recipient_id is invalid"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"field": "list_id",
"message": "Returned if list_id does not exist"
},
{
"field": "recipient_id",
"message": "Returned if recipient_id does not exist"
}
]
}DELETE
| Query Parameter Name | Example |
|---|---|
list_id* | -29983799 |
recipient_id* | 5631615 |
| Header Name | Example |
|---|---|
on-behalf-of | "dolore elit" |
Error generating exampleError generating example{
"errors": [
{
"field": "list_id",
"message": "Returned if list_id is invalid"
},
{
"field": "recipient_id",
"message": "no valid recipients were provided"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"field": "list_id",
"message": "Returned if list_id does not exist"
},
{
"field": "recipient_id",
"message": "Returned if recipient_id does not exist"
}
]
}Contacts API - Recipients(12 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "mollit Excepteur anim sint in" |
[
{
"email": "example@example.com",
"first_name": "",
"last_name": "User",
"age": 25
},
{
"email": "example2@example.com",
"first_name": "Example",
"last_name": "User",
"age": 25
}
]{
"error_count": 1,
"error_indices": [
2
],
"new_count": 2,
"persisted_recipients": [
"YUBh",
"bWlsbGVyQG1pbGxlci50ZXN0"
],
"updated_count": 0,
"errors": [
{
"message": "Invalid email.",
"error_indices": [
2
]
}
]
}{
"errors": [
{
"field": null,
"message": "Request body is not valid json"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "irure sunt qui" |
[
{
"email": "jones@example.com",
"last_name": "Jones",
"first_name": "Guy"
}
]{
"error_count": 1,
"error_indices": [
2
],
"new_count": 2,
"persisted_recipients": [
"YUBh",
"bWlsbGVyQG1pbGxlci50ZXN0"
],
"updated_count": 0,
"errors": [
{
"message": "Invalid email.",
"error_indices": [
2
]
}
]
}{
"errors": [
{
"field": null,
"message": "Request body is not valid json"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "commodo" |
[
"recipient_id1",
"recipient_id2"
]{}{
"errors": [
{
"message": "No recipient ids provided"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
page | -36048010 |
page_size | 68333294 |
| Header Name | Example |
|---|---|
on-behalf-of | "quis" |
{
"recipients": []
}{}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "est aliquip velit" |
{
"status": [
{
"id": "worker_delay",
"value": "delayed"
},
{
"id": "worker_delay_seconds",
"value": "75.0"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "in laborum dolor" |
{
"recipients": [
{
"id": "cupidatat laborum elit dolor",
"created_at": -72573320.741884,
"custom_fields": [
{
"name": "first_name",
"type": "text"
},
{
"name": "first_name",
"type": "text"
},
{
"name": "first_name",
"type": "text"
}
],
"email": "fgY9@jwqbrgjbdWgMBwTxufR.beg",
"first_name": null,
"last_name": "in eu",
"last_clicked": null,
"last_emailed": null,
"last_opened": null,
"updated_at": -61976280.39434311
},
{
"id": "in do velit ipsum anim",
"created_at": 18715772.047934458,
"custom_fields": [
{
"name": "first_name",
"type": "text"
},
{
"name": "first_name",
"type": "text"
},
{
"name": "first_name",
"type": "text"
}
],
"email": "R4cZjLS1@qtywzfQDc.xqvb",
"first_name": null,
"last_name": null,
"last_clicked": 40119720.271063924,
"last_emailed": null,
"last_opened": null,
"updated_at": -76873531.0177203
},
{
"id": "enim nostrud Excepteur ex velit",
"created_at": 67473297.56866533,
"custom_fields": [
{
"name": "first_name",
"type": "text"
}
],
"email": "DiCbjBGGG@EwAiDIgZytvEheYAivvCGtFqevmO.fhyf",
"first_name": null,
"last_name": null,
"last_clicked": 96174925.30062494,
"last_emailed": -70929575.54155612,
"last_opened": null,
"updated_at": 64628612.37058881
}
]
}{}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "Ut" |
{}{
"errors": [
{
"field": null,
"message": "recipient not found"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"field": null,
"message": "recipient_id is not valid"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "incididunt sed mollit Lorem esse" |
{
"lists": [
{
"id": 1234,
"name": "Example list",
"recipient_count": 42
}
]
}{
"errors": [
{
"field": null,
"message": "recipient ID is invalid"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"field": null,
"message": "recipient id not found"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "consequat laborum occaecat incididunt do" |
{
"recipient_count": 1234
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "dolore" |
{
"recipient_count": 1234
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
{field_name} | ipsum proident reprehenderit |
| Header Name | Example |
|---|---|
on-behalf-of | "magna deserunt dolor velit sunt" |
{
"recipients": [
{
"created_at": 1422313607,
"email": "jones@example.com",
"first_name": null,
"id": "YUBh",
"last_clicked": null,
"last_emailed": null,
"last_name": "Jones",
"last_opened": null,
"updated_at": 1422313790,
"custom_fields": [
{
"id": 23,
"name": "pet",
"value": "Fluffy",
"type": "text"
}
]
}
]
}{
"errors": [
{
"message": "The following parameters are not custom fields or reserved fields: [{field_name}]"
},
{
"message": "No search params are specified"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}POST
{
"list_id": -27497588,
"conditions": [
{
"and_or": "",
"field": "birthday",
"value": "01/12/1985",
"operator": "eq"
},
{
"and_or": "",
"field": "birthday",
"value": "01/12/1985",
"operator": "eq"
},
{
"and_or": "",
"field": "birthday",
"value": "01/12/1985",
"operator": "eq"
},
{
"and_or": "",
"field": "birthday",
"value": "01/12/1985",
"operator": "eq"
}
]
}{
"recipients": [
{
"created_at": -27901208,
"email": "ut magna quis ipsum",
"id": "fugiat ad adipisicing ullamco",
"last_emailed": 21626657
},
{
"created_at": 17466400,
"email": "sunt irure",
"id": "et",
"last_clicked": -23135244,
"last_opened": -44593357,
"first_name": "est"
},
{
"created_at": -34495329,
"email": "reprehenderit incididunt velit Lorem esse",
"id": "esse Ut ad dolore",
"last_clicked": 10164083,
"last_opened": 34443062
},
{
"created_at": -37030673,
"email": "amet deserunt fugiat voluptate",
"id": "et exercitation commodo id laborum",
"last_clicked": -10497425
},
{
"created_at": 3658435,
"email": "labore veniam",
"id": "ad pariatur esse",
"last_opened": -84227501,
"custom_fields": [
{
"id": -5765608,
"name": "proident pariatur",
"value": "do in magna mollit",
"type": "dolore ut"
},
{
"id": -31131201,
"name": "laborum mollit",
"value": 84434696,
"type": "veniam"
}
],
"updated_at": -56455352,
"first_name": "Ut cupidatat nulla deserunt adipisicing",
"last_clicked": -52862671
}
],
"recipient_count": 65190677
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Contacts API - Custom Fields(5 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "ipsum tempor Duis consequat in" |
{
"name": "pet",
"type": "text"
}{
"id": 1,
"name": "pet",
"type": "text"
}{
"errors": [
{
"field": null,
"message": "Returned if request body is invalid JSON"
},
{
"field": "type",
"message": "Returned if custom field type is invalid or not provided"
},
{
"field": "name",
"message": "Returned if custom field name is not provided"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "cillum Duis tempor nostrud" |
{
"custom_fields": [
{
"id": 6234,
"name": "age",
"type": "number"
},
{
"id": 6233,
"name": "country",
"type": "text"
},
{
"id": 6235,
"name": "favorite_color",
"type": "text"
},
{
"id": 6239,
"name": "fname",
"type": "text"
},
{
"id": 6240,
"name": "lname",
"type": "text"
},
{
"id": 49439,
"name": "pet",
"type": "text"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "anim" |
{
"id": 1,
"name": "pet",
"type": "text"
}{
"errors": [
{
"message": "invalid id"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"message": "Custom field ID does not exist"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "eiusmod in ad" |
{
"message": "Custom Field delete is processing."
}{
"errors": [
{
"message": "Custom field in use by one or more segment conditions"
},
{
"message": "Custom field ID does not exist"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"message": "Custom field ID does not exist"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "nisi" |
{
"reserved_fields": [
{
"name": "first_name",
"type": "text"
},
{
"name": "last_name",
"type": "text"
},
{
"name": "email",
"type": "text"
},
{
"name": "created_at",
"type": "date"
},
{
"name": "updated_at",
"type": "date"
},
{
"name": "last_emailed",
"type": "date"
},
{
"name": "last_clicked",
"type": "date"
},
{
"name": "last_opened",
"type": "date"
},
{
"name": "lists",
"type": "set"
},
{
"name": "campaigns",
"type": "set"
},
{
"name": "my_custom_field",
"type": "text"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}Contacts API - Segments(6 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "sunt" |
{
"name": "Last Name Miller",
"list_id": 4,
"conditions": [
{
"field": "last_name",
"value": "Miller",
"operator": "eq",
"and_or": ""
},
{
"field": "last_clicked",
"value": "01/02/2015",
"operator": "gt",
"and_or": "and"
},
{
"field": "clicks.campaign_identifier",
"value": "513",
"operator": "eq",
"and_or": "or"
}
]
}{
"id": 1,
"name": "Last Name Miller",
"list_id": 4,
"conditions": [
{
"field": "last_name",
"value": "Miller",
"operator": "eq",
"and_or": ""
},
{
"field": "last_clicked",
"value": "01/02/2015",
"operator": "gt",
"and_or": "and"
},
{
"field": "clicks.campaign_identifier",
"value": "513",
"operator": "eq",
"and_or": "or"
}
],
"recipient_count": 0
}{
"errors": [
{
"message": "request body is not valid json"
},
{
"message": "invalid value is passed into one of the request body parameters"
},
{
"field": "field",
"message": "field and set value is not passed into the request body"
},
{
"field": "value",
"message": "value and set value is not passed into the request body"
},
{
"field": "operator",
"message": "operator and set value is not passed into the request body"
},
{
"field": "and_or",
"message": "and_or is not set on more than one condition and less than all conditions"
},
{
"field": "and_or",
"message": "and_or is set on all conditions"
},
{
"field": "and_or",
"message": "and_or is set on the only condition passed"
},
{
"field": "and_or",
"message": "and_or and set value is not passed into the request body"
},
{
"field": "list_id",
"message": "the list_id is not valid"
},
{
"field": "name",
"message": "the name is not valid"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "qui" |
{
"segments": [
{
"id": 1234,
"name": "Age segments < 25",
"conditions": [
{
"field": "age",
"value": "25",
"operator": "lt"
}
],
"recipient_count": 8
},
{
"id": 2345,
"name": "email address - gmail",
"conditions": [
{
"field": "email",
"value": "@gmail.com",
"operator": "contains"
}
],
"recipient_count": 0
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
segment_id* | -35410581 |
| Header Name | Example |
|---|---|
on-behalf-of | "reprehenderit cillum id deserunt nostrud" |
{
"id": 1,
"name": "Last Name Miller",
"list_id": 4,
"conditions": [
{
"field": "last_name",
"value": "Miller",
"operator": "eq",
"and_or": ""
}
],
"recipient_count": 1
}{
"errors": [
{
"message": "if segment_id is not valid"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"message": "segment_id not found"
}
]
}PATCH
| Query Parameter Name | Example |
|---|---|
segment_id | aliqua minim reprehenderit |
| Header Name | Example |
|---|---|
on-behalf-of | "voluptate reprehenderit occaecat quis" |
{
"name": "The Millers",
"list_id": 5,
"conditions": [
{
"field": "last_name",
"value": "Miller",
"operator": "eq",
"and_or": ""
}
]
}{
"id": 5,
"name": "The Millers",
"list_id": 5,
"conditions": [
{
"field": "last_name",
"value": "Miller",
"operator": "eq",
"and_or": ""
}
],
"recipient_count": 1
}{
"errors": [
{
"message": "request body is not valid json"
},
{
"message": "invalid value is passed into one of the request body parameters"
},
{
"segment_id": "segment_id",
"message": "segment id is not valid"
},
{
"field": "field",
"message": "field and set value is not passed into the request body"
},
{
"field": "value",
"message": "value and set value is not passed into the request body"
},
{
"field": "operator",
"message": "operator and set value is not passed into the request body"
},
{
"field": "and_or",
"message": "and_or is not set on more than one condition and less than all conditions"
},
{
"field": "and_or",
"message": "and_or is set on all conditions"
},
{
"field": "and_or",
"message": "and_or is set on the only condition passed"
},
{
"field": "and_or",
"message": "and_or and set value is not passed into the request body"
},
{
"field": "list_id",
"message": "the list_id is not valid"
},
{
"field": "name",
"message": "the name is not valid"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}DELETE
| Query Parameter Name | Example |
|---|---|
delete_contacts | false |
| Header Name | Example |
|---|---|
on-behalf-of | "do anim sint officia sunt" |
Error generating exampleError generating example{
"errors": [
{
"field": "segment_id",
"message": "Returned if segment_id is not valid"
},
{
"field": "delete_contacts",
"message": "Returned if delete_contacts is not a valid boolean"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"field": "segment_id",
"message": "segment_id does not exist"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
page | -85192547 |
page_size | -72341454 |
| Header Name | Example |
|---|---|
on-behalf-of | "anim esse reprehenderit aute" |
{
"recipients": [
{
"created_at": 1422313607,
"email": "jones@example.com",
"first_name": null,
"id": "YUBh",
"last_clicked": null,
"last_emailed": null,
"last_name": "Jones",
"last_opened": null,
"updated_at": 1422313790,
"custom_fields": [
{
"id": 23,
"name": "pet",
"value": "Indiana",
"type": "text"
}
]
}
]
}{}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{}Categories(3 operations)
GET
| Query Parameter Name | Example |
|---|---|
limit | -64808809 |
category | consectetur Lorem proident |
offset | -80609515 |
| Header Name | Example |
|---|---|
on-behalf-of | "mollit enim in" |
[
{
"category": "category 1"
},
{
"category": "category 2"
}
]{
"errors": [
{
"field": "sort_by",
"message": "invalid sort value"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
sort_by_metric | velit do irure |
sort_by_direction | desc |
start_date* | Ut |
end_date | ex occaecat veniam |
limit | 44768069 |
offset | 44783552 |
aggregated_by | week |
| Header Name | Example |
|---|---|
on-behalf-of | "proident" |
{
"date": "2015-01-01",
"stats": [
{
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 20,
"deferred": 0,
"delivered": 20,
"invalid_emails": 0,
"opens": 20,
"processed": 0,
"requests": 20,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 20,
"unique_opens": 20,
"unsubscribe_drops": 0,
"unsubscribes": 20
},
"name": "cat1",
"type": "category"
},
{
"metrics": {
"blocks": 1,
"bounce_drops": 0,
"bounces": 0,
"clicks": 19,
"deferred": 0,
"delivered": 19,
"invalid_emails": 0,
"opens": 19,
"processed": 0,
"requests": 20,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 19,
"unique_opens": 19,
"unsubscribe_drops": 0,
"unsubscribes": 19
},
"name": "cat2",
"type": "category"
},
{
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 5,
"deferred": 0,
"delivered": 5,
"invalid_emails": 0,
"opens": 5,
"processed": 0,
"requests": 5,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 5,
"unique_opens": 5,
"unsubscribe_drops": 0,
"unsubscribes": 5
},
"name": "cat3",
"type": "category"
},
{
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 6,
"deferred": 0,
"delivered": 5,
"invalid_emails": 0,
"opens": 6,
"processed": 0,
"requests": 5,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 5,
"unique_opens": 5,
"unsubscribe_drops": 0,
"unsubscribes": 6
},
"name": "cat4",
"type": "category"
},
{
"metrics": {
"blocks": 10,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 10,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
},
"name": "cat5",
"type": "category"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
start_date* | sed Lorem nostrud |
end_date | Ut do fugiat ex anim |
categories* | Lorem tempor cillum et nostrud |
limit | -95002547 |
offset | 67910433 |
aggregated_by | month |
| Header Name | Example |
|---|---|
on-behalf-of | "Excepteur dolor est aute ullamco" |
[
{
"date": "2015-10-01",
"stats": [
{
"type": "category",
"name": "docs",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
},
{
"type": "category",
"name": "mattscategory",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
},
{
"date": "2015-11-01",
"stats": [
{
"type": "category",
"name": "docs",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
},
{
"type": "category",
"name": "mattscategory",
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
}
]Campaigns API(11 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "in proident dolor id" |
{
"title": "March Newsletter",
"subject": "New Products for Spring!",
"sender_id": 124451,
"list_ids": [
110,
124
],
"segment_ids": [
110
],
"categories": [
"spring line"
],
"suppression_group_id": 42,
"custom_unsubscribe_url": "",
"ip_pool": "marketing",
"html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
"plain_content": "Check out our spring line!"
}{
"id": 986724,
"title": "March Newsletter",
"subject": "New Products for Spring!",
"sender_id": 124451,
"list_ids": [
110,
124
],
"segment_ids": [
110
],
"categories": [
"spring line"
],
"suppression_group_id": 42,
"custom_unsubscribe_url": "",
"ip_pool": "marketing",
"html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
"plain_content": "Check out our spring line!",
"status": "Draft"
}{
"errors": [
{
"field": "title",
"message": "title can't be blank"
},
{
"field": "title",
"message": "title is too long (maximum is 100 characters)"
},
{
"field": "categories",
"message": "categories exceeds 10 category limit"
},
{
"field": "html_content",
"message": "html_content exceeds the 1MB limit"
},
{
"field": "plain_content",
"message": "plain_content exceeds the 1MB limit"
},
{
"field": "sender_id",
"message": "sender_id does not exist"
},
{
"field": "sender_id",
"message": "sender_id is not a verified sender identity"
},
{
"field": "list_ids",
"message": "list_ids do not all exist"
},
{
"field": "segment_ids",
"message": "segment_ids do not all exist"
},
{
"field": "ip_pool",
"message": "The ip pool you provided is invalid"
},
{
"field": "suppression_group_id",
"message": "suppression_group_id does not exist"
},
{
"field": "unsubscribes",
"message": "Either suppression_group_id or custom_unsubscribe_url may be set/used, but not both. Please remove one before setting the other."
},
{
"field": null,
"message": "The JSON you have submitted cannot be parsed."
},
{
"field": null,
"message": "You've reached your limit of 250 campaigns. Please delete one or more and try again."
}
]
}{}GET
| Query Parameter Name | Example |
|---|---|
limit | 57522471 |
offset | 98006917 |
| Header Name | Example |
|---|---|
on-behalf-of | "in sit consectetur" |
{
"result": [
{
"id": 986724,
"title": "March Newsletter",
"subject": "New Products for Spring!",
"sender_id": 124451,
"list_ids": [
110,
124
],
"segment_ids": [
110
],
"categories": [
"spring line"
],
"suppression_group_id": 42,
"custom_unsubscribe_url": "",
"ip_pool": "marketing",
"html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
"plain_content": "Check out our spring line!",
"status": "Draft"
},
{
"id": 986723,
"title": "February Newsletter",
"subject": "Final Winter Product Sale!",
"sender_id": 124451,
"list_ids": [
110,
124
],
"segment_ids": [
110
],
"categories": [
"winter line"
],
"suppression_group_id": 42,
"custom_unsubscribe_url": "",
"ip_pool": "marketing",
"html_content": "<html><head><title></title></head><body><p>Last call for winter clothes!</p></body></html>",
"plain_content": "Last call for winter clothes!",
"status": "Sent"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "ad" |
{
"categories": [
"spring line"
],
"custom_unsubscribe_url": "",
"html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
"id": 986724,
"ip_pool": "marketing",
"list_ids": [
110
],
"plain_content": "Check out our spring line!",
"segment_ids": [
110
],
"sender_id": 124451,
"status": "Draft",
"subject": "New Products for Spring!",
"suppression_group_id": 42,
"title": "March Newsletter"
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"field": null,
"message": "not found"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "quis anim in exercitation nisi" |
Error generating example{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "enim anim qui" |
{
"title": "May Newsletter",
"subject": "New Products for Summer!",
"categories": [
"summer line"
],
"html_content": "<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>",
"plain_content": "Check out our summer line!"
}{
"id": 986724,
"title": "May Newsletter",
"subject": "New Products for Summer!",
"sender_id": 124451,
"list_ids": [
110,
124
],
"segment_ids": [
110
],
"categories": [
"summer line"
],
"suppression_group_id": 42,
"custom_unsubscribe_url": "",
"ip_pool": "marketing",
"html_content": "<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>",
"plain_content": "Check out our summer line!",
"status": "Draft"
}{
"errors": [
{
"field": "title",
"message": "title can't be blank"
},
{
"field": "title",
"message": "title is too long (maximum is 100 characters)"
},
{
"field": "categories",
"message": "categories exceeds 10 category limit"
},
{
"field": "html_content",
"message": "html_content exceeds the 1MB limit"
},
{
"field": "plain_content",
"message": "plain_content exceeds the 1MB limit"
},
{
"field": "sender_id",
"message": "sender_id does not exist"
},
{
"field": "sender_id",
"message": "sender_id is not a verified sender identity"
},
{
"field": "list_ids",
"message": "list_ids do not all exist"
},
{
"field": "segment_ids",
"message": "segment_ids do not all exist"
},
{
"field": "ip_pool",
"message": "The ip pool you provided is invalid"
},
{
"field": "suppression_group_id",
"message": "suppression_group_id does not exist"
},
{
"field": "unsubscribes",
"message": "Either suppression_group_id or custom_unsubscribe_url may be set/used, but not both. Please remove one before setting the other."
},
{
"field": null,
"message": "The JSON you have submitted cannot be parsed."
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"field": null,
"message": "You may only update a campaign when it is in draft mode."
}
]
}{
"errors": [
{
"field": null,
"message": "not found"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "laboris enim aliqua" |
{
"id": 1234,
"status": "Scheduled"
}{
"errors": [
{
"field": "subject",
"message": "subject can't be blank"
},
{
"field": "sender_id",
"message": "sender_id can't be blank"
},
{
"field": "plain_content",
"message": "plain_content can't be blank, please provide plain text or html content"
},
{
"field": "list_id",
"message": "You must select at least 1 segment or 1 list to send to."
},
{
"field": "unsubscribe_tag",
"message": "An [unsubscribe] tag in both your html and plain content is required to send a campaign."
},
{
"field": "suppression_group_id",
"message": "Either a suppression_group_id or custom_unsubscribe_url is required to send a campaign."
},
{
"field": null,
"message": "You do not have enough credits to send this campaign. Upgrade your plan to send more: https://app.sendgrid.com/settings/billing"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"field": null,
"message": "You may only send a campaign when it is in draft mode."
}
]
}{
"errors": [
{
"field": null,
"message": "not found"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "voluptate velit dolore" |
{
"send_at": 1489771528
}{
"id": 1234,
"send_at": 1489771528,
"status": "Scheduled"
}{
"errors": [
{
"field": "subject",
"message": "subject can't be blank"
},
{
"field": "sender_id",
"message": "sender_id can't be blank"
},
{
"field": "plain_content",
"message": "plain_content can't be blank, please provide plain text or html content"
},
{
"field": "list_id",
"message": "You must select at least 1 segment or 1 list to send to."
},
{
"field": "unsubscribe_tag",
"message": "An [unsubscribe] tag in both your html and plain content is required to send a campaign."
},
{
"field": "suppression_group_id",
"message": "Either a suppression_group_id or custom_unsubscribe_url is required to send a campaign."
},
{
"field": null,
"message": "You do not have enough credits to send this campaign. Upgrade your plan to send more: https://app.sendgrid.com/settings/billing"
}
]
}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}{
"errors": [
{
"field": null,
"message": "You cannot POST to a campaign that has already sent or scheduled. However you can update a scheduled campaign with a PATCH."
}
]
}{
"errors": [
{
"field": null,
"message": "not found"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "Ut aute" |
{
"send_at": 1489451436
}{
"id": 2179470,
"send_at": -92546989,
"status": "eu Excepteur est ad"
}{
"errors": [
{
"field": "send_at",
"message": "Please choose a future time for sending your campaign."
},
{
"field": null,
"message": "The JSON you have submitted cannot be parsed."
},
{
"field": null,
"message": "You do not have enough credits to send this campaign. Upgrade your plan to send https://app.sendgrid.com/settings/billing"
}
]
}{
"errors": [
{
"field": "send_at",
"message": "You cannot update the send_at value of non-scheduled campaign."
}
]
}{
"errors": [
{
"field": null,
"message": "not found"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "eiusmod deserunt Lorem labore" |
{
"send_at": 1490778528
}{
"errors": [
{
"field": null,
"message": "not found"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "ipsum ut quis Lorem pariatur" |
Error generating example{
"errors": [
{
"field": null,
"message": "This campaign is already In Progress."
},
{
"field": null,
"message": "This campaign is already Sent."
},
{
"field": null,
"message": "This campaign is already Paused."
},
{
"field": null,
"message": "This campaign is already Canceled."
}
]
}{
"errors": [
{
"field": null,
"message": "not found"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "in in consequat magna" |
{
"to": "your.email@example.com"
}{
"to": "id commodo in et"
}{
"errors": [
{
"field": "send_at",
"message": "Please choose a future time for sending your campaign."
},
{
"field": null,
"message": "The JSON you have submitted cannot be parsed."
},
{
"field": null,
"message": "You do not have enough credits to send this campaign. Upgrade your plan to send more: https://app.sendgrid.com/settings/billing"
}
]
}{
"errors": [
{
"field": null,
"message": "not found"
}
]
}Transactional Templates(6 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "anim" |
{
"name": "example_name",
"generation": "dynamic"
}{
"id": "733ba07f-ead1-41fc-933a-3976baa23716",
"name": "example_name",
"generation": "legacy",
"versions": []
}GET
| Query Parameter Name | Example |
|---|---|
generations | dynamic |
page_size* | 96.93527301595473 |
page_token | aute ut |
| Header Name | Example |
|---|---|
on-behalf-of | "labore in" |
{
"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": [
{
"": "ut",
"message": "adipisicing do ullamco ut",
"error_id": "ea tempor sit"
},
{
"": "in",
"message": "aliqua velit",
"error_id": "mollit ut laboris labore aute"
},
{
"": "velit",
"message": "minim",
"error_id": "velit sit nulla"
},
{
"": "aliquip",
"message": "laborum enim do",
"error_id": "ea occaecat tempor ipsum qui"
},
{
"": "quis deserunt incididunt irure",
"message": "amet laboris",
"error_id": "sed exercitation magna dolor ipsum"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "dolor sit dolore esse" |
{
"name": "example_name"
}{
"id": "733ba07f-ead1-41fc-933a-3976baa2371",
"name": "example_name",
"generation": "dynamic",
"updated_at ": "2019-03-13T11:52:41.009Z",
"versions": []
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "culpa eiusmod minim sit Lorem" |
{
"id": "40da60e6-66f3-4223-9406-ba58b7f55a62",
"name": "Duis in dolor",
"generation": "legacy",
"updated_at ": "2020-12-12 58:26:65",
"versions": []
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "elit dolore quis sunt dolore" |
{
"name": "new_example_name"
}{
"id": "733ba07f-ead1-41fc-933a-3976baa23716",
"name": "new_example_name",
"versions": []
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "eu Ut anim" |
{}Transactional Templates Versions(5 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "et sit non sint eu" |
{
"active": 1,
"name": "example_version_name",
"html_content": "<HTML body content>",
"plain_content": "Plain text content",
"generate_plain_content": false,
"subject": "<Subject>",
"editor": "design"
}{
"id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
"template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
"active": 1,
"name": "example_version_name",
"html_content": "<%body%>",
"plain_content": "<%body%>",
"generate_plain_content": true,
"subject": "<%subject%>",
"updated_at": "2019-03-13 18:56:33",
"editor": "code"
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "sint eu fugiat" |
{
"id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
"template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
"active": 1,
"name": "example_version_name",
"html_content": "<%body%>",
"plain_content": "<%body%>",
"generate_plain_content": true,
"subject": "<%subject%>",
"updated_at": "2019-03-13 18:56:33",
"editor": "code"
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "qui" |
{
"id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
"template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
"active": 1,
"name": "example_version_name",
"html_content": "<%body%>",
"plain_content": "<%body%>",
"generate_plain_content": true,
"subject": "<%subject%>",
"updated_at": "2019-03-13 18:56:33",
"editor": "code"
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "adipisicing qui" |
{
"template_id": "Excepteur Ut qui",
"active": 1,
"name": "pariatur non incididunt commodo",
"html_content": "dolor",
"generate_plain_content": false,
"subject": "aliquip nulla Ut",
"editor": "design",
"plain_content": "labore dolore"
}{
"id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
"template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
"active": 1,
"name": "example_version_name",
"html_content": "<%body%>",
"plain_content": "<%body%>",
"generate_plain_content": true,
"subject": "<%subject%>",
"updated_at": "2019-03-13 18:56:33",
"editor": "code"
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "Lorem nisi" |
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Webhooks(7 operations)
GET
| Header Name | Example |
|---|---|
on-behalf-of | "ex" |
{
"enabled": false,
"url": "incididunt reprehenderit",
"group_resubscribe": false,
"delivered": false,
"group_unsubscribe": false,
"spam_report": false,
"bounce": false,
"deferred": false,
"unsubscribe": true,
"processed": false,
"open": true,
"click": true,
"dropped": true,
"oauth_client_id": "est fugiat",
"oauth_token_url": "Duis in laborum sunt"
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "labore sunt qui incididunt" |
{
"enabled": false,
"url": "id aliqua",
"group_resubscribe": true,
"delivered": false,
"group_unsubscribe": true,
"spam_report": true,
"bounce": false,
"deferred": false,
"unsubscribe": true,
"processed": false,
"open": false,
"click": false,
"dropped": false,
"oauth_client_id": "reprehenderit in null",
"oauth_client_secret": "ea in nostrud",
"oauth_token_url": "cupidatat ad Ut"
}{
"enabled": true,
"url": "mollit laborum",
"group_resubscribe": false,
"delivered": true,
"group_unsubscribe": true,
"spam_report": true,
"bounce": true,
"deferred": true,
"unsubscribe": true,
"processed": true,
"open": true,
"click": false,
"dropped": true,
"oauth_client_id": "anim sunt",
"oauth_token_url": "ex"
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "dolor in adipisicing Ut cillum" |
{
"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": "ipsum Duis"
},
{
"message": "deserunt"
},
{
"message": "mollit dolore sint"
},
{
"message": "sunt"
},
{
"message": "ex ad est in elit"
}
]
}GET
| Query Parameter Name | Example |
|---|---|
limit | ex |
offset | dolore |
aggregated_by | week |
start_date* | velit est tempor |
end_date | ut |
| Header Name | Example |
|---|---|
on-behalf-of | "incididunt qui officia" |
[
{
"date": "2015-10-11",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-12",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-13",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-14",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-15",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-16",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-17",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-18",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-19",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-20",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-21",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-22",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-23",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-24",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-25",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-26",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-27",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-28",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-29",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-30",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-10-31",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-11-01",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-11-02",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-11-03",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-11-04",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-11-05",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-11-06",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-11-07",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-11-08",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-11-09",
"stats": [
{
"metrics": {
"received": 0
}
}
]
},
{
"date": "2015-11-10",
"stats": [
{
"metrics": {
"received": 0
}
}
]
}
]GET
| Header Name | Example |
|---|---|
on-behalf-of | "aute voluptate" |
{
"public_key": "anim quis in sint"
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "do sunt exercitation consequat" |
{
"enabled": true
}{
"public_key": "voluptate id Excepteur proident"
}{
"errors": [
{
"message": "mollit consequat dolore commodo",
"field": "anim Ut"
},
{
"message": "qui"
},
{
"message": "commodo dolor ipsum"
},
{
"message": "minim fugiat amet",
"field": "quis consectetur eiusmod ullamco laboris"
}
]
}{
"errors": [
{
"message": "fugiat",
"field": "in proident"
},
{
"message": "adipisicing veniam laboris sunt ullamco",
"field": "ut"
},
{
"message": "id sunt consequat Duis irure"
},
{
"message": "nisi",
"field": "in qui"
},
{
"message": "tempor in eiusmod elit"
}
]
}{
"errors": [
{
"message": "Excepteur culpa esse ea ut"
},
{
"message": "enim Excepteur dolore dolore"
},
{
"message": "dolor occaecat"
}
]
}POST
| Header Name | Example |
|---|---|
on-behalf-of | "Ut" |
{
"url": "mollit non ipsum magna",
"oauth_client_id": "nisi",
"oauth_client_secret": "veniam commodo ex sunt",
"oauth_token_url": "dolor Duis"
}Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.Settings - Inbound Parse(4 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "sint et sit" |
{
"url": "http://email.myhostname.com",
"hostname": "myhostname.com",
"spam_check": false,
"send_raw": true
}{
"url": "http://email.myhostname.com",
"hostname": "myhostname.com",
"spam_check": false,
"send_raw": true
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "tempor est aute"
},
{
"message": "Ut dolor"
},
{
"message": "incididunt culpa nulla"
},
{
"message": "ut"
},
{
"message": "nostrud"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "magna ad culpa cillum sunt" |
{
"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": "magna"
},
{
"message": "quis et commodo consectetur in"
},
{
"message": "ipsum eiusmod aliqua"
},
{
"message": "nisi cillum minim et"
}
]
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "ex" |
{
"url": "http://email.myhostname.com",
"hostname": "myhostname.com",
"spam_check": false,
"send_raw": true
}{
"url": "http://mydomain.com/parse",
"hostname": "mail.mydomain.com",
"spam_check": true,
"send_raw": true
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "et consequat Duis"
},
{
"message": "ullamco exercitation non reprehenderit Ut"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "consequat enim veniam" |
{}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}{
"errors": [
{
"message": "anim magna nostrud ea laboris"
},
{
"message": "dolor"
}
]
}Query(2 operations)
GET
| Query Parameter Name | Example |
|---|---|
query* | proident aute adipisicing |
limit | 663.6306944452895 |
| Header Name | Example |
|---|---|
X-Query-Id | "sunt consectetur esse veniam" |
X-Cursor | "veniam ut consequat occaecat qui" |
Authorization* | "in Duis exercitation" |
{
"messages": [
{
"from_email": "from@test.com",
"msg_id": "abc123",
"subject": "something profound",
"to_email": "to@test.com",
"status": "processed",
"opens_count": 0,
"clicks_count": 0,
"last_event_time": 1495064728,
"last_timestamp": 1495064728
},
{
"from_email": "yeah@test.com",
"msg_id": "321befe",
"subject": "something profound",
"to_email": "nah@test.com",
"status": "delivered",
"opens_count": 500,
"clicks_count": 200,
"last_event_time": 1495064793,
"last_timestamp": 1495064793
},
{
"from_email": "sad@test.com",
"msg_id": "434512dfg",
"subject": "something sad",
"to_email": "reject@test.com",
"status": "not delivered",
"opens_count": 0,
"clicks_count": 0,
"last_event_time": 1495064993,
"last_timestamp": 1495064993
}
]
}{
"errors": [
{
"message": "invalid syntax: 'bad_field' is not a known field"
}
]
}{
"errors": [
{
"message": "too many requests"
}
]
}GET
| Header Name | Example |
|---|---|
Authorization* | "consequat" |
{
"from_email": "LKb.pOGYIZbfxMgi7Le0K1YWym%e5pz2PiuGbwByM2tR+wRPqfoFg1__35DaWF8CDhzYJg@ZTSFDjbgdxD23oq34Lun1NUnyymoGT4G.5i1IEzQpXWAvNwx.BNckAJiBCnwEVnwBfrbMlouoOPmtTSEbdPp",
"msg_id": "hznSfJ1RfKeIKS1B4mShNnkRMpdt5IXXKf",
"subject": "culpa aute amet magna sint",
"to_email": "+lOnUtHodefMsuBw.kunNalfcxRos5USSRoR@r5uEXYPP6wrQGRQ-vBg33fLY6MVkkMd-DKT8Z1iqt4qnrL23xMOZ8GWd.fyghGEFceTHIUpgwNGlwEtFHJikSaPzsnYfrJPKydPVPAlItJtqykRHZSGW",
"status": "delivered",
"template_id": "d674d9b7-e8e5-4e30-87be-1b3b026235fd",
"asm_group_id": 5464443,
"teammate": "9a8F0EP88wSSJeuOyXtbfc7BkK",
"api_key_id": "bUshz3LGa3coToxA2sWViYAEJJmYZJRyY9BCQY",
"events": [
{
"event_name": "unsubscribe",
"processed": 7085461846,
"bounce_type": "soft",
"http_user_agent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0",
"mx_server": "s",
"attempt_num": 8
},
{
"event_name": "dropped",
"processed": 9878933331,
"attempt_num": 3,
"url": "G_3c-1HtUkN4`puC&&!u>0OiStFG.ZoRi2=j%fUVa]&re6k{hKqD-8vWE<hw-Bd>12Fb5JC6z>S@@'cWS~w5KtuIwv$8/JDD94CXx1n5yjC_I2lQ66zDj4MXe/4bqlcqqQ7evnQWTYx5roaEYMapyuzb/USpsyalh/HcYc9PmQfF8ND_C7bXnwFQ_fb_BHMXbIV8JN28/NjZdawDJ6kSWxLykSVTHzcISGPBRfs_rt3Uc65Vzj6LDSSMN8WRs70m0tAWs/fkDvjvm_7ZeV08YZeB9j9mS9BcE089Fn5UzDlTJW9vqDF5uipjlIVrNbM7oWE/MIJcjg2vJO20jA24WHrchrEXCvKcxriviSDl3tuyDxqdqRSekpm2aH6yW7_ylXj/nWsex4jm3rKvYw1uLq3Tp7qb9edhj8B_TnwLv1yjHSkgbA5jKI4BTqxugmwVTnFf2OFCFp/ZILLkoKgfwOyIK4reUIkhCjuhkwp/cqGaFAkeCFQXPB6DLYesLZ2M3KPuBsBrs3pr3HRbTtwaOzdKtGc8e0C0VTjrJ3GwljStMPrSuQWh6/vigHRasZ4P9kFv5DPVbHWZzPvtwUw0AMByt44YH678WpbAXXy4I/IVOHmErZTbw1mJ/3vd4uI5rr2zEO_YA9qJZLJT/wmBimbOyaMtmTNYr_FhgfkKMN3_1la7RCK8CIP3p26mbuHbdJV1j/5sTIKibInM5l2BoWdEi49bPqzagsfjKpGVbg0YQ8mjrLhI92/qy0eVYi34kBGVuLzxK2FLC8vwYUrbupjUYE23Mc_6nmHYRK1HF1QmZDZG1hw96I3MPbTZqeJOWGch230qDNxOgnHRNNM52k/3c7FeuRr88RwZGpif/4FaSAbdqkUNvJ9J9qX2tJS9x5vZlgD8k4YHIXDztrnwg2VPquj/uo_2MjbWybIF/NGJM2RFAsKV1S5iOejuTV4p12KlH1p0Dt5EpxCSIl0XoWuvyLYar77f_hzqNdWAyL0FDxGfj4ma4jwqdTTLNyeZEtguYoCHTFfY/HgJkpHx/yO23G7gLhKPvD459ceffHidFh7LipTxNF0GFXhIAPrWfhv7PkPmVofBoFFlo6/rMcHQ82d5VS8i1CCyLtfuT5WH9GqrsOY7xo3lxi7BNL93/PLRdQT3SObRFRERw68V5ZFvIuEQqFOFZQ848rWPLXYDGY658dyjZALf/Ug4EROi_ehNtzPwecer_RGBHxeMnpxrPAFZEL6YXNKzm8hh3HY4Uc4fgkjge5fXsR4CeTSkS66/FOD00deDKmN7XcHEj1LGlAmd4XlV8vFpXg2VazX4OLW8z6vXn5vntNGYO6eBCEKUwupRz9nQSMeZ/Pbmjoopyt6TxQBUfPkHBdgCIhqA1zDV72ARqGlK_ao9KVjvgbB98YeiieIyogkuOa4y0E5iUEdBopzovVgtY88yLijh9ww/tl0R5rI2P2_OxguTbv_wrfEm8jRjISEIqSE9q29RB3n8PeD4hu24rcsaEuTMCqniiLN0a2OtZiKxHnbsNB660Aq3/tEo2SHZBkkIFYXBbDNE7gLfvFz9ZaC_E2oV2quyK1Id5SkNkJBVRRgROWBc_XEOXktc4vRUKxy1MQ526Xilyo8/uI67lHH1Vlr4V3GVmweT4A16KMqzmVzvRDRFLpkBv2iu3Okc1vIqkC/426aOqeUm6SXIx16d8BWVRcmqKqizxDEF3JkLFgX0ab73CZ4GdJ9YaakJO7y4adFGzzIVLcn08UZ/pwDQ9BAuwuMc2yMnKihdvmLKbnAa1ATk9jFXQ9QAEMBHZLbPNvtS3pkpk0s6fyh2ceHa9Myy3fL/oqvPmq_14KzLgPZHaOlyb3tUoQM52fv/I78TqTGyB4WYD_vkm8gYHZcCF0dFIXsiXUbAbwR90Ldk8lsgxSL6rBvjPSlQq7N66NPzUVRYr3zSISupG_66uS4rJszHwmxmmraT3/zfVKxHXFHgxUDRmnwIMfdFKm4sf/qnRRccOLExJYGcZy8u65jo4gHDvO6vnpsdf0YtVWqDBJXa95/Y/qL7EYS73_t6/2xnWra9TTO0OtQNXEQ1XXLSLt6vPw1FTlE2aYCitDgUo7DyxiwuGtvmMKUkYCo/lqXouo2TGXZFF80lrCu1vKdxBgOOerlrsKrOJawGEzL8XzXdxkOMUT8HOzHPNOvDwsxc47mvpVzXEbX5DRaioOlm2U4flTG/6bZfLqJqHNtrKwC5U5NNG6_yNOW5Jg_bLmzUosi86IXxn7i04vRXXn92JmdE70TcdujehT1n15wtiD8ld5A65IV2W1801/wr0XcDIGiUSmxFfCozUCtBTFwln0uJ0cquSDXhj7JQADhYDGyz8WhqcPE7CP9xN93EUBrWczINbA4IsfckY8CZh68/Tak5dEhw8i_3rz/8U39D/iML1G_A8TsnKQ9/_S8o89fFc7Wx/f1nXF8H6OLVbPpp5IZg7UTZ2K0bSe3iBpsmkkJpxY_6zEHTJE3LbIANwF9Ik5Tu0ZJpjck7I07xlHR8mDW9FXclSQC/qJUGL5qByf2SY2Wd24hqKGrahLfqApQuRI8_DtU/Y8kH6DDif5kD6as3sIe6VbKYnU9c1URq/npTlE72m107FXxW9zktdzbBJAxt4udMFzjt2LPcBpqrMKGkrg4BHqKXwhFTspCWyYCjxJ/eFb3fd3BB5kb9D0yl3oOjeWtbJBqsboyzdLisRBn2MCtXO2O8eo4Hkm/2uJDoRjRCyIi2GNRkH0B3EkN6Z3vG40C985bAtM8eqHABzP2QRcKCz4ICOw_Xz249bJk8qM0/m4EeIWnx2ISf9TBU6_0KZ5QJ0VPOCPXxV9jCeK5W5/RV5nd7GUUXG0btDqUAa3DzpaRHX3klMAqL73hK4AGD3ItikmxF8vnSaqtsgOCpEePERt9qcUOJJP2aR0scPAf_1TkGSrgr5VF/XLM2i7YhC_3J9fA2Qwa0dbTedY/xGayjimEkuWSWvh7P5FNOum_l7qJPnA31lQq6ixqR0NKhO328rWfijqKHF6WR/5O0MJ4WNuIXk6xBtTOA9mK7CGUgWjaF5mB72PVnDpN8G6ERO39GqO/fCO96/A1mwIPWedF6HklU8jaQ_M5EUzwCsBE3/7FW2hbcD3GCOFCiLvObjn59o6CKoYlmTop/PZw2CLzvARAr5KaLhjIuZRSKTGlmYjvSoSELuvWi/QHUV7SJ0kF_1O3b_3a88cm/z7qD3Rp6MmoQdGPSyu1lXTpoETypgOMywfsr4ycV2LQr5XaE3UrQP/RzobA4rI_I3ceCUaRASmil2rV1TUiyljhdCFt8zmi1o2NyTzSBRNGP0lXU5Qtm6dKKp7lGRC19P2oSSFrxt85vWRNo1mv8odcL/TF7/MN1Ev7gY20MqlRSBrlwg5LZ4_Az7QnBnpbU3LkTC/oVb743VFtXMW4cK/3lw6wfBJZe_8DobxT_6/gCXp6QOs/LuqmrQHMQvTS6jfbqVFnPfLjrQ01Mb_F4lr3md6m87wpc1CYd9hdzgUL/aqz68HMDCxjGauC00Rajq9wGVYcWJ3j6rIaHIPwclftjARXFDg0yH8v/L6qDgIgGwbB3eZfjOXHAMXRFNMMihseZxYkcFAzLtYr94q9XpQeK4bKi9h_rWAMwcEHnS8/MHHlySbgy8azGEA0u9xsY96MRi45Qe74kZ9xlsI1t4Yutx8/gsjIiu7vNsKEyeTwd88BMExjWNcJHOSHRff57pJBMEAtPdbMETYorvUkRyErsqprxX0W45n0RRQ85w/JCOsYaxZOAFfzO0AdLpMCguFwl01fkFOKYrQeXfNn8w0KF4XS0k/fPx02fU7fFjUoXcPH7_9xo755WL8DNIU2ne4b6DpiROe473yUfD8_zSNUI1tpxzVYNA7GvVSYt8UtqHn3/_QwuOc4VeAI6RiAG5O5bcAxzQl96Q35emNwtTT_CYqHORCmyPj6By2hT_SCLf8m_xFxxe3YzvnxDZGq3qf__pq7Tw181/GosBAJy3MotiIxcYDASbY9sV4T2V/KoGHyJ64spdkQbJOHJ216JMSKj8ii5m8gxqJ2ypL81p5hbjWtjbUgSc8M_KTLuc0Owf1R/3vr/dKbQ2pJ4XEfXhnZTBQY7ZrClnVCnd5cMe9ic/aNF0yyOSQVVOecUFkK9IYFVR8VHdVf4/Nfu3nOEskHki1_r3At1HLOMniS6qNTvhS0hfqIuBiQBsd5aB7OdfVpYy1HdIR72gMToBlpHPsE5GrVO0J9/gcyB2xcyZ3UpTom8G3V48LUkk6kcJ6l1SL5Fgzbst0z3pDA4dzBfswbC8dW57_MkswDANNd8atPrOBSU5m2z66dP/mIYQ8iq/DcmBexkARDI47VzYuw5gwy8Lvym2_B2gxBokU9_T/fHCPjlpqjTsY6SgBOz1nlDh_HcSWYAqnyrZxbEO2erVJ4WPKNzjM3KaPXGH/dZryna1E28wxCrMqLCs9aL9oVBlDMjUcEryAyRh7xwN0uWGopdpkd7Du6O9EPjAj37sHkUiVs7WL6JyexoDF_n67MICvQnJ9FK/FVrp1uMZnmr7ijkMW87moNRBkXbVc2EA_hHOHmpbVGqr6WgNtJ7bBk1LrAPT8sKtE75vbe_L9VYqBHJ/njk.WIIj-V23pwC7ZahcIL0XnDPupL7ltwEc779Ofhrk9dt_wIOFsA8XwnCjrYqH2ty.F0XdS\"*;@kDYgfL4dwE/5I@>k|u0D:wGz\"_8=}RJM!Ybbwd}eN=ZB*esF&(iQ%FW]_FSA:3Ze4O*6&tG-Fe**/j^a&S8zIa#6gxL2NmnNMSVGF-Bf3z08tt0ug_UfNshhs4HJh0l1o24gjAN-Uck1OvWkGQSXH0glB7CnOm0gI",
"bounce_type": "soft",
"mx_server": "laborum nisi",
"http_user_agent": "quis re"
}
],
"originating_ip": "204.173.18.0",
"categories": [
"dolor",
"pie"
],
"unique_args": "eu",
"outbound_ip": "181.40.184.87",
"outbound_ip_type": "dedicated",
"id": "2mMUdxV2HRfAeDiBTYs2IP"
}{
"errors": [
{
"message": "invalid syntax: 'bad_field' is not a known field"
}
]
}{
"errors": [
{
"message": "not found",
"field": "message_id"
}
]
}{
"errors": [
{
"message": "too many requests"
}
]
}CSV (UI only)(2 operations)
POST
| Query Parameter Name | Example |
|---|---|
query | enim |
| Header Name | Example |
|---|---|
Authorization* | "cillum" |
{
"status": "pending",
"message": "An email will be sent to jane_doe@example.com when the CSV is ready to download."
}{
"errors": [
{
"message": "some error"
}
]
}{
"errors": [
{
"message": "too many requests",
"field": ""
}
]
}{
"errors": [
{
"message": "internal server error"
}
]
}GET
| Header Name | Example |
|---|---|
Authorization* | "aliquip officia in ea" |
{
"presigned_url": "https://example.com",
"csv": "https://s3-us-west-2.amazonaws.com/sendgrid-rts-development-queries/013c31af-7c9a-49e6-922c-d990f4aff151.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Credential=AKIAI4NOW7APZHRFYGWQ%2F20170728%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-SignedHeaders=host&X-Amz-Date=20170728T223936Z&X-Amz-Signature=5c13ede58b211799ab1a556280bd316c404eac3aef1450c47906a077166c4ab4"
}{
"errors": [
{
"message": "download token is invalid or expired",
"field": ""
}
]
}{
"errors": [
{
"message": "internal server error"
}
]
}Settings - Tracking(9 operations)
GET
| Header Name | Example |
|---|---|
on-behalf-of | "eiusmod qui enim nisi" |
{
"result": [
{
"name": "open",
"title": "Open Tracking",
"description": "lorem ipsum... .",
"enabled": true
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "enim deserunt dolor consequat id" |
{
"enable_text": false,
"enabled": true
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "Lorem in Excepteur consectetur officia" |
{
"enabled": true
}{
"enable_text": false,
"enabled": true
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "amet" |
{
"enabled": true,
"utm_campaign": "",
"utm_content": "lotsandlotsofcontent",
"utm_medium": "",
"utm_source": "",
"utm_term": ""
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "sint ad officia non" |
{
"enabled": true,
"utm_source": "sendgrid.com",
"utm_medium": "email",
"utm_term": "",
"utm_content": "",
"utm_campaign": "website"
}{
"enabled": true,
"utm_campaign": "",
"utm_content": "lotsandlotsofcontent",
"utm_medium": "",
"utm_source": "",
"utm_term": ""
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "irure enim" |
{
"enabled": true
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "dolor Ut veniam" |
{
"enabled": true
}{
"enabled": true
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "enim nisi ut nulla consectetur" |
{
"enabled": true,
"html_content": "<p>Something something unsubscribe <% %> something something</p>\n",
"landing": "<p>subscribehere</p>\n",
"plain_content": "Something something unsubscribe <% %> something something",
"replace": "thetag",
"url": ""
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "sunt" |
{
"enabled": true,
"landing": "landing page html",
"url": "url",
"replace": "replacement tag",
"html_content": "html content",
"plain_content": "text content"
}{
"enabled": true,
"landing": "landing page html",
"url": "url",
"replace": "replacement tag",
"html_content": "html content",
"plain_content": "text content"
}Stats(7 operations)
GET
| Query Parameter Name | Example |
|---|---|
limit | -41396094 |
offset | -84272675 |
aggregated_by | week |
start_date* | Excepteur fugiat Ut ad veniam |
end_date | magna |
| Header Name | Example |
|---|---|
on-behalf-of | "labore adipisicing deserunt ullamco" |
[
{
"date": "2015-11-03",
"stats": [
{
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
},
{
"date": "2015-11-04",
"stats": [
{
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
},
{
"date": "2015-11-05",
"stats": [
{
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
},
{
"date": "2015-11-06",
"stats": [
{
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
},
{
"date": "2015-11-07",
"stats": [
{
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
},
{
"date": "2015-11-08",
"stats": [
{
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
},
{
"date": "2015-11-09",
"stats": [
{
"metrics": {
"blocks": 0,
"bounce_drops": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"invalid_emails": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_report_drops": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0,
"unsubscribe_drops": 0,
"unsubscribes": 0
}
}
]
}
]GET
| Query Parameter Name | Example |
|---|---|
country | US |
limit | -11434370 |
offset | 11574647 |
aggregated_by | month |
start_date* | occaecat dolor |
end_date | sit quis |
| Header Name | Example |
|---|---|
on-behalf-of | "velit irure occaecat amet" |
[
{
"date": "2015-10-11",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-12",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-13",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-14",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-15",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-16",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-17",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-18",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-19",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-20",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-21",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 1,
"unique_clicks": 0,
"unique_opens": 1
}
}
]
},
{
"date": "2015-10-22",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-23",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-24",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-25",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-26",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-27",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-28",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-29",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-30",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-31",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-01",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-02",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-03",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-04",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-05",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-06",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-07",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-08",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-09",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-10",
"stats": [
{
"type": "province",
"name": "TX",
"metrics": {
"clicks": 0,
"opens": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
}
]GET
| Query Parameter Name | Example |
|---|---|
limit | 26447103 |
offset | -1940509 |
aggregated_by | day |
start_date* | anim cillum Excepteur aliquip |
end_date | ut tempor |
| Header Name | Example |
|---|---|
on-behalf-of | "pariatur" |
[
{
"date": "2015-10-11",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-12",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-13",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-14",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-15",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-16",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-17",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-18",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-19",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-20",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-21",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 1,
"unique_opens": 1
}
}
]
},
{
"date": "2015-10-22",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-23",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-24",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-25",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-26",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 2,
"unique_opens": 2
}
}
]
},
{
"date": "2015-10-27",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-28",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-29",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-30",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-31",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-01",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-02",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-03",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-04",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-05",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-06",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-07",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-08",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-09",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-10",
"stats": [
{
"type": "device",
"name": "Webmail",
"metrics": {
"opens": 0,
"unique_opens": 0
}
}
]
}
]GET
| Query Parameter Name | Example |
|---|---|
start_date* | cillum eu laboris enim eiusmod |
end_date | amet |
aggregated_by | day |
| Header Name | Example |
|---|---|
on-behalf-of | "irure veniam" |
[
{
"date": "2014-10-01",
"stats": [
{
"metrics": {
"opens": 1,
"unique_opens": 1
},
"name": "Gmail",
"type": "client"
}
]
},
{
"date": "2014-10-02",
"stats": [
{
"metrics": {
"opens": 0,
"unique_opens": 0
},
"name": "Gmail",
"type": "client"
}
]
}
]GET
| Query Parameter Name | Example |
|---|---|
start_date* | ut officia |
end_date | veniam eiusmod nostrud |
aggregated_by | day |
| Header Name | Example |
|---|---|
on-behalf-of | "ut enim et ad eiusmod" |
[
{
"date": "2014-10-01",
"stats": [
{
"metrics": {
"opens": 1,
"unique_opens": 1
},
"name": "Gmail",
"type": "client"
}
]
},
{
"date": "2014-10-02",
"stats": [
{
"metrics": {
"opens": 0,
"unique_opens": 0
},
"name": "Gmail",
"type": "client"
}
]
}
]GET
| Query Parameter Name | Example |
|---|---|
mailbox_providers | tempor |
limit | -97043200 |
offset | -43691295 |
aggregated_by | month |
start_date* | et in |
end_date | consectetur |
| Header Name | Example |
|---|---|
on-behalf-of | "consectetur" |
[
{
"date": "2015-10-11",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-12",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-13",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-14",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-15",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-16",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-17",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-18",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-19",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-20",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-21",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 1,
"drops": 0,
"opens": 1,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 1
}
}
]
},
{
"date": "2015-10-22",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-23",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-24",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-25",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-26",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 2,
"drops": 0,
"opens": 2,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 2
}
}
]
},
{
"date": "2015-10-27",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-28",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-29",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-30",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-10-31",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-01",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-02",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-03",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-04",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-05",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-06",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-07",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-08",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-09",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
},
{
"date": "2015-11-10",
"stats": [
{
"type": "mailbox_provider",
"name": "Gmail",
"metrics": {
"blocks": 0,
"bounces": 0,
"clicks": 0,
"deferred": 0,
"delivered": 0,
"drops": 0,
"opens": 0,
"processed": 0,
"requests": 0,
"spam_reports": 0,
"unique_clicks": 0,
"unique_opens": 0
}
}
]
}
]GET
| Query Parameter Name | Example |
|---|---|
browsers | cupidatat est deserunt |
limit | 73170705 |
offset | -40354425 |
aggregated_by | month |
start_date* | officia Duis sint |
end_date | nostrud in |
| Header Name | Example |
|---|---|
on-behalf-of | "proident ex" |
[
{
"date": "2014-10-01",
"stats": [
{
"metrics": {
"clicks": 0,
"unique_clicks": 0
},
"name": "Chrome",
"type": "browser"
},
{
"metrics": {
"clicks": 1,
"unique_clicks": 1
},
"name": "Firefox",
"type": "browser"
}
]
},
{
"date": "2014-10-02",
"stats": [
{
"metrics": {
"clicks": 0,
"unique_clicks": 0
},
"name": "Chrome",
"type": "browser"
},
{
"metrics": {
"clicks": 1,
"unique_clicks": 1
},
"name": "Firefox",
"type": "browser"
}
]
}
]Bounces API(4 operations)
GET
| Query Parameter Name | Example |
|---|---|
start_time | 26704608 |
end_time | -2263149 |
| Header Name | Example |
|---|---|
Accept* | "amet sunt in magna ad" |
on-behalf-of | "ex in aute magna enim" |
[
{
"created": 1250337600,
"email": "example@example.com",
"reason": "550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at https://support.google.com/mail/answer/6596 o186si2389584ioe.63 - gsmtp ",
"status": "5.1.1"
},
{
"created": 1250337600,
"email": "example@example.com",
"reason": "550 5.1.1 <testemail2@testing.com>: Recipient address rejected: User unknown in virtual alias table ",
"status": "5.1.1"
}
]{
"errors": [
{
"field": "field_name",
"message": "error message"
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "veniam exercitation aliqua ex" |
{
"delete_all": false,
"emails": [
"example@example.com",
"example2@example.com"
]
}Error generating example{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "proident in non ad do" |
[
{
"created": 1443651125,
"email": "bounce1@test.com",
"reason": "550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at https://support.google.com/mail/answer/6596 o186si2389584ioe.63 - gsmtp ",
"status": "5.1.1"
}
]DELETE
| Query Parameter Name | Example |
|---|---|
email_address* | nQ36aWgrMK2Ge@Fob.vj |
| Header Name | Example |
|---|---|
on-behalf-of | "do amet" |
Error generating example{}{
"errors": [
{
"field": null,
"message": "authorization required"
}
]
}Blocks API(4 operations)
GET
| Query Parameter Name | Example |
|---|---|
start_time | -42283420 |
end_time | 93295893 |
limit | 46122838 |
offset | -17264339 |
| Header Name | Example |
|---|---|
on-behalf-of | "non" |
[
{
"created": 1443651154,
"email": "example@example.com",
"reason": "error dialing remote address: dial tcp 10.57.152.165:25: no route to host",
"status": "4.0.0"
},
{
"created": 1443651155,
"email": "example1@example.com",
"reason": "unable to resolve MX record for example.com: servfail",
"status": "4.0.0"
}
]DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "tempor amet commodo" |
{
"delete_all": false,
"emails": [
"example1@example.com",
"example2@example.com"
]
}{}GET
| Header Name | Example |
|---|---|
on-behalf-of | "enim laborum" |
[
{
"created": 1443651154,
"email": "example@example.com",
"reason": "error dialing remote address: dial tcp 10.57.152.165:25: no route to host",
"status": "4.0.0"
}
]DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "cillum mollit" |
{}Spam Reports API(4 operations)
GET
| Query Parameter Name | Example |
|---|---|
start_time | -74163725 |
end_time | -24791039 |
limit | -63305869 |
offset | -8976979 |
| Header Name | Example |
|---|---|
on-behalf-of | "exercitation dolore tempor aute" |
[
{
"created": 1443651141,
"email": "user1@example.com",
"ip": "10.63.202.100"
},
{
"created": 1443651154,
"email": "user2@example.com",
"ip": "10.63.202.100"
}
]DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "dolore" |
{
"delete_all": false,
"emails": [
"example1@example.com",
"example2@example.com"
]
}{}GET
| Header Name | Example |
|---|---|
on-behalf-of | "proident voluptate eiusmod ad" |
[
{
"created": 1454433146,
"email": "test1@example.com",
"ip": "10.89.32.5"
}
]DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "reprehenderit" |
{}Suppressions - Global Suppressions(4 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "irure labore in nisi occaecat" |
{
"recipient_emails": [
"test1@example.com",
"test2@example.com"
]
}{
"recipient_emails": [
"test1@example.com",
"test2@example.com"
]
}GET
| Query Parameter Name | Example |
|---|---|
start_time | -41598454 |
end_time | 74713082 |
limit | -76118957 |
offset | -35228716 |
| Header Name | Example |
|---|---|
on-behalf-of | "Excepteur officia nostrud ex" |
[
{
"created": 1443651141,
"email": "user1@example.com"
},
{
"created": 1443651154,
"email": "user2@example.com"
}
]GET
| Header Name | Example |
|---|---|
on-behalf-of | "id mollit do ullamco" |
{
"recipient_email": "test@example.com"
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "enim exercitation labore irure" |
{}Suppressions - Unsubscribe Groups(5 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "sit aliquip ut incididunt do" |
{
"name": "Product Suggestions",
"description": "Suggestions for products our users might like.",
"is_default": true
}{
"id": 103,
"name": "Product Suggestions",
"description": "Suggestions for products our users might like.",
"is_default": false
}GET
| Query Parameter Name | Example |
|---|---|
id | 47731368 |
| Header Name | Example |
|---|---|
on-behalf-of | "incididunt aliqua anim" |
[
{
"id": 1234,
"name": "Unsubscribe Group",
"description": "An Unsubscribe Group",
"last_email_sent_at": null,
"is_default": true,
"unsubscribes": 1234
},
{
"id": 1234,
"name": "Unsubscribe Group",
"description": "An Unsubscribe Group",
"last_email_sent_at": null,
"is_default": true,
"unsubscribes": 1234
}
]GET
| Header Name | Example |
|---|---|
on-behalf-of | "irure" |
{
"description": "Our monthly newsletter.",
"id": 100,
"is_default": true,
"last_email_sent_at": null,
"name": "Newsletters",
"unsubscribes": 400
}PATCH
| Header Name | Example |
|---|---|
on-behalf-of | "elit" |
{
"id": 103,
"name": "Item Suggestions",
"description": "Suggestions for items our users might like."
}{
"id": 103,
"name": "Item Suggestions",
"description": "Suggestions for items our users might like."
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "ex ut Lorem anim" |
{}Suppressions - Suppressions(6 operations)
POST
| Header Name | Example |
|---|---|
on-behalf-of | "laboris" |
{
"recipient_emails": [
"test1@example.com",
"test2@example.com"
]
}{
"recipient_emails": [
"test1@example.com",
"test2@example.com"
]
}GET
| Header Name | Example |
|---|---|
on-behalf-of | "minim aliqua aute Duis" |
[
"example@example.com",
"example2@example.com"
]POST
| Header Name | Example |
|---|---|
on-behalf-of | "nostrud dolor anim officia consectetur" |
{
"recipient_emails": [
"exists1@example.com",
"exists2@example.com",
"doesnotexists@example.com"
]
}[
"exists1@example.com",
"exists2@example.com"
]GET
| Header Name | Example |
|---|---|
on-behalf-of | "in" |
[
{
"email": "test1@example.com",
"group_id": 1,
"group_name": "Weekly News",
"created_at": 1410986704
},
{
"email": "test1@example.com",
"group_id": 2,
"group_name": "Daily News",
"created_at": 1411493671
},
{
"email": "test2@example.com",
"group_id": 2,
"group_name": "Daily News",
"created_at": 1411493671
}
]GET
| Header Name | Example |
|---|---|
on-behalf-of | "culpa" |
{
"suppressions": [
{
"description": "Optional description.",
"id": 1,
"is_default": true,
"name": "Weekly News",
"suppressed": true
},
{
"description": "Some daily news.",
"id": 2,
"is_default": true,
"name": "Daily News",
"suppressed": true
},
{
"description": "An old group.",
"id": 2,
"is_default": false,
"name": "Old News",
"suppressed": false
}
]
}DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "laborum" |
Error generating exampleInvalid Emails API(4 operations)
GET
| Query Parameter Name | Example |
|---|---|
start_time | 31787951 |
end_time | 24869693 |
limit | -94734617 |
offset | 44863919 |
| Header Name | Example |
|---|---|
on-behalf-of | "consectetur sit officia Ut" |
[
{
"created": 1449953655,
"email": "user1@example.com",
"reason": "Mail domain mentioned in email address is unknown"
},
{
"created": 1449939373,
"email": "user2@example.com",
"reason": "Mail domain mentioned in email address is unknown"
}
]DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "esse do aute culpa ipsum" |
{
"delete_all": false,
"emails": [
"example1@example.com",
"example2@example.com"
]
}{}GET
| Header Name | Example |
|---|---|
on-behalf-of | "esse" |
[
{
"created": 1454433146,
"email": "test1@example.com",
"reason": "Mail domain mentioned in email address is unknown"
}
]DELETE
| Header Name | Example |
|---|---|
on-behalf-of | "do aliqua" |
{}Service Homepage: sendgrid.com/en-us
API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started
emails