View All Services

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.

Sendgrid V3 Rest/OpenAPI mock server is up and running!

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

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



Mail Send

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

Cancel Scheduled Sends(7 operations)

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

API Keys(6 operations)

Header NameExample
on-behalf-of"dolore Duis"
Request Payload
{
  "name": "My API Key",
  "scopes": [
    "mail.send",
    "alerts.create",
    "alerts.read"
  ]
}
Response Payload
{
  "api_key": "SG.xxxxxxxx.yyyyyyyy",
  "api_key_id": "xxxxxxxx",
  "name": "My API Key",
  "scopes": [
    "mail.send",
    "alerts.create",
    "alerts.read"
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "voluptate pariatur fugiat sed eu"
    },
    {
      "message": "voluptate ipsum in"
    },
    {
      "message": "adipisicing officia commodo ut ad"
    },
    {
      "message": "sed"
    }
  ]
}
Query Parameter NameExample
limit89098351
Header NameExample
on-behalf-of"ea ad occaecat mollit"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "API Key Name",
      "api_key_id": "some-apikey-id"
    },
    {
      "name": "API Key Name 2",
      "api_key_id": "another-apikey-id"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "qui"
    },
    {
      "message": "nulla eiusmod velit laborum"
    },
    {
      "message": "aute laboris id nostrud in"
    }
  ]
}
Header NameExample
on-behalf-of"fugiat sit Ut"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "API Key Name",
      "api_key_id": "some-apikey-id"
    },
    {
      "name": "API Key Name 2",
      "api_key_id": "another-apikey-id"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "officia"
    }
  ]
}
Header NameExample
on-behalf-of"nostrud nulla pariatur Duis dolor"
Request Payload
{
  "name": "A New Hope"
}
Response Payload
{
  "api_key_id": "qfTQ6KG0QBiwWdJ0-pCLCA",
  "name": "A New Hope"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "nisi ut incididunt do Duis"
    },
    {
      "message": "fugiat enim"
    }
  ]
}
Header NameExample
on-behalf-of"commodo nisi"
Request Payload
{
  "name": "Profiles key",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ]
}
Response Payload
{
  "api_key_id": "qfTQ6KG0QBiwWdJ0-pCLCA",
  "name": "Profiles Key",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "nostrud"
    },
    {
      "message": "velit sint"
    },
    {
      "message": "ut id sint dolor"
    },
    {
      "message": "fugiat in pariatur cillum"
    },
    {
      "message": "veniam sit reprehenderit fugiat ut"
    }
  ]
}
Header NameExample
on-behalf-of"voluptate ex laborum esse deserunt"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "mollit culpa nostrud in"
    },
    {
      "message": "pariatur Ut veniam"
    },
    {
      "message": "fugiat Ut ipsum do irure"
    },
    {
      "message": "minim veniam est"
    },
    {
      "message": "sit ullamco nostrud do cillum"
    }
  ]
}

API Key Permissions

Header NameExample
on-behalf-of"veniam culpa eiusmod exercitation Ut"
Request Payload
Response Payload
{
  "scopes": [
    "mail.send",
    "alerts.create",
    "alerts.read"
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ex sint"
    },
    {
      "message": "ut exercitation non"
    },
    {
      "message": "do sunt quis"
    },
    {
      "message": "velit"
    }
  ]
}

Settings - Enforced TLS(2 operations)

Header NameExample
on-behalf-of"consectetur Excepteur"
Request Payload
Response Payload
{
  "require_tls": false,
  "require_valid_cert": false
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "reprehenderit elit ut culpa et"
    }
  ]
}
Header NameExample
on-behalf-of"id dolore tempor in est"
Request Payload
{
  "require_tls": true,
  "require_valid_cert": true
}
Response Payload
{
  "require_tls": true,
  "require_valid_cert": false
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "laborum laboris fugiat incididunt ea"
    },
    {
      "message": "proident laboris esse in"
    },
    {
      "message": "minim"
    }
  ]
}

IP Access Management(6 operations)

Header NameExample
on-behalf-of"amet quis id"
Request Payload
{
  "ips": [
    {
      "ip": "192.168.1.1"
    },
    {
      "ip": "192.*.*.*"
    },
    {
      "ip": "192.168.1.3/32"
    }
  ]
}
Response Payload
{
  "result": [
    {
      "id": 1,
      "ip": "192.168.1.1/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    },
    {
      "id": 2,
      "ip": "192.0.0.0/8",
      "created_at": 1441824715,
      "updated_at": 1441824715
    },
    {
      "id": 3,
      "ip": "192.168.1.3/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "in"
    },
    {
      "message": "quis"
    },
    {
      "message": "aliqua"
    },
    {
      "message": "Ut id"
    }
  ]
}
Header NameExample
on-behalf-of"eu sed"
Request Payload
Response Payload
{
  "result": [
    {
      "id": 1,
      "ip": "192.168.1.1/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    },
    {
      "id": 2,
      "ip": "192.168.1.2/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    },
    {
      "id": 3,
      "ip": "192.168.1.3/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "adipisicing"
    },
    {
      "message": "amet sunt"
    },
    {
      "message": "magna"
    },
    {
      "message": "mollit proident commodo Ut esse"
    },
    {
      "message": "dolore qui"
    }
  ]
}
Header NameExample
on-behalf-of"ut"
Request Payload
{
  "ids": [
    1,
    2,
    3
  ]
}
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "in sint"
    },
    {
      "message": "voluptate Duis"
    }
  ]
}
Query Parameter NameExample
limit28357401
Header NameExample
on-behalf-of"consequat in Duis velit fugiat"
Request Payload
Response Payload
{
  "result": [
    {
      "allowed": false,
      "auth_method": "Web",
      "first_at": 1444087966,
      "ip": "1.1.1.1",
      "last_at": 1444406672,
      "location": "Australia"
    },
    {
      "allowed": false,
      "auth_method": "Web",
      "first_at": 1444087505,
      "ip": "1.2.3.48",
      "last_at": 1444087505,
      "location": "Mukilteo, Washington"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ea ut aliquip dolor"
    },
    {
      "message": "minim enim"
    },
    {
      "message": "enim in"
    },
    {
      "message": "proident"
    },
    {
      "message": "tempor proident nostrud occaecat consequat"
    }
  ]
}
Header NameExample
on-behalf-of"in nisi anim"
Request Payload
Response Payload
{
  "id": 1,
  "ip": "192.168.1.1",
  "created_at": 1441824715,
  "updated_at": 1441824715
}
Header NameExample
on-behalf-of"culpa tempor sed qui"
Request Payload
Response Payload
{}

Certificates(5 operations)

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

Single Sign-On Settings(5 operations)

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

Single Sign-On Teammates(2 operations)

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

Settings - Mail(13 operations)

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

Settings - Partner(3 operations)

Header NameExample
on-behalf-of"elit aliqua velit sunt"
Request Payload
{
  "license_key": "",
  "enabled": true,
  "enable_subuser_statistics": true
}
Response Payload
{
  "enable_subuser_statistics": true,
  "enabled": true,
  "license_key": ""
}
Header NameExample
on-behalf-of"enim culpa irure"
Request Payload
Response Payload
{
  "enable_subuser_statistics": false,
  "enabled": true,
  "license_key": ""
}
Query Parameter NameExample
limit-7849845
offset71912571
Header NameExample
on-behalf-of"consequat deserunt minim nisi ipsum"
Request Payload
Response Payload
{
  "result": [
    {
      "title": "Partner title",
      "enabled": true,
      "name": "partner_name",
      "description": "A description of a partner."
    }
  ]
}

Teammates(11 operations)

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

Alerts(5 operations)

Header NameExample
Authorization"velit occaecat esse dolor dolore"
on-behalf-of"elit ut Duis proident"
Request Payload
{
  "type": "stats_notification",
  "email_to": "example@example.com",
  "frequency": "daily"
}
Response Payload
{
  "created_at": 1451520930,
  "email_to": "test@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451520930
}
{
  "field": "laborum dolor aliqua adipisicing",
  "message": "consectetur qui commodo ut aliqua"
}
Header NameExample
Authorization"voluptate"
on-behalf-of"laborum exercitation est"
Request Payload
Response Payload
[
  {
    "created_at": 1451498784,
    "email_to": "example1@example.com",
    "id": 46,
    "percentage": 90,
    "type": "usage_limit",
    "updated_at": 1451498784
  },
  {
    "created_at": 1451498812,
    "email_to": "example2@example.com",
    "frequency": "monthly",
    "id": 47,
    "type": "stats_notification",
    "updated_at": 1451498812
  },
  {
    "created_at": 1451520930,
    "email_to": "example3@example.com",
    "frequency": "daily",
    "id": 48,
    "type": "stats_notification",
    "updated_at": 1451520930
  }
]
Header NameExample
Authorization"in non ea deserunt labore"
on-behalf-of"ad dolore"
Request Payload
Response Payload
{
  "created_at": 1451520930,
  "email_to": "example@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451520930
}
Header NameExample
on-behalf-of"veniam anim deserunt reprehenderit"
Request Payload
Response Payload
{}
Header NameExample
on-behalf-of"mollit ullamco deserunt qui non"
Request Payload
{
  "email_to": "example@example.com"
}
Response Payload
{
  "created_at": 1451520930,
  "email_to": "example@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451522691
}

Users API(9 operations)

Header NameExample
on-behalf-of"quis"
Request Payload
Response Payload
{
  "address": "814 West Chapman Avenue",
  "address2": "",
  "city": "Orange",
  "company": "SendGrid",
  "country": "US",
  "first_name": "Test",
  "last_name": "User",
  "phone": "555-555-5555",
  "state": "CA",
  "website": "http://www.sendgrid.com",
  "zip": "92868"
}
Header NameExample
on-behalf-of"nisi laborum magna dolore"
Request Payload
{
  "first_name": "Example",
  "last_name": "User",
  "city": "Orange"
}
Response Payload
{
  "address": "814 West Chapman Avenue",
  "address2": "",
  "city": "Orange",
  "company": "SendGrid",
  "country": "US",
  "first_name": "Example",
  "last_name": "User",
  "phone": "555-555-5555",
  "state": "CA",
  "website": "http://www.sendgrid.com",
  "zip": "92868"
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"Duis exercitation irure in voluptate"
Request Payload
Response Payload
{
  "reputation": 100,
  "type": "paid"
}
Header NameExample
on-behalf-of"sunt exercitation"
Request Payload
Response Payload
{
  "email": "test@example.com"
}
Header NameExample
on-behalf-of"Excepteur quis magna officia"
Request Payload
{
  "email": "example@example.com"
}
Response Payload
{
  "email": "example@example.com"
}
Header NameExample
on-behalf-of"dolor"
Request Payload
Response Payload
{
  "username": "test_username",
  "user_id": 1
}
Header NameExample
on-behalf-of"fugiat in cupidatat elit proident"
Request Payload
{
  "username": "test_username"
}
Response Payload
{
  "username": "test_username"
}
Header NameExample
on-behalf-of"nulla do"
Request Payload
Response Payload
{
  "remain": 200,
  "total": 200,
  "overage": 0,
  "used": 0,
  "last_reset": "2013-01-01",
  "next_reset": "2013-02-01",
  "reset_frequency": "monthly"
}
Header NameExample
on-behalf-of"elit"
Request Payload
{
  "new_password": "new_password",
  "old_password": "old_password"
}
Response Payload
{}

Subusers API(6 operations)

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

Subuser Monitor Settings(4 operations)

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

Subuser Statistics(4 operations)

Query Parameter NameExample
date*qui veniam sed ullamco officia
sort_by_metricvelit
sort_by_directiondesc
limit-70024804
offset5024405
Request Payload
Response Payload
{
  "date": "2016-02-01",
  "stats": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 10,
        "processed": 10,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user1",
      "type": "subuser"
    }
  ]
}
Query Parameter NameExample
date*quis irure culpa sit esse
subuseraliquip ipsum nisi sint amet
sort_by_metricblocks
sort_by_directiondesc
limit20346702
offset-90587555
Request Payload
Response Payload
{
  "date": "2016-02-01",
  "stats": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 0,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 1,
        "processed": 0,
        "requests": 100,
        "spam_report_drops": 0,
        "spam_reports": 99,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user1",
      "type": "subuser"
    },
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 10,
        "processed": 10,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user2",
      "type": "subuser"
    }
  ]
}
Query Parameter NameExample
sort_by_directionasc
start_date*voluptate et culpa Ut ipsum
end_datein aliquip
limit-5966030
offset-66834707
aggregated_byfugiat dolore commodo Lorem
sort_by_metricexercitation in dolor
Request Payload
Response Payload
{
  "date": "2015-10-11",
  "stats": []
}
Query Parameter NameExample
limit-97932720
offset80895052
aggregated_byday
subusers*cillum dolore culpa fugiat
start_date*aliqua adipisicing in
end_datead incididunt Excepteur id anim
Request Payload
Response Payload
[
  {
    "date": "2015-10-01",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-02",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-03",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-04",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-05",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-06",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-07",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-08",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-09",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-10",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]

Link branding(10 operations)

IP Warmup(4 operations)

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

Reverse DNS(5 operations)

Header NameExample
on-behalf-of"proident ex Duis sed Lorem"
Request Payload
{
  "ip": "192.168.1.1",
  "subdomain": "email",
  "domain": "example.com"
}
Response Payload
{
  "id": 123,
  "ip": "192.168.1.2",
  "rdns": "o1.email.example.com",
  "users": [],
  "subdomain": "email",
  "domain": "example.com",
  "valid": true,
  "legacy": false,
  "a_record": {
    "valid": true,
    "type": "a",
    "host": "o1.email.example.com",
    "data": "192.168.1.2"
  }
}
Query Parameter NameExample
limit38570499
offset22717129
ipproident in Ut
Header NameExample
on-behalf-of"quis Excepteur"
Request Payload
Response Payload
[
  {
    "id": 1,
    "ip": "192.168.1.1",
    "rdns": "o1.email.example.com",
    "users": [
      {
        "username": "john@example.com",
        "user_id": 7
      },
      {
        "username": "jane@example.com",
        "user_id": 8
      }
    ],
    "subdomain": "email",
    "domain": "example.com",
    "valid": true,
    "legacy": false,
    "a_record": {
      "valid": true,
      "type": "a",
      "host": "o1.email.example.com",
      "data": "192.168.1.1"
    }
  },
  {
    "id": 2,
    "ip": "192.168.1.2",
    "rdns": "o2.email.example.com",
    "users": [
      {
        "username": "john@example.com",
        "user_id": 7
      },
      {
        "username": "jane@example2.com",
        "user_id": 9
      }
    ],
    "subdomain": "email",
    "domain": "example.com",
    "valid": true,
    "legacy": false,
    "a_record": {
      "valid": true,
      "type": "a",
      "host": "o2.email.example.com",
      "data": "192.168.1.2"
    }
  }
]
Header NameExample
on-behalf-of"ut ipsum consectetur ut elit"
Request Payload
Response Payload
{
  "id": 123456,
  "valid": false,
  "validation_results": {
    "a_record": {
      "valid": false,
      "reason": "Failed to resolve A Record at o1.ptr4283.example.com: lookup o1.ptr4283.example.com on 192.168.0.10:53: no such host"
    }
  }
}
{
  "errors": [
    {
      "message": "Reverse DNS record not found."
    }
  ]
}
{
  "errors": [
    {
      "message": "internal error getting rDNS"
    }
  ]
}
Header NameExample
on-behalf-of"ut ut incididunt do"
Request Payload
Response Payload
{
  "id": 123,
  "ip": "192.168.1.1",
  "rdns": "o1.email.example.com",
  "users": [
    {
      "username": "john@example.com",
      "user_id": 7
    }
  ],
  "subdomain": "email",
  "domain": "example.com",
  "valid": true,
  "legacy": false,
  "a_record": {
    "valid": true,
    "type": "a",
    "host": "o1.email.example.com",
    "data": "192.168.1.1"
  }
}
Header NameExample
on-behalf-of"proident laboris adipisicing minim"
Request Payload
Response Payload
{}

Email Address Validation

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

Email CNAME records

Request Payload
{
  "link_id": 29719392,
  "domain_id": 46873408,
  "email": "my_colleague@example.com",
  "message": "DNS Record for verification"
}
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": {
    "error": "ex nulla cupidatat aute dolore",
    "field": "irure dolore aliqua qui Excepteur"
  }
}

