View All Services

Sendgrid V3 Virtual Sandbox

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

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

Sendgrid V3 virtual sandbox is up and running!

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

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



Mail Send

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

Cancel Scheduled Sends(7 operations)

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

API Keys(6 operations)

Header NameExample
on-behalf-of"magna nisi ea"
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": "in"
    },
    {
      "message": "fugiat ea incididunt enim minim"
    },
    {
      "message": "Ut aute dolor"
    },
    {
      "message": "Ut velit exercitation in"
    }
  ]
}
Query Parameter NameExample
limit15117446
Header NameExample
on-behalf-of"sit labore"
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": "in aliqua"
    }
  ]
}
Header NameExample
on-behalf-of"laboris pariatur"
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": "Duis adipisicing incididunt"
    }
  ]
}
Header NameExample
on-behalf-of"veniam ea do"
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": "labore eiusmod laboris ipsum"
    }
  ]
}
Header NameExample
on-behalf-of"aliqua nostrud occaecat"
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": "ipsum dolore Duis culpa"
    },
    {
      "message": "quis Lorem"
    }
  ]
}
Header NameExample
on-behalf-of"consectetur"
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": "consequat commodo veniam adipisicing"
    },
    {
      "message": "deserunt cillum ut irure"
    }
  ]
}

API Key Permissions

Header NameExample
on-behalf-of"sunt deserunt in non"
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": "officia nulla non Ut"
    },
    {
      "message": "mollit enim ut Excepteur id"
    },
    {
      "message": "velit dolore id magna commodo"
    }
  ]
}

Settings - Enforced TLS(2 operations)

Header NameExample
on-behalf-of"amet"
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": "elit aute nisi"
    },
    {
      "message": "dolore sit qui tempor"
    },
    {
      "message": "et reprehenderit pariatur"
    },
    {
      "message": "ad"
    },
    {
      "message": "elit fugiat"
    }
  ]
}
Header NameExample
on-behalf-of"eu irure exercitation"
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": "consectetur dolor cillum ullamco ut"
    },
    {
      "message": "sint deserunt esse in"
    },
    {
      "message": "Lorem do fugiat in velit"
    },
    {
      "message": "in pariatur amet sint"
    },
    {
      "message": "non qui"
    }
  ]
}

IP Access Management(6 operations)

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

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

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

Settings - Mail(13 operations)

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

Settings - Partner(3 operations)

Header NameExample
on-behalf-of"laborum quis"
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"adipisicing consectetur labore"
Request Payload
Response Payload
{
  "enable_subuser_statistics": false,
  "enabled": true,
  "license_key": ""
}
Query Parameter NameExample
limit-43496020
offset43650865
Header NameExample
on-behalf-of"dolore Duis esse"
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"Ut eiusmod voluptate do"
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": "dolore anim Ut nisi ullamco",
      "message": "dolor et"
    },
    {
      "field": "reprehenderit deserunt do est",
      "message": "velit eu mollit quis ipsum"
    },
    {
      "field": "ipsum",
      "message": "in"
    },
    {
      "field": "Ut",
      "message": "officia ex enim in"
    },
    {
      "field": "adipisicing",
      "message": "esse et sunt dolor est"
    }
  ]
}
Query Parameter NameExample
limit49
offset61369789
Header NameExample
on-behalf-of"labore velit fugiat ut"
Request Payload
Response Payload
{
  "results": [
    {
      "username": "teammate1",
      "email": "teammate1@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "user_type": "owner",
      "is_admin": true,
      "phone": "123-345-3453",
      "website": "www.example.com",
      "company": "ACME Inc.",
      "address": "123 Acme St",
      "address2": "",
      "city": "City",
      "state": "CA",
      "country": "USA",
      "zip": "12345"
    },
    {
      "username": "teammate2",
      "email": "teammate2@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "user_type": "teammate",
      "is_admin": false,
      "phone": "123-345-3453",
      "website": "www.example.com",
      "company": "ACME Inc.",
      "address": "123 Acme St",
      "address2": "",
      "city": "City",
      "state": "CA",
      "country": "USA",
      "zip": "12345"
    },
    {
      "username": "teammate3",
      "email": "teammate3@example.com",
      "first_name": "Steve",
      "last_name": "Doe",
      "user_type": "admin",
      "is_admin": true,
      "phone": "123-345-3453",
      "website": "www.example.com",
      "company": "ACME Inc.",
      "address": "123 Acme St",
      "address2": "",
      "city": "City",
      "state": "CA",
      "country": "USA",
      "zip": "12345"
    }
  ]
}
Header NameExample
on-behalf-of"Ut consectetur Lorem"
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
limit1618011
offset-15731039
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"eiusmod culpa nisi"
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"et"
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"culpa consequat"
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"do consectetur ullamco"
Request Payload
Response Payload
{
  "errors": [
    {
      "field": "do minim ad",
      "message": "deserunt ut dolor culpa"
    },
    {
      "field": "in velit exercitation do",
      "message": "proident ex sunt"
    },
    {
      "field": "ex eiusmod dolore",
      "message": "reprehenderit esse sunt pariatur ullamco"
    },
    {
      "field": "aliquip",
      "message": "ad nulla laborum"
    },
    {
      "field": "esse ad consectetur",
      "message": "sunt"
    }
  ]
}
{
  "errors": [
    {
      "message": "username not found",
      "field": "username"
    }
  ]
}
Request Payload
Response Payload
{
  "scope_group_name": "Stats"
}
{}
{
  "errors": [
    {
      "field": "ut",
      "message": "sunt commodo amet"
    },
    {
      "field": "elit eu exercitation dolore cillum",
      "message": "minim do enim adipisicing"
    },
    {
      "field": "consequat ex",
      "message": "adipisicing Ut"
    },
    {
      "field": "mollit fugiat velit Duis",
      "message": "proident"
    },
    {
      "field": "et",
      "message": "nisi"
    }
  ]
}
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"ad cupidatat ullamco exercitation"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "magna",
      "message": "minim Excepteur"
    },
    {
      "field": "qui anim mollit id sed",
      "message": "qui sed reprehenderit irure aliquip"
    }
  ]
}

Alerts(5 operations)

Header NameExample
Authorization"consectetur ut nulla adipisicing"
on-behalf-of"consequat cupidatat in fugiat aute"
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": "dolore do ea",
  "message": "nisi elit aliquip"
}
Header NameExample
Authorization"nostrud"
on-behalf-of"voluptate id laboris minim laborum"
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"deserunt enim"
on-behalf-of"irure ut proident"
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"pariatur laboris aute Ut irure"
Request Payload
Response Payload
{}
Header NameExample
on-behalf-of"ut laboris cillum qui elit"
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"veniam"
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"adipisicing Lorem id"
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"amet"
Request Payload
Response Payload
{
  "reputation": 100,
  "type": "paid"
}
Header NameExample
on-behalf-of"voluptate aute"
Request Payload
Response Payload
{
  "email": "test@example.com"
}
Header NameExample
on-behalf-of"dolore"
Request Payload
{
  "email": "example@example.com"
}
Response Payload
{
  "email": "example@example.com"
}
Header NameExample
on-behalf-of"ex"
Request Payload
Response Payload
{
  "username": "test_username",
  "user_id": 1
}
Header NameExample
on-behalf-of"ad tempor cillum"
Request Payload
{
  "username": "test_username"
}
Response Payload
{
  "username": "test_username"
}
Header NameExample
on-behalf-of"laborum"
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"dolor adipisicing eu exercitation consectetur"
Request Payload
{
  "new_password": "new_password",
  "old_password": "old_password"
}
Response Payload
{}

Subusers API(6 operations)

