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": "ad cillum"
    },
    {
      "message": "incididunt"
    },
    {
      "message": "exercitation sunt dolore"
    }
  ]
}

Cancel Scheduled Sends(7 operations)

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

API Keys(6 operations)

Header NameExample
on-behalf-of"adipisicing dolor velit nulla"
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": "qui"
    },
    {
      "message": "qui consequat quis"
    }
  ]
}
Query Parameter NameExample
limit-46118880
Header NameExample
on-behalf-of"laboris deserunt nulla ullamco qui"
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": "esse"
    }
  ]
}
Header NameExample
on-behalf-of"cupidatat irure eu velit dolor"
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": "cupidatat"
    },
    {
      "message": "aliquip Duis proident est sint"
    },
    {
      "message": "incididunt in dolor ut"
    }
  ]
}
Header NameExample
on-behalf-of"sed proident"
Request Payload
{
  "name": "A New Hope"
}
Response Payload
{
  "api_key_id": "qfTQ6KG0QBiwWdJ0-pCLCA",
  "name": "A New Hope"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "elit"
    },
    {
      "message": "cillum anim"
    }
  ]
}
Header NameExample
on-behalf-of"et anim sint fugiat Ut"
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": "Ut laborum proident sit ut"
    }
  ]
}
Header NameExample
on-behalf-of"laborum mollit et pariatur"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "non Excepteur eiusmod"
    },
    {
      "message": "cillum"
    }
  ]
}

API Key Permissions

Header NameExample
on-behalf-of"incididunt ea quis cupidatat"
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": "adipisicing"
    },
    {
      "message": "consectetur"
    }
  ]
}

Settings - Enforced TLS(2 operations)

Header NameExample
on-behalf-of"adipisicing anim deserunt non magna"
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 ex ipsum elit"
    },
    {
      "message": "sunt Lorem ullamco"
    }
  ]
}
Header NameExample
on-behalf-of"amet"
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": "non"
    }
  ]
}

IP Access Management(6 operations)

Header NameExample
on-behalf-of"nisi exercitation ea"
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": "ipsum"
    }
  ]
}
Header NameExample
on-behalf-of"dolore dolor adipisicing anim"
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": "sint ullamco"
    }
  ]
}
Header NameExample
on-behalf-of"commodo"
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": "laboris do"
    },
    {
      "message": "sunt in consequat ad veniam"
    },
    {
      "message": "ipsum"
    },
    {
      "message": "aliqua"
    },
    {
      "message": "elit velit dolore"
    }
  ]
}
Query Parameter NameExample
limit32573147
Header NameExample
on-behalf-of"ipsum Excepteur"
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": "minim"
    },
    {
      "message": "qui"
    },
    {
      "message": "pariatur"
    },
    {
      "message": "Duis aliquip irure"
    }
  ]
}
Header NameExample
on-behalf-of"non enim incididunt minim adipisicing"
Request Payload
Response Payload
{
  "id": 1,
  "ip": "192.168.1.1",
  "created_at": 1441824715,
  "updated_at": 1441824715
}
Header NameExample
on-behalf-of"dolor nostrud quis"
Request Payload
Response Payload
{}

Certificates(5 operations)

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

Single Sign-On Settings(5 operations)

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

Single Sign-On Teammates(2 operations)

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

Settings - Mail(13 operations)

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

Settings - Partner(3 operations)

Header NameExample
on-behalf-of"aliquip culpa qui non elit"
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"ex dolore velit consequat"
Request Payload
Response Payload
{
  "enable_subuser_statistics": false,
  "enabled": true,
  "license_key": ""
}
Query Parameter NameExample
limit11318974
offset36112468
Header NameExample
on-behalf-of"culpa et ex"
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"dolore"
Request Payload
{
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}
Response Payload
{
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}
{
  "errors": [
    {
      "message": "aliquip",
      "field": "mollit"
    }
  ]
}
Query Parameter NameExample
limit230
offset73603984
Header NameExample
on-behalf-of"est sit sed"
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"ipsum dolor"
Request Payload
Response Payload
{
  "pending_id": "abc123abc",
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}
{
  "errors": [
    {
      "message": "invalid pending key",
      "field": "pending_key"
    }
  ]
}
Query Parameter NameExample
limit-44244640
offset75343249
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"fugiat Duis eu"
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"anim consectetur velit"
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"fugiat eu"
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"dolore Ut eiusmod est officia"
Request Payload
Response Payload
{
  "errors": [
    {
      "message": "et ipsum esse",
      "field": "quis"
    },
    {
      "message": "ea adipisicing dolore elit veniam",
      "field": "in ad Duis"
    },
    {
      "message": "veniam",
      "field": "eu"
    },
    {
      "message": "ullamco dolor",
      "field": "laborum proident ea id laboris"
    },
    {
      "message": "adipisicing esse",
      "field": "in occaecat"
    }
  ]
}
{
  "errors": [
    {
      "message": "username not found",
      "field": "username"
    }
  ]
}
Request Payload
Response Payload
{
  "scope_group_name": "Stats"
}
{}
{
  "errors": [
    {
      "message": "ut pariatur elit in sit",
      "field": "esse exercitation"
    },
    {
      "message": "ipsum",
      "field": "nisi id culpa quis ad"
    }
  ]
}
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"mollit in in adipisicing anim"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "aliqua exercitation et",
      "field": "deserunt"
    },
    {
      "message": "deserunt proident ea voluptate quis",
      "field": "ea deserunt dolor non"
    },
    {
      "message": "cillum",
      "field": "fugiat in dolor minim velit"
    },
    {
      "message": "eu laborum anim nostrud nulla",
      "field": "id dolore"
    }
  ]
}

Alerts(5 operations)

Header NameExample
Authorization"officia consectetur deserunt"
on-behalf-of"aliqua sed dolore"
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": "esse",
  "message": "Duis labore officia"
}
Header NameExample
Authorization"ex commodo Lorem"
on-behalf-of"ex esse qui"
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"dolor ipsum irure qui esse"
on-behalf-of"sunt nulla fugiat reprehenderit"
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"officia culpa laborum nulla"
Request Payload
Response Payload
{}
Header NameExample
on-behalf-of"id"
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"qui non elit laborum sit"
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"id commodo aliqua"
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"reprehenderit proident non consequat commodo"
Request Payload
Response Payload
{
  "reputation": 100,
  "type": "paid"
}
Header NameExample
on-behalf-of"aliquip aliqua Excepteur laborum ea"
Request Payload
Response Payload
{
  "email": "test@example.com"
}
Header NameExample
on-behalf-of"in id dolore"
Request Payload
{
  "email": "example@example.com"
}
Response Payload
{
  "email": "example@example.com"
}
Header NameExample
on-behalf-of"deserunt mollit veniam"
Request Payload
Response Payload
{
  "username": "test_username",
  "user_id": 1
}
Header NameExample
on-behalf-of"nisi in ut"
Request Payload
{
  "username": "test_username"
}
Response Payload
{
  "username": "test_username"
}
Header NameExample
on-behalf-of"incididunt adipisicing sunt eiusmod nulla"
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"reprehenderit"
Request Payload
{
  "new_password": "new_password",
  "old_password": "old_password"
}
Response Payload
{}

Subusers API(6 operations)

Query Parameter NameExample
usernamelaborum ut esse Excepteur aliquip
limit-29489361
offset-78077598
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
usernamesanim minim
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*veniam ea enim
sort_by_metricut ad minim
sort_by_directiondesc
limit-26699240
offset-66852036
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*veniam
subuserdolore
sort_by_metricblocks
sort_by_directionasc
limit-81712066
offset56080467
Request Payload
Response Payload
{
  "date": "2016-02-01",
  "stats": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 0,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 1,
        "processed": 0,
        "requests": 100,
        "spam_report_drops": 0,
        "spam_reports": 99,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user1",
      "type": "subuser"
    },
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 10,
        "processed": 10,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user2",
      "type": "subuser"
    }
  ]
}
Query Parameter NameExample
sort_by_directiondesc
start_date*pariatur culpa amet
end_dateeu incididunt est
limit-43295993
offset5742029
aggregated_byconsectetur dolore
sort_by_metricDuis in incididunt pariatur
Request Payload
Response Payload
{
  "date": "2015-10-11",
  "stats": []
}
Query Parameter NameExample
limit59883034
offset53266437
aggregated_byday
subusers*anim dolore nisi
start_date*tempor dolor
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"velit ex amet sit"
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
limit90955163
offset48786884
ipDuis laborum in cupidatat
Header NameExample
on-behalf-of"ad minim deserunt"
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"nisi ullamco enim et"
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"consectetur voluptate"
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"cillum aliquip dolore"
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": "consequat laboris",
    "field": "ea"
  }
}

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
ipin et
exclude_whitelabelstrue
limit12990771
offset-45403503
subusereu
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
limit6179723
offset-38630107
exclude_subuserstrue
usernameex
domainanim
Header NameExample
on-behalf-of"cillum labore"
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"in"
Request Payload
{
  "domain": "example.com",
  "subdomain": "news",
  "username": "john@example.com",
  "ips": [
    "192.168.1.1",
    "192.168.1.2"
  ],
  "custom_spf": true,
  "default": true,
  "automatic_security": false
}
Response Payload
{
  "id": 302183,
  "user_id": 1446226,
  "subdomain": "example",
  "domain": "example.com",
  "username": "mbernier",
  "ips": [],
  "custom_spf": false,
  "default": true,
  "legacy": false,
  "automatic_security": true,
  "valid": false,
  "dns": {
    "mail_cname": {
      "valid": false,
      "type": "cname",
      "host": "example.example.com",
      "data": "u1446226.wl.sendgrid.net"
    },
    "dkim1": {
      "valid": false,
      "type": "cname",
      "host": "s1._domainkey.example.com",
      "data": "s1.domainkey.u1446226.wl.sendgrid.net"
    },
    "dkim2": {
      "valid": false,
      "type": "cname",
      "host": "s2._domainkey.example.com",
      "data": "s2.domainkey.u1446226.wl.sendgrid.net"
    }
  }
}
Header NameExample
on-behalf-of"do ipsum"
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"incididunt mollit commodo"
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"ut reprehenderit officia"
Request Payload
Response Payload
{}
Query Parameter NameExample
domainad
Header NameExample
on-behalf-of"non sint"
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"Excepteur labore"
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"Duis magna nostrud"
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"amet nulla ex"
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*dolor sit nostrud proident
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
usernameadipisicing cillum sit
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": "eiusmod ut amet esse nostrud"
    },
    {
      "message": "nulla et labore Duis"
    },
    {
      "message": "et irure consequat occaecat amet"
    }
  ]
}
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": "pariatur sint"
    },
    {
      "message": "ut ipsum esse"
    },
    {
      "message": "veniam ex"
    },
    {
      "message": "sint laborum ut ipsum"
    },
    {
      "message": "id in reprehenderit nostrud nulla"
    }
  ]
}
Request Payload
{
  "nickname": "Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105"
}
Response Payload
{
  "id": 1234,
  "nickname": "Example Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St.",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105",
  "verified": true,
  "locked": false
}
{
  "errors": [
    {
      "field": "minim",
      "message": "Ut ex consequat in",
      "error_id": "sint ea ut eiusmod"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "dolore magna exercitation"
    }
  ]
}
Query Parameter NameExample
limit22681627.259803742
lastSeenID-65373988.623238064
id-96599658
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": "et cupidatat nisi"
    },
    {
      "message": "velit laboris eiusmod"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "voluptate minim ipsum id proident",
      "error_id": "Lorem minim dolor"
    },
    {
      "message": "velit sed dolore sint dolor",
      "error_id": "et anim"
    },
    {
      "message": "commodo ad nulla exercitation cupidatat",
      "error_id": "aliquip sunt nulla nisi"
    }
  ]
}
{
  "errors": [
    {
      "message": "labore ipsum enim"
    },
    {
      "message": "irure dolore deserunt aute dolor"
    },
    {
      "message": "mollit"
    },
    {
      "message": "veniam Excepteur"
    }
  ]
}
Request Payload
{
  "nickname": "Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105"
}
Response Payload
{
  "id": 1234,
  "nickname": "Example Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St.",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105",
  "verified": true,
  "locked": false
}
{
  "errors": [
    {
      "field": "cupidatat",
      "message": "pariatur dolor ipsum",
      "error_id": "in officia commodo laboris qui"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "reprehenderit commodo fugiat eiusmod",
      "error_id": "tempor Duis proident sunt"
    },
    {
      "message": "in",
      "error_id": "pariatur est reprehenderit sed"
    }
  ]
}
{
  "errors": [
    {
      "message": "dolore in ea",
      "error_id": "Lorem amet ut dolor"
    },
    {
      "message": "commodo elit tempor ipsum sunt",
      "error_id": "cupidatat labore"
    },
    {
      "message": "labore",
      "error_id": "exercitation incididunt sunt in anim"
    }
  ]
}
{
  "errors": [
    {
      "message": "irure cupidatat dolore ea"
    },
    {
      "message": "aute pariatur cupidatat in qui"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "in",
      "error_id": "qui"
    },
    {
      "message": "sit irure eu in",
      "error_id": "commodo"
    },
    {
      "message": "voluptate do",
      "error_id": "esse pariatur dolor do"
    }
  ]
}
{
  "errors": [
    {
      "message": "in et nisi sunt",
      "error_id": "enim aliquip Duis ipsum Lorem"
    },
    {
      "message": "do deserunt fugiat eiusmod",
      "error_id": "in"
    },
    {
      "message": "officia Duis dolore mollit quis",
      "error_id": "in nulla labore"
    }
  ]
}
{
  "errors": [
    {
      "message": "laboris Duis quis ut"
    },
    {
      "message": "dolore voluptate anim pariatur reprehenderit"
    },
    {
      "message": "nulla incididunt"
    },
    {
      "message": "laborum in nulla ea"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "message": "id in esse",
      "error_id": "dolore deserunt"
    },
    {
      "message": "occaecat ullamco amet sint in",
      "error_id": "officia"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ut tempor adipisicing nulla pariatur",
      "error_id": "non cillum"
    }
  ]
}
{
  "errors": [
    {
      "message": "est"
    },
    {
      "message": "in voluptate"
    },
    {
      "message": "esse ea officia in"
    },
    {
      "message": "officia sed enim commodo"
    },
    {
      "message": "sed fugiat et laboris"
    }
  ]
}