IP Pools(7 operations)

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

IP Addresses(5 operations)

Request Payload
{
  "count": 90323478,
  "subusers": [
    "subuser1",
    "subuser2"
  ],
  "warmup": true,
  "user_can_send": true
}
Response Payload
{
  "ips": [
    {
      "ip": "1.2.3.4",
      "subusers": [
        "user",
        "subuser1"
      ]
    },
    {
      "ip": "1.2.3.5",
      "subusers": [
        "user",
        "subuser1"
      ]
    }
  ],
  "remaining_ips": 1,
  "warmup": true
}
{
  "errors": [
    {
      "field": null,
      "message": "one or more subusers do not belong to this user"
    }
  ]
}
Query Parameter NameExample
ipsit adipisicing
exclude_whitelabelsfalse
limit20411700
offset-15956976
subuserest dolor Ut sint dolore
sort_by_directionasc
Request Payload
Response Payload
[
  {
    "ip": "192.168.1.1",
    "pools": [
      "pool1",
      "pool2"
    ],
    "whitelabeled": false,
    "start_date": 1409616000,
    "subusers": [
      "tim@sendgrid.net"
    ],
    "warmup": false,
    "assigned_at": 1482883200
  },
  {
    "ip": "208.115.214.22",
    "pools": [],
    "whitelabeled": true,
    "rdns": "o1.email.burgermail.com",
    "start_date": 1409616000,
    "subusers": [],
    "warmup": false,
    "assigned_at": 1482883200
  }
]
Request Payload
Response Payload
{
  "results": [
    {
      "remaining": 2,
      "period": "month",
      "price_per_ip": 20
    }
  ]
}
Request Payload
Response Payload
[
  {
    "ip": "167.89.21.3",
    "pools": [
      "new_test5"
    ],
    "warmup": true,
    "start_date": 1409616000
  }
]
Request Payload
Response Payload
{
  "ip": "000.00.00.0",
  "subusers": [
    "subuser1",
    "subuser2"
  ],
  "rdns": "o1.em.example.com",
  "pools": [
    "test1"
  ],
  "warmup": false,
  "start_date": null,
  "whitelabeled": true
}

Domain Authentication(12 operations)

Query Parameter NameExample
limit-45646074
offset-42244389
exclude_subusersfalse
usernamenulla dolor
domainsunt enim labore in elit
Header NameExample
on-behalf-of"consectetur"
Request Payload
Response Payload
[
  {
    "id": 1,
    "user_id": 7,
    "subdomain": "mail",
    "domain": "example.com",
    "username": "jane@example.com",
    "ips": [
      "192.168.1.1",
      "192.168.1.2"
    ],
    "custom_spf": true,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": true,
    "dns": {
      "mail_cname": {
        "valid": true,
        "type": "cname",
        "host": "mail.example.com",
        "data": "u7.wl.sendgrid.net"
      },
      "dkim1": {
        "valid": true,
        "type": "cname",
        "host": "s1._domainkey.example.com",
        "data": "s1._domainkey.u7.wl.sendgrid.net"
      },
      "dkim2": {
        "valid": true,
        "type": "cname",
        "host": "s2._domainkey.example.com",
        "data": "s2._domainkey.u7.wl.sendgrid.net"
      }
    }
  },
  {
    "id": 2,
    "user_id": 8,
    "subdomain": "new",
    "domain": "example2.com",
    "username": "john@example2.com",
    "ips": [],
    "custom_spf": false,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": false,
    "dns": {
      "mail_cname": {
        "valid": false,
        "type": "mx",
        "host": "news.example2.com",
        "data": "sendgrid.net"
      },
      "dkim1": {
        "valid": false,
        "type": "txt",
        "host": "example2.com",
        "data": "k=rsa; t=s; p=publicKey"
      },
      "dkim2": {
        "valid": false,
        "type": "txt",
        "host": "example2.com",
        "data": "k=rsa; t=s p=publicKey"
      }
    }
  }
]
Header NameExample
on-behalf-of"exercitation tempor nisi minim consequat"
Request Payload
{
  "domain": "example.com",
  "subdomain": "news",
  "username": "john@example.com",
  "ips": [
    "192.168.1.1",
    "192.168.1.2"
  ],
  "custom_spf": true,
  "default": true,
  "automatic_security": false
}
Response Payload
{
  "id": 302183,
  "user_id": 1446226,
  "subdomain": "example",
  "domain": "example.com",
  "username": "mbernier",
  "ips": [],
  "custom_spf": false,
  "default": true,
  "legacy": false,
  "automatic_security": true,
  "valid": false,
  "dns": {
    "mail_cname": {
      "valid": false,
      "type": "cname",
      "host": "example.example.com",
      "data": "u1446226.wl.sendgrid.net"
    },
    "dkim1": {
      "valid": false,
      "type": "cname",
      "host": "s1._domainkey.example.com",
      "data": "s1.domainkey.u1446226.wl.sendgrid.net"
    },
    "dkim2": {
      "valid": false,
      "type": "cname",
      "host": "s2._domainkey.example.com",
      "data": "s2.domainkey.u1446226.wl.sendgrid.net"
    }
  }
}
Header NameExample
on-behalf-of"ut officia ea sunt"
Request Payload
Response Payload
{
  "id": 45373692,
  "user_id": 66036447,
  "subdomain": "sub",
  "domain": "example.com",
  "username": "jdoe",
  "ips": [
    "127.0.0.1"
  ],
  "custom_spf": false,
  "default": true,
  "legacy": false,
  "automatic_security": true,
  "valid": true,
  "dns": {
    "mail_cname": {
      "valid": true,
      "type": "cname",
      "host": "mail.example.com",
      "data": "u7.wl.sendgrid.net"
    },
    "dkim1": {
      "valid": true,
      "type": "cname",
      "host": "s1._domainkey.example.com",
      "data": "s1._domainkey.u7.wl.sendgrid.net"
    },
    "dkim2": {
      "valid": true,
      "type": "cname",
      "host": "s2._domainkey.example.com",
      "data": "s2._domainkey.u7.wl.sendgrid.net"
    }
  }
}
Header NameExample
on-behalf-of"exercitation ipsum"
Request Payload
{
  "default": false,
  "custom_spf": true
}
Response Payload
[
  {
    "id": 1,
    "user_id": 7,
    "subdomain": "mail",
    "domain": "example.com",
    "username": "jane@example.com",
    "ips": [
      "192.168.1.1",
      "192.168.1.2"
    ],
    "custom_spf": true,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": true,
    "dns": {
      "mail_cname": {
        "valid": true,
        "type": "cname",
        "host": "mail.example.com",
        "data": "u7.wl.sendgrid.net"
      },
      "dkim1": {
        "valid": true,
        "type": "cname",
        "host": "s1._domainkey.example.com",
        "data": "s1._domainkey.u7.wl.sendgrid.net"
      },
      "dkim2": {
        "valid": true,
        "type": "cname",
        "host": "s2._domainkey.example.com",
        "data": "s2._domainkey.u7.wl.sendgrid.net"
      }
    }
  },
  {
    "id": 2,
    "user_id": 8,
    "subdomain": "new",
    "domain": "example2.com",
    "username": "john@example2.com",
    "ips": [],
    "custom_spf": false,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": false,
    "dns": {
      "mail_cname": {
        "valid": false,
        "type": "mx",
        "host": "news.example2.com",
        "data": "sendgrid.net"
      },
      "dkim1": {
        "valid": false,
        "type": "txt",
        "host": "example2.com",
        "data": "k=rsa; t=s; p=publicKey"
      },
      "dkim2": {
        "valid": false,
        "type": "txt",
        "host": "example2.com",
        "data": "k=rsa; t=s p=publicKey"
      }
    }
  }
]
Header NameExample
on-behalf-of"esse amet do officia"
Request Payload
Response Payload
{}
Query Parameter NameExample
domainesse ullamco Ut adipisicing in
Header NameExample
on-behalf-of"commodo irure mollit anim"
Request Payload
Response Payload
[
  {
    "id": 1,
    "user_id": 7,
    "subdomain": "mail",
    "domain": "example.com",
    "username": "jane@example.com",
    "ips": [
      "192.168.1.1",
      "192.168.1.2"
    ],
    "custom_spf": true,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": true,
    "dns": {
      "mail_cname": {
        "valid": true,
        "type": "cname",
        "host": "mail.example.com",
        "data": "u7.wl.sendgrid.net"
      },
      "dkim1": {
        "valid": true,
        "type": "cname",
        "host": "s1._domainkey.example.com",
        "data": "s1._domainkey.u7.wl.sendgrid.net"
      },
      "dkim2": {
        "valid": true,
        "type": "cname",
        "host": "s2._domainkey.example.com",
        "data": "s2._domainkey.u7.wl.sendgrid.net"
      }
    }
  }
]
Header NameExample
on-behalf-of"eu sunt"
Request Payload
{
  "ip": "192.168.0.1"
}
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "john@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}
Header NameExample
on-behalf-of"deserunt culpa"
Request Payload
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "mail@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}
Header NameExample
on-behalf-of"aliquip magna velit esse"
Request Payload
Response Payload
{
  "id": 1,
  "valid": true,
  "validation_resuts": {
    "mail_cname": {
      "valid": false,
      "reason": "Expected your MX record to be \"mx.sendgrid.net\" but found \"example.com\"."
    },
    "dkim1": {
      "valid": true,
      "reason": null
    },
    "dkim2": {
      "valid": true,
      "reason": null
    },
    "spf": {
      "valid": true,
      "reason": null
    }
  }
}
{
  "errors": [
    {
      "message": "internal error getting TXT"
    }
  ]
}
Query Parameter NameExample
username*irure do in
Request Payload
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "mail@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}
Query Parameter NameExample
usernamelaborum minim
Request Payload
Response Payload
{}
Request Payload
{
  "username": "jdoe"
}
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "mail@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}

Sender Verification(8 operations)

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

Designs API(9 operations)

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

Contacts(13 operations)

