View All Services

Sendgrid V3 Mock Server

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

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

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

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

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



Mail Send

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

Cancel Scheduled Sends(7 operations)

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

API Keys(6 operations)

Header NameExample
on-behalf-of"reprehenderit ex irure do"
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": "consequat et tempor"
    },
    {
      "message": "quis ut magna"
    }
  ]
}
Query Parameter NameExample
limit55278413
Header NameExample
on-behalf-of"consectetur nisi"
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": "ullamco mollit laboris esse"
    },
    {
      "message": "irure anim"
    }
  ]
}
Header NameExample
on-behalf-of"minim"
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": "esse"
    }
  ]
}
Header NameExample
on-behalf-of"laborum veniam adipisicing aute"
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": "irure"
    },
    {
      "message": "et aute occaecat"
    },
    {
      "message": "aliquip incididunt"
    },
    {
      "message": "est"
    }
  ]
}
Header NameExample
on-behalf-of"ea"
Request Payload
{
  "name": "Profiles key",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ]
}
Response Payload
{
  "api_key_id": "qfTQ6KG0QBiwWdJ0-pCLCA",
  "name": "Profiles Key",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "Excepteur esse irure in Lorem"
    },
    {
      "message": "qui dolor consectetur aute"
    },
    {
      "message": "aliqua Ut"
    },
    {
      "message": "esse consectetur"
    },
    {
      "message": "culpa consequat elit anim nisi"
    }
  ]
}
Header NameExample
on-behalf-of"aliqua in elit Lorem et"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "dolore enim"
    },
    {
      "message": "voluptate fugiat aute"
    },
    {
      "message": "deserunt labore"
    },
    {
      "message": "enim nostrud Excepteur elit"
    },
    {
      "message": "id occaecat veniam nostrud nisi"
    }
  ]
}

API Key Permissions

Header NameExample
on-behalf-of"et est dolore culpa"
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": "in ipsum dolor non minim"
    },
    {
      "message": "dolor deserunt laborum"
    },
    {
      "message": "ea dolor"
    },
    {
      "message": "officia proident"
    }
  ]
}

Settings - Enforced TLS(2 operations)

Header NameExample
on-behalf-of"cupidatat exercitation esse anim amet"
Request Payload
Response Payload
{
  "require_tls": false,
  "require_valid_cert": false
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "proident"
    },
    {
      "message": "dolore ea ad Duis ex"
    }
  ]
}
Header NameExample
on-behalf-of"cupidatat et"
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": "mollit Duis officia in et"
    },
    {
      "message": "commodo sed anim esse eiusmod"
    },
    {
      "message": "ex in pariatur cupidatat nulla"
    },
    {
      "message": "minim consequat nostrud est"
    },
    {
      "message": "Lorem sunt minim aute"
    }
  ]
}

IP Access Management(6 operations)

Header NameExample
on-behalf-of"qui Lorem Duis sit dolore"
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": "occaecat officia qui nulla"
    }
  ]
}
Header NameExample
on-behalf-of"labore eiusmod ut do aute"
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": "non"
    }
  ]
}
Header NameExample
on-behalf-of"esse ipsum culpa amet Duis"
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": "labore et"
    },
    {
      "message": "in"
    },
    {
      "message": "amet occaecat sunt proident"
    }
  ]
}
Query Parameter NameExample
limit52599523
Header NameExample
on-behalf-of"non in aliqua"
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": "quis fugiat elit dolor aliqua"
    },
    {
      "message": "est amet Ut voluptate"
    },
    {
      "message": "Ut officia exercitation ad"
    },
    {
      "message": "sed voluptate labore ullamco"
    },
    {
      "message": "Ut sit"
    }
  ]
}
Header NameExample
on-behalf-of"occaecat mollit"
Request Payload
Response Payload
{
  "id": 1,
  "ip": "192.168.1.1",
  "created_at": 1441824715,
  "updated_at": 1441824715
}
Header NameExample
on-behalf-of"aliqua"
Request Payload
Response Payload
{}

Certificates(5 operations)

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

Single Sign-On Settings(5 operations)

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

Single Sign-On Teammates(2 operations)

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

Settings - Mail(13 operations)

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

Settings - Partner(3 operations)

Header NameExample
on-behalf-of"mollit ut sed"
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"labore"
Request Payload
Response Payload
{
  "enable_subuser_statistics": false,
  "enabled": true,
  "license_key": ""
}
Query Parameter NameExample
limit69565470
offset-7067387
Header NameExample
on-behalf-of"pariatur velit anim"
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"deserunt et cupidatat"
Request Payload
{
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}
Response Payload
{
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}
{
  "errors": [
    {
      "field": "amet et elit incididunt",
      "message": "exercitation voluptate elit tempor incididunt"
    }
  ]
}
Query Parameter NameExample
limit498
offset17770322
Header NameExample
on-behalf-of"aute aliquip dolore"
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"amet"
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-12917570
offset7036348
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"Excepteur dolore"
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"ex Excepteur dolor"
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"cupidatat proident ad dolor mollit"
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"aliqua voluptate quis commodo dolore"
Request Payload
Response Payload
{
  "errors": [
    {
      "field": "sint quis laboris Ut",
      "message": "ut"
    },
    {
      "field": "laborum Excepteur aute",
      "message": "mollit Ut"
    }
  ]
}
{
  "errors": [
    {
      "message": "username not found",
      "field": "username"
    }
  ]
}
Request Payload
Response Payload
{
  "scope_group_name": "Stats"
}
{}
{
  "errors": [
    {
      "field": "nulla cupidatat adipisicing nisi",
      "message": "dolor labore"
    },
    {
      "field": "in ea dolor",
      "message": "minim aliqua"
    },
    {
      "field": "ipsum et",
      "message": "magna sunt nulla"
    },
    {
      "field": "ex",
      "message": "cillum occaecat ullamco"
    },
    {
      "field": "adipisicing velit Excepteur",
      "message": "mollit deserunt"
    }
  ]
}
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"dolor veniam"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "laborum minim in",
      "message": "anim"
    },
    {
      "field": "qui enim sit",
      "message": "Ut ex"
    },
    {
      "field": "elit Excepteur ex occaecat sunt",
      "message": "ipsum magna"
    },
    {
      "field": "labore non eu anim amet",
      "message": "do id Lorem irure"
    },
    {
      "field": "est nostrud occaecat cupidatat",
      "message": "est exercitation nulla"
    }
  ]
}

Alerts(5 operations)

Header NameExample
Authorization"ex ea officia qui aute"
on-behalf-of"dolor consequat 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": "eu proident do",
  "message": "anim Duis laboris magna"
}
Header NameExample
Authorization"sed culpa enim irure"
on-behalf-of"proident voluptate esse non aliquip"
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"cupidatat incididunt cillum ipsum fugiat"
on-behalf-of"ad aliqua dolor"
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"nulla consectetur"
Request Payload
Response Payload
{}
Header NameExample
on-behalf-of"veniam Lorem"
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"Duis pariatur in mollit"
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"anim"
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"sit"
Request Payload
Response Payload
{
  "reputation": 100,
  "type": "paid"
}
Header NameExample
on-behalf-of"cupidatat incididunt do velit"
Request Payload
Response Payload
{
  "email": "test@example.com"
}
Header NameExample
on-behalf-of"tempor"
Request Payload
{
  "email": "example@example.com"
}
Response Payload
{
  "email": "example@example.com"
}
Header NameExample
on-behalf-of"sed"
Request Payload
Response Payload
{
  "username": "test_username",
  "user_id": 1
}
Header NameExample
on-behalf-of"nisi cupidatat dolore eu enim"
Request Payload
{
  "username": "test_username"
}
Response Payload
{
  "username": "test_username"
}
Header NameExample
on-behalf-of"nisi laborum velit occaecat"
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"mollit est"
Request Payload
{
  "new_password": "new_password",
  "old_password": "old_password"
}
Response Payload
{}

Subusers API(6 operations)

Query Parameter NameExample
usernameex
limit-76203401
offset-18364855
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
usernamesreprehenderit eiusmod amet dolore ipsum
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*cillum
sort_by_metricnon dolore aliqua sit voluptate
sort_by_directionasc
limit45553132
offset35092802
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*eu
subuserdolor voluptate Excepteur laborum labore
sort_by_metricunique_opens
sort_by_directionasc
limit-57438366
offset-51388437
Request Payload
Response Payload
{
  "date": "2016-02-01",
  "stats": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 0,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 1,
        "processed": 0,
        "requests": 100,
        "spam_report_drops": 0,
        "spam_reports": 99,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user1",
      "type": "subuser"
    },
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 10,
        "processed": 10,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user2",
      "type": "subuser"
    }
  ]
}
Query Parameter NameExample
sort_by_directionasc
start_date*nulla
end_dateex enim labore elit nostrud
limit54346033
offset59219140
aggregated_byeiusmod proident
sort_by_metriceu sed Excepteur est laborum
Request Payload
Response Payload
{
  "date": "2015-10-11",
  "stats": []
}
Query Parameter NameExample
limit99669358
offset-8103167
aggregated_byweek
subusers*consequat do officia id irure
start_date*velit eiusmod
end_datenisi
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"consectetur tempor aliqua aute"
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
limit11902535
offset-72147167
ipculpa non minim tempor commodo
Header NameExample
on-behalf-of"pariatur culpa"
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"proident cillum aliquip dolore"
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"sit"
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"Ut sint est ipsum ut"
Request Payload
Response Payload
{}

Email Address Validation

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

Email CNAME records

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

IP Pools(7 operations)

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

IP Addresses(5 operations)

Request Payload
{
  "count": 90323478,
  "subusers": [
    "subuser1",
    "subuser2"
  ],
  "warmup": true,
  "user_can_send": true
}
Response Payload
{
  "ips": [
    {
      "ip": "1.2.3.4",
      "subusers": [
        "user",
        "subuser1"
      ]
    },
    {
      "ip": "1.2.3.5",
      "subusers": [
        "user",
        "subuser1"
      ]
    }
  ],
  "remaining_ips": 1,
  "warmup": true
}
{
  "errors": [
    {
      "field": null,
      "message": "one or more subusers do not belong to this user"
    }
  ]
}
Query Parameter NameExample
ipDuis
exclude_whitelabelsfalse
limit-835631
offset66592406
subuserin sit dolore enim esse
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
limit-36086320
offset-27065368
exclude_subusersfalse
usernamealiquip do non labore
domainaliqua amet Duis
Header NameExample
on-behalf-of"irure labore Ut dolor"
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"occaecat cillum"
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"esse"
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"sit"
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"adipisicing cupidatat Excepteur nulla"
Request Payload
Response Payload
{}
Query Parameter NameExample
domainvelit
Header NameExample
on-behalf-of"do esse consectetur et"
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"sed voluptate veniam laboris tempor"
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"in quis sed anim"
Request Payload
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "mail@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}
Header NameExample
on-behalf-of"est Lorem in"
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*cillum veniam minim consectetur qui
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
usernamenostrud eu
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": "Lorem sint et id"
    },
    {
      "message": "non nisi dolor"
    },
    {
      "message": "aliqua Lorem sint"
    }
  ]
}
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": "qui occaecat"
    },
    {
      "message": "et consequat"
    },
    {
      "message": "Lorem nisi"
    },
    {
      "message": "id sed nisi"
    }
  ]
}
Request Payload
{
  "nickname": "Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105"
}
Response Payload
{
  "id": 1234,
  "nickname": "Example Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St.",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105",
  "verified": true,
  "locked": false
}
{
  "errors": [
    {
      "error_id": "aliqua",
      "field": "sed est",
      "message": "adipisicing irure incididunt ad"
    },
    {
      "error_id": "pariatur qui",
      "field": "magna esse sint adipisicing",
      "message": "Duis commodo id elit"
    },
    {
      "error_id": "aliquip magna in Excepteur incididunt",
      "field": "amet ea officia non",
      "message": "ut consequat"
    },
    {
      "error_id": "adipisicing consectetur velit aliquip exercitation",
      "field": "incididunt esse nisi proident do",
      "message": "est ipsum anim ullamco qui"
    },
    {
      "error_id": "quis",
      "field": "ipsum",
      "message": "elit Duis dolore et"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "non elit enim consequat"
    },
    {
      "message": "pariatur commodo"
    }
  ]
}
Query Parameter NameExample
limit-5494721.736754343
lastSeenID-69174298.34407769
id-56411638
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": "mollit deserunt ut"
    },
    {
      "message": "ea nostrud exercitation tempor et"
    },
    {
      "message": "ut"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "voluptate et sit ut eiusmod",
      "message": "cupidatat nostrud"
    },
    {
      "error_id": "dolore",
      "message": "et Excepteur mollit voluptate"
    },
    {
      "error_id": "pariatur",
      "message": "labore"
    },
    {
      "error_id": "eiusmod pariatur irure",
      "message": "occaecat id anim irure dolore"
    }
  ]
}
{
  "errors": [
    {
      "message": "cillum adipisicing ea nisi"
    },
    {
      "message": "Ut reprehenderit consectetur"
    }
  ]
}
Request Payload
{
  "nickname": "Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105"
}
Response Payload
{
  "id": 1234,
  "nickname": "Example Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St.",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105",
  "verified": true,
  "locked": false
}
{
  "errors": [
    {
      "error_id": "esse reprehenderit",
      "field": "ea cillum et aliquip",
      "message": "do cillum mollit sint"
    },
    {
      "error_id": "Lorem ad pariatur magna",
      "field": "incididunt pariatur tempor officia",
      "message": "in"
    },
    {
      "error_id": "ad dolore exercitation",
      "field": "Excepteur sit commodo officia",
      "message": "eiusmod sint nostrud magna"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "occaecat",
      "message": "velit aliquip quis aute laboris"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "nulla Excepteur",
      "message": "sint"
    },
    {
      "error_id": "voluptate",
      "message": "adipisicing ut nulla qui laborum"
    }
  ]
}
{
  "errors": [
    {
      "message": "aliquip"
    },
    {
      "message": "ea officia incididunt aute"
    },
    {
      "message": "adipisicing est laborum proident aliquip"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "aute veniam elit",
      "message": "Excepteur"
    },
    {
      "error_id": "quis ex",
      "message": "nisi"
    },
    {
      "error_id": "culpa in minim",
      "message": "minim"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ut tempor nisi",
      "message": "ea sint commodo irure in"
    },
    {
      "error_id": "mollit in sed tempor",
      "message": "id"
    },
    {
      "error_id": "reprehenderit Excepteur voluptate officia",
      "message": "veniam"
    },
    {
      "error_id": "commodo",
      "message": "do in"
    }
  ]
}
{
  "errors": [
    {
      "message": "ullamco Duis dolor sed fugiat"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "error_id": "cupidatat",
      "message": "dolore do"
    },
    {
      "error_id": "et qui",
      "message": "Lorem consequat Excepteur Duis do"
    },
    {
      "error_id": "sint exercitation consectetur et commodo",
      "message": "quis in amet occaecat ut"
    },
    {
      "error_id": "sint dolor",
      "message": "ut dolore commodo occaecat aliqua"
    },
    {
      "error_id": "mollit",
      "message": "sed Excepteur magna"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "anim",
      "message": "irure ad"
    },
    {
      "error_id": "nulla nostrud",
      "message": "ad anim"
    },
    {
      "error_id": "exercitation labore Lorem",
      "message": "ea irure enim aliquip laboris"
    },
    {
      "error_id": "et veniam proident",
      "message": "quis ut aliqua laborum dolore"
    },
    {
      "error_id": "in officia",
      "message": "esse eu"
    }
  ]
}
{
  "errors": [
    {
      "message": "consequat pariatur occaecat do incididunt"
    }
  ]
}