Designs API(9 operations)

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

Contacts(13 operations)

Request Payload
{
  "list_ids": [
    "fcd1ed7a-f83f-ad35-42c2-89d7fdd55ae1"
  ],
  "contacts": [
    {
      "address_line_1": "et nulla in",
      "address_line_2": "et",
      "alternate_emails": [
        "pariatur magna qui deserunt commodo",
        "labore Duis aliquip cupidatat in",
        "occaecat",
        "dolore consectetur",
        "irure labore culpa"
      ],
      "city": "pariatur qui",
      "country": "enim in",
      "email": "sint",
      "first_name": "n",
      "last_name": "Lorem quis non",
      "postal_code": "minim dolor ipsum ut culpa",
      "state_province_region": "esse laboris non",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "dolor magna nisi i",
      "address_line_2": "consectetur dolor eu nisi",
      "alternate_emails": [
        "ea",
        "culpa magna tempor est aliqua",
        "esse in",
        "adipisicing proident id",
        "sint proident"
      ],
      "city": "et occaecat amet",
      "country": "magna aute proident",
      "email": "sed officia eu irure consequat",
      "first_name": "occ",
      "last_name": "cons",
      "postal_code": "deserunt",
      "state_province_region": "laborum proide",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "anim consectetur nostrud et nisi",
      "address_line_2": "dolor dolore voluptate",
      "alternate_emails": [
        "ut dolore enim",
        "quis",
        "minim sed ullamco irure",
        "qui",
        "pariatur nisi enim"
      ],
      "city": "aliqua",
      "country": "qui Duis quis in ea",
      "email": "et irure",
      "first_name": "in esse ullamco nostrud",
      "last_name": "eius",
      "postal_code": "ad proident reprehenderit",
      "state_province_region": "cupidatat",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "voluptat",
      "address_line_2": "nulla",
      "alternate_emails": [
        "ut do cillum",
        "labore qui co",
        "quis ex ad magna",
        "occaecat minim in in reprehenderit",
        "est et id"
      ],
      "city": "cillum ",
      "country": "eiusmod",
      "email": "ut amet sed est Ut",
      "first_name": "anim eu",
      "last_name": "volu",
      "postal_code": "esse consequat voluptate",
      "state_province_region": "pa",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "ad exercitation veniam",
      "address_line_2": "nostrud irure in adipisicing",
      "alternate_emails": [
        "Lorem qui dolor ea",
        "esse",
        "ea tempor",
        "ipsum velit ut",
        "consectetur est"
      ],
      "city": "Lorem",
      "country": "ex magna",
      "email": "ullamco",
      "first_name": "consectetur d",
      "last_name": "ipsum rep",
      "postal_code": "voluptate quis",
      "state_province_region": "et nisi",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "n",
      "address_line_2": "labore anim",
      "alternate_emails": [
        "sit in",
        "sit anim",
        "pariatur Excepteur veniam eu",
        "sunt",
        "nulla deserunt laboris"
      ],
      "city": "culpa exercitation ex dolore",
      "country": "sit aliqua no",
      "email": "aute dolor in",
      "first_name": "velit Lorem f",
      "last_name": "eu incididunt Ut",
      "postal_code": "ut",
      "state_province_region": "sed eu in reprehenderit ut",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "adipisicing mollit minim occ",
      "address_line_2": "Duis in pariatur mollit nisi",
      "alternate_emails": [
        "qui proident nulla sit",
        "labore in eu f",
        "voluptate veniam magna",
        "culpa aute veniam magna",
        "est"
      ],
      "city": "minim in ut nisi commodo",
      "country": "nisi exercitation mollit et",
      "email": "commodo nisi voluptate",
      "first_name": "reprehenderit exercitation ullamco dolo",
      "last_name": "consectetur sed in sint",
      "postal_code": "Lorem dolore Duis",
      "state_province_region": "Lorem velit",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "",
      "address_line_2": "id ad",
      "alternate_emails": [
        "ut cupidatat fugiat",
        "consequat Ut",
        "culpa ",
        "est",
        "aute tempor Lorem consectetur ea"
      ],
      "city": "Duis sint irure",
      "country": "qui",
      "email": "consectetur esse quis culpa",
      "first_name": "ipsum exercitation",
      "last_name": "cupidatat",
      "postal_code": "ullamco commodo aliqua irure cillum",
      "state_province_region": "eiusmo",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "anim",
      "address_line_2": "voluptate ad",
      "alternate_emails": [
        "eiusmod qui ipsum dolor",
        "amet id",
        "laborum ad anim qui",
        "esse",
        "elit labore"
      ],
      "city": "nisi",
      "country": "reprehenderit ea in proi",
      "email": "anim",
      "first_name": "sint",
      "last_name": "sint eu labore amet ",
      "postal_code": "Lorem aliquip ipsum",
      "state_province_region": "in dolor deserunt ea",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "anim sunt do",
      "address_line_2": "ex proident dolor",
      "alternate_emails": [
        "et",
        "laborum enim qui sunt",
        "ut quis dolor anim aliquip",
        "in ullamco eiusmod",
        "dolor sunt sint mollit"
      ],
      "city": "sed consectetur culpa",
      "country": "ut sunt",
      "email": "tempor magna",
      "first_name": "enim dolor ea",
      "last_name": "Lorem dolore",
      "postal_code": "ad pariatur",
      "state_province_region": "reprehenderit amet",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    }
  ]
}
Response Payload
{
  "job_id": "proident eu dolore"
}
{
  "errors": [
    {
      "message": "laboris officia",
      "field": "dolore",
      "error_id": "elit proident sit eu",
      "parameter": "nostrud"
    },
    {
      "message": "pariatur mollit",
      "field": "dolore",
      "error_id": "nulla magna fugiat",
      "parameter": "aliqua voluptate pariatur ipsum"
    },
    {
      "message": "esse proident",
      "field": "in",
      "error_id": "Ut ut sint id dolore",
      "parameter": "voluptate eu"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "Ut nisi irure"
    },
    {
      "message": "Ut ipsum in Duis"
    },
    {
      "message": "et aliquip ex commodo adipisicing"
    },
    {
      "message": "sunt magna"
    },
    {
      "message": "qui"
    }
  ]
}
Query Parameter NameExample
delete_all_contactssit in
idsullamco ex culpa ipsum voluptate
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": "quis occaecat commodo"
    },
    {
      "message": "ullamco ut reprehenderit"
    },
    {
      "message": "do nostrud ad Duis"
    }
  ]
}
Request Payload
Response Payload
{
  "result": [
    {
      "id": "pariatur Lorem reprehenderit aliqua",
      "first_name": "proident",
      "last_name": "ut",
      "unique_name": "non esse eiusmod dolore minim",
      "email": "id",
      "alternate_emails": [
        "dolor minim culpa dolor",
        "anim ad",
        "amet tempor",
        "ea nisi voluptate",
        "labore ut incididunt proident veniam"
      ],
      "address_line_1": "sint",
      "address_line_2": "aute sint magna voluptate cupidatat",
      "city": "commodo aute irure sunt",
      "state_province_region": "ex id",
      "country": "minim sed ut dolore",
      "postal_code": "in eiusmod labore quis",
      "phone_number": "commodo eiusmod dolor et",
      "whatsapp": "in nulla tempor quis voluptate",
      "line": "dolore",
      "facebook": "do ullamco",
      "list_ids": [
        "cillum Ut sit"
      ],
      "segment_ids": [
        "reprehenderit ullamco",
        "eu"
      ],
      "custom_fields": {},
      "created_at": "eu",
      "updated_at": "proident minim do",
      "_metadata": {
        "self": "sint sit esse"
      }
    }
  ],
  "_metadata": {
    "self": "Duis dolore reprehenderit deserunt"
  },
  "contact_count": -2742620
}
{
  "errors": [
    {
      "message": "adipisicing cillum mollit ullamco in",
      "field": "velit consequat dolor amet",
      "error_id": "eu in reprehenderit",
      "parameter": "voluptate labore"
    },
    {
      "message": "est",
      "field": "consectetur dolore aliquip",
      "error_id": "et dolore tempor ex veniam",
      "parameter": "cupidatat ut reprehenderit"
    },
    {
      "message": "eu",
      "field": "ut elit esse est et",
      "error_id": "aute",
      "parameter": "anim officia aliqua occaecat pariatur"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "qui exercitation enim amet"
    },
    {
      "message": "exercitation ut culpa adipisicing"
    },
    {
      "message": "consequat"
    },
    {
      "message": "commodo"
    },
    {
      "message": "exercitation incididunt labore"
    }
  ]
}
Request Payload
Response Payload
{
  "contact_count": 21915278,
  "billable_count": 12729911,
  "billable_breakdown": {
    "total": -14961102,
    "breakdown": {}
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "eiusmod veniam"
    },
    {
      "message": "ut"
    },
    {
      "message": "cupidatat nostrud"
    },
    {
      "message": "sed"
    },
    {
      "message": "qui dolore"
    }
  ]
}
Request Payload
{
  "list_ids": [
    "121437e3-9a0a-6947-efb4-3683e0596f3b",
    "cfbd96e0-e7af-89cc-e59b-dc5b93cada1e",
    "92afcccf-4147-b0d9-dde3-45530a446652",
    "57d4def8-a903-de6d-8b73-11311f80014a",
    "76ac9183-5872-7d63-205d-861d05d8bea3"
  ],
  "segment_ids": [
    "amet"
  ],
  "notifications": {
    "email": true
  },
  "file_type": "csv",
  "max_file_size": -17483930
}
Response Payload
{
  "_metadata": {
    "prev": "http://POHXrwNXLMhsfYcpYlpVC.admffAgF2hiarYeeD96PEugB0cyByFO3uhSNQk",
    "self": "https://DCADTjAkuADARnkbouvC.xgczi6zYY2-9RmRYaGD",
    "next": "https://qwpymFGgugcrMUZCUvkhwaakoNxpYm.gyvoyjLXuX8tz8.Vhjco6IZv7eLQ.b5AWS2QK,i0XWzTIA1WlZn4",
    "count": 45022359.30675101
  },
  "id": "anim dolor sit"
}
{
  "errors": [
    {
      "message": "consequat",
      "field": "aliqua cillum ut fugiat occaecat",
      "error_id": "minim id cupidatat",
      "parameter": "ad est non deserunt Lorem"
    },
    {
      "message": "sunt",
      "field": "nulla",
      "error_id": "qui ut minim commodo",
      "parameter": "id sed aliquip velit Lorem"
    },
    {
      "message": "nostrud Lorem id",
      "field": "ea officia sit",
      "error_id": "sint Ut et",
      "parameter": "in ullamco"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "qui mollit Duis exercitation pariatur"
    },
    {
      "message": "amet"
    },
    {
      "message": "consequat in"
    },
    {
      "message": "laboris quis ipsum"
    }
  ]
}
Request Payload
Response Payload
{
  "result": [
    {
      "id": "Lorem pariatur dolor",
      "status": "esse amet Duis non",
      "created_at": "est ut",
      "completed_at": "tempor sint",
      "expires_at": "occaecat esse dolore",
      "urls": [
        "Lorem ipsum consectetur incididunt",
        "Ut minim eu"
      ],
      "user_id": "esse nisi veniam irure",
      "export_type": "dolore",
      "segments": [
        {
          "ID": "labore sit Excepteur eiusmod sunt",
          "Name": "tempor"
        },
        {
          "ID": "elit sed in sint cupidatat",
          "Name": "aute enim"
        },
        {
          "ID": "reprehenderit",
          "Name": "voluptate"
        },
        {
          "ID": "nulla eu",
          "Name": "cillum sed"
        },
        {
          "ID": "velit labore sed fugiat",
          "Name": "voluptate velit aute culpa anim"
        }
      ],
      "lists": [
        {
          "ID": "in exercitation esse",
          "Name": "pariatur"
        },
        {
          "ID": "Excepteur amet tempor cupidatat",
          "Name": "nostrud culpa"
        },
        {
          "ID": "consequat ex",
          "Name": "et proident"
        },
        {
          "ID": "amet ut minim incididunt",
          "Name": "sed minim enim eiusmod"
        },
        {
          "ID": "ipsum consectetur Duis nisi commodo",
          "Name": "labore occaecat"
        }
      ],
      "_metadata": {
        "prev": "nostrud anim ad",
        "self": "eiusmod dolore enim",
        "next": "enim aliqua Duis magna id"
      }
    }
  ],
  "_metadata": {
    "prev": "in qui",
    "self": "mollit sunt velit amet in",
    "next": "dolor fugiat laboris"
  }
}
{
  "errors": [
    {
      "message": "enim in nisi aliquip mollit",
      "": "cupidatat eiusmod consectetur eu aute",
      "error_id": "eu veniam nostrud"
    },
    {
      "message": "deserunt sed pariatur",
      "": "laborum Ut veniam voluptate",
      "error_id": "sit aute"
    },
    {
      "message": "ullamco do cupidatat ipsum exercitation",
      "": "ex",
      "error_id": "cupidatat"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "aute qui incididunt fugiat"
    },
    {
      "message": "tempor magna dolor ut"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "in ut",
  "first_name": "nisi",
  "last_name": "officia Duis",
  "unique_name": "ad",
  "email": "nisi nostrud id consectetur Lorem",
  "alternate_emails": [
    "laborum in incididunt",
    "amet veniam cillum",
    "aute tempor minim",
    "Duis fugiat dolore in"
  ],
  "address_line_1": "Ut adipisicing cupidatat consectetur culpa",
  "address_line_2": "reprehenderit Lorem magna nisi nostrud",
  "city": "aliquip minim ipsum commodo",
  "state_province_region": "labore dolore",
  "country": "velit nisi",
  "postal_code": "incididunt Lorem et dolor enim",
  "phone_number": "aute qui culpa dolore aliqua",
  "whatsapp": "aute magna consectetur dolore",
  "line": "pariatur consequat tempor aute incididunt",
  "facebook": "consectetur in nostrud sint",
  "list_ids": [
    "aliqua sint",
    "ex cillum in"
  ],
  "segment_ids": [
    "aliquip",
    "magna",
    "exercitation fugiat",
    "aute aliquip nostrud officia sint"
  ],
  "custom_fields": {},
  "created_at": "quis labore qui consectetur",
  "updated_at": "Lorem quis reprehenderit cillum mollit",
  "_metadata": {
    "self": "ipsum fugiat enim exercitation"
  }
}
{
  "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": "in irure culpa tempor"
    },
    {
      "message": "eu voluptate pariatur"
    }
  ]
}
Request Payload
{
  "query": "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')"
}
Response Payload
{
  "result": [
    {
      "id": "qui Ut",
      "first_name": "adipisicing eiusmod",
      "last_name": "nisi magna consequat labore laboris",
      "unique_name": "officia ut nostrud quis",
      "email": "officia mollit adipisicing",
      "alternate_emails": [
        "ea tempor ut",
        "sint",
        "labore magna",
        "aute Duis sed",
        "est sit proident dolore"
      ],
      "address_line_1": "dolore do irure est exercitation",
      "address_line_2": "eu nostrud",
      "city": "ea eiusmod",
      "state_province_region": "ea est sit sed",
      "country": "aliquip labore",
      "postal_code": "magna officia",
      "phone_number": "dolore velit exercitation qui",
      "whatsapp": "dolor dolore incididunt",
      "line": "in et ipsum",
      "facebook": "sunt culpa elit officia in",
      "list_ids": [
        "nulla ipsum occaecat reprehenderit"
      ],
      "segment_ids": [
        "occaecat veniam ad ullamco anim",
        "eu reprehenderit non",
        "sint occaecat do",
        "ex",
        "tempor proident qui sit quis"
      ],
      "custom_fields": {},
      "created_at": "dolor",
      "updated_at": "eiusmod laboris aliqua",
      "_metadata": {
        "self": "nisi adipisicing"
      }
    },
    {
      "id": "cupidatat est dolore irure",
      "first_name": "dolor velit culpa magna",
      "last_name": "magna sint sit reprehenderit",
      "unique_name": "do ut sint pariatur adipisicing",
      "email": "mollit et aliqua dolore enim",
      "alternate_emails": [
        "sint sunt veniam irure reprehenderit",
        "ipsum",
        "laboris incididunt",
        "commodo non amet id",
        "do laboris"
      ],
      "address_line_1": "Lorem Ut esse ipsum",
      "address_line_2": "cillum Duis anim incididunt",
      "city": "dolore",
      "state_province_region": "laborum",
      "country": "minim",
      "postal_code": "in consequat dolor consectetur dolor",
      "phone_number": "sunt",
      "whatsapp": "in Duis mollit dolore aute",
      "line": "officia",
      "facebook": "dolore",
      "list_ids": [
        "nisi commodo"
      ],
      "segment_ids": [
        "occaecat nulla magna reprehenderit fugiat"
      ],
      "custom_fields": {},
      "created_at": "culpa amet dolore voluptate minim",
      "updated_at": "mollit",
      "_metadata": {
        "self": "sed magna dolore"
      }
    }
  ],
  "_metadata": {
    "self": "nulla"
  },
  "contact_count": 65202292.97076988
}
{
  "errors": [
    {
      "field": "ad ex adipisicing irure eu",
      "message": "ea nostrud quis sed eu"
    },
    {
      "field": "nostrud Duis",
      "message": "consectetur dolor enim Lorem pariatur"
    },
    {
      "field": "cupidatat officia ut Lorem",
      "message": "dolore ad ex non ullamco"
    }
  ]
}
{
  "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": "eu"
    },
    {
      "message": "magna laboris"
    },
    {
      "message": "eiusmod Lorem incididunt aliquip"
    }
  ]
}
Request Payload
{
  "list_ids": [
    "culpa ipsum fugiat commodo"
  ],
  "file_type": "csv",
  "field_mappings": [
    "incididunt commodo sed aute pariatur",
    null,
    "adipisicing veniam",
    "occaecat cupidatat do officia"
  ]
}
Response Payload
{
  "job_id": "Excepteur",
  "upload_uri": "dolore",
  "upload_headers": [
    {
      "header": "velit sed",
      "value": "labore Duis irure commodo"
    }
  ]
}
{
  "errors": [
    {
      "message": "eiusmod voluptate cupidatat do consequat",
      "field": "aute nisi Lorem minim do",
      "error_id": "eu cillum ullamco",
      "parameter": "adipisicing"
    },
    {
      "message": "cillum in",
      "field": "aute do ut",
      "error_id": "culpa",
      "parameter": "sed voluptate officia laboris ea"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "nostrud Excepteur sunt dolore incididunt",
      "field": "labore irure est eu ad",
      "error_id": "amet labore laborum ea",
      "parameter": "dolor"
    },
    {
      "message": "elit minim aute est",
      "field": "dolor laboris",
      "error_id": "laborum sint",
      "parameter": "eiusmod nulla"
    },
    {
      "message": "Duis amet in",
      "field": "magna",
      "error_id": "aliqua",
      "parameter": "esse consequat ad"
    },
    {
      "message": "sunt Lorem proident aliqua",
      "field": "in cillum nostrud aliquip laboris",
      "error_id": "dolore exercitation non ut consequat",
      "parameter": "eu pariatur amet in id"
    }
  ]
}
{
  "errors": [
    {
      "message": "ipsum"
    },
    {
      "message": "in cupidatat ut"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "esse",
  "status": "non irure id dolor",
  "job_type": "quis qui",
  "results": {
    "requested_count": -96329837.6058476,
    "created_count": -97751258.04250404,
    "updated_count": 86157796.54148996,
    "deleted_count": -72775606.95642364,
    "errored_count": 72139741.55253333,
    "errors_url": "consequat sit nulla enim voluptate"
  },
  "started_at": "Ut exercitation mollit do",
  "finished_at": "eiusmod minim ut et"
}
{
  "errors": {
    "message": "nisi labore mollit adipisicing",
    "field": "voluptate Ut veniam",
    "error_id": "anim",
    "parameter": "sunt"
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "eu mollit aliquip"
    },
    {
      "message": "consectetur"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "dolor",
  "status": "pending",
  "created_at": "dolore eiusmod",
  "updated_at": "Duis mollit esse",
  "completed_at": "sed irure ad cupidatat",
  "expires_at": "adipisicing",
  "urls": [
    "esse exercitation eiusmod",
    "est cillum voluptate ea"
  ],
  "message": "sit laborum sed fugiat",
  "_metadata": {
    "prev": "http://dpKCfGUsiitQgFgoABE.pmdsugb2A2CsIUodjWK5CcepiVpQm+VA1WQ9JbBryeh",
    "self": "http://lXilKiRdykMeMkeVhXDjfbgCWeV.bgoDF7xduk31,VqXfm9glZtHekQA6GjgEMOXEwswyL.mw8tVk0Oos-UgG-FWr",
    "next": "http://vufQBwEZF.byRVJqJ2c1IXCvq4Jl2XioyM4TzoAGfMv+JzToxtV,bJTbKky9YIXHqKy6JPSiLwfO2aRJYscT",
    "count": -3095900.7217968255
  },
  "contact_count": -4500129
}
{
  "errors": [
    {
      "message": "pariatur",
      "field": "reprehenderit magna",
      "error_id": "nulla aliquip",
      "parameter": "aute tempor reprehenderit"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "in veniam enim"
    },
    {
      "message": "aliqua dolor pariatur"
    }
  ]
}
Request Payload
{
  "ids": [
    "1234",
    "1235"
  ]
}
Response Payload
{
  "result": [
    {
      "id": "nostrud amet fugiat eu",
      "first_name": "consequat",
      "last_name": "tempor qui in mollit dolor",
      "unique_name": "velit",
      "email": "anim",
      "alternate_emails": [
        "proident ex velit nostrud nisi",
        "sunt",
        "Duis in",
        "et nostrud voluptate",
        "anim ipsum eu"
      ],
      "address_line_1": "esse",
      "address_line_2": "adipisicing est",
      "city": "dolor consectetur",
      "state_province_region": "enim quis adipisicing exercitation",
      "country": "consectetur non sed sit do",
      "postal_code": "et exercitation aliquip",
      "phone_number": "dolor ea velit",
      "whatsapp": "aliqua nisi occaecat dolor",
      "line": "dolor",
      "facebook": "ipsum qui ad exercitation enim",
      "list_ids": [
        "cillum nulla enim",
        "commodo",
        "ea laborum",
        "in"
      ],
      "segment_ids": [
        "Duis non",
        "incididunt ipsum enim aliquip"
      ],
      "custom_fields": {},
      "created_at": "quis fugiat Ut",
      "updated_at": "aute",
      "_metadata": {
        "self": "Excepteur deserunt laborum ex incididunt"
      }
    },
    {
      "id": "cupidatat",
      "first_name": "Excepteur sunt ipsum consequat Duis",
      "last_name": "in voluptate",
      "unique_name": "ex",
      "email": "proident",
      "alternate_emails": [
        "eu sint consectetur reprehenderit aute",
        "pariatur culpa nostrud",
        "culpa consectetur non id deserunt"
      ],
      "address_line_1": "dolor Excepteur in",
      "address_line_2": "Duis dolore",
      "city": "fugiat esse reprehenderit",
      "state_province_region": "nisi",
      "country": "non sunt",
      "postal_code": "laboris fugiat ut",
      "phone_number": "incididunt in id veniam laboris",
      "whatsapp": "dolore dolor",
      "line": "in laborum aliqua minim",
      "facebook": "ut aliquip commodo in",
      "list_ids": [
        "est consectetur irure Lorem",
        "aute dolore velit incididunt",
        "Lorem non",
        "sit laboris ullamco nostrud consequat"
      ],
      "segment_ids": [
        "ex sed voluptate ad",
        "consequat fugiat"
      ],
      "custom_fields": {},
      "created_at": "aute Lorem qui reprehenderit in",
      "updated_at": "consectetur voluptate cillum Ut",
      "_metadata": {
        "self": "id dolore velit et Ut"
      }
    },
    {
      "id": "in id irure non sunt",
      "first_name": "cupidatat",
      "last_name": "aliqua nostrud",
      "unique_name": "Ut enim amet",
      "email": "sint mollit eu",
      "alternate_emails": [
        "deserunt velit voluptate",
        "esse consectetur dolore"
      ],
      "address_line_1": "proident laboris sunt dolore",
      "address_line_2": "velit in ad minim",
      "city": "qui",
      "state_province_region": "proident cillum amet consequat eu",
      "country": "reprehenderit et incididunt",
      "postal_code": "culpa",
      "phone_number": "laborum esse tempor aliquip",
      "whatsapp": "cupidatat",
      "line": "ut ea Excepteur do",
      "facebook": "fugiat",
      "list_ids": [
        "aliquip in pariatur",
        "occaecat fugiat sit ipsum"
      ],
      "segment_ids": [
        "dolor",
        "ex in elit Duis eu",
        "Duis",
        "qui veniam reprehenderit",
        "ex mollit aliquip"
      ],
      "custom_fields": {},
      "created_at": "ut",
      "updated_at": "aliquip in",
      "_metadata": {
        "self": "ea in ut"
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "consectetur tempor ipsum dolor in"
    },
    {
      "message": "cillum do dolor fugiat id"
    },
    {
      "message": "adipisicing et sed"
    },
    {
      "message": "Excepteur esse consequat nisi"
    }
  ]
}
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": "veniam eu Duis id aliquip"
    },
    {
      "message": "nulla id officia exercitation Ut"
    },
    {
      "message": "deserunt enim culpa"
    },
    {
      "message": "in anim dolore adipisicing"
    }
  ]
}

Segmenting Contacts V2 - Beta(5 operations)

Request Payload
{
  "name": "ut amet consequat ut",
  "parent_list_ids": [
    "nostrud fugiat exercitation",
    "consectetur tempor",
    "voluptate culpa ipsum in tempor",
    "pariatur eiusmod in",
    "commodo sint elit velit"
  ],
  "query_dsl": "ad mollit sint officia"
}
Response Payload
{
  "id": "4707e82c-2821-137e-3241-51e34e4f5760",
  "name": "enim aliqua culpa Ut sunt",
  "query_dsl": "est sed labore do culpa",
  "contacts_count": -81911593,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "ea exercitation ut",
  "updated_at": "aliquip voluptate non Ut",
  "sample_updated_at": "sint",
  "next_sample_update": "et",
  "parent_list_ids": [
    "incididunt dolore reprehenderit aute"
  ],
  "query_version": "laborum quis ea minim",
  "status": {
    "query_validation": "et reprehenderit",
    "error_message": "do"
  }
}
{
  "errors": [
    {
      "field": "commodo nisi",
      "message": "in Duis do voluptate adipisicing"
    },
    {
      "field": "ex in dolore cupidatat in",
      "message": "Excepteur"
    },
    {
      "field": "nostrud",
      "message": "ullamco est exercitation"
    },
    {
      "field": "quis sunt amet minim sint",
      "message": "cupidatat anim consectetur"
    }
  ]
}
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": "non",
      "message": "minim eu dolore proident"
    },
    {
      "field": "sit eu",
      "message": "cupidatat exercitation quis"
    },
    {
      "field": "in adipisicing ut sunt",
      "message": "pariatur labore"
    },
    {
      "field": "dolore mollit",
      "message": "minim Lorem sed"
    },
    {
      "field": "dolor in culpa velit tempor",
      "message": "mollit pariatur ea non est"
    }
  ]
}
Query Parameter NameExample
parent_list_idsmagna tempor
no_parent_list_idfalse
Request Payload
Response Payload
{
  "id": "a459ed0e-2bf4-4966-ec6c-7f562dc0e760",
  "name": "Ut dolore",
  "contacts_count": 53663904,
  "created_at": "officia",
  "updated_at": "in ut Excepteur Duis irure",
  "sample_updated_at": "occaecat pariatur magna veniam eu",
  "next_sample_update": "sit aute in",
  "parent_list_ids": [
    "aliquip",
    "mollit minim",
    "ut anim adipisicing",
    "ad aliquip velit"
  ],
  "query_version": "pariatur minim labore",
  "_metadata": {
    "prev": "http://RerQlKBUtmVaCDRIBpeMf.opem3IxMAjf0CHYCqkXKJvwrBVaEYvEsX-jGFL4C.Yj+kqCBEfa8rvQ7vXLSbH",
    "self": "http://EVXzxzpIDyTEAdkIcOHuiyL.sikNtQpXyvvezuKCIdb7Ad",
    "next": "https://DAeJVaTQhYbjCAfpjWPoElgYKXhGc.uaeus.lJfExhMwmwWP5j76aGTiuhi",
    "count": 92944347
  },
  "status": {
    "query_validation": "Lorem veniam commodo id",
    "error_message": "do Lorem"
  }
}
{
  "errors": [
    {
      "field": "qui in",
      "message": "velit elit enim ex in"
    },
    {
      "field": "ut ut",
      "message": "irure ut"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "incididunt voluptate nisi",
      "message": "culpa do aliquip quis"
    },
    {
      "field": "in anim minim",
      "message": "laborum nostrud labore nisi"
    },
    {
      "field": "et commodo ex deserunt",
      "message": "amet magna non elit ut"
    },
    {
      "field": "ut tempor",
      "message": "reprehenderit pariatur officia"
    },
    {
      "field": "Duis minim dolore qui ut",
      "message": "nostrud mollit cillum"
    }
  ]
}
Request Payload
{
  "name": "ipsum",
  "query_dsl": "magna nisi consequat"
}
Response Payload
{
  "id": "0a3c6313-4bd0-a985-7336-85bfa14a456a",
  "name": "voluptate aliquip do et",
  "query_dsl": "minim",
  "contacts_count": 28021073,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "ut Ut officia eiusmod ex",
  "updated_at": "laboris in Ut ut",
  "sample_updated_at": "aliquip sed ex sit non",
  "next_sample_update": "consectetur Excepteur sed ut laboris",
  "parent_list_ids": [
    "in sint Ut deserunt sunt",
    "aute veniam aliqua mollit",
    "proident esse minim",
    "amet minim"
  ],
  "query_version": "ut exercitation",
  "status": {
    "query_validation": "amet elit Lorem",
    "error_message": "quis dolor tempor laboris exercitation"
  }
}
{
  "errors": [
    {
      "field": "fugiat officia est dolor",
      "message": "laborum"
    },
    {
      "field": "aliqua enim",
      "message": "in aliquip occaecat amet Excepteur"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "ea nisi",
      "message": "incididunt est"
    },
    {
      "field": "in",
      "message": "dolor"
    },
    {
      "field": "proident eiusmod minim irure",
      "message": "fugiat enim"
    }
  ]
}
Query Parameter NameExample
contacts_samplefalse
Request Payload
Response Payload
{
  "id": "b32be94a-553f-32aa-807a-8506e96311fd",
  "name": "sit dolore aliqua",
  "query_dsl": "veniam elit",
  "contacts_count": -59214557,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "ex",
  "updated_at": "occaecat",
  "sample_updated_at": "ea irure",
  "next_sample_update": "esse",
  "parent_list_ids": [
    "irure",
    "commodo Ut quis culpa",
    "ad aliqua officia mollit",
    "fugiat qui",
    "esse in tempor Duis cupidatat"
  ],
  "query_version": "cillum",
  "status": {
    "query_validation": "cillum sunt sint deserunt",
    "error_message": "mollit Ut aliquip fugiat"
  }
}
{
  "errors": [
    {
      "field": "et labore in",
      "message": "proident irure"
    },
    {
      "field": "sed",
      "message": "est"
    }
  ]
}
{
  "errors": [
    {
      "field": "nostrud in Excepteur esse",
      "message": "reprehenderit aliquip ut"
    },
    {
      "field": "voluptate labore",
      "message": "deserunt sit"
    },
    {
      "field": "quis nulla",
      "message": "enim sit"
    },
    {
      "field": "in mollit occaecat ut esse",
      "message": "in qui voluptate"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "aute",
      "message": "officia in cupidatat"
    },
    {
      "field": "dolore dolor eiusmod laborum proident",
      "message": "velit eu aliqua"
    },
    {
      "field": "dolor consequat ipsum do",
      "message": "occaecat"
    },
    {
      "field": "nostrud dolor sit",
      "message": "veniam reprehenderit eu aliqua"
    },
    {
      "field": "laboris enim tempor",
      "message": "veniam ut pariatur dolore Excepteur"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "aute Ut ut ad ea",
      "message": "cupidatat sint sit Ut"
    },
    {
      "field": "sint Ut",
      "message": "do officia"
    }
  ]
}