Request Payload
{
  "contacts": [
    {
      "address_line_1": "esse pariatur",
      "address_line_2": "pariatur",
      "alternate_emails": [
        "enim dolor ipsum",
        "quis consectetur ut ma",
        "labore in",
        "nisi elit fugiat est",
        "aute irure ullamco"
      ],
      "city": "occaecat",
      "country": "laborum ut",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "aliquip ad dolore in",
      "first_name": "ex deserunt dolor m",
      "last_name": "pariatur irure nisi reprehenderit non",
      "postal_code": "tempor nulla Ut eu",
      "state_province_region": "veniam ad eu"
    },
    {
      "address_line_1": "eiusmod ut minim dolore Duis",
      "address_line_2": "ad sit",
      "alternate_emails": [
        "Lorem irure sit anim veniam",
        "qui fugiat",
        "tempor consequat nostrud velit pariatur",
        "nostrud dolore",
        "nisi"
      ],
      "city": "veniam laboris ullamco in",
      "country": "enim dolor lab",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "ut ad nulla tempor laborum",
      "first_name": "labore cup",
      "last_name": "consectetur do dolore qui",
      "postal_code": "culpa laborum",
      "state_province_region": "eiusmod consec"
    },
    {
      "address_line_1": "velit dolor tempor qui",
      "address_line_2": "aute eu minim cupidatat sed",
      "alternate_emails": [
        "ex esse",
        "incididunt est",
        "dolor laboris",
        "fugiat nisi ut",
        "cillum"
      ],
      "city": "nul",
      "country": "Excepteur eiusmod id sit",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "occaecat aute in nisi",
      "first_name": "laborum ut mollit quis",
      "last_name": "dolore tempor eiusmod",
      "postal_code": "sed",
      "state_province_region": "dolor in "
    },
    {
      "address_line_1": "in consectetur est tempor",
      "address_line_2": "do non",
      "alternate_emails": [
        "velit qui aliquip elit",
        "minim",
        "est dolor tempor Lorem",
        "id esse ipsum",
        "sed do"
      ],
      "city": "consectetur min",
      "country": "",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "aliquip",
      "first_name": "u",
      "last_name": "officia sunt",
      "postal_code": "tempor esse labore in",
      "state_province_region": "dolor"
    },
    {
      "address_line_1": "pariatur qui est eiusmod in",
      "address_line_2": "dolore sed ex",
      "alternate_emails": [
        "nisi Ut quis dolor incididunt",
        "non aliqua adipisicing enim",
        "Ut nulla",
        "aliquip reprehenderit mollit Ut ad",
        "velit do exercitation mollit"
      ],
      "city": "anim esse laboris",
      "country": "tempor ut esse eu i",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "do",
      "first_name": "sunt nisi cupidatat e",
      "last_name": "qui",
      "postal_code": "nostrud",
      "state_province_region": ""
    },
    {
      "address_line_1": "nisi exercitation ut",
      "address_line_2": "exercitation officia es",
      "alternate_emails": [
        "velit Excepteur sint nostrud sit",
        "nostrud",
        "dolore ad magna",
        "magna",
        "ea ut aliqua dolore"
      ],
      "city": "qui in cillum consequat elit",
      "country": "cupidatat sed eiusmod",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "sunt dolor velit id quis",
      "first_name": "ut veniam laborum in",
      "last_name": "in",
      "postal_code": "cillum velit non",
      "state_province_region": "anim laborum"
    },
    {
      "address_line_1": "voluptate",
      "address_line_2": "officia commodo",
      "alternate_emails": [
        "ut nisi aliquip ad reprehenderit",
        "dolore mollit eu esse est",
        "dolor aliquip",
        "Duis ut voluptate sunt",
        "deserunt velit"
      ],
      "city": "ullamco laboris",
      "country": "nostrud sint culpa ipsum ea",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "ex",
      "first_name": "do sunt",
      "last_name": "commodo laboris",
      "postal_code": "Excepteur elit",
      "state_province_region": "dolore lab"
    },
    {
      "address_line_1": "Duis commodo sint aliquip",
      "address_line_2": "ut sunt culpa",
      "alternate_emails": [
        "ad",
        "velit exercitation",
        "cupidatat voluptate",
        "cupidatat",
        "nisi enim"
      ],
      "city": "v",
      "country": "eiusmod",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "labore eu in anim laborum",
      "first_name": "quis in",
      "last_name": "quis sed ir",
      "postal_code": "aute deserunt pariatur reprehenderit",
      "state_province_region": "deserunt amet do"
    },
    {
      "address_line_1": "magna proident",
      "address_line_2": "aliquip enim eu mollit",
      "alternate_emails": [
        "in",
        "ut labore quis",
        "laboris dolor Ut tempor consequat",
        "magna occaecat",
        "Duis non veniam Lorem"
      ],
      "city": "commodo sed ea officia",
      "country": "ullamco ut eni",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "exercitation",
      "first_name": "quis mollit",
      "last_name": "in nulla dolor l",
      "postal_code": "pariatur ad Excepteur consectetur sunt",
      "state_province_region": "occaecat nisi sunt "
    },
    {
      "address_line_1": "Ut sed aute",
      "address_line_2": "non nisi laborum proident",
      "alternate_emails": [
        "ullamco deserunt reprehenderit",
        "culpa",
        "velit Lorem esse non incididunt",
        "et",
        "do id consequat pariatur"
      ],
      "city": "ullamco culpa",
      "country": "Excepteur proident ut",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "sit voluptate occaecat",
      "first_name": "nostrud",
      "last_name": "co",
      "postal_code": "sunt eu irure",
      "state_province_region": "aliquip laboris Duis enim in"
    }
  ],
  "list_ids": [
    "e7aebfde-3db1-d133-e96d-421c3412a489",
    "d11c4d9d-120c-abcc-571e-303dccd7e0a9"
  ]
}
Response Payload
{
  "job_id": "sit deserunt nulla"
}
{
  "errors": [
    {
      "error_id": "sunt",
      "field": "est",
      "message": "ullamco laborum et eiusmod",
      "parameter": "dolor laborum"
    },
    {
      "error_id": "incididunt",
      "field": "consequat pariatur magna Duis enim",
      "message": "mollit",
      "parameter": "dolor amet"
    }
  ]
}
{
  "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": "in nulla proident"
    },
    {
      "message": "esse cillum proident"
    },
    {
      "message": "ea anim qui do"
    },
    {
      "message": "sint eu qui"
    }
  ]
}
Query Parameter NameExample
delete_all_contactsnisi consequat ipsum
idscupidatat id consequat non proident
Request Payload
Response Payload
{
  "job_id": {}
}
{
  "errors": []
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "sint do cillum dolor id"
    },
    {
      "message": "tempor dolore amet fugiat"
    },
    {
      "message": "aliqua"
    },
    {
      "message": "sit"
    },
    {
      "message": "ad consequat labore sit"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "self": "aliquip cupidatat dolore veniam in"
  },
  "contact_count": 23701781,
  "result": [
    {
      "_metadata": {
        "self": "culpa laborum"
      },
      "address_line_1": "labore",
      "address_line_2": "est nisi",
      "alternate_emails": [
        "magna aute proident"
      ],
      "city": "laboris reprehenderit in pariatur consectetur",
      "country": "enim sint",
      "created_at": "commodo nisi irure dolor",
      "custom_fields": {},
      "email": "non amet Lorem exercitation",
      "facebook": "anim Duis in",
      "first_name": "irure adipisicing nostrud in",
      "id": "incididunt voluptate Lorem",
      "last_name": "do in mollit",
      "line": "in velit",
      "list_ids": [
        "nostrud dolor aliqua qui",
        "esse labore proident",
        "aliqua"
      ],
      "phone_number": "eu culpa",
      "postal_code": "dolor",
      "segment_ids": [
        "minim fugiat pariatur deserunt",
        "laboris sed in",
        "velit"
      ],
      "state_province_region": "exercitation culpa",
      "unique_name": "nulla aute",
      "updated_at": "laborum mollit",
      "whatsapp": "esse exercitation id"
    },
    {
      "_metadata": {
        "self": "in proident Ut dolore incididunt"
      },
      "address_line_1": "ut est exercitation labore",
      "address_line_2": "laboris sunt amet pariatur Ut",
      "alternate_emails": [
        "do officia",
        "labore",
        "labore"
      ],
      "city": "Lorem exercitation fugiat dolor amet",
      "country": "ut",
      "created_at": "Excepteur",
      "custom_fields": {},
      "email": "fugiat eu",
      "facebook": "Ut adipisicing incididunt amet",
      "first_name": "dolor ullamco irure Lorem Duis",
      "id": "dolor officia",
      "last_name": "id",
      "line": "reprehenderit cupidatat incididunt nostrud commodo",
      "list_ids": [
        "cupidatat",
        "elit officia",
        "ipsum laborum cupidatat in culpa"
      ],
      "phone_number": "sed in Excepteur anim",
      "postal_code": "ad",
      "segment_ids": [
        "sit",
        "in laborum tempor proident"
      ],
      "state_province_region": "eu dolore dolor ad",
      "unique_name": "adipisicing",
      "updated_at": "reprehenderit",
      "whatsapp": "voluptate laboris nisi Ut"
    },
    {
      "_metadata": {
        "self": "labore"
      },
      "address_line_1": "culpa sint nulla in in",
      "address_line_2": "elit cillum id",
      "alternate_emails": [
        "anim",
        "Excepteur sint labore",
        "nisi sed minim velit",
        "reprehenderit ipsum laborum esse"
      ],
      "city": "minim dolor ipsum voluptate",
      "country": "sint sed",
      "created_at": "velit labore",
      "custom_fields": {},
      "email": "officia nostrud",
      "facebook": "ex aliqua nostrud consequat",
      "first_name": "mollit consectetur sit culpa",
      "id": "nulla proident cillum",
      "last_name": "culpa eiusmod",
      "line": "labore sint commodo sunt",
      "list_ids": [
        "ullamco ex ut",
        "elit quis ullamco qui"
      ],
      "phone_number": "Excepteur",
      "postal_code": "Lorem adipisicing occaecat",
      "segment_ids": [
        "consequat",
        "sit Lorem dolore in Excepteur",
        "eu"
      ],
      "state_province_region": "dolor",
      "unique_name": "voluptate",
      "updated_at": "in",
      "whatsapp": "commodo cillum reprehenderit dolor dolore"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "Duis",
      "field": "velit amet sunt ipsum enim",
      "message": "amet",
      "parameter": "tempor dolor ut"
    },
    {
      "error_id": "ea Ut velit aliqua incididunt",
      "field": "velit labore dolore",
      "message": "enim culpa commodo",
      "parameter": "laboris"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "eiusmod et"
    },
    {
      "message": "consequat"
    },
    {
      "message": "officia cillum"
    }
  ]
}
Request Payload
Response Payload
{
  "billable_breakdown": {
    "breakdown": {},
    "total": -80266952
  },
  "billable_count": 99374193,
  "contact_count": -64785697
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "esse aliqua"
    }
  ]
}
Request Payload
{
  "file_type": "json",
  "list_ids": [
    "53a8b0bd-11b8-e3da-2f79-87474fda767a"
  ],
  "max_file_size": -63552334,
  "notifications": {
    "email": false
  },
  "segment_ids": [
    "dolor do irure dolore reprehenderit"
  ]
}
Response Payload
{
  "_metadata": {
    "count": 27041839.366985038,
    "next": "https://dQrVWmbTZjPQPYWUjVGluvwenOkg.twoNQDMa1VQqaWMBOchlSewp-",
    "prev": "http://DMSOfJ.fayUBG5jFlZgWPtrVsftaP8enRKiYPcDaUfXZgfhVcGf",
    "self": "http://ns.flxX"
  },
  "id": "in"
}
{
  "errors": [
    {
      "error_id": "dolor consequat minim eiusmod",
      "field": "ex dolore laborum",
      "message": "consequat",
      "parameter": "esse"
    },
    {
      "error_id": "cupidatat consectetur amet",
      "field": "deserunt aliquip laborum",
      "message": "eu Duis quis",
      "parameter": "nisi"
    },
    {
      "error_id": "cillum tempor labore",
      "field": "dolor ut",
      "message": "ipsum ex",
      "parameter": "cupidatat Lorem et"
    },
    {
      "error_id": "dolor sunt",
      "field": "cillum sint",
      "message": "exercitation ex reprehenderit anim nisi",
      "parameter": "enim ad"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "adipisicing Excepteur"
    },
    {
      "message": "velit sunt Lorem"
    },
    {
      "message": "dolore sint cillum ex"
    },
    {
      "message": "sit incididunt"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "next": "culpa id ut",
    "prev": "do irure reprehenderit sit Duis",
    "self": "sit Lorem amet ipsum"
  },
  "result": [
    {
      "_metadata": {
        "next": "mollit officia sint irure fugiat",
        "prev": "fugiat Lorem occaecat sit",
        "self": "ullamco ex Duis velit"
      },
      "completed_at": "est sint id sit",
      "created_at": "deserunt incididunt in aliquip in",
      "expires_at": "nisi exercitation reprehenderit culpa",
      "export_type": "Duis ea labore id minim",
      "id": "laborum in fugiat dolore adipisicing",
      "lists": [
        {
          "ID": "eu aute qui consectetur labore",
          "Name": "Duis quis"
        },
        {
          "ID": "deserunt occaecat",
          "Name": "ut in"
        }
      ],
      "segments": [
        {
          "ID": "aute",
          "Name": "Excepteur labore minim irure Lorem"
        },
        {
          "ID": "eiusmod laborum labore Lorem",
          "Name": "reprehenderit sit ex"
        },
        {
          "ID": "velit dolor id deserunt",
          "Name": "proident occaecat Ut"
        }
      ],
      "status": "ut cupidatat incididunt ut",
      "urls": [
        "minim voluptate sint dolor enim",
        "sint aliqua Lorem nulla commodo",
        "eu Excepteur"
      ],
      "user_id": "in in"
    },
    {
      "_metadata": {
        "next": "cupidatat mollit id in exercitation",
        "prev": "in",
        "self": "amet anim in"
      },
      "completed_at": "eiusmod velit dolor id sed",
      "created_at": "ut consectetur tempor",
      "expires_at": "et",
      "export_type": "dolor minim cillum",
      "id": "id non reprehenderit",
      "lists": [
        {
          "ID": "enim fugiat sint occaecat",
          "Name": "in sint ad ea"
        },
        {
          "ID": "pariatur adipisicing Ut ut ullamco",
          "Name": "aute nisi proident elit"
        },
        {
          "ID": "non mollit ullamco cillum",
          "Name": "officia reprehenderit"
        }
      ],
      "segments": [
        {
          "ID": "labore",
          "Name": "dolor"
        },
        {
          "ID": "quis cillum officia sed",
          "Name": "pariatur ea nostrud"
        },
        {
          "ID": "nisi dolor qui",
          "Name": "ea"
        }
      ],
      "status": "ad amet do et in",
      "urls": [
        "in Ut",
        "voluptate nisi labore Ut anim",
        "sint Duis consectetur cillum esse",
        "qui Ut magna"
      ],
      "user_id": "Lorem"
    },
    {
      "_metadata": {
        "next": "commodo consectetur",
        "prev": "deserunt",
        "self": "dolor labore ipsum amet elit"
      },
      "completed_at": "enim sit",
      "created_at": "consectetur ullamco culpa sint",
      "expires_at": "in",
      "export_type": "occaecat",
      "id": "minim Excepteur nulla in",
      "lists": [
        {
          "ID": "nostrud commodo quis",
          "Name": "officia sunt irure elit"
        },
        {
          "ID": "voluptate in anim reprehenderit",
          "Name": "in"
        },
        {
          "ID": "est ad nostrud",
          "Name": "nulla qui mollit proident exercitation"
        },
        {
          "ID": "occaecat pariatur",
          "Name": "magna"
        }
      ],
      "segments": [
        {
          "ID": "eiusmod Ut",
          "Name": "aliqua Excepteur veniam magna dolore"
        }
      ],
      "status": "ut",
      "urls": [
        "dolor commodo non",
        "eu",
        "mollit ipsum",
        "Ut reprehenderit ex",
        "sed sint"
      ],
      "user_id": "reprehenderit ea voluptate amet"
    },
    {
      "_metadata": {
        "next": "Ut laborum",
        "prev": "exercitation cupidatat dolore qui commodo",
        "self": "irure nostrud ut Ut"
      },
      "completed_at": "quis cillum aliquip eiusmod",
      "created_at": "proident",
      "expires_at": "labore et aliquip magna sed",
      "export_type": "irure sunt",
      "id": "minim sed",
      "lists": [
        {
          "ID": "dolor non magna labore in",
          "Name": "fugiat"
        },
        {
          "ID": "nulla enim eu",
          "Name": "tempor pariatur"
        }
      ],
      "segments": [
        {
          "ID": "minim magna in",
          "Name": "nulla"
        },
        {
          "ID": "cillum eu amet ea",
          "Name": "exercitation non"
        }
      ],
      "status": "do",
      "urls": [
        "minim",
        "dolore velit labore aute sit"
      ],
      "user_id": "culpa ullamco laborum sit"
    }
  ]
}
{
  "errors": [
    {
      "": "amet",
      "error_id": "proident",
      "message": "dolor"
    },
    {
      "": "non",
      "error_id": "amet Ut in",
      "message": "qui proident et mollit"
    },
    {
      "": "in fugiat sit",
      "error_id": "cillum",
      "message": "in"
    },
    {
      "": "ea exercitation eiusmod",
      "error_id": "officia ea",
      "message": "amet nulla laboris"
    },
    {
      "": "do non dolore cupidatat qui",
      "error_id": "voluptate reprehenderit dolore id mollit",
      "message": "aute deserunt esse qui in"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "enim Lorem"
    },
    {
      "message": "minim"
    },
    {
      "message": "velit ut officia"
    },
    {
      "message": "eiusmod non dolor labore"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "self": "in aute"
  },
  "address_line_1": "pariatur",
  "address_line_2": "in fugiat magna sunt",
  "alternate_emails": [
    "adipisicing non sit Lorem",
    "nostrud",
    "dolor elit"
  ],
  "city": "cillum tempor",
  "country": "magna",
  "created_at": "est veniam enim",
  "custom_fields": {},
  "email": "dolor dolore nostrud",
  "facebook": "irure nisi sunt nulla occaecat",
  "first_name": "irure",
  "id": "officia",
  "last_name": "dolor minim commodo in",
  "line": "consequat aliquip elit eiusmod",
  "list_ids": [
    "exercitation Ut adipisicing",
    "adipisicing sed",
    "in dolore commodo",
    "velit"
  ],
  "phone_number": "consequat eu in in culpa",
  "postal_code": "dolore consectetur ea",
  "segment_ids": [
    "nostrud minim",
    "in"
  ],
  "state_province_region": "in eu ea",
  "unique_name": "nisi dolore in exercitation",
  "updated_at": "sit ad pariatur cupidatat consequat",
  "whatsapp": "officia dolore"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "Excepteur sit"
    },
    {
      "message": "do culpa tempor"
    },
    {
      "message": "consectetur"
    }
  ]
}
Request Payload
{
  "query": "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')"
}
Response Payload
{
  "_metadata": {
    "self": "do irure"
  },
  "contact_count": 89305558.6298753,
  "result": [
    {
      "_metadata": {
        "self": "nisi dolor consectetur aliqua cillum"
      },
      "address_line_1": "aliquip exercitation",
      "address_line_2": "ea voluptate",
      "alternate_emails": [
        "ullamco",
        "Duis",
        "mollit culpa Duis et",
        "do aliquip"
      ],
      "city": "commodo",
      "country": "eu cillum voluptate",
      "created_at": "adipisicing ut",
      "custom_fields": {},
      "email": "culpa ut",
      "facebook": "non cupidatat officia esse aute",
      "first_name": "in",
      "id": "dolore dolor",
      "last_name": "incididunt do",
      "line": "Excepteur Lorem in ipsum ullamco",
      "list_ids": [
        "dolor consectetur laboris ex"
      ],
      "phone_number": "occaecat",
      "postal_code": "mollit",
      "segment_ids": [
        "consequat quis dolor Excepteur reprehenderit",
        "officia dolor"
      ],
      "state_province_region": "dolor laborum pariatur",
      "unique_name": "anim sit fugiat",
      "updated_at": "cillum Excepteur pariatur",
      "whatsapp": "aliqua fugiat et dolore do"
    },
    {
      "_metadata": {
        "self": "sunt"
      },
      "address_line_1": "est sunt veniam esse exercitation",
      "address_line_2": "ipsum",
      "alternate_emails": [
        "culpa laborum Duis adipisicing amet",
        "ut enim",
        "qui",
        "elit eiusmod laboris est dolore"
      ],
      "city": "non esse aliquip enim",
      "country": "fugiat",
      "created_at": "est dolore occaecat consectetur labore",
      "custom_fields": {},
      "email": "est non ut",
      "facebook": "nulla Ut aute",
      "first_name": "ullamco incididunt Lorem minim",
      "id": "enim dolor occaecat voluptate non",
      "last_name": "proident",
      "line": "commodo aute",
      "list_ids": [
        "commodo consequat labore",
        "sit id",
        "in",
        "ut"
      ],
      "phone_number": "ipsum ea",
      "postal_code": "Duis veniam occaecat eiusmod incididunt",
      "segment_ids": [
        "in dolor ex",
        "aliqua magna esse exercitation",
        "sed",
        "dolore sed",
        "nostrud in enim et sint"
      ],
      "state_province_region": "aliquip et incididunt",
      "unique_name": "deserunt ex",
      "updated_at": "aliqua in Ut",
      "whatsapp": "commodo deserunt incididunt"
    },
    {
      "_metadata": {
        "self": "sunt amet"
      },
      "address_line_1": "velit sit veniam esse do",
      "address_line_2": "aute cillum adipisicing voluptate esse",
      "alternate_emails": [
        "ad"
      ],
      "city": "mollit minim veniam",
      "country": "officia exercitation",
      "created_at": "laborum commodo Lorem",
      "custom_fields": {},
      "email": "ullamco minim",
      "facebook": "ullamco esse",
      "first_name": "veniam Lorem mollit",
      "id": "nisi ad",
      "last_name": "ipsum dolor deserunt aliqua",
      "line": "Excepteur et ullamco sit",
      "list_ids": [
        "elit officia dolore anim",
        "culpa officia magna commodo",
        "exercitation dolor Lorem"
      ],
      "phone_number": "Duis dolor ipsum tempor ex",
      "postal_code": "pariatur ut nulla aliqua",
      "segment_ids": [
        "minim occaecat sint proident elit"
      ],
      "state_province_region": "id pariatur dolore",
      "unique_name": "consequat incididunt",
      "updated_at": "Duis dolore",
      "whatsapp": "dolor"
    }
  ]
}
{
  "errors": [
    {
      "field": "ipsum ullamco",
      "message": "sit"
    },
    {
      "field": "occaecat cillum tempor anim",
      "message": "incididunt nulla in aute esse"
    },
    {
      "field": "dolor est sunt consectetur amet",
      "message": "sunt esse occaecat irure"
    },
    {
      "field": "eiusmod labore Excepteur mollit est",
      "message": "irure Excepteur quis"
    }
  ]
}
{
  "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": "eiusmod sit"
    },
    {
      "message": "Excepteur"
    },
    {
      "message": "quis fugiat"
    },
    {
      "message": "pariatur"
    }
  ]
}
Request Payload
{
  "field_mappings": [
    "in mollit Ut",
    "sed occaecat ut",
    "Lorem proident tempor enim"
  ],
  "file_type": "csv",
  "list_ids": [
    "nulla",
    "Excepteur cillum dolor id",
    "irure tempor Lorem cillum"
  ]
}
Response Payload
{
  "job_id": "commodo aliqua do anim ea",
  "upload_headers": [
    {
      "header": "veniam aliqua incididunt qui",
      "value": "Duis"
    },
    {
      "header": "magna mollit reprehenderit",
      "value": "Lorem fugiat officia ut commodo"
    },
    {
      "header": "id deserunt",
      "value": "esse velit nulla ea"
    },
    {
      "header": "occaecat in",
      "value": "aliqua Lorem ipsum"
    },
    {
      "header": "ipsum magna non enim aute",
      "value": "consequat Excepteur ad sunt"
    }
  ],
  "upload_uri": "anim fugiat"
}
{
  "errors": [
    {
      "error_id": "cillum enim labore ut",
      "field": "id anim Duis",
      "message": "amet laboris",
      "parameter": "laboris amet"
    },
    {
      "error_id": "laborum voluptate incididunt aliquip ea",
      "field": "adipisicing officia cupidatat ea fugiat",
      "message": "dolore aliqua",
      "parameter": "sint"
    },
    {
      "error_id": "aute tempor officia proident et",
      "field": "ut minim consequat tempor",
      "message": "magna labore",
      "parameter": "dolor in adipisicing"
    },
    {
      "error_id": "sunt",
      "field": "laboris consectetur deserunt consequat",
      "message": "in",
      "parameter": "commodo enim do"
    },
    {
      "error_id": "nisi dolor",
      "field": "sed minim amet magna Ut",
      "message": "aliqua adipisicing",
      "parameter": "Lorem Excepteur"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "do Ut",
      "field": "pariatur ipsum eiusmod",
      "message": "ex sed exercitation elit deserunt",
      "parameter": "est quis deserunt aliquip Lorem"
    },
    {
      "error_id": "aliquip ut Lorem id",
      "field": "esse dolor sint in nisi",
      "message": "adipisicing elit",
      "parameter": "nostrud adipisicing dolore"
    }
  ]
}
{
  "errors": [
    {
      "message": "sit reprehenderit esse"
    }
  ]
}
Request Payload
Response Payload
{
  "finished_at": "ullamco sunt ut",
  "id": "veniam",
  "job_type": "dolore elit laboris",
  "results": {
    "created_count": 60182995.283035755,
    "deleted_count": -83848535.57574607,
    "errored_count": 84942427.7459344,
    "errors_url": "sunt dolore consectetur Excepteur",
    "requested_count": -92489044.36687604,
    "updated_count": -27288136.488766134
  },
  "started_at": "culpa laboris minim Excepteur dolor",
  "status": "ipsum do"
}
{
  "errors": {
    "error_id": "minim",
    "field": "commodo nostrud",
    "message": "veniam ipsum irure culpa esse",
    "parameter": "ea Ut fugiat sed deserunt"
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "Lorem culpa ut nisi deserunt"
    },
    {
      "message": "aute Lorem esse veniam"
    },
    {
      "message": "qui"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "count": -46597154.77281128,
    "next": "http://GrsvCuswOzbFZGssiSlxXlhylOPLp.yeuIf3y.pPIzxU6X7aSU0Zm9cWBehGMB2",
    "prev": "http://EuiLQadzWsvZWwPbffzyIqaworPlJ.qhSNG7wvtRepqxoZzj4Lkeoqoe.KTlQ9H5gGc4ewP2haaY",
    "self": "https://NjAiTTpxwUibdwVbdXMaLDreUCvTo.dvSZ2KQKV"
  },
  "completed_at": "non proident mollit",
  "contact_count": 83246623,
  "created_at": "ipsum Lorem in do minim",
  "expires_at": "dolore",
  "id": "do",
  "message": "eiusmod amet",
  "status": "failure",
  "updated_at": "esse id ipsum",
  "urls": [
    "Duis in",
    "fugiat sint",
    "tempor veniam ad ut consequat",
    "fugiat eu tempor ut mollit"
  ]
}
{
  "errors": [
    {
      "error_id": "incididunt proident qui tempor",
      "field": "eu nostrud sit consequat consectetur",
      "message": "velit officia",
      "parameter": "dolore dolor"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "laborum sint"
    },
    {
      "message": "nulla elit"
    },
    {
      "message": "est elit"
    },
    {
      "message": "et laborum"
    },
    {
      "message": "sunt elit cupidatat culpa"
    }
  ]
}
Request Payload
{
  "ids": [
    "1234",
    "1235"
  ]
}
Response Payload
{
  "result": [
    {
      "_metadata": {
        "self": "ut magna"
      },
      "address_line_1": "eiusmod",
      "address_line_2": "sunt non dolor nisi aute",
      "alternate_emails": [
        "culpa ullamco laboris in",
        "in Excepteur amet pariatur in",
        "officia do magna nostrud"
      ],
      "city": "proident reprehenderit Excepteur do",
      "country": "ea reprehenderit consequat in magna",
      "created_at": "Excepteur in",
      "custom_fields": {},
      "email": "fugiat cillum",
      "facebook": "ullamco id Duis tempor sint",
      "first_name": "qui velit deserunt",
      "id": "ut ut non veniam dolor",
      "last_name": "fugiat sit amet",
      "line": "nisi",
      "list_ids": [
        "culpa do ut id",
        "commodo",
        "id ullamco dolore eiusmod irure",
        "aute dolore ullamco"
      ],
      "phone_number": "cillum et sunt",
      "postal_code": "fugiat",
      "segment_ids": [
        "laboris veniam",
        "occaecat pariatur reprehenderit est",
        "eu velit"
      ],
      "state_province_region": "et labore amet qui incididunt",
      "unique_name": "ea est",
      "updated_at": "dolor",
      "whatsapp": "eu ea"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "ea qui nulla sunt"
    },
    {
      "message": "ut ut minim exercitation"
    },
    {
      "message": "elit fugiat et velit"
    }
  ]
}
Request Payload
{
  "emails": [
    "jane_doe@example.com",
    "john_doe@example.com",
    "joann_doe@example.com"
  ]
}
Response Payload
{
  "result": {
    "jane_doe@example.com": {
      "contact": {
        "address_line_1": "",
        "address_line_2": "",
        "alternate_emails": [
          "janedoe@example1.com"
        ],
        "city": "",
        "country": "",
        "email": "jane_doe@example.com",
        "first_name": "Jane",
        "id": "asdf-Jkl-zxCvBNm",
        "last_name": "Doe",
        "list_ids": [],
        "segment_ids": [],
        "postal_code": "",
        "state_province_region": "",
        "phone_number": "",
        "whatsapp": "",
        "line": "",
        "facebook": "",
        "unique_name": "",
        "custom_fields": {},
        "created_at": "2021-03-02T15:25:47Z",
        "updated_at": "2021-03-30T15:26:16Z",
        "_metadata": {
          "self": "<metadata_url>"
        }
      }
    },
    "john_doe@example.com": {
      "contact": {
        "address_line_1": "",
        "address_line_2": "",
        "alternate_emails": [],
        "city": "",
        "country": "",
        "email": "john_doe@example.com",
        "first_name": "Jane",
        "id": "asdf-Jkl-qWeRTy",
        "last_name": "Doe",
        "list_ids": [],
        "segment_ids": [],
        "postal_code": "",
        "state_province_region": "",
        "phone_number": "",
        "whatsapp": "",
        "line": "",
        "facebook": "",
        "unique_name": "",
        "custom_fields": {},
        "created_at": "2020-01-02T15:25:47Z",
        "updated_at": "2020-12-20T15:26:16Z",
        "_metadata": {
          "self": "<metadata_url>"
        }
      }
    },
    "joann_doe@example.com": {
      "error": "contact not found"
    }
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ut Duis in fugiat"
    },
    {
      "message": "quis Duis"
    },
    {
      "message": "nostrud in est id"
    },
    {
      "message": "dolore commodo"
    },
    {
      "message": "dolore"
    }
  ]
}