Designs API(9 operations)

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

Contacts(13 operations)

Request Payload
{
  "contacts": [
    {
      "address_line_1": "laboris",
      "address_line_2": "amet eiusmod",
      "alternate_emails": [
        "laboris aute velit in dolore",
        "cillum tempor nulla reprehenderit in",
        "deserunt Excepteur nulla minim",
        "Lorem cupidatat do",
        "sit ad anim"
      ],
      "city": "in",
      "country": "nulla et aliquip",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "vel",
      "first_name": "est officia sit consequat",
      "last_name": "non eu Lorem dolor",
      "postal_code": "est in dolor et",
      "state_province_region": "eu laborum"
    },
    {
      "address_line_1": "in nulla",
      "address_line_2": "eiusmod in minim est",
      "alternate_emails": [
        "voluptate ea incididunt",
        "et commodo consequat",
        "sint et ipsum veniam",
        "consectetur Ut id laboris est",
        "culpa dolore irure"
      ],
      "city": "nisi",
      "country": "anim occ",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "nostrud id adipisicing Excepteur",
      "first_name": "sed Excepteur",
      "last_name": "incididunt",
      "postal_code": "do ad nisi ex",
      "state_province_region": "cons"
    },
    {
      "address_line_1": "nulla",
      "address_line_2": "consequat voluptate in Ut nisi",
      "alternate_emails": [
        "irure",
        "dolor non incididunt officia",
        "ullamco aliqua",
        "aute Lorem",
        "eiusmod occaecat c"
      ],
      "city": "in",
      "country": "nisi sed ipsum",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "ad incididunt",
      "first_name": "nostrud minim",
      "last_name": "occaecat p",
      "postal_code": "mollit fugiat",
      "state_province_region": "quis"
    },
    {
      "address_line_1": "sunt laboris irure eiusmod",
      "address_line_2": "proident",
      "alternate_emails": [
        "sunt",
        "ullamco laborum in aliquip",
        "cillum magna sunt nostrud",
        "est",
        "nisi consequat ut"
      ],
      "city": "cons",
      "country": "ullamco",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "proident voluptate reprehenderit ex ipsum",
      "first_name": "proident elit re",
      "last_name": "deserunt",
      "postal_code": "dolor tempor consequat",
      "state_province_region": "in ex enim officia"
    },
    {
      "address_line_1": "eu minim ullamco Lorem",
      "address_line_2": "ut",
      "alternate_emails": [
        "dolor",
        "in officia",
        "magna nulla nisi",
        "amet labore",
        "labore quis cupidatat velit Lorem"
      ],
      "city": "mollit sit esse et enim",
      "country": "ut",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "elit veniam",
      "first_name": "in voluptate qui Lorem",
      "last_name": "deserunt occae",
      "postal_code": "sed eu mollit",
      "state_province_region": "Except"
    },
    {
      "address_line_1": "do consec",
      "address_line_2": "minim id de",
      "alternate_emails": [
        "in",
        "proident",
        "voluptate laborum",
        "proident",
        "ad aute sed"
      ],
      "city": "qui ipsum ",
      "country": "cillum dolor",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "esse",
      "first_name": "elit ",
      "last_name": "laboris",
      "postal_code": "sit",
      "state_province_region": "esse Excepteur ex"
    },
    {
      "address_line_1": "nostrud",
      "address_line_2": "incididunt mollit offi",
      "alternate_emails": [
        "deserunt velit",
        "minim incididunt officia",
        "sit ad Ut in esse",
        "esse nisi in",
        "mollit dolor"
      ],
      "city": "nisi in do in",
      "country": "adipisicing exercitation",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "culpa Ut eu enim cillum",
      "first_name": "incididun",
      "last_name": "id velit Lor",
      "postal_code": "deserunt laborum do",
      "state_province_region": "minim et voluptate pariatur"
    },
    {
      "address_line_1": "eu sed sit Ut magna",
      "address_line_2": "laborum nostrud",
      "alternate_emails": [
        "cillum",
        "labore mollit",
        "magna eu anim laborum",
        "officia pariatur",
        "in Ut tempor"
      ],
      "city": "pro",
      "country": "et",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "ut cillum eu",
      "first_name": "exercit",
      "last_name": "qui anim",
      "postal_code": "commodo",
      "state_province_region": "et occaecat nos"
    },
    {
      "address_line_1": "elit sit sunt nostrud",
      "address_line_2": "culpa Duis voluptate",
      "alternate_emails": [
        "in",
        "ut cupidatat amet",
        "culpa ut",
        "est incididunt",
        "ipsum"
      ],
      "city": "esse fugiat qui Ut culpa",
      "country": "ullamco in",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "consectetur est elit veniam",
      "first_name": "in dolor",
      "last_name": "id aliqua velit ut in",
      "postal_code": "Duis consequat sint",
      "state_province_region": "cillum magna ullamco officia tempor"
    },
    {
      "address_line_1": "eu eiusmod",
      "address_line_2": "dolore",
      "alternate_emails": [
        "aliquip quis",
        "commodo incididunt",
        "laboris eu deserunt",
        "Ut veniam",
        "elit exercitation aute tempor"
      ],
      "city": "elit",
      "country": "est enim",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "nulla cupidatat occaecat",
      "first_name": "minim quis consequat",
      "last_name": "et veniam aliquip",
      "postal_code": "dolore mollit eu",
      "state_province_region": "sunt in en"
    }
  ],
  "list_ids": [
    "8cac252e-9efd-1dd7-82ea-0e75324dc741"
  ]
}
Response Payload
{
  "job_id": "ullamco nostrud"
}
{
  "errors": [
    {
      "error_id": "in",
      "field": "proident sunt cillum et consectetur",
      "message": "magna Duis",
      "parameter": "sit sed reprehenderit aliquip"
    },
    {
      "error_id": "consequat veniam deserunt",
      "field": "tempor",
      "message": "minim deserunt eu esse in",
      "parameter": "labore sed"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "non consequat eiusmod enim"
    },
    {
      "message": "enim id"
    },
    {
      "message": "cillum incididunt nisi eu"
    },
    {
      "message": "in est sed sunt ex"
    },
    {
      "message": "et"
    }
  ]
}
Query Parameter NameExample
delete_all_contactsLorem anim ad eiusmod
idscillum laboris fugiat dolor
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": "in amet dolore Excepteur"
    },
    {
      "message": "Excepteur"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "self": "aute"
  },
  "contact_count": -20444442,
  "result": [
    {
      "_metadata": {
        "self": "nostrud aute"
      },
      "address_line_1": "exercitation consequat aliquip cupidatat id",
      "address_line_2": "aliqua dolor Excepteur veniam nisi",
      "alternate_emails": [
        "ullamco adipisicing",
        "cupidatat dolor do",
        "ea Ut adipisicing sint ex",
        "nisi et occaecat"
      ],
      "city": "dolore",
      "country": "consequat",
      "created_at": "velit magna veniam esse",
      "custom_fields": {},
      "email": "cupidatat in sint est",
      "facebook": "aute",
      "first_name": "quis",
      "id": "qui non nulla cillum aliquip",
      "last_name": "ad Lorem officia",
      "line": "non exercitation nulla occaecat",
      "list_ids": [
        "Excepteur",
        "aute Ut ea eiusmod",
        "magna ut nulla",
        "officia dolore cupidatat cillum ipsum",
        "culpa elit ullamco nostrud eiusmod"
      ],
      "phone_number": "qui",
      "postal_code": "elit qui",
      "segment_ids": [
        "irure",
        "culpa ut elit et"
      ],
      "state_province_region": "in exercitation ea velit",
      "unique_name": "reprehenderit commodo magna",
      "updated_at": "sit laborum non",
      "whatsapp": "nostrud"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "voluptate",
      "field": "commodo do est",
      "message": "Lorem reprehenderit",
      "parameter": "Lorem sunt"
    },
    {
      "error_id": "culpa in",
      "field": "do ut adipisicing",
      "message": "nulla Excepteur sunt sint",
      "parameter": "veniam do"
    },
    {
      "error_id": "Duis proident",
      "field": "in consectetur voluptate est",
      "message": "proident ipsum consequat dolor",
      "parameter": "eu ea ex est consectetur"
    },
    {
      "error_id": "veniam",
      "field": "cillum qui ipsum ad culpa",
      "message": "sit",
      "parameter": "ullamco Lorem mollit consectetur"
    },
    {
      "error_id": "veniam",
      "field": "magna enim ipsum Duis in",
      "message": "cupidatat amet elit ex",
      "parameter": "do occaecat Duis deserunt"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "culpa proident pariatur"
    },
    {
      "message": "ullamco"
    }
  ]
}
Request Payload
Response Payload
{
  "billable_breakdown": {
    "breakdown": {},
    "total": 7858768
  },
  "billable_count": 55453729,
  "contact_count": 58553100
}
{
  "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": "deserunt aute"
    },
    {
      "message": "aliqua ut ut"
    },
    {
      "message": "nulla dolor minim"
    }
  ]
}
Request Payload
{
  "file_type": "csv",
  "list_ids": [
    "2d4307bf-d853-41e7-6f77-ecd9b950f72d"
  ],
  "max_file_size": -24913811,
  "notifications": {
    "email": false
  },
  "segment_ids": [
    "ut ullamco"
  ]
}
Response Payload
{
  "_metadata": {
    "count": 43627648.976325125,
    "next": "http://Cz.ymCL7j-k1szqDw",
    "prev": "https://ZCXayVb.qjupfsFa+Ooi9ormPrEkc41rvCQ+",
    "self": "https://DJOxnaRQpXQCJyYjAuuNYmiBfCH.swvt2wP0yH9-36oFq.SUrFP+eVhPNbd-1fj"
  },
  "id": "Ut in voluptate consequat"
}
{
  "errors": [
    {
      "error_id": "labore",
      "field": "cupidatat non",
      "message": "elit reprehenderit ad",
      "parameter": "pariatur magna cupidatat ullamco"
    },
    {
      "error_id": "occaecat Excepteur",
      "field": "sunt elit sit non occaecat",
      "message": "minim ipsum culpa occaecat velit",
      "parameter": "sed est commodo in exercitation"
    },
    {
      "error_id": "Duis",
      "field": "dolor laborum nostrud minim",
      "message": "sint sunt",
      "parameter": "id ut deserunt amet cupidatat"
    },
    {
      "error_id": "commodo Lorem id",
      "field": "cupidatat elit labore",
      "message": "incididunt eiusmod in",
      "parameter": "laborum laboris amet reprehenderit dolore"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "occaecat dolore sed"
    },
    {
      "message": "minim irure pariatur"
    },
    {
      "message": "elit aute laborum"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "next": "magna qui laboris",
    "prev": "dolore nulla",
    "self": "anim labore in culpa velit"
  },
  "result": [
    {
      "_metadata": {
        "next": "dolor",
        "prev": "in eiusmod",
        "self": "aliqua velit do"
      },
      "completed_at": "ut anim deserunt",
      "created_at": "esse proident",
      "expires_at": "velit",
      "export_type": "in aute amet",
      "id": "Lorem ullamco",
      "lists": [
        {
          "ID": "ex adipisicing nulla in sed",
          "Name": "anim sint Duis Lorem ut"
        },
        {
          "ID": "nulla irure laboris Lorem reprehenderit",
          "Name": "anim qui Ut nulla dolore"
        },
        {
          "ID": "irure tempor magna",
          "Name": "sed"
        }
      ],
      "segments": [
        {
          "ID": "exercitation labore",
          "Name": "est ea cupidatat mollit tempor"
        },
        {
          "ID": "esse quis velit",
          "Name": "consectetur aliqua culpa occaecat"
        },
        {
          "ID": "est in Lorem do",
          "Name": "consectetur aute nostrud deserunt"
        },
        {
          "ID": "fugiat amet adipisicing",
          "Name": "exercitation aliqua"
        },
        {
          "ID": "Ut",
          "Name": "est eiusmod nisi dolor"
        }
      ],
      "status": "occaecat aute est exercitation",
      "urls": [
        "do est",
        "proident id dolor non",
        "dolor",
        "dolor quis id est",
        "culpa"
      ],
      "user_id": "proident laborum id"
    },
    {
      "_metadata": {
        "next": "ut commodo",
        "prev": "aute",
        "self": "ad nisi consectetur aute sit"
      },
      "completed_at": "minim velit",
      "created_at": "officia Lorem eu labore enim",
      "expires_at": "in anim voluptate sunt ex",
      "export_type": "magna deserunt Excepteur non veniam",
      "id": "enim ut ut",
      "lists": [
        {
          "ID": "amet culpa ex",
          "Name": "veniam ut in"
        },
        {
          "ID": "ex minim Excepteur Ut sint",
          "Name": "in Duis et ut irure"
        },
        {
          "ID": "eiusmod nostrud Ut",
          "Name": "mollit ad incididunt"
        },
        {
          "ID": "esse in",
          "Name": "nulla labore ex"
        }
      ],
      "segments": [
        {
          "ID": "ipsum",
          "Name": "exercitation nisi nostrud"
        },
        {
          "ID": "ullamco sunt",
          "Name": "culpa irure Duis in"
        },
        {
          "ID": "sed pariatur ea",
          "Name": "sed consectetur"
        },
        {
          "ID": "ad in",
          "Name": "commodo ut"
        },
        {
          "ID": "reprehenderit eu elit sint",
          "Name": "ea ipsum consectetur ex cupidatat"
        }
      ],
      "status": "ex quis dolor velit",
      "urls": [
        "commodo dolor nulla aute",
        "Duis sed laboris eiusmod minim",
        "ullamco tempor magna laboris reprehenderit",
        "proident"
      ],
      "user_id": "occaecat aliquip"
    },
    {
      "_metadata": {
        "next": "cillum aliquip est aute voluptate",
        "prev": "ullamco",
        "self": "dolor"
      },
      "completed_at": "Duis",
      "created_at": "et laborum ad dolor Duis",
      "expires_at": "ipsum dolor",
      "export_type": "sint Ut eiusmod in",
      "id": "occaecat id mollit",
      "lists": [
        {
          "ID": "amet do eiusmod",
          "Name": "occaecat id"
        },
        {
          "ID": "laborum",
          "Name": "ipsum sed dolore laboris velit"
        },
        {
          "ID": "ut fugiat aute",
          "Name": "eiusmod est in"
        },
        {
          "ID": "nostrud",
          "Name": "ex velit ut ea"
        },
        {
          "ID": "adipisicing ex non aliqua veniam",
          "Name": "Excepteur deserunt id culpa"
        }
      ],
      "segments": [
        {
          "ID": "Excepteur in Lorem",
          "Name": "non ut elit culpa"
        },
        {
          "ID": "commodo",
          "Name": "anim"
        },
        {
          "ID": "ad irure velit eiusmod enim",
          "Name": "sit"
        },
        {
          "ID": "commodo ut veniam ipsum minim",
          "Name": "id amet"
        },
        {
          "ID": "in occaecat",
          "Name": "laborum Lorem nulla"
        }
      ],
      "status": "in id Duis sint",
      "urls": [
        "nisi laboris tempor",
        "labore Duis et",
        "do",
        "veniam ad labore est"
      ],
      "user_id": "sed ullamco"
    },
    {
      "_metadata": {
        "next": "incididunt veniam",
        "prev": "consequat ad",
        "self": "eiusmod amet"
      },
      "completed_at": "pariatur nisi aute deserunt",
      "created_at": "officia Duis Lorem dolore quis",
      "expires_at": "ullamco irure sunt officia aliqua",
      "export_type": "minim est cillum laborum",
      "id": "ad dolor",
      "lists": [
        {
          "ID": "proident tempor Lorem",
          "Name": "eiusmod voluptate"
        },
        {
          "ID": "minim Ut sunt",
          "Name": "pariatur in Lorem dolore"
        }
      ],
      "segments": [
        {
          "ID": "ut minim ea",
          "Name": "velit"
        },
        {
          "ID": "aliquip minim",
          "Name": "anim pariatur"
        },
        {
          "ID": "in Lorem nostrud consequat",
          "Name": "aute proident mollit quis consectetur"
        },
        {
          "ID": "Duis elit non",
          "Name": "in"
        },
        {
          "ID": "Lorem minim tempor",
          "Name": "sit ipsum"
        }
      ],
      "status": "cillum ad eu exercitation",
      "urls": [
        "dolore irure laborum"
      ],
      "user_id": "et fugiat cillum dolor mollit"
    }
  ]
}
{
  "errors": [
    {
      "": "ipsum sint",
      "error_id": "in aute dolor Excepteur",
      "message": "eiusmod adipisicing pariatur"
    },
    {
      "": "ut esse nulla sint amet",
      "error_id": "in qui laborum ipsum Lorem",
      "message": "cupidatat minim ex"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ut magna commodo aliquip"
    },
    {
      "message": "dolor nostrud incididunt aliqua"
    },
    {
      "message": "elit sunt"
    },
    {
      "message": "qui"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "self": "in mollit culpa ullamco"
  },
  "address_line_1": "adipisicing",
  "address_line_2": "laborum aliqua in magna esse",
  "alternate_emails": [
    "eiusmod"
  ],
  "city": "adipisicing",
  "country": "consectetur do",
  "created_at": "aliquip incididunt officia veniam",
  "custom_fields": {},
  "email": "deserunt ipsum consectetur",
  "facebook": "cillum aute",
  "first_name": "dolor Lorem sed consectetur",
  "id": "do anim",
  "last_name": "deserunt",
  "line": "enim",
  "list_ids": [
    "ipsum anim aliquip proident commodo"
  ],
  "phone_number": "sit amet enim exercitation ut",
  "postal_code": "ea veniam deserunt id irure",
  "segment_ids": [
    "mollit dolore ipsum",
    "fugiat non enim labore"
  ],
  "state_province_region": "Excepteur magna",
  "unique_name": "minim irure",
  "updated_at": "incididunt sed dolore",
  "whatsapp": "dolore voluptate"
}
{
  "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": "elit cupidatat voluptate"
    },
    {
      "message": "irure Excepteur voluptate"
    },
    {
      "message": "ea laborum eiusmod"
    },
    {
      "message": "ea"
    },
    {
      "message": "Excepteur anim adipisicing exercitation"
    }
  ]
}
Request Payload
{
  "query": "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')"
}
Response Payload
{
  "_metadata": {
    "self": "veniam"
  },
  "contact_count": 5325124.571263462,
  "result": [
    {
      "_metadata": {
        "self": "esse sint dolore"
      },
      "address_line_1": "in dolore aliqua aute laboris",
      "address_line_2": "non officia ullamco elit qui",
      "alternate_emails": [
        "in fugiat in eiusmod",
        "consequat fugiat",
        "sit consequat incididunt dolor dolor",
        "incididunt aliquip",
        "adipisicing est"
      ],
      "city": "culpa anim esse minim",
      "country": "laboris fugiat",
      "created_at": "Ut id ex pariatur",
      "custom_fields": {},
      "email": "aliquip",
      "facebook": "ad officia cupidatat qui fugiat",
      "first_name": "dolore voluptate magna",
      "id": "deserunt cillum consequat incididunt ullamco",
      "last_name": "sunt non adipisicing est",
      "line": "nostrud sed",
      "list_ids": [
        "aliquip",
        "Ut",
        "mollit est",
        "dolor proident Ut veniam officia",
        "magna"
      ],
      "phone_number": "deserunt aliqua sint",
      "postal_code": "commodo laboris",
      "segment_ids": [
        "non",
        "reprehenderit",
        "ex ea",
        "dolor Ut amet nisi"
      ],
      "state_province_region": "sit",
      "unique_name": "cupidatat id sed deserunt voluptate",
      "updated_at": "dolore aliquip",
      "whatsapp": "reprehenderit quis Duis"
    }
  ]
}
{
  "errors": [
    {
      "field": "consectetur deserunt id elit",
      "message": "aliqua est labore"
    },
    {
      "field": "sunt",
      "message": "id qui cillum ex exercitation"
    },
    {
      "field": "id culpa",
      "message": "cupidatat tempor culpa"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "culpa"
    },
    {
      "message": "dolor laborum"
    },
    {
      "message": "id adipisicing Lorem ut nulla"
    },
    {
      "message": "veniam consectetur nulla"
    },
    {
      "message": "est reprehenderit commodo"
    }
  ]
}
Request Payload
{
  "field_mappings": [
    "tempor",
    "elit sit laborum magna",
    null,
    "adipisicing tempor ut do ex"
  ],
  "file_type": "csv",
  "list_ids": [
    "aliqua",
    "nostrud aute occaecat consequat",
    "mollit qui"
  ]
}
Response Payload
{
  "job_id": "Lorem officia irure",
  "upload_headers": [
    {
      "header": "sed cupidatat in amet",
      "value": "pariatur sint ad"
    },
    {
      "header": "ut quis officia in",
      "value": "est adipisicing enim quis"
    },
    {
      "header": "laborum",
      "value": "reprehenderit quis tempor"
    }
  ],
  "upload_uri": "sunt consequat nulla non dolore"
}
{
  "errors": [
    {
      "error_id": "dolor Ut do",
      "field": "amet",
      "message": "tempor",
      "parameter": "in"
    },
    {
      "error_id": "veniam Lorem est",
      "field": "adipisicing aute in",
      "message": "ex nulla fugiat elit",
      "parameter": "deserunt occaecat qui dolore"
    },
    {
      "error_id": "aliquip",
      "field": "Lorem",
      "message": "dolore cupidatat nulla id",
      "parameter": "tempor officia esse"
    },
    {
      "error_id": "proident cillum est dolore",
      "field": "nisi",
      "message": "ex magna nostrud",
      "parameter": "reprehenderit cillum"
    },
    {
      "error_id": "qui consequat",
      "field": "qui sed est",
      "message": "dolore quis est aliqua aliquip",
      "parameter": "veniam aute"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "officia",
      "field": "dolore elit exercitation sit",
      "message": "nostrud nulla ut officia Duis",
      "parameter": "sit et minim"
    },
    {
      "error_id": "proident sunt esse",
      "field": "elit cupidatat",
      "message": "deserunt",
      "parameter": "non aliqua mollit eiusmod"
    },
    {
      "error_id": "magna nulla eu sint",
      "field": "consectetur ut cillum fugiat",
      "message": "Excepteur mollit nostrud",
      "parameter": "Duis dolore consequat sunt"
    },
    {
      "error_id": "culpa elit eu ipsum",
      "field": "ipsum",
      "message": "proident",
      "parameter": "amet sunt voluptate veniam"
    }
  ]
}
{
  "errors": [
    {
      "message": "sunt"
    },
    {
      "message": "veniam ut ad ex cillum"
    },
    {
      "message": "labore"
    },
    {
      "message": "cillum magna ex"
    },
    {
      "message": "dolor ex incididunt"
    }
  ]
}
Request Payload
Response Payload
{
  "finished_at": "Duis et dolor quis dolor",
  "id": "Ut Excepteur",
  "job_type": "in",
  "results": {
    "created_count": -66293402.84164958,
    "deleted_count": 38432486.886232644,
    "errored_count": -50903385.85426575,
    "errors_url": "aliquip deserunt",
    "requested_count": -93869931.28823656,
    "updated_count": 62226507.37990785
  },
  "started_at": "culpa sunt ut exercitation",
  "status": "est mollit pariatur"
}
{
  "errors": {
    "error_id": "ut qui in sed deserunt",
    "field": "deserunt enim",
    "message": "consectetur ullamco",
    "parameter": "laboris"
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ipsum nostrud"
    },
    {
      "message": "aute Excepteur"
    },
    {
      "message": "proident dolore ex"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "count": 22985332.891287193,
    "next": "https://RPLOccEqk.aqvyujB,dJAdRpJeMx88W-vTMI7IvN39YM+3wa",
    "prev": "http://Pv.ngkx6XZ6SfHT",
    "self": "https://SXruoXCTrieJS.hdJkudlN"
  },
  "completed_at": "sint dolor voluptate",
  "contact_count": 2139328,
  "created_at": "deserunt dolor commodo",
  "expires_at": "dolor",
  "id": "cupidatat reprehenderit",
  "message": "elit",
  "status": "ready",
  "updated_at": "velit ut reprehenderit Lorem",
  "urls": [
    "Ut",
    "cupidatat ipsum quis",
    "incididunt Lorem"
  ]
}
{
  "errors": [
    {
      "error_id": "ad ipsum",
      "field": "dolor dolor nostrud officia",
      "message": "velit tempor incididunt mollit",
      "parameter": "id dolor"
    },
    {
      "error_id": "aliqua ad",
      "field": "consectetur Lorem reprehenderit",
      "message": "veniam ut sed commodo magna",
      "parameter": "in non reprehenderit dolore"
    },
    {
      "error_id": "commodo dolor dolore",
      "field": "Duis enim",
      "message": "et",
      "parameter": "enim cupidatat Lorem ipsum"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "tempor eiusmod ipsum do"
    },
    {
      "message": "irure in enim mollit"
    },
    {
      "message": "cillum Duis pariatur"
    },
    {
      "message": "sed Excepteur sunt in in"
    }
  ]
}
Request Payload
{
  "ids": [
    "1234",
    "1235"
  ]
}
Response Payload
{
  "result": [
    {
      "_metadata": {
        "self": "irure eiusmod"
      },
      "address_line_1": "qui sint consequat magna labore",
      "address_line_2": "et anim irure reprehenderit",
      "alternate_emails": [
        "in Lorem deserunt id",
        "dolore exercitation veniam",
        "et commodo fugiat non id",
        "incididunt",
        "in laborum minim incididunt"
      ],
      "city": "minim enim",
      "country": "nisi ut officia",
      "created_at": "ea mollit aliquip exercitation voluptate",
      "custom_fields": {},
      "email": "occaecat tempor Lorem",
      "facebook": "est irure Excepteur in reprehenderit",
      "first_name": "aliqua quis fugiat ea sint",
      "id": "adipisicing occaecat Lorem sunt incididunt",
      "last_name": "ea incididunt est",
      "line": "aliquip consequat enim cillum aute",
      "list_ids": [
        "est",
        "magna",
        "in pariatur"
      ],
      "phone_number": "sunt laboris laborum ut eu",
      "postal_code": "commodo tempor sit ut deserunt",
      "segment_ids": [
        "ipsum",
        "Ut",
        "velit deserunt",
        "eu in ut non",
        "qui Excepteur aliquip incididunt"
      ],
      "state_province_region": "nulla magna",
      "unique_name": "enim quis sint",
      "updated_at": "consequat Excepteur",
      "whatsapp": "do Ut"
    },
    {
      "_metadata": {
        "self": "consectetur"
      },
      "address_line_1": "ut eu sit",
      "address_line_2": "proident",
      "alternate_emails": [
        "do exercitation ea Excepteur in",
        "in eiusmod dolore",
        "velit ex",
        "cupidatat dolor"
      ],
      "city": "non ipsum minim tempor",
      "country": "velit occaecat incididunt do",
      "created_at": "dolore consequat mollit deserunt",
      "custom_fields": {},
      "email": "cillum non aliqua",
      "facebook": "mollit proident nisi",
      "first_name": "eiusmod dolor officia irure ex",
      "id": "sunt Excepteur mollit fugiat",
      "last_name": "adipisicing",
      "line": "incididunt adipisicing velit in est",
      "list_ids": [
        "occaecat deserunt",
        "Excepteur dolore sunt sit"
      ],
      "phone_number": "Excepteur veniam",
      "postal_code": "minim",
      "segment_ids": [
        "ut in ex"
      ],
      "state_province_region": "in ut",
      "unique_name": "velit consequat dolor amet Duis",
      "updated_at": "consequat veniam reprehenderit nisi dolore",
      "whatsapp": "eiusmod sed id non labore"
    },
    {
      "_metadata": {
        "self": "sunt proident Excepteur magna nisi"
      },
      "address_line_1": "fugiat enim",
      "address_line_2": "qui fugiat pariatur dolore Ut",
      "alternate_emails": [
        "amet",
        "incididunt anim",
        "qui Ut ex et"
      ],
      "city": "ipsum sed",
      "country": "voluptate dolor eiusmod ea",
      "created_at": "occaecat voluptate Lorem sit",
      "custom_fields": {},
      "email": "ullamco",
      "facebook": "dolor",
      "first_name": "elit ex",
      "id": "cillum deserunt proident commodo",
      "last_name": "exercitation ut sunt occaecat consectetur",
      "line": "dolore",
      "list_ids": [
        "officia aute laborum pariatur",
        "Ut"
      ],
      "phone_number": "dolore laborum amet",
      "postal_code": "ea officia",
      "segment_ids": [
        "non"
      ],
      "state_province_region": "voluptate ea do",
      "unique_name": "veniam sint consequat officia adipisicing",
      "updated_at": "reprehenderit ipsum",
      "whatsapp": "eiusmod aute"
    },
    {
      "_metadata": {
        "self": "minim nostrud commodo est"
      },
      "address_line_1": "velit veniam",
      "address_line_2": "sunt",
      "alternate_emails": [
        "eiusmod dolore"
      ],
      "city": "id sint ex",
      "country": "culpa cupidatat",
      "created_at": "consequat mollit",
      "custom_fields": {},
      "email": "esse",
      "facebook": "dolor",
      "first_name": "sunt mollit officia dolore sed",
      "id": "ea et",
      "last_name": "ex Duis do",
      "line": "in deserunt nisi incididunt veniam",
      "list_ids": [
        "ut laboris Ut fugiat",
        "do incididunt Excepteur enim sint",
        "exercitation irure",
        "commodo"
      ],
      "phone_number": "eu dolor officia elit",
      "postal_code": "dolore aliquip amet",
      "segment_ids": [
        "culpa commodo cillum ut officia",
        "qui sint",
        "laborum Lorem non",
        "in",
        "dolor tempor aute eu"
      ],
      "state_province_region": "Duis",
      "unique_name": "labore fugiat dolore",
      "updated_at": "Excepteur dolor elit adipisicing ex",
      "whatsapp": "Lorem"
    },
    {
      "_metadata": {
        "self": "adipisicing"
      },
      "address_line_1": "incididunt officia quis ut veniam",
      "address_line_2": "mollit ex",
      "alternate_emails": [
        "deserunt laborum irure exercitation",
        "nostrud velit ad magna Excepteur",
        "cupidatat consequat Excepteur nisi ipsum",
        "fugiat aute esse incididunt laborum",
        "qui"
      ],
      "city": "id dolore",
      "country": "ex",
      "created_at": "consectetur Excepteur enim laboris",
      "custom_fields": {},
      "email": "Excepteur mollit quis nulla",
      "facebook": "ut qui minim nulla",
      "first_name": "commodo ut",
      "id": "id laboris",
      "last_name": "nostrud qui minim Duis ut",
      "line": "Duis nisi magna",
      "list_ids": [
        "nulla ipsum culpa"
      ],
      "phone_number": "occaecat culpa laboris irure do",
      "postal_code": "id",
      "segment_ids": [
        "Duis ut reprehenderit",
        "Lorem consectetur velit do",
        "Excepteur qui",
        "ullamco eiusmod",
        "velit irure"
      ],
      "state_province_region": "sed fugiat consectetur nulla",
      "unique_name": "irure laborum laboris elit Duis",
      "updated_at": "ea sed ad id",
      "whatsapp": "sunt"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "eiusmod reprehenderit aute consectetur"
    }
  ]
}
Request Payload
{
  "emails": [
    "jane_doe@example.com",
    "john_doe@example.com",
    "joann_doe@example.com"
  ]
}
Response Payload
{
  "result": {
    "jane_doe@example.com": {
      "contact": {
        "address_line_1": "",
        "address_line_2": "",
        "alternate_emails": [
          "janedoe@example1.com"
        ],
        "city": "",
        "country": "",
        "email": "jane_doe@example.com",
        "first_name": "Jane",
        "id": "asdf-Jkl-zxCvBNm",
        "last_name": "Doe",
        "list_ids": [],
        "segment_ids": [],
        "postal_code": "",
        "state_province_region": "",
        "phone_number": "",
        "whatsapp": "",
        "line": "",
        "facebook": "",
        "unique_name": "",
        "custom_fields": {},
        "created_at": "2021-03-02T15:25:47Z",
        "updated_at": "2021-03-30T15:26:16Z",
        "_metadata": {
          "self": "<metadata_url>"
        }
      }
    },
    "john_doe@example.com": {
      "contact": {
        "address_line_1": "",
        "address_line_2": "",
        "alternate_emails": [],
        "city": "",
        "country": "",
        "email": "john_doe@example.com",
        "first_name": "Jane",
        "id": "asdf-Jkl-qWeRTy",
        "last_name": "Doe",
        "list_ids": [],
        "segment_ids": [],
        "postal_code": "",
        "state_province_region": "",
        "phone_number": "",
        "whatsapp": "",
        "line": "",
        "facebook": "",
        "unique_name": "",
        "custom_fields": {},
        "created_at": "2020-01-02T15:25:47Z",
        "updated_at": "2020-12-20T15:26:16Z",
        "_metadata": {
          "self": "<metadata_url>"
        }
      }
    },
    "joann_doe@example.com": {
      "error": "contact not found"
    }
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "deserunt"
    },
    {
      "message": "amet fugiat magna esse"
    },
    {
      "message": "proident reprehenderit labore"
    },
    {
      "message": "fugiat tempor"
    }
  ]
}

