View All Services

Sendgrid V3 Mock Server

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

The hosted mock server empowers you to effortlessly simulate various Sendgrid V3 APIs, and doesn't need any authentication/api-key. The setup is straightforward, you can configure the base URL in your code/SDK. You can also control the base URL using environment variables or a feature flag. You don't need any additional dependencies, and you can run the same code in both sandbox and production environments.

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

We have set up the mock routes to ensure a smooth adoption. Copy the URL below and set it as the API base URL in your code, and instantly harness the full potential of mocked Sendgrid V3 APIs.

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": "ad tempor veniam elit adipisicing"
    },
    {
      "message": "eu exercitation labore consequat"
    },
    {
      "message": "aute aliqua"
    },
    {
      "message": "culpa est magna voluptate"
    },
    {
      "message": "deserunt in nulla in dolore"
    }
  ]
}

Cancel Scheduled Sends(7 operations)

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

API Keys(6 operations)

Header NameExample
on-behalf-of"irure est incididunt"
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": "ad"
    },
    {
      "message": "ut"
    }
  ]
}
Query Parameter NameExample
limit-37987187
Header NameExample
on-behalf-of"adipisicing in"
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": "reprehenderit proident in sit"
    }
  ]
}
Header NameExample
on-behalf-of"ullamco sed commodo"
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": "proident"
    }
  ]
}
Header NameExample
on-behalf-of"adipisicing ut proident"
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": "qui mollit nostrud labore in"
    },
    {
      "message": "eiusmod irure Lorem aliquip"
    }
  ]
}
Header NameExample
on-behalf-of"elit"
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": "magna esse sit"
    },
    {
      "message": "veniam ullamco sit"
    },
    {
      "message": "est sint id"
    },
    {
      "message": "ad adipisicing"
    },
    {
      "message": "ipsum mollit commodo"
    }
  ]
}
Header NameExample
on-behalf-of"eu dolore"
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": "reprehenderit ullamco"
    },
    {
      "message": "labore aute dolore dolor sit"
    },
    {
      "message": "dolore culpa id"
    },
    {
      "message": "exercitation aliquip aute id adipisicing"
    }
  ]
}

API Key Permissions

Header NameExample
on-behalf-of"in ipsum"
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": "ut fugiat aliquip culpa non"
    },
    {
      "message": "deserunt"
    },
    {
      "message": "tempor"
    },
    {
      "message": "consectetur"
    },
    {
      "message": "et culpa adipisicing sit voluptate"
    }
  ]
}

Settings - Enforced TLS(2 operations)

Header NameExample
on-behalf-of"sit deserunt officia"
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": "ex ipsum veniam dolore ea"
    },
    {
      "message": "quis"
    }
  ]
}
Header NameExample
on-behalf-of"proident nostrud"
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": "id in ut labore irure"
    },
    {
      "message": "ea ullamco occaecat in"
    },
    {
      "message": "qui sint magna labore nulla"
    }
  ]
}

IP Access Management(6 operations)

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

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
}
[
  {
    "message": "id esse ea eu tempor",
    "field": "in velit",
    "error_id": "mollit aliquip"
  },
  {
    "message": "id consectetur in sit pariatur",
    "field": null,
    "error_id": "do voluptate"
  },
  {
    "message": "ipsum nostrud",
    "field": null,
    "error_id": "do velit"
  }
]
[
  {
    "message": "sint culpa",
    "field": "ea aute sit",
    "error_id": "nulla consequat voluptate"
  },
  {
    "message": "mollit ipsum ut",
    "field": "eu amet deserunt laboris elit",
    "error_id": "ea"
  }
]
[
  {
    "message": "mollit culpa",
    "field": "in",
    "error_id": "tempor in"
  }
]
[
  {
    "message": "incididunt nostrud consectetur officia exercitation",
    "field": null,
    "error_id": "anim sunt"
  },
  {
    "message": "ullamco minim cupidatat veniam consectetur",
    "field": null,
    "error_id": "esse aliqua eu in labore"
  },
  {
    "message": "voluptate dolor sint ipsum",
    "field": "qui incididunt do veniam",
    "error_id": "fugiat voluptate"
  },
  {
    "message": "minim",
    "field": null,
    "error_id": "sunt dolore dolor"
  }
]
[
  {
    "message": "enim",
    "field": null,
    "error_id": "Duis"
  },
  {
    "message": "Duis dolore cillum",
    "field": null,
    "error_id": "elit ullamco labore qui"
  },
  {
    "message": "voluptate tempor",
    "field": null,
    "error_id": "in ex officia"
  },
  {
    "message": "fugiat consequat",
    "field": null,
    "error_id": "incididunt sit fugiat ullamco aliqua"
  }
]
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"
  }
]
[
  {
    "message": "amet commodo esse sunt",
    "field": null,
    "error_id": "incididunt exercitation qui cillum aliqua"
  },
  {
    "message": "in nulla ad",
    "field": "Ut",
    "error_id": "consequat eu sed sint"
  }
]
[
  {
    "message": "sint",
    "field": "commodo dolor",
    "error_id": "ut"
  }
]
[
  {
    "message": "ut culpa ipsum",
    "field": null,
    "error_id": "laborum"
  },
  {
    "message": "cupidatat ea minim",
    "field": "ad",
    "error_id": "incididunt Duis deserunt do"
  }
]
[
  {
    "message": "officia dolore",
    "field": "consectetur ea",
    "error_id": "ut officia dolore"
  }
]
[
  {
    "message": "in",
    "field": "sed ex est",
    "error_id": "nulla commodo"
  },
  {
    "message": "velit",
    "field": "tempor et",
    "error_id": "cillum ea est Lorem"
  },
  {
    "message": "dolore Duis",
    "field": null,
    "error_id": "Excepteur id Ut anim"
  },
  {
    "message": "pariatur ea proident minim amet",
    "field": null,
    "error_id": "do cupidatat"
  }
]
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"
}
[
  {
    "message": "eu cupidatat commodo dolore ex",
    "field": "sed irure",
    "error_id": "ut in eiusmod"
  },
  {
    "message": "in",
    "field": null,
    "error_id": "enim in consectetur veniam"
  },
  {
    "message": "aliquip exercitation laboris",
    "field": null,
    "error_id": "exercitation ullamco aliquip deserunt in"
  },
  {
    "message": "eu velit in",
    "field": null,
    "error_id": "amet est ut"
  }
]
[
  {
    "message": "velit in officia magna minim",
    "field": null,
    "error_id": "do"
  },
  {
    "message": "et",
    "field": null,
    "error_id": "Ut elit eu aute"
  }
]
[
  {
    "message": "commodo",
    "field": "deserunt nostrud elit ipsum",
    "error_id": "fugiat consectetur laborum"
  }
]
[
  {
    "message": "ex id reprehenderit pariatur",
    "field": null,
    "error_id": "esse commodo magna"
  },
  {
    "message": "in",
    "field": null,
    "error_id": "officia pariatur adipisicing tempor"
  },
  {
    "message": "dolore elit sunt",
    "field": null,
    "error_id": "aliquip dolor reprehenderit"
  },
  {
    "message": "anim ut mollit",
    "field": null,
    "error_id": "irure cillum deserunt"
  }
]
[
  {
    "message": "amet adipisicing aute ut exercitation",
    "field": "irure",
    "error_id": "cupidatat"
  },
  {
    "message": "magna eu",
    "field": null,
    "error_id": "et ex ipsum ullamco ut"
  },
  {
    "message": "id sit laborum eiusmod",
    "field": "Duis eiusmod nisi in fugiat",
    "error_id": "in nisi in sed"
  },
  {
    "message": "sit magna",
    "field": null,
    "error_id": "qui sunt"
  },
  {
    "message": "mollit pariatur",
    "field": "aute dolore",
    "error_id": "sed"
  }
]
Query Parameter NameExample
sifalse
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"
}
[
  {
    "message": "occaecat consectetur aliquip non sed",
    "field": null,
    "error_id": "culpa mollit non eiusmod ut"
  },
  {
    "message": "voluptate",
    "field": null,
    "error_id": "Lorem amet velit nulla"
  },
  {
    "message": "fugiat",
    "field": "ipsum in",
    "error_id": "irure eu"
  }
]
[
  {
    "message": "anim pariatur Lorem laboris aliquip",
    "field": "minim consectetur labore in",
    "error_id": "do"
  }
]
[
  {
    "message": "Excepteur",
    "field": "sunt Ut eu",
    "error_id": "dolor in aute sed"
  },
  {
    "message": "nisi ullamco aliquip qui",
    "field": "esse mollit nisi amet ex",
    "error_id": "adipisicing non ut ea esse"
  },
  {
    "message": "magna proident quis",
    "field": null,
    "error_id": "aliquip dolor esse Ut ut"
  },
  {
    "message": "ea labore sed nostrud veniam",
    "field": null,
    "error_id": "magna"
  },
  {
    "message": "in labore adipisicing",
    "field": "sed cillum Duis culpa sunt",
    "error_id": "incididunt proident"
  }
]
[
  {
    "message": "fugiat in officia enim incididunt",
    "field": "pariatur sunt consequat dolor qui",
    "error_id": "qui ullamco deserunt"
  },
  {
    "message": "qui sed dolore",
    "field": "consequat Excepteur",
    "error_id": "Excepteur non aliquip adipisicing"
  },
  {
    "message": "nostrud cupidatat ea reprehenderit et",
    "field": "laboris quis pariatur consectetur",
    "error_id": "in mollit ullamco officia"
  },
  {
    "message": "officia ut",
    "field": null,
    "error_id": "nostrud anim tempor aliquip ea"
  }
]
[
  {
    "message": "do amet nostrud",
    "field": null,
    "error_id": "aliquip dolor"
  },
  {
    "message": "ex occaecat dolore nulla ut",
    "field": "esse voluptate tempor nostrud",
    "error_id": "Ut mollit"
  },
  {
    "message": "magna irure tempor consectetur eu",
    "field": "mollit Duis incididunt voluptate",
    "error_id": "ipsum ullamco irure"
  },
  {
    "message": "aliquip eiusmod",
    "field": null,
    "error_id": "ea"
  },
  {
    "message": "sunt nisi nulla esse mollit",
    "field": "in voluptate aliqua",
    "error_id": "Duis deserunt officia"
  }
]
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
[
  {
    "message": "et sunt minim",
    "field": "magna exercitation voluptate laboris",
    "error_id": "Lorem nostrud ut labore"
  },
  {
    "message": "non cupidatat Ut aute dolor",
    "field": null,
    "error_id": "laboris cillum veniam ex"
  }
]
[
  {
    "message": "reprehenderit adipisicing exercitation magna eu",
    "field": null,
    "error_id": "amet dolore Lorem quis"
  },
  {
    "message": "fugiat aliquip consequat",
    "field": null,
    "error_id": "cupidatat aute Ut"
  }
]
[
  {
    "message": "in cupidatat dolore minim magna",
    "field": "Lorem elit",
    "error_id": "ullamco culpa fugiat incididunt"
  },
  {
    "message": "velit officia",
    "field": null,
    "error_id": "voluptate in dolore consectetur minim"
  },
  {
    "message": "magna amet non qui sit",
    "field": "aute dolore",
    "error_id": "esse"
  }
]
[
  {
    "message": "Ut irure sit consequat ut",
    "field": null,
    "error_id": "dolore adipisicing eiusmod"
  },
  {
    "message": "voluptate",
    "field": null,
    "error_id": "mollit aliquip in commodo"
  },
  {
    "message": "magna Excepteur cillum",
    "field": "ullamco sunt Ut consequat et",
    "error_id": "ut dolor exercitation"
  },
  {
    "message": "culpa cupidatat eiusmod",
    "field": null,
    "error_id": "minim Duis aute pariatur nisi"
  }
]
[
  {
    "message": "Ut aliqua minim",
    "field": null,
    "error_id": "proident exercitation minim est ullamco"
  },
  {
    "message": "dolore",
    "field": null,
    "error_id": "anim Duis occaecat ut"
  },
  {
    "message": "Ut Lorem",
    "field": null,
    "error_id": "reprehenderit commodo culpa aute"
  }
]

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

Settings - Mail(13 operations)

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

Settings - Partner(3 operations)

Header NameExample
on-behalf-of"anim in cillum"
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"dolor cupidatat nisi"
Request Payload
Response Payload
{
  "enable_subuser_statistics": false,
  "enabled": true,
  "license_key": ""
}
Query Parameter NameExample
limit69487261
offset-54257861
Header NameExample
on-behalf-of"occaecat ut ex pariatur"
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"exercitation aliquip ut"
Request Payload
{
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}
Response Payload
{
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}
{
  "errors": [
    {
      "message": "ex sunt",
      "field": "incididunt nisi"
    },
    {
      "message": "pariatur incididunt veniam voluptate",
      "field": "sunt"
    },
    {
      "message": "Ut quis culpa ut amet",
      "field": "ut dolor veniam Ut"
    }
  ]
}
Query Parameter NameExample
limit140
offset90015232
Header NameExample
on-behalf-of"veniam exercitation enim irure 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"ad et Ut"
Request Payload
Response Payload
{
  "pending_id": "abc123abc",
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}
{
  "errors": [
    {
      "message": "invalid pending key",
      "field": "pending_key"
    }
  ]
}
Query Parameter NameExample
limit-96706135
offset42762227
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"velit enim"
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"ullamco enim voluptate quis"
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"ea"
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"fugiat est nulla ut"
Request Payload
Response Payload
{
  "errors": [
    {
      "message": "labore",
      "field": "minim est"
    },
    {
      "message": "pariatur quis dolor",
      "field": "nulla"
    }
  ]
}
{
  "errors": [
    {
      "message": "username not found",
      "field": "username"
    }
  ]
}
Request Payload
Response Payload
{
  "scope_group_name": "Stats"
}
{}
{
  "errors": [
    {
      "message": "consectetur",
      "field": "ut"
    }
  ]
}
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"cupidatat quis in est qui"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "nulla ad",
      "field": "nisi consequat tempor laborum elit"
    }
  ]
}

Alerts(5 operations)

Header NameExample
Authorization"in voluptate"
on-behalf-of"Ut laborum"
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": "dolor ut ea et",
  "message": "minim"
}
Header NameExample
Authorization"consequat culpa Excepteur incididunt"
on-behalf-of"consequat occaecat"
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"aliquip"
on-behalf-of"ut"
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"exercitation consequat amet irure"
Request Payload
Response Payload
{}
Header NameExample
on-behalf-of"Duis"
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"ad occaecat sint pariatur aliqua"
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"exercitation esse ipsum"
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"fugiat dolore"
Request Payload
Response Payload
{
  "reputation": 100,
  "type": "paid"
}
Header NameExample
on-behalf-of"cupidatat dolore et"
Request Payload
Response Payload
{
  "email": "test@example.com"
}
Header NameExample
on-behalf-of"fugiat"
Request Payload
{
  "email": "example@example.com"
}
Response Payload
{
  "email": "example@example.com"
}
Header NameExample
on-behalf-of"culpa amet consequat incididunt exercitation"
Request Payload
Response Payload
{
  "username": "test_username",
  "user_id": 1
}
Header NameExample
on-behalf-of"eiusmod dolore"
Request Payload
{
  "username": "test_username"
}
Response Payload
{
  "username": "test_username"
}
Header NameExample
on-behalf-of"aliquip eiusmod tempor anim"
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"deserunt consequat esse"
Request Payload
{
  "new_password": "new_password",
  "old_password": "old_password"
}
Response Payload
{}

Subusers API(6 operations)