Segmenting Contacts V2 - Beta(5 operations)

Request Payload
{
  "name": "in deserunt enim ipsum",
  "parent_list_ids": [
    "deserunt ea do"
  ],
  "query_dsl": "eu dolor id"
}
Response Payload
{
  "contacts_count": -36382214,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "labore irure",
  "id": "32186d51-e654-a518-fc35-acf14a87b68d",
  "name": "magna fugiat sunt",
  "next_sample_update": "in adipisicing sunt Excepteur",
  "parent_list_ids": [
    "deserunt cupidatat",
    "proident sit ut",
    "cillum aute",
    "nulla amet",
    "incididunt Lorem aute ipsum cillum"
  ],
  "query_dsl": "tempor enim",
  "query_version": "amet",
  "sample_updated_at": "tempor exercitation",
  "status": {
    "error_message": "consectetur dolor enim proident",
    "query_validation": "incididunt nostrud Duis tempor Ut"
  },
  "updated_at": "consectetur"
}
{
  "errors": [
    {
      "field": "exercitation quis Lorem magna",
      "message": "Ut"
    },
    {
      "field": "et",
      "message": "adipisicing et enim"
    }
  ]
}
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": "irure laboris",
      "message": "culpa veniam voluptate mollit id"
    }
  ]
}
Query Parameter NameExample
parent_list_idsincididunt tempor consequat adipisicing
no_parent_list_idfalse
Request Payload
Response Payload
{
  "_metadata": {
    "count": 29072245,
    "next": "http://edJuNiRtLLm.pbxj2jTI7rH37kJaOm1kJxcQSj",
    "prev": "http://fzByMuZkzfTuCLrOVMD.apgNZ-3MNJPjznD7nkKRu",
    "self": "http://KOIkWjTs.ajhqrQc7yqLsKarIvtWWNsXv"
  },
  "contacts_count": 62069368,
  "created_at": "pariatur",
  "id": "c9326c4b-d6c4-06d3-ea7a-d3bc4b2ea4e3",
  "name": "occaecat Ut sint",
  "next_sample_update": "laborum adipisicing consectetur pariatur voluptate",
  "parent_list_ids": [
    "consequat reprehenderit",
    "in fugiat laborum aute aliqua",
    "reprehenderit voluptate ullamco cillum",
    "sunt",
    "culpa mollit ullamco in proident"
  ],
  "query_version": "exercitation voluptate",
  "sample_updated_at": "irure nostrud id adipisicing",
  "status": {
    "error_message": "ut occaecat amet nostrud",
    "query_validation": "incididunt"
  },
  "updated_at": "sint eu minim"
}
{
  "errors": [
    {
      "field": "tempor",
      "message": "sed ullamco"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "id dolor irure",
      "message": "do elit ut"
    },
    {
      "field": "incididunt anim dolore amet sed",
      "message": "ex sint enim dolor pariatur"
    },
    {
      "field": "in consequat exercitation Excepteur",
      "message": "velit irure"
    },
    {
      "field": "sed",
      "message": "dolor ipsum"
    },
    {
      "field": "et anim",
      "message": "et in sint ex"
    }
  ]
}
Request Payload
{
  "name": "laborum esse",
  "query_dsl": "ex dolor deserunt do"
}
Response Payload
{
  "contacts_count": 41793379,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "officia eiusmod mollit irure ex",
  "id": "eec67f5f-acb7-22b9-69dd-e293c352fa5d",
  "name": "amet quis pariatur qui",
  "next_sample_update": "voluptate eu",
  "parent_list_ids": [
    "dolore Excepteur fugiat nisi",
    "sunt irure",
    "dolor ipsum incididunt",
    "dolore minim nostrud aliqua"
  ],
  "query_dsl": "eu",
  "query_version": "dolore adipisicing",
  "sample_updated_at": "voluptate deserunt qui nostrud",
  "status": {
    "error_message": "ea Ut commodo",
    "query_validation": "Excepteur Lorem"
  },
  "updated_at": "nulla magna anim"
}
{
  "errors": [
    {
      "field": "aute in dolore voluptate",
      "message": "consequat magna"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "qui",
      "message": "veniam esse deserunt occaecat"
    },
    {
      "field": "nisi laboris",
      "message": "irure ullamco anim in aute"
    },
    {
      "field": "proident voluptate",
      "message": "aliqua occaecat eiusmod dolor commodo"
    },
    {
      "field": "tempor sit quis exercitation",
      "message": "tempor"
    },
    {
      "field": "dolore eu",
      "message": "et Lorem tempor"
    }
  ]
}
Query Parameter NameExample
contacts_sampletrue
Request Payload
Response Payload
{
  "contacts_count": -57665843,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "elit Lorem consequat ut voluptate",
  "id": "990b2643-4a21-b973-d1d8-a9ceaaf19c35",
  "name": "dolore ex adipisicing quis minim",
  "next_sample_update": "dolore consequat est minim Duis",
  "parent_list_ids": [
    "sunt ut consectetur",
    "ex do eu laborum",
    "commodo Ut incididunt",
    "ut officia ut dolore sit",
    "ut"
  ],
  "query_dsl": "nisi",
  "query_version": "in in ipsum quis",
  "sample_updated_at": "dolor aliqua",
  "status": {
    "error_message": "velit mollit dolor",
    "query_validation": "ea qui tempor"
  },
  "updated_at": "sint"
}
{
  "errors": [
    {
      "field": "do Excepteur est ullamco",
      "message": "non reprehenderit laborum"
    },
    {
      "field": "pariatur eiusmod in",
      "message": "dolore"
    },
    {
      "field": "laboris est",
      "message": "nisi"
    },
    {
      "field": "consectetur commodo labore deserunt",
      "message": "incididunt cupidatat non"
    }
  ]
}
{
  "errors": [
    {
      "field": "ipsum ea officia consequat proident",
      "message": "irure nostrud veniam aute"
    },
    {
      "field": "fugiat aliqua",
      "message": "fugiat cupidatat aute non magna"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "voluptate",
      "message": "nulla voluptate ad"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "ut et in culpa",
      "message": "in"
    },
    {
      "field": "ad",
      "message": "cupidatat deserunt qui"
    },
    {
      "field": "sint dolor aute exercitation est",
      "message": "Duis"
    },
    {
      "field": "cupidatat",
      "message": "officia Ut dolor"
    },
    {
      "field": "adipisicing",
      "message": "velit Lorem"
    }
  ]
}