Query Parameter NameExample
usernameveniam laboris voluptate sit Duis
limit107249
offset6550384
Request Payload
Response Payload
[
  {
    "disabled": false,
    "email": "example@example.com",
    "id": 1234,
    "username": "example_subuser"
  },
  {
    "disabled": false,
    "email": "example2@example.com",
    "id": 1234,
    "username": "example_subuser2"
  }
]
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Request Payload
{
  "username": "John@example.com",
  "email": "John@example.com",
  "password": "johns_password",
  "ips": [
    "1.1.1.1",
    "2.2.2.2"
  ]
}
Response Payload
{
  "username": "example_subuser",
  "user_id": 1234,
  "email": "example@example.com",
  "signup_session_token": "",
  "authorization_token": "",
  "credit_allocation": {
    "type": "unlimited"
  }
}
{
  "errors": [
    {
      "message": "username exists"
    },
    {
      "message": "unable to validate IPs at this time"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "you dont have permission to access this resource"
    }
  ]
}
{
  "errors": [
    {
      "message": "unable to validate IPs at this time"
    }
  ]
}
Request Payload
{
  "disabled": false
}
Response Payload
{}
{
  "errors": [
    {
      "message": "invalid username"
    },
    {
      "message": "no fields provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "unable to enable user"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
usernamesin pariatur cupidatat fugiat ut
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*et qui eiusmod
sort_by_metricdolore in irure amet
sort_by_directiondesc
limit-8525284
offset69958707
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*dolore exercitation
subuserest aute eu veniam
sort_by_metricopens
sort_by_directionasc
limit8003404
offset-25416345
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*tempor consequat in
end_datealiqua Excepteur
limit-16864406
offset-58072740
aggregated_byelit veniam ut
sort_by_metricexercitation
Request Payload
Response Payload
{
  "date": "2015-10-11",
  "stats": []
}
Query Parameter NameExample
limit2145410
offset51914588
aggregated_bymonth
subusers*officia enim eu sed nostrud
start_date*deserunt
end_dateexercitation in laboris mollit ullamco
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"mollit adipisicing eiusmod cillum"
Request Payload
{
  "ip": "192.168.1.1",
  "subdomain": "email",
  "domain": "example.com"
}
Response Payload
{
  "id": 123,
  "ip": "192.168.1.2",
  "rdns": "o1.email.example.com",
  "users": [],
  "subdomain": "email",
  "domain": "example.com",
  "valid": true,
  "legacy": false,
  "a_record": {
    "valid": true,
    "type": "a",
    "host": "o1.email.example.com",
    "data": "192.168.1.2"
  }
}
Query Parameter NameExample
limit-76415013
offset33641368
iplabore dolore reprehenderit ex
Header NameExample
on-behalf-of"consequat"
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"et laborum"
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"ad exercitation"
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"non et enim"
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": "dolore",
    "field": "exercitation aliqua"
  }
}

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
ipadipisicing et nostrud deserunt ullamco
exclude_whitelabelstrue
limit-61684054
offset-3683260
subuserDuis
sort_by_directiondesc
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
limit71655191
offset36941985
exclude_subusersfalse
usernametempor dolore aute qui quis
domainex
Header NameExample
on-behalf-of"adipisicing reprehenderit ipsum"
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"nulla enim in"
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"nisi culpa"
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"est aute do eu nisi"
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"pariatur Ut veniam velit dolor"
Request Payload
Response Payload
{}
Query Parameter NameExample
domainaliquip nostrud
Header NameExample
on-behalf-of"proident est nisi quis"
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"pariatur voluptate"
Request Payload
{
  "ip": "192.168.0.1"
}
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "john@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}
Header NameExample
on-behalf-of"officia"
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"proident in consectetur ipsum"
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*sunt voluptate
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
usernamedolore est Ut veniam in
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": "in voluptate consequat"
    }
  ]
}
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": "exercitation"
    },
    {
      "message": "aliqua tempor culpa reprehenderit nulla"
    }
  ]
}
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": "fugiat eiusmod Excepteur",
      "field": "non laboris",
      "message": "consequat incididunt officia consectetur"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "velit"
    },
    {
      "message": "est fugiat"
    },
    {
      "message": "Excepteur"
    }
  ]
}
Query Parameter NameExample
limit-71534554.66671681
lastSeenID-48932397.031581365
id-57579200
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": "pariatur"
    }
  ]
}
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": "tempor Duis sunt aute labore",
      "message": "in ut culpa"
    },
    {
      "error_id": "magna sit anim in in",
      "message": "quis et laborum aute"
    },
    {
      "error_id": "nisi esse magna consequat incididunt",
      "message": "dolore"
    }
  ]
}
{
  "errors": [
    {
      "message": "enim"
    },
    {
      "message": "eu laboris"
    },
    {
      "message": "ut cillum"
    },
    {
      "message": "proident"
    },
    {
      "message": "magna in adipisicing cupidatat consectetur"
    }
  ]
}
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": "anim in",
      "field": "nulla",
      "message": "aliquip ullamco"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "tempor",
      "message": "in magna"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sunt",
      "message": "Lorem ut deserunt"
    },
    {
      "error_id": "aliqua proident eiusmod irure dolore",
      "message": "non eiusmod dolor nulla"
    },
    {
      "error_id": "non Lorem Duis dolor",
      "message": "est sit eiusmod"
    },
    {
      "error_id": "non in sit commodo in",
      "message": "aliqua labore"
    },
    {
      "error_id": "consequat",
      "message": "est pariatur sint exercitation in"
    }
  ]
}
{
  "errors": [
    {
      "message": "aliquip sit sunt consequat"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sunt reprehenderit velit",
      "message": "reprehenderit ad"
    },
    {
      "error_id": "eiusmod aute eu",
      "message": "proident"
    },
    {
      "error_id": "Ut reprehenderit ut elit",
      "message": "in quis"
    },
    {
      "error_id": "laborum ipsum quis voluptate velit",
      "message": "quis"
    },
    {
      "error_id": "dolore Duis anim do",
      "message": "nisi"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "non",
      "message": "mollit occaecat"
    },
    {
      "error_id": "mollit occaecat dolor cillum",
      "message": "eiusmod veniam mollit aliquip"
    },
    {
      "error_id": "velit",
      "message": "dolor anim laboris"
    },
    {
      "error_id": "eu sit ut do",
      "message": "voluptate et deserunt sunt incididunt"
    },
    {
      "error_id": "exercitation velit minim",
      "message": "officia tempor amet velit"
    }
  ]
}
{
  "errors": [
    {
      "message": "cillum ipsum labore Lorem incididunt"
    },
    {
      "message": "adipisicing ut"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "error_id": "cillum",
      "message": "mollit"
    },
    {
      "error_id": "voluptate officia eu anim",
      "message": "sint"
    },
    {
      "error_id": "anim proident ea",
      "message": "sed Duis pariatur ipsum"
    },
    {
      "error_id": "commodo fugiat anim elit culpa",
      "message": "reprehenderit labore"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "veniam aute aliquip culpa",
      "message": "aliquip elit ipsum ex"
    },
    {
      "error_id": "occaecat cillum",
      "message": "consequat sed est cupidatat"
    }
  ]
}
{
  "errors": [
    {
      "message": "Ut pariatur eiusmod minim"
    },
    {
      "message": "deserunt non nisi adipisicing sed"
    }
  ]
}

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": "ullamco est veniam laboris",
  "field": "exercitation adipisicing ipsum proident aliqua",
  "message": "incididunt"
}
{
  "errors": [
    {
      "error_id": "consectetur ipsum fugiat officia Excepteur",
      "field": "velit esse minim pariatur in",
      "message": "enim occaecat qui"
    },
    {
      "error_id": "dolor aute",
      "field": "consectetur cillum anim",
      "message": "magna qui"
    },
    {
      "error_id": "ea",
      "field": "in",
      "message": "culpa et aliquip"
    },
    {
      "error_id": "aliquip voluptate labore laboris",
      "field": "esse do",
      "message": "amet esse aliqua"
    },
    {
      "error_id": "deserunt ut in",
      "field": "labore nulla Duis",
      "message": "occaecat Lorem"
    }
  ]
}
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": "ullamco",
      "field": "Ut",
      "message": "deserunt sed dolor"
    },
    {
      "error_id": "qui anim Duis culpa",
      "field": "fugiat eiusmod dolore laborum",
      "message": "occaecat dolor"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "cillum",
      "field": "irure",
      "message": "adipisicing"
    },
    {
      "error_id": "reprehenderit in sunt irure laborum",
      "field": "laboris occaecat",
      "message": "Duis culpa"
    },
    {
      "error_id": "sit fugiat",
      "field": "culpa esse nulla",
      "message": "magna ullamco exercitation in"
    }
  ]
}
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": "aute do tempor",
      "field": "Lorem exercitation et enim est",
      "message": "sit consequat eiusmod in"
    },
    {
      "error_id": "et voluptate",
      "field": "deserunt pariatur velit",
      "message": "enim nisi cillum proident"
    },
    {
      "error_id": "sint proident",
      "field": "magna",
      "message": "nostrud adipisicing"
    },
    {
      "error_id": "elit",
      "field": "minim",
      "message": "pariatur id occaecat culpa laborum"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "enim ipsum aliqua",
      "field": "elit sint",
      "message": "dolore do proident consectetur tempor"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "error_id": "laboris labore laborum",
      "field": "Excepteur dolor",
      "message": "commodo qui ex"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "minim cupidatat ut sed",
      "field": "Duis irure",
      "message": "aute mollit"
    },
    {
      "error_id": "Duis esse magna nisi aute",
      "field": "nisi aliqua Duis qui",
      "message": "ad"
    },
    {
      "error_id": "ut",
      "field": "dolor",
      "message": "ullamco minim culpa sunt"
    }
  ]
}
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": "occaecat irure sit dolor",
      "field": "elit",
      "message": "aliqua"
    },
    {
      "error_id": "cillum",
      "field": "culpa deserunt qui",
      "message": "exercitation"
    },
    {
      "error_id": "nulla ut",
      "field": "sit exercitation est nostrud",
      "message": "in amet laborum laboris"
    },
    {
      "error_id": "labore tempor fugiat ut",
      "field": "velit eiusmod anim ex",
      "message": "eiusmod pariatur dolor"
    }
  ]
}
Query Parameter NameExample
page_size25674395
page_tokenirure non cillum nulla
summarytrue
Request Payload
Response Payload
{
  "result": [
    {
      "id": "3247eaea-c912-42a3-b0bc-60bdaf210396",
      "name": "Welcome Email",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/llny8o5b3m636z92p7hbjnmq1jvpka39p370jwtin2s1wxv7x1sgm0y5fk518d0s.png",
      "subject": "Welcom to the Cake or Pie Cafe",
      "created_at": "2021-04-09T17:29:46Z",
      "updated_at": "2021-04-09T17:29:55Z",
      "editor": "code",
      "categories": [
        "welcome",
        "new customer"
      ]
    },
    {
      "id": "02dfd792-f31f-439a-a79e-5c47fbcfdbac",
      "name": "Monthly Promo",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/hfyxahd7ues2ajuoeoqq2xe6ibdasl1q89ox0y9ncya2ftpoicssmtf9ddus4c39.png",
      "subject": "Free Dozen Cupcakes",
      "created_at": "2021-04-09T17:29:21Z",
      "updated_at": "2021-04-09T17:29:42Z",
      "editor": "design",
      "categories": [
        "promo",
        "coupon"
      ]
    },
    {
      "id": "e54be823-19ef-4c6f-8b60-efd7514f492d",
      "name": "Duplicate: Ingrid & Anders",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/12kni9gjpyb9uxmwr9vk7unycjr70u95zoyhe9sg2zounul2zg7dih1s20k13q2z.png",
      "subject": "Welcome to Ingrid & Anders!",
      "created_at": "2020-10-09T17:33:46Z",
      "updated_at": "2021-04-07T19:57:52Z",
      "editor": "design",
      "categories": []
    }
  ],
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/designs?page_token=vHdvHCg0w1F-TmWJcPNpTEnFY2aPEmRBHONwOgZ6TgJbX2_I",
    "count": 3
  }
}
Request Payload
{
  "name": "Ahoy, Cake or Pie Cafe!",
  "editor": "design"
}
Response Payload
{
  "id": "abe0877f-a224-21e2-b62e-c789d326cda5",
  "name": "Ahoy, Pre-built Design!",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: courier, monospace;\n      font-size: 16px;\n    }\n    body {\n      color: #FFFFFF;\n    }\n    body a {\n      color: #fe5d61;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start-->\n\n     <!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#fe5d61\" data-body-style=\"font-size:16px; font-family:courier, monospace; color:#FFFFFF; background-color:#f2f4fb;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#f2f4fb\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#f2f4fb\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#FFFFFF; text-align:left;\" bgcolor=\"#f2f4fb\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p>You've found the secret!</p>\n      </td>\n    </tr>\n  </table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"98ndJyAY9BSGjoVqrr6FYx\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:30px 0px 30px 0px;\" valign=\"top\" align=\"left\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:40% !important; width:40%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/9d9c1f3d8009c42bbe60c0355f1ed23e86c3f5619173e83a9328b9214e42e1c1d5e009ed5cc4c8f3efedfc33d46bba2f4577b143607025a29add6e89ab4662ad.png\" alt=\"Off Grid Adventures\" width=\"240\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"3Ypdby9Xfsf2rN27zTDEfN\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/e324b295c47223f1a936198fbd4e5d4b239ff86c6d6c89d4d0eb8d7c61028921abfc4901ba607f6dcb7acc7067bb0c6df4313726b14b8274e0b2c98cdf8b58d2.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"7pyDCmyDaGcm5WsBBSaEgv\" data-mc-module-version=\"2019-10-22\">\n      <tbody><tr>\n        <td style=\"background-color:#FE5D61; padding:50px 0px 30px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#FE5D61\"><div><div style=\"font-family: inherit; text-align: center\"><span style=\"font-size: 24px\">Welcome to the family!</span></div><div></div></div></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"nSVYnVzPLnGZ4wUdynLiKo\" data-mc-module-version=\"2019-10-22\">\n      <tbody><tr>\n        <td style=\"background-color:#fe5d61; padding:30px 50px 30px 50px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#fe5d61\"><div><div style=\"font-family: inherit; text-align: center\">You've found a community of travelers that are just like you.</div>\n<div style=\"font-family: inherit; text-align: center\">&nbsp;</div>\n<div style=\"font-family: inherit; text-align: center\">We don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.</div>\n<div style=\"font-family: inherit; text-align: center\">&nbsp;</div>\n<div style=\"font-family: inherit; text-align: center\">Ready for your next authentic travel experience?</div><div></div></div></td>\n      </tr>\n    </tbody></table><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"module\" data-role=\"module-button\" data-type=\"button\" role=\"module\" style=\"table-layout:fixed\" width=\"100%\" data-muid=\"4ywPd9vJ6WFyV1Si75h9vh\"><tbody><tr><td align=\"center\" bgcolor=\"#fe5d61\" class=\"outer-td\" style=\"padding:10px 10px 60px 10px; background-color:#fe5d61;\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"button-css__deep-table___2OZyb wrapper-mobile\" style=\"text-align:center\"><tbody><tr><td align=\"center\" bgcolor=\"#ffffff\" class=\"inner-td\" style=\"border-radius:6px; font-size:16px; text-align:center; background-color:inherit;\"><a style=\"background-color:#ffffff; border:1px solid #ffffff; border-color:#ffffff; border-radius:3px; border-width:1px; color:#fe5d61; display:inline-block; font-size:16px; font-weight:700; letter-spacing:1px; line-height:40px; padding:12px 20px 12px 20px; text-align:center; text-decoration:none; border-style:solid;\" href=\"\" target=\"_blank\">Browse Gallery</a></td></tr></tbody></table></td></tr></tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"6jxKSRk9dKQ1Tvi1wtnu8q\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/0accac77b1e34c614730ab732317a493478835c96bd549fb2df7a921ec1177fdb30d6d33e1d0a33d8c6c579344890ae408ce13aaed0e478f1fd6d2219d308365.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"iYySZ4rAB78PLoW7vU13Bb\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"divider\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"mVyZz43HETwfwb72TGh4iy\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 0px 0px;\" role=\"module-content\" height=\"100%\" valign=\"top\" bgcolor=\"\">\n          <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" align=\"center\" width=\"100%\" height=\"3px\" style=\"line-height:3px; font-size:3px;\">\n            <tbody><tr>\n              <td style=\"padding:0px 0px 3px 0px;\" bgcolor=\"#ffffff\"></td>\n            </tr>\n          </tbody></table>\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"sfek66tVLi5d2iy5jmSawj\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"social\" align=\"center\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"87277ffe-54ed-4792-94f3-0a973b71c268\">\n    <tbody>\n      <tr>\n        <td valign=\"top\" style=\"padding:0px 0px 0px 0px; font-size:6px; line-height:10px;\" align=\"center\">\n          <table align=\"center\" style=\"-webkit-margin-start:auto;-webkit-margin-end:auto;\">\n            <tbody><tr align=\"center\"><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.facebook.com/sendgrid/\" target=\"_blank\" alt=\"Facebook\" title=\"Facebook\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Facebook\" title=\"Facebook\" src=\"https://mc.sendgrid.com/assets/social/white/facebook.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor\" target=\"_blank\" alt=\"Twitter\" title=\"Twitter\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Twitter\" title=\"Twitter\" src=\"https://mc.sendgrid.com/assets/social/white/twitter.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.instagram.com/sendgrid/?hl=en\" target=\"_blank\" alt=\"Instagram\" title=\"Instagram\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Instagram\" title=\"Instagram\" src=\"https://mc.sendgrid.com/assets/social/white/instagram.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.pinterest.com/sendgrid/\" target=\"_blank\" alt=\"Pinterest\" title=\"Pinterest\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Pinterest\" title=\"Pinterest\" src=\"https://mc.sendgrid.com/assets/social/white/pinterest.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td></tr></tbody>\n          </table>\n        </td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module unsubscribe-css__unsubscribe___2CDlR\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#FFFFFF; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:center;\" data-muid=\"txBUUpmixSjuZ5Ad69p1sX\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "plain_content": "You've found the secret!\n\nWelcome to the family!\n\nYou've found a community of travelers that are just like you.\n\nWe don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.\n\nReady for your next authentic travel experience?\n\nBrowse Gallery\n\n( https://www.facebook.com/sendgrid/ ) ( https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor ) ( https://www.instagram.com/sendgrid/?hl=en ) ( https://www.pinterest.com/sendgrid/ )\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
  "generate_plain_content": true,
  "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/a85b4b202ff28094828f11ff472360caecf67ead2d186b69b45c904b9251aa0b.png",
  "subject": "Welcome to the family!",
  "created_at": "2021-04-30T19:15:28Z",
  "updated_at": "2021-04-30T19:15:28Z",
  "editor": "design",
  "categories": []
}
{
  "errors": [
    {
      "error_id": "irure Excepteur dolor",
      "field": "cillum enim",
      "message": "id esse pariatur fugiat sed"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "officia minim dolor proident ex",
      "field": "enim quis Lorem eu sed",
      "message": "ad reprehenderit sint in"
    },
    {
      "error_id": "eu magna",
      "field": "mollit ullamco eiusmod ex",
      "message": "amet culpa proident"
    },
    {
      "error_id": "adipisicing minim",
      "field": "dolor dolore est esse",
      "message": "pariatur consequat sed veniam cillum"
    },
    {
      "error_id": "amet mollit",
      "field": "aliqua sed cillum labore",
      "message": "laboris"
    },
    {
      "error_id": "deserunt",
      "field": "sunt eu non commodo voluptate",
      "message": "aute eiusmod laborum"
    }
  ]
}
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": "laborum dolore",
      "field": "ex magna",
      "message": "pariatur"
    },
    {
      "error_id": "aliquip Duis labore id nostrud",
      "field": "Excepteur sit ullamco dolore officia",
      "message": "enim Excepteur"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "veniam proident eu nisi velit",
      "field": "esse ea sint elit veniam",
      "message": "culpa sint consectetur"
    },
    {
      "error_id": "eiusmod nostrud ullamco officia",
      "field": "consectetur aliquip reprehenderit veniam",
      "message": "ut"
    },
    {
      "error_id": "dolor in",
      "field": "sit esse consequat laboris",
      "message": "et"
    },
    {
      "error_id": "amet consequat",
      "field": "est",
      "message": "laboris eu"
    }
  ]
}
Query Parameter NameExample
page_size68953347
page_tokenullamco in
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": "sit",
      "address_line_2": "in dolor pariatur ea Excepteu",
      "alternate_emails": [
        "mollit exercitation",
        "dolor fugiat consectetur in",
        "do veniam adipisicing",
        "fugiat",
        "in pariatur sint id qui"
      ],
      "city": "voluptate nisi magna qui",
      "country": "sint qui mollit ",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "dolor enim commodo in",
      "first_name": "in",
      "last_name": "e",
      "postal_code": "fugiat cupidatat aliquip labore",
      "state_province_region": "Excepteur consectetur"
    },
    {
      "address_line_1": "sit",
      "address_line_2": "",
      "alternate_emails": [
        "fugiat consectetur",
        "labore",
        "do anim Duis",
        "dolor commodo aute",
        "Ut in Duis"
      ],
      "city": "cupidatat in",
      "country": "quis nostrud es",
      "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": "magna est elit",
      "first_name": "sed velit esse commodo",
      "last_name": "Lo",
      "postal_code": "dolor sunt",
      "state_province_region": "qui officia"
    },
    {
      "address_line_1": "elit ut officia velit laborum",
      "address_line_2": "pariat",
      "alternate_emails": [
        "anim laboris",
        "nulla",
        "reprehenderit elit mollit velit",
        "qui minim",
        "ex in nisi"
      ],
      "city": "ullamco elit velit sit",
      "country": "irure enim exercitation esse o",
      "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": "Duis nostrud",
      "first_name": "do ex mollit ullamco nostrud",
      "last_name": "qui culpa irure quis",
      "postal_code": "voluptate ipsum in",
      "state_province_region": "ullamco pariatur"
    },
    {
      "address_line_1": "et do consequat officia",
      "address_line_2": "nisi",
      "alternate_emails": [
        "ea in Lorem",
        "aliqua Lorem sint elit",
        "dolore fugiat proident commodo nulla",
        "ut culpa amet",
        "esse sunt minim"
      ],
      "city": "id exercitation",
      "country": "Ut officia pariatur proident ex",
      "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 pariatur",
      "first_name": "id commodo aute",
      "last_name": "aute sit",
      "postal_code": "tempor officia ullamco exercitation proident",
      "state_province_region": "pariatur aliquip veniam est Duis"
    },
    {
      "address_line_1": "est magna pariatur fug",
      "address_line_2": "irure Excepteur nostrud nisi sint",
      "alternate_emails": [
        "eu aliquip ullamco in",
        "ea dolor aute aliqua",
        "veniam laborum aute est quis",
        "et ullamco non pariatur elit",
        "ad dolor"
      ],
      "city": "labore in id laborum ullamco",
      "country": "et eu deserunt",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "ad eiusmod eu deserunt labore",
      "first_name": "est mollit",
      "last_name": "ipsum dolore amet ex incididunt",
      "postal_code": "ut id",
      "state_province_region": "ipsum anim est nisi minim"
    },
    {
      "address_line_1": "Ut eiusmod qui",
      "address_line_2": "incididunt cupidatat Ut",
      "alternate_emails": [
        "",
        "nostrud adipisicing consequat voluptate dolor",
        "anim ea aute",
        "anim sint ipsum nostrud ea",
        "dolor ea"
      ],
      "city": "veniam quis ullamco exercitation",
      "country": "laboris do dolore",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "aute",
      "first_name": "cons",
      "last_name": "mollit id est velit",
      "postal_code": "adipisicing deserunt",
      "state_province_region": "ipsum"
    },
    {
      "address_line_1": "eiusmod cillum nisi in",
      "address_line_2": "amet",
      "alternate_emails": [
        "anim",
        "tempor deserunt voluptate",
        "dolor pariat",
        "nostrud esse nisi",
        "minim in qui adipisicing esse"
      ],
      "city": "ni",
      "country": "est aliqua",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "commodo tempor adipisicing",
      "first_name": "veniam",
      "last_name": "",
      "postal_code": "nisi",
      "state_province_region": "cupidatat proident"
    },
    {
      "address_line_1": "ut ut magna ullamco in",
      "address_line_2": "D",
      "alternate_emails": [
        "Ut reprehenderit aliquip",
        "in",
        "occaecat in",
        "do fugiat laborum cillum cupidatat",
        "Duis ex Lorem Excepteur incididunt"
      ],
      "city": "cup",
      "country": "mollit",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "pariatur cillum",
      "first_name": "sed eu adipisicing ",
      "last_name": "et aliquip",
      "postal_code": "et labore mollit Duis ullamco",
      "state_province_region": "cillum nostrud"
    },
    {
      "address_line_1": "reprehenderit est labore qui",
      "address_line_2": "incididunt",
      "alternate_emails": [
        "cillum",
        "deserunt voluptate",
        "in est mollit labore irure",
        "Ut eiusmod reprehenderit sit",
        "eiusmod ex"
      ],
      "city": "dolore ullamco sunt ut est",
      "country": "dol",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "pariatur qui elit",
      "first_name": "cupidatat in in elit",
      "last_name": "ad amet nulla",
      "postal_code": "eiusmod ad ut do",
      "state_province_region": "minim esse non am"
    },
    {
      "address_line_1": "adipisicing",
      "address_line_2": "qui",
      "alternate_emails": [
        "cillum sint",
        "nulla",
        "pariatur laborum",
        "ipsum",
        "Excepteur ut"
      ],
      "city": "minim",
      "country": "officia",
      "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": "in anim",
      "first_name": "officia laboris do",
      "last_name": "aute in",
      "postal_code": "reprehenderit incididunt exercitation ut amet",
      "state_province_region": "culpa"
    }
  ],
  "list_ids": [
    "e81abd14-0d58-27e3-6207-1497611b35db",
    "fe3ad0d7-cdce-ef4b-15e3-df393ce56ee8",
    "ed520e84-09a8-62dd-160f-77d75e872080"
  ]
}
Response Payload
{
  "job_id": "ut ea sit nulla commodo"
}
{
  "errors": [
    {
      "error_id": "quis aliquip cillum adipisicing",
      "field": "qui mollit exercitation in",
      "message": "Excepteur do",
      "parameter": "ex sit nostrud anim dolore"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "in ex in"
    },
    {
      "message": "Excepteur proident"
    },
    {
      "message": "eu in adipisicing laborum Excepteur"
    },
    {
      "message": "laborum ut elit"
    },
    {
      "message": "veniam cupidatat Duis consequat"
    }
  ]
}
Query Parameter NameExample
delete_all_contactsnisi laboris sit
idsfugiat amet sit
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": "dolore veniam mollit esse tempor"
    },
    {
      "message": "elit ut"
    },
    {
      "message": "Lorem sit"
    },
    {
      "message": "dolor culpa eu dolore pariatur"
    },
    {
      "message": "minim non laboris nostrud consequat"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "self": "do"
  },
  "contact_count": -77828738,
  "result": [
    {
      "_metadata": {
        "self": "quis fugiat"
      },
      "address_line_1": "nostrud",
      "address_line_2": "consectetur ex fugiat",
      "alternate_emails": [
        "Lorem adipisicing aute nulla tempor"
      ],
      "city": "laborum deserunt laboris",
      "country": "labore",
      "created_at": "nisi",
      "custom_fields": {},
      "email": "sunt",
      "facebook": "nulla",
      "first_name": "voluptate ipsum nisi labore mollit",
      "id": "Lorem",
      "last_name": "cillum Excepteur Lorem",
      "line": "Excepteur aute aliqua magna",
      "list_ids": [
        "qui",
        "commodo",
        "sit",
        "commodo elit eiusmod dolor non"
      ],
      "phone_number": "sunt anim ut est quis",
      "postal_code": "ullamco magna dolore culpa eu",
      "segment_ids": [
        "nostrud",
        "veniam sint"
      ],
      "state_province_region": "pariatur enim eiusmod",
      "unique_name": "aliqua mollit amet",
      "updated_at": "Excepteur commodo et do",
      "whatsapp": "ut ut id ea"
    },
    {
      "_metadata": {
        "self": "consequat"
      },
      "address_line_1": "labore mollit sit",
      "address_line_2": "laborum tempor",
      "alternate_emails": [
        "ullamco qui",
        "velit sit adipisicing"
      ],
      "city": "fugiat commodo",
      "country": "ad",
      "created_at": "ad culpa proident",
      "custom_fields": {},
      "email": "adipisicing fugiat reprehenderit cupidatat",
      "facebook": "nulla aliquip anim amet",
      "first_name": "dolor deserunt esse labore",
      "id": "esse ut",
      "last_name": "ut qui",
      "line": "mollit officia exercitation amet",
      "list_ids": [
        "sunt"
      ],
      "phone_number": "et cupidatat occaecat aute mollit",
      "postal_code": "id Lorem est",
      "segment_ids": [
        "dolor"
      ],
      "state_province_region": "sed Excepteur nisi",
      "unique_name": "ut commodo adipisicing sed",
      "updated_at": "magna qui",
      "whatsapp": "et in cillum ad"
    },
    {
      "_metadata": {
        "self": "laboris nisi"
      },
      "address_line_1": "Lorem ad culpa consectetur eu",
      "address_line_2": "ullamco aliqua ut officia adipisicing",
      "alternate_emails": [
        "ipsum in aliquip sed",
        "sed velit esse",
        "esse incididunt proident",
        "veniam magna velit Duis Ut"
      ],
      "city": "esse minim nisi sunt",
      "country": "consectetur cillum in",
      "created_at": "aliqua reprehenderit",
      "custom_fields": {},
      "email": "labore commodo",
      "facebook": "amet",
      "first_name": "ut irure dolore",
      "id": "sed est proident consequat id",
      "last_name": "cupidatat tempor enim sint",
      "line": "mollit qui dolore",
      "list_ids": [
        "nisi dolor nostrud cupidatat",
        "Ut labore ad",
        "dolore nulla"
      ],
      "phone_number": "velit mollit nostrud",
      "postal_code": "eiusmod ad veniam eu",
      "segment_ids": [
        "est in elit",
        "veniam",
        "quis id laboris"
      ],
      "state_province_region": "mollit",
      "unique_name": "nisi dolor dolore commodo elit",
      "updated_at": "irure id dolore in dolor",
      "whatsapp": "ad"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "veniam",
      "field": "mollit dolor Lorem sit",
      "message": "nulla elit ullamco Lorem",
      "parameter": "culpa ut eiusmod ut esse"
    },
    {
      "error_id": "incididunt",
      "field": "et aliqua amet do",
      "message": "dolore sed aliqua eiusmod est",
      "parameter": "sunt ipsum proident"
    },
    {
      "error_id": "laborum do",
      "field": "in officia pariatur tempor nostrud",
      "message": "consectetur voluptate",
      "parameter": "labore"
    },
    {
      "error_id": "id ipsum sint in",
      "field": "laborum adipisicing Lorem Excepteur anim",
      "message": "dolore nulla",
      "parameter": "sint"
    },
    {
      "error_id": "dolore consectetur commodo proident quis",
      "field": "exercitation incididunt proident fugiat",
      "message": "ut adipisicing",
      "parameter": "esse in dolore commodo ullamco"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "qui Ut"
    },
    {
      "message": "do ut officia sit"
    },
    {
      "message": "cillum laboris ullamco"
    },
    {
      "message": "anim dolore amet laborum culpa"
    }
  ]
}
Request Payload
Response Payload
{
  "billable_breakdown": {
    "breakdown": {},
    "total": -53996791
  },
  "billable_count": 93803396,
  "contact_count": -72930526
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "in dolor nulla consequat qui"
    }
  ]
}
Request Payload
{
  "file_type": "json",
  "list_ids": [
    "38219e83-4836-9c4b-09a8-155bd8751de5",
    "8c6301b3-e760-3762-f7b8-cd8d5d63231f",
    "aa2a8dfd-922d-fe37-989c-b3aba240f602"
  ],
  "max_file_size": -31611251,
  "notifications": {
    "email": true
  },
  "segment_ids": [
    "sed adipisicing"
  ]
}
Response Payload
{
  "_metadata": {
    "count": 15203725.916009963,
    "next": "http://jlzdHzvHHTwrRnt.essjCUIf2nTC93qHc,mQbfPxKRrlHFob5cn,SQnaNzYkt,M0DHunvVS3sqSZ8kgZbz5cL9PA-x0eX9F,k",
    "prev": "http://lPyEWd.oyWFGcfpZRbHtuIy0",
    "self": "http://YoLWeuMtJsmiuUpj.qdgQ.VR7M6fLhT,Nqdrxi5KOVlpfzIMDV1HuPFsQbP3mxtE4BKmJn39gEF4iws5N-i0hzdkZ"
  },
  "id": "consequat cupidatat aliqua"
}
{
  "errors": [
    {
      "error_id": "Excepteur proident voluptate sunt culpa",
      "field": "dolor adipisicing exercitation sunt",
      "message": "adipisicing dolore",
      "parameter": "eiusmod nostrud"
    },
    {
      "error_id": "incididunt commodo sint dolor pariatur",
      "field": "quis magna Excepteur velit dolore",
      "message": "reprehenderit non enim est",
      "parameter": "ut mollit laborum voluptate"
    },
    {
      "error_id": "ex pariatur non",
      "field": "laborum cupidatat culpa dolore",
      "message": "ut",
      "parameter": "Ut culpa incididunt enim pariatur"
    },
    {
      "error_id": "velit sint deserunt",
      "field": "mollit qui",
      "message": "consectetur id commodo mollit non",
      "parameter": "ad dolor non aute nulla"
    },
    {
      "error_id": "non Duis veniam tempor proident",
      "field": "sint in reprehenderit non",
      "message": "veniam",
      "parameter": "labore"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "aliqua nulla sunt mollit"
    },
    {
      "message": "dolore"
    },
    {
      "message": "quis labore eu"
    },
    {
      "message": "nisi velit"
    },
    {
      "message": "et ipsum exercitation consectetur reprehenderit"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "next": "sit",
    "prev": "id non Excepteur",
    "self": "quis enim proident laborum mollit"
  },
  "result": [
    {
      "_metadata": {
        "next": "irure",
        "prev": "sunt labore laboris",
        "self": "qui in"
      },
      "completed_at": "officia esse laboris ea",
      "created_at": "culpa proident quis sit",
      "expires_at": "sint officia consectetur amet",
      "export_type": "Lorem sunt",
      "id": "dolor cillum nulla",
      "lists": [
        {
          "ID": "ex eiusmod",
          "Name": "Duis"
        }
      ],
      "segments": [
        {
          "ID": "ipsum",
          "Name": "dolore voluptate fugiat aute"
        },
        {
          "ID": "culpa in Lorem",
          "Name": "Lorem nisi amet"
        },
        {
          "ID": "amet",
          "Name": "eiusmod ullamco cupidatat"
        },
        {
          "ID": "velit",
          "Name": "anim reprehenderit sunt fugiat do"
        }
      ],
      "status": "nostrud eiusmod",
      "urls": [
        "ipsum",
        "deserunt ut laborum consectetur",
        "cillum ipsum et non",
        "sit in ex et voluptate",
        "dolor nulla magna"
      ],
      "user_id": "in amet"
    },
    {
      "_metadata": {
        "next": "sint",
        "prev": "esse laboris sunt officia",
        "self": "nostrud proident"
      },
      "completed_at": "enim in voluptate",
      "created_at": "cupidatat",
      "expires_at": "aliqua",
      "export_type": "dolor consectetur",
      "id": "elit laborum dolor nostrud",
      "lists": [
        {
          "ID": "dolore sit et sint fugiat",
          "Name": "ipsum labore proident"
        },
        {
          "ID": "eu ipsum tempor pariatur magna",
          "Name": "nulla nostrud"
        },
        {
          "ID": "pariatur",
          "Name": "et Ut minim eiusmod"
        },
        {
          "ID": "officia ipsum aute exercitation irure",
          "Name": "reprehenderit aute"
        }
      ],
      "segments": [
        {
          "ID": "enim tempor",
          "Name": "ipsum ea ad ullamco"
        },
        {
          "ID": "commodo",
          "Name": "ut"
        },
        {
          "ID": "proident",
          "Name": "non pariatur minim"
        }
      ],
      "status": "minim tempor nisi",
      "urls": [
        "cupidatat"
      ],
      "user_id": "aute eu culpa"
    },
    {
      "_metadata": {
        "next": "nostrud deserunt",
        "prev": "officia",
        "self": "eiusmod laborum cupidatat id in"
      },
      "completed_at": "dolore cupidatat",
      "created_at": "eiusmod consequat adipisicing proident",
      "expires_at": "et cupidatat",
      "export_type": "minim deserunt",
      "id": "aliquip consectetur exercitation officia",
      "lists": [
        {
          "ID": "dolor quis qui est",
          "Name": "irure dolor commodo dolor quis"
        },
        {
          "ID": "id fugiat mollit",
          "Name": "nisi"
        },
        {
          "ID": "incididunt ut ex sit velit",
          "Name": "irure cillum labore consectetur"
        },
        {
          "ID": "eiusmod ullamco ex",
          "Name": "dolor"
        },
        {
          "ID": "dolore",
          "Name": "elit"
        }
      ],
      "segments": [
        {
          "ID": "consequat nisi anim cupidatat nostrud",
          "Name": "ullamco elit est magna"
        },
        {
          "ID": "nulla adipisicing",
          "Name": "occaecat non laborum sit"
        }
      ],
      "status": "dolor",
      "urls": [
        "eiusmod Lorem mollit id aliqua"
      ],
      "user_id": "irure deserunt consectetur enim incididunt"
    },
    {
      "_metadata": {
        "next": "commodo labore sit",
        "prev": "nostrud",
        "self": "laboris dolore ipsum Duis"
      },
      "completed_at": "nisi reprehenderit veniam proident dolore",
      "created_at": "sed dolor do velit",
      "expires_at": "elit consequat magna anim",
      "export_type": "esse elit sit",
      "id": "nulla et aute in",
      "lists": [
        {
          "ID": "ad in proident culpa nulla",
          "Name": "laborum"
        }
      ],
      "segments": [
        {
          "ID": "ut",
          "Name": "ut"
        }
      ],
      "status": "deserunt minim mollit adipisicing",
      "urls": [
        "magna",
        "pariatur voluptate occaecat id et",
        "magna nisi amet labore pariatur"
      ],
      "user_id": "aliquip incididunt consectetur esse proident"
    },
    {
      "_metadata": {
        "next": "deserunt",
        "prev": "culpa aliqua dolor tempor eu",
        "self": "veniam do Ut et irure"
      },
      "completed_at": "anim",
      "created_at": "laborum esse Lorem",
      "expires_at": "labore cillum irure ipsum",
      "export_type": "nulla enim et",
      "id": "dolore mollit nulla",
      "lists": [
        {
          "ID": "aliquip in eu anim",
          "Name": "culpa aliqua exercitation in"
        },
        {
          "ID": "cupidatat",
          "Name": "laboris est ea"
        },
        {
          "ID": "cillum dolore aute eu officia",
          "Name": "cillum incididunt velit mollit elit"
        }
      ],
      "segments": [
        {
          "ID": "officia quis",
          "Name": "in cillum ipsum consequat aute"
        },
        {
          "ID": "qui aliquip eu exercitation",
          "Name": "pariatur laborum"
        },
        {
          "ID": "Ut consectetur",
          "Name": "et ea"
        }
      ],
      "status": "exercitation ut eu magna Lorem",
      "urls": [
        "in esse",
        "nisi ad ullamco consequat aute"
      ],
      "user_id": "exercitation ullamco do"
    }
  ]
}
{
  "errors": [
    {
      "": "mollit ea esse",
      "error_id": "consectetur veniam nulla",
      "message": "adipisicing labore ipsum Duis"
    },
    {
      "": "aliqua",
      "error_id": "sed",
      "message": "sint consequat sed in deserunt"
    }
  ]
}
{
  "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": "dolore"
    },
    {
      "message": "nostrud"
    },
    {
      "message": "sunt labore exercitation non"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "self": "nisi do elit"
  },
  "address_line_1": "sunt velit qui ad ipsum",
  "address_line_2": "nisi Excepteur officia anim nostrud",
  "alternate_emails": [
    "dolor eiusmod nisi",
    "incididunt in amet Duis",
    "mollit incididunt irure in",
    "pariatur incididunt quis sed"
  ],
  "city": "Excepteur qui mollit esse magna",
  "country": "incididunt eiusmod sed",
  "created_at": "laboris",
  "custom_fields": {},
  "email": "occaecat non",
  "facebook": "laboris sed pariatur",
  "first_name": "nulla",
  "id": "velit anim",
  "last_name": "Lorem mollit irure",
  "line": "ullamco pariatur id ex",
  "list_ids": [
    "consequat sunt tempor",
    "sint non veniam"
  ],
  "phone_number": "id dolore",
  "postal_code": "dolor magna",
  "segment_ids": [
    "qui",
    "sunt in incididunt non"
  ],
  "state_province_region": "laborum",
  "unique_name": "sint in tempor",
  "updated_at": "irure",
  "whatsapp": "tempor laboris labore dolore quis"
}
{
  "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": "adipisicing"
    },
    {
      "message": "aliquip aute sint commodo do"
    },
    {
      "message": "dolor in aute voluptate pariatur"
    }
  ]
}
Request Payload
{
  "query": "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')"
}
Response Payload
{
  "_metadata": {
    "self": "incididunt"
  },
  "contact_count": 4217053.549530461,
  "result": [
    {
      "_metadata": {
        "self": "sunt ea aliqua nulla dolore"
      },
      "address_line_1": "Ut do officia laborum",
      "address_line_2": "in nulla aute anim",
      "alternate_emails": [
        "nulla tempor magna"
      ],
      "city": "Lorem aliqua dolore",
      "country": "est in reprehenderit",
      "created_at": "dolore",
      "custom_fields": {},
      "email": "consectetur quis elit exercitation ullamco",
      "facebook": "cillum consectetur qui aliqua",
      "first_name": "non consectetur do dolore eiusmod",
      "id": "minim esse",
      "last_name": "ullamco in",
      "line": "proident adipisicing voluptate commodo",
      "list_ids": [
        "ut ea",
        "sint"
      ],
      "phone_number": "deserunt dolore tempor veniam id",
      "postal_code": "Lorem ipsum mollit cillum dolore",
      "segment_ids": [
        "amet aute",
        "aute dolor laborum in magna",
        "Lorem ex ullamco Duis"
      ],
      "state_province_region": "culpa eu ipsum et",
      "unique_name": "ad esse Excepteur",
      "updated_at": "Excepteur velit quis",
      "whatsapp": "fugiat veniam"
    },
    {
      "_metadata": {
        "self": "elit mollit nisi"
      },
      "address_line_1": "et ullamco elit",
      "address_line_2": "commodo ad amet",
      "alternate_emails": [
        "irure ut est fugiat",
        "quis qui dolor"
      ],
      "city": "sunt aliqua nulla do",
      "country": "labore ullamco",
      "created_at": "Ut ullamco quis commodo",
      "custom_fields": {},
      "email": "nisi exercitation nostrud",
      "facebook": "ad sint ullamco culpa sed",
      "first_name": "dolore incididunt velit in",
      "id": "officia qui in dolor",
      "last_name": "dolor ut in",
      "line": "reprehenderit pariatur labore",
      "list_ids": [
        "tempor non cupidatat ut est",
        "elit enim anim occaecat"
      ],
      "phone_number": "in laboris veniam",
      "postal_code": "exercitation reprehenderit proident incididunt",
      "segment_ids": [
        "in",
        "in laboris est occaecat",
        "elit",
        "ea deserunt",
        "non irure in anim id"
      ],
      "state_province_region": "pariatur est dolore nostrud irure",
      "unique_name": "eiusmod occaecat",
      "updated_at": "in",
      "whatsapp": "culpa pariatur incididunt aute"
    },
    {
      "_metadata": {
        "self": "enim in aliqua nisi"
      },
      "address_line_1": "ut Lorem ad quis amet",
      "address_line_2": "qui",
      "alternate_emails": [
        "Excepteur ipsum dolor ut"
      ],
      "city": "et adipisicing aute fugiat",
      "country": "elit",
      "created_at": "ea amet cillum ad",
      "custom_fields": {},
      "email": "non et",
      "facebook": "sunt anim officia",
      "first_name": "eiusmod dolor ex commodo tempor",
      "id": "sed Excepteur magna",
      "last_name": "proident amet",
      "line": "do ad",
      "list_ids": [
        "adipisicing Duis enim",
        "occaecat in Excepteur sed Duis",
        "irure pariatur ut qui"
      ],
      "phone_number": "est consectetur proident sit ea",
      "postal_code": "ipsum ea ad laborum consectetur",
      "segment_ids": [
        "sint ut aliqua sit incididunt",
        "in est",
        "ut in",
        "velit"
      ],
      "state_province_region": "mollit Lorem",
      "unique_name": "et incididunt commodo irure veniam",
      "updated_at": "elit nulla",
      "whatsapp": "nulla non consectetur"
    }
  ]
}
{
  "errors": [
    {
      "field": "anim in laborum",
      "message": "in ad eiusmod culpa"
    }
  ]
}
{
  "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": "dolor"
    },
    {
      "message": "pariatur dolor"
    },
    {
      "message": "elit Lorem Ut amet magna"
    },
    {
      "message": "labore"
    },
    {
      "message": "ullamco eu"
    }
  ]
}
Request Payload
{
  "field_mappings": [
    null
  ],
  "file_type": "csv",
  "list_ids": [
    "minim est id",
    "dolore officia exercitation laboris",
    "veniam"
  ]
}
Response Payload
{
  "job_id": "aute eu",
  "upload_headers": [
    {
      "header": "anim irure Ut quis amet",
      "value": "mollit enim ullamco dolore dolore"
    },
    {
      "header": "irure exercitation qui",
      "value": "irure id ea"
    },
    {
      "header": "adipisicing quis ea Ut",
      "value": "exercitation qui Duis aliqua"
    }
  ],
  "upload_uri": "reprehenderit laboris mollit"
}
{
  "errors": [
    {
      "error_id": "nostrud ad exercitation proident",
      "field": "dolor aliquip non",
      "message": "irure labore ea",
      "parameter": "in consectetur Duis enim velit"
    },
    {
      "error_id": "sed nulla Excepteur",
      "field": "laboris ullamco Duis et",
      "message": "sed eu enim labore",
      "parameter": "sed"
    },
    {
      "error_id": "ea qui sint consequat ipsum",
      "field": "esse officia",
      "message": "dolore commodo velit elit",
      "parameter": "enim nisi mollit anim"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ut nisi labore ullamco sunt",
      "field": "cupidatat ea sunt",
      "message": "culpa nulla sit",
      "parameter": "dolor id incididunt ullamco pariatur"
    },
    {
      "error_id": "nulla est ut anim sed",
      "field": "minim incididunt",
      "message": "pariatur",
      "parameter": "dolore ea amet pariatur"
    },
    {
      "error_id": "mollit",
      "field": "amet aute commodo esse non",
      "message": "cillum laboris do officia",
      "parameter": "sed mollit"
    },
    {
      "error_id": "dolor",
      "field": "do ex sed",
      "message": "non do et in",
      "parameter": "eu sit exercitation"
    },
    {
      "error_id": "minim",
      "field": "dolor labore fugiat sunt",
      "message": "reprehenderit eiusmod dolor",
      "parameter": "Lorem"
    }
  ]
}
{
  "errors": [
    {
      "message": "ea fugiat sed exercitation officia"
    },
    {
      "message": "culpa veniam"
    },
    {
      "message": "cillum velit"
    },
    {
      "message": "exercitation anim cillum Lorem"
    }
  ]
}
Request Payload
Response Payload
{
  "finished_at": "esse id",
  "id": "esse",
  "job_type": "aliquip",
  "results": {
    "created_count": -3481379.651328087,
    "deleted_count": 47188690.45071629,
    "errored_count": 55117883.96085283,
    "errors_url": "ex sint nostrud in veniam",
    "requested_count": 34637791.74333045,
    "updated_count": 80067567.67927882
  },
  "started_at": "in non",
  "status": "dolor pariatur esse"
}
{
  "errors": {
    "error_id": "culpa eu proident",
    "field": "aliqua",
    "message": "Lorem dolore qui cillum sit",
    "parameter": "adipisicing magna pariatur dolor ut"
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "nulla enim veniam deserunt occaecat"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "count": -97262864.57655618,
    "next": "http://jEXwkeNIPWYL.ctsmXNJYiKmO,GfMucia4P-e-JSFe.rCr279GV,mPER4iCeZm7QsdZOJ.",
    "prev": "http://UqBzYqhuUAQGgkkzHcnZcwiNMn.gmhEcoF1pTwGQ",
    "self": "http://mUzrXzxzMLRiZeYIV.aruwzl7LZMpbLveDukdlB6eIZn6Y-12KwuZMvhwvEdwYFlksrD2o8Ro"
  },
  "completed_at": "dolore dolor",
  "contact_count": 1949286,
  "created_at": "sint ad dolore",
  "expires_at": "laboris deserunt",
  "id": "sed",
  "message": "irure tempor consequat",
  "status": "ready",
  "updated_at": "dolore",
  "urls": [
    "sed voluptate Ut"
  ]
}
{
  "errors": [
    {
      "error_id": "dolor irure eu proident nisi",
      "field": "ad cupidatat Ut",
      "message": "pariatur",
      "parameter": "mollit voluptate deserunt sit laborum"
    },
    {
      "error_id": "Excepteur velit ut",
      "field": "labore Ut",
      "message": "laboris tempor nisi qui",
      "parameter": "dolore Ut laboris ipsum"
    },
    {
      "error_id": "minim dolor cillum elit ex",
      "field": "magna est amet",
      "message": "in sunt ipsum",
      "parameter": "fugiat occaecat"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "laboris irure velit"
    },
    {
      "message": "mollit laboris"
    },
    {
      "message": "Ut"
    }
  ]
}
Request Payload
{
  "ids": [
    "1234",
    "1235"
  ]
}
Response Payload
{
  "result": [
    {
      "_metadata": {
        "self": "Ut adipisicing"
      },
      "address_line_1": "labore nisi",
      "address_line_2": "fugiat in incididunt aute esse",
      "alternate_emails": [
        "dolore magna laboris mollit"
      ],
      "city": "eu eiusmod ullamco incididunt dolor",
      "country": "voluptate in tempor laboris",
      "created_at": "dolor aute esse sunt est",
      "custom_fields": {},
      "email": "in",
      "facebook": "velit voluptate sed enim",
      "first_name": "Duis irure nulla",
      "id": "ipsum est dolore",
      "last_name": "non magna incididunt esse",
      "line": "occaecat Ut enim mollit",
      "list_ids": [
        "deserunt ut"
      ],
      "phone_number": "exercitation cupidatat Ut commodo non",
      "postal_code": "nostrud",
      "segment_ids": [
        "dolor deserunt do cillum est",
        "proident sed",
        "anim",
        "labore voluptate",
        "est ipsum veniam officia"
      ],
      "state_province_region": "deserunt culpa amet id incididunt",
      "unique_name": "quis fugiat",
      "updated_at": "commodo proident ea irure labore",
      "whatsapp": "enim cupidatat reprehenderit eiusmod"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "aliquip amet dolor"
    },
    {
      "message": "Duis"
    },
    {
      "message": "id do velit ut"
    }
  ]
}
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": "deserunt culpa enim proident tempor"
    },
    {
      "message": "non tempor esse Lorem"
    },
    {
      "message": "eiusmod nostrud adipisicing in Lorem"
    }
  ]
}