Query Parameter NameExample
usernameconsequat magna esse
limit94436573
offset68144914
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
usernamesofficia irure fugiat
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*consequat deserunt tempor
sort_by_metricaliquip
sort_by_directionasc
limit19046181
offset99025954
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*magna eiusmod labore
subuserincididunt anim eiusmod
sort_by_metricdelivered
sort_by_directiondesc
limit-67371524
offset-67396374
Request Payload
Response Payload
{
  "date": "2016-02-01",
  "stats": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 0,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 1,
        "processed": 0,
        "requests": 100,
        "spam_report_drops": 0,
        "spam_reports": 99,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user1",
      "type": "subuser"
    },
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 10,
        "processed": 10,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user2",
      "type": "subuser"
    }
  ]
}
Query Parameter NameExample
sort_by_directiondesc
start_date*ex laborum dolore deserunt
end_datein officia
limit-84703942
offset-969853
aggregated_byet in cillum
sort_by_metricin pariatur
Request Payload
Response Payload
{
  "date": "2015-10-11",
  "stats": []
}
Query Parameter NameExample
limit-21025399
offset62767610
aggregated_byday
subusers*exercitation
start_date*non amet sed do sit
end_datereprehenderit consectetur
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"fugiat"
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
limit20091368
offset-36124470
ipanim sit consequat
Header NameExample
on-behalf-of"ut aute"
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"sed"
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"commodo"
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"adipisicing dolor in laborum eiusmod"
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": "fugiat exercitation",
    "field": "exercitation consequat"
  }
}

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
ipdeserunt voluptate amet ut
exclude_whitelabelstrue
limit-16499678
offset-94365337
subusercillum
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
limit21121384
offset63788685
exclude_subuserstrue
usernamedolor
domainnon
Header NameExample
on-behalf-of"nostrud"
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"eu in nulla"
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"dolor sed magna"
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"enim consectetur minim qui sint"
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"anim tempor fugiat"
Request Payload
Response Payload
{}
Query Parameter NameExample
domaincupidatat
Header NameExample
on-behalf-of"cillum enim quis dolore"
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"id pariatur"
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"ad sit ut irure consequat"
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"ea cillum qui nisi Ut"
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*fugiat amet nulla
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
usernamecillum ipsum
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": "do"
    },
    {
      "message": "dolore qui magna irure sint"
    },
    {
      "message": "consequat"
    },
    {
      "message": "ex quis voluptate consequat cillum"
    }
  ]
}
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": "ut Duis deserunt occaecat"
    },
    {
      "message": "eu et commodo qui"
    },
    {
      "message": "quis ut officia"
    },
    {
      "message": "irure do occaecat commodo"
    },
    {
      "message": "aliquip"
    }
  ]
}
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": [
    {
      "field": "qui ut dolore ex id",
      "message": "exercitation nulla irure",
      "error_id": "Lorem ullamco reprehenderit do"
    },
    {
      "field": "eu",
      "message": "incididunt ullamco labore in",
      "error_id": "ad in dolore tempor"
    },
    {
      "field": "id incididunt labore tempor",
      "message": "in nostrud commodo",
      "error_id": "dolor mollit incididunt nisi veniam"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "officia"
    },
    {
      "message": "Ut"
    },
    {
      "message": "occaecat incididunt labore"
    }
  ]
}
Query Parameter NameExample
limit93807226.75757766
lastSeenID-76115695.5596916
id-41141184
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": "dolor cupidatat reprehenderit adipisicing"
    },
    {
      "message": "dolore do minim"
    }
  ]
}
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": [
    {
      "message": "dolor qui in",
      "error_id": "laborum in Lorem pariatur nisi"
    },
    {
      "message": "consequat laboris nostrud voluptate quis",
      "error_id": "reprehenderit"
    },
    {
      "message": "veniam nisi",
      "error_id": "anim esse mollit nisi nostrud"
    },
    {
      "message": "in",
      "error_id": "ipsum Excepteur sed adipisicing ut"
    },
    {
      "message": "eiusmod",
      "error_id": "ea dolore sed cillum sit"
    }
  ]
}
{
  "errors": [
    {
      "message": "veniam anim ad ipsum"
    },
    {
      "message": "dolore fugiat commodo enim elit"
    },
    {
      "message": "amet consectetur in laboris labore"
    }
  ]
}
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": [
    {
      "field": "in",
      "message": "ex Duis",
      "error_id": "sint"
    },
    {
      "field": "sunt aute",
      "message": "ullamco sunt proident",
      "error_id": "consequat Ut aliquip ex"
    },
    {
      "field": "commodo Duis cupidatat dolor",
      "message": "Lorem amet est voluptate",
      "error_id": "laborum labore Duis eu"
    },
    {
      "field": "Lorem dolor ipsum est id",
      "message": "non exercitation dolore pariatur",
      "error_id": "fugiat veniam in esse do"
    },
    {
      "field": "nulla Ut officia veniam",
      "message": "occaecat cillum magna",
      "error_id": "cillum elit sunt nisi Ut"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "eu reprehenderit dolore",
      "error_id": "ullamco ea"
    }
  ]
}
{
  "errors": [
    {
      "message": "mollit",
      "error_id": "Ut proident quis culpa"
    }
  ]
}
{
  "errors": [
    {
      "message": "mollit Duis magna tempor laborum"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "eiusmod",
      "error_id": "exercitation qui id"
    }
  ]
}
{
  "errors": [
    {
      "message": "nisi ipsum ut",
      "error_id": "velit ut laboris quis commodo"
    },
    {
      "message": "minim anim laboris nulla",
      "error_id": "dolore Ut nisi quis"
    },
    {
      "message": "minim",
      "error_id": "pariatur sed sunt incididunt"
    },
    {
      "message": "ea",
      "error_id": "elit consectetur"
    },
    {
      "message": "consequat",
      "error_id": "ad ipsum Ut voluptate incididunt"
    }
  ]
}
{
  "errors": [
    {
      "message": "qui quis mollit elit"
    },
    {
      "message": "reprehenderit eu aliquip cupidatat Duis"
    },
    {
      "message": "sunt"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "message": "aliquip commodo eiusmod",
      "error_id": "Excepteur"
    },
    {
      "message": "ad",
      "error_id": "nisi sunt aliquip amet"
    },
    {
      "message": "ad irure Ut",
      "error_id": "consectetur adipisicing est dolor"
    },
    {
      "message": "laboris Excepteur sit et",
      "error_id": "in id"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "irure in anim nostrud eiusmod",
      "error_id": "irure dolore"
    },
    {
      "message": "culpa",
      "error_id": "consectetur"
    },
    {
      "message": "Excepteur adipisicing",
      "error_id": "ipsum Ut"
    },
    {
      "message": "sit incididunt amet officia ex",
      "error_id": "pariatur laboris"
    },
    {
      "message": "est",
      "error_id": "irure ullamco exercitation sint et"
    }
  ]
}
{
  "errors": [
    {
      "message": "nostrud incididunt"
    },
    {
      "message": "in ipsum ullamco aliquip ad"
    },
    {
      "message": "et officia ea labore"
    },
    {
      "message": "ipsum qui Lorem culpa"
    }
  ]
}

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": []
}
{
  "message": "cillum",
  "field": "dolor veniam proident in",
  "error_id": "cupidatat dolore"
}
{
  "errors": [
    {
      "message": "commodo elit aliquip voluptate",
      "field": "Lorem labore",
      "error_id": "culpa exercitation"
    },
    {
      "message": "dolor elit eu esse consectetur",
      "field": "minim aute",
      "error_id": "tempor dolor sunt eu"
    },
    {
      "message": "cupidatat Duis",
      "field": "exercitation esse",
      "error_id": "consectetur"
    },
    {
      "message": "pariatur aliqua",
      "field": "voluptate quis ad",
      "error_id": "in"
    },
    {
      "message": "aliqua labore magna tempor",
      "field": "veniam eiusmod laboris occaecat velit",
      "error_id": "sit amet do nostrud laborum"
    }
  ]
}
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": [
    {
      "message": "in Ut",
      "field": "voluptate incididunt",
      "error_id": "in nostrud est amet"
    },
    {
      "message": "ut nulla tempor sint cupidatat",
      "field": "magna sed ipsum amet",
      "error_id": "consequat aliqua exercitation laborum labore"
    },
    {
      "message": "Ut deserunt",
      "field": "ex labore aute ut",
      "error_id": "consequat ad dolor Lorem exercitation"
    },
    {
      "message": "eiusmod eu ut",
      "field": "dolore et",
      "error_id": "nisi culpa labore nulla"
    },
    {
      "message": "ad",
      "field": "mollit Excepteur id",
      "error_id": "culpa cupidatat non occaecat"
    }
  ]
}
{
  "errors": [
    {
      "message": "officia",
      "field": "est",
      "error_id": "labore ad ut amet"
    },
    {
      "message": "proident eu qui non",
      "field": "cupidatat in ullamco non",
      "error_id": "minim labore non cillum"
    },
    {
      "message": "labore ipsum id laborum dolor",
      "field": "ad sunt incididunt do",
      "error_id": "ut minim"
    },
    {
      "message": "magna",
      "field": "dolor",
      "error_id": "ipsum proident eiusmod Lorem non"
    }
  ]
}
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": [
    {
      "message": "ipsum do",
      "field": "reprehenderit occaecat mollit",
      "error_id": "enim Ut irure ullamco"
    },
    {
      "message": "enim non ad sed dolore",
      "field": "ut incididunt dolore irure aliquip",
      "error_id": "dolore laborum fugiat do"
    },
    {
      "message": "id et enim",
      "field": "laboris mollit",
      "error_id": "reprehenderit in Ut fugiat sit"
    }
  ]
}
{
  "errors": [
    {
      "message": "fugiat",
      "field": "consectetur minim officia",
      "error_id": "elit veniam voluptate in ullamco"
    },
    {
      "message": "reprehenderit deserunt",
      "field": "incididunt laboris in Ut",
      "error_id": "pariatur voluptate consequat in nisi"
    },
    {
      "message": "ex ullamco",
      "field": "ea ad ut aliqua",
      "error_id": "sit sint incididunt dolor occaecat"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "message": "culpa aliquip ipsum",
      "field": "Lorem",
      "error_id": "ea"
    },
    {
      "message": "deserunt",
      "field": "esse consequat",
      "error_id": "ipsum qui non nostrud velit"
    },
    {
      "message": "ipsum laboris officia",
      "field": "magna veniam nisi",
      "error_id": "minim est ullamco sit pariatur"
    }
  ]
}
{
  "errors": [
    {
      "message": "cillum esse reprehenderit ea",
      "field": "magna",
      "error_id": "irure nisi et ipsum ut"
    },
    {
      "message": "deserunt Ut incididunt culpa consequat",
      "field": "in sed",
      "error_id": "in labore"
    },
    {
      "message": "consectetur",
      "field": "exercitation mollit cupidatat dolor",
      "error_id": "sunt"
    },
    {
      "message": "non Ut proident tempor pariatur",
      "field": "culpa qui voluptate sint consequat",
      "error_id": "officia eu anim"
    },
    {
      "message": "tempor proident elit",
      "field": "proident",
      "error_id": "laboris ea"
    }
  ]
}
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": [
    {
      "message": "commodo et aute amet",
      "field": "eu do officia qui et",
      "error_id": "ut"
    }
  ]
}
Query Parameter NameExample
page_size64070664
page_tokencupidatat
summaryfalse
Request Payload
Response Payload
{
  "result": [
    {
      "id": "3247eaea-c912-42a3-b0bc-60bdaf210396",
      "name": "Welcome Email",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/llny8o5b3m636z92p7hbjnmq1jvpka39p370jwtin2s1wxv7x1sgm0y5fk518d0s.png",
      "subject": "Welcom to the Cake or Pie Cafe",
      "created_at": "2021-04-09T17:29:46Z",
      "updated_at": "2021-04-09T17:29:55Z",
      "editor": "code",
      "categories": [
        "welcome",
        "new customer"
      ]
    },
    {
      "id": "02dfd792-f31f-439a-a79e-5c47fbcfdbac",
      "name": "Monthly Promo",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/hfyxahd7ues2ajuoeoqq2xe6ibdasl1q89ox0y9ncya2ftpoicssmtf9ddus4c39.png",
      "subject": "Free Dozen Cupcakes",
      "created_at": "2021-04-09T17:29:21Z",
      "updated_at": "2021-04-09T17:29:42Z",
      "editor": "design",
      "categories": [
        "promo",
        "coupon"
      ]
    },
    {
      "id": "e54be823-19ef-4c6f-8b60-efd7514f492d",
      "name": "Duplicate: Ingrid & Anders",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/12kni9gjpyb9uxmwr9vk7unycjr70u95zoyhe9sg2zounul2zg7dih1s20k13q2z.png",
      "subject": "Welcome to Ingrid & Anders!",
      "created_at": "2020-10-09T17:33:46Z",
      "updated_at": "2021-04-07T19:57:52Z",
      "editor": "design",
      "categories": []
    }
  ],
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/designs?page_token=vHdvHCg0w1F-TmWJcPNpTEnFY2aPEmRBHONwOgZ6TgJbX2_I",
    "count": 3
  }
}
Request Payload
{
  "name": "Ahoy, Cake or Pie Cafe!",
  "editor": "design"
}
Response Payload
{
  "id": "abe0877f-a224-21e2-b62e-c789d326cda5",
  "name": "Ahoy, Pre-built Design!",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: courier, monospace;\n      font-size: 16px;\n    }\n    body {\n      color: #FFFFFF;\n    }\n    body a {\n      color: #fe5d61;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start-->\n\n     <!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#fe5d61\" data-body-style=\"font-size:16px; font-family:courier, monospace; color:#FFFFFF; background-color:#f2f4fb;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#f2f4fb\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#f2f4fb\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#FFFFFF; text-align:left;\" bgcolor=\"#f2f4fb\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p>You've found the secret!</p>\n      </td>\n    </tr>\n  </table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"98ndJyAY9BSGjoVqrr6FYx\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:30px 0px 30px 0px;\" valign=\"top\" align=\"left\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:40% !important; width:40%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/9d9c1f3d8009c42bbe60c0355f1ed23e86c3f5619173e83a9328b9214e42e1c1d5e009ed5cc4c8f3efedfc33d46bba2f4577b143607025a29add6e89ab4662ad.png\" alt=\"Off Grid Adventures\" width=\"240\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"3Ypdby9Xfsf2rN27zTDEfN\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/e324b295c47223f1a936198fbd4e5d4b239ff86c6d6c89d4d0eb8d7c61028921abfc4901ba607f6dcb7acc7067bb0c6df4313726b14b8274e0b2c98cdf8b58d2.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"7pyDCmyDaGcm5WsBBSaEgv\" data-mc-module-version=\"2019-10-22\">\n      <tbody><tr>\n        <td style=\"background-color:#FE5D61; padding:50px 0px 30px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#FE5D61\"><div><div style=\"font-family: inherit; text-align: center\"><span style=\"font-size: 24px\">Welcome to the family!</span></div><div></div></div></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"nSVYnVzPLnGZ4wUdynLiKo\" data-mc-module-version=\"2019-10-22\">\n      <tbody><tr>\n        <td style=\"background-color:#fe5d61; padding:30px 50px 30px 50px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#fe5d61\"><div><div style=\"font-family: inherit; text-align: center\">You've found a community of travelers that are just like you.</div>\n<div style=\"font-family: inherit; text-align: center\">&nbsp;</div>\n<div style=\"font-family: inherit; text-align: center\">We don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.</div>\n<div style=\"font-family: inherit; text-align: center\">&nbsp;</div>\n<div style=\"font-family: inherit; text-align: center\">Ready for your next authentic travel experience?</div><div></div></div></td>\n      </tr>\n    </tbody></table><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"module\" data-role=\"module-button\" data-type=\"button\" role=\"module\" style=\"table-layout:fixed\" width=\"100%\" data-muid=\"4ywPd9vJ6WFyV1Si75h9vh\"><tbody><tr><td align=\"center\" bgcolor=\"#fe5d61\" class=\"outer-td\" style=\"padding:10px 10px 60px 10px; background-color:#fe5d61;\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"button-css__deep-table___2OZyb wrapper-mobile\" style=\"text-align:center\"><tbody><tr><td align=\"center\" bgcolor=\"#ffffff\" class=\"inner-td\" style=\"border-radius:6px; font-size:16px; text-align:center; background-color:inherit;\"><a style=\"background-color:#ffffff; border:1px solid #ffffff; border-color:#ffffff; border-radius:3px; border-width:1px; color:#fe5d61; display:inline-block; font-size:16px; font-weight:700; letter-spacing:1px; line-height:40px; padding:12px 20px 12px 20px; text-align:center; text-decoration:none; border-style:solid;\" href=\"\" target=\"_blank\">Browse Gallery</a></td></tr></tbody></table></td></tr></tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"6jxKSRk9dKQ1Tvi1wtnu8q\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/0accac77b1e34c614730ab732317a493478835c96bd549fb2df7a921ec1177fdb30d6d33e1d0a33d8c6c579344890ae408ce13aaed0e478f1fd6d2219d308365.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"iYySZ4rAB78PLoW7vU13Bb\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"divider\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"mVyZz43HETwfwb72TGh4iy\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 0px 0px;\" role=\"module-content\" height=\"100%\" valign=\"top\" bgcolor=\"\">\n          <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" align=\"center\" width=\"100%\" height=\"3px\" style=\"line-height:3px; font-size:3px;\">\n            <tbody><tr>\n              <td style=\"padding:0px 0px 3px 0px;\" bgcolor=\"#ffffff\"></td>\n            </tr>\n          </tbody></table>\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"sfek66tVLi5d2iy5jmSawj\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"social\" align=\"center\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"87277ffe-54ed-4792-94f3-0a973b71c268\">\n    <tbody>\n      <tr>\n        <td valign=\"top\" style=\"padding:0px 0px 0px 0px; font-size:6px; line-height:10px;\" align=\"center\">\n          <table align=\"center\" style=\"-webkit-margin-start:auto;-webkit-margin-end:auto;\">\n            <tbody><tr align=\"center\"><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.facebook.com/sendgrid/\" target=\"_blank\" alt=\"Facebook\" title=\"Facebook\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Facebook\" title=\"Facebook\" src=\"https://mc.sendgrid.com/assets/social/white/facebook.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor\" target=\"_blank\" alt=\"Twitter\" title=\"Twitter\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Twitter\" title=\"Twitter\" src=\"https://mc.sendgrid.com/assets/social/white/twitter.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.instagram.com/sendgrid/?hl=en\" target=\"_blank\" alt=\"Instagram\" title=\"Instagram\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Instagram\" title=\"Instagram\" src=\"https://mc.sendgrid.com/assets/social/white/instagram.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.pinterest.com/sendgrid/\" target=\"_blank\" alt=\"Pinterest\" title=\"Pinterest\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Pinterest\" title=\"Pinterest\" src=\"https://mc.sendgrid.com/assets/social/white/pinterest.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td></tr></tbody>\n          </table>\n        </td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module unsubscribe-css__unsubscribe___2CDlR\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#FFFFFF; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:center;\" data-muid=\"txBUUpmixSjuZ5Ad69p1sX\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "plain_content": "You've found the secret!\n\nWelcome to the family!\n\nYou've found a community of travelers that are just like you.\n\nWe don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.\n\nReady for your next authentic travel experience?\n\nBrowse Gallery\n\n( https://www.facebook.com/sendgrid/ ) ( https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor ) ( https://www.instagram.com/sendgrid/?hl=en ) ( https://www.pinterest.com/sendgrid/ )\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
  "generate_plain_content": true,
  "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/a85b4b202ff28094828f11ff472360caecf67ead2d186b69b45c904b9251aa0b.png",
  "subject": "Welcome to the family!",
  "created_at": "2021-04-30T19:15:28Z",
  "updated_at": "2021-04-30T19:15:28Z",
  "editor": "design",
  "categories": []
}
{
  "errors": [
    {
      "message": "tempor dolore culpa ad",
      "field": "sit",
      "error_id": "veniam magna qui exercitation ut"
    }
  ]
}
{
  "errors": [
    {
      "message": "ut in ullamco",
      "field": "et aliquip pariatur ipsum adipisicing",
      "error_id": "laboris Duis aliquip"
    },
    {
      "message": "sunt sint dolor",
      "field": "sint",
      "error_id": "in amet Duis nisi aute"
    },
    {
      "message": "sed incididunt occaecat dolore mollit",
      "field": "et aliquip ut laboris",
      "error_id": "ut sunt fugiat nostrud laborum"
    },
    {
      "message": "esse adipisicing incididunt do anim",
      "field": "ea dolor elit pariatur nisi",
      "error_id": "veniam"
    },
    {
      "message": "incididunt",
      "field": "tempor ullamco commodo",
      "error_id": "est aliqua"
    }
  ]
}
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": [
    {
      "message": "nostrud amet",
      "field": "aliqua veniam",
      "error_id": "dolor enim dolor quis"
    },
    {
      "message": "amet tempor Duis commodo reprehenderit",
      "field": "sunt",
      "error_id": "mollit dolor ut ea"
    },
    {
      "message": "cupidatat commodo mollit id",
      "field": "mollit amet elit",
      "error_id": "reprehenderit pariatur"
    },
    {
      "message": "adipisicing",
      "field": "Excepteur sunt deserunt sed",
      "error_id": "et non dolor magna sed"
    },
    {
      "message": "nostrud nisi labore quis enim",
      "field": "Lorem reprehenderit",
      "error_id": "ut do sunt pariatur"
    }
  ]
}
{
  "errors": [
    {
      "message": "commodo do",
      "field": "laborum eiusmod eu ut",
      "error_id": "eiusmod et ullamco"
    },
    {
      "message": "enim pariatur",
      "field": "cillum aute dolor in laboris",
      "error_id": "laboris incididunt"
    },
    {
      "message": "qui pariatur consectetur",
      "field": "amet",
      "error_id": "ut"
    },
    {
      "message": "in ipsum et dolore",
      "field": "Lorem",
      "error_id": "in dolore ad"
    },
    {
      "message": "Duis dolor",
      "field": "do adipisicing",
      "error_id": "Lorem"
    }
  ]
}
Query Parameter NameExample
page_size75064513
page_tokenet nostrud aute reprehenderit
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
{
  "list_ids": [
    "7996178a-1f89-1d95-808a-ce981c30b758",
    "381c4df4-25f4-3625-63c0-63c6958b10cb",
    "31450b5e-88f5-1eee-d8b5-0c6ee2c5ae60",
    "aaba9ecf-e18b-967f-ece3-46ca3b72b3e1"
  ],
  "contacts": [
    {
      "address_line_1": "id",
      "address_line_2": "est reprehenderit proident",
      "alternate_emails": [
        "aute irure",
        "sed",
        "commodo in qui adipisicing veniam",
        "consectetur",
        "Duis fugiat sit labore"
      ],
      "city": "in",
      "country": "dolo",
      "email": "proident laborum",
      "first_name": "",
      "last_name": "sint non veniam",
      "postal_code": "nisi proident minim",
      "state_province_region": "occaecat cupid",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "ut est sunt",
      "address_line_2": "eiusmod aliquip labori",
      "alternate_emails": [
        "sit dolore in ",
        "ea proident Duis",
        "velit",
        "qui proident aute",
        "eu laboris incididunt eiusmod"
      ],
      "city": "et eiusmod",
      "country": "do irure",
      "email": "adipisicing nostrud",
      "first_name": "nostrud esse in",
      "last_name": "in adipisicing",
      "postal_code": "Excepteur veniam proident",
      "state_province_region": "aute et ",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "nulla laborum Duis sint consectetur",
      "address_line_2": "mollit ea anim aliquip est",
      "alternate_emails": [
        "Ut",
        "aliquip eu non",
        "proident anim exercitation est dolor",
        "cupidatat esse minim",
        "ex consectetur nulla cupidatat"
      ],
      "city": "pariatur adi",
      "country": "aliqua dolor aute",
      "email": "sunt sit nostrud",
      "first_name": "dolore Duis ea",
      "last_name": "labore exercita",
      "postal_code": "adipisicing pariatur id",
      "state_province_region": "sit",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "u",
      "address_line_2": "sit in ",
      "alternate_emails": [
        "cillum incididunt anim l",
        "sint incididunt sunt mollit proident",
        "sint non aliquip ipsum",
        "dolor sunt enim",
        "minim deserunt magna qui o"
      ],
      "city": "ut tempor",
      "country": "reprehenderit veniam non sint",
      "email": "velit nisi officia consectetur",
      "first_name": "aliqua ut",
      "last_name": "magna in mo",
      "postal_code": "eiusmod",
      "state_province_region": "ipsum dolor in eu",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "dolore laborum in ullamco dolore",
      "address_line_2": "consectetur Excepteur",
      "alternate_emails": [
        "sed veniam nisi consequat",
        "et non ut",
        "consectetur aliqua",
        "proident in Lorem aute",
        "ad est velit commodo"
      ],
      "city": "",
      "country": "Lorem la",
      "email": "magna laboris proident de",
      "first_name": "labore et",
      "last_name": "esse dese",
      "postal_code": "veniam Duis",
      "state_province_region": "qui aliqua",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "nostrud dolore Lorem",
      "address_line_2": "dolor incididunt Duis",
      "alternate_emails": [
        "proident aliqua",
        "Lorem ex",
        "nostrud cupidatat in dolor",
        "ut anim consequat cillum",
        "pariatur laboris proident"
      ],
      "city": "ex aliqua",
      "country": "ni",
      "email": "reprehenderit sunt",
      "first_name": "sed Lorem labore culpa eiusmod",
      "last_name": "adipisicing do pariatur qui",
      "postal_code": "quis",
      "state_province_region": "iru",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "pariatur deserunt fugiat laboris",
      "address_line_2": "cillum veniam ",
      "alternate_emails": [
        "amet culpa",
        "magna aliqua dolore",
        "sed nulla in",
        "non eu magna",
        "id amet ad"
      ],
      "city": "no",
      "country": "irure nisi laborum sit",
      "email": "voluptate consequat",
      "first_name": "nostrud c",
      "last_name": "dolor nisi volupt",
      "postal_code": "ut cillum et sunt irure",
      "state_province_region": "reprehenderit in ve",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "aliquip nostrud est laboris",
      "address_line_2": "laboris sunt sint si",
      "alternate_emails": [
        "ipsum tempor",
        "et adipisicing ni",
        "tempor",
        "ad",
        "ani"
      ],
      "city": "reprehenderit velit in exercitation aliquip",
      "country": "laboris sed",
      "email": "proident",
      "first_name": "ex",
      "last_name": "voluptate culpa",
      "postal_code": "mollit in culpa Excepteur dolor",
      "state_province_region": "id qui",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "nulla",
      "address_line_2": "ad cupidatat",
      "alternate_emails": [
        "",
        "ex sunt",
        "cupidatat",
        "fugiat mollit est",
        "id"
      ],
      "city": "nisi dolore",
      "country": "Duis enim Ut ",
      "email": "aliqua exercitation cillum",
      "first_name": "sint elit ",
      "last_name": "cillum sit aute ipsum dolor",
      "postal_code": "Duis reprehenderit qui mollit",
      "state_province_region": "ad ipsum",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "pariatur cupidatat in ad voluptate",
      "address_line_2": "sint sunt fugiat voluptate minim",
      "alternate_emails": [
        "irure in",
        "dolore Excepteur reprehenderit",
        "Lorem non ullamco proident exercitation",
        "aute ipsum",
        "consequat"
      ],
      "city": "velit ipsum nulla ullam",
      "country": "amet in eu do cupidatat",
      "email": "E",
      "first_name": "aute mollit nostrud do",
      "last_name": "ad labore consectetur",
      "postal_code": "dolor aute eiusmod in",
      "state_province_region": "sint ullamco",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    }
  ]
}
Response Payload
{
  "job_id": "dolore esse ea laborum eiusmod"
}
{
  "errors": [
    {
      "message": "enim ad Excepteur Duis",
      "field": "ullamco",
      "error_id": "consequat",
      "parameter": "laborum sunt dolor adipisicing voluptate"
    },
    {
      "message": "aute veniam magna sint in",
      "field": "aliquip officia eiusmod dolor",
      "error_id": "consectetur Duis",
      "parameter": "irure ut"
    },
    {
      "message": "sint officia enim consequat",
      "field": "in aute ut nisi sed",
      "error_id": "consectetur proident irure aliquip adipisicing",
      "parameter": "dolore nulla nostrud anim"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "mollit aliquip proident"
    },
    {
      "message": "nostrud occaecat adipisicing sit"
    }
  ]
}
Query Parameter NameExample
delete_all_contactsexercitation dolor anim
idsoccaecat in labore
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": "nulla ullamco"
    }
  ]
}
Request Payload
Response Payload
{
  "result": [
    {
      "id": "amet quis",
      "first_name": "nisi voluptate",
      "last_name": "do",
      "unique_name": "exercitation deserunt cupidatat",
      "email": "ex id adipisicing",
      "alternate_emails": [
        "sit enim",
        "occaecat exercitation incididunt aute",
        "nisi"
      ],
      "address_line_1": "laborum",
      "address_line_2": "ut id sit magna",
      "city": "Excepteur ea",
      "state_province_region": "in cillum do ut deserunt",
      "country": "eiusmod in Ut",
      "postal_code": "cupidatat ad",
      "phone_number": "enim id nisi",
      "whatsapp": "eu velit dolor amet qui",
      "line": "ut",
      "facebook": "laboris voluptate",
      "list_ids": [
        "pariatur enim",
        "velit",
        "officia ex"
      ],
      "segment_ids": [
        "cillum",
        "commodo mollit",
        "quis et nulla voluptate commodo"
      ],
      "custom_fields": {},
      "created_at": "dolore veniam",
      "updated_at": "eu",
      "_metadata": {
        "self": "eiusmod deserunt adipisicing est"
      }
    },
    {
      "id": "eu consequat",
      "first_name": "Lorem",
      "last_name": "velit",
      "unique_name": "incididunt Lorem occaecat veniam",
      "email": "cillum",
      "alternate_emails": [
        "dolor"
      ],
      "address_line_1": "exercitation ut Excepteur in nulla",
      "address_line_2": "proident",
      "city": "Duis dolore do",
      "state_province_region": "fugiat tempor id",
      "country": "non tempor laboris dolore",
      "postal_code": "nostrud qui dolore",
      "phone_number": "quis ut id",
      "whatsapp": "minim est consectetur",
      "line": "consequat aliqua aute aliquip",
      "facebook": "nostrud dolor culpa ipsum cillum",
      "list_ids": [
        "dolore",
        "nisi laborum eiusmod",
        "adipisicing",
        "eiusmod"
      ],
      "segment_ids": [
        "sit exercitation"
      ],
      "custom_fields": {},
      "created_at": "aliquip ullamco minim occaecat pariatur",
      "updated_at": "dolore commodo",
      "_metadata": {
        "self": "dolore"
      }
    },
    {
      "id": "dolore ex nisi proident",
      "first_name": "pariatur laborum",
      "last_name": "voluptate",
      "unique_name": "deserunt consectetur ullamco aliqua",
      "email": "Lorem pariatur",
      "alternate_emails": [
        "eu laboris sit ullamco ad",
        "in quis"
      ],
      "address_line_1": "cillum nisi anim",
      "address_line_2": "anim in nulla",
      "city": "sit sint amet",
      "state_province_region": "ex est",
      "country": "in",
      "postal_code": "mollit eiusmod ut",
      "phone_number": "sit qui ipsum",
      "whatsapp": "aliquip Duis est",
      "line": "voluptate nisi Ut",
      "facebook": "laborum",
      "list_ids": [
        "adipisicing et nisi",
        "aute"
      ],
      "segment_ids": [
        "voluptate sunt",
        "aute amet et officia",
        "aliqua laboris in dolore deserunt",
        "esse cillum Duis irure"
      ],
      "custom_fields": {},
      "created_at": "ut in",
      "updated_at": "Excepteur ut fugiat qui commodo",
      "_metadata": {
        "self": "ut quis"
      }
    },
    {
      "id": "veniam Lorem culpa Excepteur Ut",
      "first_name": "elit cupidatat pariatur laborum exercitation",
      "last_name": "ex",
      "unique_name": "dolor esse anim adipisicing Duis",
      "email": "aliquip",
      "alternate_emails": [
        "veniam dolor irure culpa reprehenderit"
      ],
      "address_line_1": "aliquip",
      "address_line_2": "consectetur et dolor aliqua",
      "city": "commodo laborum",
      "state_province_region": "dolore officia amet est minim",
      "country": "proident quis sunt fugiat",
      "postal_code": "Duis sint adipisicing proident ut",
      "phone_number": "veniam adipisicing Excepteur eu dolor",
      "whatsapp": "Lorem veniam",
      "line": "Duis",
      "facebook": "eiusmod quis deserunt Lorem proident",
      "list_ids": [
        "ex magna aliquip",
        "irure in sint dolore",
        "non sunt",
        "adipisicing velit quis id",
        "id dolor qui"
      ],
      "segment_ids": [
        "occaecat",
        "ut",
        "Duis cillum adipisicing veniam",
        "aute in ullamco culpa proident"
      ],
      "custom_fields": {},
      "created_at": "nostrud proident cupidatat Duis",
      "updated_at": "in amet",
      "_metadata": {
        "self": "ea aute mollit nulla"
      }
    }
  ],
  "_metadata": {
    "self": "Lorem dolor"
  },
  "contact_count": 5318868
}
{
  "errors": [
    {
      "message": "laboris incididunt irure et anim",
      "field": "sunt nostrud ullamco",
      "error_id": "et",
      "parameter": "voluptate"
    },
    {
      "message": "deserunt aliqua aute enim",
      "field": "ex",
      "error_id": "est dolore in",
      "parameter": "veniam minim"
    },
    {
      "message": "consectetur laborum nisi",
      "field": "dolor sunt commodo do",
      "error_id": "officia fugiat ea do",
      "parameter": "Duis"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "anim cillum"
    },
    {
      "message": "veniam irure sed commodo"
    },
    {
      "message": "magna commodo"
    }
  ]
}
Request Payload
Response Payload
{
  "contact_count": 7412858,
  "billable_count": 6357840,
  "billable_breakdown": {
    "total": 41091355,
    "breakdown": {}
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "aliquip"
    },
    {
      "message": "id ipsum dolor ex"
    },
    {
      "message": "nisi sed voluptate minim nulla"
    },
    {
      "message": "nulla"
    }
  ]
}
Request Payload
{
  "list_ids": [
    "3f1f1846-e4ce-90ec-cf1a-74b4bc57fe65",
    "e159c842-1eae-f681-6ab5-57663b6d335a",
    "140c263e-fc18-2744-3cc9-eef819a75a71",
    "98ab7340-9b45-56aa-e362-cff52f25d27e"
  ],
  "segment_ids": [
    "nisi sunt",
    "Excepteur est voluptate nisi",
    "laboris et aute culpa fugiat"
  ],
  "notifications": {
    "email": false
  },
  "file_type": "json",
  "max_file_size": -34012223
}
Response Payload
{
  "_metadata": {
    "prev": "https://UIIwhaocWdLSSNUWuHxdVaYkOKYeou.emmJDk3QZ5CgT.mWR,o+uCizXXygX2Hp,4VLQJWiSsmJPDmltK",
    "self": "https://mvOpalTLskMQwOTt.gteokxXvIPka2Tqs.Ya5Y88xcGiG+WyPcm",
    "next": "http://fc.vtbUfg5Za+W-uFvE0FoNsQ",
    "count": -35607347.42194409
  },
  "id": "ad pariatur dolore eiusmod"
}
{
  "errors": [
    {
      "message": "nulla",
      "field": "in officia occaecat eiusmod",
      "error_id": "pariatur",
      "parameter": "ea"
    },
    {
      "message": "in",
      "field": "culpa",
      "error_id": "sunt nostrud Ut est",
      "parameter": "nisi ea"
    },
    {
      "message": "laborum voluptate nulla incididunt adipisicing",
      "field": "anim culpa incididunt et adipisicing",
      "error_id": "ex ut laborum",
      "parameter": "ipsum"
    },
    {
      "message": "ut consequat est",
      "field": "dolor commodo nostrud",
      "error_id": "velit commodo dolore ea",
      "parameter": "anim consequat"
    },
    {
      "message": "nulla proident amet officia Lorem",
      "field": "consequat nisi",
      "error_id": "eiusmod Excepteur",
      "parameter": "esse"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "qui laborum et ut"
    },
    {
      "message": "laborum reprehenderit ut"
    },
    {
      "message": "voluptate amet velit dolor"
    },
    {
      "message": "fugiat occaecat nisi"
    }
  ]
}
Request Payload
Response Payload
{
  "result": [
    {
      "id": "ullamco qui Lorem pariatur incididunt",
      "status": "Excepteur amet",
      "created_at": "aute qui ut",
      "completed_at": "adipisicing laborum esse",
      "expires_at": "enim irure sed laboris non",
      "urls": [
        "in ex quis culpa"
      ],
      "user_id": "Duis minim incididunt",
      "export_type": "consequat proident",
      "segments": [
        {
          "ID": "nulla anim aliqua",
          "Name": "incididunt adipisicing est"
        },
        {
          "ID": "exercitation laboris ad",
          "Name": "pariatur aliqua in occaecat"
        }
      ],
      "lists": [
        {
          "ID": "ea eu",
          "Name": "in do eiusmod"
        },
        {
          "ID": "sint cillum",
          "Name": "proident nostrud ipsum"
        },
        {
          "ID": "mollit sed Duis eiusmod",
          "Name": "non mollit sunt nulla"
        }
      ],
      "_metadata": {
        "prev": "ad veniam",
        "self": "dolor",
        "next": "sit"
      }
    },
    {
      "id": "eu amet deserunt ut id",
      "status": "exercitation",
      "created_at": "veniam sunt",
      "completed_at": "ad aliquip qui",
      "expires_at": "consequat elit sint",
      "urls": [
        "amet irure"
      ],
      "user_id": "nulla dolore qui ut sit",
      "export_type": "in Excepteur fugiat sit adipisicing",
      "segments": [
        {
          "ID": "aliqua dolor ea",
          "Name": "nulla in tempor fugiat Duis"
        },
        {
          "ID": "minim cillum non",
          "Name": "voluptate et tempor consectetur"
        },
        {
          "ID": "eu quis ipsum",
          "Name": "eu commodo ipsum Lorem ut"
        },
        {
          "ID": "in dolore ut anim",
          "Name": "est amet in"
        },
        {
          "ID": "qui mollit eu ut labore",
          "Name": "in proident nostrud et aute"
        }
      ],
      "lists": [
        {
          "ID": "dolore incididunt",
          "Name": "enim minim eiusmod aliqua fugiat"
        },
        {
          "ID": "fugiat dolor non aliqua",
          "Name": "Lorem deserunt labore aliqua proident"
        },
        {
          "ID": "sint",
          "Name": "ad"
        },
        {
          "ID": "ad non cillum",
          "Name": "anim velit nostrud culpa"
        }
      ],
      "_metadata": {
        "prev": "in eu",
        "self": "deserunt",
        "next": "ut"
      }
    },
    {
      "id": "consequat sint deserunt",
      "status": "Excepteur et Ut",
      "created_at": "nostrud nisi eu nulla Lorem",
      "completed_at": "dolor velit aliquip",
      "expires_at": "ea in sed culpa",
      "urls": [
        "sed aliquip",
        "eu esse laborum irure in",
        "ipsum"
      ],
      "user_id": "ex dolore ullamco nostrud",
      "export_type": "ut",
      "segments": [
        {
          "ID": "magna consectetur ipsum",
          "Name": "id nulla ad"
        },
        {
          "ID": "velit anim ad",
          "Name": "aliquip officia qui do anim"
        }
      ],
      "lists": [
        {
          "ID": "ipsum",
          "Name": "veniam culpa in voluptate"
        },
        {
          "ID": "commodo incididunt",
          "Name": "officia aliquip et"
        },
        {
          "ID": "laboris fugiat aliquip Ut nostrud",
          "Name": "ex sunt eu"
        },
        {
          "ID": "officia ipsum minim occaecat exercitation",
          "Name": "ullamco et magna Duis"
        },
        {
          "ID": "ex nostrud dolore",
          "Name": "magna occaecat"
        }
      ],
      "_metadata": {
        "prev": "adipisicing culpa magna",
        "self": "ipsum commodo occaecat",
        "next": "laborum dolore Lorem in"
      }
    },
    {
      "id": "officia et magna est ullamco",
      "status": "laboris",
      "created_at": "cupidatat tempor velit dolore",
      "completed_at": "elit",
      "expires_at": "irure dolore sunt esse",
      "urls": [
        "labore qui mollit",
        "consequat quis aliquip"
      ],
      "user_id": "nostrud ex",
      "export_type": "Ut",
      "segments": [
        {
          "ID": "fugiat velit",
          "Name": "exercitation aute cupidatat nisi"
        },
        {
          "ID": "ut in do officia",
          "Name": "do tempor consectetur"
        }
      ],
      "lists": [
        {
          "ID": "enim adipisicing in",
          "Name": "anim"
        }
      ],
      "_metadata": {
        "prev": "cupidatat do esse velit",
        "self": "commodo pariatur",
        "next": "quis anim pariatur"
      }
    }
  ],
  "_metadata": {
    "prev": "Lorem reprehenderit consectetur",
    "self": "ipsum occaecat irure reprehenderit",
    "next": "magna"
  }
}
{
  "errors": [
    {
      "message": "sed ut fugiat elit",
      "": "velit voluptate non consequat",
      "error_id": "eu culpa occaecat cillum"
    },
    {
      "message": "nulla",
      "": "non ad deserunt",
      "error_id": "anim fugiat nostrud"
    },
    {
      "message": "incididunt ut laboris ipsum enim",
      "": "non commodo",
      "error_id": "nostrud quis est fugiat"
    },
    {
      "message": "ex",
      "": "aliqua",
      "error_id": "sed cupidatat dolor"
    },
    {
      "message": "sint Duis",
      "": "laboris incididunt dolore labore consectetur",
      "error_id": "dolore"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "exercitation Ut aliqua ullamco occaecat"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "pariatur",
  "first_name": "eu",
  "last_name": "officia Excepteur in aliquip dolor",
  "unique_name": "in labore magna quis",
  "email": "anim officia",
  "alternate_emails": [
    "anim labore nisi quis dolore"
  ],
  "address_line_1": "velit nulla",
  "address_line_2": "Duis in incididunt Ut",
  "city": "ut commodo",
  "state_province_region": "adipisicing veniam",
  "country": "dolor do",
  "postal_code": "elit",
  "phone_number": "ut",
  "whatsapp": "nisi dolor ut exercitation in",
  "line": "dolore velit eu",
  "facebook": "Lorem exercitation aliqua sed",
  "list_ids": [
    "nisi mollit ut ipsum do",
    "reprehenderit ad"
  ],
  "segment_ids": [
    "ut mollit",
    "dolore velit aliqua"
  ],
  "custom_fields": {},
  "created_at": "quis ad",
  "updated_at": "proident aute cillum",
  "_metadata": {
    "self": "esse dolore"
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "Ut elit enim sit"
    },
    {
      "message": "esse in dolore ea"
    },
    {
      "message": "laboris exercitation nisi sunt est"
    },
    {
      "message": "occaecat exercitation pariatur mollit"
    }
  ]
}
Request Payload
{
  "query": "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')"
}
Response Payload
{
  "result": [
    {
      "id": "fugiat ea",
      "first_name": "velit eu pariatur in",
      "last_name": "proident",
      "unique_name": "in nisi ipsum",
      "email": "voluptate consequat cillum",
      "alternate_emails": [
        "cillum minim proident veniam",
        "do tempor",
        "voluptate magna dolor elit Lorem",
        "Lorem non ad in",
        "pariatur"
      ],
      "address_line_1": "Ut mollit eu aute proident",
      "address_line_2": "adipisicing cillum elit nulla",
      "city": "est commodo incididunt enim",
      "state_province_region": "in",
      "country": "commodo in id ut ullamco",
      "postal_code": "pariatur laborum",
      "phone_number": "Excepteur eiusmod do dolor ut",
      "whatsapp": "aliqua commodo ullamco exercitation",
      "line": "adipisicing",
      "facebook": "ipsum ut esse ut qui",
      "list_ids": [
        "sit",
        "dolore veniam aliquip velit cillum",
        "ut dolor in",
        "anim magna",
        "cupidatat"
      ],
      "segment_ids": [
        "Excepteur nostrud laborum reprehenderit enim"
      ],
      "custom_fields": {},
      "created_at": "dolore consequat tempor",
      "updated_at": "eiusmod esse Lorem Ut veniam",
      "_metadata": {
        "self": "Lorem velit deserunt eiusmod sit"
      }
    },
    {
      "id": "dolore enim",
      "first_name": "laborum eiusmod",
      "last_name": "ipsum minim",
      "unique_name": "deserunt qui adipisicing aute occaecat",
      "email": "aute occaecat est cillum",
      "alternate_emails": [
        "velit Ut consequat elit ipsum",
        "in"
      ],
      "address_line_1": "officia eu est",
      "address_line_2": "dolore laboris",
      "city": "sunt ut dolore",
      "state_province_region": "non in pariatur Excepteur",
      "country": "do",
      "postal_code": "irure tempor esse",
      "phone_number": "dolore in elit aliqua fugiat",
      "whatsapp": "velit et",
      "line": "quis ex Ut cillum laboris",
      "facebook": "incididunt",
      "list_ids": [
        "ex",
        "pariatur ea dolor voluptate",
        "deserunt in enim nisi ut",
        "ea",
        "do"
      ],
      "segment_ids": [
        "voluptate exercitation reprehenderit",
        "ex in laborum pariatur",
        "sint in in adipisicing"
      ],
      "custom_fields": {},
      "created_at": "occaecat ad minim",
      "updated_at": "minim mollit Duis dolor eu",
      "_metadata": {
        "self": "laboris culpa sunt Lorem"
      }
    },
    {
      "id": "non incididunt dolore ut ea",
      "first_name": "Ut",
      "last_name": "Duis in consequat in",
      "unique_name": "et deserunt ea",
      "email": "fugiat cupidatat labore Duis incididunt",
      "alternate_emails": [
        "laboris ex eu magna irure",
        "amet laboris eiusmod",
        "laborum nostrud aliquip sit est"
      ],
      "address_line_1": "Ut dolore magna adipisicing",
      "address_line_2": "dolor veniam eu",
      "city": "dolore qui exercitation aute occaecat",
      "state_province_region": "id",
      "country": "mollit",
      "postal_code": "veniam quis pariatur sunt dolor",
      "phone_number": "sit",
      "whatsapp": "cupidatat",
      "line": "deserunt",
      "facebook": "Ut dolore aliquip tempor",
      "list_ids": [
        "amet aute in",
        "consectetur veniam",
        "cillum qui"
      ],
      "segment_ids": [
        "anim adipisicing tempor"
      ],
      "custom_fields": {},
      "created_at": "aliquip",
      "updated_at": "irure anim ullamco officia in",
      "_metadata": {
        "self": "Lorem elit exercitation est"
      }
    }
  ],
  "_metadata": {
    "self": "ipsum eiusmod minim"
  },
  "contact_count": -34565973.49955581
}
{
  "errors": [
    {
      "field": "sit officia",
      "message": "ea consectetur"
    },
    {
      "field": "enim cupidatat pariatur ad",
      "message": "exercitation eu cillum reprehenderit"
    },
    {
      "field": "magna sed dolor",
      "message": "reprehenderit esse anim"
    },
    {
      "field": "nulla eu pariatur",
      "message": "et ut do sit"
    }
  ]
}
{
  "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": "fugiat"
    },
    {
      "message": "consequat mollit"
    }
  ]
}
Request Payload
{
  "list_ids": [
    "culpa magna fugiat cillum id",
    "in aliqua"
  ],
  "file_type": "csv",
  "field_mappings": [
    "irure"
  ]
}
Response Payload
{
  "job_id": "et qui exercitation",
  "upload_uri": "veniam Lorem",
  "upload_headers": [
    {
      "header": "quis id",
      "value": "cillum voluptate sunt"
    },
    {
      "header": "aute ex ea eiusmod",
      "value": "exercitation ullamco aliquip"
    },
    {
      "header": "aliquip",
      "value": "eu"
    },
    {
      "header": "reprehenderit deserunt",
      "value": "amet aute non"
    },
    {
      "header": "minim sint ex pariatur Duis",
      "value": "sed magna sit eu"
    }
  ]
}
{
  "errors": [
    {
      "message": "cillum occaecat Ut",
      "field": "proident Excepteur deserunt ex ad",
      "error_id": "sint eu sed in",
      "parameter": "tempor Ut officia sunt amet"
    },
    {
      "message": "anim quis consectetur",
      "field": "et nostrud",
      "error_id": "ipsum id nostrud eiusmod commodo",
      "parameter": "ullamco proident Excepteur"
    },
    {
      "message": "Duis et",
      "field": "adipisicing ullamco",
      "error_id": "ipsum enim sed sint velit",
      "parameter": "sint nostrud ex exercitation"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "voluptate consequat quis mollit",
      "field": "et mollit fugiat sit",
      "error_id": "labore dolor nostrud occaecat",
      "parameter": "consequat eiusmod ex in"
    },
    {
      "message": "anim ut labore aute deserunt",
      "field": "nostrud culpa do cillum Lorem",
      "error_id": "consectetur consequat",
      "parameter": "amet"
    },
    {
      "message": "Ut quis incididunt id adipisicing",
      "field": "fugiat incididunt Ut sit",
      "error_id": "consectetur cillum in et",
      "parameter": "laboris labore magna fugiat quis"
    },
    {
      "message": "ad in elit deserunt culpa",
      "field": "velit ut",
      "error_id": "aliquip nisi do ut id",
      "parameter": "nostrud sed est tempor"
    }
  ]
}
{
  "errors": [
    {
      "message": "nostrud qui"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "pariatur sunt labore velit",
  "status": "reprehenderit",
  "job_type": "dolor",
  "results": {
    "requested_count": 3794684.429589525,
    "created_count": -84400181.46864748,
    "updated_count": 35478478.13645637,
    "deleted_count": 1486784.1707296968,
    "errored_count": -16215985.297127306,
    "errors_url": "Lorem sed dolore"
  },
  "started_at": "Lorem officia velit",
  "finished_at": "sed tempor consequat laboris"
}
{
  "errors": {
    "message": "ut pariatur amet",
    "field": "culpa consequat ut",
    "error_id": "quis mollit",
    "parameter": "in"
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "non ea minim ut Excepteur"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "dolore exercitation adipisicing occaecat",
  "status": "failure",
  "created_at": "nostrud quis veniam velit reprehenderit",
  "updated_at": "ipsum sunt cillum",
  "completed_at": "veniam id",
  "expires_at": "dolore elit",
  "urls": [
    "in mollit Duis in",
    "adipisicing"
  ],
  "message": "Duis in esse laboris culpa",
  "_metadata": {
    "prev": "http://fghbkiEmdBeOFmUQAWvZQQxYFHqTwMfE.agm+oBGI4g4CDEj34sD-SXubYfRJVmNw0t",
    "self": "http://poZGGPYeGdnmGHmqn.ojtfOnsCg+8oAvfJjFjm7nKKzx5MzqaBgt5",
    "next": "http://vr.nqrdPzqOwgxaU,AMbhPIGZHlAQ",
    "count": -198211.84910173714
  },
  "contact_count": -27493017
}
{
  "errors": [
    {
      "message": "do",
      "field": "deserunt voluptate exercitation dolore pariatur",
      "error_id": "enim pariatur Ut",
      "parameter": "exercitation ut"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "fugiat"
    },
    {
      "message": "ex sunt"
    }
  ]
}
Request Payload
{
  "ids": [
    "1234",
    "1235"
  ]
}
Response Payload
{
  "result": [
    {
      "id": "exercitation",
      "first_name": "est tempor",
      "last_name": "ad adipisicing Lorem dolor ipsum",
      "unique_name": "deserunt do",
      "email": "exercitation labore deserunt veniam adipisicing",
      "alternate_emails": [
        "qui",
        "ut ex",
        "pariatur proident sint et elit",
        "amet",
        "consequat veniam adipisicing"
      ],
      "address_line_1": "reprehenderit in irure veniam",
      "address_line_2": "Excepteur commodo",
      "city": "magna ut",
      "state_province_region": "sint ut deserunt",
      "country": "ad",
      "postal_code": "sunt",
      "phone_number": "magna consectetur",
      "whatsapp": "proident exercitation enim",
      "line": "irure sunt labore",
      "facebook": "voluptate nisi",
      "list_ids": [
        "qui ex",
        "officia Excepteur eu non ad"
      ],
      "segment_ids": [
        "reprehenderit",
        "qui ex fugiat",
        "laborum incididunt sunt ut aliqua",
        "nisi fugiat incididunt qui in"
      ],
      "custom_fields": {},
      "created_at": "esse minim Duis",
      "updated_at": "dolor",
      "_metadata": {
        "self": "Excepteur dolor in ut est"
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "et laborum in cillum"
    }
  ]
}
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": "fugiat tempor proident reprehenderit"
    },
    {
      "message": "occaecat proident ad"
    },
    {
      "message": "laborum incididunt in"
    },
    {
      "message": "amet nisi"
    },
    {
      "message": "labore id velit est do"
    }
  ]
}

Segmenting Contacts V2 - Beta(5 operations)

Request Payload
{
  "name": "officia",
  "parent_list_ids": [
    "Lorem ex ullamco",
    "adipisicing amet in in",
    "anim sint",
    "proident",
    "mollit ea veniam consectetur enim"
  ],
  "query_dsl": "dolor cillum velit"
}
Response Payload
{
  "id": "fe5dea9c-16e4-e477-beea-6c6f5ec831ff",
  "name": "sit est non velit fugiat",
  "query_dsl": "occaecat consequat laborum deserunt",
  "contacts_count": -44427531,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "dolor",
  "updated_at": "proident exercitation id elit",
  "sample_updated_at": "culpa Lorem do sint",
  "next_sample_update": "sint",
  "parent_list_ids": [
    "tempor nostrud",
    "ad enim exercitation Ut",
    "laboris",
    "veniam nisi sed dolor aliqua",
    "non tempor Lorem ullamco"
  ],
  "query_version": "pariatur voluptate",
  "status": {
    "query_validation": "mollit reprehenderit",
    "error_message": "minim fugiat"
  }
}
{
  "errors": [
    {
      "field": "anim enim ea Excepteur Lorem",
      "message": "voluptate ullamco deserunt aute et"
    }
  ]
}
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": "id proident enim voluptate dolore",
      "message": "irure"
    }
  ]
}
Query Parameter NameExample
parent_list_idsvelit nostrud do deserunt
no_parent_list_idtrue
Request Payload
Response Payload
{
  "id": "053a1825-fad0-32c4-4b28-27a5ec388e78",
  "name": "laborum consecte",
  "contacts_count": -19503934,
  "created_at": "sunt officia adipisicing veniam elit",
  "updated_at": "ad culpa aliqua dolore",
  "sample_updated_at": "qui",
  "next_sample_update": "deserunt enim eu",
  "parent_list_ids": [
    "sunt",
    "pariatur in aute",
    "dolore irure adipisicing eiusmod ea",
    "enim amet voluptate fugiat incididunt",
    "deserunt sit id"
  ],
  "query_version": "laborum adipisicing dolor eu commodo",
  "_metadata": {
    "prev": "http://nlBaTWBEjNzroUNvBDxCESQNIDwsIvWQ.vfjfCwNrcTAEdzDo",
    "self": "https://bxDkyEWqlynhkeIJqxYf.kundCbl8xeFV7dmv6Q6WkL,u.cB9y+bkGRpS4ihshmGrlVUz",
    "next": "https://SXduJmNiUlMTlAGIckQzDiafUgIQYUrQ.ilxo8P2DEWyd,C0zw75v3YlfU5ZK1v2YHTrb-0o",
    "count": 64384939
  },
  "status": {
    "query_validation": "voluptate",
    "error_message": "ullamco ad"
  }
}
{
  "errors": [
    {
      "field": "voluptate et non sed",
      "message": "Duis adipisicing eiusmod qui"
    },
    {
      "field": "aliquip in incididunt qui sit",
      "message": "adipisicing Duis ad"
    },
    {
      "field": "Duis ex sed",
      "message": "reprehenderit ea ut"
    },
    {
      "field": "dolore Excepteur culpa in",
      "message": "officia consectetur do commodo"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "quis aliqua do Excepteur",
      "message": "esse dolor in"
    },
    {
      "field": "Excepteur dolor eu",
      "message": "eiusmod aute voluptate et"
    },
    {
      "field": "exercitation elit",
      "message": "culpa adipisicing"
    }
  ]
}
Request Payload
{
  "name": "deserunt voluptate ",
  "query_dsl": "voluptate in labore consequat quis"
}
Response Payload
{
  "id": "ae0101ed-ea32-a41d-a5f2-6bb0ca87584e",
  "name": "ad anim",
  "query_dsl": "pariatur non dolor laboris id",
  "contacts_count": -55571684,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "mollit",
  "updated_at": "dolor dolor commodo",
  "sample_updated_at": "sunt in aliqua",
  "next_sample_update": "minim voluptate",
  "parent_list_ids": [
    "amet veniam ex cupidatat",
    "ullamco",
    "sint laboris tempor consequat",
    "irure commodo deserunt incididunt sed",
    "magna eiusmod"
  ],
  "query_version": "tempor Excepteur esse",
  "status": {
    "query_validation": "sunt culpa laboris",
    "error_message": "aute"
  }
}
{
  "errors": [
    {
      "field": "Lorem",
      "message": "incididunt pariatur ipsum"
    },
    {
      "field": "dolor",
      "message": "nulla"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "cupidatat sed consequat",
      "message": "cillum aliquip culpa Ut"
    }
  ]
}
Query Parameter NameExample
contacts_samplefalse
Request Payload
Response Payload
{
  "id": "fa46e6c9-1941-a67a-76f2-640d716d7d88",
  "name": "qui ad",
  "query_dsl": "ipsum anim aliqua",
  "contacts_count": 1497359,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "anim",
  "updated_at": "fugiat",
  "sample_updated_at": "dolore enim",
  "next_sample_update": "est in",
  "parent_list_ids": [
    "occaecat minim"
  ],
  "query_version": "Excepteur",
  "status": {
    "query_validation": "non proident nisi dolor",
    "error_message": "fugiat"
  }
}
{
  "errors": [
    {
      "field": "eu qui",
      "message": "in laborum magna nulla"
    },
    {
      "field": "pariatur",
      "message": "dolor"
    }
  ]
}
{
  "errors": [
    {
      "field": "mollit",
      "message": "elit ad anim ullamco"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "occaecat cupidatat dolore et",
      "message": "incididunt sed ut deserunt dolor"
    },
    {
      "field": "dolor sit consequat pariatur ut",
      "message": "irure enim ad ullamco"
    },
    {
      "field": "culpa",
      "message": "anim occaecat commodo ea ut"
    },
    {
      "field": "amet irure mollit",
      "message": "veniam in dolor nostrud"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "Excepteur",
      "message": "cillum consequat dolor sed voluptate"
    },
    {
      "field": "magna ut",
      "message": "Excepteur nulla nostrud"
    }
  ]
}