Segmenting Contacts V2 - Beta(5 operations)

Request Payload
{
  "name": "dolor aliquip nostrud ut",
  "parent_list_ids": [
    "nulla",
    "Ut non aute",
    "elit",
    "esse mollit dolore",
    "deserunt incididunt aliqua"
  ],
  "query_dsl": "ut commodo eu"
}
Response Payload
{
  "contacts_count": 40943348,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "laborum proident Duis ea",
  "id": "2044fb83-3872-1bd7-185c-1b31534b4b06",
  "name": "i",
  "next_sample_update": "eu elit",
  "parent_list_ids": [
    "enim id officia"
  ],
  "query_dsl": "do sed labore",
  "query_version": "sed",
  "sample_updated_at": "incididunt velit labore Lorem",
  "status": {
    "error_message": "elit pariatur",
    "query_validation": "minim"
  },
  "updated_at": "est"
}
{
  "errors": [
    {
      "field": "ex",
      "message": "velit dolore"
    },
    {
      "field": "aliqua occaecat exercitation mollit nulla",
      "message": "id exercitation elit"
    },
    {
      "field": "enim",
      "message": "enim dolor ipsum"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "dolore anim",
      "message": "in culpa Excepteur amet ipsum"
    }
  ]
}
Query Parameter NameExample
parent_list_idsullamco
no_parent_list_idfalse
Request Payload
Response Payload
{
  "_metadata": {
    "count": 44060180,
    "next": "http://KoGAqzQtuNVFFqUhlxZJOhkMkW.qzjADTB4I9kFFAAngAtJ3IidC9Un+iSqIEdV5cHPFfpUV0Rw6GN3",
    "prev": "https://gLuOSPBIpBhGzNy.nwrUKB52bUndFp0ZNc-vXe5l,2I8QXjho9Lsc.,29Oz6WJ",
    "self": "http://qgAVooQGbbqoAEUgmDgbdDxNzS.wgdNLXSyWpTxIW4q7OfCsaxO4Eci3hr"
  },
  "contacts_count": -63486686,
  "created_at": "eu irure esse cillum",
  "id": "381e4f47-9dd8-18d3-a626-5f76766eb2f8",
  "name": "id laborum aute laboris ullamco",
  "next_sample_update": "ad",
  "parent_list_ids": [
    "nulla ut",
    "sint",
    "enim tempor",
    "velit dolor"
  ],
  "query_version": "nulla Lorem",
  "sample_updated_at": "quis elit ex",
  "status": {
    "error_message": "culpa Lorem proident quis",
    "query_validation": "sit"
  },
  "updated_at": "enim irure non"
}
{
  "errors": [
    {
      "field": "qui deserunt pariatur",
      "message": "incididunt mollit"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "et dolore ut ea",
      "message": "esse sit aliqua irure Excepteur"
    }
  ]
}
Request Payload
{
  "name": "esse",
  "query_dsl": "occaecat ad"
}
Response Payload
{
  "contacts_count": 39442265,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "aliqua magna",
  "id": "58c288ec-e92f-edb2-cea9-a538a3c54ebe",
  "name": "proident nisi dolore eu aliqua",
  "next_sample_update": "in ipsum sunt",
  "parent_list_ids": [
    "est quis Lorem"
  ],
  "query_dsl": "cillum velit ea veniam",
  "query_version": "dolore esse culpa ut",
  "sample_updated_at": "nulla in",
  "status": {
    "error_message": "cupidatat anim velit esse sint",
    "query_validation": "eu nisi velit est"
  },
  "updated_at": "culpa"
}
{
  "errors": [
    {
      "field": "sint Duis Ut",
      "message": "Duis irure commodo pariatur labore"
    },
    {
      "field": "cillum",
      "message": "laboris"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "exercitation",
      "message": "proident ut nostrud"
    },
    {
      "field": "elit cillum aute",
      "message": "reprehenderit consectetur fugiat dolore"
    }
  ]
}
Query Parameter NameExample
contacts_sampletrue
Request Payload
Response Payload
{
  "contacts_count": 23530785,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "in exercitation enim elit est",
  "id": "b9d71db8-2955-8659-a3ba-c4de4d4c5eba",
  "name": "ex sed velit aute est",
  "next_sample_update": "deserunt dolore dolor mollit",
  "parent_list_ids": [
    "amet do",
    "tempor",
    "labore tempor magna",
    "ipsum qui eu non et"
  ],
  "query_dsl": "nostrud ullamco consectetur exercitation Duis",
  "query_version": "dolor nostrud",
  "sample_updated_at": "consectetur eiusmod mollit labore",
  "status": {
    "error_message": "dolor reprehenderit anim",
    "query_validation": "fugiat"
  },
  "updated_at": "ad reprehenderit"
}
{
  "errors": [
    {
      "field": "deserunt exercitation",
      "message": "nostrud id"
    },
    {
      "field": "elit",
      "message": "laborum exercitation incididunt id"
    },
    {
      "field": "Ut commodo",
      "message": "velit in in nisi sed"
    },
    {
      "field": "Excepteur consectetur quis",
      "message": "nostrud magna veniam"
    }
  ]
}
{
  "errors": [
    {
      "field": "id officia",
      "message": "sit minim"
    },
    {
      "field": "dolor est consectetur sed",
      "message": "eu esse et do"
    },
    {
      "field": "exercitation consectetur commodo esse",
      "message": "minim"
    },
    {
      "field": "dolore aliqua laborum adipisicing dolor",
      "message": "proident"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "ullamco",
      "message": "ad dolore laborum"
    },
    {
      "field": "dolor laboris id culpa",
      "message": "labore anim in magna"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "deserunt in minim sunt",
      "message": "deserunt incididunt fugiat esse"
    },
    {
      "field": "in et culpa pariatur aliquip",
      "message": "veniam"
    },
    {
      "field": "Lorem",
      "message": "veniam"
    },
    {
      "field": "mollit deserunt quis proident",
      "message": "qui"
    }
  ]
}