Segmenting Contacts V2 - Beta(5 operations)

Request Payload
{
  "name": "elit",
  "parent_list_ids": [
    "et qui irure",
    "ut Duis laborum et nisi",
    "deserunt reprehenderit"
  ],
  "query_dsl": "officia ea nisi in consectetur"
}
Response Payload
{
  "contacts_count": -68601547,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "ex",
  "id": "5db1fcdc-28d8-8fc4-8271-74da29a54dc2",
  "name": "occaecat eu esse",
  "next_sample_update": "amet eu",
  "parent_list_ids": [
    "proident cupidatat labore officia eu"
  ],
  "query_dsl": "sint dolor",
  "query_version": "veniam et",
  "sample_updated_at": "nostrud esse",
  "status": {
    "error_message": "mollit ea reprehenderit ex",
    "query_validation": "aute minim do qui"
  },
  "updated_at": "sint ad occaecat"
}
{
  "errors": [
    {
      "field": "tempor fugiat irure aliquip aute",
      "message": "consequat incididunt"
    },
    {
      "field": "commodo culpa veniam consequat",
      "message": "amet exercitation id cupidatat qui"
    },
    {
      "field": "fugiat aliquip ullamco qui",
      "message": "aute nulla incididunt nisi velit"
    }
  ]
}
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": "in et",
      "message": "ut non Duis"
    },
    {
      "field": "commodo sint dolor proident",
      "message": "voluptate Duis aliqua laboris"
    },
    {
      "field": "ipsum consectetur do in dolor",
      "message": "commodo dolore minim"
    }
  ]
}
Query Parameter NameExample
parent_list_idsmagna voluptate nulla officia
no_parent_list_idtrue
Request Payload
Response Payload
{
  "_metadata": {
    "count": 90119369,
    "next": "http://AiWMPpTHVKTugmLzqMzqfMyNOwLOVgtIU.kheYJsaLE,o11D",
    "prev": "http://ymKWbSZuWZknaSphmUkc.lblXXn5om4G-x3sDkV5gzzyBXycp.HCYKe",
    "self": "https://db.ciQ5,5Y9svENVvBtJ,gTjUhp3ZyEjFM,be.ZkhG2KaJUTgL.4xDFKFpffuP7Y.WXVH,"
  },
  "contacts_count": -48258884,
  "created_at": "labore pariatur proident anim",
  "id": "71fed19e-de28-3d97-3fc8-f77ecfc42895",
  "name": "nisi pariatur deserunt ut",
  "next_sample_update": "occaecat esse sed non enim",
  "parent_list_ids": [
    "adipisicing",
    "irure",
    "incididunt sint adipisicing",
    "ea consectetur sunt voluptate",
    "nulla"
  ],
  "query_version": "magna eu",
  "sample_updated_at": "reprehenderit ex",
  "status": {
    "error_message": "qui",
    "query_validation": "reprehenderit sed fugiat et commodo"
  },
  "updated_at": "occaecat laborum non aute do"
}
{
  "errors": [
    {
      "field": "laborum sit pariatur dolore et",
      "message": "Excepteur pariatur adipisicing"
    },
    {
      "field": "eu dolor sunt reprehenderit pariatur",
      "message": "sint"
    },
    {
      "field": "eu dolore sit ut veniam",
      "message": "mollit dolore culpa"
    },
    {
      "field": "ad consequat",
      "message": "minim"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "exercitation laboris",
      "message": "ipsum dolor Excepteur eiusmod"
    },
    {
      "field": "officia Duis voluptate sunt ex",
      "message": "minim ipsum"
    },
    {
      "field": "dolore",
      "message": "ut irure voluptate aliqua"
    },
    {
      "field": "pariatur",
      "message": "incididunt ea dolore eiusmod"
    },
    {
      "field": "Excepteur sed dolor",
      "message": "fugiat consequat dolore culpa"
    }
  ]
}
Request Payload
{
  "name": "quis nostrud Ut",
  "query_dsl": "minim ut in"
}
Response Payload
{
  "contacts_count": 59496234,
  "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": "et elit",
  "id": "bccea1b3-f272-9ee9-b474-be15c7bf0949",
  "name": "occaecat voluptate in id dolore",
  "next_sample_update": "veniam enim ut commodo dolor",
  "parent_list_ids": [
    "Duis eiusmod qui velit",
    "id enim",
    "ullamco Duis ipsum",
    "anim",
    "Lorem voluptate"
  ],
  "query_dsl": "id minim",
  "query_version": "reprehenderit dolor ex",
  "sample_updated_at": "velit sed",
  "status": {
    "error_message": "do",
    "query_validation": "non est elit aute dolore"
  },
  "updated_at": "esse ea elit sed"
}
{
  "errors": [
    {
      "field": "pariatur exercitation quis ut",
      "message": "sint enim non magna consequat"
    },
    {
      "field": "laboris",
      "message": "ut commodo et"
    },
    {
      "field": "quis sed",
      "message": "magna"
    },
    {
      "field": "laboris velit reprehenderit ullamco",
      "message": "irure sint laborum fugiat"
    },
    {
      "field": "magna",
      "message": "eu esse amet do"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "adipisicing est",
      "message": "do"
    },
    {
      "field": "eu laborum minim",
      "message": "nisi sunt non Ut"
    },
    {
      "field": "sit ut nisi id dolore",
      "message": "fugiat consequat velit"
    }
  ]
}
Query Parameter NameExample
contacts_sampletrue
Request Payload
Response Payload
{
  "contacts_count": -79611148,
  "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": "tempor adipisicing",
  "id": "4352d117-58aa-5bb5-5bf4-0d4ce609d075",
  "name": "fugiat volu",
  "next_sample_update": "in ut sit aliquip incididunt",
  "parent_list_ids": [
    "ex fugiat labore",
    "qui nisi et consequat aliqua",
    "sunt commodo esse veniam irure",
    "ea irure Excepteur veniam",
    "incididunt"
  ],
  "query_dsl": "adipisicing qui irure",
  "query_version": "in nisi veniam ut minim",
  "sample_updated_at": "ullamco",
  "status": {
    "error_message": "occaecat eiusmod cupidatat sint",
    "query_validation": "do consectetur commodo elit fugiat"
  },
  "updated_at": "dolore commodo"
}
{
  "errors": [
    {
      "field": "voluptate",
      "message": "voluptate"
    },
    {
      "field": "fugiat",
      "message": "ut"
    },
    {
      "field": "in",
      "message": "deserunt incididunt id est et"
    },
    {
      "field": "in Lorem labore",
      "message": "ex est tempor qui non"
    },
    {
      "field": "sed dolor nisi",
      "message": "ullamco"
    }
  ]
}
{
  "errors": [
    {
      "field": "cupidatat sunt sint",
      "message": "ad non eiusmod nostrud laboris"
    },
    {
      "field": "dolor fugiat",
      "message": "voluptate ut"
    },
    {
      "field": "in",
      "message": "elit dolore incididunt velit"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "sed fugiat",
      "message": "consectetur pariatur"
    },
    {
      "field": "dolor",
      "message": "ut adipisicing"
    },
    {
      "field": "sit Excepteur fugiat sint Lorem",
      "message": "in ut exercitation reprehenderit"
    },
    {
      "field": "fugiat minim sit labore",
      "message": "occaecat dolore"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "do ipsum id exercitation",
      "message": "sint sed aliquip amet non"
    },
    {
      "field": "do ipsum",
      "message": "in irure"
    },
    {
      "field": "amet ex commodo",
      "message": "dolor pariatur ut esse id"
    }
  ]
}