Senders

Header NameExample
on-behalf-of"culpa qui dolor sunt dolore"
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": "anim commodo in mollit"
    }
  ]
}

Lists(7 operations)

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

Custom Fields(4 operations)

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

segmenting contacts(5 operations)

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

Segmenting Contacts

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

Single Sends(11 operations)

Request Payload
{
  "name": "Example API Created Single Send",
  "categories": [
    "unique opens"
  ],
  "send_to": {
    "all": true
  },
  "email_config": {
    "design_id": "<your-design-id>",
    "editor": "design",
    "suppression_group_id": 12345,
    "sender_id": 1234567
  }
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "field": "officia veniam",
      "message": "consequat sit velit",
      "error_id": "esse amet sit"
    },
    {
      "field": "velit quis pariatur mollit",
      "message": "voluptate",
      "error_id": "laborum"
    },
    {
      "field": "est sit culpa",
      "message": "nostrud minim ea ullamco",
      "error_id": "magna cupidatat cillum Ut"
    },
    {
      "field": "incididunt ad quis",
      "message": "voluptate pariatur",
      "error_id": "sint tempor aliquip enim"
    },
    {
      "field": "Excepteur ad cupidatat",
      "message": "culpa",
      "error_id": "ex labore anim amet"
    }
  ]
}
{
  "errors": [
    {
      "field": "exercitation",
      "message": "laboris exercitation Ut",
      "error_id": "proident dolor officia est"
    }
  ]
}
Query Parameter NameExample
page_size-62848457
page_tokenculpa
Request Payload
Response Payload
{
  "result": [
    {
      "id": "485a0f0d-5e8d-e6f8-d3a5-b5201b7cf34f",
      "name": "dolore consequat adipisicing aliquip",
      "abtest": null,
      "status": "scheduled",
      "categories": [
        "dolor aute do minim amet",
        "cillum consequat",
        "culpa eiusmod",
        "minim voluptate qui",
        "nisi Lorem",
        "ut fugiat adipisicing minim ullamco",
        "Ut sed",
        "veniam tempor elit",
        "commodo et",
        "ea quis"
      ],
      "send_at": "1932-09-05T23:19:14.0Z",
      "is_abtest": true,
      "updated_at": "1956-09-16T21:22:17.0Z",
      "created_at": "1946-01-24T04:11:23.0Z"
    },
    {
      "id": "fae8f199-7018-790a-e5d8-b4bdfc74449d",
      "name": "exercitation ut",
      "abtest": {
        "type": "subject",
        "winner_criteria": "manual",
        "test_percentage": 89968741,
        "duration": "deserunt magna ea velit",
        "winning_template_id": "commodo nostrud Lorem reprehenderit do",
        "winner_selected_at": "tempor qui reprehenderit ipsum",
        "expiration_date": null
      },
      "status": "scheduled",
      "categories": [
        "pariatur laboris",
        "adipisicing",
        "ipsum sint anim",
        "tempor sunt",
        "sit amet ad",
        "cillum velit in",
        "ullamco dolor nisi labore pariatur",
        "ut Excepteur est nulla dolore",
        "ex commodo",
        "in velit"
      ],
      "send_at": "1926-02-18T20:47:50.0Z",
      "is_abtest": true,
      "updated_at": "1956-07-28T13:36:17.0Z",
      "created_at": "1912-07-15T12:12:42.0Z"
    }
  ],
  "_metadata": {
    "prev": "http://GnCbRTNywNmJIdSWpSP.iaakxxzmSAW",
    "self": "https://vz.bncio5FiKfTFACcjw.ivzheLGlNPmTtQ+KCH4lOVO6SfW0IbDKNQtPyrP4r",
    "next": "http://LPCZznfKjGLaGW.phtSYhNYTRgnpjVilKrFiE2uGXqqwuYwHxekomolCMIdjMoML",
    "count": 47432911
  }
}
{
  "errors": [
    {
      "field": "voluptate eiusmod commodo anim",
      "message": "commodo ut nisi esse",
      "error_id": "in Lorem"
    },
    {
      "field": "consequat et esse consectetur",
      "message": "ut ut Ut sint",
      "error_id": "sunt id"
    },
    {
      "field": "esse eu ad",
      "message": "eu",
      "error_id": "voluptate"
    }
  ]
}
Query Parameter NameExample
ids["sunt aute","exercitation culpa consectetur amet Excepteur","amet labore","enim ex minim","dolore dolor laborum","reprehenderit incididunt amet","aliqua consequat","est","amet officia Duis esse","elit nisi occaecat"]
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "ipsum dolore enim",
      "message": "cillum elit",
      "error_id": "adipisicing commodo do"
    },
    {
      "field": "Ut nulla anim fugiat consectetur",
      "message": "magna minim tempor dolor laborum",
      "error_id": "id elit sunt"
    },
    {
      "field": "et incididunt nisi dolore",
      "message": "anim Lorem",
      "error_id": "ea"
    }
  ]
}
{
  "errors": [
    {
      "field": "magna Lorem sit voluptate aute",
      "message": "sed",
      "error_id": "amet sunt esse"
    },
    {
      "field": "Excepteur officia occaecat",
      "message": "incididunt non aliquip sunt",
      "error_id": "dolor sit"
    }
  ]
}
Request Payload
{
  "name": "commodo reprehenderit"
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "field": "est dolore in",
      "message": "sed",
      "error_id": "ullamco labore nostrud"
    },
    {
      "field": "veniam amet occaecat ut minim",
      "message": "aliquip Duis commodo voluptate minim",
      "error_id": "officia irure consectetur aute elit"
    },
    {
      "field": "sunt pariatur tempor",
      "message": "enim nisi irure in",
      "error_id": "sed Ut veniam aute minim"
    }
  ]
}
{
  "errors": [
    {
      "field": "sed ipsum",
      "message": "et anim exercitation ut",
      "error_id": "laboris nisi veniam nulla"
    },
    {
      "field": "anim",
      "message": "proident ex voluptate ea culpa",
      "error_id": "Lorem proident"
    },
    {
      "field": "ut adipisicing",
      "message": "pariatur",
      "error_id": "Lorem consequat veniam commodo enim"
    },
    {
      "field": "consequat occaecat cillum sit",
      "message": "tempor do minim dolore",
      "error_id": "ad voluptate"
    },
    {
      "field": "ut ea consectetur magna",
      "message": "ipsum cupidatat",
      "error_id": "veniam laboris aute sint"
    }
  ]
}
Request Payload
{
  "name": "occaecat adipi",
  "categories": [
    "in veniam eu",
    "Duis nisi laborum",
    "non officia dolore",
    "voluptate",
    "aliqua ad",
    "Excepteur laborum",
    "Lorem et occaecat",
    "dolor ullamco elit cillum do",
    "deserunt",
    "pariatur sed"
  ],
  "send_at": "1962-12-11T02:06:24.0Z",
  "send_to": {
    "list_ids": [
      "bf2437b3-bd13-ca31-6e29-f7164c55b3e0",
      "32e2d6f2-3f48-44ba-fb6e-acf3a1db4cb4",
      "23d0a1a4-1300-0be6-e732-381e0b75a558",
      "b010b778-1162-ee0a-ae95-859c6517fec3",
      "a6a8ab50-c4c9-aef1-8337-dc8bd8b2ec3f",
      "492462fa-f2ec-d229-75e0-a88688abdff9",
      "ae73485e-91ec-2ae8-6047-686773b4a0ba",
      "e54e57b9-0efe-06c0-160c-0b031d83c8a6",
      "05b76d76-728c-effa-29fe-7b7faa1878ae",
      "1599aab0-9013-f46f-04c5-013fdc84dbdc"
    ],
    "segment_ids": [
      "c808c10d-19a6-774a-7a5f-977ea77722f8",
      "e9a2e5a5-2df7-4197-7f62-49ea73c46dea",
      "2c109cb3-910b-4cb6-58ce-8df94e6532e5",
      "9175bfa4-61d1-9c36-ac7e-46a17ab2cefc",
      "d9257814-82a4-7859-2541-5a2a77699f0d",
      "997003a9-77c8-2b2f-ecf8-76a03342e13a",
      "0eafb3e6-9896-381a-bf1a-80465076e45c",
      "539f6323-62ab-ab00-574a-d8a7ccc4f22d",
      "f3934c61-c95d-f3bf-dd30-cd0f22606863",
      "f344ce80-9568-222b-da7f-4b10cfc3eb46"
    ],
    "all": false
  },
  "email_config": {
    "subject": "dolore aliqua proident voluptate est",
    "html_content": "reprehenderit dolor ad",
    "plain_content": "eu consequat veniam ut officia",
    "generate_plain_content": true,
    "design_id": "quis",
    "editor": "design",
    "suppression_group_id": null,
    "custom_unsubscribe_url": "http://XtqZyxShdfP.knrn",
    "sender_id": null,
    "ip_pool": "Duis proident et voluptate mollit"
  }
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "field": "et",
      "message": "nisi ex sunt laboris velit",
      "error_id": "laborum"
    }
  ]
}
{
  "errors": [
    {
      "field": "consectetur dolore Ut incididunt",
      "message": "enim dolor",
      "error_id": "aliquip consectetur officia est nulla"
    },
    {
      "field": "est",
      "message": "reprehenderit laboris",
      "error_id": "sunt tempor consectetur esse"
    },
    {
      "field": "non amet voluptate sit",
      "message": "eiusmod irure anim ut pariatur",
      "error_id": "minim eiusmod"
    },
    {
      "field": "Excepteur",
      "message": "dolor exercitation Lorem pariatur",
      "error_id": "exercitation non occaecat Excepteur Duis"
    },
    {
      "field": "tempor consectetur minim sed Excepteur",
      "message": "Excepteur Lorem",
      "error_id": "ut officia esse occaecat id"
    }
  ]
}
{
  "errors": [
    {
      "field": "dolor",
      "message": "occaecat mollit",
      "error_id": "mollit"
    }
  ]
}
Request Payload
Response Payload
{
  "name": "single-send-1",
  "id": "2f6dec81-43b9-4c67-a890-3a38cb63b54a",
  "status": "scheduled",
  "created_at": "2020-12-13T16:24:42.013Z",
  "send_to": {
    "segment_ids": [
      "dad84de3-bec4-4e04-b132-2cbfd4bb3789",
      "7dce758d-1155-4102-88d2-ca65565ac98b"
    ],
    "all": true
  }
}
{
  "errors": [
    {
      "field": "reprehenderit in",
      "message": "nisi cupidatat",
      "error_id": "dolor laborum"
    },
    {
      "field": "consectetur aliquip in nisi",
      "message": "est quis consectetur",
      "error_id": "amet ad reprehenderit"
    },
    {
      "field": "non",
      "message": "Duis",
      "error_id": "adipisicing tempor elit aute cillum"
    },
    {
      "field": "velit voluptate culpa sunt enim",
      "message": "do non Duis labore",
      "error_id": "non adipisicing cillum"
    }
  ]
}
{
  "errors": [
    {
      "field": "laborum",
      "message": "deserunt ipsum occaecat",
      "error_id": "sed Ut"
    },
    {
      "field": "reprehenderit commodo Excepteur",
      "message": "sed",
      "error_id": "nisi eu dolor exercitation"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "aliquip",
      "message": "commodo non minim",
      "error_id": "in esse sint"
    },
    {
      "field": "commodo ea exercitation laboris culpa",
      "message": "Ut aute",
      "error_id": "sint"
    }
  ]
}
{
  "errors": [
    {
      "field": "ut in tempor magna laboris",
      "message": "proident ullamco",
      "error_id": "veniam aute et anim sit"
    },
    {
      "field": "Lorem non sed",
      "message": "non cillum",
      "error_id": "enim ipsum aliqua"
    },
    {
      "field": "Lorem et",
      "message": "aute incididunt pariatur",
      "error_id": "aliqua et sit dolore"
    },
    {
      "field": "sit occaecat sunt laborum tempor",
      "message": "in deserunt",
      "error_id": "commodo veniam nostrud"
    },
    {
      "field": "velit enim",
      "message": "proident reprehenderit veniam",
      "error_id": "ipsum minim magna"
    }
  ]
}
Query Parameter NameExample
page_size-99411952
page_tokenin sed ex dolore
Request Payload
{
  "name": "specific-single-send-name",
  "status": [
    "draft",
    "scheduled"
  ],
  "categories": [
    "shoes"
  ]
}
Response Payload
{
  "result": [
    {
      "id": "df25ffdf-6a96-458a-9419-6d87d3094c6b",
      "name": "single-send-1",
      "status": "triggered",
      "categories": [
        "shoes"
      ],
      "is_abtest": true,
      "updated_at": "3263-04-09T09:05:08.193Z",
      "created_at": "4739-10-29T07:11:32.476Z",
      "send_at": "2471-05-31T15:46:18.797Z"
    }
  ],
  "_metadata": {
    "self": "nwNSrPSWt7d",
    "prev": "P0Enoayd",
    "next": "DYEsTUDww9-",
    "count": 1
  }
}
{
  "errors": [
    {
      "field": "ut elit sunt non exercitation",
      "message": "officia",
      "error_id": "occaecat"
    },
    {
      "field": "ex dolor mollit deserunt",
      "message": "enim adipisicing",
      "error_id": "id incididunt amet nisi"
    },
    {
      "field": "minim",
      "message": "incididunt deserunt in",
      "error_id": "do voluptate aliquip nostrud incididunt"
    },
    {
      "field": "velit commodo",
      "message": "pariatur",
      "error_id": "adipisicing consectetur labore Excepteur elit"
    },
    {
      "field": "esse ex dolore quis",
      "message": "Lorem non Ut reprehenderit",
      "error_id": "anim"
    }
  ]
}
Request Payload
{
  "send_at": "3752-01-28T23:21:52.575Z"
}
Response Payload
{
  "send_at": "3752-01-28T23:21:52.575Z",
  "status": "scheduled"
}
{
  "errors": [
    {
      "field": "dolor minim consequat incididunt aliquip",
      "message": "occaecat voluptate sint eu nostrud",
      "error_id": "dolore velit"
    },
    {
      "field": "irure labore ullamco cillum",
      "message": "magna",
      "error_id": "velit pariatur qui nostrud aute"
    },
    {
      "field": "laboris",
      "message": "reprehenderit aliquip minim",
      "error_id": "laboris esse ut do"
    },
    {
      "field": "magna",
      "message": "esse",
      "error_id": "laboris sunt"
    },
    {
      "field": "in reprehenderit Duis tempor",
      "message": "elit officia et ipsum",
      "error_id": "esse laboris sed fugiat officia"
    }
  ]
}
{
  "errors": [
    {
      "field": "culpa laborum",
      "message": "voluptate ea exercitation in cupidatat",
      "error_id": "anim qui"
    }
  ]
}
Request Payload
Response Payload
{
  "send_at": "1968-08-14T22:52:30.0Z",
  "status": "draft"
}
{
  "errors": [
    {
      "field": "id sunt sit dolore minim",
      "message": "fugiat deserunt cillum eiusmod",
      "error_id": "eu occaecat qui"
    },
    {
      "field": "cillum",
      "message": "sed",
      "error_id": "quis minim tempor dolor"
    },
    {
      "field": "Lorem consequat tempor eu",
      "message": "do non veniam",
      "error_id": "irure"
    },
    {
      "field": "adipisicing minim nisi dolor",
      "message": "officia ad ut veniam",
      "error_id": "eiusmod sed et Duis occaecat"
    },
    {
      "field": "in ut esse nostrud",
      "message": "Duis Lorem est",
      "error_id": "dolore in sunt"
    }
  ]
}
{
  "errors": [
    {
      "field": "esse ad deserunt aute dolore",
      "message": "culpa esse",
      "error_id": "anim Excepteur cillum"
    },
    {
      "field": "consectetur incididunt magna ut consequat",
      "message": "fugiat officia labore incididunt dolore",
      "error_id": "sed pariatur esse eu mollit"
    },
    {
      "field": "commodo irure nisi Ut",
      "message": "esse dolore exercitation",
      "error_id": "ipsum"
    },
    {
      "field": "do Duis",
      "message": "anim quis sunt",
      "error_id": "sit commodo aute in irure"
    },
    {
      "field": "in dolor veniam esse voluptate",
      "message": "cillum laboris magna sit",
      "error_id": "sunt nisi nulla et culpa"
    }
  ]
}
Request Payload
Response Payload
{
  "categories": [
    "equipment",
    "shoes",
    "sports"
  ]
}
{
  "errors": [
    {
      "field": "anim amet",
      "message": "est irure",
      "error_id": "tempor"
    },
    {
      "field": "sed cillum nisi et",
      "message": "ullamco ipsum irure",
      "error_id": "nulla dolor reprehenderit incididunt"
    }
  ]
}

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["dolor cupidatat commodo anim","ut","Lorem","voluptate officia in","culpa nisi aliqua commodo","laboris","nostrud in non consequat Excepteur","velit aliqua","esse","elit veniam nisi non"]
page_size10
page_tokenid consectetur aliquip ullamco
Request Payload
Response Payload
{
  "results": [
    {
      "id": "86400550-13a6-2e2f-67ef-42de86d3f87a",
      "aggregation": "exercitation",
      "step_id": "deserunt irure nulla non mollit",
      "stats": {
        "bounce_drops": -45933789,
        "bounces": 60357103,
        "clicks": 6011392,
        "delivered": -13760540,
        "invalid_emails": 49715718,
        "opens": 67225767,
        "requests": 54756563,
        "spam_report_drops": -33162124,
        "spam_reports": -42625460,
        "unique_clicks": -99710200,
        "unique_opens": -38720512,
        "unsubscribes": -3988333
      }
    },
    {
      "id": "4880411c-4a8b-7058-b68c-c017519e2b38",
      "aggregation": "non consequat occaecat dolor sed",
      "step_id": "do enim sunt nostrud laborum",
      "stats": {
        "bounce_drops": -87089970,
        "bounces": -86890423,
        "clicks": -31126181,
        "delivered": 76299017,
        "invalid_emails": -18150309,
        "opens": 20262362,
        "requests": 18858562,
        "spam_report_drops": 3683389,
        "spam_reports": -19353211,
        "unique_clicks": 76831318,
        "unique_opens": 54059273,
        "unsubscribes": -18549983
      }
    },
    {
      "id": "52eb99bb-35bf-7334-49b6-6eb9586372f1",
      "aggregation": "Excepteur",
      "step_id": "dolor",
      "stats": {
        "bounce_drops": 7097135,
        "bounces": 96720058,
        "clicks": -15006849,
        "delivered": -42001036,
        "invalid_emails": 98390600,
        "opens": -20436840,
        "requests": -92694031,
        "spam_report_drops": 48719903,
        "spam_reports": 77332672,
        "unique_clicks": 28187870,
        "unique_opens": 34776686,
        "unsubscribes": 67807719
      }
    },
    {
      "id": "550e9afe-44cc-3091-94be-fcad2e347d76",
      "aggregation": "mollit officia Duis",
      "step_id": "fugiat cupidatat proident est dolor",
      "stats": {
        "bounce_drops": 81677431,
        "bounces": -75757788,
        "clicks": 99988033,
        "delivered": -45228180,
        "invalid_emails": -49229909,
        "opens": 31771128,
        "requests": -85561038,
        "spam_report_drops": 23380498,
        "spam_reports": -69340929,
        "unique_clicks": 99513275,
        "unique_opens": 46071086,
        "unsubscribes": -34418557
      }
    }
  ],
  "_metadata": {
    "prev": "https://sOJewFslaMbAQPxKO.cxmlqcd7.8z9fCBknDi3+bw92MR6FEG3jYo",
    "self": "http://KseNfTUZTxWIYyYMXXff.lmCRu9ylx6CFUUGR3hSWYt8xkDt+.ADt.2k0Y,",
    "next": "http://ZfPNDrkL.cbHxoz78vfX0umXpE1WzXllSTRN9DZADvsbQJc9yNLLk5TE",
    "count": -16509190.143013582
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
group_by["step_id","step_id","step_id","step_id","step_id"]
step_ids["5d658529-b953-0579-3c8f-38b8f0225226","0172d0cc-b1ce-2cb3-95a7-9e95930f8527"]
aggregated_bytotal
start_date1947-11-01
end_date1936-12-20
timezonecupidatat ut cillum dolore
page_size12
page_tokenlabore ut Lorem irure
Request Payload
Response Payload
{
  "results": [
    {
      "id": "8b819bdc-7359-9b68-ecc1-26bd0f20aab1",
      "aggregation": "non eiusmod",
      "step_id": "sed incididunt voluptate culpa",
      "stats": {
        "bounce_drops": -90136951,
        "bounces": -93244777,
        "clicks": -90835761,
        "delivered": 33473269,
        "invalid_emails": 74251306,
        "opens": -55536907,
        "requests": 54990581,
        "spam_report_drops": 907433,
        "spam_reports": -59902371,
        "unique_clicks": 44921399,
        "unique_opens": -26152543,
        "unsubscribes": 44204530
      }
    },
    {
      "id": "86692c55-7666-fe6f-0ec0-0612f1884a24",
      "aggregation": "exercitation qui pariatur",
      "step_id": "esse",
      "stats": {
        "bounce_drops": 61059501,
        "bounces": 34682543,
        "clicks": 3729293,
        "delivered": -10922686,
        "invalid_emails": -95910670,
        "opens": -10192060,
        "requests": -39653677,
        "spam_report_drops": -68425248,
        "spam_reports": -89023390,
        "unique_clicks": -63319492,
        "unique_opens": -2141062,
        "unsubscribes": -83461207
      }
    },
    {
      "id": "5f559d9a-389e-4ecf-97b0-c0ca335871fd",
      "aggregation": "anim aliquip in",
      "step_id": "ex consectetur tempor",
      "stats": {
        "bounce_drops": 70855568,
        "bounces": -51903009,
        "clicks": -37713536,
        "delivered": -90306986,
        "invalid_emails": -98314566,
        "opens": 76999973,
        "requests": 84140755,
        "spam_report_drops": 75095795,
        "spam_reports": 28303926,
        "unique_clicks": -51467503,
        "unique_opens": 14472915,
        "unsubscribes": 96137508
      }
    }
  ],
  "_metadata": {
    "prev": "http://vpCKEohWwn.xkucMBIoDEq8oLXA,wJZCdugDoYUhelBiU25niJCjeLVDaaeh.ubs2f",
    "self": "http://edbppQ.otB17a,U69",
    "next": "http://rADZJAZOTjiRSE.yucyZX5NWWIGxCIEWBR8Gcrfnwbmu9aDnjd0bJHE3A5RNswDOp",
    "count": -4004512.1616494805
  }
}
{
  "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["laborum","nostrud","do","in","voluptate consequat in cillum eu","officia laboris consectetur eu dolore","ea Excepteur ex","sit exercitation nisi","sed","magna cupidatat eu fugiat consequat"]
page_size27
page_tokenirure
Request Payload
Response Payload
{
  "results": [
    {
      "id": "71e983f8-ecc4-715a-b665-c5d75ce49543",
      "ab_variation": "2557d6d0-446d-9df8-e75e-6b03ddca2323",
      "ab_phase": "all",
      "aggregation": "in magna eiusmod",
      "stats": {
        "bounce_drops": 26432774,
        "bounces": 41297372,
        "clicks": -99218749,
        "delivered": 40337868,
        "invalid_emails": -97531536,
        "opens": -13554362,
        "requests": 77944388,
        "spam_report_drops": 28703503,
        "spam_reports": 20309779,
        "unique_clicks": 9457629,
        "unique_opens": -45452540,
        "unsubscribes": -67608670
      }
    },
    {
      "id": "14aefb5b-4033-49f2-4dbc-504468172a23",
      "ab_variation": "c3f65d9d-116f-84fd-17c1-f02d4b814805",
      "ab_phase": "test",
      "aggregation": "enim in sit",
      "stats": {
        "bounce_drops": 24273832,
        "bounces": 36729964,
        "clicks": 93033786,
        "delivered": -85298246,
        "invalid_emails": -53145341,
        "opens": -64834309,
        "requests": -47101919,
        "spam_report_drops": -83385385,
        "spam_reports": -91229550,
        "unique_clicks": 2049795,
        "unique_opens": -58415086,
        "unsubscribes": -88529045
      }
    },
    {
      "id": "09aa5c33-8709-382f-be8d-4c78260c97e9",
      "ab_variation": "c1f46f51-dee2-6095-3e6d-d475c50ee718",
      "ab_phase": "send",
      "aggregation": "ad mollit officia",
      "stats": {
        "bounce_drops": -12300210,
        "bounces": 83889863,
        "clicks": 3181317,
        "delivered": 91442838,
        "invalid_emails": -32717701,
        "opens": -72217572,
        "requests": 44189115,
        "spam_report_drops": -21397138,
        "spam_reports": -22306377,
        "unique_clicks": 50227422,
        "unique_opens": -84316285,
        "unsubscribes": -86089355
      }
    },
    {
      "id": "1f21fbc5-0f0f-2979-9595-f9511ad5cb81",
      "ab_variation": "9fe760dc-1875-0437-0349-34638ffef010",
      "ab_phase": "all",
      "aggregation": "reprehenderit irure id",
      "stats": {
        "bounce_drops": -11223669,
        "bounces": -62311157,
        "clicks": -51583827,
        "delivered": 91543960,
        "invalid_emails": 10713369,
        "opens": -77070752,
        "requests": 93802629,
        "spam_report_drops": 71479541,
        "spam_reports": 1046339,
        "unique_clicks": -47847650,
        "unique_opens": 75025133,
        "unsubscribes": 67241513
      }
    },
    {
      "id": "93da3668-df9d-44e7-dd51-63c199cbd014",
      "ab_variation": "83328684-45f1-351a-5b54-6cc8ae5bafe0",
      "ab_phase": "all",
      "aggregation": "ipsum enim occaecat",
      "stats": {
        "bounce_drops": -64045142,
        "bounces": 61753363,
        "clicks": 93004778,
        "delivered": 38731040,
        "invalid_emails": -5377072,
        "opens": -53834106,
        "requests": -90850228,
        "spam_report_drops": -62850735,
        "spam_reports": 47868719,
        "unique_clicks": 93762408,
        "unique_opens": -37893581,
        "unsubscribes": 10361582
      }
    }
  ],
  "_metadata": {
    "prev": "https://rsoLDjCQuPAgDhJIvfs.gyENuZz882bQKdItlz+EISHAGnqP2DSB.bmA2",
    "self": "http://owEZPYiE.gkDFN5gdMQCEM",
    "next": "https://OhhZEkEQYCTSzoDTBJfmCxNhF.vxknfiQuDMoJS23F",
    "count": 14304600.866387844
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
aggregated_byday
start_date1953-02-13
end_date1935-12-06
timezonevoluptate
page_size63
page_tokendolore cillum
group_by["ab_variation"]
Request Payload
Response Payload
{
  "results": [
    {
      "id": "533addb6-1cf8-3cff-6a2d-c9c3bef20f61",
      "ab_variation": "9ec15596-297b-7c21-7581-fede24fec551",
      "ab_phase": "test",
      "aggregation": "proident commodo occaecat veniam",
      "stats": {
        "bounce_drops": 79658213,
        "bounces": 293947,
        "clicks": 74203771,
        "delivered": 95504729,
        "invalid_emails": -45880213,
        "opens": -88755854,
        "requests": -30844067,
        "spam_report_drops": 64243306,
        "spam_reports": -13507059,
        "unique_clicks": -66484605,
        "unique_opens": 52962578,
        "unsubscribes": -40726122
      }
    },
    {
      "id": "9a646ee5-a4ff-8ac4-432e-5771dd359e7f",
      "ab_variation": "5e50a489-ac4e-f6ce-52e2-6c247fc912c6",
      "ab_phase": "all",
      "aggregation": "minim cupidatat Lorem",
      "stats": {
        "bounce_drops": -58817567,
        "bounces": 71986855,
        "clicks": 67463142,
        "delivered": -20445146,
        "invalid_emails": 45918609,
        "opens": -93247728,
        "requests": 29566386,
        "spam_report_drops": 89472804,
        "spam_reports": -77327269,
        "unique_clicks": 70140010,
        "unique_opens": 63215782,
        "unsubscribes": 94458603
      }
    }
  ],
  "_metadata": {
    "prev": "http://OmdWFkKuFplRrfZ.unyPeASXItQ5rzTLxAwfoU1QxNRLQkefMR0IPr.e5a7pxPW42vPO2Y",
    "self": "http://SK.mihvBbCWuZaUDEqpF59xhnUfQx4YmpBU1NksymIgsOXP",
    "next": "https://RHVkyXSPhkfgwJHFNUjrtQPxd.swXeF21+GnLC2zsKSge-QgtZRw2aHjt5cKirxY0vXWY2hSJUWFldOc",
    "count": 49494763.13167563
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
group_by["step_id","step_id","step_id","step_id"]
step_ids["c7875eea-0c72-dd2e-3e64-9266459a9a11","8ce90fda-d3c9-0a17-cb4c-1f245e47ee4c","67ab7d77-f9d4-fa25-8e77-2601f4a3b725","453f8dc6-4d25-a442-439b-968d859c9bfe"]
page_size94
page_tokenincididunt id ullamco proident dolore
Request Payload
Response Payload
{
  "results": [
    {
      "url": "http://AUJMiDEQMnjRyfGBDAKeIIvISqkCsQ.pzVPGlkzY5L",
      "url_location": 68310259,
      "step_id": "851008e4-2ef4-7c85-ea33-5f09d4e343c5",
      "clicks": 9909386
    },
    {
      "url": "http://hEaBOnAMCoMaIMCdZvcBPGbA.ezlqZ+6f0vzK.c1tX-tOoRzCemp.gmxwI96+v",
      "url_location": 81405071,
      "step_id": "595d6e19-8e1f-bd4b-feb0-60c8c1ecc2d6",
      "clicks": 82134168
    }
  ],
  "total_clicks": -6562263,
  "_metadata": {
    "prev": "https://xSmUzqLkNuPKylWE.fgocef,9k",
    "self": "http://UXSHJLqnNWKVUzmhzBXtWuekFzFfx.wwshIFpqUX32U1EC5ErjwueLbllBD0ygOZSe7J2cmmqP4KBT+rJK,vCa",
    "next": "http://BjdvIbDILfZDEymCnMvnO.frpkM13ykALQRCXxl8NdGIdPNUlSeNS1Do8LyRsI-RBzQ45M0+-bXc1j9xmkDTzkvP9",
    "count": -96002335.3125704
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
page_size18
page_tokenamet reprehenderit ut aliqua qui
group_by["ab_variation"]
ab_variation_id07bb95d8-70e6-2432-1d42-10f9b8e8921f
ab_phase_idtest
Request Payload
Response Payload
{
  "results": [
    {
      "url": "http://deGPXyFqhomCNJdXMjfCLSBIM.umnngXLInGshVVyEmRuRz.i6UpaRuaKoM4ravcj0c3uM",
      "url_location": 20435288,
      "ab_variation": "7bccb4cb-e055-7893-d30a-1ecaa8c562eb",
      "ab_phase": "all",
      "clicks": 95419748
    },
    {
      "url": "https://rAcfOsIMCGEBKsaSDsNVnlmaeEh.nesEf",
      "url_location": 41114902,
      "ab_variation": "7828b235-548d-6f1e-922f-e3a226eaf524",
      "ab_phase": "test",
      "clicks": 12365985
    }
  ],
  "_metadata": {
    "prev": "http://jORplDJC.xrJQdzVLbIBT7NfdEyG1o",
    "self": "http://UpXLqhwY.lkBDm2RR4MCsqDn3b4oGU1TCeP3c+",
    "next": "http://phqbKGzhfZlxnrEBWYBtBygtiToGk.lqjtuK6m3E",
    "count": -90580631.07457355
  },
  "total_clicks": -95865075
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
Query Parameter NameExample
ids["qui sint nulla","sunt ea minim","laborum proident irure magna","adipisicing","Lorem proident commodo in nulla","sit","exercitation","ex amet","est amet in laboris consectetur","reprehenderit do mollit dolore"]
timezoneut nostrud
Request Payload
Response Payload
ex laboris Ut aliquip fugiat
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
ids["laborum est ad","qui consequat","irure","amet laborum in","dolore aute velit","irure","culpa aliqua elit nulla","aliqua veniam velit sint dolore","dolor est","nulla voluptate sed amet Lorem"]
timezoneex ut ea Lorem et
Request Payload
Response Payload
non fugiat cillum in
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Sender Identities API(6 operations)

Header NameExample
on-behalf-of"reprehenderit proident"
Request Payload
{
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States"
}
Response Payload
{
  "id": 1,
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States",
  "verified": true,
  "updated_at": 1449872165,
  "created_at": 1449872165,
  "locked": false
}
{
  "errors": [
    {
      "message": "The JSON you have submitted cannot be parsed.",
      "field": ""
    },
    {
      "message": "You've reached your limit of 100 sender identities. Please delete one or more and try again.",
      "field": ""
    },
    {
      "message": "nickname is required.",
      "field": "nickname"
    },
    {
      "message": "You already have a sender identity with the same nickname.",
      "field": "nickname"
    },
    {
      "message": "from_name is required.",
      "field": "from_name"
    },
    {
      "message": "from_email is required.",
      "field": "from_email"
    },
    {
      "message": "From email is not a valid email address.",
      "field": "from_email"
    },
    {
      "message": "reply_to is required.",
      "field": "reply_to"
    },
    {
      "message": "Reply to email is not a valid email address.",
      "field": "reply_to"
    },
    {
      "message": "address is required.",
      "field": "address"
    },
    {
      "message": "city is required.",
      "field": "city"
    },
    {
      "message": "country is required.",
      "field": "country"
    }
  ]
}
Header NameExample
on-behalf-of"consequat"
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"magna qui fugiat exercitation id"
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"Excepteur labore quis"
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"Lorem irure mollit"
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"consequat magna dolore eu velit"
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "message": "The Sender Identity is already verified.  No email sent.",
      "field": ""
    }
  ]
}
{
  "errors": [
    {
      "message": "resource not found",
      "field": "id"
    }
  ]
}

Contacts API - Lists(10 operations)

Header NameExample
on-behalf-of"dolor"
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"irure eiusmod aliquip laborum ut"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1,
      "name": "the jones",
      "recipient_count": 1
    }
  ]
}
Header NameExample
on-behalf-of"quis cupidatat minim nisi"
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_id15979889
Header NameExample
on-behalf-of"irure"
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*-98637931
Header NameExample
on-behalf-of"quis amet"
Request Payload
{
  "name": "newlistname"
}
Response Payload
{
  "id": 1234,
  "name": "2016 iPhone Users",
  "recipient_count": 0
}
{
  "errors": [
    {
      "message": "invalid id"
    }
  ]
}
{
  "errors": [
    {
      "message": "List ID does not exist"
    }
  ]
}
Query Parameter NameExample
delete_contactstrue
Header NameExample
on-behalf-of"dolore nulla consectetur officia"
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-39176873
page_size-55567311
list_id*79698481
Header NameExample
on-behalf-of"dolor ad anim"
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"dolore laboris voluptate adipisicing tempor"
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"deserunt sed"
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*70704097
recipient_id*-15628796
Header NameExample
on-behalf-of"eiusmod officia ipsum dolore enim"
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"
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"id adipisicing"
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"fugiat sunt"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
{}
{
  "errors": [
    {
      "message": "No recipient ids provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
page1323978
page_size-93642867
Header NameExample
on-behalf-of"non consequat irure culpa"
Request Payload
Response Payload
{
  "recipients": []
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"do"
Request Payload
Response Payload
{
  "status": [
    {
      "id": "worker_delay",
      "value": "delayed"
    },
    {
      "id": "worker_delay_seconds",
      "value": "75.0"
    }
  ]
}
Header NameExample
on-behalf-of"deserunt id elit exercitation"
Request Payload
Response Payload
{
  "recipients": [
    {
      "id": "ut do deserunt culpa",
      "created_at": -43304757.589364275,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "trD80eWbvt@qwEdwRnmoAjmrqkTvjzGSMdvVVB.qq",
      "first_name": null,
      "last_name": "labore aliqua dolore ad nostrud",
      "last_clicked": 40917952.19633362,
      "last_emailed": -59109409.23940915,
      "last_opened": 56854124.68198946,
      "updated_at": -26341826.329699725
    },
    {
      "id": "sed occaecat magna et",
      "created_at": -34353168.78966352,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "fFyreS@BenJXvklbOBS.gj",
      "first_name": "reprehenderit adipisicing aliquip sint",
      "last_name": null,
      "last_clicked": 19984987.428905845,
      "last_emailed": 6343579.658418313,
      "last_opened": -93959673.45187195,
      "updated_at": -62649129.36390488
    },
    {
      "id": "deserunt ex dolor",
      "created_at": -50700795.95727579,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "Umz@YLIEaqXdF.zgs",
      "first_name": null,
      "last_name": "dolore mollit consectetur",
      "last_clicked": -14100675.7518062,
      "last_emailed": null,
      "last_opened": null,
      "updated_at": -98566521.4351334
    },
    {
      "id": "ut",
      "created_at": -45041090.22866056,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "L86ysn5f87MH0R@DSNUcntGlpmewEksBsvPmlE.zdr",
      "first_name": null,
      "last_name": null,
      "last_clicked": 12134317.890789121,
      "last_emailed": null,
      "last_opened": -27963358.871646047,
      "updated_at": -89731994.72623593
    },
    {
      "id": "Ut in dolor ullamco",
      "created_at": 53413539.82031137,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "ycSvM9A@JEBRvaKPmFjDjxUqMiXRmxm.fr",
      "first_name": null,
      "last_name": "incididunt ipsum mollit est nisi",
      "last_clicked": -78995149.73721349,
      "last_emailed": 12807297.57602948,
      "last_opened": 45392856.258573174,
      "updated_at": 45741207.167686224
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"consequat ut"
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"culpa nisi"
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"elit"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"adipisicing ex"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
{field_name}eu et fugiat Excepteur sit
Header NameExample
on-behalf-of"dolor voluptate qui proident"
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"aliqua eiusmod non"
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"velit ut reprehenderit"
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"enim laboris"
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"aliquip Excepteur ipsum mollit non"
Request Payload
Response Payload
{
  "message": "Custom Field delete is processing."
}
{
  "errors": [
    {
      "message": "Custom field in use by one or more segment conditions"
    },
    {
      "message": "Custom field ID does not exist"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "Custom field ID does not exist"
    }
  ]
}
Header NameExample
on-behalf-of"tempor"
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"nisi"
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"irure"
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*-67239099
Header NameExample
on-behalf-of"sunt esse eiusmod fugiat"
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_idexercitation non reprehenderit id dolore
Header NameExample
on-behalf-of"eiusmod et Duis"
Request Payload
{
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ]
}
Response Payload
{
  "id": 5,
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ],
  "recipient_count": 1
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "segment_id": "segment_id",
      "message": "segment id is not valid"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
delete_contactstrue
Header NameExample
on-behalf-of"aliqua"
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
page46021514
page_size14357463
Header NameExample
on-behalf-of"tempor magna consectetur"
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-1552134
categoryest
offset-71545244
Header NameExample
on-behalf-of"ex sunt dolor Duis"
Request Payload
Response Payload
[
  {
    "category": "category 1"
  },
  {
    "category": "category 2"
  }
]
{
  "errors": [
    {
      "field": "sort_by",
      "message": "invalid sort value"
    }
  ]
}
Query Parameter NameExample
sort_by_metricut
sort_by_directiondesc
start_date*exercitation eiusmod
end_datecillum nulla reprehenderit in
limit-40821963
offset39782266
aggregated_byweek
Header NameExample
on-behalf-of"anim sunt"
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*nulla ullamco commodo
end_datedolor consectetur irure ex
categories*ex
limit-32102013
offset48414069
aggregated_byday
Header NameExample
on-behalf-of"in Ut ut culpa irure"
Request Payload
Response Payload
[
  {
    "date": "2015-10-01",
    "stats": [
      {
        "type": "category",
        "name": "docs",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      },
      {
        "type": "category",
        "name": "mattscategory",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "category",
        "name": "docs",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      },
      {
        "type": "category",
        "name": "mattscategory",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]

Campaigns API(11 operations)

Header NameExample
on-behalf-of"do"
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
limit81585416
offset-82394442
Header NameExample
on-behalf-of"officia non ad eu ipsum"
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"consectetur"
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"enim officia eu"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"Duis"
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"in officia aliquip reprehenderit sunt"
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"amet pariatur"
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"adipisicing cillum"
Request Payload
{
  "send_at": 1489451436
}
Response Payload
{
  "id": 89488865,
  "send_at": -954717,
  "status": "fugiat consequat Ut ad adipisicing"
}
{
  "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"in est sunt enim"
Request Payload
Response Payload
{
  "send_at": 1490778528
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"irure id"
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"qui"
Request Payload
{
  "to": "your.email@example.com"
}
Response Payload
{
  "to": "culpa"
}
{
  "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"sed"
Request Payload
{
  "name": "example_name",
  "generation": "dynamic"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "example_name",
  "generation": "legacy",
  "versions": []
}
Query Parameter NameExample
generationsdynamic
page_size*10.407604089507167
page_tokenesse eu commodo
Header NameExample
on-behalf-of"sed"
Request Payload
Response Payload
{
  "result": [
    {
      "id": "fae7c985-eb92-4b47-9987-28ec29dbc698",
      "name": "example_name",
      "generation": "legacy",
      "updated_at ": "2020-11-12 12:00:09",
      "versions": []
    }
  ],
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/templates",
    "count": 1
  }
}
{
  "errors": [
    {
      "": "incididunt dolor voluptate dolore laborum",
      "message": "in et qui",
      "error_id": "magna"
    },
    {
      "": "amet officia mollit",
      "message": "aute reprehenderit Lorem cupidatat",
      "error_id": "laborum"
    },
    {
      "": "ea minim consectetur",
      "message": "enim dolor",
      "error_id": "incididunt minim sint voluptate"
    },
    {
      "": "minim tempor sed sint velit",
      "message": "est cupidatat",
      "error_id": "ex"
    }
  ]
}
Header NameExample
on-behalf-of"sed pariatur consequat laboris consectetur"
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"elit non reprehenderit sit"
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"dolore"
Request Payload
{
  "name": "new_example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "new_example_name",
  "versions": []
}
Header NameExample
on-behalf-of"veniam"
Request Payload
Response Payload
{}

Transactional Templates Versions(5 operations)

Header NameExample
on-behalf-of"Duis deserunt est laborum"
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"et in minim exercitation voluptate"
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"voluptate"
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"fugiat aliqua eiusmod ipsum"
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"nisi amet esse"
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"deserunt"
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"sed laborum aute reprehenderit Ut"
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"anim ex tempor incididunt"
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": "fugiat dolore ut anim"
    },
    {
      "message": "sunt id"
    },
    {
      "message": "nostrud"
    }
  ]
}
Query Parameter NameExample
limitcupidatat et dolore dolor nulla
offsetelit ex amet consequat
aggregated_byday
start_date*sed
end_dateesse labore laborum
Header NameExample
on-behalf-of"cupidatat nostrud"
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"dolore dolor quis tempor"
Request Payload
Response Payload
{
  "public_key": "anim quis in sint"
}
Header NameExample
on-behalf-of"ullamco ipsum proident"
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"sed mollit aliquip"
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"enim dolor"
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": "culpa ipsum aliquip"
    },
    {
      "message": "exercitation"
    },
    {
      "message": "sit"
    },
    {
      "message": "in"
    }
  ]
}
Header NameExample
on-behalf-of"Lorem"
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": "labore est id Excepteur irure"
    },
    {
      "message": "fugiat reprehenderit"
    },
    {
      "message": "eu officia proident"
    }
  ]
}
Header NameExample
on-behalf-of"aliqua"
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": "pariatur sit labore"
    },
    {
      "message": "reprehenderit eiusmod do et"
    },
    {
      "message": "voluptate Ut non sint"
    }
  ]
}
Header NameExample
on-behalf-of"nisi et"
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": "Duis culpa"
    }
  ]
}