Senders

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

Lists(7 operations)

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

Custom Fields(4 operations)

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

segmenting contacts(5 operations)

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

Segmenting Contacts

Request Payload
{
  "ids": [
    "a14dcc63-d651-4c57-9826-4a3705f5c78d",
    "f3de551e-dc5c-4d42-bd08-c7f87f87f0e8",
    "1b8107b5-adf4-401c-8865-fa84ba178fb9",
    "d7900715-c904-4728-acff-9ab79627579e",
    "16641f5b-cfa3-41b9-9626-244488ee85b1"
  ]
}
Response Payload
{
  "errors": [
    {
      "error": "quis",
      "id": "Duis dolor ex amet velit",
      "resources": {
        "ids": [
          "proident dolore",
          "laborum"
        ],
        "type": "proident nulla velit incididunt sed"
      }
    },
    {
      "error": "aliqua laborum consequat dolor culpa",
      "id": "eiusmod minim laboris",
      "resources": {
        "ids": [
          "id ut laborum aliquip reprehenderit",
          "est id sint",
          "in magna exercitation"
        ],
        "type": "est aliquip"
      }
    },
    {
      "error": "pariatur voluptate et",
      "id": "dolor voluptate",
      "resources": {
        "ids": [
          "id",
          "minim ullamco consectetur dolor",
          "ipsum nostrud dolor commodo voluptate"
        ],
        "type": "nulla incididunt esse commodo"
      }
    },
    {
      "error": "ullamco dolore adipisicing",
      "id": "consectetur ea exercitation",
      "resources": {
        "ids": [
          "elit eu in dolor Excepteur",
          "aute ex",
          "amet do dolor sunt"
        ],
        "type": "ut Lorem et"
      }
    },
    {
      "error": "in",
      "id": "fugiat laboris",
      "resources": {
        "ids": [
          "occaecat magna mollit",
          "elit ipsum do id adipisicing"
        ],
        "type": "sed incididunt aute magna sit"
      }
    }
  ]
}
{}
{
  "errors": [
    {
      "field": "ut et non",
      "message": "consequat sint elit irure ad"
    },
    {
      "field": "culpa incididunt",
      "message": "Lorem in Duis"
    },
    {
      "field": "dolor dolor",
      "message": "non incididunt tempor ex"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ea minim in anim quis"
    },
    {
      "message": "quis et"
    }
  ]
}

Single Sends(11 operations)

Request Payload
{
  "name": "Example API Created Single Send",
  "categories": [
    "unique opens"
  ],
  "send_to": {
    "all": true
  },
  "email_config": {
    "design_id": "<your-design-id>",
    "editor": "design",
    "suppression_group_id": 12345,
    "sender_id": 1234567
  }
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "error_id": "adipisicing incididunt",
      "field": "esse eiusmod ullamco ad",
      "message": "non ea dolore do minim"
    },
    {
      "error_id": "ut cupidatat ipsum non sit",
      "field": "et nostrud",
      "message": "in adipisicing Duis voluptate magna"
    },
    {
      "error_id": "culpa fugiat aliqua nostrud elit",
      "field": "Excepteur in velit exercitation",
      "message": "sint fugiat aliquip magna irure"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "incididunt Excepteur",
      "field": "culpa",
      "message": "aute amet laboris fugiat"
    }
  ]
}
Query Parameter NameExample
page_size13283338
page_tokenDuis
Request Payload
Response Payload
{
  "_metadata": {
    "count": 51331052,
    "next": "http://RJjv.nbhixD08wVXbIkjtCV-UeHehnYVJMAp06DjCbLvAQZIc,nwsvCNYdyHkzswAnux+ufac",
    "prev": "https://rMoQAkWOGErnbILJHeANyEH.fxsjqJvp2+pqqLE6GkeeUX5g+jXQTwIP2s.idUxNItlmNhzBw2WkPqJCuZ9k3Ka6KE",
    "self": "https://aacxhiVaIeBYGAIqQIlsTJY.pnyzrWQrltxBV2DKW3V"
  },
  "result": [
    {
      "abtest": null,
      "categories": [
        "laboris",
        "Duis sint",
        "consectetur sed sit enim",
        "reprehenderit sunt fugiat",
        "ut in",
        "culpa incididunt",
        "consequat enim esse reprehenderit mollit",
        "sunt ullamco incididunt Duis consectetur",
        "non labore",
        "ullamco cillum in in velit"
      ],
      "created_at": "1903-10-23T12:41:41.0Z",
      "id": "bb3e9a06-e42d-14da-bdc4-29fd58cdd7d1",
      "is_abtest": false,
      "name": "amet labore",
      "send_at": "1897-09-30T14:22:22.0Z",
      "status": "scheduled",
      "updated_at": "1951-03-21T10:44:24.0Z"
    },
    {
      "abtest": null,
      "categories": [
        "adipisicing et voluptate in",
        "nostrud",
        "consectetur culpa aliqua",
        "ullamco ut irure dolor",
        "do ea exercitation in labore",
        "sint tempor ut in",
        "pariatur aliquip nisi commodo officia",
        "officia ex",
        "velit Excepteur anim ea laboris",
        "Lorem dolore enim velit culpa"
      ],
      "created_at": "1911-02-22T09:46:20.0Z",
      "id": "f3688eba-5121-0f7d-0d4c-75d63bc76a09",
      "is_abtest": true,
      "name": "nostr",
      "send_at": "1893-04-25T19:07:55.0Z",
      "status": "scheduled",
      "updated_at": "1957-12-29T17:52:23.0Z"
    },
    {
      "abtest": null,
      "categories": [
        "esse sed Duis id dolore",
        "anim Excepteur laborum et",
        "dolor proident est",
        "reprehenderit laborum velit cupidatat",
        "Lorem ut nulla tempor",
        "eu aute magna",
        "Excepteur",
        "nostrud velit aliqua",
        "aute",
        "eu veniam in voluptate Ut"
      ],
      "created_at": "1940-02-09T06:39:54.0Z",
      "id": "ee3b38f8-d421-83f4-22a1-13064f20c85d",
      "is_abtest": true,
      "name": "enim labore",
      "send_at": "1934-12-29T22:31:18.0Z",
      "status": "scheduled",
      "updated_at": "1892-11-23T22:39:11.0Z"
    },
    {
      "abtest": null,
      "categories": [
        "qui dolor",
        "amet nostrud labore occaecat",
        "aliqua aliquip eu laboris Lorem",
        "deserunt",
        "voluptate et tempor exercitation",
        "nostrud Duis aliquip",
        "aute",
        "esse",
        "irure occaecat exercitation pariatur",
        "pariatur ex irure"
      ],
      "created_at": "1951-02-08T10:05:48.0Z",
      "id": "2ab8f6c2-7207-29e8-a655-18b9683dc821",
      "is_abtest": false,
      "name": "Excepteur",
      "send_at": "1928-11-30T01:13:53.0Z",
      "status": "draft",
      "updated_at": "1910-03-22T01:03:37.0Z"
    },
    {
      "abtest": null,
      "categories": [
        "exercitation id voluptate sunt",
        "sint Ut ut",
        "ut aliqua reprehenderit",
        "aute tempor",
        "esse dolor commodo aliquip ea",
        "nostrud",
        "ipsum",
        "officia proident ut consequat",
        "nulla esse in",
        "proident cupidatat magna aute velit"
      ],
      "created_at": "1910-07-01T05:59:41.0Z",
      "id": "e417101a-356e-576e-3537-455a6e2d5251",
      "is_abtest": false,
      "name": "minim sunt tempo",
      "send_at": "1929-09-21T23:58:06.0Z",
      "status": "scheduled",
      "updated_at": "1968-07-01T09:47:29.0Z"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ut nisi ut anim",
      "field": "irure",
      "message": "ex"
    },
    {
      "error_id": "aliquip consequat enim",
      "field": "est nisi Duis ad consequat",
      "message": "culpa proident amet aliquip"
    },
    {
      "error_id": "ea irure amet sint",
      "field": "enim Excepteur elit reprehenderit cupidatat",
      "message": "in dolore aute est Excepteur"
    }
  ]
}
Query Parameter NameExample
ids["ut commodo cillum","eu nulla do fugiat","sit dolore ex et incididunt","eu","ut quis ipsum","dolore est ipsum ut non","culpa dolor","nulla aliquip mollit laboris","voluptate eu","elit"]
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "non",
      "field": "deserunt adipisicing tempor officia in",
      "message": "anim qui esse reprehenderit"
    },
    {
      "error_id": "ad do",
      "field": "ea occaecat pariatur qui incididunt",
      "message": "Lorem dolore"
    },
    {
      "error_id": "esse reprehenderit nostrud",
      "field": "amet mollit cupidatat veniam Ut",
      "message": "Ut"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "dolor consequat pariatur ullamco",
      "field": "amet",
      "message": "sunt ea"
    }
  ]
}
Request Payload
{
  "name": "nisi"
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "error_id": "aliqua irure nostrud laboris anim",
      "field": "dolore fugiat in",
      "message": "minim amet in magna"
    },
    {
      "error_id": "qui",
      "field": "adipisicing",
      "message": "do esse"
    },
    {
      "error_id": "cupidatat proident",
      "field": "anim eu ipsum",
      "message": "ea Lorem"
    },
    {
      "error_id": "sunt elit ut",
      "field": "enim consequat",
      "message": "veniam et commodo occaecat laborum"
    },
    {
      "error_id": "aliqua cillum nulla Ut",
      "field": "aliqua laboris culpa ipsum",
      "message": "pariatur Excepteur dolore cupidatat do"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "consectetur eu magna est",
      "field": "consequat",
      "message": "in laborum dolore mollit eu"
    },
    {
      "error_id": "irure",
      "field": "amet ut sed irure",
      "message": "eu dolore aliquip"
    }
  ]
}
Request Payload
{
  "categories": [
    "occaecat amet ullamco ipsum dolore",
    "pariatur consectetur",
    "ad qui",
    "labore Ut id",
    "in esse veniam aute consectetur",
    "do labore occaecat pariatur",
    "exercitation dolore ullamco non",
    "dolore culpa",
    "dolor commodo qui",
    "voluptate in ut"
  ],
  "email_config": {
    "custom_unsubscribe_url": "https://MhHQdmsnGEOwihJ.spIBmvknCspeD0p",
    "design_id": "do incididunt",
    "editor": "code",
    "generate_plain_content": true,
    "html_content": "elit deserunt sint consectetur",
    "ip_pool": "occaecat id",
    "plain_content": "consequat et",
    "sender_id": -36065996,
    "subject": "sed sint cillum eiusmod labore",
    "suppression_group_id": -37837240
  },
  "name": "eu",
  "send_at": "1891-11-18T09:04:33.0Z",
  "send_to": {
    "all": false,
    "list_ids": [
      "373184db-a508-e90d-b0d1-f0fc36c294b6",
      "ca1893f8-a0d8-eb5e-dcc3-71c96db9f8f7",
      "0636f33c-0cc5-47a9-2678-c46b2a9b0f00",
      "b4830c06-7e1b-1760-c734-4127554fe8c7",
      "5b7da980-11ed-947b-742d-aed84bf3b46d",
      "0734a480-0062-c789-39a8-c8736340ec05",
      "e25684a1-df38-07e5-9a54-27f403e235fd",
      "814af260-0d16-bba2-dbe9-c23212c0b195",
      "aaed96cf-680e-24b1-eede-f0b176c4d949",
      "996dca88-980a-3edf-d4ee-30a7648ac7cd"
    ],
    "segment_ids": [
      "109aa744-7851-8a9c-549c-6ba90d2f06f5",
      "ec22a4b8-d83c-9ead-b91c-6b5bf71e86a9",
      "86c22e40-12f3-a583-e61e-6b34652fd5d4",
      "952d9751-b854-7bd0-9c29-1115a8d6003d",
      "1edbea01-ffc3-f328-e9d8-8bd42be8ae52",
      "3fea20c5-5166-1485-c447-ead7c5c76579",
      "519c802d-38fb-2bf3-0d9d-6b092b4f5ba0",
      "4bf8580b-eb66-50ab-d1e0-8140d382fbf9",
      "10c2b150-16c2-bb41-1c27-762fac3241b8",
      "5c14358f-4d19-7041-bee7-ccdfbf6ea942"
    ]
  }
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "error_id": "anim consectetur Excepteur elit commodo",
      "field": "Ut laborum reprehenderit nostrud do",
      "message": "veniam occaecat est"
    },
    {
      "error_id": "reprehenderit",
      "field": "non",
      "message": "laborum nostrud"
    },
    {
      "error_id": "non",
      "field": "minim dolor do",
      "message": "ut"
    },
    {
      "error_id": "est consequat dolor",
      "field": "sint veniam",
      "message": "in"
    },
    {
      "error_id": "Lorem",
      "field": "nisi laboris in culpa",
      "message": "ad non"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "aliqua voluptate",
      "field": "ut fugiat sit",
      "message": "id magna"
    },
    {
      "error_id": "minim ex sint laborum non",
      "field": "ex nisi ut",
      "message": "eiusmod reprehenderit cupidatat dolore"
    },
    {
      "error_id": "anim",
      "field": "pariatur magna",
      "message": "labore cillum"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "nulla exercitation Duis",
      "field": "exercitation occaecat in anim",
      "message": "Ut officia deserunt nostrud cillum"
    },
    {
      "error_id": "officia in",
      "field": "voluptate sed occaecat in",
      "message": "labore ut id mollit aute"
    }
  ]
}
Request Payload
Response Payload
{
  "name": "single-send-1",
  "id": "2f6dec81-43b9-4c67-a890-3a38cb63b54a",
  "status": "scheduled",
  "created_at": "2020-12-13T16:24:42.013Z",
  "send_to": {
    "segment_ids": [
      "dad84de3-bec4-4e04-b132-2cbfd4bb3789",
      "7dce758d-1155-4102-88d2-ca65565ac98b"
    ],
    "all": true
  }
}
{
  "errors": [
    {
      "error_id": "laboris quis",
      "field": "dolor eu ut anim",
      "message": "adipisicing ad"
    },
    {
      "error_id": "dolor",
      "field": "aliquip dolore in ea",
      "message": "non"
    },
    {
      "error_id": "reprehenderit sunt",
      "field": "ut dolore veniam",
      "message": "Excepteur Duis tempor aliquip nostrud"
    },
    {
      "error_id": "consequat",
      "field": "dolor dolore laborum Lorem consectetur",
      "message": "anim in laboris ea"
    },
    {
      "error_id": "non nulla aute enim reprehenderit",
      "field": "esse fugiat",
      "message": "proident"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "do velit dolor",
      "field": "sed esse cupidatat",
      "message": "aliqua mollit"
    },
    {
      "error_id": "eiusmod",
      "field": "adipisicing enim",
      "message": "cillum officia pariatur"
    },
    {
      "error_id": "dolor Duis",
      "field": "adipisicing eu dolore fugiat",
      "message": "commodo incididunt dolore velit"
    },
    {
      "error_id": "aliquip sit",
      "field": "minim",
      "message": "pariatur"
    },
    {
      "error_id": "anim adipisicing veniam sit est",
      "field": "dolore nostrud sed mollit",
      "message": "ut Lorem dolore"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "qui cupidatat fugiat laboris sed",
      "field": "Duis quis",
      "message": "consequat incididunt elit et"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "reprehenderit adipisicing",
      "field": "consequat et nulla",
      "message": "laboris dolore sunt"
    }
  ]
}
Query Parameter NameExample
page_size-21448211
page_tokentempor est occaecat
Request Payload
{
  "name": "specific-single-send-name",
  "status": [
    "draft",
    "scheduled"
  ],
  "categories": [
    "shoes"
  ]
}
Response Payload
{
  "result": [
    {
      "id": "df25ffdf-6a96-458a-9419-6d87d3094c6b",
      "name": "single-send-1",
      "status": "triggered",
      "categories": [
        "shoes"
      ],
      "is_abtest": true,
      "updated_at": "3263-04-09T09:05:08.193Z",
      "created_at": "4739-10-29T07:11:32.476Z",
      "send_at": "2471-05-31T15:46:18.797Z"
    }
  ],
  "_metadata": {
    "self": "nwNSrPSWt7d",
    "prev": "P0Enoayd",
    "next": "DYEsTUDww9-",
    "count": 1
  }
}
{
  "errors": [
    {
      "error_id": "esse irure ut",
      "field": "sit deserunt dolore",
      "message": "culpa elit nulla"
    },
    {
      "error_id": "ea exercitation sit aliquip",
      "field": "occaecat in adipisicing voluptate",
      "message": "Lorem"
    },
    {
      "error_id": "exercitation qui in incididunt",
      "field": "pariatur ut culpa dolore",
      "message": "dolore Duis non Ut"
    },
    {
      "error_id": "deserunt Ut dolore",
      "field": "voluptate qui veniam ex",
      "message": "ex ad consequat officia"
    }
  ]
}
Request Payload
{
  "send_at": "3752-01-28T23:21:52.575Z"
}
Response Payload
{
  "send_at": "3752-01-28T23:21:52.575Z",
  "status": "scheduled"
}
{
  "errors": [
    {
      "error_id": "magna aute fugiat laborum deserunt",
      "field": "non eiusmod consectetur",
      "message": "esse"
    },
    {
      "error_id": "pariatur",
      "field": "aliqua consequat fugiat mollit",
      "message": "commodo"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "velit et laboris",
      "field": "dolor anim occaecat ut",
      "message": "voluptate sit magna"
    },
    {
      "error_id": "pariatur cillum cupidatat ex",
      "field": "adipisicing veniam voluptate officia",
      "message": "ipsum"
    },
    {
      "error_id": "ex elit eu irure",
      "field": "ea do",
      "message": "dolor"
    },
    {
      "error_id": "mollit",
      "field": "laboris ullamco",
      "message": "dolore cillum nostrud in"
    }
  ]
}
Request Payload
Response Payload
{
  "send_at": "1947-05-23T04:44:06.0Z",
  "status": "triggered"
}
{
  "errors": [
    {
      "error_id": "nulla eu consequat amet",
      "field": "cupidatat id",
      "message": "commodo nulla in elit"
    },
    {
      "error_id": "labore dolore veniam",
      "field": "ea dolore",
      "message": "dolor consectetur fugiat"
    },
    {
      "error_id": "nulla non id cupidatat",
      "field": "nisi",
      "message": "nulla"
    },
    {
      "error_id": "aute eu est",
      "field": "eu irure laboris nostrud",
      "message": "eu pariatur labore nisi cillum"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sunt in exercitation laborum",
      "field": "reprehenderit",
      "message": "cupidatat non"
    }
  ]
}
Request Payload
Response Payload
{
  "categories": [
    "equipment",
    "shoes",
    "sports"
  ]
}
{
  "errors": [
    {
      "error_id": "voluptate ullamco",
      "field": "ut ea sunt reprehenderit occaecat",
      "message": "ad in dolor"
    },
    {
      "error_id": "eu Excepteur velit",
      "field": "ea officia",
      "message": "dolore ea qui consequat"
    },
    {
      "error_id": "minim veniam id adipisicing",
      "field": "Excepteur ipsum sit culpa nulla",
      "message": "pariatur ea occaecat"
    }
  ]
}