Senders

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

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": "aute in",
      "field": "nostrud dolor Ut velit fugiat",
      "message": "in pariatur exercitation",
      "parameter": "officia ex velit"
    }
  ]
}
Query Parameter NameExample
page_size528.2868704920749
page_tokenvoluptate minim dolore adipisicing eu
Request Payload
Response Payload
{
  "result": [
    {
      "id": "abc12312-x3y4-1234-abcd-123qwe456rty",
      "name": "list-name",
      "contact_count": 0,
      "_metadata": {
        "self": "https://api.sendgrid.com/v3/marketing/lists/abc12312-x3y4-1234-abcd-123qwe456rty"
      }
    }
  ],
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/lists?page_size=100&page_token="
  }
}
Request Payload
Response Payload
{
  "contact_count": 0,
  "billable_count:": 0
}
{}
Query Parameter NameExample
contact_samplefalse
Request Payload
Response Payload
{
  "contact_count": 2,
  "contact_sample": {
    "id": "c3445f88-5c69-4237-86e6-9ec9de958050",
    "list_ids": [
      "199abb98-0af3-4a8d-b371-6811ff85d062"
    ],
    "created_at": "2620-06-16T17:03:54.867Z",
    "updated_at": "4780-12-06T06:51:30.024Z"
  },
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/lists/199abb98-0af3-4a8d-b371-6811ff85d062"
  },
  "id": "199abb98-0af3-4a8d-b371-6811ff85d062",
  "name": "list-name"
}
[
  {
    "error_id": "laborum eiusmod ea sed Excepteur",
    "field": "veniam laboris aliquip consectetur Lorem",
    "message": "nulla consequat quis adipisicing reprehenderit",
    "parameter": "occaecat ex"
  }
]
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": "sed Lorem",
      "field": "fugiat tempor sint pariatur proident",
      "message": "cillum ut nostrud laboris deserunt",
      "parameter": "laboris incididunt dolor"
    },
    {
      "error_id": "eu dolore dolor",
      "field": "proident Ut mollit Lorem",
      "message": "exercitation",
      "parameter": "Ut"
    },
    {
      "error_id": "qui aliqua aliquip nulla culpa",
      "field": "fugiat non aute",
      "message": "incididunt anim sit est",
      "parameter": "ipsum elit incididunt pariatur sint"
    },
    {
      "error_id": "veniam mollit dolore do",
      "field": "nostrud qui",
      "message": "minim ex laborum Lorem sint",
      "parameter": "exercitation sint Ut aliquip non"
    }
  ]
}
{}
Query Parameter NameExample
delete_contactsfalse
Request Payload
Response Payload
{
  "job_id": "abc12312-x3y4-1234-abcd-123qwe456rty"
}
nulla eiusmod quis id
{
  "errors": []
}
Query Parameter NameExample
contact_ids*in sit et cupidatat
Request Payload
Response Payload
{
  "job_id": "tempor nisi"
}
{
  "error_id": "Ut id laborum",
  "field": "nostrud ad consectetur",
  "message": "elit aliqua pariatur",
  "parameter": "Excepteur Ut cupidatat"
}
{
  "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": "occaecat in ut laboris",
      "field": "Ut commodo aute elit cillum",
      "message": "eiusmod ullamco sint",
      "parameter": "nulla non in"
    },
    {
      "error_id": "non",
      "field": "consectetur reprehenderit et",
      "message": "velit",
      "parameter": "do officia nostrud tempor"
    }
  ]
}
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": "occaecat tempor et velit sit",
      "field": "dolore",
      "message": "nisi",
      "parameter": "do"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "minim",
      "field": "aliqua aliquip nisi elit ut",
      "message": "in velit quis proident sunt",
      "parameter": "Lorem in amet irure"
    },
    {
      "error_id": "sit id",
      "field": "voluptate ut",
      "message": "veniam",
      "parameter": "laboris consectetur consequat dolor dolore"
    },
    {
      "error_id": "ex amet Ut do",
      "field": "do",
      "message": "occaecat ut nostrud",
      "parameter": "sit commodo officia dolor"
    },
    {
      "error_id": "et quis nulla Ut",
      "field": "dolor Ut sit ex",
      "message": "minim esse",
      "parameter": "sint proident voluptate dolor sunt"
    },
    {
      "error_id": "elit occaecat culpa ut reprehenderit",
      "field": "in fugiat",
      "message": "Duis proident fugiat",
      "parameter": "consectetur"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "dolore",
      "field": "dolore qui ut",
      "message": "ipsum",
      "parameter": "occaecat ullamco"
    },
    {
      "error_id": "do reprehenderit aliqua velit",
      "field": "aliqua",
      "message": "aute in in occaecat anim",
      "parameter": "quis aliquip minim"
    },
    {
      "error_id": "sit laborum nostrud non",
      "field": "proident",
      "message": "exercitation velit et",
      "parameter": "reprehenderit irure"
    },
    {
      "error_id": "ipsum",
      "field": "nostrud",
      "message": "enim id consectetur cillum",
      "parameter": "Excepteur"
    },
    {
      "error_id": "minim sunt cupidatat",
      "field": "Ut",
      "message": "aliqua dolore ullamco",
      "parameter": "cillum dolore laborum"
    }
  ]
}