Senders

Header NameExample
on-behalf-of"incididunt sint do proident elit"
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 laboris occaecat"
    }
  ]
}

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

segmenting contacts(5 operations)

Request Payload
{
  "name": "ex dolor consequat sed labore",
  "parent_list_ids": [
    "officia nulla",
    "ipsum"
  ],
  "query_dsl": "ut ex consectetur",
  "parent_list_id": "693504cd-9509-0db0-fecc-fff2e554cbbd"
}
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": "veniam"
    },
    {
      "message": "cupidatat irure fugiat adipisicing anim"
    }
  ]
}
Query Parameter NameExample
parent_list_idsea eiusmod enim officia
no_parent_list_idfalse
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": "dolor"
    },
    {
      "message": "sit"
    },
    {
      "message": "officia ipsum deserunt proident"
    },
    {
      "message": "dolore ut mollit Lorem ipsum"
    }
  ]
}
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": [
    {
      "message": "ullamco sit eiusmod fugiat",
      "field": "in"
    },
    {
      "message": "ut",
      "field": "sint"
    },
    {
      "message": "sed Ut laborum dolor sint",
      "field": "in commodo"
    },
    {
      "message": "commodo in tempor sit in",
      "field": "laborum exercitation qui"
    },
    {
      "message": "et irure id non",
      "field": "dolor ipsum dolore sed irure"
    }
  ]
}
{
  "errors": [
    {
      "message": "laboris aliquip"
    },
    {
      "message": "nulla eiusmod Duis"
    },
    {
      "message": "occaecat quis ad"
    },
    {
      "message": "ad sint anim"
    },
    {
      "message": "aute ullamco Duis tempor"
    }
  ]
}
Request Payload
{
  "name": "in sint",
  "parent_list_ids": [
    "ut aliquip cillum cupidatat velit",
    "non id ad culpa est",
    "nulla id officia in ut"
  ],
  "query_dsl": "nulla eu amet eiusmod ut"
}
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": [
    {
      "message": "reprehenderit incididunt",
      "field": "aliquip dolor velit"
    },
    {
      "message": "aute dolore mollit",
      "field": "enim dolore sit"
    }
  ]
}
{
  "errors": [
    {
      "message": "eiusmod"
    },
    {
      "message": "velit enim adipisicing"
    }
  ]
}
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": "consequat eu dolor cupidatat sed",
      "field": "commodo"
    },
    {
      "message": "elit magna id consequat",
      "field": "adipisicing sed Excepteur esse dolor"
    },
    {
      "message": "commodo pariatur dolor laborum incididunt",
      "field": "ut cillum pariatur et"
    },
    {
      "message": "reprehenderit",
      "field": "in"
    },
    {
      "message": "sunt tempor eiusmod nulla culpa",
      "field": "proident"
    }
  ]
}
{
  "errors": [
    {
      "message": "laboris irure ut Lorem"
    },
    {
      "message": "deserunt ad voluptate occaecat"
    }
  ]
}

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": [
    {
      "id": "dolore veniam est sit",
      "error": "culpa esse cupidatat dolore labore",
      "resources": {
        "type": "consectetur",
        "ids": [
          "dolore ullamco laborum incididunt deserunt",
          "ad in deserunt nisi",
          "enim cupidatat",
          "qui culpa"
        ]
      }
    },
    {
      "id": "exercitation minim",
      "error": "officia veniam dolore est",
      "resources": {
        "type": "cillum ipsum ut voluptate",
        "ids": [
          "do",
          "sed sit qui amet nisi",
          "fugiat Excepteur ea officia"
        ]
      }
    }
  ]
}
{}
{
  "errors": [
    {
      "field": "id adipisicing culpa cupidatat",
      "message": "magna commodo Lorem"
    },
    {
      "field": "non velit ea qui",
      "message": "labore exercitation est ut"
    },
    {
      "field": "laboris veniam",
      "message": "in Duis"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "culpa officia"
    },
    {
      "message": "in ex"
    },
    {
      "message": "nostrud ullamco adipisicing minim anim"
    },
    {
      "message": "nostrud aute qui in cillum"
    }
  ]
}

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": [
    {
      "field": "eu",
      "message": "et ex",
      "error_id": "deserunt nostrud id Excepteur"
    },
    {
      "field": "quis nostrud velit deserunt",
      "message": "dolore",
      "error_id": "deserunt dolor in"
    },
    {
      "field": "ullamco",
      "message": "elit minim sit",
      "error_id": "ex enim"
    },
    {
      "field": "aute incididunt reprehenderit Duis ipsum",
      "message": "laboris Lorem adipisicing nulla",
      "error_id": "laboris proident aute nisi reprehenderit"
    }
  ]
}
{
  "errors": [
    {
      "field": "reprehenderit",
      "message": "ut enim cillum ex",
      "error_id": "consectetur dolor ea in adipisicing"
    },
    {
      "field": "Lorem in",
      "message": "ullamco aute",
      "error_id": "enim"
    },
    {
      "field": "aute dolore nulla do",
      "message": "id quis incididunt",
      "error_id": "in"
    }
  ]
}
Query Parameter NameExample
page_size-86513759
page_tokenex Duis mollit consectetur
Request Payload
Response Payload
{
  "result": [
    {
      "id": "533e3274-8e86-9db7-e93b-34faf1e9e08d",
      "name": "eu esse",
      "abtest": null,
      "status": "scheduled",
      "categories": [
        "ut sit sed aliquip",
        "ex nisi sit",
        "ad aute officia ipsum",
        "laboris",
        "culpa",
        "elit labore ullamco",
        "quis",
        "Duis sed nulla enim dolore",
        "dolore",
        "non reprehenderit"
      ],
      "send_at": "1924-01-09T02:01:36.0Z",
      "is_abtest": false,
      "updated_at": "1914-07-31T23:59:42.0Z",
      "created_at": "1948-08-04T23:06:27.0Z"
    },
    {
      "id": "7cc100fe-2225-f6a9-3fcd-752bc376e282",
      "name": "adipisicing mollit",
      "abtest": null,
      "status": "scheduled",
      "categories": [
        "ea dolore laboris id qui",
        "labore exercitation minim laborum",
        "amet eu",
        "sit",
        "deserunt eu",
        "minim incididunt",
        "ullamco",
        "Duis",
        "ea eu in minim",
        "nostrud"
      ],
      "send_at": "1968-02-17T21:06:56.0Z",
      "is_abtest": true,
      "updated_at": "1938-01-24T23:54:14.0Z",
      "created_at": "1901-06-15T23:01:13.0Z"
    },
    {
      "id": "8f4574ca-0ce5-d1d7-4e99-7cf24b138c65",
      "name": "dolor deserunt",
      "abtest": {
        "type": "content",
        "winner_criteria": "open",
        "test_percentage": -75877512,
        "duration": "exercitation ipsum dolore adipisicing",
        "winning_template_id": "id incididunt",
        "winner_selected_at": "quis ut eiusmod proident",
        "expiration_date": "proident ex do"
      },
      "status": "draft",
      "categories": [
        "eiusmod amet",
        "ex ad",
        "incididunt pariatur cupidatat voluptate enim",
        "non aute amet",
        "incididunt ad aute",
        "Duis dolor fugiat laborum",
        "adipisicing pariatur voluptate Duis",
        "qui consectetur",
        "non",
        "sint amet ad reprehenderit"
      ],
      "send_at": "1926-02-24T04:19:05.0Z",
      "is_abtest": true,
      "updated_at": "1913-07-21T10:18:56.0Z",
      "created_at": "1907-05-09T23:21:47.0Z"
    },
    {
      "id": "ad38eedd-40d6-fc0a-c0f4-92a88e75ac63",
      "name": "ut eiusmod fugiat",
      "abtest": null,
      "status": "triggered",
      "categories": [
        "culpa aliqua anim in eiusmod",
        "tempor consectetur",
        "non",
        "voluptate dolor incididunt aute dolore",
        "nostrud",
        "magna Ut eu deserunt officia",
        "cillum sunt officia",
        "ut exercitation",
        "Ut",
        "est"
      ],
      "send_at": "1941-04-10T07:31:29.0Z",
      "is_abtest": true,
      "updated_at": "1966-09-13T06:33:28.0Z",
      "created_at": "1904-04-16T21:25:36.0Z"
    }
  ],
  "_metadata": {
    "prev": "http://Yp.ugykdPrO-Nk2V6",
    "self": "http://vTPSRCfEzyEJi.tfnJjxd0UrisSKxsx+OW5VPneIzGby5Tjip2tX0Mm4yv4GfeRfctgikUBsgsphl,oQB5Ba",
    "next": "https://eazhmcEkAfHWwJztkXKqWfHZKfwJKiQg.hrLfcoMWsUx0UM4KzmR,igkAK+aQDRTqDdMFZRFJnHHCgr,",
    "count": 27211840
  }
}
{
  "errors": [
    {
      "field": "dolore sit consequat",
      "message": "in et ullamco Excepteur magna",
      "error_id": "cillum quis velit et amet"
    },
    {
      "field": "officia sit deserunt",
      "message": "voluptate pariatur",
      "error_id": "adipisicing"
    },
    {
      "field": "ad",
      "message": "nulla",
      "error_id": "sunt commodo minim"
    }
  ]
}
Query Parameter NameExample
ids["commodo elit esse","consequat est nisi exercitation tempor","quis eu cupidatat","ut nisi aute enim","Lorem laborum velit quis","nisi Excepteur","magna deserunt","deserunt eiusmod","nisi","Ut et tempor non"]
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "irure dolor",
      "message": "quis aute anim id aliqua",
      "error_id": "Ut"
    },
    {
      "field": "aliqua Duis cupidatat",
      "message": "veniam voluptate Duis in",
      "error_id": "consectetur voluptate aliqua ipsum"
    },
    {
      "field": "occaecat",
      "message": "eu quis sint",
      "error_id": "Excepteur eiusmod labore"
    }
  ]
}
{
  "errors": [
    {
      "field": "laboris consequat exercitation",
      "message": "ullamco Duis",
      "error_id": "irure culpa"
    }
  ]
}
Request Payload
{
  "name": "ut ullamco et"
}
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": [
    {
      "field": "cillum veniam aliquip dolor",
      "message": "in Lorem ex enim esse",
      "error_id": "qui"
    },
    {
      "field": "reprehenderit culpa aliqua nostrud Duis",
      "message": "elit sed tempor voluptate in",
      "error_id": "Ut"
    },
    {
      "field": "esse nulla ut Excepteur id",
      "message": "in anim deserunt cillum",
      "error_id": "culpa pariatur"
    },
    {
      "field": "dolor proident officia quis eu",
      "message": "deserunt ipsum laboris ad sit",
      "error_id": "magna commodo aliquip"
    }
  ]
}
{
  "errors": [
    {
      "field": "aute deserunt laboris non eiusmod",
      "message": "qui Lorem aliquip",
      "error_id": "est culpa"
    },
    {
      "field": "incididunt veniam occaecat",
      "message": "dolore do dolor pariatur eiusmod",
      "error_id": "ut"
    },
    {
      "field": "ullamco cillum quis laborum cupidatat",
      "message": "ex irure id mollit",
      "error_id": "culpa"
    }
  ]
}
Request Payload
{
  "name": "in ea ad",
  "categories": [
    "eu ullamco aliquip",
    "adipisicing esse nostrud",
    "ipsum minim commodo enim",
    "do laborum Excepteur nostrud",
    "aliqua est non",
    "sint",
    "elit cillum ut nisi",
    "quis exercitation",
    "tempor Lorem",
    "amet in irure laboris tempor"
  ],
  "send_at": "1962-04-03T13:19:12.0Z",
  "send_to": {
    "list_ids": [
      "56ce07e4-43af-7ade-e865-d1bceac19cbd",
      "66f8b97b-d880-5012-ac90-ff54a5f4c71d",
      "586ce2e5-4a90-06eb-4243-91db8525f65f",
      "75af9e06-8aa3-1279-e627-c0ecfaef7619",
      "bd4ca67a-e5b9-0866-19e2-41c3de74b930",
      "84616f80-99f6-003e-5c1f-eac99d55c016",
      "400c78bb-1f2d-2f4d-08e0-2f09c97bc1b4",
      "4d556d34-a20c-2145-3780-544e2dcf7be2",
      "376d4bb9-eac4-311e-d9f6-046f62c8cf5a",
      "c00e26bb-e3ff-4680-30f1-331d303fc0f7"
    ],
    "segment_ids": [
      "27ebda28-936b-37fd-43ef-9ad622185340",
      "4c384639-afda-f7ce-0814-8fc80e918d17",
      "ac35fee1-f966-d1de-7cde-d83a27f24ca2",
      "3e9b0450-0490-2a9a-4353-5ae5a4244d41",
      "931fdff9-5274-7722-b74f-29ccbbe49273",
      "6681cac0-2950-c011-dc4c-46b8ecef0562",
      "615894d8-af36-b531-667b-43563cc33556",
      "7c4ad89a-3020-dbeb-a663-cd5c7360a31b",
      "cc2d9e43-53f2-bc1b-cfab-58b92a92753c",
      "9e975237-1ab3-e760-6d96-a1d949efc6df"
    ],
    "all": true
  },
  "email_config": {
    "subject": "id ipsum ad laboris",
    "html_content": "dolore enim Excepteur",
    "plain_content": "ex deserunt ea ad",
    "generate_plain_content": true,
    "design_id": "esse magna ex",
    "editor": "code",
    "suppression_group_id": -5503320,
    "custom_unsubscribe_url": null,
    "sender_id": 14977892,
    "ip_pool": null
  }
}
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": [
    {
      "field": "sit veniam",
      "message": "Excepteur et irure",
      "error_id": "do"
    },
    {
      "field": "fugiat ullamco aliquip",
      "message": "deserunt velit ut mollit proident",
      "error_id": "id voluptate ad sit"
    },
    {
      "field": "veniam sit",
      "message": "commodo occaecat",
      "error_id": "ipsum exercitation ex Excepteur"
    },
    {
      "field": "proident",
      "message": "amet voluptate sed",
      "error_id": "et velit eiusmod magna eu"
    }
  ]
}
{
  "errors": [
    {
      "field": "adipisicing ea sit ad",
      "message": "culpa",
      "error_id": "ex"
    }
  ]
}
{
  "errors": [
    {
      "field": "Duis sed do",
      "message": "adipisicing in amet",
      "error_id": "voluptate Lorem"
    },
    {
      "field": "eiusmod et",
      "message": "Lorem",
      "error_id": "consequat laborum aliquip"
    },
    {
      "field": "sunt voluptate sint consectetur officia",
      "message": "in",
      "error_id": "deserunt ea eu"
    }
  ]
}
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": [
    {
      "field": "cupidatat qui",
      "message": "do quis",
      "error_id": "est ipsum minim culpa"
    },
    {
      "field": "in Lorem sit do in",
      "message": "Duis magna eiusmod sint",
      "error_id": "ea ipsum"
    },
    {
      "field": "laborum commodo",
      "message": "exercitation sed anim cupidatat dolor",
      "error_id": "incididunt laboris Lorem"
    },
    {
      "field": "nulla non enim Excepteur aliqua",
      "message": "non magna commodo",
      "error_id": "exercitation nisi"
    },
    {
      "field": "do ex non veniam culpa",
      "message": "dolor",
      "error_id": "tempor proident ex"
    }
  ]
}
{
  "errors": [
    {
      "field": "cupidatat sit eu nostrud tempor",
      "message": "nisi exercitation reprehenderit",
      "error_id": "in do"
    },
    {
      "field": "nulla sunt",
      "message": "ut",
      "error_id": "quis"
    },
    {
      "field": "eu Lorem dolor in irure",
      "message": "qui eu laborum velit",
      "error_id": "irure voluptate"
    },
    {
      "field": "exercitation ipsum",
      "message": "eiusmod ut tempor amet non",
      "error_id": "laboris nostrud ut ut consequat"
    },
    {
      "field": "non",
      "message": "tempor Lorem",
      "error_id": "sint enim commodo reprehenderit adipisicing"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "do anim mollit eu",
      "message": "ullamco",
      "error_id": "aute"
    },
    {
      "field": "officia",
      "message": "occaecat",
      "error_id": "incididunt Duis exercitation ullamco"
    },
    {
      "field": "velit nostrud amet labore ad",
      "message": "in culpa ipsum",
      "error_id": "Excepteur pariatur culpa dolore"
    },
    {
      "field": "enim",
      "message": "exercitation magna et",
      "error_id": "adipisicing et"
    }
  ]
}
{
  "errors": [
    {
      "field": "dolor quis Duis",
      "message": "in velit sed",
      "error_id": "qui"
    },
    {
      "field": "tempor sed veniam labore aliqua",
      "message": "amet dolor dolor",
      "error_id": "velit id"
    },
    {
      "field": "ut",
      "message": "non cupidatat",
      "error_id": "elit incididunt anim mollit"
    }
  ]
}
Query Parameter NameExample
page_size-10333553
page_tokendolor irure
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": [
    {
      "field": "officia est elit",
      "message": "labore nulla id officia sunt",
      "error_id": "aliquip velit amet sint ullamco"
    },
    {
      "field": "irure dolore nulla",
      "message": "ea culpa",
      "error_id": "adipisicing eu"
    },
    {
      "field": "Lorem",
      "message": "Excepteur voluptate laborum",
      "error_id": "esse aute ut occaecat aliqua"
    }
  ]
}
Request Payload
{
  "send_at": "3752-01-28T23:21:52.575Z"
}
Response Payload
{
  "send_at": "3752-01-28T23:21:52.575Z",
  "status": "scheduled"
}
{
  "errors": [
    {
      "field": "aliqua dolore tempor in ipsum",
      "message": "nostrud Excepteur nulla dolor",
      "error_id": "aute"
    },
    {
      "field": "ex amet elit cillum",
      "message": "cupidatat sit pariatur",
      "error_id": "eu ex"
    }
  ]
}
{
  "errors": [
    {
      "field": "voluptate occaecat Duis consectetur",
      "message": "et",
      "error_id": "voluptate eu in"
    },
    {
      "field": "elit ut in nostrud",
      "message": "velit ipsum sunt",
      "error_id": "ex nulla culpa tempor velit"
    },
    {
      "field": "consequat non fugiat Ut ut",
      "message": "labore enim nulla tempor",
      "error_id": "laboris"
    }
  ]
}
Request Payload
Response Payload
{
  "send_at": "1905-05-28T20:22:24.0Z",
  "status": "scheduled"
}
{
  "errors": [
    {
      "field": "amet reprehenderit sunt sit",
      "message": "in",
      "error_id": "et nostrud"
    },
    {
      "field": "commodo exercitation id",
      "message": "tempor ad",
      "error_id": "dolor non fugiat eiusmod voluptate"
    }
  ]
}
{
  "errors": [
    {
      "field": "culpa adipisicing labore",
      "message": "in labore eiusmod non",
      "error_id": "in laborum nisi in sed"
    },
    {
      "field": "deserunt sit minim sint ex",
      "message": "reprehenderit",
      "error_id": "fugiat dolor"
    },
    {
      "field": "et dolor",
      "message": "labore",
      "error_id": "incididunt eu anim"
    },
    {
      "field": "aute nisi irure occaecat aliquip",
      "message": "Duis nulla velit",
      "error_id": "deserunt"
    }
  ]
}
Request Payload
Response Payload
{
  "categories": [
    "equipment",
    "shoes",
    "sports"
  ]
}
{
  "errors": [
    {
      "field": "in qui",
      "message": "ad aliqua laboris",
      "error_id": "Ut"
    },
    {
      "field": "non laboris qui sed",
      "message": "aute cupidatat et labore minim",
      "error_id": "culpa laboris minim aute id"
    },
    {
      "field": "reprehenderit velit tempor",
      "message": "ut cillum",
      "error_id": "quis ea fugiat amet"
    }
  ]
}

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","et","occaecat in","anim","ex est laborum","commodo","dolore aliqua pariatur","culpa laborum reprehenderit","nostrud labore","mollit sunt"]
page_size38
page_tokencommodo enim nostrud pariatur
Request Payload
Response Payload
{
  "results": [
    {
      "id": "15e2c877-7b19-040c-d0fd-fddc23884ab2",
      "aggregation": "dolor sint in ad",
      "step_id": "sit",
      "stats": {
        "bounce_drops": -14104716,
        "bounces": 16521166,
        "clicks": -98395015,
        "delivered": 68370468,
        "invalid_emails": -93521766,
        "opens": -73441625,
        "requests": -94666262,
        "spam_report_drops": -30930007,
        "spam_reports": -2991459,
        "unique_clicks": -33777513,
        "unique_opens": 2271668,
        "unsubscribes": -10451278
      }
    },
    {
      "id": "65fc13e0-718f-9e25-0ef8-e38b2eef67fa",
      "aggregation": "tempor cillum",
      "step_id": "Duis eiusmod dolor exercitation in",
      "stats": {
        "bounce_drops": 74517535,
        "bounces": 10783012,
        "clicks": 34255838,
        "delivered": -31947459,
        "invalid_emails": -59564500,
        "opens": -91838255,
        "requests": -21164170,
        "spam_report_drops": -52523653,
        "spam_reports": -62037125,
        "unique_clicks": -26184075,
        "unique_opens": -86456001,
        "unsubscribes": 79781095
      }
    },
    {
      "id": "7d827a31-8334-14ab-6649-d6438cdbea5b",
      "aggregation": "ex proident ut",
      "step_id": "dolore mollit culpa in sunt",
      "stats": {
        "bounce_drops": 96979996,
        "bounces": 21491653,
        "clicks": -65941708,
        "delivered": 86090979,
        "invalid_emails": -67643955,
        "opens": 62856438,
        "requests": 93393351,
        "spam_report_drops": -89471980,
        "spam_reports": -3399908,
        "unique_clicks": 92546070,
        "unique_opens": -27718119,
        "unsubscribes": 52722512
      }
    },
    {
      "id": "1f03f8ed-4dfd-9d0d-1737-e1f7eaa054a1",
      "aggregation": "dolore qui laborum cillum ullamco",
      "step_id": "dolor in fugiat labore id",
      "stats": {
        "bounce_drops": 26612870,
        "bounces": -48414031,
        "clicks": -30495650,
        "delivered": 78614974,
        "invalid_emails": -54886687,
        "opens": 57119109,
        "requests": -95485426,
        "spam_report_drops": 93117410,
        "spam_reports": -73199730,
        "unique_clicks": 46652757,
        "unique_opens": -92904126,
        "unsubscribes": -41629268
      }
    },
    {
      "id": "09758810-7afc-714f-be77-7c54b2c33a4e",
      "aggregation": "tempor id esse aliqua",
      "step_id": "anim eu",
      "stats": {
        "bounce_drops": -62759295,
        "bounces": 48256190,
        "clicks": -84929979,
        "delivered": 83989079,
        "invalid_emails": -30680713,
        "opens": -18737224,
        "requests": -29667725,
        "spam_report_drops": 94338031,
        "spam_reports": -70019686,
        "unique_clicks": -63490488,
        "unique_opens": -54228278,
        "unsubscribes": 8993641
      }
    }
  ],
  "_metadata": {
    "prev": "http://tunFrjSkxCrhsIGxf.qfcdH1,QZe,Wd2HbWtD-exdLIcc2p,ThiqOVZac9ksb",
    "self": "http://FnZTCxyIOXqSaJ.kjRvcrrnTsAtMoZVd-dldJ0h9.v5B8tAKuUaxm3TKpEiawphGv8QwzC,U,UrPfJ-37DG,s",
    "next": "https://ZU.bzuAg6vyOsAPIYGYIGhcrtXybCIFt",
    "count": -1452152.8293623775
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
group_by["step_id","step_id","step_id","step_id","step_id"]
step_ids["8b3dd5ad-315a-3766-0acf-fb0b8e017e2f","4cf6a3aa-e655-0602-ee92-2ad2e1470acd","ffaf0151-7c34-8026-c403-2c2aac218456","c527c5da-9021-4a58-8526-83cf9bb26b16","a92bac93-1004-e174-c878-4944394545fe"]
aggregated_bytotal
start_date1960-04-08
end_date1907-02-11
timezonelaborum anim
page_size36
page_tokenlabore
Request Payload
Response Payload
{
  "results": [
    {
      "id": "ee62c0c0-3a3b-8033-68d1-93b30a0ef54d",
      "aggregation": "ad adipisicing",
      "step_id": "aliquip dolor",
      "stats": {
        "bounce_drops": 63164446,
        "bounces": 71627129,
        "clicks": 80793951,
        "delivered": 89311929,
        "invalid_emails": 29373662,
        "opens": -53493752,
        "requests": -29490620,
        "spam_report_drops": -43311354,
        "spam_reports": -86601257,
        "unique_clicks": -96405188,
        "unique_opens": -74014158,
        "unsubscribes": -33503451
      }
    },
    {
      "id": "d8209364-181c-f404-6f5c-0d66546dc2c1",
      "aggregation": "et anim reprehenderit enim",
      "step_id": "nulla in aliquip",
      "stats": {
        "bounce_drops": -5371336,
        "bounces": 31422832,
        "clicks": -33767950,
        "delivered": 2921331,
        "invalid_emails": -99921231,
        "opens": -44920569,
        "requests": -6230182,
        "spam_report_drops": 53221035,
        "spam_reports": 353437,
        "unique_clicks": 37594294,
        "unique_opens": -74456929,
        "unsubscribes": -63864953
      }
    },
    {
      "id": "585859b2-8f72-7f35-5471-00df4b6847f1",
      "aggregation": "aliqua sit nostrud sed labore",
      "step_id": "in pariatur incididunt sed nostrud",
      "stats": {
        "bounce_drops": -68646883,
        "bounces": 94217355,
        "clicks": 92844323,
        "delivered": -80964039,
        "invalid_emails": 84686542,
        "opens": -80698826,
        "requests": 20754681,
        "spam_report_drops": 37343578,
        "spam_reports": -97211404,
        "unique_clicks": 77639278,
        "unique_opens": 66648608,
        "unsubscribes": 28888096
      }
    },
    {
      "id": "b0d1c5e2-11d2-8c5e-e8a0-a790b3879d59",
      "aggregation": "ex ad labore amet consectetur",
      "step_id": "sed",
      "stats": {
        "bounce_drops": 26434266,
        "bounces": -40989449,
        "clicks": 76236249,
        "delivered": 16775399,
        "invalid_emails": -76365938,
        "opens": 34478168,
        "requests": -39146996,
        "spam_report_drops": -67518454,
        "spam_reports": -97818437,
        "unique_clicks": -79175224,
        "unique_opens": 55583415,
        "unsubscribes": 15410431
      }
    },
    {
      "id": "1b8693ea-e6bb-2063-9696-c6939ee84a2d",
      "aggregation": "Ut",
      "step_id": "laboris consectetur cillum nulla exercitation",
      "stats": {
        "bounce_drops": 4224851,
        "bounces": -35856577,
        "clicks": 35429632,
        "delivered": 23520,
        "invalid_emails": 82184310,
        "opens": -52490353,
        "requests": -89331136,
        "spam_report_drops": -59985161,
        "spam_reports": -47950900,
        "unique_clicks": -54465573,
        "unique_opens": 48508520,
        "unsubscribes": 5258942
      }
    }
  ],
  "_metadata": {
    "prev": "http://zwkcHfY.gcqglsN,YSTF4tUxOJcD5ngr5TtBtbE7dSW,vNmhUm1bvo6XMisyrv67YTYDujTtPTRzs7V1Levn",
    "self": "https://dieRHZQwPzfWFu.oxAbVQGrUtVDES2VJLB",
    "next": "http://yyYSO.uizhR0xlLyzuuONFQOr",
    "count": 17257979.66445057
  }
}
{
  "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["aliqua anim dolore","dolor consequat","adipisicing quis","cillum commodo consectetur eu minim","officia nulla laboris in","proident","consectetur pariatur non Lorem","eu id aliqua aute","aliquip eu aliqua reprehenderit Duis","ut id velit do"]
page_size74
page_tokenlaborum aute consectetur sed
Request Payload
Response Payload
{
  "results": [
    {
      "id": "de76cede-2c66-b9b9-bb4b-b136e98542df",
      "ab_variation": "06206426-98e0-a3f0-1221-1cb642d4ced5",
      "ab_phase": "test",
      "aggregation": "minim aliquip in",
      "stats": {
        "bounce_drops": -12643329,
        "bounces": 17840503,
        "clicks": -81950524,
        "delivered": -5050064,
        "invalid_emails": -69013875,
        "opens": 76917261,
        "requests": -40566146,
        "spam_report_drops": -5522350,
        "spam_reports": -99458833,
        "unique_clicks": 30840895,
        "unique_opens": 36672402,
        "unsubscribes": 79654692
      }
    },
    {
      "id": "85217ea6-dc56-2443-5acc-f592906103a8",
      "ab_variation": "c96eeb89-dbcd-9a48-4151-4490b2c0f414",
      "ab_phase": "all",
      "aggregation": "sunt laborum cillum",
      "stats": {
        "bounce_drops": -96045925,
        "bounces": 67548566,
        "clicks": 58036449,
        "delivered": 24160350,
        "invalid_emails": 60844603,
        "opens": 28194641,
        "requests": 49684950,
        "spam_report_drops": -34784906,
        "spam_reports": 57567982,
        "unique_clicks": -93413292,
        "unique_opens": -64981630,
        "unsubscribes": -36682261
      }
    },
    {
      "id": "55ca7522-125f-b987-1080-1395e04d803e",
      "ab_variation": "31037242-98e3-0cc4-4a2d-fdd0920e27ff",
      "ab_phase": "send",
      "aggregation": "mollit in",
      "stats": {
        "bounce_drops": 40804557,
        "bounces": -52355974,
        "clicks": -89970076,
        "delivered": -2709477,
        "invalid_emails": -26912637,
        "opens": 70346403,
        "requests": -50147993,
        "spam_report_drops": 76983548,
        "spam_reports": 48408088,
        "unique_clicks": -9228369,
        "unique_opens": -84472231,
        "unsubscribes": 91502514
      }
    },
    {
      "id": "20cbd843-1aa2-8c65-b398-32e3cbfd8e37",
      "ab_variation": "3cc3f554-faf8-0392-98e0-059349b27b49",
      "ab_phase": "send",
      "aggregation": "dolor Ut eu esse",
      "stats": {
        "bounce_drops": -72460641,
        "bounces": -11612955,
        "clicks": -2635093,
        "delivered": 12806836,
        "invalid_emails": 66479689,
        "opens": 76031510,
        "requests": 7374948,
        "spam_report_drops": 63096112,
        "spam_reports": -70962918,
        "unique_clicks": 49590118,
        "unique_opens": 14138676,
        "unsubscribes": -54040931
      }
    },
    {
      "id": "91142355-9be0-161a-970c-9bc1dd6d7573",
      "ab_variation": "92f25aec-c529-c608-78c4-ed26e8041eb7",
      "ab_phase": "send",
      "aggregation": "adipisicing cupidatat esse culpa",
      "stats": {
        "bounce_drops": -63733419,
        "bounces": 33016592,
        "clicks": -15856768,
        "delivered": -18559083,
        "invalid_emails": -33026018,
        "opens": 12372328,
        "requests": 8861096,
        "spam_report_drops": -62208719,
        "spam_reports": 37091424,
        "unique_clicks": -15276457,
        "unique_opens": -73883370,
        "unsubscribes": -51089920
      }
    }
  ],
  "_metadata": {
    "prev": "http://xjDDUUiwVTLH.fiffCGcrHDBT25fUJatD1VRuk-w+NYzqfWT,hLHyxwnbk2F8Ktmo",
    "self": "http://NcEaYTi.aoIDQhCF",
    "next": "https://TWRWFg.xlmW9-qqyb",
    "count": 33207777.745662794
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
aggregated_bytotal
start_date1899-09-06
end_date1909-10-27
timezonedolore dolor laborum
page_size60
page_tokenut enim do
group_by["ab_phase","ab_variation","ab_phase"]
Request Payload
Response Payload
{
  "results": [
    {
      "id": "e39c2a7b-0882-6203-7d67-c848afdbe934",
      "ab_variation": "7e623940-07c2-d11a-6201-5b1ce83c6f08",
      "ab_phase": "all",
      "aggregation": "non quis cupidatat sunt ad",
      "stats": {
        "bounce_drops": 18490330,
        "bounces": -93699174,
        "clicks": -67993863,
        "delivered": -37297787,
        "invalid_emails": 17256831,
        "opens": 77896694,
        "requests": -91999257,
        "spam_report_drops": 2817426,
        "spam_reports": -92484248,
        "unique_clicks": 89153659,
        "unique_opens": -47790033,
        "unsubscribes": 36359218
      }
    }
  ],
  "_metadata": {
    "prev": "http://rMYknxZptjoQX.uqccl-TKUz6sygLCWpLJdE+Lm5TDC4d2lfy",
    "self": "https://xULdCdoWCFEcvsAF.kazkg5,MbV+emLNTupErotQL",
    "next": "http://eGLipkcsqR.tgkARYxATjT7yATa9dNlqTpuq,E7nTXh815+AwB2R6Lis7Ve1h9.PVa,SR2xzB8",
    "count": -12933774.170246258
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
group_by["step_id","step_id","step_id","step_id"]
step_ids["fbf41693-3379-d312-1831-561482a919f9"]
page_size3
page_tokenminim tempor ad
Request Payload
Response Payload
{
  "results": [
    {
      "url": "https://VZGyVXukxiPpITMEO.rgiz2+dN6H3xBdqbx.i2,eeMsN5OsD0Af",
      "url_location": 39846624,
      "step_id": "46455eb0-d4fc-e4f1-a788-237b09615630",
      "clicks": 36155622
    },
    {
      "url": "https://KbvlEMIOREjcolhJofG.yfpvvrGwgrLDkpLkiugxIGu0fFrHe9HL1ZW5KoygAd5Lja1CEprEo-6+FcCxuRTJIvv",
      "url_location": 53316483,
      "step_id": "94ab22bd-b6a5-3584-0974-88fab21a4ea1",
      "clicks": 74393572
    },
    {
      "url": "http://jUfVyTqewGskbM.rjgflkw9eQgmnWjRYsTKcOaarAPvf8ElqTK3C4u",
      "url_location": 40636592,
      "step_id": "8988b6ee-b4e6-ad3f-b2bb-2736ce679757",
      "clicks": 51858660
    }
  ],
  "total_clicks": -70068387,
  "_metadata": {
    "prev": "https://VQdprMPSVvkE.wiMkj.2",
    "self": "https://yhyDuxHgiqiiFkG.czzkqlq1k4ws5+vjJQC",
    "next": "https://rGYEPhV.lxFpMnFSJ0N6vSRbklTx+xlQ+sgn",
    "count": 58125027.58836061
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
page_size80
page_tokeneiusmod aliquip eu aliqua
group_by["ab_variation","ab_variation","ab_variation"]
ab_variation_id69af5dc4-fdb2-0227-81af-8c141973495b
ab_phase_idtest
Request Payload
Response Payload
{
  "results": [
    {
      "url": "http://AryrgB.ycdwzvvab9jxpZ9TmoohaQdA.aDy,AN046xIuE.GsJX8MiG6CBIYrF",
      "url_location": 81696,
      "ab_variation": "a180441a-cac1-3724-9e3e-d6bbb2a40b82",
      "ab_phase": "all",
      "clicks": 91523660
    },
    {
      "url": "http://LCcSlQNlJDEKEjx.lpwDIPq.",
      "url_location": 55805513,
      "ab_variation": "f746db74-960c-c40d-123f-75245575e164",
      "ab_phase": "all",
      "clicks": 91454833
    }
  ],
  "_metadata": {
    "prev": "https://EzkhwIsNtKCzTrNCmPKIaMyUnM.kiNckozfjJmqdoU-9",
    "self": "http://rcqEMxAta.jemy",
    "next": "http://RfCclKNnykyXRizevpuHCWSiFIOXP.pvqnN3ZRd",
    "count": 5311011.247274518
  },
  "total_clicks": 153318
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
Query Parameter NameExample
ids["minim laborum exercitation occaecat ipsum","consectetur","commodo deserunt","aliqua dolore","ut qui voluptate cupidatat eiusmod","esse","et Lorem culpa ea","ad occaecat enim","proident culpa enim","ut labore quis minim sint"]
timezonecupidatat
Request Payload
Response Payload
adipisicing in
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
ids["ut","est in deserunt in","qui commodo","velit sunt eu","ex aliquip","in ut laborum dolor quis","Ut elit ea cillum","ad in","veniam","dolore"]
timezonequi
Request Payload
Response Payload
elit aliqua ipsum
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Sender Identities API(6 operations)

Header NameExample
on-behalf-of"proident"
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"sit in consectetur"
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"non"
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"pariatur et dolore cillum"
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"irure"
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"commodo culpa id cillum"
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"dolor qui ea voluptate"
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 dolore Ut"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1,
      "name": "the jones",
      "recipient_count": 1
    }
  ]
}
Header NameExample
on-behalf-of"labore irure fugiat aute eiusmod"
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_id5695945
Header NameExample
on-behalf-of"eu cupidatat"
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*7840856
Header NameExample
on-behalf-of"officia quis"
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_contactsfalse
Header NameExample
on-behalf-of"deserunt nisi consectetur dolor"
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
page62345488
page_size-48414763
list_id*29849200
Header NameExample
on-behalf-of"amet laboris pariatur voluptate Lorem"
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"tempor amet anim incididunt"
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"et occaecat"
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*-16404290
recipient_id*86383619
Header NameExample
on-behalf-of"fugiat"
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"Excepteur et voluptate labore"
Request Payload
[
  {
    "email": "example@example.com",
    "first_name": "",
    "last_name": "User",
    "age": 25
  },
  {
    "email": "example2@example.com",
    "first_name": "Example",
    "last_name": "User",
    "age": 25
  }
]
Response Payload
{
  "error_count": 1,
  "error_indices": [
    2
  ],
  "new_count": 2,
  "persisted_recipients": [
    "YUBh",
    "bWlsbGVyQG1pbGxlci50ZXN0"
  ],
  "updated_count": 0,
  "errors": [
    {
      "message": "Invalid email.",
      "error_indices": [
        2
      ]
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "Request body is not valid json"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"dolor"
Request Payload
[
  {
    "email": "jones@example.com",
    "last_name": "Jones",
    "first_name": "Guy"
  }
]
Response Payload
{
  "error_count": 1,
  "error_indices": [
    2
  ],
  "new_count": 2,
  "persisted_recipients": [
    "YUBh",
    "bWlsbGVyQG1pbGxlci50ZXN0"
  ],
  "updated_count": 0,
  "errors": [
    {
      "message": "Invalid email.",
      "error_indices": [
        2
      ]
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "Request body is not valid json"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"ea anim fugiat 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-128351
page_size-40857718
Header NameExample
on-behalf-of"aute do consectetur culpa"
Request Payload
Response Payload
{
  "recipients": []
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"dolore ad sed"
Request Payload
Response Payload
{
  "status": [
    {
      "id": "worker_delay",
      "value": "delayed"
    },
    {
      "id": "worker_delay_seconds",
      "value": "75.0"
    }
  ]
}
Header NameExample
on-behalf-of"enim"
Request Payload
Response Payload
{
  "recipients": [
    {
      "id": "amet esse",
      "created_at": -92421140.16844836,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "3eu3EEcJo@GQYJJdktxqnYpOVFarMOLKrZiNPUzGF.myev",
      "first_name": "aute",
      "last_name": null,
      "last_clicked": null,
      "last_emailed": 2333314.3458316326,
      "last_opened": 36499439.38674629,
      "updated_at": -92612481.70490366
    },
    {
      "id": "nulla commodo ex",
      "created_at": 17893132.21190673,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "Sm8W9kUoFcG9Z@plRpMzFpUboTDTvo.frke",
      "first_name": "dolor deserunt nostrud culpa amet",
      "last_name": "nisi aliquip mollit",
      "last_clicked": 7497414.888745889,
      "last_emailed": null,
      "last_opened": null,
      "updated_at": 58926677.56386155
    },
    {
      "id": "ex consectetur exercitation",
      "created_at": 43307938.09327605,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "rR1v@jTViNDbYPFzKHHygOalJ.jaae",
      "first_name": "voluptate proident do labore esse",
      "last_name": null,
      "last_clicked": null,
      "last_emailed": null,
      "last_opened": -28081569.340210155,
      "updated_at": -42682595.0520267
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"nisi laboris"
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"aute nulla commodo ipsum Ut"
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"in elit cupidatat"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"consequat et est cillum"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
{field_name}incididunt Ut velit labore ea
Header NameExample
on-behalf-of"ex culpa"
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"pariatur"
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"incididunt nulla aute pariatur"
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"minim occaecat ullamco"
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"nulla aliqua non"
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"eiusmod deserunt"
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"ut Excepteur ad tempor sint"
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"culpa"
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*-15418218
Header NameExample
on-behalf-of"adipisicing sint anim"
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_iddeserunt consequat esse
Header NameExample
on-behalf-of"veniam labore cupidatat nulla ut"
Request Payload
{
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ]
}
Response Payload
{
  "id": 5,
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ],
  "recipient_count": 1
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "segment_id": "segment_id",
      "message": "segment id is not valid"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
delete_contactsfalse
Header NameExample
on-behalf-of"ut in fugiat"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "segment_id",
      "message": "Returned if segment_id is not valid"
    },
    {
      "field": "delete_contacts",
      "message": "Returned if delete_contacts is not a valid boolean"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "segment_id",
      "message": "segment_id does not exist"
    }
  ]
}
Query Parameter NameExample
page-1476654
page_size62953355
Header NameExample
on-behalf-of"sint sunt magna"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 1422313607,
      "email": "jones@example.com",
      "first_name": null,
      "id": "YUBh",
      "last_clicked": null,
      "last_emailed": null,
      "last_name": "Jones",
      "last_opened": null,
      "updated_at": 1422313790,
      "custom_fields": [
        {
          "id": 23,
          "name": "pet",
          "value": "Indiana",
          "type": "text"
        }
      ]
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}

Categories(3 operations)

Query Parameter NameExample
limit-72162996
categoryea eu
offset57878229
Header NameExample
on-behalf-of"qui voluptate"
Request Payload
Response Payload
[
  {
    "category": "category 1"
  },
  {
    "category": "category 2"
  }
]
{
  "errors": [
    {
      "field": "sort_by",
      "message": "invalid sort value"
    }
  ]
}
Query Parameter NameExample
sort_by_metricnisi
sort_by_directiondesc
start_date*ut ad consectetur
end_datevelit nostrud magna
limit54611809
offset-82940140
aggregated_bymonth
Header NameExample
on-behalf-of"dolore"
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*sit in incididunt elit cupidatat
end_dateanim dolore ex reprehenderit laboris
categories*sit esse
limit-24026661
offset71931518
aggregated_byweek
Header NameExample
on-behalf-of"tempor culpa id elit"
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"amet ad Lorem"
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
limit79696048
offset14475207
Header NameExample
on-behalf-of"deserunt id proident"
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"dolore"
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"cupidatat qui reprehenderit in fugiat"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"proident mollit"
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"Ut aliquip"
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"et ad 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"in quis esse"
Request Payload
{
  "send_at": 1489451436
}
Response Payload
{
  "id": 69019421,
  "send_at": 29313616,
  "status": "aliquip elit Duis deserunt"
}
{
  "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"sed sint voluptate deserunt occaecat"
Request Payload
Response Payload
{
  "send_at": 1490778528
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"nulla id commodo reprehenderit"
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"do amet ad"
Request Payload
{
  "to": "your.email@example.com"
}
Response Payload
{
  "to": "veniam fugiat irure aliqua quis"
}
{
  "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"culpa exercitation ad"
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*99.29042408261222
page_tokenconsequat eiusmod aliquip dolor
Header NameExample
on-behalf-of"sint Ut"
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": [
    {
      "": "culpa ea exercitation consectetur voluptate",
      "message": "irure enim id commodo anim",
      "error_id": "Ut"
    },
    {
      "": "ex voluptate Lorem",
      "message": "quis",
      "error_id": "nisi pariatur minim cillum aliqua"
    },
    {
      "": "ullamco est cillum",
      "message": "sit",
      "error_id": "adipisicing esse nostrud minim"
    }
  ]
}
Header NameExample
on-behalf-of"sint"
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"sint nulla non laboris"
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"exercitation sunt"
Request Payload
{
  "name": "new_example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "new_example_name",
  "versions": []
}
Header NameExample
on-behalf-of"ullamco in"
Request Payload
Response Payload
{}

Transactional Templates Versions(5 operations)

Header NameExample
on-behalf-of"eu officia ea 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"ex"
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"Excepteur"
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"consequat veniam labore"
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"reprehenderit nulla id"
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"fugiat in labore nostrud"
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"eiusmod non in"
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"culpa"
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": "id tempor"
    },
    {
      "message": "Duis"
    },
    {
      "message": "dolore ullamco pariatur esse adipisicing"
    },
    {
      "message": "pariatur"
    }
  ]
}
Query Parameter NameExample
limitaute sunt quis ex nostrud
offsetnon ipsum sunt cupidatat voluptate
aggregated_byweek
start_date*tempor cillum consequat veniam
end_dateex aliqua in cupidatat minim
Header NameExample
on-behalf-of"dolor"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  }
]
Header NameExample
on-behalf-of"ipsum"
Request Payload
Response Payload
{
  "public_key": "anim quis in sint"
}
Header NameExample
on-behalf-of"est aliqua"
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"non sint tempor Ut et"
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"dolor ad do in"
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": "in"
    },
    {
      "message": "ut velit qui reprehenderit"
    },
    {
      "message": "eiusmod non"
    }
  ]
}
Header NameExample
on-behalf-of"commodo Duis occaecat"
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": "est qui velit"
    },
    {
      "message": "magna pariatur"
    },
    {
      "message": "mollit consectetur aliquip id"
    },
    {
      "message": "quis reprehenderit"
    },
    {
      "message": "dolore esse anim"
    }
  ]
}
Header NameExample
on-behalf-of"mollit eiusmod"
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": "consectetur dolor dolor"
    }
  ]
}
Header NameExample
on-behalf-of"officia commodo sint"
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": "nulla aliquip Ut incididunt dolor"
    },
    {
      "message": "minim"
    },
    {
      "message": "elit sit incididunt et commodo"
    }
  ]
}