Send Test Email

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

Marketing Campaigns Stats(8 operations)

Query Parameter NameExample
automation_ids["ad","est pariatur in Lorem non","laborum aute dolore","irure dolore eiusmod dolore","esse","ipsum nostrud Lorem veniam","enim","irure do velit","aliqua ea tempor","quis amet"]
page_size37
page_tokennulla adipisicing sed
Request Payload
Response Payload
{
  "_metadata": {
    "count": 96056333.34993508,
    "next": "http://grBqcqEhrwQUTdPPWgBprpaZdifRZAs.ovvV7Iy4EiVl.BUqjiQ6WPop2oxJW9YAttsW4d-cxIuZ.vdtXevYtvF4xCQlF6ld7w1XME",
    "prev": "https://TMdLyxCgwbOeDrewAjfCQR.nrtvX3SnMYivMwxCVKFQPrKi",
    "self": "http://cBAAiLvjljKLsuSrXnJMj.lonJveleG2CWQ"
  },
  "results": [
    {
      "aggregation": "ad",
      "id": "5015122a-53bc-b92d-6df5-f9b9e04fde05",
      "stats": {
        "bounce_drops": -52846399,
        "bounces": 70256658,
        "clicks": 8045302,
        "delivered": -76467340,
        "invalid_emails": 5736305,
        "opens": -13450504,
        "requests": 17314160,
        "spam_report_drops": 78785732,
        "spam_reports": -91255416,
        "unique_clicks": -96614506,
        "unique_opens": 56789918,
        "unsubscribes": 2830751
      },
      "step_id": "id proident tempor dolore"
    },
    {
      "aggregation": "occaecat irure mollit consectetur",
      "id": "202be235-71e1-6106-ae32-66644de5a11d",
      "stats": {
        "bounce_drops": 33077868,
        "bounces": 87330150,
        "clicks": -73492423,
        "delivered": -53947498,
        "invalid_emails": 24266375,
        "opens": -51800809,
        "requests": 60500942,
        "spam_report_drops": 51547532,
        "spam_reports": 67392251,
        "unique_clicks": 84837842,
        "unique_opens": -73945568,
        "unsubscribes": -24854796
      },
      "step_id": "adipisicing"
    },
    {
      "aggregation": "consectetur",
      "id": "5f32eeaf-5e10-815c-34e9-adc153f5331c",
      "stats": {
        "bounce_drops": -16134439,
        "bounces": -62210960,
        "clicks": 9152956,
        "delivered": -29428247,
        "invalid_emails": -25234853,
        "opens": 97954154,
        "requests": 96343431,
        "spam_report_drops": 60690271,
        "spam_reports": -46925739,
        "unique_clicks": -25386123,
        "unique_opens": 98281930,
        "unsubscribes": -13636355
      },
      "step_id": "laboris veniam ut"
    },
    {
      "aggregation": "tempor eu consequat enim proident",
      "id": "dbf03102-72d1-bf0c-44fa-d08eecbfe344",
      "stats": {
        "bounce_drops": -72286818,
        "bounces": 40300481,
        "clicks": 23434783,
        "delivered": -21610747,
        "invalid_emails": -44676127,
        "opens": 45651832,
        "requests": 37499746,
        "spam_report_drops": 56602904,
        "spam_reports": 98505083,
        "unique_clicks": 20313518,
        "unique_opens": -28984660,
        "unsubscribes": 76558379
      },
      "step_id": "consequat culpa nostrud"
    },
    {
      "aggregation": "aliquip commodo",
      "id": "6d925726-cb16-bca0-f54b-5e174f1c33c6",
      "stats": {
        "bounce_drops": -86785522,
        "bounces": 22439418,
        "clicks": -85524211,
        "delivered": 79575096,
        "invalid_emails": -45388181,
        "opens": -17881804,
        "requests": -51578425,
        "spam_report_drops": 87507073,
        "spam_reports": -23670181,
        "unique_clicks": 84729445,
        "unique_opens": -17937520,
        "unsubscribes": -36110358
      },
      "step_id": "anim magna"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
group_by["step_id","step_id","step_id"]
step_ids["47a507b6-b0ae-fa77-01de-a3ba79ab8d10","2d3daefa-d3d8-630c-23e6-588bc4c5b6f3","8c3b6fe2-1a95-fdd4-15d6-7ae12c6a9b2e","88ab1686-d3c1-9c2b-b57d-0aa54591d6c7","2f2f572f-da92-7720-44b1-1da0519809a7"]
aggregated_bytotal
start_date1949-02-26
end_date1893-07-28
timezoneirure adipisicing
page_size29
page_tokenproident irure
Request Payload
Response Payload
{
  "_metadata": {
    "count": 22011136.91605872,
    "next": "http://tCCXQSuXWUfDo.kvkatOqYLS8iTUKaG5aCpzgv0NdZLPARfbmLME-Xfb80m1SbXWIcRYx,MHfVwn5Uc0qAlmh6mbLsG2WNBNuSq",
    "prev": "https://OXBttiZNhelqfuwIknxdJgwI.mydpq59IcYGqypNZ9xh+4,",
    "self": "http://mdKGukTKCuKmVaOio.laujxU3mq--9XcOEecgniptgGsXwI,0G.h"
  },
  "results": [
    {
      "aggregation": "occaecat est eu enim exercitation",
      "id": "57cb0aeb-6559-4e14-6a9b-97781f0e0555",
      "stats": {
        "bounce_drops": 63242282,
        "bounces": 32477472,
        "clicks": -34364100,
        "delivered": 93299367,
        "invalid_emails": -71363055,
        "opens": 32300222,
        "requests": 43625289,
        "spam_report_drops": -99496338,
        "spam_reports": 6699139,
        "unique_clicks": -88964045,
        "unique_opens": 75520525,
        "unsubscribes": 70080620
      },
      "step_id": "ad ullamco"
    },
    {
      "aggregation": "amet dolor pariatur laborum",
      "id": "6b1eb369-a950-a2ce-f898-80226cea57c1",
      "stats": {
        "bounce_drops": 49288732,
        "bounces": 34413996,
        "clicks": 25553720,
        "delivered": 12090314,
        "invalid_emails": -82028694,
        "opens": 58514627,
        "requests": -41357933,
        "spam_report_drops": 63033493,
        "spam_reports": 28439719,
        "unique_clicks": 56687802,
        "unique_opens": -44124480,
        "unsubscribes": -29896049
      },
      "step_id": "cillum qui aliquip"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
singlesend_ids["sed veniam exercitation velit","et qui","veniam magna","aliqua occaecat","velit nulla","aliqua minim voluptate dolor occaecat","aute enim eiusmod","laborum","ad nostrud exercitation in","et ea"]
page_size12
page_tokensit tempor ipsum
Request Payload
Response Payload
{
  "_metadata": {
    "count": 13710075.09448354,
    "next": "https://GLsYYAxpT.whTdkVgGKCj995WtsKUR6Cb8U7,XPof58X",
    "prev": "https://JmkqGsnZcyEhyVCVqXph.qbpOtweM9TLDVouraU",
    "self": "http://toHmCBuQRPCXRRBebfZYKoj.xwtccT2no0-QBKUXgwek2beVzbk4EHJJFRlwJ0iodqJydoPEATHj8MHvP"
  },
  "results": [
    {
      "ab_phase": "test",
      "ab_variation": "85ddb5ad-ff7f-32fc-0c8a-165370a8d02a",
      "aggregation": "veniam sit Excepteur",
      "id": "99b53dc5-8e27-e991-ba08-1a2adc4800b5",
      "stats": {
        "bounce_drops": -51365745,
        "bounces": 50350795,
        "clicks": 20477590,
        "delivered": 47579978,
        "invalid_emails": -57349967,
        "opens": 39326626,
        "requests": 43573122,
        "spam_report_drops": 60482664,
        "spam_reports": 48916215,
        "unique_clicks": 67866031,
        "unique_opens": -23122882,
        "unsubscribes": 71157275
      }
    },
    {
      "ab_phase": "all",
      "ab_variation": "12b27a34-c786-2a33-a7cd-020b59ef3753",
      "aggregation": "amet nisi cupidatat",
      "id": "35639ee2-1019-35f9-04ef-b0545ed3b7f9",
      "stats": {
        "bounce_drops": -6573794,
        "bounces": -23673041,
        "clicks": 48908989,
        "delivered": 13432915,
        "invalid_emails": 6572954,
        "opens": -95071480,
        "requests": -20433905,
        "spam_report_drops": -84693970,
        "spam_reports": 88788642,
        "unique_clicks": -58970622,
        "unique_opens": -69496110,
        "unsubscribes": -26661770
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
aggregated_byday
start_date1893-03-22
end_date1890-08-20
timezonedolor fugiat sit ea
page_size42
page_tokendeserunt ullamco officia proident id
group_by["ab_variation","ab_phase"]
Request Payload
Response Payload
{
  "_metadata": {
    "count": -63081533.49727985,
    "next": "https://IUN.coCT,y5ISHPg",
    "prev": "http://cgBJGBTlZgvoyjhhSJpfRHhIamgB.igb2pV9l-Q14eJHEUiAgMxFFAfJLGuTuUVfOLMxDWQ3.MMPnSEgniACmEf1Gn,pCNx+JPQ-bxgo9OKFuM0",
    "self": "http://glMHsueTkBIVpIWTGdBBCcUZ.gqvvbsS79JANjWR"
  },
  "results": [
    {
      "ab_phase": "send",
      "ab_variation": "66c177d1-8322-9313-d01e-5e879c377d2f",
      "aggregation": "voluptate in ullamco magna reprehenderit",
      "id": "1268b360-a59b-ee54-ab79-a237537747f2",
      "stats": {
        "bounce_drops": 26405035,
        "bounces": 82177499,
        "clicks": 70538130,
        "delivered": 11539191,
        "invalid_emails": 9635802,
        "opens": 5640233,
        "requests": 34999768,
        "spam_report_drops": 47089329,
        "spam_reports": 4204001,
        "unique_clicks": -3620666,
        "unique_opens": 13425003,
        "unsubscribes": -55140547
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "929ec892-b803-e5c1-6be2-92efbf5ca1ff",
      "aggregation": "Duis",
      "id": "946eac40-b022-3e94-b1ca-1c30a76abd45",
      "stats": {
        "bounce_drops": -28423036,
        "bounces": -86943044,
        "clicks": 39346337,
        "delivered": 85469540,
        "invalid_emails": 9969850,
        "opens": 71561545,
        "requests": 19931479,
        "spam_report_drops": 24534032,
        "spam_reports": -44994515,
        "unique_clicks": -28078019,
        "unique_opens": -48531500,
        "unsubscribes": 11757531
      }
    },
    {
      "ab_phase": "send",
      "ab_variation": "f6e78999-2fc1-11c0-2f20-d047254faedd",
      "aggregation": "ullamco",
      "id": "f54451a2-e5ec-f58e-e804-8066f6b9300b",
      "stats": {
        "bounce_drops": 45794412,
        "bounces": 81609550,
        "clicks": -97270887,
        "delivered": 11458287,
        "invalid_emails": -37349585,
        "opens": 20822245,
        "requests": -11323673,
        "spam_report_drops": -20183908,
        "spam_reports": 67041153,
        "unique_clicks": 65068350,
        "unique_opens": 97443628,
        "unsubscribes": -54430388
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
group_by["step_id","step_id","step_id","step_id"]
step_ids["68fbd71b-ef5c-7500-a347-832f7523343f"]
page_size2
page_tokenlaborum est labore
Request Payload
Response Payload
{
  "_metadata": {
    "count": -62733895.99635473,
    "next": "http://nmMPSZKgRoPvupqJE.xpseKCAZ10B8k4HCae5S5kXJG0PevsUSzauFpORxor6Unbk",
    "prev": "https://OnWW.epsA1TYq",
    "self": "http://qznAXGATIsYGmujvcswkbEACqieYljejA.tipykW8jOJD9yjanJevqSQwkkoXRnDngo0anBuZCgcGib3yOOZxGXN,"
  },
  "results": [
    {
      "clicks": 37756371,
      "step_id": "c9d77a14-a82e-dc8a-230b-ec013f82f06f",
      "url": "http://LbGfOll.yansD13io-W8ATZMVwArbZJq1rjolSeXZUTZv6ZLXaD1-ZPhD,Ywk",
      "url_location": 13354619
    },
    {
      "clicks": 14498892,
      "step_id": "5e88fb2b-de3a-61c7-d6a0-af377ae30933",
      "url": "http://bPHK.usdohkIXVVLnWv5DTMPa8+gwvnVc",
      "url_location": 63935210
    },
    {
      "clicks": 33058726,
      "step_id": "01ab3fdc-6ef8-f57c-35e7-61b5505d6b80",
      "url": "https://GlarvvWsU.xoxdpLzj09tEqq4EnhBgrwqo54b1iqWvXzQpRAMf",
      "url_location": 90372850
    },
    {
      "clicks": 14073576,
      "step_id": "9b305aa4-ad2a-1be6-d771-1cf7ce1904fc",
      "url": "http://jgwFUUHuffJgmLAmP.nilzg7pmyETAGJQoVzp",
      "url_location": 96253692
    }
  ],
  "total_clicks": -72165113
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
page_size19
page_tokenadipisicing
group_by["ab_phase"]
ab_variation_id543cace6-e304-5ff3-5984-5e8ea865bd8c
ab_phase_idsend
Request Payload
Response Payload
{
  "_metadata": {
    "count": 78870372.85730028,
    "next": "http://qTYwCxoWtNvIrznYyvBbiWGFm.goAyKV5HKjYcZZ-bk52EfwTMTmQ7NQY",
    "prev": "http://Ra.ggwffYNqTJ0f8bFnDCysb5MVjpWr",
    "self": "https://OfZuQ.pgbHVgE"
  },
  "results": [
    {
      "ab_phase": "send",
      "ab_variation": "c18f34b2-9233-c730-d7dc-3bbef6e7e7d1",
      "clicks": 97306977,
      "url": "https://LdSeXgftffJQYSUrAPscZAIbRlLN.vlzwWmDaCWClTj,y0m4h2DPspnxpa,ypKAH8w-iBRHFnj3pM2jEOxZ",
      "url_location": 63811582
    }
  ],
  "total_clicks": -68197194
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
Query Parameter NameExample
ids["sunt in pariatur","nulla cupidatat dolor","pariatur sed Ut non","officia dolore","cillum ea ullamco exercitation fugiat","mollit consectetur sint voluptate ex","incididunt sed","ipsum in cillum","exercitation labore quis est do","quis"]
timezoneculpa in anim
Request Payload
Response Payload
laboris tempor veniam deserunt amet
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
ids["non Excepteur culpa","officia irure nostrud","fugiat","amet","pariatur fugiat quis Lorem cupidatat","ea","veniam ex consectetur","ad consectetur quis","ut dolore laboris consectetur","velit consequat fugiat"]
timezoneadipisicing nisi
Request Payload
Response Payload
deserunt
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Sender Identities API(6 operations)

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

Contacts API - Lists(10 operations)

Header NameExample
on-behalf-of"sed incididunt magna anim"
Request Payload
{
  "name": "your list name"
}
Response Payload
{
  "id": 1,
  "name": "your list name",
  "recipient_count": 0
}
{
  "errors": [
    {
      "field": null,
      "message": "Returned if request body is invalid JSON"
    },
    {
      "field": "name",
      "message": "Returned if list name is not a string"
    },
    {
      "field": "name",
      "message": "Returned if list name is a duplicate of an existing list or segment"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"quis Duis ea eiusmod"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1,
      "name": "the jones",
      "recipient_count": 1
    }
  ]
}
Header NameExample
on-behalf-of"minim ex reprehenderit"
Request Payload
[
  1,
  2,
  3,
  4
]
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "list id was invalid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
list_id74340797
Header NameExample
on-behalf-of"do sit voluptate"
Request Payload
Response Payload
{
  "id": 1,
  "name": "listname",
  "recipient_count": 0
}
{
  "errors": [
    {
      "message": "invalid id"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "List ID does not exist"
    }
  ]
}
Query Parameter NameExample
list_id*-34546101
Header NameExample
on-behalf-of"esse ad culpa proident"
Request Payload
{
  "name": "newlistname"
}
Response Payload
{
  "id": 1234,
  "name": "2016 iPhone Users",
  "recipient_count": 0
}
{
  "errors": [
    {
      "message": "invalid id"
    }
  ]
}
{
  "errors": [
    {
      "message": "List ID does not exist"
    }
  ]
}
Query Parameter NameExample
delete_contactstrue
Header NameExample
on-behalf-of"aliqua"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "delete_contacts",
      "message": "delete_contacts not a bool"
    },
    {
      "field": "list_id",
      "message": "Returned if list_id is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "List not found: 5"
    }
  ]
}
Query Parameter NameExample
page-88692100
page_size59581190
list_id*11670787
Header NameExample
on-behalf-of"sit"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 1433348344,
      "custom_fields": [
        {
          "id": 6234,
          "name": "age",
          "type": "number",
          "value": null
        },
        {
          "id": 6233,
          "name": "country",
          "type": "text",
          "value": null
        },
        {
          "id": 6235,
          "name": "fname",
          "type": "text",
          "value": "Example"
        },
        {
          "id": 6239,
          "name": "lname",
          "type": "text",
          "value": "User"
        },
        {
          "id": 6240,
          "name": "lname",
          "type": "text",
          "value": null
        }
      ],
      "email": "example@example.com",
      "first_name": "Example",
      "id": "ZGVWfyZWsuYmFpbmVzQHNlbmRmCmLkLmNv==",
      "last_clicked": 1438616117,
      "last_emailed": 1438613272,
      "last_name": "User",
      "last_opened": 1438616109,
      "updated_at": 1438616119
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id is not a valid integer"
    },
    {
      "field": "page",
      "message": "Returned if page is not a valid integer"
    },
    {
      "field": "page",
      "message": "Returned if page is less than 1"
    },
    {
      "field": "page_size",
      "message": "Returned if page_size is not a valid integer"
    },
    {
      "field": "page_size",
      "message": "Returned if page_size is less than 1 or greater than 1000"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id is invalid"
    }
  ]
}
Header NameExample
on-behalf-of"sunt incididunt Lorem cupidatat est"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "list_id",
      "message": "list_id is invalid"
    },
    {
      "field": "recipient_id",
      "message": "no valid recipients were provided"
    },
    {
      "field": null,
      "message": "no recipients were added"
    },
    {
      "field": null,
      "message": "request body is invalid JSON"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "list_id does not exist"
    },
    {
      "field": "recipient_id",
      "message": "recipient_id does not exist"
    }
  ]
}
Header NameExample
on-behalf-of"adipisicing ad deserunt laborum"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id is invalid"
    },
    {
      "field": "recipient_id",
      "message": "Returned if recipient_id is invalid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id does not exist"
    },
    {
      "field": "recipient_id",
      "message": "Returned if recipient_id does not exist"
    }
  ]
}
Query Parameter NameExample
list_id*-48381102
recipient_id*55913452
Header NameExample
on-behalf-of"ut sed culpa"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id is invalid"
    },
    {
      "field": "recipient_id",
      "message": "no valid recipients were provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id does not exist"
    },
    {
      "field": "recipient_id",
      "message": "Returned if recipient_id does not exist"
    }
  ]
}

Contacts API - Recipients(12 operations)

Header NameExample
on-behalf-of"adipisicing irure ullamco consectetur"
Request Payload
[
  {
    "email": "example@example.com",
    "first_name": "",
    "last_name": "User",
    "age": 25
  },
  {
    "email": "example2@example.com",
    "first_name": "Example",
    "last_name": "User",
    "age": 25
  }
]
Response Payload
{
  "error_count": 1,
  "error_indices": [
    2
  ],
  "new_count": 2,
  "persisted_recipients": [
    "YUBh",
    "bWlsbGVyQG1pbGxlci50ZXN0"
  ],
  "updated_count": 0,
  "errors": [
    {
      "message": "Invalid email.",
      "error_indices": [
        2
      ]
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "Request body is not valid json"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"pariatur occaecat ut tempor"
Request Payload
[
  {
    "email": "jones@example.com",
    "last_name": "Jones",
    "first_name": "Guy"
  }
]
Response Payload
{
  "error_count": 1,
  "error_indices": [
    2
  ],
  "new_count": 2,
  "persisted_recipients": [
    "YUBh",
    "bWlsbGVyQG1pbGxlci50ZXN0"
  ],
  "updated_count": 0,
  "errors": [
    {
      "message": "Invalid email.",
      "error_indices": [
        2
      ]
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "Request body is not valid json"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"cillum amet occaecat ipsum consectetur"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
{}
{
  "errors": [
    {
      "message": "No recipient ids provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
page25012569
page_size-24285149
Header NameExample
on-behalf-of"mollit non Excepteur occaecat sit"
Request Payload
Response Payload
{
  "recipients": []
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"do sit dolor mollit"
Request Payload
Response Payload
{
  "status": [
    {
      "id": "worker_delay",
      "value": "delayed"
    },
    {
      "id": "worker_delay_seconds",
      "value": "75.0"
    }
  ]
}
Header NameExample
on-behalf-of"veniam culpa tempor et non"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 74438032.91999999,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "rQSpgN13-U@spQtydI.jtn",
      "first_name": null,
      "id": "ut ut",
      "last_clicked": null,
      "last_emailed": null,
      "last_name": "nostrud",
      "last_opened": -21843985.41102013,
      "updated_at": 23947854.201566488
    },
    {
      "created_at": 58836961.995183975,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "LNJX-0@K.gla",
      "first_name": null,
      "id": "mollit",
      "last_clicked": 93705373.65010628,
      "last_emailed": -69004942.56986663,
      "last_name": null,
      "last_opened": null,
      "updated_at": 25246392.26870504
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"veniam fugiat ex"
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "recipient not found"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "recipient_id is not valid"
    }
  ]
}
Header NameExample
on-behalf-of"velit proident pariatur"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1234,
      "name": "Example list",
      "recipient_count": 42
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "recipient ID is invalid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "recipient id not found"
    }
  ]
}
Header NameExample
on-behalf-of"laborum"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"in occaecat do dolor dolor"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
{field_name}ullamco velit
Header NameExample
on-behalf-of"amet aute reprehenderit do esse"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 1422313607,
      "email": "jones@example.com",
      "first_name": null,
      "id": "YUBh",
      "last_clicked": null,
      "last_emailed": null,
      "last_name": "Jones",
      "last_opened": null,
      "updated_at": 1422313790,
      "custom_fields": [
        {
          "id": 23,
          "name": "pet",
          "value": "Fluffy",
          "type": "text"
        }
      ]
    }
  ]
}
{
  "errors": [
    {
      "message": "The following parameters are not custom fields or reserved fields: [{field_name}]"
    },
    {
      "message": "No search params are specified"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Request Payload
{
  "list_id": -27497588,
  "conditions": [
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    },
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    },
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    },
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    }
  ]
}
Response Payload
{
  "recipients": [
    {
      "created_at": -27901208,
      "email": "ut magna quis ipsum",
      "id": "fugiat ad adipisicing ullamco",
      "last_emailed": 21626657
    },
    {
      "created_at": 17466400,
      "email": "sunt irure",
      "id": "et",
      "last_clicked": -23135244,
      "last_opened": -44593357,
      "first_name": "est"
    },
    {
      "created_at": -34495329,
      "email": "reprehenderit incididunt velit Lorem esse",
      "id": "esse Ut ad dolore",
      "last_clicked": 10164083,
      "last_opened": 34443062
    },
    {
      "created_at": -37030673,
      "email": "amet deserunt fugiat voluptate",
      "id": "et exercitation commodo id laborum",
      "last_clicked": -10497425
    },
    {
      "created_at": 3658435,
      "email": "labore veniam",
      "id": "ad pariatur esse",
      "last_opened": -84227501,
      "custom_fields": [
        {
          "id": -5765608,
          "name": "proident pariatur",
          "value": "do in magna mollit",
          "type": "dolore ut"
        },
        {
          "id": -31131201,
          "name": "laborum mollit",
          "value": 84434696,
          "type": "veniam"
        }
      ],
      "updated_at": -56455352,
      "first_name": "Ut cupidatat nulla deserunt adipisicing",
      "last_clicked": -52862671
    }
  ],
  "recipient_count": 65190677
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

Contacts API - Custom Fields(5 operations)

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

Contacts API - Segments(6 operations)

Header NameExample
on-behalf-of"ullamco dolor"
Request Payload
{
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    },
    {
      "field": "last_clicked",
      "value": "01/02/2015",
      "operator": "gt",
      "and_or": "and"
    },
    {
      "field": "clicks.campaign_identifier",
      "value": "513",
      "operator": "eq",
      "and_or": "or"
    }
  ]
}
Response Payload
{
  "id": 1,
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    },
    {
      "field": "last_clicked",
      "value": "01/02/2015",
      "operator": "gt",
      "and_or": "and"
    },
    {
      "field": "clicks.campaign_identifier",
      "value": "513",
      "operator": "eq",
      "and_or": "or"
    }
  ],
  "recipient_count": 0
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"Excepteur"
Request Payload
Response Payload
{
  "segments": [
    {
      "id": 1234,
      "name": "Age segments < 25",
      "conditions": [
        {
          "field": "age",
          "value": "25",
          "operator": "lt"
        }
      ],
      "recipient_count": 8
    },
    {
      "id": 2345,
      "name": "email address - gmail",
      "conditions": [
        {
          "field": "email",
          "value": "@gmail.com",
          "operator": "contains"
        }
      ],
      "recipient_count": 0
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
segment_id*69451161
Header NameExample
on-behalf-of"irure nisi"
Request Payload
Response Payload
{
  "id": 1,
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ],
  "recipient_count": 1
}
{
  "errors": [
    {
      "message": "if segment_id is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "segment_id not found"
    }
  ]
}
Query Parameter NameExample
segment_idex id
Header NameExample
on-behalf-of"Excepteur"
Request Payload
{
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ]
}
Response Payload
{
  "id": 5,
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ],
  "recipient_count": 1
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "segment_id": "segment_id",
      "message": "segment id is not valid"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
delete_contactsfalse
Header NameExample
on-behalf-of"quis in laborum"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "segment_id",
      "message": "Returned if segment_id is not valid"
    },
    {
      "field": "delete_contacts",
      "message": "Returned if delete_contacts is not a valid boolean"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "segment_id",
      "message": "segment_id does not exist"
    }
  ]
}
Query Parameter NameExample
page4792113
page_size64282132
Header NameExample
on-behalf-of"Excepteur exercitation"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 1422313607,
      "email": "jones@example.com",
      "first_name": null,
      "id": "YUBh",
      "last_clicked": null,
      "last_emailed": null,
      "last_name": "Jones",
      "last_opened": null,
      "updated_at": 1422313790,
      "custom_fields": [
        {
          "id": 23,
          "name": "pet",
          "value": "Indiana",
          "type": "text"
        }
      ]
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}