segmenting contacts(5 operations)

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

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": "dolor consectetur in elit",
      "id": "nisi Ut elit labore irure",
      "resources": {
        "ids": [
          "voluptate dolore esse",
          "culpa fugiat ex Duis nostrud",
          "nulla velit cupidatat ex",
          "in id commodo culpa dolor",
          "in minim quis"
        ],
        "type": "dolor"
      }
    },
    {
      "error": "do Lorem nulla",
      "id": "consectetur cillum pariatur est",
      "resources": {
        "ids": [
          "eiusmod dolor in ut"
        ],
        "type": "in pariatur"
      }
    },
    {
      "error": "proident id",
      "id": "eiusmod veniam",
      "resources": {
        "ids": [
          "ut quis Duis amet",
          "labore nostrud ipsum est do",
          "veniam",
          "magna mollit do"
        ],
        "type": "officia cillum eiusmod"
      }
    }
  ]
}
{}
{
  "errors": [
    {
      "field": "in",
      "message": "proident in amet consequat"
    },
    {
      "field": "sunt voluptate dolore",
      "message": "enim Excepteur Lorem sunt"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "tempor Ut sed"
    },
    {
      "message": "sit dolore Lorem amet ut"
    }
  ]
}

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": "minim magna Excepteur mollit occaecat",
      "field": "ex voluptate nisi cupidatat",
      "message": "ut"
    },
    {
      "error_id": "in dolore ad est cupidatat",
      "field": "cillum consectetur dolore",
      "message": "laboris ut"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "reprehenderit in aute",
      "field": "deserunt eu dolore consequat in",
      "message": "laborum ipsum sit exercitation fugiat"
    }
  ]
}
Query Parameter NameExample
page_size-12808396
page_tokenaliquip eu do adipisicing
Request Payload
Response Payload
{
  "_metadata": {
    "count": 35149917,
    "next": "https://yyLLryzXTEUhlsMvFXxPWAozN.hvx2nDa",
    "prev": "http://SbQEhTcNmALSTbhO.qvvfX3unpjSAQyODY.ldwWnrs8iyLcZ,Dsf2Eg90gD",
    "self": "https://BUoReZSIHMSPgeWEmJWpLlXktgWgc.blakwWPA9Mwi4sVaHtzDUxdeoMITMLHv3.QoRkGGTnw,AsPjKp.7IaO"
  },
  "result": [
    {
      "abtest": null,
      "categories": [
        "aute",
        "incididunt",
        "velit ut culpa laborum",
        "est adipisicing",
        "eu velit Ut consectetur",
        "culpa laborum adipisicing elit ea",
        "enim aliqua nisi",
        "reprehenderit nisi",
        "ad cillum incididunt",
        "anim"
      ],
      "created_at": "1903-10-30T12:59:42.0Z",
      "id": "2cbfefd2-fbd2-1641-3c4e-f9cd54d568c4",
      "is_abtest": false,
      "name": "do cupidatat esse",
      "send_at": "1946-04-19T15:23:35.0Z",
      "status": "triggered",
      "updated_at": "1936-10-06T20:42:47.0Z"
    },
    {
      "abtest": {
        "duration": "laboris esse",
        "expiration_date": "tempor sit consectetur ad fugiat",
        "test_percentage": -52541519,
        "type": "subject",
        "winner_criteria": "manual",
        "winner_selected_at": null,
        "winning_template_id": "pariatur"
      },
      "categories": [
        "tempor voluptate",
        "irure",
        "occaecat quis",
        "eiusmod",
        "nostrud",
        "reprehenderit esse culpa laboris qui",
        "commodo consectetur ex incididunt",
        "ad",
        "et officia labore amet",
        "dolor"
      ],
      "created_at": "1904-01-14T03:01:51.0Z",
      "id": "cf9f46e3-3943-74c0-10c9-470c7860b137",
      "is_abtest": true,
      "name": "occaecat",
      "send_at": "1934-01-04T14:49:23.0Z",
      "status": "triggered",
      "updated_at": "1952-05-03T04:38:35.0Z"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ad",
      "field": "laboris",
      "message": "adipisicing"
    },
    {
      "error_id": "proident ut",
      "field": "consectetur commodo nulla",
      "message": "est aute nostrud pariatur"
    },
    {
      "error_id": "ut qui",
      "field": "eiusmod ea amet fugiat nisi",
      "message": "ea consequat quis"
    },
    {
      "error_id": "ipsum",
      "field": "aute dolor",
      "message": "est nisi qui"
    }
  ]
}
Query Parameter NameExample
ids["sunt","Duis ut id","laboris dolor mollit","in sed","magna qui sed aliquip ea","in","ullamco sit in mollit ex","in anim irure","id labore","non aliqua sunt eiusmod"]
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "dolor ut sit sint est",
      "field": "Lorem id",
      "message": "dolor nisi"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "proident sunt",
      "field": "non aliqua ut elit officia",
      "message": "culpa"
    }
  ]
}
Request Payload
{
  "name": "dolor in dolore nostrud"
}
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",
      "field": "ut do elit enim nulla",
      "message": "in in ex"
    },
    {
      "error_id": "deserunt ut sit do",
      "field": "sit anim exercitation qui",
      "message": "dolor Duis occaecat"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "est in sint ea in",
      "field": "dolore sed incididunt",
      "message": "nulla fugiat voluptate eiusmod"
    },
    {
      "error_id": "do aliqua aliquip eu mollit",
      "field": "eiusmod est ipsum",
      "message": "ea"
    },
    {
      "error_id": "consequat mollit adipisicing dolore",
      "field": "voluptate ut",
      "message": "sunt sint occaecat laboris"
    }
  ]
}
Request Payload
{
  "categories": [
    "ut quis adipisicing Lorem consequat",
    "veniam",
    "in ullamco Duis culpa",
    "cillum ipsum",
    "anim non tempor",
    "labore Ut proident culpa",
    "qui eu",
    "sunt esse adipisicing dolor nisi",
    "nostrud deserunt voluptate",
    "ea ex esse dolor"
  ],
  "email_config": {
    "custom_unsubscribe_url": "https://zXkXHTLw.orpwN5+DaoqML7ylVZiJo6oiLIEJnwiGg+3xyUy-xh2f5zps8Vlh9gNpLs7nqucAmN,Ee",
    "design_id": "in nisi elit",
    "editor": "code",
    "generate_plain_content": true,
    "html_content": "id Excepteur",
    "ip_pool": "dolore aliquip proident eiusmod",
    "plain_content": "Lorem enim sint nisi et",
    "sender_id": null,
    "subject": "eiusmod ad aliquip",
    "suppression_group_id": null
  },
  "name": "culpa occaecat",
  "send_at": "1936-08-15T02:53:50.0Z",
  "send_to": {
    "all": true,
    "list_ids": [
      "922d8fbc-879f-bcdb-8303-53747a899f0d",
      "63587743-4b79-ec05-8473-806f75d5b6c0",
      "71092772-0599-51d8-4fa1-cf470a664d94",
      "ded1e818-9493-fa01-3000-b522f24374db",
      "1f462162-e84a-21a3-f360-a84c65c73842",
      "27f853c7-d884-1e5a-f8ff-65788c0d915b",
      "f16c7d61-147f-e591-2015-6094c0f2cde9",
      "962b3f5d-33a1-b2e7-87d4-07f4aeef0e6d",
      "9965cee9-aa63-2fad-4151-3bac672b39e7",
      "e1c8264f-b475-55e3-e432-cc8db809c5fc"
    ],
    "segment_ids": [
      "56be06de-593a-29bb-f8ff-760d1257b297",
      "66d36709-2a0b-fc49-d1da-9f575d6b64c0",
      "4b70672f-95ce-34cf-dde3-f928f2fa7b07",
      "26706796-95b5-c4c7-14e5-4ea60795bee8",
      "c5992d22-ec6a-84af-0e88-03a0b72d5f51",
      "89feddf6-5f03-a76d-a5eb-a43f68ea38f7",
      "b3ac7378-80d8-3b7c-8f79-72895921cda7",
      "9825059e-6400-f828-25d0-7e13a1198118",
      "03bb61ee-89f8-d1f8-0c30-29d43931fcac",
      "84b0cfe9-7b80-37a9-8949-e2bb8c83f954"
    ]
  }
}
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": "enim",
      "field": "fugiat culpa",
      "message": "ea elit mollit officia"
    },
    {
      "error_id": "in elit ea et",
      "field": "officia amet tempor reprehenderit",
      "message": "officia in eu irure sit"
    },
    {
      "error_id": "eu",
      "field": "irure consequat culpa ipsum aliqua",
      "message": "ad Ut minim id ex"
    },
    {
      "error_id": "non incididunt",
      "field": "laborum",
      "message": "ad nisi consectetur veniam sint"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "Ut",
      "field": "exercitation eiusmod",
      "message": "proident"
    },
    {
      "error_id": "dolor velit",
      "field": "magna est ut Duis",
      "message": "anim"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "deserunt eiusmod tempor",
      "field": "exercitation dolor aliqua ex cupidatat",
      "message": "ipsum"
    }
  ]
}
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": "magna",
      "field": "pariatur occaecat ut",
      "message": "ut ex Duis quis minim"
    },
    {
      "error_id": "tempor in proident aute",
      "field": "tempor",
      "message": "incididunt"
    },
    {
      "error_id": "reprehenderit fugiat consectetur ea",
      "field": "exercitation aliquip pariatur",
      "message": "do id Lorem consequat tempor"
    },
    {
      "error_id": "amet et",
      "field": "in proident exercitation ullamco",
      "message": "amet magna Duis veniam non"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "commodo sed",
      "field": "Lorem reprehenderit",
      "message": "nisi pariatur ex"
    },
    {
      "error_id": "incididunt",
      "field": "velit nisi incididunt ut pariatur",
      "message": "quis"
    },
    {
      "error_id": "dolore anim",
      "field": "fugiat commodo in",
      "message": "laboris culpa commodo sint"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "laborum dolore occaecat voluptate",
      "field": "aliqua",
      "message": "consequat ad et"
    },
    {
      "error_id": "laborum",
      "field": "eiusmod ex ut mollit sunt",
      "message": "et cupidatat pariatur commodo mollit"
    },
    {
      "error_id": "ad ex Lorem adipisicing aliqua",
      "field": "aute",
      "message": "magna fugiat Duis"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "non Ut dolore sed fugiat",
      "field": "magna",
      "message": "minim velit nisi exercitation"
    },
    {
      "error_id": "in",
      "field": "aliqua Duis",
      "message": "laboris"
    },
    {
      "error_id": "Excepteur mollit",
      "field": "nisi consequat",
      "message": "dolor in dolore labore ex"
    }
  ]
}
Query Parameter NameExample
page_size-3176759
page_tokenpariatur nulla sed magna exercitation
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": "qui",
      "field": "dolor in ad in incididunt",
      "message": "labore anim nisi quis"
    },
    {
      "error_id": "occaecat ut ea mollit",
      "field": "ex tempor",
      "message": "laborum Ut culpa"
    },
    {
      "error_id": "nulla magna sit Excepteur",
      "field": "dolore quis et cillum",
      "message": "irure nostrud est ullamco tempor"
    },
    {
      "error_id": "voluptate incididunt eu do",
      "field": "in adipisicing Ut eu commodo",
      "message": "adipisicing et"
    }
  ]
}
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": "exercitation",
      "field": "cupidatat esse proident incididunt cillum",
      "message": "ut dolore sunt"
    },
    {
      "error_id": "dolore cupidatat veniam",
      "field": "laboris esse mollit ex aliquip",
      "message": "culpa mollit"
    },
    {
      "error_id": "laboris eu consequat",
      "field": "id laborum esse",
      "message": "aute dolor incididunt"
    },
    {
      "error_id": "non ut voluptate",
      "field": "dolor labore laboris magna ad",
      "message": "sit sunt do laboris"
    },
    {
      "error_id": "minim",
      "field": "in ad dolor",
      "message": "in aliquip ut commodo minim"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "non laboris minim Ut eu",
      "field": "sunt",
      "message": "sit ipsum"
    }
  ]
}
Request Payload
Response Payload
{
  "send_at": "1902-06-06T08:13:13.0Z",
  "status": "draft"
}
{
  "errors": [
    {
      "error_id": "voluptate velit",
      "field": "aliqua ut",
      "message": "ullamco sed sint nostrud"
    },
    {
      "error_id": "dolor laboris aliqua enim",
      "field": "deserunt",
      "message": "consequat"
    },
    {
      "error_id": "et laboris labore",
      "field": "Ut",
      "message": "dolore"
    },
    {
      "error_id": "velit aliquip",
      "field": "ut reprehenderit",
      "message": "ipsum nostrud incididunt esse"
    },
    {
      "error_id": "consequat velit minim ipsum",
      "field": "incididunt mollit eu in",
      "message": "ut exercitation incididunt"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "aute do",
      "field": "exercitation ut ut",
      "message": "enim aute nisi"
    }
  ]
}
Request Payload
Response Payload
{
  "categories": [
    "equipment",
    "shoes",
    "sports"
  ]
}
{
  "errors": [
    {
      "error_id": "nulla",
      "field": "consectetur in aliquip",
      "message": "laborum mollit nisi minim"
    }
  ]
}

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["laborum amet labore","laboris cillum mollit est Ut","Excepteur consectetur commodo dolore dolore","in mollit ipsum eu","non ad Lorem proident voluptate","exercitation mollit minim","cupidatat","velit Duis dolor aliqua sed","ea quis nostrud","voluptate est magna"]
page_size67
page_tokenet irure enim esse mollit
Request Payload
Response Payload
{
  "_metadata": {
    "count": -77807008.02622151,
    "next": "https://DGWpbzLehHe.jiuqlOnM4N9q8",
    "prev": "https://zdrRnlguEMQe.fnzA,TH4CT1RUACopN0v..2kU",
    "self": "https://ZznJUgcUjWBVayTiOnbIC.acwv.5aoJyaZ,Bu1BraN,pHOAYl7OEjAGqlxb,vmsX"
  },
  "results": [
    {
      "aggregation": "occaecat Excepteur",
      "id": "737e2554-5dcf-c4a8-9a83-f07f620ab4f9",
      "stats": {
        "bounce_drops": 42611466,
        "bounces": 30676298,
        "clicks": 57251402,
        "delivered": 24329375,
        "invalid_emails": -59437409,
        "opens": 62739074,
        "requests": 80051757,
        "spam_report_drops": 69683217,
        "spam_reports": -26470032,
        "unique_clicks": 68792591,
        "unique_opens": -27091578,
        "unsubscribes": -63637479
      },
      "step_id": "veniam in sint Duis"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
group_by["step_id"]
step_ids["62e5053c-8ccd-131c-fc15-bd0c4981e876","c558226a-a846-62d7-6ee0-c888cbf00c29","cd6ddf5f-fb3e-654e-fbba-de9937131213","1ac8731e-3e02-6a46-57cf-43c34719e388","3a08227c-458c-4d22-b0ea-3bc12379994d"]
aggregated_bytotal
start_date1940-09-12
end_date1917-12-26
timezonequi labore nostrud eu
page_size52
page_tokendeserunt Excepteur cillum
Request Payload
Response Payload
{
  "_metadata": {
    "count": -52516753.311270304,
    "next": "http://GtyYaKOOUNvIYxtSWlBnYHjpTie.kwoF",
    "prev": "http://DqojyinmeGMOBk.dhjwL8vPYc4TOvoBGppjngBLUkD8ool4fiCebfBjujjMh1sQRGJjQnPAaYBmv",
    "self": "https://QGYXzufyQYc.qoqlZT9Nuccu5I8ZzwYhhItRVAoL"
  },
  "results": [
    {
      "aggregation": "laboris",
      "id": "f06caf37-2342-ae03-c685-884f0c56054f",
      "stats": {
        "bounce_drops": -11420729,
        "bounces": 97012981,
        "clicks": -25700121,
        "delivered": -24506289,
        "invalid_emails": 68946026,
        "opens": -34576704,
        "requests": 20464804,
        "spam_report_drops": -7516033,
        "spam_reports": 77165915,
        "unique_clicks": -53533371,
        "unique_opens": -97882418,
        "unsubscribes": 76039311
      },
      "step_id": "occaecat in"
    },
    {
      "aggregation": "anim sed voluptate",
      "id": "b85367ee-d16a-cf7d-4204-318c80143a7e",
      "stats": {
        "bounce_drops": -98849292,
        "bounces": -58815380,
        "clicks": -4588477,
        "delivered": -48351597,
        "invalid_emails": 96083517,
        "opens": -98881514,
        "requests": -31041845,
        "spam_report_drops": 55902115,
        "spam_reports": -21075750,
        "unique_clicks": -32216121,
        "unique_opens": -83017728,
        "unsubscribes": -2452511
      },
      "step_id": "culpa eu voluptate nulla mollit"
    },
    {
      "aggregation": "exercitation culpa",
      "id": "179a9e46-fb4e-ded0-174d-6ab829cd5d0b",
      "stats": {
        "bounce_drops": -22316815,
        "bounces": -65278564,
        "clicks": -28098057,
        "delivered": 82842961,
        "invalid_emails": 37063935,
        "opens": -26030,
        "requests": 54298212,
        "spam_report_drops": -47040368,
        "spam_reports": 84129630,
        "unique_clicks": 67226494,
        "unique_opens": 25924030,
        "unsubscribes": -29073353
      },
      "step_id": "veniam magna commodo enim"
    },
    {
      "aggregation": "in Ut ipsum",
      "id": "d299d00b-5210-3d07-9629-4e20c8d073e5",
      "stats": {
        "bounce_drops": -43229634,
        "bounces": -14112465,
        "clicks": 61662243,
        "delivered": 31846048,
        "invalid_emails": 82093396,
        "opens": 97484774,
        "requests": -38310496,
        "spam_report_drops": 59794820,
        "spam_reports": 57447894,
        "unique_clicks": 96583987,
        "unique_opens": -27936711,
        "unsubscribes": -60685883
      },
      "step_id": "sed dolore minim"
    }
  ]
}
{
  "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["dolore magna","veniam voluptate","dolor cillum cupidatat ipsum nostrud","incididunt quis velit elit","fugiat cillum","occaecat anim Excepteur","ut et","laborum culpa","consectetur dolor","Duis"]
page_size97
page_tokenirure id laborum
Request Payload
Response Payload
{
  "_metadata": {
    "count": 56605732.24526709,
    "next": "http://CeMhCnVrntIbyZGwoO.yluQTYA9DJeN+gwO,DZZQ4ZCvZajVcfoVp",
    "prev": "http://BlmLogClbvMyMVDKmcA.fhawhgNiolkDbsNvVwfJtHTMF35GVGAbxSvTbC",
    "self": "https://IO.zzn,tNXdNUDRKAm947G.leLCTugekMs9dKo,mCb6Usw,FyNC,TjOHed8z0-RmABJF9ot3St.+tCl4mS6aigd"
  },
  "results": [
    {
      "ab_phase": "all",
      "ab_variation": "966274cf-183d-b1d9-9c5e-e113dcdde0c3",
      "aggregation": "dolore",
      "id": "e5ff0d5d-ddae-f8e4-3ac8-17c4b97e83a7",
      "stats": {
        "bounce_drops": -83648976,
        "bounces": -70690162,
        "clicks": -85068175,
        "delivered": -52369880,
        "invalid_emails": 96684786,
        "opens": -23450240,
        "requests": 75753176,
        "spam_report_drops": -50019580,
        "spam_reports": -52054694,
        "unique_clicks": 76821992,
        "unique_opens": 6930407,
        "unsubscribes": 11008713
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "45047591-38b6-8846-4001-9dec5f92bba8",
      "aggregation": "cillum cupidatat laboris ullamco irure",
      "id": "ee5131ff-d9ef-a5c8-477c-66c78154eee1",
      "stats": {
        "bounce_drops": 66479181,
        "bounces": -82854224,
        "clicks": 72929290,
        "delivered": 37085748,
        "invalid_emails": -95965039,
        "opens": 14418226,
        "requests": 11731913,
        "spam_report_drops": -33166521,
        "spam_reports": 96309928,
        "unique_clicks": 40463665,
        "unique_opens": -85694973,
        "unsubscribes": 30230738
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "49d52011-2c87-0ffd-0290-77bff82023ae",
      "aggregation": "cupidatat ex anim aute",
      "id": "299b9373-a88d-3b93-c346-bb5797120df6",
      "stats": {
        "bounce_drops": -8432779,
        "bounces": 15331430,
        "clicks": 29588086,
        "delivered": 52329277,
        "invalid_emails": 86599196,
        "opens": -4259149,
        "requests": -94565664,
        "spam_report_drops": 78508821,
        "spam_reports": -91451099,
        "unique_clicks": -6018434,
        "unique_opens": -22338580,
        "unsubscribes": 38995425
      }
    },
    {
      "ab_phase": "send",
      "ab_variation": "eef1594f-f3b6-aad4-4011-b382965f9705",
      "aggregation": "laborum id ex",
      "id": "2fc3364e-029b-d156-5ce3-5f918186400e",
      "stats": {
        "bounce_drops": -89285954,
        "bounces": -47173784,
        "clicks": 14814707,
        "delivered": 69188286,
        "invalid_emails": 883646,
        "opens": -22230405,
        "requests": 85956814,
        "spam_report_drops": -31330470,
        "spam_reports": 96659333,
        "unique_clicks": -78137143,
        "unique_opens": -22402847,
        "unsubscribes": -2384686
      }
    },
    {
      "ab_phase": "send",
      "ab_variation": "c8280b21-318c-050f-25f0-6aa03eabba62",
      "aggregation": "mollit ea esse",
      "id": "3c58be63-78ce-4404-abd4-5f53eb955832",
      "stats": {
        "bounce_drops": 79684614,
        "bounces": 47706155,
        "clicks": -68474545,
        "delivered": -22213555,
        "invalid_emails": 21993467,
        "opens": 42538268,
        "requests": -1666872,
        "spam_report_drops": 37381611,
        "spam_reports": -70581223,
        "unique_clicks": -22746375,
        "unique_opens": 57947125,
        "unsubscribes": -32249189
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
aggregated_byday
start_date1930-04-26
end_date1918-11-05
timezonealiquip cupidatat
page_size46
page_tokenlabore
group_by["ab_phase","ab_variation","ab_variation"]
Request Payload
Response Payload
{
  "_metadata": {
    "count": -39762290.93971999,
    "next": "http://XSaWBjmRjIWs.qjqhK+IHJcoqzMCZFzUyz7cS66LAjYP5gkYyQpdDP26cF4RY5+H1Yir4q0",
    "prev": "http://CfnrQvZGxIuXILtVUhr.cquBFz1.0BSdFy6wMXPJY",
    "self": "https://xMtFUUaFJseVEFOqaYph.nxq4,hKs74FpIWhPUCkUJ6L4xyFqlQgPpu9UV"
  },
  "results": [
    {
      "ab_phase": "test",
      "ab_variation": "e7c4ba78-ebe1-f699-cfb2-b8d9a862bfac",
      "aggregation": "magna exercitation",
      "id": "cdf18f73-f28e-09bb-6538-9f587b60a254",
      "stats": {
        "bounce_drops": 78322593,
        "bounces": -49101503,
        "clicks": -24626976,
        "delivered": -68298244,
        "invalid_emails": -91495961,
        "opens": -99775717,
        "requests": 63989588,
        "spam_report_drops": 54580834,
        "spam_reports": -60705825,
        "unique_clicks": 20553575,
        "unique_opens": -59907065,
        "unsubscribes": 71062171
      }
    },
    {
      "ab_phase": "send",
      "ab_variation": "ce61e32b-b7d3-c0b8-1b73-9ffea5e6214a",
      "aggregation": "adipisicing cillum",
      "id": "a099bcae-4bd6-21c3-bd09-092197d0088b",
      "stats": {
        "bounce_drops": -98748013,
        "bounces": -71226407,
        "clicks": -84280797,
        "delivered": -87838573,
        "invalid_emails": -19966710,
        "opens": -405572,
        "requests": 34362285,
        "spam_report_drops": 81905228,
        "spam_reports": -26108858,
        "unique_clicks": -65100966,
        "unique_opens": -66683952,
        "unsubscribes": -75924299
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "4c7e03bd-ed36-1edc-46fe-0cbcca8dfb2c",
      "aggregation": "nostrud non",
      "id": "47a322d4-a751-cee7-a470-1e48c8fd1453",
      "stats": {
        "bounce_drops": 23135633,
        "bounces": -49538702,
        "clicks": 7656868,
        "delivered": -85248546,
        "invalid_emails": -32466011,
        "opens": 16948886,
        "requests": -83045940,
        "spam_report_drops": -93784344,
        "spam_reports": 29461949,
        "unique_clicks": 17699247,
        "unique_opens": 97077318,
        "unsubscribes": 55476634
      }
    },
    {
      "ab_phase": "all",
      "ab_variation": "3a050e11-8d7d-23a0-3a6d-f75c510bf335",
      "aggregation": "consequat",
      "id": "6ed54956-ee67-8511-3339-9c7fddeb8bb1",
      "stats": {
        "bounce_drops": 85870054,
        "bounces": -88359837,
        "clicks": 59526210,
        "delivered": -74525336,
        "invalid_emails": 91959527,
        "opens": -22189457,
        "requests": -71885331,
        "spam_report_drops": 12455387,
        "spam_reports": 29640056,
        "unique_clicks": -65091514,
        "unique_opens": 48530131,
        "unsubscribes": -94250785
      }
    }
  ]
}
{
  "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_ids["67c32518-e2f1-53ad-b77a-235b7812dd66","07d2f0da-14e2-25c0-4d9b-c2bfb0abf977"]
page_size53
page_tokenesse Ut in
Request Payload
Response Payload
{
  "_metadata": {
    "count": 17919491.566518575,
    "next": "https://IbHnHMrC.dedmxdCvO",
    "prev": "http://EJvJjDOxUx.dtawn-hyojZyH9g+YqQevL0",
    "self": "http://QPjMQSsZLCCgosjzyoXNB.jyMOcn,FIVSbvk7CDVbid5.QQHBkqTdNB"
  },
  "results": [
    {
      "clicks": 66210355,
      "step_id": "20c90c20-761c-a01c-12b5-4515e8455e7f",
      "url": "https://EAwVPVeTJMgVXkqbXkHJsmQGSxv.wbKRH4il-hqSAqDiQuFnfGJrMoLCfNGWo-7Wy51Tunw",
      "url_location": 34569806
    },
    {
      "clicks": 24820915,
      "step_id": "077c9007-d56e-45aa-db69-a9b1fe9b6100",
      "url": "https://LKHReMRsNKJnvgEsfiVkfxHiYLFNoRhh.jcgeLPHbj9pr1AtG9yhE.nswhr3+c",
      "url_location": 59935946
    },
    {
      "clicks": 34296399,
      "step_id": "b7e5703c-1d1a-16fc-40c7-0c04cf3a2465",
      "url": "http://mEeKlKBfSzlswMALNfMffMuKBUetrr.jvmLb97kbOYk1+wrzcpyjEhjn4sLdq.KatzxwPdZVBpj-B9wyva",
      "url_location": 74972535
    },
    {
      "clicks": 39267786,
      "step_id": "26fd0b6d-dd57-6dea-c626-b7cf039e961e",
      "url": "http://gnsQ.vzlUTHz0mqLb0nXsSZMgcFlGAGMzXkQg8LJtVe7rF3q1oNrqMizN3Il4I",
      "url_location": 30669925
    },
    {
      "clicks": 65042821,
      "step_id": "3cba88c0-bda2-977c-3b4b-5811940180c5",
      "url": "https://xBCvbDfeEk.drZgdDQhnvU4Dx0xtECu080diwrZlIPg5GclZ65gwUB-uHgnWvwfTdGgpPUNah4PUsOn",
      "url_location": 64858450
    }
  ],
  "total_clicks": -60086041
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
page_size64
page_tokennon ipsum esse velit
group_by["ab_phase","ab_variation"]
ab_variation_idf8008572-ef67-52cd-9602-5ec70b2568e5
ab_phase_idtest
Request Payload
Response Payload
{
  "_metadata": {
    "count": 12269059.131078303,
    "next": "http://KnbGHYKZEzibmZwgUqkGzyWHSqET.ltspYdIJ3FO77E.vBD,QG0ubiBHQDnrqldAfRvFYS9LhohqkB",
    "prev": "https://bAbllpFxORPxim.xuxC7UpEKDmlJl,ETVt,iKBvEoD3GNErMY5p.1.Kx",
    "self": "https://wUO.xynpM.yArile5,3iz1drGavrtYMBdpYDOtTlRzl9BnqKjNzajTwY"
  },
  "results": [
    {
      "ab_phase": "send",
      "ab_variation": "85b34c46-0768-46e1-756e-71663bcd98ce",
      "clicks": 97136474,
      "url": "http://Tgnra.dvbgSVabP3fhj1cQWU7jhrTQirtYbKmF",
      "url_location": 53049396
    },
    {
      "ab_phase": "send",
      "ab_variation": "d7b8f856-6f39-24f2-ea30-d2b316a3eb89",
      "clicks": 14678046,
      "url": "https://EbfTnxmJKTfYId.okfa9Y9qePMJYe.jUtcq.5GnPR.MaeDdRgE6nLRTPRwVGq-BcrZefReSfRegu-m0Rpw-TVERlmfZ",
      "url_location": 95951899
    },
    {
      "ab_phase": "all",
      "ab_variation": "439d9ef1-92ef-085e-2150-8311e75f7d40",
      "clicks": 60757117,
      "url": "http://kjmOKT.tttet59e9CUAjhIYonej4seqLHrVsicNB2KmMxI-YoEVxSrLDQewX5tIjwHHL",
      "url_location": 53278024
    },
    {
      "ab_phase": "send",
      "ab_variation": "9032544e-1d23-909f-3ce2-b5f3532a0640",
      "clicks": 47047108,
      "url": "http://DVXRE.rlnZK5FeFmtT1N.6BwI9d",
      "url_location": 78975178
    },
    {
      "ab_phase": "send",
      "ab_variation": "16c2957d-0709-a752-6f55-3d418449cf19",
      "clicks": 32499025,
      "url": "https://HgjSIxtUtFjjNBOEbMqzHGX.heqK9vIDRF-pyxKj11UNoYOcqEqY1nmxxgz-7yaX,HsaxCMR+j5IvG4saQXDy33",
      "url_location": 64160504
    }
  ],
  "total_clicks": -59435841
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
Query Parameter NameExample
ids["elit","irure adipisicing elit eu","esse culpa","velit occaecat","est velit in cupidatat","magna nostrud ut in","ex","tempor labore Ut","Duis sint do","ad labore laboris"]
timezoneproident in
Request Payload
Response Payload
nisi ex
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
ids["eu consequat qui aliqua","qui","laborum","ad elit","dolore","amet nostrud id ullamco","deserunt in culpa","dolor","cupidatat occaecat et Lorem deserunt","Duis sit"]
timezoneminim deserunt esse eiusmod
Request Payload
Response Payload
in dolor
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Sender Identities API(6 operations)

Header NameExample
on-behalf-of"ullamco"
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"nisi laborum"
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"aliqua in non pariatur"
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"irure qui Excepteur minim"
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"sunt"
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"quis"
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"incididunt nulla"
Request Payload
{
  "name": "your list name"
}
Response Payload
{
  "id": 1,
  "name": "your list name",
  "recipient_count": 0
}
{
  "errors": [
    {
      "field": null,
      "message": "Returned if request body is invalid JSON"
    },
    {
      "field": "name",
      "message": "Returned if list name is not a string"
    },
    {
      "field": "name",
      "message": "Returned if list name is a duplicate of an existing list or segment"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"in"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1,
      "name": "the jones",
      "recipient_count": 1
    }
  ]
}
Header NameExample
on-behalf-of"Excepteur"
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_id-71997225
Header NameExample
on-behalf-of"labore velit esse tempor"
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*-84813433
Header NameExample
on-behalf-of"sed ut ea aliqua"
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"occaecat"
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
page42077667
page_size-87044588
list_id*-13880377
Header NameExample
on-behalf-of"labore"
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"Duis"
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"cillum nisi"
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*71844267
recipient_id*8321782
Header NameExample
on-behalf-of"in deserunt id cupidatat"
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"esse commodo minim"
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"qui in veniam"
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"consequat in deserunt"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
{}
{
  "errors": [
    {
      "message": "No recipient ids provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
page-40769135
page_size-4687507
Header NameExample
on-behalf-of"Excepteur"
Request Payload
Response Payload
{
  "recipients": []
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"aliquip Excepteur in"
Request Payload
Response Payload
{
  "status": [
    {
      "id": "worker_delay",
      "value": "delayed"
    },
    {
      "id": "worker_delay_seconds",
      "value": "75.0"
    }
  ]
}
Header NameExample
on-behalf-of"et"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": -42506272.28175326,
      "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": "IRa6YnQ-z@fdzDtywPxe.oupk",
      "first_name": null,
      "id": "commodo minim",
      "last_clicked": 22247578.11926441,
      "last_emailed": 7596875.116375834,
      "last_name": null,
      "last_opened": 53421602.0706504,
      "updated_at": 97749878.54618934
    },
    {
      "created_at": 58408957.01909363,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "FDJDXjXIfdxQOzb@yqYCAlHJdcTjCvXFdoJKlzPGcymxIVnN.ynp",
      "first_name": "irure sint id in velit",
      "id": "eiusmod",
      "last_clicked": 79298762.33153418,
      "last_emailed": null,
      "last_name": null,
      "last_opened": null,
      "updated_at": -98739668.12379478
    },
    {
      "created_at": -78039432.77844554,
      "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": "Q21f09V5rdEZpJz@tJILzdiRWPsTkP.fv",
      "first_name": null,
      "id": "quis incididunt in veniam",
      "last_clicked": null,
      "last_emailed": 31171012.518585518,
      "last_name": "pariatur consequat elit ad",
      "last_opened": -75106384.4334853,
      "updated_at": 89715522.23822898
    },
    {
      "created_at": -19326030.00654888,
      "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": "xgac446QqCb@eAgBGa.jdy",
      "first_name": null,
      "id": "culpa eiusmod amet veniam ut",
      "last_clicked": -29873134.54636,
      "last_emailed": 47614498.46551579,
      "last_name": null,
      "last_opened": null,
      "updated_at": 14888829.452972844
    },
    {
      "created_at": 7549108.354531109,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "pBg@wHdTUuXhasruBOXce.td",
      "first_name": "culpa exercitation occaecat",
      "id": "tempor aliquip",
      "last_clicked": null,
      "last_emailed": 25564990.2265303,
      "last_name": null,
      "last_opened": 11418372.22799027,
      "updated_at": -75320923.22772281
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"eiusmod proident"
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"laborum"
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"dolore Excepteur aute"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"ex ut pariatur"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
{field_name}Excepteur exercitation pariatur veniam
Header NameExample
on-behalf-of"ipsum dolor exercitation anim non"
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"aute"
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"elit"
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"consequat proident consectetur deserunt Duis"
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"in"
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"in aliquip dolor enim"
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"pariatur"
Request Payload
{
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    },
    {
      "field": "last_clicked",
      "value": "01/02/2015",
      "operator": "gt",
      "and_or": "and"
    },
    {
      "field": "clicks.campaign_identifier",
      "value": "513",
      "operator": "eq",
      "and_or": "or"
    }
  ]
}
Response Payload
{
  "id": 1,
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    },
    {
      "field": "last_clicked",
      "value": "01/02/2015",
      "operator": "gt",
      "and_or": "and"
    },
    {
      "field": "clicks.campaign_identifier",
      "value": "513",
      "operator": "eq",
      "and_or": "or"
    }
  ],
  "recipient_count": 0
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"commodo in voluptate aute enim"
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*-43498773
Header NameExample
on-behalf-of"exercitation id elit fugiat culpa"
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_idculpa aliqua
Header NameExample
on-behalf-of"consequat adipisicing culpa amet fugiat"
Request Payload
{
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ]
}
Response Payload
{
  "id": 5,
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ],
  "recipient_count": 1
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "segment_id": "segment_id",
      "message": "segment id is not valid"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
delete_contactstrue
Header NameExample
on-behalf-of"consequat sunt culpa ut"
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
page64873644
page_size-65192289
Header NameExample
on-behalf-of"Duis pariatur tempor"
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
limit3524740
categoryamet Excepteur ut
offset-72114632
Header NameExample
on-behalf-of"reprehenderit minim do aute consequat"
Request Payload
Response Payload
[
  {
    "category": "category 1"
  },
  {
    "category": "category 2"
  }
]
{
  "errors": [
    {
      "field": "sort_by",
      "message": "invalid sort value"
    }
  ]
}
Query Parameter NameExample
sort_by_metricLorem
sort_by_directionasc
start_date*eiusmod sed qui sunt
end_dateLorem aliqua
limit-57705567
offset23735335
aggregated_byweek
Header NameExample
on-behalf-of"pariatur voluptate"
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*nostrud consequat cupidatat
end_datecupidatat anim ex
categories*sint consequat eiusmod
limit-39753879
offset25167763
aggregated_byweek
Header NameExample
on-behalf-of"exercitation Duis in consequat dolore"
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"dolor officia veniam irure"
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
limit46893285
offset88611062
Header NameExample
on-behalf-of"velit Ut veniam"
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"proident"
Request Payload
Response Payload
{
  "categories": [
    "spring line"
  ],
  "custom_unsubscribe_url": "",
  "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
  "id": 986724,
  "ip_pool": "marketing",
  "list_ids": [
    110
  ],
  "plain_content": "Check out our spring line!",
  "segment_ids": [
    110
  ],
  "sender_id": 124451,
  "status": "Draft",
  "subject": "New Products for Spring!",
  "suppression_group_id": 42,
  "title": "March Newsletter"
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"pariatur qui"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"ullamco pariatur"
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"incididunt irure nisi qui nulla"
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"eiusmod labore qui dolore ut"
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"reprehenderit aliquip sit cillum veniam"
Request Payload
{
  "send_at": 1489451436
}
Response Payload
{
  "id": 35970931,
  "send_at": 34691039,
  "status": "ut eu"
}
{
  "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"elit labore"
Request Payload
Response Payload
{
  "send_at": 1490778528
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"eiusmod cillum in Duis aliquip"
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"velit cupidatat officia eu"
Request Payload
{
  "to": "your.email@example.com"
}
Response Payload
{
  "to": "dolore"
}
{
  "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"consequat sed cupidatat dolore eu"
Request Payload
{
  "name": "example_name",
  "generation": "dynamic"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "example_name",
  "generation": "legacy",
  "versions": []
}
Query Parameter NameExample
generationsdynamic
page_size*7.091460100370431
page_tokenvoluptate
Header NameExample
on-behalf-of"ut quis reprehenderit"
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": [
    {
      "": "eiusmod esse aliqua",
      "error_id": "ipsum tempor",
      "message": "proident"
    },
    {
      "": "ea Lorem exercitation Excepteur",
      "error_id": "mollit sed",
      "message": "ut"
    },
    {
      "": "ex et cillum id nulla",
      "error_id": "officia cupidatat",
      "message": "et"
    },
    {
      "": "non in sint",
      "error_id": "dolore enim sed",
      "message": "ut est et"
    },
    {
      "": "laboris Excepteur consectetur",
      "error_id": "enim proident ut",
      "message": "laborum dolor magna in ut"
    }
  ]
}
Header NameExample
on-behalf-of"proident labore do"
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"quis sit eu"
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"in labore consectetur laboris enim"
Request Payload
{
  "name": "new_example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "new_example_name",
  "versions": []
}
Header NameExample
on-behalf-of"sed"
Request Payload
Response Payload
{}

Transactional Templates Versions(5 operations)

Header NameExample
on-behalf-of"Lorem exercitation nisi enim Duis"
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"nisi"
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"labore occaecat"
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"officia dolor sed irure"
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"dolor id ut veniam"
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"dolore adipisicing qui aliquip tempor"
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"Ut anim amet aute"
Request Payload
{
  "enabled": false,
  "url": "id aliqua",
  "group_resubscribe": true,
  "delivered": false,
  "group_unsubscribe": true,
  "spam_report": true,
  "bounce": false,
  "deferred": false,
  "unsubscribe": true,
  "processed": false,
  "open": false,
  "click": false,
  "dropped": false,
  "oauth_client_id": "reprehenderit in null",
  "oauth_client_secret": "ea in nostrud",
  "oauth_token_url": "cupidatat ad Ut"
}
Response Payload
{
  "enabled": true,
  "url": "mollit laborum",
  "group_resubscribe": false,
  "delivered": true,
  "group_unsubscribe": true,
  "spam_report": true,
  "bounce": true,
  "deferred": true,
  "unsubscribe": true,
  "processed": true,
  "open": true,
  "click": false,
  "dropped": true,
  "oauth_client_id": "anim sunt",
  "oauth_token_url": "ex"
}
Header NameExample
on-behalf-of"pariatur"
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": "magna elit cillum non laboris"
    },
    {
      "message": "labore eu occaecat aliqua adipisicing"
    }
  ]
}
Query Parameter NameExample
limitfugiat
offsetid Duis incididunt deserunt
aggregated_byweek
start_date*eu magna
end_dateexercitation nisi aliquip nulla culpa
Header NameExample
on-behalf-of"irure"
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"commodo laborum proident ullamco Excepteur"
Request Payload
Response Payload
{
  "public_key": "anim quis in sint"
}
Header NameExample
on-behalf-of"sit ipsum dolore fugiat in"
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"Ut eu"
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"elit ipsum 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": "dolore eiusmod sit"
    }
  ]
}
Header NameExample
on-behalf-of"Lorem in est"
Request Payload
Response Payload
{
  "url": "http://mydomain.com/parse",
  "hostname": "mail.mydomain.com",
  "spam_check": true,
  "send_raw": true
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "veniam irure quis officia anim"
    },
    {
      "message": "eiusmod"
    },
    {
      "message": "in consectetur amet mollit veniam"
    },
    {
      "message": "nisi consectetur ex commodo ea"
    },
    {
      "message": "est do enim deserunt"
    }
  ]
}
Header NameExample
on-behalf-of"adipisicing amet eiusmod quis"
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": "ea nisi"
    },
    {
      "message": "nulla"
    },
    {
      "message": "cupidatat eu ea"
    },
    {
      "message": "cillum deserunt sint in ex"
    },
    {
      "message": "Excepteur nulla velit"
    }
  ]
}
Header NameExample
on-behalf-of"voluptate in sit Duis"
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": "reprehenderit"
    },
    {
      "message": "qui ipsum consectetur reprehenderit"
    },
    {
      "message": "in adipisicing id"
    },
    {
      "message": "aute"
    }
  ]
}

Query(2 operations)

Query Parameter NameExample
query*consectetur
limit548.5257713347418
Header NameExample
X-Query-Id"esse"
X-Cursor"ut exercitation ut"
Authorization*"consectetur enim ut"
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*"anim dolor"
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
queryin ut
Header NameExample
Authorization*"tempor labore"
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*"ut ad magna irure in"
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"elit"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "open",
      "title": "Open Tracking",
      "description": "lorem ipsum... .",
      "enabled": true
    }
  ]
}
Header NameExample
on-behalf-of"sed enim in"
Request Payload
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"id sed qui et quis"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"laborum ad incididunt"
Request Payload
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"officia adipisicing dolor"
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"pariatur nisi elit dolore"
Request Payload
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"ex sint esse id"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"sit Lorem consequat enim"
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"in laborum"
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
limit97296477
offset-42629702
aggregated_byweek
start_date*in fugiat
end_dateid
Header NameExample
on-behalf-of"Duis est proident"
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-19056352
offset46599826
aggregated_bymonth
start_date*magna quis
end_dateelit
Header NameExample
on-behalf-of"qui elit anim nostrud est"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 1,
          "unique_clicks": 0,
          "unique_opens": 1
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
limit-99649475
offset-35899443
aggregated_byday
start_date*ut nostrud adipisicing sint
end_datevoluptate commodo
Header NameExample
on-behalf-of"deserunt dolore"
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*dolore dolor aliquip in
end_dateincididunt
aggregated_bymonth
Header NameExample
on-behalf-of"nostrud dolore ut ullamco"
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*commodo sunt Excepteur voluptate
end_dateet minim qui labore
aggregated_byday
Header NameExample
on-behalf-of"minim esse dolore"
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_providersvelit
limit39325482
offset45202729
aggregated_byweek
start_date*aliqua in id magna
end_dateveniam
Header NameExample
on-behalf-of"laboris veniam"
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
browsersnisi id
limit49717609
offset-14898981
aggregated_byday
start_date*laborum consequat incididunt magna sit
end_dateenim cillum officia
Header NameExample
on-behalf-of"nulla fugiat labore"
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_time61784368
end_time8446911
Header NameExample
Accept*"et adipisicing laborum ipsum Duis"
on-behalf-of"tempor labore"
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"dolor nostrud irure ut"
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"ea esse ad"
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*VQATsFOFvGraw@ZYOzQogMDOWwVVXTnRPkQ.tc
Header NameExample
on-behalf-of"nostrud laborum velit"
Request Payload
Error generating example
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Blocks API(4 operations)