Query(2 operations)

Query Parameter NameExample
query*Lorem est ad
limit800.3352544757862
Header NameExample
X-Query-Id"ea"
X-Cursor"adipisicing"
Authorization*"tempor veniam aliquip"
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*"exercitation"
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
queryea sit labore
Header NameExample
Authorization*"culpa consequat aliquip fugiat incididunt"
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*"id laborum ullamco"
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"sed"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "open",
      "title": "Open Tracking",
      "description": "lorem ipsum... .",
      "enabled": true
    }
  ]
}
Header NameExample
on-behalf-of"in ex fugiat"
Request Payload
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"commodo eu"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"amet"
Request Payload
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"elit dolore Duis et"
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"quis Ut eiusmod"
Request Payload
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"ut est nostrud"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"minim in fugiat ex"
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"irure amet voluptate"
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-97062276
offset-42671899
aggregated_byday
start_date*culpa
end_dateculpa sed laborum enim
Header NameExample
on-behalf-of"consectetur elit deserunt"
Request Payload
Response Payload
[
  {
    "date": "2015-11-03",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
countryUS
limit56030849
offset-23016124
aggregated_byweek
start_date*aliquip dolor non dolore
end_datequis
Header NameExample
on-behalf-of"nostrud aute laborum"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 1,
          "unique_clicks": 0,
          "unique_opens": 1
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
limit-55860588
offset-50217579
aggregated_bymonth
start_date*dolor incididunt esse
end_datein cupidatat dolor
Header NameExample
on-behalf-of"Ut nisi"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 2,
          "unique_opens": 2
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
start_date*incididunt culpa tempor quis
end_dateut pariatur
aggregated_byweek
Header NameExample
on-behalf-of"commodo do cupidatat minim eiusmod"
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*amet fugiat id tempor Lorem
end_datenostrud laboris
aggregated_byweek
Header NameExample
on-behalf-of"tempor dolore"
Request Payload
Response Payload
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  }
]
Query Parameter NameExample
mailbox_providersqui consectetur pariatur et adipisicing
limit4997951
offset-36976296
aggregated_bymonth
start_date*Excepteur
end_dateadipisicing
Header NameExample
on-behalf-of"veniam laboris"
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
browsersvelit elit dolor
limit26239863
offset-62234548
aggregated_bymonth
start_date*quis dolore proident est Ut
end_datealiquip ad ex elit aliqua
Header NameExample
on-behalf-of"sit proident in deserunt non"
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-82233259
end_time51180225
Header NameExample
Accept*"ut anim sunt et Lorem"
on-behalf-of"non ex fugiat labore est"
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"mollit exercitation"
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"pariatur in in Lorem"
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*nuAd8WPNixC5@uDHIeuFkxLYiKKIjubmfMtL.du
Header NameExample
on-behalf-of"ea minim in sed"
Request Payload
Error generating example
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Blocks API(4 operations)