Categories(3 operations)

Query Parameter NameExample
limit-43432701
categorylaboris non aute
offset-18677518
Header NameExample
on-behalf-of"Ut fugiat nulla"
Request Payload
Response Payload
[
  {
    "category": "category 1"
  },
  {
    "category": "category 2"
  }
]
{
  "errors": [
    {
      "field": "sort_by",
      "message": "invalid sort value"
    }
  ]
}
Query Parameter NameExample
sort_by_metricaute cupidatat labore dolor
sort_by_directiondesc
start_date*commodo velit
end_datelaboris Ut quis
limit-64715078
offset-46582240
aggregated_bymonth
Header NameExample
on-behalf-of"ad in commodo velit"
Request Payload
Response Payload
{
  "date": "2015-01-01",
  "stats": [
    {
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 20,
        "deferred": 0,
        "delivered": 20,
        "invalid_emails": 0,
        "opens": 20,
        "processed": 0,
        "requests": 20,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 20,
        "unique_opens": 20,
        "unsubscribe_drops": 0,
        "unsubscribes": 20
      },
      "name": "cat1",
      "type": "category"
    },
    {
      "metrics": {
        "blocks": 1,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 19,
        "deferred": 0,
        "delivered": 19,
        "invalid_emails": 0,
        "opens": 19,
        "processed": 0,
        "requests": 20,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 19,
        "unique_opens": 19,
        "unsubscribe_drops": 0,
        "unsubscribes": 19
      },
      "name": "cat2",
      "type": "category"
    },
    {
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 5,
        "invalid_emails": 0,
        "opens": 5,
        "processed": 0,
        "requests": 5,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 5,
        "unique_opens": 5,
        "unsubscribe_drops": 0,
        "unsubscribes": 5
      },
      "name": "cat3",
      "type": "category"
    },
    {
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 6,
        "deferred": 0,
        "delivered": 5,
        "invalid_emails": 0,
        "opens": 6,
        "processed": 0,
        "requests": 5,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 5,
        "unique_opens": 5,
        "unsubscribe_drops": 0,
        "unsubscribes": 6
      },
      "name": "cat4",
      "type": "category"
    },
    {
      "metrics": {
        "blocks": 10,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 0,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 0,
        "processed": 0,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "cat5",
      "type": "category"
    }
  ]
}
Query Parameter NameExample
start_date*minim voluptate
end_datelaborum consectetur in enim
categories*ex elit
limit-67507899
offset-66848009
aggregated_byweek
Header NameExample
on-behalf-of"irure"
Request Payload
Response Payload
[
  {
    "date": "2015-10-01",
    "stats": [
      {
        "type": "category",
        "name": "docs",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      },
      {
        "type": "category",
        "name": "mattscategory",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "category",
        "name": "docs",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      },
      {
        "type": "category",
        "name": "mattscategory",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]

Campaigns API(11 operations)

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

Transactional Templates(6 operations)

Header NameExample
on-behalf-of"proident pariatur sint"
Request Payload
{
  "name": "example_name",
  "generation": "dynamic"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "example_name",
  "generation": "legacy",
  "versions": []
}
Query Parameter NameExample
generationslegacy,dynamic
page_size*151.25949758976765
page_tokensunt ea quis Lorem in
Header NameExample
on-behalf-of"Duis pariatur"
Request Payload
Response Payload
{
  "result": [
    {
      "id": "fae7c985-eb92-4b47-9987-28ec29dbc698",
      "name": "example_name",
      "generation": "legacy",
      "updated_at ": "2020-11-12 12:00:09",
      "versions": []
    }
  ],
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/templates",
    "count": 1
  }
}
{
  "errors": [
    {
      "": "incididunt",
      "error_id": "sint aliqua fugiat",
      "message": "in"
    }
  ]
}
Header NameExample
on-behalf-of"eu commodo"
Request Payload
{
  "name": "example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa2371",
  "name": "example_name",
  "generation": "dynamic",
  "updated_at ": "2019-03-13T11:52:41.009Z",
  "versions": []
}
Header NameExample
on-behalf-of"et ut"
Request Payload
Response Payload
{
  "id": "40da60e6-66f3-4223-9406-ba58b7f55a62",
  "name": "Duis in dolor",
  "generation": "legacy",
  "updated_at ": "2020-12-12 58:26:65",
  "versions": []
}
Header NameExample
on-behalf-of"nulla adipisicing culpa Duis"
Request Payload
{
  "name": "new_example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "new_example_name",
  "versions": []
}
Header NameExample
on-behalf-of"minim Lorem dolor do"
Request Payload
Response Payload
{}

Transactional Templates Versions(5 operations)

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

Webhooks(7 operations)

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

Settings - Inbound Parse(4 operations)

Header NameExample
on-behalf-of"nisi"
Request Payload
{
  "url": "http://email.myhostname.com",
  "hostname": "myhostname.com",
  "spam_check": false,
  "send_raw": true
}
Response Payload
{
  "url": "http://email.myhostname.com",
  "hostname": "myhostname.com",
  "spam_check": false,
  "send_raw": true
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "est Duis"
    },
    {
      "message": "nostrud aute ea labore ullamco"
    },
    {
      "message": "occaecat Lorem et"
    },
    {
      "message": "nulla consectetur velit nisi"
    }
  ]
}
Header NameExample
on-behalf-of"sit amet esse reprehenderit laboris"
Request Payload
Response Payload
{
  "url": "http://mydomain.com/parse",
  "hostname": "mail.mydomain.com",
  "spam_check": true,
  "send_raw": true
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "sit sunt"
    },
    {
      "message": "ex sunt velit Duis"
    }
  ]
}
Header NameExample
on-behalf-of"laboris cupidatat"
Request Payload
{
  "url": "http://email.myhostname.com",
  "hostname": "myhostname.com",
  "spam_check": false,
  "send_raw": true
}
Response Payload
{
  "url": "http://mydomain.com/parse",
  "hostname": "mail.mydomain.com",
  "spam_check": true,
  "send_raw": true
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "culpa qui enim"
    },
    {
      "message": "eiusmod ut mollit cillum veniam"
    },
    {
      "message": "Lorem"
    },
    {
      "message": "esse cupidatat sed"
    }
  ]
}
Header NameExample
on-behalf-of"laboris velit magna cupidatat irure"
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "officia do"
    },
    {
      "message": "aute dolor veniam ex"
    },
    {
      "message": "ut ut"
    },
    {
      "message": "sit ipsum laboris ut"
    }
  ]
}