Query Parameter NameExample
start_time-66314906
end_time34174470
limit94528377
offset-12028977
Header NameExample
on-behalf-of"est id enim adipisicing"
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"qui"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"Duis commodo tempor est anim"
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"velit do"
Request Payload
Response Payload
{}

Spam Reports API(4 operations)

Query Parameter NameExample
start_time90348571
end_time-79200949
limit-4101024
offset-56018464
Header NameExample
on-behalf-of"quis laborum qui"
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"cupidatat officia"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"tempor minim sunt consectetur eu"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "ip": "10.89.32.5"
  }
]
Header NameExample
on-behalf-of"quis laborum"
Request Payload
Response Payload
{}

Suppressions - Global Suppressions(4 operations)

Header NameExample
on-behalf-of"officia magna dolor"
Request Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Response Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Query Parameter NameExample
start_time67590206
end_time67064209
limit34684937
offset28685233
Header NameExample
on-behalf-of"aliqua ea nulla"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com"
  }
]
Header NameExample
on-behalf-of"in"
Request Payload
Response Payload
{
  "recipient_email": "test@example.com"
}
Header NameExample
on-behalf-of"fugiat minim est tempor Lorem"
Request Payload
Response Payload
{}

Suppressions - Unsubscribe Groups(5 operations)

Header NameExample
on-behalf-of"sed ut 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
id77237544
Header NameExample
on-behalf-of"laboris ipsum pariatur"
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"Ut in ut exercitation reprehenderit"
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"Ut aute labore eiusmod"
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"ea in enim"
Request Payload
Response Payload
{}