Senders

Header NameExample
on-behalf-of"nostrud aute enim incididunt laboris"
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": "ut pariatur"
    },
    {
      "message": "eiusmod in culpa laboris ea"
    },
    {
      "message": "eu Excepteur officia"
    }
  ]
}

Lists(7 operations)

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

Custom Fields(4 operations)

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

segmenting contacts(5 operations)

Request Payload
{
  "name": "ea in amet",
  "parent_list_id": "4fb37bdd-4e46-b656-3d69-7d71d211bd63",
  "parent_list_ids": [
    "sint nisi dolore et",
    "ipsum ad et ea sint",
    "dolore officia",
    "aliquip Ut elit",
    "elit Excepteur Ut aliqua"
  ],
  "query_dsl": "aliqua"
}
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": "esse dolore et"
    },
    {
      "message": "ut dolor reprehenderit exercitation esse"
    },
    {
      "message": "incididunt aliqua"
    },
    {
      "message": "sed"
    },
    {
      "message": "sed"
    }
  ]
}
Query Parameter NameExample
parent_list_idsid dolore velit aute
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": "deserunt ullamco in esse do"
    },
    {
      "message": "in"
    },
    {
      "message": "exercitation nisi proident sed incididunt"
    },
    {
      "message": "id officia ea culpa mollit"
    }
  ]
}
Query Parameter NameExample
query_jsonfalse
Request Payload
Response Payload
{
  "id": "3b049926-0a54-4a91-83f0-086ace63c530",
  "contacts_count": -83213117,
  "created_at": "voluptate sunt non fugiat",
  "sample_updated_at": "labore occaecat sunt enim",
  "updated_at": "sunt aliqui",
  "contacts_sample": [
    {
      "contact_id": "e70eac25-1431-4231-bccd-1cfab432301e",
      "primary_email": "KLTF@SurgGzlAxCPOqhOUHYNBLsfpfE.trh",
      "alternate_emails": [
        "dTeJZgU5uN9UYSo@nfIB.ijxg"
      ],
      "first_name": "ullamco esse culpa do",
      "last_name": "officia laboris veniam consequat",
      "address_line_1": "in occaecat labore est tempor",
      "address_line_2": "magna adipisicing",
      "city": "ƞó",
      "state_province_region": "culpa ut",
      "postal_code": -75218567,
      "country": "voluptate in in reprehenderit aliquip",
      "custom_fields": {
        "custom_field_name1": "amet deserunt mollit",
        "custom_field_name2": "minim consequat id"
      }
    },
    {
      "contact_id": "db637d33-bce1-462c-ae9c-91ec4f761de6",
      "primary_email": "t7N5TjDmKhC0@gfdifW.ua",
      "alternate_emails": [
        "gQol@Xcfilli.hc",
        "n4K7OdaVQh@YfsnF.ie",
        "TdnvS3nMStREn@miFjGzNDCPZWhiswJNxrFnOYdUAZEpesQ.yxpu",
        "xRzGDTTzzbYK@eJ.wpgb",
        "iI1rOpx2ct@aZhuYGZBxJLZ.phr"
      ],
      "first_name": "ea et eu",
      "last_name": "velit Ut laborum ipsu",
      "address_line_1": "labore",
      "address_line_2": "non",
      "city": "ĔȸąŸÂ¸ȠɏbɄ",
      "state_province_region": "deserunt dolore",
      "postal_code": -95171713,
      "country": "do",
      "list_ids": [
        "c712288b-2300-4069-bef4-2e05b5948ec3",
        "9003ef29-5eb7-4951-898b-1b102e490d6e"
      ]
    }
  ],
  "name": "enim et anim",
  "query_dsl": "nostrud"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "est nostrud minim Excepteur",
      "message": "et voluptate in ut ea"
    },
    {
      "field": "aliquip voluptate",
      "message": "anim incididunt reprehenderit dolore"
    },
    {
      "field": "aliquip in tempor",
      "message": "incididunt ullamco dolor"
    },
    {
      "field": "non deserunt fugiat enim cupidatat",
      "message": "aliquip"
    },
    {
      "field": "nulla sed",
      "message": "voluptate sint"
    }
  ]
}
{
  "errors": [
    {
      "message": "est do in ullamco quis"
    },
    {
      "message": "ullamco aliqua velit ut nisi"
    },
    {
      "message": "dolor tempor amet"
    },
    {
      "message": "nostrud"
    }
  ]
}
Request Payload
{
  "name": "in nostrud dolore cupidatat cillum",
  "parent_list_ids": [
    "laboris Lorem dolor"
  ],
  "query_dsl": "Excepteur do esse dolor"
}
Response Payload
{
  "id": "5fff6250-b766-4959-a183-2e1fa565c4ce",
  "contacts_count": -35493018,
  "created_at": "2014-12-23T17:18:52.907Z",
  "sample_updated_at": "2146-04-13T16:46:32.328Z",
  "updated_at": "4389-06-21T16:59:51.403Z",
  "contacts_sample": [
    {
      "contact_id": "4cff9fdf-1bee-44f7-95dc-a101f9ed3cfe",
      "primary_email": "exmS@KIzibBSmaUUHQa.uvv",
      "alternate_emails": [
        "qXP-RD97fLl@oEDaUynqnNRHJHdoJAWVGXwvI.qlv",
        "W0ngFWmR@WcQuSbPFVPZvLrjCFadfimFi.eqf",
        "mYBC0ea5UxFI@qwO.jh",
        "Nhf1OmY@KCSjTQsXYpbKrBUsQFHrnLuY.oef"
      ],
      "first_name": "consequat nulla in",
      "last_name": "irure nostrud elit eu",
      "address_line_1": "deserunt cillum aliqua nostrud ullamco",
      "address_line_2": "sint",
      "city": "ŷ(ç",
      "state_province_region": "minim",
      "postal_code": 62721676,
      "country": "consectetur quis voluptate",
      "list_ids": [
        "f9d5987d-7a01-4a66-b77e-1f08a392304b",
        "b4e3b028-01d4-428b-9ef5-24bcd90fa02c",
        "fedab84f-9aa5-449d-99e2-7b1361f8ee61"
      ]
    },
    {
      "contact_id": "093a66b8-bca8-4d8a-b32a-091d939c1928",
      "primary_email": "atNeYGC4nbF42@VOCUWuGaYr.ystm",
      "alternate_emails": [
        "Zs6vnQbMU@XTamDsXEGJWBMMEacOc.hitv",
        "Epl@ySBrQCFJZnjggkAYLu.ppta"
      ],
      "first_name": "est",
      "last_name": "in",
      "address_line_1": "culpa eu eiusmod sint",
      "address_line_2": "sed velit sint",
      "city": "BĊJ",
      "state_province_region": "Lorem Ut aliqua elit",
      "postal_code": 33736880,
      "country": "in laboris Excepteur consequat",
      "custom_fields": {
        "custom_field_name2": "culpa Excepteur",
        "custom_field_name1": "esse magna Ut"
      }
    },
    {
      "contact_id": "08939f9c-2c87-4639-bd07-16d41f90a5eb",
      "primary_email": "Jx660QHClqRrC@SavQvcdRpJlLqepwoEUCm.ar",
      "alternate_emails": [
        "S8u@ZVGjHsXdSWtlhhad.ximc",
        "GA1MN72v3uA@MPDvMUmTYjwFCsEaGnFnvVzJVqUTl.ehws"
      ],
      "first_name": "sed eu veli",
      "last_name": "aliqua sit culpa",
      "address_line_1": "occaecat aute enim",
      "address_line_2": "ipsum quis in",
      "city": "ɌſĕĝȤ¶Ǖ",
      "state_province_region": "ut nisi sed esse",
      "postal_code": -66445052,
      "country": "occaecat veniam"
    },
    {
      "contact_id": "0667ed97-7b7b-44aa-a115-0301067660d7",
      "primary_email": "AnoFtJq@IolRDmfj.njt",
      "alternate_emails": [
        "F5WhHCA3oL6Ix@wOKzwIsvHbFi.mrlc"
      ],
      "first_name": "do mollit velit",
      "last_name": "voluptate dolor",
      "address_line_1": "et incididunt",
      "address_line_2": "veniam quis non exercitation Duis",
      "city": "DzƐȹŲdž",
      "state_province_region": "occaecat",
      "postal_code": -19694583,
      "country": "reprehenderit",
      "custom_fields": {
        "custom_field_name1": "dolor aute irure Excepteur"
      },
      "list_ids": [
        "ffd225a8-2008-4457-87af-1cffff5b1ccb"
      ]
    },
    {
      "contact_id": "449767ca-d446-45f1-aa9b-432f441b5ca1",
      "primary_email": "kF4@gYYdAxzetJrWszLAHuBUTu.rzq",
      "alternate_emails": [
        "ksqbx6BInlB@ouWBjjxwFBwVQjdnEKXy.xi",
        "TAe7F2m8dFlF@SirYykzbe.aj",
        "T9c2Y@HjVQY.zz",
        "p7ShfET@vMMnTUqoqngPSEqbpyoeWN.jlqn",
        "0VJSIhIUT2k@mJXVtdZVKKswW.xoca"
      ],
      "first_name": "irure laboris minim",
      "last_name": "id nostrud aliqua sit",
      "address_line_1": "dolor",
      "address_line_2": "elit ex labore sunt aliquip",
      "city": "ÝǘźƝǝƉ‘Ɲ",
      "state_province_region": "nostrud Duis non nulla laborum",
      "postal_code": 60466925,
      "country": "id sunt nisi",
      "custom_fields": {
        "custom_field_name2": "enim quis",
        "custom_field_name1": "amet"
      },
      "list_ids": [
        "2870627c-b9ea-4dcf-bde0-36c3e0e3eca9",
        "575d86aa-4dcc-4b7d-b7de-ded856913198",
        "fb82a17f-5777-439d-9b8c-2c565c8ddf20"
      ]
    }
  ],
  "name": "List Name",
  "query_dsl": "Email LIKE %twilio.com"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "Ut qui irure Lorem labore",
      "message": "laborum exercitation proident dolor elit"
    },
    {
      "field": "magna non cillum",
      "message": "do"
    }
  ]
}
{
  "errors": [
    {
      "message": "cupidatat do laborum irure"
    },
    {
      "message": "Excepteur"
    },
    {
      "message": "eiusmod"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "in",
      "message": "veniam aliqua ad"
    },
    {
      "field": "aliquip dolore",
      "message": "sit ipsum veniam"
    }
  ]
}
{
  "errors": [
    {
      "message": "aute nostrud"
    }
  ]
}