Query Parameter NameExample
start_time16953643
end_time-46839041
limit-63576365
offset-34795398
Header NameExample
on-behalf-of"incididunt"
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"tempor sed"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"non"
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"voluptate exercitation do anim"
Request Payload
Response Payload
{}

Spam Reports API(4 operations)

Query Parameter NameExample
start_time-15594054
end_time-8707837
limit36861127
offset-24549705
Header NameExample
on-behalf-of"commodo qui mollit pariatur"
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"sunt dolor elit fugiat aliquip"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"consectetur nisi"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "ip": "10.89.32.5"
  }
]
Header NameExample
on-behalf-of"esse cillum in anim"
Request Payload
Response Payload
{}

Suppressions - Global Suppressions(4 operations)

Header NameExample
on-behalf-of"esse dolore adipisicing exercitation"
Request Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Response Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Query Parameter NameExample
start_time18221321
end_time84303776
limit-13894723
offset-30022243
Header NameExample
on-behalf-of"velit nisi in est"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com"
  }
]
Header NameExample
on-behalf-of"veniam anim quis officia sunt"
Request Payload
Response Payload
{
  "recipient_email": "test@example.com"
}
Header NameExample
on-behalf-of"velit elit"
Request Payload
Response Payload
{}

Suppressions - Unsubscribe Groups(5 operations)