Query(2 operations)

Query Parameter NameExample
query*occaecat
limit481.3584157681401
Header NameExample
X-Query-Id"ut veniam anim"
X-Cursor"adipisicing"
Authorization*"id eu"
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*"ex"
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
queryDuis dolor esse culpa dolore
Header NameExample
Authorization*"velit amet laboris pariatur dolor"
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*"mollit id"
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"non aliqua qui adipisicing exercitation"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "open",
      "title": "Open Tracking",
      "description": "lorem ipsum... .",
      "enabled": true
    }
  ]
}
Header NameExample
on-behalf-of"fugiat reprehenderit"
Request Payload
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"nisi in ut"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"voluptate sint ex"
Request Payload
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"velit incididunt sit sed"
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"ut fugiat culpa adipisicing officia"
Request Payload
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"nostrud veniam"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"tempor pariatur Lorem Excepteur"
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"minim dolore nulla do ex"
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
limit54396919
offset91212699
aggregated_byweek
start_date*laborum labore ut
end_datelaborum in velit
Header NameExample
on-behalf-of"officia irure sint adipisicing aliquip"
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
countryUS
limit77079986
offset65172565
aggregated_bymonth
start_date*incididunt
end_dateculpa anim eiusmod commodo ea
Header NameExample
on-behalf-of"cillum dolore ut minim labore"
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
limit60388909
offset57511507
aggregated_byweek
start_date*ipsum
end_datecillum elit velit
Header NameExample
on-behalf-of"do qui nisi nulla ut"
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*sunt consequat pariatur
end_dateminim eiusmod fugiat elit
aggregated_byday
Header NameExample
on-behalf-of"sint pariatur anim"
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*enim
end_dateut
aggregated_byweek
Header NameExample
on-behalf-of"ipsum Lorem aliquip magna"
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_providerslabore Lorem voluptate
limit-96849892
offset-28286546
aggregated_byweek
start_date*fugiat dolor magna
end_datenostrud in consequat Lorem dolore
Header NameExample
on-behalf-of"eiusmod"
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
browsersdolor cupidatat
limit-63523239
offset-52992738
aggregated_byday
start_date*ut incididunt cillum
end_datein
Header NameExample
on-behalf-of"ex nisi veniam"
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_time-65627305
end_time-33886778
Header NameExample
Accept*"ea fugiat proident consectetur officia"
on-behalf-of"elit cillum exercitation mollit"
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"amet ut in"
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"culpa non eiusmod aliquip laboris"
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*KsxuQV@BhRdHixZXCTAGthKsOYOVZNOfIlXingF.daz
Header NameExample
on-behalf-of"reprehenderit in"
Request Payload
Error generating example
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Blocks API(4 operations)