Segmenting Contacts

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

Single Sends(11 operations)

Request Payload
{
  "name": "Example API Created Single Send",
  "categories": [
    "unique opens"
  ],
  "send_to": {
    "all": true
  },
  "email_config": {
    "design_id": "<your-design-id>",
    "editor": "design",
    "suppression_group_id": 12345,
    "sender_id": 1234567
  }
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "error_id": "ut aute veniam",
      "field": "nisi mollit dolore",
      "message": "eiusmod mollit"
    },
    {
      "error_id": "magna Lorem nostrud laboris",
      "field": "esse irure",
      "message": "in"
    },
    {
      "error_id": "dolore mollit aliquip commodo",
      "field": "ex veniam reprehenderit aute consectetur",
      "message": "sint id adipisicing"
    },
    {
      "error_id": "esse dolore labore fugiat non",
      "field": "est reprehenderit nulla quis velit",
      "message": "voluptate velit"
    },
    {
      "error_id": "ipsum Duis id sed",
      "field": "ullamco voluptate eu",
      "message": "cillum labore magna elit adipisicing"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ipsum Excepteur culpa voluptate amet",
      "field": "eiusmod",
      "message": "in exercitation commodo"
    },
    {
      "error_id": "sed culpa consectetur",
      "field": "esse Ut nulla minim adipisicing",
      "message": "ea laborum cupidatat veniam"
    },
    {
      "error_id": "incididunt ullamco ut elit anim",
      "field": "aute officia ut ex reprehenderit",
      "message": "sint aliqua aute Excepteur irure"
    },
    {
      "error_id": "voluptate deserunt amet tempor ullamco",
      "field": "in occaecat fugiat",
      "message": "exercitation tempor consectetur Excepteur"
    },
    {
      "error_id": "laborum",
      "field": "ad elit quis amet ipsum",
      "message": "cillum nulla"
    }
  ]
}
Query Parameter NameExample
page_size83249289
page_tokenconsectetur aute laboris ad
Request Payload
Response Payload
{
  "_metadata": {
    "count": 60477815,
    "next": "https://tcFLwdKwEYkHuPpdKMUtD.ubvnPb,Er.QzO+vr0NQt",
    "prev": "https://WgAYZbRjnTmItviPzVdOVU.tjo.nq.JY5PVNt9hIbYeW+OYVWRjSOXXCBtzxrChAmifSuYEozl-AS",
    "self": "https://bSgyktfgNZmaNOBzCvlBRqQXDVihDMlv.colGgh6+gN1DfqDsq-z7nyzb5sQWGmY6QQT7B2UtyisGgoz+D5H,TV6"
  },
  "result": [
    {
      "abtest": {
        "duration": "consectetur",
        "expiration_date": null,
        "test_percentage": -70909363,
        "type": "subject",
        "winner_criteria": "manual",
        "winner_selected_at": "proident",
        "winning_template_id": "exercitation reprehenderit Ut cillum occaecat"
      },
      "categories": [
        "ullamco dolor",
        "culpa ea cillum id adipisicing",
        "commodo dolore ut",
        "amet",
        "aute",
        "cillum",
        "cillum nisi do adipisicing consequat",
        "proident irure veniam",
        "proident do non consequat enim",
        "esse sed ut ipsum do"
      ],
      "created_at": "1924-05-18T04:42:34.0Z",
      "id": "617c6bc5-cc5c-aad9-b681-a6ca591693a1",
      "is_abtest": true,
      "name": "ea magna id cillum dolore",
      "send_at": "1956-11-11T08:49:14.0Z",
      "status": "triggered",
      "updated_at": "1892-02-29T01:13:32.0Z"
    },
    {
      "abtest": {
        "duration": "exercitation",
        "expiration_date": "qui est",
        "test_percentage": 98825602,
        "type": "content",
        "winner_criteria": "click",
        "winner_selected_at": null,
        "winning_template_id": "ipsum laboris"
      },
      "categories": [
        "adipisicing consectetur aliquip occaecat Lorem",
        "eiusmod Excepteur",
        "in qui dolor labore",
        "fugiat do ut",
        "Excepteur incididunt dolor Lorem",
        "ut est",
        "consequat esse deserunt proident",
        "proident nostrud nulla",
        "velit",
        "Ut"
      ],
      "created_at": "1897-11-20T11:58:01.0Z",
      "id": "2393247a-08de-cd61-18ec-770539a74c48",
      "is_abtest": true,
      "name": "id p",
      "send_at": "1968-07-25T23:21:42.0Z",
      "status": "scheduled",
      "updated_at": "1937-08-02T18:36:45.0Z"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "veniam mollit consectetur",
      "field": "adipisicing",
      "message": "exercitation aute qui"
    },
    {
      "error_id": "laborum",
      "field": "id aliqua",
      "message": "nisi"
    },
    {
      "error_id": "cillum eu",
      "field": "irure labore laborum Lorem",
      "message": "labore consequat nisi mollit laborum"
    },
    {
      "error_id": "ex reprehenderit pariatur Duis minim",
      "field": "eiusmod",
      "message": "voluptate enim"
    }
  ]
}
Query Parameter NameExample
ids["aute","in","eiusmod veniam","aliqua dolore culpa","ut adipisicing cupidatat","incididunt eiusmod","culpa","eiusmod ipsum eu aute labore","esse commodo labore","dolore exercitation"]
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "adipisicing aliquip",
      "field": "quis ea irure",
      "message": "Duis et culpa"
    },
    {
      "error_id": "laboris dolor",
      "field": "eiusmod aute Ut sit elit",
      "message": "Excepteur qui"
    },
    {
      "error_id": "nulla consectetur nisi do",
      "field": "dolor ut",
      "message": "quis proident qui"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "in veniam sint reprehenderit",
      "field": "deserunt esse enim",
      "message": "Ut labore"
    },
    {
      "error_id": "ullamco consequat",
      "field": "culpa",
      "message": "laboris ullamco esse ut dolore"
    },
    {
      "error_id": "irure amet esse",
      "field": "nostrud Duis ullamco consectetur",
      "message": "laborum aliqua cupidatat nostrud"
    },
    {
      "error_id": "Duis sed",
      "field": "ullamco non dolor in",
      "message": "veniam velit laborum minim sit"
    },
    {
      "error_id": "eiusmod ea aliqua mollit exercitation",
      "field": "do aute et in irure",
      "message": "in eiusmod dolor"
    }
  ]
}
Request Payload
{
  "name": "proident"
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "error_id": "occaecat qui pariatur dolore",
      "field": "non sed exercitation dolore",
      "message": "quis enim nulla cillum"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "labore aute non esse ad",
      "field": "dolor ad",
      "message": "laboris eiusmod Duis"
    },
    {
      "error_id": "labore mollit est",
      "field": "mollit",
      "message": "tempor dolor"
    },
    {
      "error_id": "fugiat in consequat",
      "field": "est anim",
      "message": "Duis"
    },
    {
      "error_id": "eiusmod sit",
      "field": "culpa",
      "message": "in amet Excepteur Lorem voluptate"
    },
    {
      "error_id": "sint minim",
      "field": "laborum id consectetur culpa",
      "message": "adipisicing"
    }
  ]
}
Request Payload
{
  "categories": [
    "anim sint commodo",
    "ipsum",
    "dolor",
    "ea qui occaecat",
    "culpa",
    "ullamco mollit",
    "Ut nulla ut aliqua dolor",
    "sint velit quis",
    "laborum",
    "culpa Ut veniam ullamco tempor"
  ],
  "email_config": {
    "custom_unsubscribe_url": "https://DoBnfFTaGMzhOOsYqMKGgrBPt.igoypWwZr7FEjmiTXH-luQT7KiuYUfKqrEMN6mlW.kGzHzhY1d09R+ah3",
    "design_id": "ipsum laboris labore reprehenderit",
    "editor": "code",
    "generate_plain_content": true,
    "html_content": "laboris anim sed",
    "ip_pool": "Lorem eiusmod in proident",
    "plain_content": "laborum ullamco ut voluptate ad",
    "sender_id": null,
    "subject": "Excepteur in Duis",
    "suppression_group_id": 9660423
  },
  "name": "Ut adipisicing Excepteur sed",
  "send_at": "1899-05-25T14:22:42.0Z",
  "send_to": {
    "all": true,
    "list_ids": [
      "b740c560-415b-0f28-633b-0093f7bde4a4",
      "80cc2ffc-b34e-1165-31ed-183fbcd60cb1",
      "f95b61fc-4d90-f875-9a74-f0c8629fb2a6",
      "0592acde-ca39-174b-3d86-dafb90c04f64",
      "4f93e044-f160-fa7a-ecf2-3120c7d0e8f0",
      "833c88b0-150e-9298-7a12-d5e856449fd1",
      "33863843-c90d-7758-8d07-1578faebe2bd",
      "30c04e22-da15-f538-de1e-0acb1b372f72",
      "ddb45169-61fb-553e-a780-b4d3fd73b3d0",
      "e0e88bcc-31dc-3063-81fb-ef0ab83a3741"
    ],
    "segment_ids": [
      "9af1fb85-f1bf-0463-71d2-0bc6c822ebc5",
      "006cd60f-df24-747b-93ca-51e6f3a82af3",
      "8287c3e0-2001-0b48-6882-36ce9426ade6",
      "982e3a9a-4853-1d66-f5be-366a69b06a58",
      "dd3d44ad-6baf-af88-1d1e-7b50d78faf3e",
      "f2795b46-a315-1a04-cc06-e37ece7b3d31",
      "5102d1a2-2bb9-554f-cd6b-3bd2d5cc1887",
      "92256db8-5871-8c3c-2adc-e709cee36e67",
      "8db7e21c-07a7-2ecc-20aa-a4a8b2d00612",
      "879d8f5f-afce-0090-7590-fbe750a253d1"
    ]
  }
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "error_id": "veniam in do",
      "field": "consectetur",
      "message": "aliqua nulla commodo"
    },
    {
      "error_id": "sint quis ullamco ipsum",
      "field": "exercitation pariatur veniam aute",
      "message": "Excepteur"
    },
    {
      "error_id": "laboris Excepteur commodo ex ad",
      "field": "dolore consequat non",
      "message": "non tempor quis ullamco"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "anim ut",
      "field": "nulla dolore Ut occaecat laborum",
      "message": "aliqua ad dolor esse"
    },
    {
      "error_id": "Excepteur laborum",
      "field": "magna",
      "message": "magna"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sint ipsum",
      "field": "elit laborum",
      "message": "amet"
    },
    {
      "error_id": "dolore officia",
      "field": "ea eu Lorem ipsum in",
      "message": "eu laborum aliqua elit adipisicing"
    },
    {
      "error_id": "tempor nisi nostrud",
      "field": "esse sit Excepteur sint nostrud",
      "message": "sint cillum"
    },
    {
      "error_id": "ullamco ea",
      "field": "eiusmod",
      "message": "est nulla deserunt"
    },
    {
      "error_id": "sint",
      "field": "eu eiusmod",
      "message": "tempor ut ullamco veniam"
    }
  ]
}
Request Payload
Response Payload
{
  "name": "single-send-1",
  "id": "2f6dec81-43b9-4c67-a890-3a38cb63b54a",
  "status": "scheduled",
  "created_at": "2020-12-13T16:24:42.013Z",
  "send_to": {
    "segment_ids": [
      "dad84de3-bec4-4e04-b132-2cbfd4bb3789",
      "7dce758d-1155-4102-88d2-ca65565ac98b"
    ],
    "all": true
  }
}
{
  "errors": [
    {
      "error_id": "nulla Duis",
      "field": "nulla dolor Lorem non",
      "message": "ut in dolor"
    },
    {
      "error_id": "enim nulla deserunt voluptate",
      "field": "amet anim pariatur",
      "message": "mollit reprehenderit"
    },
    {
      "error_id": "magna sint aliquip ex laboris",
      "field": "exercitation tempor",
      "message": "veniam"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "dolor sed in non",
      "field": "Excepteur cillum in in",
      "message": "ullamco dolore"
    },
    {
      "error_id": "esse Lorem in qui aliqua",
      "field": "incididunt veniam deserunt Excepteur",
      "message": "minim ullamco dolore incididunt aute"
    },
    {
      "error_id": "exercitation adipisicing in est",
      "field": "nisi sit",
      "message": "magna tempor enim culpa"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "in mollit",
      "field": "in nostrud minim",
      "message": "laborum ut"
    },
    {
      "error_id": "deserunt mollit quis tempor",
      "field": "cillum veniam in Excepteur ipsum",
      "message": "ut cillum laborum sunt"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "in Excepteur Duis velit officia",
      "field": "magna amet sit",
      "message": "deserunt sunt cillum exercitation mollit"
    }
  ]
}
Query Parameter NameExample
page_size8384769
page_tokenullamco in reprehenderit officia aute
Request Payload
{
  "name": "specific-single-send-name",
  "status": [
    "draft",
    "scheduled"
  ],
  "categories": [
    "shoes"
  ]
}
Response Payload
{
  "result": [
    {
      "id": "df25ffdf-6a96-458a-9419-6d87d3094c6b",
      "name": "single-send-1",
      "status": "triggered",
      "categories": [
        "shoes"
      ],
      "is_abtest": true,
      "updated_at": "3263-04-09T09:05:08.193Z",
      "created_at": "4739-10-29T07:11:32.476Z",
      "send_at": "2471-05-31T15:46:18.797Z"
    }
  ],
  "_metadata": {
    "self": "nwNSrPSWt7d",
    "prev": "P0Enoayd",
    "next": "DYEsTUDww9-",
    "count": 1
  }
}
{
  "errors": [
    {
      "error_id": "minim sint est deserunt",
      "field": "in incididunt id esse",
      "message": "eiusmod"
    },
    {
      "error_id": "dolore",
      "field": "adipisicing consectetur sunt magna",
      "message": "et minim ullamco aliqua amet"
    },
    {
      "error_id": "ullamco",
      "field": "sunt Duis exercitation tempor et",
      "message": "aute do cupidatat consectetur proident"
    }
  ]
}
Request Payload
{
  "send_at": "3752-01-28T23:21:52.575Z"
}
Response Payload
{
  "send_at": "3752-01-28T23:21:52.575Z",
  "status": "scheduled"
}
{
  "errors": [
    {
      "error_id": "elit",
      "field": "Ut tempor voluptate",
      "message": "dolor exercitation dolore"
    },
    {
      "error_id": "sunt quis aliquip dolor tempor",
      "field": "anim",
      "message": "consectetur ullamco voluptate pariatur"
    },
    {
      "error_id": "dolore dolore magna sed labore",
      "field": "nisi",
      "message": "occaecat"
    },
    {
      "error_id": "laboris",
      "field": "ut nostrud Lorem dolor",
      "message": "nulla reprehenderit consequat adipisicing mollit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "voluptate",
      "field": "reprehenderit",
      "message": "ullamco sint Excepteur"
    }
  ]
}
Request Payload
Response Payload
{
  "send_at": "1893-04-12T12:13:14.0Z",
  "status": "triggered"
}
{
  "errors": [
    {
      "error_id": "ut in officia consequat dolore",
      "field": "veniam",
      "message": "amet consequat sint"
    },
    {
      "error_id": "proident velit",
      "field": "ad fugiat",
      "message": "eu nostrud mollit elit"
    },
    {
      "error_id": "veniam id Duis",
      "field": "tempor",
      "message": "velit adipisicing"
    },
    {
      "error_id": "adipisicing eiusmod culpa cillum sed",
      "field": "cupidatat mollit commodo ullamco et",
      "message": "fugiat sint"
    },
    {
      "error_id": "adipisicing est ad",
      "field": "Duis consequat veniam commodo",
      "message": "officia"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "laborum dolore",
      "field": "in laboris",
      "message": "laborum adipisicing"
    },
    {
      "error_id": "cupidatat sit aute dolor",
      "field": "eiusmod officia",
      "message": "cupidatat do deserunt"
    },
    {
      "error_id": "quis labore fugiat mollit",
      "field": "dolor",
      "message": "Duis fugiat"
    },
    {
      "error_id": "proident Ut aliqua laborum culpa",
      "field": "pariatur amet in",
      "message": "sunt laboris velit qui"
    },
    {
      "error_id": "eiusmod adipisicing irure",
      "field": "officia anim magna occaecat sit",
      "message": "deserunt magna dolor"
    }
  ]
}
Request Payload
Response Payload
{
  "categories": [
    "equipment",
    "shoes",
    "sports"
  ]
}
{
  "errors": [
    {
      "error_id": "Ut ipsum dolor",
      "field": "occaecat voluptate aliquip",
      "message": "nostrud"
    },
    {
      "error_id": "culpa ea est laboris",
      "field": "enim dolor commodo occaecat in",
      "message": "officia ut incididunt id dolore"
    },
    {
      "error_id": "proident deserunt velit",
      "field": "laborum",
      "message": "voluptate exercitation dolor sunt culpa"
    },
    {
      "error_id": "dolor",
      "field": "tempor eu",
      "message": "in"
    },
    {
      "error_id": "sed et ullamco",
      "field": "aute in consequat",
      "message": "ex non id in ea"
    }
  ]
}

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["proident ut enim","consequat laborum proident tempor voluptate","aliqua","laboris ipsum tempor aliquip","est","adipisicing","id irure eu","nostrud Ut nulla est occaecat","in officia aute","ad laboris anim laborum ex"]
page_size89
page_tokenadipisicing quis est in aute
Request Payload
Response Payload
{
  "_metadata": {
    "count": -46303114.16155135,
    "next": "http://UjG.jkokrLrf4zH-qlfPA2ufXj",
    "prev": "https://YqpasCVeRckrhdwZsDlybCnbwi.skkbeHyOfRHHyJ36Ie9dDs2Bjxul6YLjiT",
    "self": "https://iaDd.xxP"
  },
  "results": [
    {
      "aggregation": "nostrud pariatur sit qui",
      "id": "7e45b109-82d6-32bf-7ea2-d69d3951c4ab",
      "stats": {
        "bounce_drops": 74784610,
        "bounces": 4037867,
        "clicks": 31053972,
        "delivered": -12284653,
        "invalid_emails": 75608092,
        "opens": 12964702,
        "requests": 60461945,
        "spam_report_drops": -92023553,
        "spam_reports": -60664345,
        "unique_clicks": 88544030,
        "unique_opens": -73207000,
        "unsubscribes": 51382281
      },
      "step_id": "reprehenderit cupidatat sed elit sit"
    },
    {
      "aggregation": "qui sint Excepteur",
      "id": "22f96ac1-fd16-ebf4-42be-658dcec4d57f",
      "stats": {
        "bounce_drops": -88975872,
        "bounces": 42179378,
        "clicks": 62158245,
        "delivered": 66476960,
        "invalid_emails": -95886300,
        "opens": -9242114,
        "requests": -32769367,
        "spam_report_drops": 9321276,
        "spam_reports": 94308094,
        "unique_clicks": -62019080,
        "unique_opens": 24815258,
        "unsubscribes": -62389383
      },
      "step_id": "ut do Duis incididunt ad"
    },
    {
      "aggregation": "eiusmod",
      "id": "76c34461-15ba-ff74-79e0-929ed67348ca",
      "stats": {
        "bounce_drops": -81522128,
        "bounces": -16888981,
        "clicks": -37629600,
        "delivered": 49318662,
        "invalid_emails": 6058871,
        "opens": 35635605,
        "requests": 79770537,
        "spam_report_drops": -33952448,
        "spam_reports": 71900021,
        "unique_clicks": 77085863,
        "unique_opens": -28054204,
        "unsubscribes": 57821619
      },
      "step_id": "commodo"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
group_by["step_id","step_id","step_id","step_id"]
step_ids["ccade175-5841-fdfb-7b2f-769fafea1064","c83ec632-00fb-c296-57f3-fda36462fb0f","917f8abb-bab1-a0fd-2a2b-1d254f6d1ee1","33bda4f5-e677-8310-2f72-219f176b87c2","efa132fc-6736-2fdf-15ca-fba42e430849"]
aggregated_byday
start_date1963-02-11
end_date1952-02-18
timezonevoluptate est amet quis laboris
page_size76
page_tokensunt
Request Payload
Response Payload
{
  "_metadata": {
    "count": -68177271.81099947,
    "next": "https://ccgZrLAILhhrUdOhmpVtjhtBYoIuNnz.votde6hAFT6d4GrBFO.Gx6d+uHxidV,HvIF.TdQ",
    "prev": "http://jDpjtIiTYBgvhdUXdgysDnHTri.ijxsGq+N0tf3hcfOE2qmxk4-hgfD+0CR,DNTD3pnkdtOExW9dy17wjyS",
    "self": "https://rYpZMiEiVLWcprcyJihIHxE.vruP9C+eeEHiZvmTI.7FDei8lWfqIohcrT,aojmK3ZeZZPMRwXLb,WCCGkNo9gDJ1b-q+8WEOe"
  },
  "results": [
    {
      "aggregation": "id veniam sed pariatur quis",
      "id": "5cdfc82e-aa3f-7159-9a0a-6d41d69efc72",
      "stats": {
        "bounce_drops": -57798025,
        "bounces": 78961517,
        "clicks": -96543030,
        "delivered": -86374523,
        "invalid_emails": -57115146,
        "opens": -84132500,
        "requests": 32817830,
        "spam_report_drops": -71172223,
        "spam_reports": 94931543,
        "unique_clicks": -43159567,
        "unique_opens": 31366995,
        "unsubscribes": 46244582
      },
      "step_id": "pariatur aute elit"
    }
  ]
}
{
  "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["fugiat ad","tempor aliquip ullamco consequat","magna","ullamco labore ea","sit deserunt nulla","anim esse velit sunt Excepteur","et","commodo anim","in","in ut dolor adipisicing eu"]
page_size39
page_tokensit voluptate mollit
Request Payload
Response Payload
{
  "_metadata": {
    "count": -51906926.131300725,
    "next": "https://zoXpxqqOsSZwkdlpHTXoAkBM.fqsgWVAFAvrhuJnZ+hUx5l+vmkaygKXDN8dgWD6KaUNL04Gmn5esBgXItMQAI8yPwiQSG",
    "prev": "http://PpweqyValNDOvFYNe.vzwwsOP3zuIFcQt6.ngEWk23cXDXuePu9TqPwhZpNrONJu-DNI8wQlSEfAutYvP0btu",
    "self": "http://asS.icnhTa4gLUw4pB41oPfVdEtrVhKqpl-IyOvJr3q8Ush4ddYwNopxj0m1MPI0HH"
  },
  "results": [
    {
      "ab_phase": "all",
      "ab_variation": "9e9be67d-a0ff-ed2e-a497-b9490533bbaa",
      "aggregation": "deserunt",
      "id": "f63a0a07-2d58-9b72-15b7-e76797d4a959",
      "stats": {
        "bounce_drops": 26896960,
        "bounces": -10920520,
        "clicks": -46376310,
        "delivered": 94492860,
        "invalid_emails": -92422183,
        "opens": 50489621,
        "requests": 73421671,
        "spam_report_drops": 31126111,
        "spam_reports": -27180740,
        "unique_clicks": -75591615,
        "unique_opens": -76136795,
        "unsubscribes": -75470397
      }
    },
    {
      "ab_phase": "send",
      "ab_variation": "86e5d339-cc18-354f-a049-4737b614e36a",
      "aggregation": "quis tempor id adipisicing",
      "id": "4a2edf3d-47c8-31f8-40a4-c43279639845",
      "stats": {
        "bounce_drops": -42018760,
        "bounces": 14608744,
        "clicks": -16849024,
        "delivered": -25638589,
        "invalid_emails": 78504487,
        "opens": 42001130,
        "requests": 16797084,
        "spam_report_drops": -90729305,
        "spam_reports": -64509662,
        "unique_clicks": 77608580,
        "unique_opens": -1541217,
        "unsubscribes": -96848593
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
aggregated_bytotal
start_date1910-01-18
end_date1939-02-16
timezonealiqua veniam et aute
page_size60
page_tokenut nostrud consequat ex dolore
group_by["ab_variation","ab_variation","ab_variation","ab_variation","ab_variation"]
Request Payload
Response Payload
{
  "_metadata": {
    "count": 77333774.63309968,
    "next": "http://bZoSLYgBxXpyecc.ddjxl6amxSxzYxoUUJV,UU-jQIjiTQI",
    "prev": "https://GTuRXjKqCmzNbB.rynhYTugdRjZGjWUilaZ1UypAD",
    "self": "https://kuREOvnVMdWo.ocWz3m6FutVgxTwv,Lzf"
  },
  "results": [
    {
      "ab_phase": "all",
      "ab_variation": "3041ffff-7bc2-2e79-f7b2-98c5e787ce8b",
      "aggregation": "Ut do ad",
      "id": "e8b40903-07bf-7ccb-cf35-01d8536f5c64",
      "stats": {
        "bounce_drops": 31669474,
        "bounces": -86923796,
        "clicks": 41758563,
        "delivered": 41694285,
        "invalid_emails": 31369058,
        "opens": -55030343,
        "requests": 92746578,
        "spam_report_drops": 75920157,
        "spam_reports": -54516645,
        "unique_clicks": -24202115,
        "unique_opens": -84735101,
        "unsubscribes": 11283588
      }
    },
    {
      "ab_phase": "send",
      "ab_variation": "317c2157-e334-e346-96b8-1ef109652013",
      "aggregation": "cupidatat ut dolore",
      "id": "3d048fc7-beb3-ee6c-ebb0-039e669449bc",
      "stats": {
        "bounce_drops": -67575402,
        "bounces": -98887865,
        "clicks": -67667520,
        "delivered": 58256105,
        "invalid_emails": -40602477,
        "opens": 41010552,
        "requests": 5021989,
        "spam_report_drops": 12300724,
        "spam_reports": 43027872,
        "unique_clicks": -62150382,
        "unique_opens": 72645482,
        "unsubscribes": 68700224
      }
    },
    {
      "ab_phase": "all",
      "ab_variation": "c0b3426e-66c4-1702-2095-b9f64f3702d4",
      "aggregation": "proident minim est consequat",
      "id": "dd044bb8-60d7-8c71-179c-e3c5fd997579",
      "stats": {
        "bounce_drops": -91251030,
        "bounces": 3009515,
        "clicks": 83421264,
        "delivered": 28916473,
        "invalid_emails": 26895140,
        "opens": 93010830,
        "requests": 90068428,
        "spam_report_drops": -94337797,
        "spam_reports": 35950502,
        "unique_clicks": 47818854,
        "unique_opens": 17925561,
        "unsubscribes": -47301021
      }
    },
    {
      "ab_phase": "send",
      "ab_variation": "7128e3d2-753b-470d-945a-c644a37b639b",
      "aggregation": "dolore",
      "id": "c612c5a1-52d0-9316-375b-4716100eada8",
      "stats": {
        "bounce_drops": 63219659,
        "bounces": 89730331,
        "clicks": 29371966,
        "delivered": 87560384,
        "invalid_emails": 65653384,
        "opens": 24736732,
        "requests": -76587336,
        "spam_report_drops": -34774737,
        "spam_reports": 10339040,
        "unique_clicks": 91796927,
        "unique_opens": 47295780,
        "unsubscribes": 59170735
      }
    },
    {
      "ab_phase": "all",
      "ab_variation": "229d9324-6e2f-575a-29e8-c27a2b556752",
      "aggregation": "irure in laboris",
      "id": "2b7b977b-63be-1cfc-9dd4-842be2ba7cac",
      "stats": {
        "bounce_drops": -80903737,
        "bounces": 73907884,
        "clicks": -11505682,
        "delivered": -84181935,
        "invalid_emails": 37135715,
        "opens": -33576848,
        "requests": -4140985,
        "spam_report_drops": 6080929,
        "spam_reports": 42773445,
        "unique_clicks": -42320312,
        "unique_opens": 20661888,
        "unsubscribes": -7465156
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
group_by["step_id","step_id","step_id","step_id","step_id"]
step_ids["12bb976f-eb58-f305-d902-56df07e1e648","66378337-01dd-940c-cc24-84fb803913a2","127a8238-bf6d-4fb0-ee2e-6334e5bf86c6","e2ab12ec-7914-e8a7-6389-058ec9db4dbf","85df99d9-331d-991c-81c5-8b44231caab1"]
page_size24
page_tokenmollit cupidatat nostrud
Request Payload
Response Payload
{
  "_metadata": {
    "count": 6487930.113318145,
    "next": "http://ocxoUflZJUBtTXlSuj.gsjiYHL7jvH.9SFdGI2WqZIg6UGJcAAxvu,KsNMTRlSowfebpikKJkCKag9og",
    "prev": "http://BjAZZ.xilHL4ccDiSCSlg.ahppZfus3",
    "self": "https://UFCJJqVAOxyuMWOkcDGSqFm.dhcjLO9NpSwC,+8XcEYJu2g1zNqeiZ"
  },
  "results": [
    {
      "clicks": 2467933,
      "step_id": "d0db7585-caff-497b-62b1-a598a2d9a18a",
      "url": "http://UoifFnvK.kpsfY-8btWJj8wHw.HmhciXxyhM9MjIX.rI.q9s",
      "url_location": 63643064
    },
    {
      "clicks": 40922260,
      "step_id": "81f9f5c9-2e91-5286-df68-9ef69b0c44c4",
      "url": "http://BctCJJSW.lvUSg8X9E4Gsjna7UtqmrnmXtcKyi77Ocl1t",
      "url_location": 92176155
    }
  ],
  "total_clicks": -91268035
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
page_size45
page_tokensint laborum esse magna cillum
group_by["ab_phase"]
ab_variation_id9fc4f828-7a8a-b9c3-889b-bfebcaab5c62
ab_phase_idsend
Request Payload
Response Payload
{
  "_metadata": {
    "count": -88869189.89677718,
    "next": "http://ADn.delK4EzfqptXyYKAvagMsSZ8AtOlT-",
    "prev": "http://ZOrcWt.ldBtwfdLlPOKO16mbwe08nvnjyFry64gW4kCcsy,G6PHuejPsrULC",
    "self": "http://CeoXLzqUHCMaKcbLjPd.tmdd8eITHiw8"
  },
  "results": [
    {
      "ab_phase": "send",
      "ab_variation": "46bbb230-4011-daf6-0da4-477a06236e2e",
      "clicks": 32360108,
      "url": "https://BbEccIlZiqte.ctyU9PKK43wEIz-6N88Ka",
      "url_location": 29815716
    },
    {
      "ab_phase": "all",
      "ab_variation": "f56493df-3f0f-2df6-9c05-8da23ee9b463",
      "clicks": 53168135,
      "url": "https://ICzExPAVCMbLFComKXidARbEKysAeWdZ.diVG,pVWxgSR1IV1m",
      "url_location": 40868439
    }
  ],
  "total_clicks": -92914387
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
Query Parameter NameExample
ids["consequat","commodo dolor laborum pariatur","elit nostrud qui consequat culpa","ipsum ut ex in fugiat","amet cillum commodo","reprehenderit aliqua incididunt","dolor exercitation officia","deserunt","cupidatat sunt ad officia","adipisicing"]
timezoneipsum eu
Request Payload
Response Payload
culpa nisi exercitation
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
ids["non laboris nostrud dolore dolore","aute consequat sit minim dolor","nulla laboris ut Duis quis","Ut deserunt dolore","occaecat id","ad","sunt exercitation commodo voluptate id","incididunt nostrud ut consequat in","consectetur esse voluptate minim occaecat","ipsum"]
timezoneminim quis
Request Payload
Response Payload
tempor anim dolor velit dolor
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Sender Identities API(6 operations)

Header NameExample
on-behalf-of"dolore irure nulla"
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"ipsum"
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"do consectetur"
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"ipsum pariatur consequat adipisicing qui"
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"consequat pariatur consectetur commodo qui"
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"in"
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"veniam et reprehenderit do"
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"reprehenderit deserunt sint dolore laboris"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1,
      "name": "the jones",
      "recipient_count": 1
    }
  ]
}
Header NameExample
on-behalf-of"aliqua irure"
Request Payload
[
  1,
  2,
  3,
  4
]
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "list id was invalid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
list_id-29311441
Header NameExample
on-behalf-of"aute voluptate sunt"
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*24507792
Header NameExample
on-behalf-of"commodo dolore"
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"in"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "delete_contacts",
      "message": "delete_contacts not a bool"
    },
    {
      "field": "list_id",
      "message": "Returned if list_id is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "List not found: 5"
    }
  ]
}
Query Parameter NameExample
page-89992744
page_size87294945
list_id*75602842
Header NameExample
on-behalf-of"in ullamco tempor"
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"pariatur ullamco"
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"ullamco"
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*83485720
recipient_id*71985589
Header NameExample
on-behalf-of"reprehenderit commodo amet eu"
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"ullamco nostrud consectetur culpa"
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"sint occaecat exercitation nisi"
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"reprehenderit nisi voluptate"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
{}
{
  "errors": [
    {
      "message": "No recipient ids provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
page-73939757
page_size-4085546
Header NameExample
on-behalf-of"Duis magna"
Request Payload
Response Payload
{
  "recipients": []
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"cillum do in"
Request Payload
Response Payload
{
  "status": [
    {
      "id": "worker_delay",
      "value": "delayed"
    },
    {
      "id": "worker_delay_seconds",
      "value": "75.0"
    }
  ]
}
Header NameExample
on-behalf-of"aliquip mollit minim voluptate"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 87246756.9574722,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "dYudH2@NQCQMOgrVCGgq.ap",
      "first_name": "labore sint",
      "id": "qui deserunt labore non consectetur",
      "last_clicked": null,
      "last_emailed": null,
      "last_name": null,
      "last_opened": null,
      "updated_at": -1110097.6124720871
    },
    {
      "created_at": -22939630.9901516,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "2bJlYvKCxvdv@Tdnxd.cm",
      "first_name": null,
      "id": "sed ex consequat",
      "last_clicked": 23374499.722716406,
      "last_emailed": null,
      "last_name": "enim Ut in",
      "last_opened": null,
      "updated_at": -80026194.58599946
    },
    {
      "created_at": -26744631.447681934,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "sikNsXHmPJqkuup@ukpxldAPGiqhO.wiqy",
      "first_name": null,
      "id": "proident non ullamco",
      "last_clicked": -38757309.123542204,
      "last_emailed": null,
      "last_name": null,
      "last_opened": -63739259.87609535,
      "updated_at": 97677581.89363107
    },
    {
      "created_at": 16552449.241860583,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "C-aXVtEZd0uR@s.gvas",
      "first_name": "proident exercitation in minim",
      "id": "Excepteur nisi anim ut enim",
      "last_clicked": null,
      "last_emailed": null,
      "last_name": null,
      "last_opened": 97286107.46031997,
      "updated_at": -19649386.650671646
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"culpa minim tempor laboris officia"
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"enim"
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"nisi exercitation sit"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"nulla consectetur sed velit"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
{field_name}laborum
Header NameExample
on-behalf-of"dolore ex dolor ut ea"
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"consequat consectetur in veniam ea"
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"do Duis"
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"deserunt dolor ex"
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"Lorem anim aliqua Excepteur pariatur"
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"Excepteur in ex"
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"Duis dolore sint anim Ut"
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"aliquip anim in et labore"
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*47912168
Header NameExample
on-behalf-of"elit nulla Lorem Duis exercitation"
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_idsunt eiusmod deserunt dolor
Header NameExample
on-behalf-of"esse aute"
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"aute"
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
page60373307
page_size-13026382
Header NameExample
on-behalf-of"ut"
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-24364506
categoryqui anim
offset62045550
Header NameExample
on-behalf-of"Excepteur anim culpa elit eu"
Request Payload
Response Payload
[
  {
    "category": "category 1"
  },
  {
    "category": "category 2"
  }
]
{
  "errors": [
    {
      "field": "sort_by",
      "message": "invalid sort value"
    }
  ]
}
Query Parameter NameExample
sort_by_metricsunt
sort_by_directionasc
start_date*consequat laboris ullamco voluptate ea
end_dateeiusmod
limit46774035
offset-75409634
aggregated_byday
Header NameExample
on-behalf-of"proident tempor"
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*sunt eu aliqua Ut sed
end_dateminim quis tempor id
categories*laboris labore deserunt in
limit-93865607
offset12130742
aggregated_byday
Header NameExample
on-behalf-of"do ullamco est Ut laborum"
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"deserunt ut"
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
limit55221314
offset22225826
Header NameExample
on-behalf-of"occaecat nulla irure ullamco"
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 nulla consequat"
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"laboris"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"qui"
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"sed Ut qui"
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"id dolore"
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 non id"
Request Payload
{
  "send_at": 1489451436
}
Response Payload
{
  "id": 21174201,
  "send_at": 43597191,
  "status": "deserunt pariatur officia"
}
{
  "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"officia anim velit irure nulla"
Request Payload
Response Payload
{
  "send_at": 1490778528
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"minim elit do deserunt tempor"
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"mollit"
Request Payload
{
  "to": "your.email@example.com"
}
Response Payload
{
  "to": "velit"
}
{
  "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"irure mollit laboris"
Request Payload
{
  "name": "example_name",
  "generation": "dynamic"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "example_name",
  "generation": "legacy",
  "versions": []
}
Query Parameter NameExample
generationslegacy
page_size*191.12394888308498
page_tokenExcepteur ipsum ad
Header NameExample
on-behalf-of"mollit et cupidatat in"
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": [
    {
      "": "nostrud ut pariatur dolore consectetur",
      "error_id": "fugiat nisi",
      "message": "ex nisi non cupidatat"
    }
  ]
}
Header NameExample
on-behalf-of"in Excepteur labore nulla"
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"nulla sed"
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"sint tempor cupidatat amet aliquip"
Request Payload
{
  "name": "new_example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "new_example_name",
  "versions": []
}
Header NameExample
on-behalf-of"Lorem quis labore aliqua"
Request Payload
Response Payload
{}

Transactional Templates Versions(5 operations)

Header NameExample
on-behalf-of"nostrud"
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"amet veniam est ex ut"
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"velit quis"
Request Payload
Response Payload
{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
  "active": 1,
  "name": "example_version_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "generate_plain_content": true,
  "subject": "<%subject%>",
  "updated_at": "2019-03-13 18:56:33",
  "editor": "code"
}
Header NameExample
on-behalf-of"dolore officia elit Lorem irure"
Request Payload
{
  "template_id": "Excepteur Ut qui",
  "active": 1,
  "name": "pariatur non incididunt commodo",
  "html_content": "dolor",
  "generate_plain_content": false,
  "subject": "aliquip nulla Ut",
  "editor": "design",
  "plain_content": "labore dolore"
}
Response Payload
{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
  "active": 1,
  "name": "example_version_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "generate_plain_content": true,
  "subject": "<%subject%>",
  "updated_at": "2019-03-13 18:56:33",
  "editor": "code"
}
Header NameExample
on-behalf-of"sed"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

Webhooks(7 operations)

Header NameExample
on-behalf-of"dolore Excepteur Lorem laborum"
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"aute commodo"
Request Payload
{
  "enabled": false,
  "url": "id aliqua",
  "group_resubscribe": true,
  "delivered": false,
  "group_unsubscribe": true,
  "spam_report": true,
  "bounce": false,
  "deferred": false,
  "unsubscribe": true,
  "processed": false,
  "open": false,
  "click": false,
  "dropped": false,
  "oauth_client_id": "reprehenderit in null",
  "oauth_client_secret": "ea in nostrud",
  "oauth_token_url": "cupidatat ad Ut"
}
Response Payload
{
  "enabled": true,
  "url": "mollit laborum",
  "group_resubscribe": false,
  "delivered": true,
  "group_unsubscribe": true,
  "spam_report": true,
  "bounce": true,
  "deferred": true,
  "unsubscribe": true,
  "processed": true,
  "open": true,
  "click": false,
  "dropped": true,
  "oauth_client_id": "anim sunt",
  "oauth_token_url": "ex"
}
Header NameExample
on-behalf-of"exercitation quis velit esse ad"
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": "aliquip"
    },
    {
      "message": "deserunt Lorem non ullamco"
    },
    {
      "message": "laborum eiusmod nulla voluptate enim"
    },
    {
      "message": "reprehenderit eiusmod ullamco laborum esse"
    },
    {
      "message": "cupidatat culpa irure"
    }
  ]
}
Query Parameter NameExample
limiteu voluptate elit dolor ipsum
offsetullamco sed officia aute
aggregated_bymonth
start_date*sint id ullamco
end_dateex aute sed voluptate
Header NameExample
on-behalf-of"aute et"
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"exercitation"
Request Payload
Response Payload
{
  "public_key": "anim quis in sint"
}
Header NameExample
on-behalf-of"tempor deserunt"
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"sunt"
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"aliqua ex tempor Excepteur"
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": "fugiat est"
    },
    {
      "message": "laborum enim ut ipsum proident"
    },
    {
      "message": "dolore"
    }
  ]
}
Header NameExample
on-behalf-of"minim sint quis"
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": "voluptate in esse"
    },
    {
      "message": "do"
    },
    {
      "message": "nostrud sed"
    },
    {
      "message": "nisi cillum qui"
    }
  ]
}
Header NameExample
on-behalf-of"in"
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": "cillum"
    },
    {
      "message": "qui exercitation et consequat veniam"
    },
    {
      "message": "incididunt sunt non veniam"
    },
    {
      "message": "in cillum"
    }
  ]
}
Header NameExample
on-behalf-of"est id eiusmod aliqua"
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": "mollit"
    }
  ]
}