Header NameExample
on-behalf-of"ad"
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
id70768781
Header NameExample
on-behalf-of"officia sit magna ut"
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"in elit est pariatur"
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"et incididunt Ut"
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"sit eu"
Request Payload
Response Payload
{}

Suppressions - Suppressions(6 operations)

Header NameExample
on-behalf-of"sint"
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"officia velit exercitation reprehenderit ea"
Request Payload
Response Payload
[
  "example@example.com",
  "example2@example.com"
]
Header NameExample
on-behalf-of"quis officia eiusmod"
Request Payload
{
  "recipient_emails": [
    "exists1@example.com",
    "exists2@example.com",
    "doesnotexists@example.com"
  ]
}
Response Payload
[
  "exists1@example.com",
  "exists2@example.com"
]
Header NameExample
on-behalf-of"ut sint"
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"ut"
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"mollit aliquip"
Request Payload
Response Payload
Error generating example

Invalid Emails API(4 operations)

Query Parameter NameExample
start_time99358910
end_time75461629
limit-37597649
offset-85473472
Header NameExample
on-behalf-of"sit non adipisicing minim esse"
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"ad consequat Ut laboris voluptate"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"eu non"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]
Header NameExample
on-behalf-of"fugiat Ut voluptate"
Request Payload
Response Payload
{}
Service Homepage: sendgrid.com/en-us
API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started
emails