Query(2 operations)

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

CSV (UI only)(2 operations)

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

Settings - Tracking(9 operations)

Header NameExample
on-behalf-of"veniam aliquip"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "open",
      "title": "Open Tracking",
      "description": "lorem ipsum... .",
      "enabled": true
    }
  ]
}
Header NameExample
on-behalf-of"consectetur elit magna commodo"
Request Payload
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"enim ullamco anim"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"culpa"
Request Payload
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"Ut dolor sed amet"
Request Payload
{
  "enabled": true,
  "utm_source": "sendgrid.com",
  "utm_medium": "email",
  "utm_term": "",
  "utm_content": "",
  "utm_campaign": "website"
}
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"cupidatat"
Request Payload
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"Lorem velit officia enim"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"fugiat in"
Request Payload
Response Payload
{
  "enabled": true,
  "html_content": "<p>Something something unsubscribe <% %> something something</p>\n",
  "landing": "<p>subscribehere</p>\n",
  "plain_content": "Something something unsubscribe <% %> something something",
  "replace": "thetag",
  "url": ""
}
Header NameExample
on-behalf-of"Duis qui aliquip exercitation Ut"
Request Payload
{
  "enabled": true,
  "landing": "landing page html",
  "url": "url",
  "replace": "replacement tag",
  "html_content": "html content",
  "plain_content": "text content"
}
Response Payload
{
  "enabled": true,
  "landing": "landing page html",
  "url": "url",
  "replace": "replacement tag",
  "html_content": "html content",
  "plain_content": "text content"
}

Stats(7 operations)

Query Parameter NameExample
limit83413375
offset-3309232
aggregated_bymonth
start_date*anim cillum eu dolore esse
end_datesunt in do in
Header NameExample
on-behalf-of"exercitation"
Request Payload
Response Payload
[
  {
    "date": "2015-11-03",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
countryCA
limit-39500760
offset-54208785
aggregated_byweek
start_date*Duis tempor do
end_datenisi dolore officia sed nostrud
Header NameExample
on-behalf-of"pariatur nisi quis magna et"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 1,
          "unique_clicks": 0,
          "unique_opens": 1
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
limit93036464
offset-87363286
aggregated_byweek
start_date*commodo eu aliqua anim reprehenderit
end_dateelit
Header NameExample
on-behalf-of"Duis occaecat"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 2,
          "unique_opens": 2
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
start_date*incididunt dolore exercitation minim ea
end_datecillum sed
aggregated_byweek
Header NameExample
on-behalf-of"esse"
Request Payload
Response Payload
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  }
]
Query Parameter NameExample
start_date*consequat laboris in adipisicing
end_dateipsum consequat dolore in
aggregated_bymonth
Header NameExample
on-behalf-of"in reprehenderit incididunt"
Request Payload
Response Payload
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  }
]
Query Parameter NameExample
mailbox_providersdolore velit ex fugiat
limit-31440458
offset-90252120
aggregated_bymonth
start_date*velit ipsum ad tempor occaecat
end_datefugiat amet occaecat in
Header NameExample
on-behalf-of"ullamco"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 1,
          "drops": 0,
          "opens": 1,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 1
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 2,
          "drops": 0,
          "opens": 2,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 2
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
browsersveniam
limit-46486676
offset-82188063
aggregated_byweek
start_date*esse ut
end_datequis incididunt consequat in laboris
Header NameExample
on-behalf-of"sit"
Request Payload
Response Payload
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "clicks": 0,
          "unique_clicks": 0
        },
        "name": "Chrome",
        "type": "browser"
      },
      {
        "metrics": {
          "clicks": 1,
          "unique_clicks": 1
        },
        "name": "Firefox",
        "type": "browser"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "clicks": 0,
          "unique_clicks": 0
        },
        "name": "Chrome",
        "type": "browser"
      },
      {
        "metrics": {
          "clicks": 1,
          "unique_clicks": 1
        },
        "name": "Firefox",
        "type": "browser"
      }
    ]
  }
]

Bounces API(4 operations)

Query Parameter NameExample
start_time65577277
end_time-82453931
Header NameExample
Accept*"Lorem occaecat cillum"
on-behalf-of"minim cillum in anim enim"
Request Payload
Response Payload
[
  {
    "created": 1250337600,
    "email": "example@example.com",
    "reason": "550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at  https://support.google.com/mail/answer/6596 o186si2389584ioe.63 - gsmtp ",
    "status": "5.1.1"
  },
  {
    "created": 1250337600,
    "email": "example@example.com",
    "reason": "550 5.1.1 <testemail2@testing.com>: Recipient address rejected: User unknown in virtual alias table ",
    "status": "5.1.1"
  }
]
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Header NameExample
on-behalf-of"commodo ullamco ut quis"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example@example.com",
    "example2@example.com"
  ]
}
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"amet officia labore"
Request Payload
Response Payload
[
  {
    "created": 1443651125,
    "email": "bounce1@test.com",
    "reason": "550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at  https://support.google.com/mail/answer/6596 o186si2389584ioe.63 - gsmtp ",
    "status": "5.1.1"
  }
]
Query Parameter NameExample
email_address*g8VQQSDRbZThHk0@IozfEVItJ.wlkf
Header NameExample
on-behalf-of"nostrud id voluptate minim labore"
Request Payload
Error generating example
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Blocks API(4 operations)

Query Parameter NameExample
start_time-44623860
end_time-67273963
limit46204611
offset59869060
Header NameExample
on-behalf-of"eu consectetur Ut commodo"
Request Payload
Response Payload
[
  {
    "created": 1443651154,
    "email": "example@example.com",
    "reason": "error dialing remote address: dial tcp 10.57.152.165:25: no route to host",
    "status": "4.0.0"
  },
  {
    "created": 1443651155,
    "email": "example1@example.com",
    "reason": "unable to resolve MX record for example.com: servfail",
    "status": "4.0.0"
  }
]
Header NameExample
on-behalf-of"in irure"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"occaecat ut dolore velit"
Request Payload
Response Payload
[
  {
    "created": 1443651154,
    "email": "example@example.com",
    "reason": "error dialing remote address: dial tcp 10.57.152.165:25: no route to host",
    "status": "4.0.0"
  }
]
Header NameExample
on-behalf-of"dolore nisi Duis"
Request Payload
Response Payload
{}

Spam Reports API(4 operations)

Query Parameter NameExample
start_time-92675239
end_time12264204
limit-13178804
offset-41460832
Header NameExample
on-behalf-of"dolor sit elit enim commodo"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com",
    "ip": "10.63.202.100"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com",
    "ip": "10.63.202.100"
  }
]
Header NameExample
on-behalf-of"in quis irure"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"voluptate pariatur ex"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "ip": "10.89.32.5"
  }
]
Header NameExample
on-behalf-of"voluptate"
Request Payload
Response Payload
{}

Suppressions - Global Suppressions(4 operations)

Header NameExample
on-behalf-of"irure labore Excepteur"
Request Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Response Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Query Parameter NameExample
start_time15643924
end_time-11285136
limit69885069
offset49842742
Header NameExample
on-behalf-of"commodo culpa ex magna"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com"
  }
]
Header NameExample
on-behalf-of"dolor eiusmod veniam esse nulla"
Request Payload
Response Payload
{
  "recipient_email": "test@example.com"
}
Header NameExample
on-behalf-of"occaecat qui id Ut"
Request Payload
Response Payload
{}

Suppressions - Unsubscribe Groups(5 operations)

Header NameExample
on-behalf-of"nisi labore dolor minim"
Request Payload
{
  "name": "Product Suggestions",
  "description": "Suggestions for products our users might like.",
  "is_default": true
}
Response Payload
{
  "id": 103,
  "name": "Product Suggestions",
  "description": "Suggestions for products our users might like.",
  "is_default": false
}
Query Parameter NameExample
id-21553897
Header NameExample
on-behalf-of"elit commodo dolore consectetur"
Request Payload
Response Payload
[
  {
    "id": 1234,
    "name": "Unsubscribe Group",
    "description": "An Unsubscribe Group",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 1234
  },
  {
    "id": 1234,
    "name": "Unsubscribe Group",
    "description": "An Unsubscribe Group",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 1234
  }
]
Header NameExample
on-behalf-of"ex qui nisi"
Request Payload
Response Payload
{
  "description": "Our monthly newsletter.",
  "id": 100,
  "is_default": true,
  "last_email_sent_at": null,
  "name": "Newsletters",
  "unsubscribes": 400
}
Header NameExample
on-behalf-of"reprehenderit minim amet"
Request Payload
{
  "id": 103,
  "name": "Item Suggestions",
  "description": "Suggestions for items our users might like."
}
Response Payload
{
  "id": 103,
  "name": "Item Suggestions",
  "description": "Suggestions for items our users might like."
}
Header NameExample
on-behalf-of"ex amet"
Request Payload
Response Payload
{}

Suppressions - Suppressions(6 operations)

Header NameExample
on-behalf-of"fugiat esse aute nostrud adipisicing"
Request Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Response Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Header NameExample
on-behalf-of"anim qui"
Request Payload
Response Payload
[
  "example@example.com",
  "example2@example.com"
]
Header NameExample
on-behalf-of"tempor id ullamco ut"
Request Payload
{
  "recipient_emails": [
    "exists1@example.com",
    "exists2@example.com",
    "doesnotexists@example.com"
  ]
}
Response Payload
[
  "exists1@example.com",
  "exists2@example.com"
]
Header NameExample
on-behalf-of"ut aute proident aliquip"
Request Payload
Response Payload
[
  {
    "email": "test1@example.com",
    "group_id": 1,
    "group_name": "Weekly News",
    "created_at": 1410986704
  },
  {
    "email": "test1@example.com",
    "group_id": 2,
    "group_name": "Daily News",
    "created_at": 1411493671
  },
  {
    "email": "test2@example.com",
    "group_id": 2,
    "group_name": "Daily News",
    "created_at": 1411493671
  }
]
Header NameExample
on-behalf-of"adipisicing dolore"
Request Payload
Response Payload
{
  "suppressions": [
    {
      "description": "Optional description.",
      "id": 1,
      "is_default": true,
      "name": "Weekly News",
      "suppressed": true
    },
    {
      "description": "Some daily news.",
      "id": 2,
      "is_default": true,
      "name": "Daily News",
      "suppressed": true
    },
    {
      "description": "An old group.",
      "id": 2,
      "is_default": false,
      "name": "Old News",
      "suppressed": false
    }
  ]
}
Header NameExample
on-behalf-of"dolore non"
Request Payload
Response Payload
Error generating example

Invalid Emails API(4 operations)

Query Parameter NameExample
start_time-27125316
end_time-139016
limit51736469
offset-78838874
Header NameExample
on-behalf-of"exercitation quis incididunt"
Request Payload
Response Payload
[
  {
    "created": 1449953655,
    "email": "user1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  },
  {
    "created": 1449939373,
    "email": "user2@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]
Header NameExample
on-behalf-of"laboris"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"do"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]
Header NameExample
on-behalf-of"esse Excepteur fugiat nostrud incididunt"
Request Payload
Response Payload
{}
Service Homepage: sendgrid.com/en-us
API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started
emails