Query Parameter NameExample
start_time-54277588
end_time12475842
limit-39919949
offset-34671651
Header NameExample
on-behalf-of"sit sunt enim veniam sed"
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"id minim"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"pariatur enim"
Request Payload
Response Payload
[
  {
    "created": 1443651154,
    "email": "example@example.com",
    "reason": "error dialing remote address: dial tcp 10.57.152.165:25: no route to host",
    "status": "4.0.0"
  }
]
Header NameExample
on-behalf-of"Ut ad"
Request Payload
Response Payload
{}

Spam Reports API(4 operations)

Query Parameter NameExample
start_time-33221491
end_time-69180616
limit18074892
offset73900162
Header NameExample
on-behalf-of"cupidatat aliquip aute in"
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"eu"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"ad est voluptate"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "ip": "10.89.32.5"
  }
]
Header NameExample
on-behalf-of"minim nulla labore aliqua"
Request Payload
Response Payload
{}

Suppressions - Global Suppressions(4 operations)

Header NameExample
on-behalf-of"commodo aute"
Request Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Response Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Query Parameter NameExample
start_time-82205070
end_time-58134584
limit26549900
offset47965602
Header NameExample
on-behalf-of"occaecat"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com"
  }
]
Header NameExample
on-behalf-of"consequat elit enim Duis"
Request Payload
Response Payload
{
  "recipient_email": "test@example.com"
}
Header NameExample
on-behalf-of"cupidatat Ut Lorem"
Request Payload
Response Payload
{}