Query(2 operations)

Query Parameter NameExample
query*magna consequat dolore in
limit606.9815020458963
Header NameExample
X-Query-Id"occaecat fugiat"
X-Cursor"commodo amet"
Authorization*"dolor Excepteur"
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*"minim"
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
queryconsequat cillum mollit
Header NameExample
Authorization*"cupidatat anim eu tempor sed"
Request Payload
Response Payload
{
  "status": "pending",
  "message": "An email will be sent to jane_doe@example.com when the CSV is ready to download."
}
{
  "errors": [
    {
      "message": "some error"
    }
  ]
}
{
  "errors": [
    {
      "message": "too many requests",
      "field": ""
    }
  ]
}
{
  "errors": [
    {
      "message": "internal server error"
    }
  ]
}
Header NameExample
Authorization*"aute"
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"eu incididunt in irure deserunt"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "open",
      "title": "Open Tracking",
      "description": "lorem ipsum... .",
      "enabled": true
    }
  ]
}
Header NameExample
on-behalf-of"do exercitation aliquip minim eu"
Request Payload
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"proident dolore"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"nisi adipisicing ut"
Request Payload
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"qui eu adipisicing"
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"ex laborum"
Request Payload
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"incididunt mollit veniam est"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"enim Excepteur consequat ut sit"
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"fugiat minim"
Request Payload
{
  "enabled": true,
  "landing": "landing page html",
  "url": "url",
  "replace": "replacement tag",
  "html_content": "html content",
  "plain_content": "text content"
}
Response Payload
{
  "enabled": true,
  "landing": "landing page html",
  "url": "url",
  "replace": "replacement tag",
  "html_content": "html content",
  "plain_content": "text content"
}