Suppressions - Suppressions(6 operations)

Header NameExample
on-behalf-of"proident nostrud elit ex"
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"mollit labore"
Request Payload
Response Payload
[
  "example@example.com",
  "example2@example.com"
]
Header NameExample
on-behalf-of"pariatur nulla Duis"
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"consectetur aute reprehenderit"
Request Payload
Response Payload
[
  {
    "email": "test1@example.com",
    "group_id": 1,
    "group_name": "Weekly News",
    "created_at": 1410986704
  },
  {
    "email": "test1@example.com",
    "group_id": 2,
    "group_name": "Daily News",
    "created_at": 1411493671
  },
  {
    "email": "test2@example.com",
    "group_id": 2,
    "group_name": "Daily News",
    "created_at": 1411493671
  }
]
Header NameExample
on-behalf-of"in anim officia quis est"
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"
Request Payload
Response Payload
Error generating example

Invalid Emails API(4 operations)

Query Parameter NameExample
start_time-18224015
end_time-47830948
limit-54599022
offset-17638539
Header NameExample
on-behalf-of"ea occaecat quis sit labore"
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"mollit commodo"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"nostrud cupidatat"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]
Header NameExample
on-behalf-of"adipisicing in officia"
Request Payload
Response Payload
{}
Service Homepage: sendgrid.com/en-us
API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started
emails