Suppressions - Unsubscribe Groups(5 operations)

Header NameExample
on-behalf-of"magna"
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
id4500757
Header NameExample
on-behalf-of"dolore nisi"
Request Payload
Response Payload
[
  {
    "id": 1234,
    "name": "Unsubscribe Group",
    "description": "An Unsubscribe Group",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 1234
  },
  {
    "id": 1234,
    "name": "Unsubscribe Group",
    "description": "An Unsubscribe Group",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 1234
  }
]
Header NameExample
on-behalf-of"nulla"
Request Payload
Response Payload
{
  "description": "Our monthly newsletter.",
  "id": 100,
  "is_default": true,
  "last_email_sent_at": null,
  "name": "Newsletters",
  "unsubscribes": 400
}
Header NameExample
on-behalf-of"adipisicing proident"
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"elit minim"
Request Payload
Response Payload
{}

Suppressions - Suppressions(6 operations)

Header NameExample
on-behalf-of"irure velit"
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"dolor ut nisi sunt amet"
Request Payload
Response Payload
[
  "example@example.com",
  "example2@example.com"
]
Header NameExample
on-behalf-of"id irure"
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"exercitation"
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"anim Lorem"
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"tempor pariatur elit consequat"
Request Payload
Response Payload
Error generating example

Invalid Emails API(4 operations)

Query Parameter NameExample
start_time91171807
end_time-99540137
limit-71056132
offset-74434876
Header NameExample
on-behalf-of"nulla magna ipsum"
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"ea dolore in id amet"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"exercitation sed voluptate ea reprehenderit"
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"
Request Payload
Response Payload
{}
Service Homepage: sendgrid.com/en-us
API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started
emails