Stats(7 operations)

Query Parameter NameExample
limit-51112093
offset-79281641
aggregated_byweek
start_date*in reprehenderit
end_datequi
Header NameExample
on-behalf-of"proident magna velit pariatur mollit"
Request Payload
Response Payload
[
  {
    "date": "2015-11-03",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
countryCA
limit-35588793
offset6516655
aggregated_byday
start_date*elit esse
end_dateanim non sunt consequat
Header NameExample
on-behalf-of"eiusmod cillum Duis dolore"
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
limit72017611
offset49484932
aggregated_bymonth
start_date*laborum dolore adipisicing ullamco tempor
end_dateullamco
Header NameExample
on-behalf-of"consectetur"
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*ut adipisicing voluptate magna
end_dateeiusmod reprehenderit
aggregated_byday
Header NameExample
on-behalf-of"dolore eu pariatur ut tempor"
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*elit incididunt tempor do nulla
end_dateexercitation in
aggregated_byweek
Header NameExample
on-behalf-of"commodo cillum magna in"
Request Payload
Response Payload
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  }
]
Query Parameter NameExample
mailbox_providerssed nulla enim
limit44408100
offset-13312342
aggregated_bymonth
start_date*mollit
end_dateet labore sunt
Header NameExample
on-behalf-of"laborum sint reprehenderit eu nostrud"
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
browsersvoluptate minim
limit-56433370
offset35780102
aggregated_bymonth
start_date*ad velit tempor culpa officia
end_datealiqua sunt in labore est
Header NameExample
on-behalf-of"pariatur anim"
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-46656458
end_time75223006
Header NameExample
Accept*"ut"
on-behalf-of"nostrud laborum Lorem fugiat id"
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"anim do"
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"eiusmod sit nostrud sint labore"
Request Payload
Response Payload
[
  {
    "created": 1443651125,
    "email": "bounce1@test.com",
    "reason": "550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at  https://support.google.com/mail/answer/6596 o186si2389584ioe.63 - gsmtp ",
    "status": "5.1.1"
  }
]
Query Parameter NameExample
email_address*JJL0hhs4Q5@PeYDiQWLqWSwfLF.zn
Header NameExample
on-behalf-of"anim"
Request Payload
Error generating example
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Blocks API(4 operations)

Query Parameter NameExample
start_time37025834
end_time96761590
limit97395693
offset25068408
Header NameExample
on-behalf-of"ipsum adipisicing ullamco aliquip"
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"ex"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"eu voluptate"
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"reprehenderit in sit labore est"
Request Payload
Response Payload
{}

Spam Reports API(4 operations)

Query Parameter NameExample
start_time-66153806
end_time-50080522
limit-75587892
offset27435196
Header NameExample
on-behalf-of"laborum magna do sunt"
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"aliqua"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"eu consequat mollit deserunt est"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "ip": "10.89.32.5"
  }
]
Header NameExample
on-behalf-of"in consectetur id"
Request Payload
Response Payload
{}

Suppressions - Global Suppressions(4 operations)

Header NameExample
on-behalf-of"in elit et"
Request Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Response Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Query Parameter NameExample
start_time45144681
end_time20825037
limit-43082442
offset57554105
Header NameExample
on-behalf-of"minim aliqua deserunt nisi"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com"
  }
]
Header NameExample
on-behalf-of"dolor"
Request Payload
Response Payload
{
  "recipient_email": "test@example.com"
}
Header NameExample
on-behalf-of"eiusmod deserunt sunt"
Request Payload
Response Payload
{}

Suppressions - Unsubscribe Groups(5 operations)

Header NameExample
on-behalf-of"dolor est ipsum aliquip exercitation"
Request Payload
{
  "name": "Product Suggestions",
  "description": "Suggestions for products our users might like.",
  "is_default": true
}
Response Payload
{
  "id": 103,
  "name": "Product Suggestions",
  "description": "Suggestions for products our users might like.",
  "is_default": false
}
Query Parameter NameExample
id-44635958
Header NameExample
on-behalf-of"labore tempor occaecat"
Request Payload
Response Payload
[
  {
    "id": 1234,
    "name": "Unsubscribe Group",
    "description": "An Unsubscribe Group",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 1234
  },
  {
    "id": 1234,
    "name": "Unsubscribe Group",
    "description": "An Unsubscribe Group",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 1234
  }
]
Header NameExample
on-behalf-of"ut ut dolor"
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"tempor commodo reprehenderit"
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"ipsum in fugiat"
Request Payload
Response Payload
{}

Suppressions - Suppressions(6 operations)

Header NameExample
on-behalf-of"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 ea"
Request Payload
Response Payload
[
  "example@example.com",
  "example2@example.com"
]
Header NameExample
on-behalf-of"irure veniam amet"
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"esse"
Request Payload
Response Payload
[
  {
    "email": "test1@example.com",
    "group_id": 1,
    "group_name": "Weekly News",
    "created_at": 1410986704
  },
  {
    "email": "test1@example.com",
    "group_id": 2,
    "group_name": "Daily News",
    "created_at": 1411493671
  },
  {
    "email": "test2@example.com",
    "group_id": 2,
    "group_name": "Daily News",
    "created_at": 1411493671
  }
]
Header NameExample
on-behalf-of"do mollit culpa incididunt sunt"
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"aute ut nulla eiusmod amet"
Request Payload
Response Payload
Error generating example

Invalid Emails API(4 operations)

Query Parameter NameExample
start_time-17589104
end_time43506677
limit-53854540
offset-72944029
Header NameExample
on-behalf-of"commodo Lorem"
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"nulla irure tempor adipisicing"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"dolore ullamco eu sit"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]
Header NameExample
on-behalf-of"irure reprehenderit"
Request Payload
Response Payload
{}
Service Homepage: sendgrid.com/en-us
API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started
emails