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": "dolore in et nisi ea"
    },
    {
      "message": "aliqua do minim sit"
    },
    {
      "message": "dolor"
    },
    {
      "message": "nostrud minim consequat exercitation magna"
    },
    {
      "message": "mollit occaecat magna"
    }
  ]
}

Cancel Scheduled Sends(7 operations)

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

API Keys(6 operations)

Header NameExample
on-behalf-of"ut nostrud"
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": "laboris"
    },
    {
      "message": "Excepteur"
    },
    {
      "message": "aliquip incididunt qui"
    },
    {
      "message": "reprehenderit in cillum voluptate"
    }
  ]
}
Query Parameter NameExample
limit-53913577
Header NameExample
on-behalf-of"laboris ullamco laborum magna deserunt"
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": "eiusmod enim in"
    }
  ]
}
Header NameExample
on-behalf-of"eiusmod aute consectetur"
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": "Ut velit mollit"
    },
    {
      "message": "consequat"
    },
    {
      "message": "qui velit deserunt"
    }
  ]
}
Header NameExample
on-behalf-of"minim Excepteur id occaecat amet"
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": "eu cillum eiusmod enim"
    }
  ]
}
Header NameExample
on-behalf-of"ex mollit"
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": "ex et dolor"
    },
    {
      "message": "labore Duis minim"
    }
  ]
}
Header NameExample
on-behalf-of"mollit qui sit nostrud Duis"
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": "aliqua laborum sunt elit"
    }
  ]
}

API Key Permissions

Header NameExample
on-behalf-of"non"
Request Payload
Response Payload
{
  "scopes": [
    "mail.send",
    "alerts.create",
    "alerts.read"
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ut pariatur veniam enim"
    },
    {
      "message": "exercitation proident dolore velit deserunt"
    },
    {
      "message": "amet"
    },
    {
      "message": "in ut"
    },
    {
      "message": "elit dolore do"
    }
  ]
}

Settings - Enforced TLS(2 operations)

Header NameExample
on-behalf-of"nostrud incididunt qui eiusmod reprehenderit"
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": "laboris ullamco incididunt magna voluptate"
    },
    {
      "message": "non"
    }
  ]
}
Header NameExample
on-behalf-of"fugiat ex"
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": "ut ullamco nostrud Duis"
    }
  ]
}

IP Access Management(6 operations)

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

Single Sign-On Settings(5 operations)

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

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

Settings - Mail(13 operations)

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

Settings - Partner(3 operations)

Header NameExample
on-behalf-of"est Excepteur do"
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"do minim eiusmod sint"
Request Payload
Response Payload
{
  "enable_subuser_statistics": false,
  "enabled": true,
  "license_key": ""
}
Query Parameter NameExample
limit97881667
offset78497574
Header NameExample
on-behalf-of"mollit aliqua labore"
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"aute cupidatat dolore ex consequat"
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": "sit cillum",
      "field": "dolore"
    },
    {
      "message": "in ipsum",
      "field": "Duis"
    }
  ]
}
Query Parameter NameExample
limit307
offset82093402
Header NameExample
on-behalf-of"ullamco laborum eu"
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"ullamco amet Excepteur do et"
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
limit12201190
offset-76572095
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"cupidatat dolore deserunt id sit"
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"do"
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"Lorem veniam sunt fugiat tempor"
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"deserunt ipsum ad in"
Request Payload
Response Payload
{
  "errors": [
    {
      "message": "commodo ipsum mollit",
      "field": "proident sit nostrud"
    },
    {
      "message": "ut commodo anim in",
      "field": "aliqua dolor irure"
    },
    {
      "message": "eiusmod ut adipisicing cupidatat",
      "field": "sint non dolore culpa"
    },
    {
      "message": "laborum sed sint ex",
      "field": "aute"
    }
  ]
}
{
  "errors": [
    {
      "message": "username not found",
      "field": "username"
    }
  ]
}
Request Payload
Response Payload
{
  "scope_group_name": "Stats"
}
{}
{
  "errors": [
    {
      "message": "do sit nostrud consectetur",
      "field": "non"
    },
    {
      "message": "reprehenderit",
      "field": "sit qui veniam dolore"
    }
  ]
}
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"veniam sit exercitation"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "consequat et non",
      "field": "cillum"
    },
    {
      "message": "eiusmod est dolor nulla fugiat",
      "field": "in"
    },
    {
      "message": "nulla cillum officia Ut elit",
      "field": "pariatur deserunt proident minim sed"
    }
  ]
}

Alerts(5 operations)

Header NameExample
Authorization"in et qui enim elit"
on-behalf-of"non dolore aliquip"
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": "cillum",
  "message": "anim"
}
Header NameExample
Authorization"officia aliqua Ut culpa dolor"
on-behalf-of"mollit consectetur dolor aliquip"
Request Payload
Response Payload
[
  {
    "created_at": 1451498784,
    "email_to": "example1@example.com",
    "id": 46,
    "percentage": 90,
    "type": "usage_limit",
    "updated_at": 1451498784
  },
  {
    "created_at": 1451498812,
    "email_to": "example2@example.com",
    "frequency": "monthly",
    "id": 47,
    "type": "stats_notification",
    "updated_at": 1451498812
  },
  {
    "created_at": 1451520930,
    "email_to": "example3@example.com",
    "frequency": "daily",
    "id": 48,
    "type": "stats_notification",
    "updated_at": 1451520930
  }
]
Header NameExample
Authorization"mollit voluptate"
on-behalf-of"esse id anim Excepteur"
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"labore sunt"
Request Payload
Response Payload
{}
Header NameExample
on-behalf-of"tempor Ut commodo occaecat"
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"nulla velit"
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"Lorem incididunt"
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"aliquip laborum"
Request Payload
Response Payload
{
  "reputation": 100,
  "type": "paid"
}
Header NameExample
on-behalf-of"Lorem laborum deserunt aute"
Request Payload
Response Payload
{
  "email": "test@example.com"
}
Header NameExample
on-behalf-of"laboris"
Request Payload
{
  "email": "example@example.com"
}
Response Payload
{
  "email": "example@example.com"
}
Header NameExample
on-behalf-of"eiusmod magna velit ut"
Request Payload
Response Payload
{
  "username": "test_username",
  "user_id": 1
}
Header NameExample
on-behalf-of"in eiusmod"
Request Payload
{
  "username": "test_username"
}
Response Payload
{
  "username": "test_username"
}
Header NameExample
on-behalf-of"consectetur tempor"
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"cillum Duis ad est"
Request Payload
{
  "new_password": "new_password",
  "old_password": "old_password"
}
Response Payload
{}

Subusers API(6 operations)

Query Parameter NameExample
usernamedeserunt nostrud ad
limit-90798058
offset15464972
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
usernamestempor nulla adipisicing laboris
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*anim qui
sort_by_metricex Duis tempor dolor
sort_by_directionasc
limit-40596900
offset7066068
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*velit reprehenderit
subuserexercitation et
sort_by_metricblocks
sort_by_directiondesc
limit2820625
offset-43724565
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*voluptate velit ea
end_datecommodo sed
limit76466543
offset96507393
aggregated_bysint et
sort_by_metricqui
Request Payload
Response Payload
{
  "date": "2015-10-11",
  "stats": []
}
Query Parameter NameExample
limit-88996778
offset9547183
aggregated_byday
subusers*sint fugiat in
start_date*fugiat officia exercitation aliqua deserunt
end_datecupidatat eiusmod nulla
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"occaecat"
Request Payload
{
  "ip": "192.168.1.1",
  "subdomain": "email",
  "domain": "example.com"
}
Response Payload
{
  "id": 123,
  "ip": "192.168.1.2",
  "rdns": "o1.email.example.com",
  "users": [],
  "subdomain": "email",
  "domain": "example.com",
  "valid": true,
  "legacy": false,
  "a_record": {
    "valid": true,
    "type": "a",
    "host": "o1.email.example.com",
    "data": "192.168.1.2"
  }
}
Query Parameter NameExample
limit-6833510
offset96628370
iplabore do cillum ut
Header NameExample
on-behalf-of"dolore occaecat"
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"dolore sit sint"
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"anim"
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"fugiat"
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": "mollit",
    "field": "enim"
  }
}

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
ipcommodo nisi dolor amet pariatur
exclude_whitelabelstrue
limit47344175
offset55163193
subusernulla in ex
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
limit1515539
offset61760737
exclude_subuserstrue
usernamenisi Lorem nulla occaecat in
domaindolor magna consequat laborum
Header NameExample
on-behalf-of"dolore ea esse"
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"nostrud"
Request Payload
{
  "domain": "example.com",
  "subdomain": "news",
  "username": "john@example.com",
  "ips": [
    "192.168.1.1",
    "192.168.1.2"
  ],
  "custom_spf": true,
  "default": true,
  "automatic_security": false
}
Response Payload
{
  "id": 302183,
  "user_id": 1446226,
  "subdomain": "example",
  "domain": "example.com",
  "username": "mbernier",
  "ips": [],
  "custom_spf": false,
  "default": true,
  "legacy": false,
  "automatic_security": true,
  "valid": false,
  "dns": {
    "mail_cname": {
      "valid": false,
      "type": "cname",
      "host": "example.example.com",
      "data": "u1446226.wl.sendgrid.net"
    },
    "dkim1": {
      "valid": false,
      "type": "cname",
      "host": "s1._domainkey.example.com",
      "data": "s1.domainkey.u1446226.wl.sendgrid.net"
    },
    "dkim2": {
      "valid": false,
      "type": "cname",
      "host": "s2._domainkey.example.com",
      "data": "s2.domainkey.u1446226.wl.sendgrid.net"
    }
  }
}
Header NameExample
on-behalf-of"dolor occaecat cillum ut eu"
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"quis in"
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"aliqua in"
Request Payload
Response Payload
{}
Query Parameter NameExample
domainet ea
Header NameExample
on-behalf-of"ut Excepteur"
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"Duis"
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"minim"
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"fugiat Ut laboris"
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*incididunt sit id amet
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
usernameconsectetur labore magna laboris
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": "ut pariatur reprehenderit esse consectetur"
    },
    {
      "message": "dolore id"
    },
    {
      "message": "do proident tempor 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": "nostrud amet laborum officia"
    },
    {
      "message": "fugiat dolore"
    },
    {
      "message": "aute cillum tempor minim ad"
    },
    {
      "message": "labore aliqua irure consectetur"
    }
  ]
}
Request Payload
{
  "nickname": "Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105"
}
Response Payload
{
  "id": 1234,
  "nickname": "Example Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St.",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105",
  "verified": true,
  "locked": false
}
{
  "errors": [
    {
      "field": "nisi consequat culpa",
      "message": "voluptate incididunt fugiat",
      "error_id": "velit dolore incididunt quis"
    },
    {
      "field": "deserunt cillum",
      "message": "reprehenderit voluptate consequat aute nulla",
      "error_id": "officia"
    },
    {
      "field": "laboris",
      "message": "dolore",
      "error_id": "sint laborum"
    },
    {
      "field": "elit laborum voluptate sint",
      "message": "sint adipisicing",
      "error_id": "non minim anim consectetur"
    },
    {
      "field": "id Duis occaecat cillum",
      "message": "labore incididunt aliquip non",
      "error_id": "cillum proident"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "Ut esse velit"
    },
    {
      "message": "commodo culpa"
    },
    {
      "message": "aliquip aliqua anim sed esse"
    },
    {
      "message": "esse"
    }
  ]
}
Query Parameter NameExample
limit-51234330.3141964
lastSeenID81967055.3419865
id60696390
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": "laboris in proident pariatur"
    },
    {
      "message": "minim amet mollit sunt dolor"
    }
  ]
}
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": "irure Ut anim qui",
      "error_id": "voluptate ut"
    },
    {
      "message": "dolor est irure consectetur",
      "error_id": "sunt veniam dolor"
    },
    {
      "message": "minim aliqua elit dolor in",
      "error_id": "non"
    },
    {
      "message": "magna",
      "error_id": "Lorem nulla elit id"
    }
  ]
}
{
  "errors": [
    {
      "message": "dolore"
    },
    {
      "message": "consequat laborum ipsum nisi elit"
    },
    {
      "message": "Lorem"
    },
    {
      "message": "qui quis non"
    },
    {
      "message": "fugiat sit est cillum irure"
    }
  ]
}
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": "est consectetur nisi non irure",
      "message": "do adipisicing officia",
      "error_id": "dolore culpa"
    },
    {
      "field": "Duis officia Ut deserunt",
      "message": "et",
      "error_id": "fugiat ipsum aute"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "laborum dolore reprehenderit dolor in",
      "error_id": "eu consectetur"
    },
    {
      "message": "labore do pariatur est",
      "error_id": "veniam et labore mollit cupidatat"
    },
    {
      "message": "aliquip commodo est sint dolore",
      "error_id": "labore veniam nulla"
    },
    {
      "message": "ullamco eu officia ad",
      "error_id": "labore dolore voluptate Lorem aliqua"
    },
    {
      "message": "anim qui",
      "error_id": "cillum labore aliqua elit adipisicing"
    }
  ]
}
{
  "errors": [
    {
      "message": "nisi labore culpa Ut",
      "error_id": "in velit ea"
    },
    {
      "message": "sit occaecat tempor sint dolore",
      "error_id": "officia dolor aute"
    }
  ]
}
{
  "errors": [
    {
      "message": "dolor"
    },
    {
      "message": "dolore"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "officia commodo",
      "error_id": "proident fugiat incididunt Excepteur"
    },
    {
      "message": "ut proident aliquip cillum",
      "error_id": "elit"
    },
    {
      "message": "sed velit qui",
      "error_id": "ullamco sunt"
    },
    {
      "message": "ut dolor amet aliqua magna",
      "error_id": "aliqua ex culpa"
    },
    {
      "message": "quis",
      "error_id": "sint minim et non"
    }
  ]
}
{
  "errors": [
    {
      "message": "eiusmod nulla",
      "error_id": "laboris ut"
    },
    {
      "message": "deserunt",
      "error_id": "eiusmod laboris"
    }
  ]
}
{
  "errors": [
    {
      "message": "sunt anim dolor in"
    },
    {
      "message": "dolor labore"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "message": "sed qui cupidatat nisi",
      "error_id": "quis est voluptate"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "consequat officia sint sunt",
      "error_id": "enim dolore cupidatat"
    }
  ]
}
{
  "errors": [
    {
      "message": "laboris do incididunt eiusmod"
    }
  ]
}

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": "pariatur deserunt est proident",
  "field": "irure elit minim cillum",
  "error_id": "ullamco nisi eu quis Duis"
}
{
  "errors": [
    {
      "message": "amet commodo eu irure",
      "field": "ut enim",
      "error_id": "eiusmod"
    },
    {
      "message": "anim incididunt Excepteur dolore velit",
      "field": "do minim id",
      "error_id": "officia laboris consequat enim"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "15b85720-ce48-48ef-8a07-672b0d3455da",
  "name": "Ahoy, World!",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: arial,helvetica,sans-serif;\n      font-size: 14px;\n    }\n    body {\n      color: #000000;\n    }\n    body a {\n      color: #1188E6;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    ul ul ul ul  {\n      list-style-type: disc !important;\n    }\n    ol ol {\n      list-style-type: lower-roman !important;\n    }\n    ol ol ol {\n      list-style-type: lower-latin !important;\n    }\n    ol ol ol ol {\n      list-style-type: decimal !important;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start--><!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p></p>\n      </td>\n    </tr>\n  </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n    <tbody>\n      <tr>\n        <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "plain_content": "Ahoy, World!\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
  "generate_plain_content": false,
  "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/5yysvuyi1lpdnxo1ym8ax8yd7ompve3azjtme76gamdace01vko3eyn1kzso1lhy.png",
  "subject": "Getting Started",
  "created_at": "2021-04-30T18:51:20Z",
  "updated_at": "2021-04-30T18:51:20Z",
  "editor": "design",
  "categories": []
}
{
  "errors": [
    {
      "message": "in laborum in irure",
      "field": "Duis labore proident",
      "error_id": "Lorem"
    }
  ]
}
{
  "errors": [
    {
      "message": "sunt fugiat adipisicing qui",
      "field": "magna eiusmod",
      "error_id": "esse dolore nostrud"
    },
    {
      "message": "amet",
      "field": "do",
      "error_id": "laboris officia dolore"
    },
    {
      "message": "pariatur veniam minim sed ipsum",
      "field": "aliquip esse eiusmod commodo",
      "error_id": "cillum dolor"
    },
    {
      "message": "Duis eu Excepteur mollit cupidatat",
      "field": "eu",
      "error_id": "aute"
    }
  ]
}
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": "deserunt culpa",
      "field": "ea ad aute nulla qui",
      "error_id": "tempor"
    }
  ]
}
{
  "errors": [
    {
      "message": "do sit",
      "field": "quis cupidatat",
      "error_id": "nostrud minim sint cupidatat sunt"
    },
    {
      "message": "amet",
      "field": "commodo do dolore",
      "error_id": "quis magna aliqua culpa anim"
    },
    {
      "message": "adipisicing reprehenderit",
      "field": "labore magna fugiat",
      "error_id": "eu tempor magna esse"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "message": "non minim nulla nisi",
      "field": "eiusmod dolore",
      "error_id": "fugiat"
    },
    {
      "message": "aliqua",
      "field": "ex",
      "error_id": "dolore veniam"
    },
    {
      "message": "sint",
      "field": "ut dolor",
      "error_id": "Ut"
    },
    {
      "message": "dolor ut reprehenderit nulla exercitation",
      "field": "anim dolor Duis culpa",
      "error_id": "et labore"
    },
    {
      "message": "veniam do culpa",
      "field": "id nisi",
      "error_id": "sunt consequat minim id elit"
    }
  ]
}
{
  "errors": [
    {
      "message": "dolor",
      "field": "qui",
      "error_id": "culpa officia ut adipisicing nostrud"
    },
    {
      "message": "sunt sint ut amet non",
      "field": "Excepteur aute dolore quis officia",
      "error_id": "elit cupidatat consequat qui"
    },
    {
      "message": "aliqua est occaecat Excepteur",
      "field": "consequat reprehenderit ut Duis",
      "error_id": "nulla exercitation enim elit qui"
    },
    {
      "message": "consequat qui",
      "field": "amet",
      "error_id": "dolor dolor qui sit sunt"
    },
    {
      "message": "Lorem irure",
      "field": "velit aliquip non ex",
      "error_id": "Lorem aliquip in"
    }
  ]
}
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": "sint",
      "field": "ut et",
      "error_id": "et nulla dolor incididunt id"
    },
    {
      "message": "adipisicing labore",
      "field": "anim dolor dolore consectetur",
      "error_id": "ex fugiat commodo adipisicing"
    }
  ]
}
Query Parameter NameExample
page_size20590298
page_tokenminim
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": "enim ut in consectetur voluptate",
      "field": "amet ut officia sint",
      "error_id": "Ut dolor do magna"
    },
    {
      "message": "aute nisi est",
      "field": "id eiusmod Duis",
      "error_id": "cillum sunt aliqua aliquip"
    }
  ]
}
{
  "errors": [
    {
      "message": "et in ullamco velit",
      "field": "consequat",
      "error_id": "non"
    },
    {
      "message": "elit dolor officia",
      "field": "labore",
      "error_id": "quis enim reprehenderit exercitation"
    },
    {
      "message": "ipsum dolore laboris non velit",
      "field": "Lorem consectetur sunt dolor",
      "error_id": "adipisicing in officia"
    }
  ]
}
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": "enim ipsum do",
      "field": "proident commodo voluptate aliqua laborum",
      "error_id": "non dolore Ut mollit deserunt"
    }
  ]
}
{
  "errors": [
    {
      "message": "voluptate",
      "field": "consectetur quis et cillum",
      "error_id": "reprehenderit velit proident sunt"
    },
    {
      "message": "dolore",
      "field": "laboris eiusmod veniam",
      "error_id": "pariatur eiusmod culpa"
    },
    {
      "message": "ut consectetur in",
      "field": "quis consectetur sit nostrud fugiat",
      "error_id": "dolore labore Lorem"
    },
    {
      "message": "deserunt dolore consectetur ipsum",
      "field": "ullamco adipisicing exercitation",
      "error_id": "ipsum dolore"
    },
    {
      "message": "eu",
      "field": "ad",
      "error_id": "enim cupidatat nisi ad officia"
    }
  ]
}
Query Parameter NameExample
page_size98757841
page_tokendolore amet culpa non nostrud
summaryfalse
Request Payload
Response Payload
{
  "result": [
    {
      "id": "6ad69134-7165-48cb-964a-6c3cf03e8af8",
      "name": "Off Grid Adventures",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/a85b4b202ff28094828f11ff472360caecf67ead2d186b69b45c904b9251aa0b.png",
      "subject": "Welcome to the family!",
      "created_at": "2019-09-10T02:11:34Z",
      "updated_at": "2021-01-11T21:47:52Z",
      "editor": "design",
      "categories": []
    },
    {
      "id": "b0a9c6f7-a9a1-4b52-b0c5-16fc6f4cdb2b",
      "name": "Song Riddle",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/4ef3a39249f3accb8461b03950c071454a745a232508feca89a626b3e7f578d3.png",
      "subject": "Welcome to Song Riddle!",
      "created_at": "2019-09-10T02:12:32Z",
      "updated_at": "2021-01-11T21:46:43Z",
      "editor": "design",
      "categories": []
    },
    {
      "id": "f8d8da76-bcca-4cfe-b809-733887855f57",
      "name": "Ingrid & Anders 1",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/15c97ffa97ee31693581a67526728d096eef00adfbaa34bb030d91034d477da4.png",
      "subject": "Welcome to Ingrid & Anders!",
      "created_at": "2019-09-10T02:10:38Z",
      "updated_at": "2021-01-11T21:45:05Z",
      "editor": "design",
      "categories": []
    },
    {
      "id": "2935a7d0-7f02-4e0f-a570-dc302ce09749",
      "name": "Ingrid & Anders 2",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/7b36a6c0955cab0c350d105114ad248700a685bd11032592cdef85ae26540afc.png",
      "subject": "Check out these exclusive deals!",
      "created_at": "2019-09-10T02:09:31Z",
      "updated_at": "2021-01-11T21:44:08Z",
      "editor": "design",
      "categories": []
    },
    {
      "id": "7826ef14-7ba6-4dbc-91f0-a8c610ebe962",
      "name": "Ingrid & Anders 3",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/6dd8dd73a1a62bd7a76c4313b52d7c749250d49e31b19cce718906655fcbc675.png",
      "subject": "Join our VIP club and save big!",
      "created_at": "2019-09-10T02:08:29Z",
      "updated_at": "2021-01-11T21:41:35Z",
      "editor": "design",
      "categories": []
    },
    {
      "id": "41da47e7-d3e2-491b-a83f-f499a4139d6a",
      "name": "Mercado",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/9cc87cc7671719712d9d363184995d0ec05103355db300ff03641fe9e205651d.png",
      "subject": "Subject",
      "created_at": "2019-09-10T02:03:06Z",
      "updated_at": "2021-01-11T21:39:23Z",
      "editor": "design",
      "categories": []
    }
  ],
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/designs/pre-builts?page_token=yYzyCxj-iIVgP54t6NjKkunDCKYLLpngo-5vAsfYXz0To34U",
    "count": 6
  }
}

Contacts(13 operations)

Request Payload
{
  "list_ids": [
    "07c0aa3b-9a2f-8935-d635-894dd8c0ad3e"
  ],
  "contacts": [
    {
      "address_line_1": "adipisicing labore id deserunt",
      "address_line_2": "est ut ullamco proident",
      "alternate_emails": [
        "ani",
        "minim esse",
        "nisi in",
        "dolor dolor veniam tempor",
        "irure aliqua dolor"
      ],
      "city": "deser",
      "country": "mollit in ipsum",
      "email": "in dolore mollit fugiat cupidatat",
      "first_name": "anim dolor",
      "last_name": "proident dolore",
      "postal_code": "commodo",
      "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": "irure amet d",
      "address_line_2": "eiusmod dolore",
      "alternate_emails": [
        "consequat occaecat ullamco",
        "adipisicing Excepteur esse occaecat",
        "ex in",
        "et in",
        "dolor"
      ],
      "city": "par",
      "country": "commodo sunt Excepteur ut",
      "email": "aute sed",
      "first_name": "incididunt",
      "last_name": "ex in velit ",
      "postal_code": "nostrud dolor nulla",
      "state_province_region": "deserunt",
      "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": "sed deserunt",
      "address_line_2": "cupidatat commodo cillum qui",
      "alternate_emails": [
        "ut",
        "cillum est",
        "eiusmod voluptate nulla esse",
        "in velit",
        "cillum proident amet"
      ],
      "city": "officia incididunt ut non",
      "country": "culpa ex nostrud",
      "email": "dolor i",
      "first_name": "velit",
      "last_name": "ex sed ",
      "postal_code": "incididunt",
      "state_province_region": "aliquip enim",
      "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": "esse ipsum dolor quis",
      "address_line_2": "dolor",
      "alternate_emails": [
        "proident magna",
        "culpa consequat",
        "elit sit nostrud",
        "",
        "anim sunt Excepteur magna incididunt"
      ],
      "city": "eiusmod t",
      "country": "commodo Lorem aliqua voluptate",
      "email": "quis et eiusmod fugiat reprehenderit",
      "first_name": "commodo reprehende",
      "last_name": "ea",
      "postal_code": "non ex laboris",
      "state_province_region": "in irure dolore",
      "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": "labore Excepteur",
      "address_line_2": "veniam laboris",
      "alternate_emails": [
        "Lorem labore ipsum ullamco minim",
        "exercitation",
        "fugiat ipsum deserunt",
        "dolor esse commodo consectetur ut",
        "proident"
      ],
      "city": "velit incididunt",
      "country": "adi",
      "email": "sunt consectetur elit amet commodo",
      "first_name": "commodo ipsum",
      "last_name": "labore cillum",
      "postal_code": "labore sed in reprehenderit adipisicing",
      "state_province_region": "cupidatat eu ut L",
      "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": "veniam",
      "address_line_2": "magna laborum Ut",
      "alternate_emails": [
        "deserunt velit",
        "laboris sunt",
        "non nostrud ullamco aute quis",
        "adipisicing tempor deserunt",
        "consequat"
      ],
      "city": "ut occaecat",
      "country": "ullamco ut Duis culpa",
      "email": "aute sit",
      "first_name": "ve",
      "last_name": "e",
      "postal_code": "ad aliquip voluptate laboris reprehenderit",
      "state_province_region": "Excepteur qui incid",
      "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": "exercitation ex sed do",
      "address_line_2": "dolor",
      "alternate_emails": [
        "ipsum ut commodo et fugiat",
        "sit consecte",
        "amet",
        "nisi adipisicing",
        "do aliquip minim"
      ],
      "city": "non",
      "country": "ullamco nisi",
      "email": "in id aliqua nostrud",
      "first_name": "amet Lorem",
      "last_name": "anim in",
      "postal_code": "non",
      "state_province_region": "in consequat aliquip",
      "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": "veniam dolor",
      "address_line_2": "in pariatur",
      "alternate_emails": [
        "ea",
        "sit",
        "nulla ea",
        "laborum ea labore Ut adipisicing",
        "ut exercitation esse"
      ],
      "city": "adipisicing",
      "country": "cupidatat commodo in irure ea",
      "email": "anim labore adipisicing",
      "first_name": "ullamco esse consectetur",
      "last_name": "in",
      "postal_code": "velit magna fugiat",
      "state_province_region": "eu",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "sint in enim esse ad",
      "address_line_2": "Excepteur mollit",
      "alternate_emails": [
        "pariatur repr",
        "minim in Lorem",
        "cillum quis nisi id consequat",
        "incididunt do est sint",
        "aute amet"
      ],
      "city": "qui esse Ut nostrud nulla",
      "country": "commodo deserunt ipsu",
      "email": "reprehenderit commodo",
      "first_name": "est ex laborum",
      "last_name": "aute",
      "postal_code": "aliquip nisi",
      "state_province_region": "esse consequat mollit",
      "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": "eu esse",
      "address_line_2": "commodo",
      "alternate_emails": [
        "officia deserunt",
        "magna non elit et irure",
        "magna elit ",
        "deserunt ipsum elit Duis",
        "commodo exercitation nu"
      ],
      "city": "sunt sint amet",
      "country": "eiusmod consectetur Duis",
      "email": "magna in aute est reprehenderit",
      "first_name": "esse ad laborum exercitation eiusmod",
      "last_name": "est",
      "postal_code": "Lorem minim voluptate dolore",
      "state_province_region": "enim",
      "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": "id eu et sunt proident"
}
{
  "errors": [
    {
      "message": "adipisicing in",
      "field": "occaecat magna",
      "error_id": "Excepteur qui",
      "parameter": "officia mollit"
    },
    {
      "message": "dolore consectetur eiusmod in",
      "field": "cupidatat laborum",
      "error_id": "et aliqua",
      "parameter": "Lorem labore"
    },
    {
      "message": "amet incididunt sit laborum ipsum",
      "field": "dolor exercitation in",
      "error_id": "ullamco in",
      "parameter": "et"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "Ut consectetur"
    },
    {
      "message": "officia proident in ea ipsum"
    },
    {
      "message": "velit"
    },
    {
      "message": "dolor aliqua adipisicing dolor"
    }
  ]
}
Query Parameter NameExample
delete_all_contactspariatur magna amet in
idsmagna
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": "labore eu qui"
    },
    {
      "message": "id"
    },
    {
      "message": "minim"
    },
    {
      "message": "cillum"
    },
    {
      "message": "adipisicing commodo ullamco anim enim"
    }
  ]
}
Request Payload
Response Payload
{
  "result": [
    {
      "id": "ad",
      "first_name": "commodo",
      "last_name": "proident dolore commodo",
      "unique_name": "cillum pariatur aliqua in",
      "email": "amet elit adipisicing",
      "alternate_emails": [
        "Ut ullamco incididunt",
        "in ullamco elit dolore ipsum",
        "enim"
      ],
      "address_line_1": "est sit in eu",
      "address_line_2": "aliquip",
      "city": "magna ullamco aute officia cillum",
      "state_province_region": "deserunt Duis dolore amet",
      "country": "ut velit Excepteur",
      "postal_code": "sint et eu occaecat",
      "phone_number": "dolor sit",
      "whatsapp": "pariatur Excepteur cillum dolore dolore",
      "line": "velit est elit",
      "facebook": "sunt consequat laborum sed",
      "list_ids": [
        "consectetur nostrud et esse"
      ],
      "segment_ids": [
        "exercitation Duis ad ut cillum",
        "veniam voluptate",
        "est in ullamco nostrud adipisicing",
        "ipsum"
      ],
      "custom_fields": {},
      "created_at": "dolore",
      "updated_at": "dolore tempor ut commodo",
      "_metadata": {
        "self": "quis"
      }
    },
    {
      "id": "eiusmod esse",
      "first_name": "nulla",
      "last_name": "do",
      "unique_name": "fugiat enim eiusmod",
      "email": "adipisicing aliquip id do incididunt",
      "alternate_emails": [
        "in dolore nisi",
        "Ut adipisicing in dolore",
        "fugiat",
        "dolore dolore"
      ],
      "address_line_1": "magna sunt adipisicing",
      "address_line_2": "ipsum cillum commodo esse minim",
      "city": "eu",
      "state_province_region": "qui eiusmod irure incididunt dolor",
      "country": "pariatur dolore nostrud nulla amet",
      "postal_code": "in Lorem deserunt ex in",
      "phone_number": "qui",
      "whatsapp": "labore",
      "line": "Lorem nostrud ex",
      "facebook": "eiusmod ad eu dolor sed",
      "list_ids": [
        "ad aliqua nulla eu deserunt",
        "reprehenderit",
        "non aliqua ut",
        "sit ipsum"
      ],
      "segment_ids": [
        "magna in irure cupidatat in",
        "Lorem id occaecat dolore",
        "adipisicing ut ad esse",
        "amet"
      ],
      "custom_fields": {},
      "created_at": "dolor aute pariatur magna",
      "updated_at": "in sunt exercitation minim eu",
      "_metadata": {
        "self": "dolor non quis"
      }
    }
  ],
  "_metadata": {
    "self": "ullamco aliquip et eu laborum"
  },
  "contact_count": 47232847
}
{
  "errors": [
    {
      "message": "dolor in ad aliquip ut",
      "field": "dolore voluptate sit",
      "error_id": "magna dolore id",
      "parameter": "minim laborum"
    },
    {
      "message": "id in elit enim aliquip",
      "field": "nisi elit minim eu",
      "error_id": "minim ea",
      "parameter": "ad"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "esse nulla"
    },
    {
      "message": "magna in nulla Excepteur"
    }
  ]
}
Request Payload
Response Payload
{
  "contact_count": 64813996,
  "billable_count": 14291867,
  "billable_breakdown": {
    "total": -53786129,
    "breakdown": {}
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "magna qui anim"
    }
  ]
}
Request Payload
{
  "list_ids": [
    "7af47dc3-fc32-d8c7-e462-dbb26169dbfb",
    "929c3a40-63d6-3ed3-9983-316f978a6658",
    "37564f1c-a5ec-0ed0-18ef-edaa15631ea3",
    "63e7a743-3572-702c-2348-d221e4d4beef",
    "75563fe4-0014-5c5a-9741-8fda8f86abd6"
  ],
  "segment_ids": [
    "proident cillum sit deserunt"
  ],
  "notifications": {
    "email": false
  },
  "file_type": "csv",
  "max_file_size": 36521876
}
Response Payload
{
  "_metadata": {
    "prev": "https://ySluEjcCyaJibewUfBRAJwqVwwL.eovdqiY2MANm,KpR.mgg+qeeVnaEXwp4r",
    "self": "http://GTbQuyYOdWjGRV.ggsziFXme-M1pHax98qVw.tGvAELqj,6IqsJjA+xmRH,bzzS-uSs7.X365JHfuMHx",
    "next": "http://AEwrWmCpVsMBPSbjmqHzvpbRW.qetbhV1yW-",
    "count": 87621650.18880403
  },
  "id": "sunt deserunt laborum"
}
{
  "errors": [
    {
      "message": "id consectetur qui laborum consequat",
      "field": "enim in aute dolore dolor",
      "error_id": "irure et in dolore",
      "parameter": "sint Excepteur"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "non cillum"
    },
    {
      "message": "veniam"
    },
    {
      "message": "aute irure laboris quis Ut"
    },
    {
      "message": "do sint in aliqua"
    }
  ]
}
Request Payload
Response Payload
{
  "result": [
    {
      "id": "sit",
      "status": "sint veniam velit",
      "created_at": "et minim nostrud quis dolor",
      "completed_at": "sit qui veniam non",
      "expires_at": "ea est",
      "urls": [
        "ea sint magna occaecat aliquip",
        "laborum anim veniam dolore velit",
        "dolor dolore reprehenderit",
        "cillum"
      ],
      "user_id": "ad sed Lorem",
      "export_type": "eiusmod mollit sint",
      "segments": [
        {
          "ID": "est adipisicing consequat ut Lorem",
          "Name": "ullamco dolore irure fugiat sunt"
        },
        {
          "ID": "elit cillum",
          "Name": "proident exercitation ea eu"
        },
        {
          "ID": "dolor",
          "Name": "in"
        }
      ],
      "lists": [
        {
          "ID": "Lorem",
          "Name": "Ut labore sunt deserunt in"
        },
        {
          "ID": "proident aliqua amet exercitation",
          "Name": "cillum magna"
        },
        {
          "ID": "incididunt aliquip exercitation dolore",
          "Name": "officia reprehenderit eiusmod Lorem"
        },
        {
          "ID": "officia",
          "Name": "dolore"
        }
      ],
      "_metadata": {
        "prev": "adipisicing dolor",
        "self": "fugiat",
        "next": "ut dolor consequat"
      }
    },
    {
      "id": "mollit et consectetur culpa Ut",
      "status": "officia dolore aute sit",
      "created_at": "nisi proident",
      "completed_at": "officia",
      "expires_at": "incididunt",
      "urls": [
        "nisi dolor sint in officia"
      ],
      "user_id": "ipsum",
      "export_type": "adipisicing quis in ullamco labore",
      "segments": [
        {
          "ID": "veniam laborum consequat",
          "Name": "id Excepteur in amet"
        },
        {
          "ID": "nulla",
          "Name": "aliquip"
        },
        {
          "ID": "nulla",
          "Name": "sunt do dolore commodo esse"
        },
        {
          "ID": "exercitation",
          "Name": "dolor sit"
        },
        {
          "ID": "sunt exercitation eu ad",
          "Name": "exercitation"
        }
      ],
      "lists": [
        {
          "ID": "pariatur dolore magna",
          "Name": "sed dolore"
        },
        {
          "ID": "occaecat nisi laborum pariatur esse",
          "Name": "ex in"
        }
      ],
      "_metadata": {
        "prev": "adipisicing esse sunt",
        "self": "in ut occaecat",
        "next": "elit amet aliquip ad in"
      }
    }
  ],
  "_metadata": {
    "prev": "est voluptate consectetur",
    "self": "elit Ut dolor ex Excepteur",
    "next": "in"
  }
}
{
  "errors": [
    {
      "message": "commodo incididunt Excepteur",
      "": "sed",
      "error_id": "id deserunt commodo"
    },
    {
      "message": "labore ut",
      "": "ea pariatur esse do",
      "error_id": "eu"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "laborum reprehenderit proident eu dolor"
    },
    {
      "message": "dolor ea"
    },
    {
      "message": "labore tempor commodo in"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "amet pariatur nisi Excepteur",
  "first_name": "dolor ullamco commodo in",
  "last_name": "eu",
  "unique_name": "labore voluptate occaecat laborum fugiat",
  "email": "labore amet ut elit",
  "alternate_emails": [
    "cupidatat dolore",
    "ex magna",
    "quis ea reprehenderit",
    "velit"
  ],
  "address_line_1": "fugiat",
  "address_line_2": "ex velit esse aute reprehenderit",
  "city": "reprehenderit elit ad minim",
  "state_province_region": "consequat",
  "country": "aute",
  "postal_code": "do voluptate laboris fugiat cillum",
  "phone_number": "Duis proident minim anim",
  "whatsapp": "pariatur veniam in ut nisi",
  "line": "anim",
  "facebook": "exercitation Lorem nulla eu",
  "list_ids": [
    "aliquip"
  ],
  "segment_ids": [
    "velit sunt exercitation in"
  ],
  "custom_fields": {},
  "created_at": "exercitation proident veniam",
  "updated_at": "enim dolore veniam labore",
  "_metadata": {
    "self": "ullamco cillum"
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "Excepteur officia dolor enim"
    },
    {
      "message": "reprehenderit labore proident sunt commodo"
    },
    {
      "message": "laboris ea"
    }
  ]
}
Request Payload
{
  "query": "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')"
}
Response Payload
{
  "result": [
    {
      "id": "sint sunt",
      "first_name": "esse eiusmod amet est",
      "last_name": "amet",
      "unique_name": "velit",
      "email": "consequat voluptate",
      "alternate_emails": [
        "non reprehenderit minim enim esse",
        "officia laborum aute culpa",
        "non occaecat",
        "anim sunt in nisi"
      ],
      "address_line_1": "eu non dolor Duis aliqua",
      "address_line_2": "pariatur aliquip",
      "city": "pariatur et enim",
      "state_province_region": "quis dolore deserunt commodo velit",
      "country": "sed anim sint",
      "postal_code": "cillum",
      "phone_number": "anim ea",
      "whatsapp": "Excepteur id elit laboris sint",
      "line": "magna ut mollit irure cillum",
      "facebook": "dolore ad cupidatat nisi ea",
      "list_ids": [
        "eu dolore incididunt",
        "dolore sit mollit",
        "minim dolore cupidatat"
      ],
      "segment_ids": [
        "eu veniam proident ad mollit",
        "sint velit in adipisicing nulla",
        "ipsum nostrud ullamco",
        "labore velit minim exercitation"
      ],
      "custom_fields": {},
      "created_at": "cupidatat consequat officia",
      "updated_at": "quis",
      "_metadata": {
        "self": "do reprehenderit mollit nulla"
      }
    },
    {
      "id": "voluptate cupidatat esse Excepteur",
      "first_name": "in",
      "last_name": "est minim proident adipisicing nostrud",
      "unique_name": "in quis consequat est consectetur",
      "email": "officia",
      "alternate_emails": [
        "veniam Duis",
        "magna exercitation sunt in Duis",
        "fugiat ea irure Excepteur labore"
      ],
      "address_line_1": "minim reprehenderit est dolor elit",
      "address_line_2": "mollit proident ex incididunt",
      "city": "et cillum sit aliquip",
      "state_province_region": "amet sed nulla",
      "country": "velit sint commodo",
      "postal_code": "consequat labore voluptate proident culpa",
      "phone_number": "irure magna tempor aute",
      "whatsapp": "proident ipsum dolor tempor magna",
      "line": "in ipsum dolor laborum",
      "facebook": "voluptate anim aliquip",
      "list_ids": [
        "enim sed proident",
        "nisi id dolore",
        "dolore reprehenderit"
      ],
      "segment_ids": [
        "consequat proident dolor elit Duis",
        "Ut id",
        "consequat cillum nulla amet",
        "occaecat sint qui",
        "deserunt commodo in do"
      ],
      "custom_fields": {},
      "created_at": "consequat Excepteur",
      "updated_at": "cillum Excepteur Lorem",
      "_metadata": {
        "self": "reprehenderit labore occaecat exercitation Lorem"
      }
    }
  ],
  "_metadata": {
    "self": "cupidatat do enim"
  },
  "contact_count": 60268040.89632374
}
{
  "errors": [
    {
      "field": "commodo in deserunt cupidatat",
      "message": "irure"
    },
    {
      "field": "sint velit",
      "message": "incididunt deserunt sint"
    },
    {
      "field": "cupidatat ullamco voluptate dolor dolore",
      "message": "ea sit"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "labore aliquip proident"
    },
    {
      "message": "in do Duis incididunt"
    },
    {
      "message": "cupidatat dolor non"
    },
    {
      "message": "culpa sunt id"
    }
  ]
}
Request Payload
{
  "list_ids": [
    "ad proident velit magna",
    "laboris sunt"
  ],
  "file_type": "csv",
  "field_mappings": [
    "elit et qui fugiat sed",
    null,
    "Duis Ut"
  ]
}
Response Payload
{
  "job_id": "in",
  "upload_uri": "culpa proident consequat ex",
  "upload_headers": [
    {
      "header": "dolor Ut",
      "value": "esse enim Ut"
    }
  ]
}
{
  "errors": [
    {
      "message": "exercitation Excepteur nisi",
      "field": "pariatur deserunt",
      "error_id": "ullamco in nulla",
      "parameter": "in dolor elit cillum enim"
    },
    {
      "message": "non",
      "field": "proident mollit eiusmod",
      "error_id": "cupidatat qui laboris amet esse",
      "parameter": "laborum est veniam"
    },
    {
      "message": "consequat pariatur fugiat cillum ut",
      "field": "veniam esse in ad qui",
      "error_id": "labore eiusmod",
      "parameter": "tempor qui nulla sit"
    },
    {
      "message": "dolor commodo pariatur aliquip aliqua",
      "field": "ea nostrud velit do eiusmod",
      "error_id": "consequat proident",
      "parameter": "commodo nostrud aliqua ea"
    },
    {
      "message": "cupidatat laboris laborum ad",
      "field": "enim officia",
      "error_id": "labore aute Excepteur pariatur magna",
      "parameter": "in sed aliqua nulla"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "do exercitation fugiat",
      "field": "dolor enim exercitation velit",
      "error_id": "labore sit tempor anim",
      "parameter": "Duis"
    },
    {
      "message": "quis",
      "field": "dolore pariatur deserunt et do",
      "error_id": "elit pariatur",
      "parameter": "id ipsum occaecat in"
    },
    {
      "message": "reprehenderit amet nostrud sit",
      "field": "commodo nostrud",
      "error_id": "ullamco ad id sint aliqua",
      "parameter": "tempor nulla sed qui sit"
    }
  ]
}
{
  "errors": [
    {
      "message": "tempor"
    },
    {
      "message": "occaecat dolor sit magna irure"
    },
    {
      "message": "voluptate"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "anim",
  "status": "cupidatat non fugiat",
  "job_type": "sint",
  "results": {
    "requested_count": 80093881.14078319,
    "created_count": 76485331.51619786,
    "updated_count": 35398213.022866905,
    "deleted_count": -62770452.810682856,
    "errored_count": -88162003.66146073,
    "errors_url": "ipsum culpa elit commodo officia"
  },
  "started_at": "sint Excepteur dolore consequat ex",
  "finished_at": "ut"
}
{
  "errors": {
    "message": "aute occaecat sed veniam",
    "field": "in aute",
    "error_id": "sint enim aute dolore",
    "parameter": "cillum labore ut minim 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 ut"
    },
    {
      "message": "ut enim"
    },
    {
      "message": "amet"
    },
    {
      "message": "eu"
    },
    {
      "message": "ut"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "ad id eiusmod voluptate adipisicing",
  "status": "ready",
  "created_at": "et nisi officia",
  "updated_at": "ipsum",
  "completed_at": "eiusmod",
  "expires_at": "sit cillum",
  "urls": [
    "do pariatur",
    "culpa",
    "pariatur in nostrud",
    "ex in cupidatat",
    "aliquip"
  ],
  "message": "dolore commodo aute minim id",
  "_metadata": {
    "prev": "http://H.ataeGkWbnQ",
    "self": "https://beoFM.quknFYdQBolW6Dgxy41Og6V4KkQUHHgBxEyOjFQ0vdydFmF1",
    "next": "https://MnrrsFzOavVngDBcdXPTNqsSjxnnfXg.zjvxzNzExxl1H8REwkmAMKxVoOiX9AMC-cYl8ZzoXrBzoncV97CjXYYzzx+NfEnE6TVl43RVv8Sd04",
    "count": 8108713.598564059
  },
  "contact_count": -24296090
}
{
  "errors": [
    {
      "message": "exercitation veniam sunt consequat",
      "field": "velit ut anim",
      "error_id": "dolore minim",
      "parameter": "nostrud in esse Duis"
    },
    {
      "message": "ex dolor",
      "field": "dolor",
      "error_id": "velit consectetur",
      "parameter": "ut dolor"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "do"
    },
    {
      "message": "tempor"
    }
  ]
}
Request Payload
{
  "ids": [
    "1234",
    "1235"
  ]
}
Response Payload
{
  "result": [
    {
      "id": "enim cillum dolor",
      "first_name": "eiusmod ut in",
      "last_name": "quis ex aliqua",
      "unique_name": "occaecat reprehenderit laboris quis",
      "email": "consequat ipsum dolore id incididunt",
      "alternate_emails": [
        "laboris Excepteur nulla",
        "voluptate in fugiat exercitation quis",
        "minim"
      ],
      "address_line_1": "enim id dolore proident",
      "address_line_2": "ut anim irure",
      "city": "est ut ex adipisicing",
      "state_province_region": "ullamco",
      "country": "mollit ex Duis nostrud",
      "postal_code": "occaecat elit ullamco in",
      "phone_number": "sunt amet cillum",
      "whatsapp": "voluptate nisi amet reprehenderit pariatur",
      "line": "veniam",
      "facebook": "occaecat nostrud proident Ut ea",
      "list_ids": [
        "non exercitation elit",
        "dolore in velit consequat labore",
        "proident aliquip voluptate consequat est",
        "in eiusmod",
        "consectetur voluptate"
      ],
      "segment_ids": [
        "Ut elit",
        "culpa aliquip consectetur laboris pariatur"
      ],
      "custom_fields": {},
      "created_at": "labore non aliqua sint ad",
      "updated_at": "sint mollit proident sunt minim",
      "_metadata": {
        "self": "ut elit consectetur"
      }
    },
    {
      "id": "in",
      "first_name": "eu sint esse",
      "last_name": "eu",
      "unique_name": "velit anim ea",
      "email": "nisi reprehenderit",
      "alternate_emails": [
        "minim in velit",
        "incididunt id nulla",
        "labore quis aliqua",
        "officia",
        "dolor ut nostrud ipsum consequat"
      ],
      "address_line_1": "sed",
      "address_line_2": "nisi",
      "city": "culpa non",
      "state_province_region": "ex cillum laborum",
      "country": "Duis irure",
      "postal_code": "exercitation velit dolor enim sit",
      "phone_number": "culpa et nostrud reprehenderit Lorem",
      "whatsapp": "esse reprehenderit consequat culpa",
      "line": "sint",
      "facebook": "dolore",
      "list_ids": [
        "Duis irure do adipisicing id"
      ],
      "segment_ids": [
        "do est cillum nostrud",
        "dolor laborum"
      ],
      "custom_fields": {},
      "created_at": "aliqua",
      "updated_at": "cillum qui ad pariatur",
      "_metadata": {
        "self": "est dolore ad nisi"
      }
    },
    {
      "id": "pariatur dolore",
      "first_name": "in nisi",
      "last_name": "commodo est incididunt cupidatat",
      "unique_name": "laboris Ut proident occaecat",
      "email": "in",
      "alternate_emails": [
        "ipsum ex",
        "sed nostrud in"
      ],
      "address_line_1": "irure",
      "address_line_2": "proident enim aliquip",
      "city": "sit",
      "state_province_region": "ad pariatur magna",
      "country": "non et ullamco nostrud Excepteur",
      "postal_code": "ex",
      "phone_number": "culpa velit eiusmod Lorem irure",
      "whatsapp": "nostrud deserunt esse velit",
      "line": "consectetur in",
      "facebook": "non pariatur proident eiusmod",
      "list_ids": [
        "quis esse",
        "pariatur",
        "elit mollit exercitation id",
        "exercitation ullamco"
      ],
      "segment_ids": [
        "sunt cillum adipisicing",
        "Excepteur laborum Ut"
      ],
      "custom_fields": {},
      "created_at": "sint qui Lorem",
      "updated_at": "proident Excepteur veniam",
      "_metadata": {
        "self": "eiusmod"
      }
    },
    {
      "id": "commodo officia incididunt adipisicing laboris",
      "first_name": "exercitation Duis velit culpa in",
      "last_name": "sint ipsum in",
      "unique_name": "laborum consectetur commodo magna quis",
      "email": "Lorem culpa",
      "alternate_emails": [
        "nulla in officia",
        "id esse",
        "dolor proident voluptate est elit"
      ],
      "address_line_1": "sint occaecat",
      "address_line_2": "dolor proident reprehenderit Ut",
      "city": "esse sit minim non",
      "state_province_region": "in ex Duis laboris dolore",
      "country": "deserunt irure et consequat",
      "postal_code": "nulla elit dolore",
      "phone_number": "cillum nulla",
      "whatsapp": "velit",
      "line": "laborum",
      "facebook": "proident ullamco anim",
      "list_ids": [
        "elit",
        "fugiat non ad",
        "deserunt"
      ],
      "segment_ids": [
        "Excepteur enim",
        "exercitation",
        "sint"
      ],
      "custom_fields": {},
      "created_at": "et quis eiusmod in",
      "updated_at": "sint exercitation",
      "_metadata": {
        "self": "magna nisi cillum quis"
      }
    },
    {
      "id": "ut officia deserunt ex nostrud",
      "first_name": "voluptate ea",
      "last_name": "anim minim Duis dolor",
      "unique_name": "fugiat dolore",
      "email": "sunt velit pariatur cillum",
      "alternate_emails": [
        "dolore quis",
        "Duis in quis",
        "labore ullamco",
        "ullamco",
        "ullamco incididunt ad"
      ],
      "address_line_1": "dolore laborum ullamco cupidatat",
      "address_line_2": "esse veniam occaecat exercitation",
      "city": "magna in deserunt labore",
      "state_province_region": "Ut labore veniam Duis",
      "country": "enim Ut",
      "postal_code": "incididunt esse",
      "phone_number": "reprehenderit in",
      "whatsapp": "nostrud reprehenderit cupidatat ea velit",
      "line": "non Excepteur aute",
      "facebook": "ex nisi",
      "list_ids": [
        "ipsum nostrud voluptate minim qui",
        "fugiat culpa elit nostrud",
        "reprehenderit",
        "in aliqua Ut est",
        "sunt deserunt"
      ],
      "segment_ids": [
        "anim et consequat Excepteur laboris"
      ],
      "custom_fields": {},
      "created_at": "reprehenderit ullamco et",
      "updated_at": "ipsum et sed cupidatat",
      "_metadata": {
        "self": "id"
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "mollit adipisicing"
    },
    {
      "message": "eu"
    },
    {
      "message": "consectetur"
    },
    {
      "message": "elit in"
    },
    {
      "message": "ut adipisicing"
    }
  ]
}
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": "esse exercitation adipisicing ut et"
    },
    {
      "message": "Lorem Excepteur adipisicing sint"
    },
    {
      "message": "laborum irure"
    },
    {
      "message": "sit Lorem aliqua nisi labore"
    },
    {
      "message": "irure adipisicing veniam voluptate"
    }
  ]
}

Segmenting Contacts V2 - Beta(5 operations)

Request Payload
{
  "name": "consequat in aliquip elit et",
  "parent_list_ids": [
    "dolor tempor dolore laborum",
    "sit eiusmod commodo",
    "magna nisi aliqua",
    "sint deserunt eu Duis aliquip"
  ],
  "query_dsl": "ullamco"
}
Response Payload
{
  "id": "512db67c-dd85-5b68-fa3b-609151333351",
  "name": "do",
  "query_dsl": "commodo",
  "contacts_count": 52044061,
  "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"
      }
    }
  ],
  "created_at": "nulla et cupidatat cillum aliqua",
  "updated_at": "id laboris",
  "sample_updated_at": "culpa non mollit commodo",
  "next_sample_update": "Ut",
  "parent_list_ids": [
    "velit exercitation anim",
    "eiusmod enim labore"
  ],
  "query_version": "aliquip reprehenderit anim consectetur sint",
  "status": {
    "query_validation": "voluptate",
    "error_message": "irure aute"
  }
}
{
  "errors": [
    {
      "field": "sed dolore",
      "message": "commodo pariatur"
    },
    {
      "field": "quis Excepteur",
      "message": "aute"
    },
    {
      "field": "sunt enim occaecat ut",
      "message": "in incididunt nisi adipisicing"
    }
  ]
}
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": "fugiat veniam",
      "message": "dolore"
    }
  ]
}
Query Parameter NameExample
parent_list_idsipsum
no_parent_list_idfalse
Request Payload
Response Payload
{
  "id": "173f8fd7-a9dd-ea2a-bdc4-f21b38f1c7f6",
  "name": "sit",
  "contacts_count": -61491458,
  "created_at": "in",
  "updated_at": "ipsum ut sed",
  "sample_updated_at": "consequat voluptate cillum est",
  "next_sample_update": "tempor Duis do elit reprehenderit",
  "parent_list_ids": [
    "occaecat ex ipsum",
    "qui fugiat magna adipisicing",
    "proident",
    "in quis qui est",
    "aliquip cillum aute in dolore"
  ],
  "query_version": "ipsum nisi veniam",
  "_metadata": {
    "prev": "http://LroOZWasUNSQwGx.nwdfmzvymtGBg2V.n4nMJfC039q",
    "self": "https://sd.afpiaiqzponNTSO4luaGWM4wn",
    "next": "https://DkvyNLZ.oebaSg+uOxRRcmULAkJvPl3tkaX",
    "count": 1404512
  },
  "status": {
    "query_validation": "adipisicing",
    "error_message": "esse eiusmod dolore ut nostrud"
  }
}
{
  "errors": [
    {
      "field": "cupidatat qui Lorem reprehenderit",
      "message": "Duis ipsum reprehenderit cillum proident"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "nisi pariatur",
      "message": "dolore laborum eiusmod"
    },
    {
      "field": "est cillum non",
      "message": "in"
    },
    {
      "field": "ullamco laboris nostrud aliqua",
      "message": "aliqua consectetur sed sit magna"
    },
    {
      "field": "et mollit sunt nostrud",
      "message": "laborum incididunt deserunt sint ea"
    }
  ]
}
Request Payload
{
  "name": "sint pariatur consectetur",
  "query_dsl": "ad laboris"
}
Response Payload
{
  "id": "66014753-1072-78c7-453a-d2fd9538d337",
  "name": "cillum nostrud commodo occaecat amet",
  "query_dsl": "magna cillum eiusmod",
  "contacts_count": -33355951,
  "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"
      }
    }
  ],
  "created_at": "consectetur non veniam dolor anim",
  "updated_at": "in consectetur aliquip officia pariatur",
  "sample_updated_at": "sed Lorem consectetur",
  "next_sample_update": "Lorem ut et aliqua",
  "parent_list_ids": [
    "sit non occaecat enim",
    "est officia cupidatat"
  ],
  "query_version": "ullamco",
  "status": {
    "query_validation": "do voluptate Duis",
    "error_message": "sunt commodo non"
  }
}
{
  "errors": [
    {
      "field": "dolore in tempor",
      "message": "nostrud eiusmod"
    },
    {
      "field": "minim aliquip laborum nulla",
      "message": "veniam consectetur id"
    },
    {
      "field": "occaecat Ut non ea",
      "message": "dolor aliqua fugiat"
    },
    {
      "field": "dolore enim cupidatat dolor",
      "message": "nisi eu cupidatat"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "ex irure",
      "message": "deserunt velit pariatur enim ullamco"
    },
    {
      "field": "sed nostrud officia enim aliqua",
      "message": "velit Ut ut irure Excepteur"
    }
  ]
}
Query Parameter NameExample
contacts_samplefalse
Request Payload
Response Payload
{
  "id": "86c0eac2-55b5-4a3a-e82e-87951142ca20",
  "name": "nisi nostrud",
  "query_dsl": "magna consectetur proident",
  "contacts_count": -70128452,
  "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"
      }
    }
  ],
  "created_at": "esse id",
  "updated_at": "nulla ea reprehenderit adipisicing",
  "sample_updated_at": "magna est",
  "next_sample_update": "cupidatat dolore cillum",
  "parent_list_ids": [
    "adipisicing",
    "sit"
  ],
  "query_version": "laborum veniam Lorem",
  "status": {
    "query_validation": "consectetur in nostrud in voluptate",
    "error_message": "pariatur anim"
  }
}
{
  "errors": [
    {
      "field": "anim commodo nostrud consectetur do",
      "message": "occaecat nisi consequat"
    },
    {
      "field": "exercitation Duis",
      "message": "dolor"
    },
    {
      "field": "veniam voluptate tempor dolore velit",
      "message": "enim pariatur commodo"
    }
  ]
}
{
  "errors": [
    {
      "field": "sit consequat elit ex dolor",
      "message": "nulla adipisicing quis minim voluptate"
    },
    {
      "field": "officia ut ex anim",
      "message": "id cillum deserunt culpa"
    },
    {
      "field": "dolor amet in",
      "message": "adipisicing pariatur occaecat in voluptate"
    },
    {
      "field": "qui officia Duis",
      "message": "est eu minim laboris do"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "laboris",
      "message": "enim et culpa"
    },
    {
      "field": "et dolore nostrud id commodo",
      "message": "Duis sunt"
    },
    {
      "field": "adipisicing do exercitation",
      "message": "sed nostrud minim dolore"
    },
    {
      "field": "ut Duis exercitation",
      "message": "dolore Ut"
    },
    {
      "field": "Excepteur et in voluptate dolore",
      "message": "in reprehenderit dolor"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "sit in",
      "message": "adipisicing"
    },
    {
      "field": "officia magna",
      "message": "sint id quis"
    }
  ]
}

Senders

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

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

segmenting contacts(5 operations)

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

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

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": "reprehenderit mollit dolore",
      "message": "Excepteur cupidatat officia",
      "error_id": "Lorem"
    },
    {
      "field": "ad anim ullamco minim irure",
      "message": "mollit quis sed ullamco do",
      "error_id": "Ut eu aute"
    }
  ]
}
{
  "errors": [
    {
      "field": "proident dolor sint",
      "message": "dolore Excepteur fugiat veniam",
      "error_id": "Duis id"
    },
    {
      "field": "id adipisicing",
      "message": "nisi est",
      "error_id": "anim fugiat et laborum"
    },
    {
      "field": "irure sunt est",
      "message": "reprehenderit ut",
      "error_id": "occaecat"
    },
    {
      "field": "adipisicing minim",
      "message": "nostrud officia cillum",
      "error_id": "eiusmod ea"
    },
    {
      "field": "eu mollit occaecat in",
      "message": "qui dolor officia aliquip adipisicing",
      "error_id": "sunt sit Excepteur irure laboris"
    }
  ]
}
Query Parameter NameExample
page_size38143674
page_tokenveniam est commodo quis
Request Payload
Response Payload
{
  "result": [
    {
      "id": "d25fb1c3-c54e-f114-59b6-0c2fdda69e74",
      "name": "ea",
      "abtest": null,
      "status": "scheduled",
      "categories": [
        "proident",
        "dolore reprehenderit ipsum ullamco",
        "ad sed quis et elit",
        "non",
        "esse anim ea",
        "consectetur officia",
        "consequat",
        "ullamco pariatur sint",
        "ut dolor",
        "culpa Ut ad"
      ],
      "send_at": "1933-08-02T08:07:11.0Z",
      "is_abtest": false,
      "updated_at": "1930-02-12T19:22:47.0Z",
      "created_at": "1897-06-04T11:40:42.0Z"
    }
  ],
  "_metadata": {
    "prev": "https://kbvNHHwaWpITgLEKAlTSctJuXBmUd.gebgP",
    "self": "https://vI.tzhiKVsDZOv5grd2u,yrsyrc3Tyl,8vM1dVsuvcJerlD.5M6d9EqqTPi8RUOgB,pbTB0MYn-iOpFO",
    "next": "https://nhfNtSYBkAzahQkVNFeBqhrBA.loVtrqLsj,rzlcZOrtkI75eeDv5qdal,vkvmU7AalVTJyYB",
    "count": 73662034
  }
}
{
  "errors": [
    {
      "field": "in",
      "message": "sed ad",
      "error_id": "pariatur eiusmod sunt"
    },
    {
      "field": "sint est deserunt anim cupidatat",
      "message": "ut velit dolor aute",
      "error_id": "enim ut officia"
    },
    {
      "field": "sit",
      "message": "aliqua",
      "error_id": "occaecat dolore exercitation quis in"
    },
    {
      "field": "anim",
      "message": "ad anim in",
      "error_id": "aliqua culpa esse mollit"
    },
    {
      "field": "cillum",
      "message": "nostrud dolore ullamco nulla nisi",
      "error_id": "proident eiusmod pariatur enim"
    }
  ]
}
Query Parameter NameExample
ids["amet fugiat laboris consectetur","Ut Duis ipsum in","elit","aute","quis consequat ullamco minim","in dolor sed exercitation commodo","esse laboris dolore Excepteur ad","aliquip","dolor","tempor"]
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "esse velit do in incididunt",
      "message": "tempor",
      "error_id": "laboris eiusmod fugiat in"
    },
    {
      "field": "amet cupidatat in nulla dolor",
      "message": "consequat laborum",
      "error_id": "non"
    }
  ]
}
{
  "errors": [
    {
      "field": "ut consequat qui",
      "message": "nulla laborum veniam ad culpa",
      "error_id": "velit"
    }
  ]
}
Request Payload
{
  "name": "dolor"
}
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": "occaecat laborum pariatur sunt",
      "message": "do aute eu labore",
      "error_id": "aliqua occaecat cillum deserunt"
    },
    {
      "field": "nostrud quis",
      "message": "ex incididunt minim",
      "error_id": "culpa aliqua ut nostrud aliquip"
    }
  ]
}
{
  "errors": [
    {
      "field": "est sint tempor nostrud eiusmod",
      "message": "dolore magna",
      "error_id": "tempor qui aliqua"
    },
    {
      "field": "ullamco mollit incididunt ipsum esse",
      "message": "ad esse ipsum cillum nisi",
      "error_id": "incididunt do sit in enim"
    },
    {
      "field": "commodo proident",
      "message": "aute nostrud dolore in",
      "error_id": "in sunt irure ut"
    },
    {
      "field": "cupidatat veniam anim Ut deserunt",
      "message": "id in Duis mollit",
      "error_id": "dolore exercitation consectetur laborum"
    },
    {
      "field": "officia",
      "message": "cupidatat deserunt",
      "error_id": "in consectetur"
    }
  ]
}
Request Payload
{
  "name": "adipisicing Duis deserunt cillum",
  "categories": [
    "dolor cillum nisi voluptate",
    "aliqua quis et",
    "Ut laboris",
    "pariatur est id ullamco",
    "fugiat laborum",
    "laborum in",
    "laborum irure voluptate magna et",
    "tempor nostrud id commodo",
    "labore Lorem",
    "dolor"
  ],
  "send_at": "1903-12-26T01:45:08.0Z",
  "send_to": {
    "list_ids": [
      "3b1687b9-ff09-f85f-7657-e7604cd745f8",
      "d95e8568-cba4-f3f1-b940-b4368e1368b4",
      "181ccff7-a355-d837-441c-47113ec27c8c",
      "6a24357d-7956-0915-aa1e-45b2dec8eeeb",
      "2afdf9e4-4584-1747-09aa-3230149756f4",
      "89a1c4e6-f81e-24a4-49da-d0b948424557",
      "4854d040-91ab-f335-e435-da79916c706e",
      "652f1012-947e-e87f-003e-ffdd76e715b7",
      "9b47ce63-44cd-c0c0-5f46-5d5ddf777d42",
      "22c4f125-2e34-aa2f-f498-fe91ffa92ab1"
    ],
    "segment_ids": [
      "d4fd2435-816e-02ec-dd81-1b8f6b7f5314",
      "794a8661-3395-4a83-73c4-a85aac009278",
      "224bc03a-baa0-a13c-ca31-9ad85f5b7c2c",
      "1e991a12-bba7-06b6-b7a1-f3a1e95d9dd9",
      "f5345d23-297b-5eab-9de1-e6a633102163",
      "1024a981-83f7-60ef-886e-e4be01aae449",
      "fd9aaf04-9152-e7d7-6863-a086e68bb972",
      "124a16dd-c2d4-ced0-3b49-129dfa3e033c",
      "a2f6a1a4-7047-97f0-4f03-99e9bf8f5a0a",
      "37d713e0-b063-307e-58be-e65f014ba17e"
    ],
    "all": true
  },
  "email_config": {
    "subject": "irure anim",
    "html_content": "in culpa est aute sint",
    "plain_content": "minim mollit consequat dolore",
    "generate_plain_content": false,
    "design_id": "ipsum in Lorem culpa eiusmod",
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": -30096344,
    "ip_pool": "aute cillum deserunt non"
  }
}
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": "ex veniam est proident",
      "message": "enim",
      "error_id": "cupidatat voluptate labore in"
    },
    {
      "field": "Ut",
      "message": "ipsum enim adipisicing labore nisi",
      "error_id": "sunt"
    },
    {
      "field": "laborum dolor sint velit",
      "message": "ea Ut Lorem ullamco",
      "error_id": "Duis et"
    },
    {
      "field": "anim",
      "message": "minim eu qui aliqua ex",
      "error_id": "laborum fugiat"
    }
  ]
}
{
  "errors": [
    {
      "field": "reprehenderit eiusmod sunt consequat",
      "message": "ullamco",
      "error_id": "cupidatat enim dolore"
    },
    {
      "field": "in nulla",
      "message": "ipsum laborum",
      "error_id": "incididunt do sed"
    },
    {
      "field": "tempor Ut",
      "message": "enim deserunt",
      "error_id": "dolor id velit"
    },
    {
      "field": "Lorem esse incididunt",
      "message": "proident",
      "error_id": "consequat"
    },
    {
      "field": "consequat ex",
      "message": "sint labore eu sunt ex",
      "error_id": "cupidatat aliqua sint"
    }
  ]
}
{
  "errors": [
    {
      "field": "occaecat ad",
      "message": "amet sunt",
      "error_id": "dolore"
    },
    {
      "field": "eiusmod",
      "message": "Lorem dolor",
      "error_id": "cillum Ut ad"
    },
    {
      "field": "id eiusmod consequat",
      "message": "veniam proident ut Excepteur officia",
      "error_id": "exercitation quis officia"
    },
    {
      "field": "et",
      "message": "dolor aliquip laboris",
      "error_id": "cupidatat culpa in nostrud officia"
    }
  ]
}
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": "ea proident nostrud officia tempor",
      "message": "eu amet",
      "error_id": "veniam consectetur ex esse"
    }
  ]
}
{
  "errors": [
    {
      "field": "laboris officia aliquip qui",
      "message": "amet commodo",
      "error_id": "nulla adipisicing aliqua"
    },
    {
      "field": "tempor reprehenderit",
      "message": "ullamco eu do",
      "error_id": "in est ex dolore"
    },
    {
      "field": "incididunt",
      "message": "dolor in",
      "error_id": "sunt"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "laboris Lorem velit ex",
      "message": "laborum",
      "error_id": "officia"
    },
    {
      "field": "fugiat non",
      "message": "ullamco ea",
      "error_id": "esse"
    },
    {
      "field": "quis aliqua eu mollit",
      "message": "ipsum id pariatur est",
      "error_id": "laborum Lorem"
    },
    {
      "field": "nulla laborum",
      "message": "aliquip aute cupidatat do",
      "error_id": "enim qui ad dolore in"
    },
    {
      "field": "dolore non veniam",
      "message": "aute",
      "error_id": "ea dolore consectetur ullamco"
    }
  ]
}
{
  "errors": [
    {
      "field": "culpa",
      "message": "Lorem in",
      "error_id": "nulla commodo aute"
    },
    {
      "field": "cupidatat sit do labore mollit",
      "message": "aliqua",
      "error_id": "non ipsum"
    },
    {
      "field": "quis sit commodo",
      "message": "labore laborum proident",
      "error_id": "culpa"
    }
  ]
}
Query Parameter NameExample
page_size-66098368
page_tokencommodo non incididunt
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": "reprehenderit",
      "message": "ea mollit Ut ut laborum",
      "error_id": "in reprehenderit ut esse officia"
    },
    {
      "field": "deserunt in adipisicing ut sit",
      "message": "ex dolor commodo",
      "error_id": "ea magna"
    },
    {
      "field": "et aliqua labore Duis",
      "message": "cillum anim",
      "error_id": "Lorem in"
    },
    {
      "field": "voluptate",
      "message": "ad",
      "error_id": "elit eiusmod fugiat sunt"
    }
  ]
}
Request Payload
{
  "send_at": "3752-01-28T23:21:52.575Z"
}
Response Payload
{
  "send_at": "3752-01-28T23:21:52.575Z",
  "status": "scheduled"
}
{
  "errors": [
    {
      "field": "culpa dolor",
      "message": "enim aliqua minim Duis amet",
      "error_id": "amet elit enim sed velit"
    },
    {
      "field": "cupidatat fugiat",
      "message": "anim eu",
      "error_id": "sit nulla velit tempor esse"
    },
    {
      "field": "nulla eu ad",
      "message": "do reprehenderit voluptate ullamco officia",
      "error_id": "in"
    }
  ]
}
{
  "errors": [
    {
      "field": "anim ad pariatur elit",
      "message": "fugiat deserunt eu",
      "error_id": "magna occaecat"
    },
    {
      "field": "ex",
      "message": "minim elit qui tempor",
      "error_id": "et voluptate"
    },
    {
      "field": "occaecat esse Duis officia dolore",
      "message": "officia consectetur laborum Duis veniam",
      "error_id": "cillum exercitation tempor"
    },
    {
      "field": "magna proident elit",
      "message": "anim deserunt labore",
      "error_id": "reprehenderit dolor adipisicing officia"
    },
    {
      "field": "ad",
      "message": "ea dolore",
      "error_id": "veniam adipisicing aute sit"
    }
  ]
}
Request Payload
Response Payload
{
  "send_at": "1904-03-13T18:20:07.0Z",
  "status": "triggered"
}
{
  "errors": [
    {
      "field": "dolor irure fugiat",
      "message": "magna ex proident qui do",
      "error_id": "in nostrud voluptate"
    }
  ]
}
{
  "errors": [
    {
      "field": "nostrud",
      "message": "eiusmod exercitation",
      "error_id": "Excepteur proident amet ea quis"
    }
  ]
}
Request Payload
Response Payload
{
  "categories": [
    "equipment",
    "shoes",
    "sports"
  ]
}
{
  "errors": [
    {
      "field": "dolore consectetur Lorem ullamco adipisicing",
      "message": "in et veniam",
      "error_id": "ex in proident"
    },
    {
      "field": "in",
      "message": "Duis officia",
      "error_id": "est ea nisi cupidatat"
    },
    {
      "field": "dolor",
      "message": "irure sed",
      "error_id": "ea minim Lorem et ex"
    },
    {
      "field": "Ut ut pariatur nisi occaecat",
      "message": "consequat Lorem enim",
      "error_id": "eiusmod"
    },
    {
      "field": "aute velit",
      "message": "Excepteur qui",
      "error_id": "ex veniam consequat ut do"
    }
  ]
}

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["non Duis incididunt","exercitation","velit","anim consectetur non dolore","nisi","amet cillum esse","veniam deserunt consectetur","anim esse in","ullamco in","qui nostrud dolor ullamco"]
page_size88
page_tokenelit
Request Payload
Response Payload
{
  "results": [
    {
      "id": "56e4d428-784f-0446-8b11-b32e1d35efe4",
      "aggregation": "culpa mollit eu fugiat ipsum",
      "step_id": "consectetur",
      "stats": {
        "bounce_drops": 16759279,
        "bounces": 7441312,
        "clicks": 71986884,
        "delivered": -64415468,
        "invalid_emails": 26901944,
        "opens": -40327150,
        "requests": -9929213,
        "spam_report_drops": 75684759,
        "spam_reports": 99165832,
        "unique_clicks": 19789542,
        "unique_opens": 73881238,
        "unsubscribes": 66935291
      }
    },
    {
      "id": "14450432-05fb-0e71-fb19-58ff243b43a3",
      "aggregation": "minim in",
      "step_id": "reprehenderit aliqua ad",
      "stats": {
        "bounce_drops": -85548818,
        "bounces": -61434924,
        "clicks": 62594008,
        "delivered": 95818427,
        "invalid_emails": 49785437,
        "opens": 82986729,
        "requests": -91637031,
        "spam_report_drops": 63706236,
        "spam_reports": -42385636,
        "unique_clicks": -67064031,
        "unique_opens": 57873694,
        "unsubscribes": -60070829
      }
    },
    {
      "id": "494b4f9f-47e4-351e-eef8-bda25510cf0f",
      "aggregation": "voluptate nostrud reprehenderit",
      "step_id": "non labore aliquip minim",
      "stats": {
        "bounce_drops": -92768166,
        "bounces": -81386911,
        "clicks": 39482181,
        "delivered": -95589075,
        "invalid_emails": -52875697,
        "opens": 44953049,
        "requests": 39604216,
        "spam_report_drops": -70915361,
        "spam_reports": 94928919,
        "unique_clicks": 71486116,
        "unique_opens": 34179152,
        "unsubscribes": 65149895
      }
    },
    {
      "id": "fbc73e55-3834-3c64-0623-82cf481b3f6a",
      "aggregation": "labore in",
      "step_id": "nisi minim do sit enim",
      "stats": {
        "bounce_drops": 23749485,
        "bounces": 63199509,
        "clicks": -41136646,
        "delivered": 66824491,
        "invalid_emails": -8486678,
        "opens": -73280203,
        "requests": -96892206,
        "spam_report_drops": 36543144,
        "spam_reports": 78084310,
        "unique_clicks": 38025713,
        "unique_opens": -99911897,
        "unsubscribes": -63649044
      }
    },
    {
      "id": "0a108673-1aca-b7cb-ac8b-4659fc7a9d79",
      "aggregation": "magna ex cillum consequat dolore",
      "step_id": "occaecat enim",
      "stats": {
        "bounce_drops": -7164023,
        "bounces": -15292403,
        "clicks": 42712466,
        "delivered": -3226146,
        "invalid_emails": -63907507,
        "opens": 80886095,
        "requests": -77765111,
        "spam_report_drops": -76450804,
        "spam_reports": -35403483,
        "unique_clicks": 83186571,
        "unique_opens": -89757259,
        "unsubscribes": 56081155
      }
    }
  ],
  "_metadata": {
    "prev": "https://BOvgvshopwCHYDfLrZmaLB.tktFmlY62DFdDxPKPbQ7R3k7lVlrIetxqvqw.MDCK8P6",
    "self": "https://QFPdKeYsesDKsY.vsrbChoH3UZRxozXutJs9VK5ldxvA89+.XJ8dk9nYRAx+JOGRwur",
    "next": "http://sKYpd.cjzn5yIw7pgWVa2bvX0WkoLJoMAwL.EE5uox",
    "count": 31558637.205563754
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
group_by["step_id","step_id"]
step_ids["cd39af99-1931-a34a-bf03-6bf8f302cfc8","ad5c869b-5a2f-5f9e-2a54-17adb9b1dad0","fdd6d155-d23d-044d-6d68-939e801ddba9"]
aggregated_bytotal
start_date1944-03-04
end_date1932-09-24
timezonenulla reprehenderit consequat deserunt
page_size55
page_tokenminim esse adipisicing reprehenderit qui
Request Payload
Response Payload
{
  "results": [
    {
      "id": "8df012e2-2d77-eced-62ce-91189d80832a",
      "aggregation": "irure",
      "step_id": "irure mollit in in elit",
      "stats": {
        "bounce_drops": 23026881,
        "bounces": -58466733,
        "clicks": 94029053,
        "delivered": 46924053,
        "invalid_emails": -51225246,
        "opens": 40791517,
        "requests": 3644182,
        "spam_report_drops": 19044844,
        "spam_reports": 50130102,
        "unique_clicks": -19776577,
        "unique_opens": 68038618,
        "unsubscribes": -39822674
      }
    },
    {
      "id": "dee61ad8-92e7-f2f1-6df4-03be8cd4d934",
      "aggregation": "minim",
      "step_id": "Ut incididunt Duis minim",
      "stats": {
        "bounce_drops": -26985892,
        "bounces": 75863076,
        "clicks": 69717751,
        "delivered": 74353264,
        "invalid_emails": -90170073,
        "opens": 76040154,
        "requests": 90255383,
        "spam_report_drops": -30609744,
        "spam_reports": 61518560,
        "unique_clicks": -95734130,
        "unique_opens": -44864570,
        "unsubscribes": 48039198
      }
    },
    {
      "id": "352e01a3-e753-c4c7-6ec9-bdf6f8014640",
      "aggregation": "sunt nulla irure anim non",
      "step_id": "nulla commodo",
      "stats": {
        "bounce_drops": -31024057,
        "bounces": 17125685,
        "clicks": -34605655,
        "delivered": 77140693,
        "invalid_emails": -6994205,
        "opens": -10759761,
        "requests": -14660849,
        "spam_report_drops": -43369095,
        "spam_reports": 45609990,
        "unique_clicks": 85025910,
        "unique_opens": -69845142,
        "unsubscribes": -56570554
      }
    }
  ],
  "_metadata": {
    "prev": "http://bdxhvSCiXyFVszxJOjHW.eqtB.Csp.fbH437GyUynYIYzQIC3RfPCftL37nq,dfaINMM2E,9Hkf4tpfjx5Kiv.s5nTW5qcGE1bz",
    "self": "http://AGXXkrVgE.vbNBHKNxzEuyoZICsUQKZAKotozfXKGDj",
    "next": "http://LRiTLwaagw.joNHqtgbY5nej4MorWdpMbLF6sm2aFe4wdg8OEcru",
    "count": 13891536.257623956
  }
}
{
  "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["commodo in nisi et adipisicing","commodo nulla sint","enim ea ut nulla","elit labore nostrud irure sit","voluptate laborum pariatur","dolor incididunt quis veniam in","est Lorem velit","commodo aliquip","exercitation nostrud ea officia","elit"]
page_size42
page_tokennisi anim sint
Request Payload
Response Payload
{
  "results": [
    {
      "id": "7e5bb5f1-e619-eda3-870e-794c08189acc",
      "ab_variation": "aaf21db1-5759-a2d2-670c-c10c3bc47f51",
      "ab_phase": "all",
      "aggregation": "adipisicing in culpa sint",
      "stats": {
        "bounce_drops": 77819279,
        "bounces": -20420177,
        "clicks": -65650352,
        "delivered": -54398168,
        "invalid_emails": -99790047,
        "opens": 24642602,
        "requests": -79794109,
        "spam_report_drops": 76844082,
        "spam_reports": -65620665,
        "unique_clicks": -78659777,
        "unique_opens": 8706404,
        "unsubscribes": 14356147
      }
    }
  ],
  "_metadata": {
    "prev": "http://Cp.iovdrsEC7d125Ym64xYRc",
    "self": "http://XVawqJRHlBLymadECYsdfQE.jjiNZ6HE,x",
    "next": "http://nzoHZnMcUKrUNSLNO.ckR.rNnwY2a7tOQ6TKN",
    "count": 9959219.912897944
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
aggregated_byday
start_date1949-03-30
end_date1936-01-10
timezoneoccaecat commodo sit
page_size92
page_tokenenim et
group_by["ab_phase","ab_variation","ab_phase","ab_phase","ab_phase"]
Request Payload
Response Payload
{
  "results": [
    {
      "id": "779b2b9e-d0c0-cfdc-cc15-56e9c7f2ea4c",
      "ab_variation": "bc0c6b21-60bd-29ab-aac7-7657f72e09be",
      "ab_phase": "all",
      "aggregation": "anim aliquip labore occaecat",
      "stats": {
        "bounce_drops": 19094038,
        "bounces": 17948967,
        "clicks": -13536778,
        "delivered": -87911202,
        "invalid_emails": -65806072,
        "opens": 61698983,
        "requests": -64819461,
        "spam_report_drops": -57280640,
        "spam_reports": 68011113,
        "unique_clicks": -28388888,
        "unique_opens": 34307983,
        "unsubscribes": -33439632
      }
    },
    {
      "id": "50916d8a-ab0d-e494-bf25-bdb97957dde2",
      "ab_variation": "d64e5157-6055-f0ae-299f-9cfdef2c2175",
      "ab_phase": "all",
      "aggregation": "ullamco magna anim voluptate non",
      "stats": {
        "bounce_drops": 2976186,
        "bounces": -93041096,
        "clicks": -86476407,
        "delivered": -1491728,
        "invalid_emails": 55492012,
        "opens": 17826538,
        "requests": 69129671,
        "spam_report_drops": 18520399,
        "spam_reports": -3698368,
        "unique_clicks": -66654974,
        "unique_opens": 97766201,
        "unsubscribes": 75601226
      }
    }
  ],
  "_metadata": {
    "prev": "https://cCxwbvhopaH.bqaskQ5ThbQ2BJy20V+iB45n",
    "self": "https://KJwIgrBqaJJiSyETNMWfRm.jgLCUHCMrNDEmE5lZV1V8n12UYv+Ekg5pY5q6rpMs-4RVbtjtEs6J1",
    "next": "https://NWNIpUmFCNfQcDNvKj.kmdWIUIom6kA,A3rVGTfMEysW1kUNBY5VnVfBLJ8fgby",
    "count": 73973006.9405947
  }
}
{
  "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_ids["9c703afb-036d-38bc-da46-726a20e8425f"]
page_size91
page_tokenlabore ex amet dolore
Request Payload
Response Payload
{
  "results": [
    {
      "url": "http://rUbOSUDuqJCbMcrQZAwIOUcoPOR.deAcVCTSBPth",
      "url_location": 67491110,
      "step_id": "3d0e5249-8c96-612f-869b-9a4143dc126f",
      "clicks": 30709933
    },
    {
      "url": "https://gJgGRdLtEPD.wmIT0IJeKQKHnIxv31ZZyA,pOofwjCKFJ05RZ4rVoXD0yFEsUImtGGsr",
      "url_location": 23808498,
      "step_id": "d76d1d09-9df6-29e8-c331-f111aba17d20",
      "clicks": 91327641
    },
    {
      "url": "http://bgxoAlAeeNBldWEdxnrKjp.grjjvauUX,5O2L9LGMs1jgW0xKeh.dpBS+tFy9PP4,c5mFFHJ0L5",
      "url_location": 64002033,
      "step_id": "3df1106c-36f5-aae0-1a5a-54281e47019c",
      "clicks": 45782389
    },
    {
      "url": "https://unDT.fdldRDhyZ,9mj8PqqbQaO9XYRghDN55lC2vY6rJg+gIbsy+zcE6Uss9jvkXuMtq.mC",
      "url_location": 8327022,
      "step_id": "db880a3a-6949-61bd-4be3-ccf33b50ca58",
      "clicks": 65195256
    },
    {
      "url": "http://KjHQk.izlVneGxrHJVCIVNtrY8AaeKNsawWslYw82f50n",
      "url_location": 83819358,
      "step_id": "10efc6ab-f6cf-1906-16ea-153229f836ad",
      "clicks": 81067309
    }
  ],
  "total_clicks": 25191396,
  "_metadata": {
    "prev": "https://zQJPEyuCElFoXCxyTmBbIhJ.xlXAg96gheqN7A1NUsScyivCN",
    "self": "https://rrjMIEsSKOykHykLLkwAmAhVcOnUL.yqpgc7.NM1zauvbFUsPxeylO-6Tv.gem31b9YUKdd",
    "next": "https://bQOVfTqjYIGwRALQYbkBDSlgpSvpxqhv.zgl99hC",
    "count": 78148321.74547249
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
page_size88
page_tokenaliqua ut magna proident quis
group_by["ab_variation","ab_phase","ab_phase","ab_variation"]
ab_variation_id82c51d55-0a50-e8e4-f3ed-9961e96e473d
ab_phase_idsend
Request Payload
Response Payload
{
  "results": [
    {
      "url": "https://JoUFyZdCqHyctQFdUFuA.ghwOryrmF89,OkTUNfIZb2Gp,",
      "url_location": 76891528,
      "ab_variation": "6d47663b-06e3-1530-ef00-f2a9f2864fd3",
      "ab_phase": "all",
      "clicks": 76935092
    },
    {
      "url": "https://kJsqDBKLyGsqsxGeabcWftXiUNqcvPQL.epcTZBIy4664QoqllUSAnc-ZAaS4TqOm",
      "url_location": 59295727,
      "ab_variation": "3eb64a61-62f6-1d36-60f6-281587063353",
      "ab_phase": "send",
      "clicks": 4509490
    },
    {
      "url": "https://m.txbts1LqgYO5q.jU-KgOq",
      "url_location": 38360842,
      "ab_variation": "519a2530-8393-7ae7-70e3-b910c69c82a6",
      "ab_phase": "all",
      "clicks": 42413019
    }
  ],
  "_metadata": {
    "prev": "http://QiV.mhyaRxRLR3zVc.VV9XfikHPE9kDdMYckaLPMHwRYjesedbiWCs5q7nA8cYeEasN7DSIob9",
    "self": "http://TtiiaUqNDeoEfmIXOmoCZrGJ.qpkaRYTkOaDLc+kPn36AyJGFLouszaqvsJ.OqenzbvPo6FGTNEMAf.-AcEdbR888Wd",
    "next": "http://PzN.tcpjI2Ez3sNBAI0wIoIPvaDhyXWKvjX14gooBE1XL9oEHdfzli",
    "count": 79454472.32512426
  },
  "total_clicks": -73655328
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
Query Parameter NameExample
ids["commodo do","esse","nostrud qui fugiat","tempor incididunt laboris ut sunt","sunt velit pariatur nulla irure","cupidatat amet","eiusmod nostrud officia","aliqua et","exercitation deserunt sint","amet dolore esse sint"]
timezonealiqua proident
Request Payload
Response Payload
occaecat
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
ids["in sunt dolor Lorem cupidatat","mollit dolore laboris esse ut","do esse","quis","laboris Lorem deserunt ad consequat","qui dolor ut Ut","labore nostrud magna","anim Lorem mollit qui","occaecat aliquip","ex dolore consequat"]
timezonecupidatat pariatur in est
Request Payload
Response Payload
commodo tempor in
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Sender Identities API(6 operations)

Header NameExample
on-behalf-of"ad"
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"esse laborum aliqua nisi in"
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"id sed nisi esse sint"
Request Payload
Response Payload
{
  "id": 1,
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States",
  "verified": true,
  "updated_at": 1449872165,
  "created_at": 1449872165,
  "locked": false
}
{
  "errors": [
    {
      "message": "resource not found",
      "field": "id"
    }
  ]
}
Header NameExample
on-behalf-of"irure dolor magna adipisicing enim"
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"dolore"
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"est Ut nisi exercitation occaecat"
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"voluptate sunt cupidatat"
Request Payload
{
  "name": "your list name"
}
Response Payload
{
  "id": 1,
  "name": "your list name",
  "recipient_count": 0
}
{
  "errors": [
    {
      "field": null,
      "message": "Returned if request body is invalid JSON"
    },
    {
      "field": "name",
      "message": "Returned if list name is not a string"
    },
    {
      "field": "name",
      "message": "Returned if list name is a duplicate of an existing list or segment"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"in Lorem Excepteur"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1,
      "name": "the jones",
      "recipient_count": 1
    }
  ]
}
Header NameExample
on-behalf-of"tempor minim"
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_id18218322
Header NameExample
on-behalf-of"aliquip commodo dolor"
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*-82666740
Header NameExample
on-behalf-of"ex cupidatat 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_contactsfalse
Header NameExample
on-behalf-of"et laboris"
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-4648428
page_size40429074
list_id*-70828798
Header NameExample
on-behalf-of"in"
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"laborum est"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "list_id",
      "message": "list_id is invalid"
    },
    {
      "field": "recipient_id",
      "message": "no valid recipients were provided"
    },
    {
      "field": null,
      "message": "no recipients were added"
    },
    {
      "field": null,
      "message": "request body is invalid JSON"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "list_id does not exist"
    },
    {
      "field": "recipient_id",
      "message": "recipient_id does not exist"
    }
  ]
}
Header NameExample
on-behalf-of"esse"
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*-37015100
recipient_id*-68080321
Header NameExample
on-behalf-of"mollit irure sit cillum"
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"pariatur deserunt"
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"amet exercitation in fugiat"
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"et anim proident non enim"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
{}
{
  "errors": [
    {
      "message": "No recipient ids provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
page23556456
page_size-21166442
Header NameExample
on-behalf-of"nisi commodo do ex elit"
Request Payload
Response Payload
{
  "recipients": []
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"est"
Request Payload
Response Payload
{
  "status": [
    {
      "id": "worker_delay",
      "value": "delayed"
    },
    {
      "id": "worker_delay_seconds",
      "value": "75.0"
    }
  ]
}
Header NameExample
on-behalf-of"commodo"
Request Payload
Response Payload
{
  "recipients": [
    {
      "id": "culpa in",
      "created_at": 97651753.47226256,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "vCWvM7d@knTPPeiYyuPcxyktRae.kb",
      "first_name": "nostrud ut fugiat consectetur laborum",
      "last_name": null,
      "last_clicked": null,
      "last_emailed": 71621069.00136948,
      "last_opened": null,
      "updated_at": 3271168.882655978
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"commodo dolore"
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"aliquip"
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"sint amet"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"veniam voluptate ut enim in"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
{field_name}dolore commodo
Header NameExample
on-behalf-of"veniam ut aliqua quis"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 1422313607,
      "email": "jones@example.com",
      "first_name": null,
      "id": "YUBh",
      "last_clicked": null,
      "last_emailed": null,
      "last_name": "Jones",
      "last_opened": null,
      "updated_at": 1422313790,
      "custom_fields": [
        {
          "id": 23,
          "name": "pet",
          "value": "Fluffy",
          "type": "text"
        }
      ]
    }
  ]
}
{
  "errors": [
    {
      "message": "The following parameters are not custom fields or reserved fields: [{field_name}]"
    },
    {
      "message": "No search params are specified"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Request Payload
{
  "list_id": -27497588,
  "conditions": [
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    },
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    },
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    },
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    }
  ]
}
Response Payload
{
  "recipients": [
    {
      "created_at": -27901208,
      "email": "ut magna quis ipsum",
      "id": "fugiat ad adipisicing ullamco",
      "last_emailed": 21626657
    },
    {
      "created_at": 17466400,
      "email": "sunt irure",
      "id": "et",
      "last_clicked": -23135244,
      "last_opened": -44593357,
      "first_name": "est"
    },
    {
      "created_at": -34495329,
      "email": "reprehenderit incididunt velit Lorem esse",
      "id": "esse Ut ad dolore",
      "last_clicked": 10164083,
      "last_opened": 34443062
    },
    {
      "created_at": -37030673,
      "email": "amet deserunt fugiat voluptate",
      "id": "et exercitation commodo id laborum",
      "last_clicked": -10497425
    },
    {
      "created_at": 3658435,
      "email": "labore veniam",
      "id": "ad pariatur esse",
      "last_opened": -84227501,
      "custom_fields": [
        {
          "id": -5765608,
          "name": "proident pariatur",
          "value": "do in magna mollit",
          "type": "dolore ut"
        },
        {
          "id": -31131201,
          "name": "laborum mollit",
          "value": 84434696,
          "type": "veniam"
        }
      ],
      "updated_at": -56455352,
      "first_name": "Ut cupidatat nulla deserunt adipisicing",
      "last_clicked": -52862671
    }
  ],
  "recipient_count": 65190677
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

Contacts API - Custom Fields(5 operations)

Header NameExample
on-behalf-of"pariatur eiusmod voluptate"
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"
Request Payload
Response Payload
{
  "custom_fields": [
    {
      "id": 6234,
      "name": "age",
      "type": "number"
    },
    {
      "id": 6233,
      "name": "country",
      "type": "text"
    },
    {
      "id": 6235,
      "name": "favorite_color",
      "type": "text"
    },
    {
      "id": 6239,
      "name": "fname",
      "type": "text"
    },
    {
      "id": 6240,
      "name": "lname",
      "type": "text"
    },
    {
      "id": 49439,
      "name": "pet",
      "type": "text"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"minim labore Excepteur"
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"est sint occaecat et id"
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"aute"
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"enim do"
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"amet irure pariatur Excepteur aute"
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*78921858
Header NameExample
on-behalf-of"dolore mollit Duis occaecat"
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_idin sit sunt voluptate commodo
Header NameExample
on-behalf-of"Excepteur fugiat ut aute"
Request Payload
{
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ]
}
Response Payload
{
  "id": 5,
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ],
  "recipient_count": 1
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "segment_id": "segment_id",
      "message": "segment id is not valid"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
delete_contactstrue
Header NameExample
on-behalf-of"eu"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "segment_id",
      "message": "Returned if segment_id is not valid"
    },
    {
      "field": "delete_contacts",
      "message": "Returned if delete_contacts is not a valid boolean"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "segment_id",
      "message": "segment_id does not exist"
    }
  ]
}
Query Parameter NameExample
page-86495394
page_size10772792
Header NameExample
on-behalf-of"dolor mollit"
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-41695142
categoryipsum officia laborum labore
offset45680580
Header NameExample
on-behalf-of"Excepteur sed in"
Request Payload
Response Payload
[
  {
    "category": "category 1"
  },
  {
    "category": "category 2"
  }
]
{
  "errors": [
    {
      "field": "sort_by",
      "message": "invalid sort value"
    }
  ]
}
Query Parameter NameExample
sort_by_metricfugiat eu laboris enim non
sort_by_directiondesc
start_date*eiusmod Lorem sed in
end_dateaute non tempor magna ullamco
limit-50138045
offset25619409
aggregated_byweek
Header NameExample
on-behalf-of"in irure"
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*ad
end_dateconsequat nulla quis
categories*sint irure qui ipsum officia
limit-81994442
offset82343022
aggregated_bymonth
Header NameExample
on-behalf-of"id velit deserunt dolor"
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"quis ut Ut"
Request Payload
{
  "title": "March Newsletter",
  "subject": "New Products for Spring!",
  "sender_id": 124451,
  "list_ids": [
    110,
    124
  ],
  "segment_ids": [
    110
  ],
  "categories": [
    "spring line"
  ],
  "suppression_group_id": 42,
  "custom_unsubscribe_url": "",
  "ip_pool": "marketing",
  "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
  "plain_content": "Check out our spring line!"
}
Response Payload
{
  "id": 986724,
  "title": "March Newsletter",
  "subject": "New Products for Spring!",
  "sender_id": 124451,
  "list_ids": [
    110,
    124
  ],
  "segment_ids": [
    110
  ],
  "categories": [
    "spring line"
  ],
  "suppression_group_id": 42,
  "custom_unsubscribe_url": "",
  "ip_pool": "marketing",
  "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
  "plain_content": "Check out our spring line!",
  "status": "Draft"
}
{
  "errors": [
    {
      "field": "title",
      "message": "title can't be blank"
    },
    {
      "field": "title",
      "message": "title is too long (maximum is 100 characters)"
    },
    {
      "field": "categories",
      "message": "categories exceeds 10 category limit"
    },
    {
      "field": "html_content",
      "message": "html_content exceeds the 1MB limit"
    },
    {
      "field": "plain_content",
      "message": "plain_content exceeds the 1MB limit"
    },
    {
      "field": "sender_id",
      "message": "sender_id does not exist"
    },
    {
      "field": "sender_id",
      "message": "sender_id is not a verified sender identity"
    },
    {
      "field": "list_ids",
      "message": "list_ids do not all exist"
    },
    {
      "field": "segment_ids",
      "message": "segment_ids do not all exist"
    },
    {
      "field": "ip_pool",
      "message": "The ip pool you provided is invalid"
    },
    {
      "field": "suppression_group_id",
      "message": "suppression_group_id does not exist"
    },
    {
      "field": "unsubscribes",
      "message": "Either suppression_group_id or custom_unsubscribe_url may be set/used, but not both. Please remove one before setting the other."
    },
    {
      "field": null,
      "message": "The JSON you have submitted cannot be parsed."
    },
    {
      "field": null,
      "message": "You've reached your limit of 250 campaigns. Please delete one or more and try again."
    }
  ]
}
{}
Query Parameter NameExample
limit-82985896
offset-87860674
Header NameExample
on-behalf-of"officia labore nulla eiusmod"
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"laboris"
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"non ut commodo"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"in sit Ut"
Request Payload
{
  "title": "May Newsletter",
  "subject": "New Products for Summer!",
  "categories": [
    "summer line"
  ],
  "html_content": "<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>",
  "plain_content": "Check out our summer line!"
}
Response Payload
{
  "id": 986724,
  "title": "May Newsletter",
  "subject": "New Products for Summer!",
  "sender_id": 124451,
  "list_ids": [
    110,
    124
  ],
  "segment_ids": [
    110
  ],
  "categories": [
    "summer line"
  ],
  "suppression_group_id": 42,
  "custom_unsubscribe_url": "",
  "ip_pool": "marketing",
  "html_content": "<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>",
  "plain_content": "Check out our summer line!",
  "status": "Draft"
}
{
  "errors": [
    {
      "field": "title",
      "message": "title can't be blank"
    },
    {
      "field": "title",
      "message": "title is too long (maximum is 100 characters)"
    },
    {
      "field": "categories",
      "message": "categories exceeds 10 category limit"
    },
    {
      "field": "html_content",
      "message": "html_content exceeds the 1MB limit"
    },
    {
      "field": "plain_content",
      "message": "plain_content exceeds the 1MB limit"
    },
    {
      "field": "sender_id",
      "message": "sender_id does not exist"
    },
    {
      "field": "sender_id",
      "message": "sender_id is not a verified sender identity"
    },
    {
      "field": "list_ids",
      "message": "list_ids do not all exist"
    },
    {
      "field": "segment_ids",
      "message": "segment_ids do not all exist"
    },
    {
      "field": "ip_pool",
      "message": "The ip pool you provided is invalid"
    },
    {
      "field": "suppression_group_id",
      "message": "suppression_group_id does not exist"
    },
    {
      "field": "unsubscribes",
      "message": "Either suppression_group_id or custom_unsubscribe_url may be set/used, but not both. Please remove one before setting the other."
    },
    {
      "field": null,
      "message": "The JSON you have submitted cannot be parsed."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "You may only update a campaign when it is in draft mode."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"in deserunt"
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"aute qui aliqua"
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"proident irure"
Request Payload
{
  "send_at": 1489451436
}
Response Payload
{
  "id": -91722075,
  "send_at": 95250872,
  "status": "nostrud anim ea ex do"
}
{
  "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"qui aliquip eu magna"
Request Payload
Response Payload
{
  "send_at": 1490778528
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"mollit incididunt"
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"enim Excepteur incididunt fugiat dolor"
Request Payload
{
  "to": "your.email@example.com"
}
Response Payload
{
  "to": "do ea nisi"
}
{
  "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"amet reprehenderit consequat consectetur"
Request Payload
{
  "name": "example_name",
  "generation": "dynamic"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "example_name",
  "generation": "legacy",
  "versions": []
}
Query Parameter NameExample
generationslegacy
page_size*36.63810345824359
page_tokenid culpa pariatur
Header NameExample
on-behalf-of"in anim sunt dolor"
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": [
    {
      "": "velit sunt",
      "message": "in cupidatat nisi sint",
      "error_id": "dolor"
    },
    {
      "": "in",
      "message": "proident Ut",
      "error_id": "irure occaecat reprehenderit sit proident"
    }
  ]
}
Header NameExample
on-behalf-of"Excepteur adipisicing anim cupidatat laborum"
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"anim laboris ex tempor"
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"magna nisi adipisicing aliqua incididunt"
Request Payload
{
  "name": "new_example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "new_example_name",
  "versions": []
}
Header NameExample
on-behalf-of"in"
Request Payload
Response Payload
{}

Transactional Templates Versions(5 operations)

Header NameExample
on-behalf-of"cupidatat Duis dolor tempor ea"
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"Excepteur deserunt"
Request Payload
Response Payload
{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
  "active": 1,
  "name": "example_version_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "generate_plain_content": true,
  "subject": "<%subject%>",
  "updated_at": "2019-03-13 18:56:33",
  "editor": "code"
}
Header NameExample
on-behalf-of"consequat sit"
Request Payload
Response Payload
{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
  "active": 1,
  "name": "example_version_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "generate_plain_content": true,
  "subject": "<%subject%>",
  "updated_at": "2019-03-13 18:56:33",
  "editor": "code"
}
Header NameExample
on-behalf-of"sit"
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"
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"cupidatat"
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"ullamco fugiat culpa Duis"
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"tempor Excepteur anim voluptate"
Request Payload
Response Payload
{
  "result": [
    {
      "url": "http://mydomain.com/parse",
      "hostname": "mail.mydomain.com",
      "spam_check": true,
      "send_raw": true
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "aliquip"
    },
    {
      "message": "Duis sed deserunt in"
    },
    {
      "message": "dolor non"
    }
  ]
}
Query Parameter NameExample
limitex voluptate eiusmod
offsetnisi
aggregated_bymonth
start_date*proident aliquip commodo irure
end_dateincididunt aliquip
Header NameExample
on-behalf-of"nulla est enim non ullamco"
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"labore Excepteur sint"
Request Payload
Response Payload
{
  "public_key": "anim quis in sint"
}
Header NameExample
on-behalf-of"magna nulla culpa sed"
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"velit in"
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"voluptate nisi irure"
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": "veniam sit sed quis"
    },
    {
      "message": "do quis elit eu"
    },
    {
      "message": "velit"
    },
    {
      "message": "incididunt"
    },
    {
      "message": "dolore occaecat"
    }
  ]
}
Header NameExample
on-behalf-of"ad elit"
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": "amet"
    },
    {
      "message": "adipisicing ex sint minim id"
    },
    {
      "message": "occaecat nulla eu velit"
    },
    {
      "message": "veniam dolore quis"
    },
    {
      "message": "non"
    }
  ]
}
Header NameExample
on-behalf-of"ex nulla consequat"
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": "aute tempor labore esse irure"
    },
    {
      "message": "esse ad deserunt sint velit"
    },
    {
      "message": "ut"
    },
    {
      "message": "dolor occaecat"
    }
  ]
}
Header NameExample
on-behalf-of"ex aliqua eu aute sunt"
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": "ut irure sunt"
    },
    {
      "message": "voluptate fugiat qui in nostrud"
    },
    {
      "message": "ad sed est deserunt"
    },
    {
      "message": "occaecat velit do ipsum"
    }
  ]
}

Query(2 operations)

Query Parameter NameExample
query*consectetur aute exercitation reprehenderit ut
limit510.15958487418044
Header NameExample
X-Query-Id"esse mollit ut"
X-Cursor"commodo aute"
Authorization*"nostrud"
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*"occaecat"
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
queryut
Header NameExample
Authorization*"Duis"
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*"nulla dolore non reprehenderit"
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"mollit"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "open",
      "title": "Open Tracking",
      "description": "lorem ipsum... .",
      "enabled": true
    }
  ]
}
Header NameExample
on-behalf-of"velit ut sit laboris Ut"
Request Payload
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"ad sit aliquip laborum"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"eiusmod proident"
Request Payload
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"ut proident anim quis"
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"est"
Request Payload
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"amet exercitation enim occaecat reprehenderit"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"in Lorem proident pariatur cupidatat"
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"pariatur non ad laborum consectetur"
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
limit54052011
offset-49696036
aggregated_bymonth
start_date*magna mollit Ut dolore laboris
end_dateanim ut consectetur voluptate aliqua
Header NameExample
on-behalf-of"cupidatat occaecat incididunt"
Request Payload
Response Payload
[
  {
    "date": "2015-11-03",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
countryCA
limit45348994
offset24104977
aggregated_bymonth
start_date*Duis in sint ullamco
end_datesit proident non voluptate
Header NameExample
on-behalf-of"magna amet cupidatat laboris eu"
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-21174707
offset95193010
aggregated_byweek
start_date*dolore voluptate
end_dateut et
Header NameExample
on-behalf-of"veniam aliquip"
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*officia irure eu cillum
end_dateLorem laborum
aggregated_byweek
Header NameExample
on-behalf-of"magna adipisicing"
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*pariatur aliquip cillum dolor consequat
end_dateex ut deserunt pariatur labore
aggregated_byday
Header NameExample
on-behalf-of"aliquip ut aliqua sed id"
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_providerslaborum sint esse in
limit26604902
offset94251895
aggregated_byweek
start_date*aliqua commodo est
end_dateanim in
Header NameExample
on-behalf-of"aliqua veniam dolore tempor ea"
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
browsersnulla cillum sit aute
limit-95304892
offset48893553
aggregated_bymonth
start_date*ut qui nisi est labore
end_dateesse nulla Duis sunt id
Header NameExample
on-behalf-of"commodo"
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_time81969780
end_time-77266381
Header NameExample
Accept*"ad non"
on-behalf-of"anim labore ut"
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"incididunt"
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"aliquip"
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*ZV3d3KDN@wbvxBKmMYSBKSXHJLmyFU.it
Header NameExample
on-behalf-of"ea elit enim"
Request Payload
Error generating example
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Blocks API(4 operations)

Query Parameter NameExample
start_time40316848
end_time-2479079
limit-84980372
offset-55780546
Header NameExample
on-behalf-of"irure elit"
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"occaecat enim"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"consequat ex ad"
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"non sed"
Request Payload
Response Payload
{}

Spam Reports API(4 operations)

Query Parameter NameExample
start_time-43728522
end_time-24582075
limit23673766
offset-21839366
Header NameExample
on-behalf-of"dolor sed elit nostrud"
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"Lorem ut tempor laborum"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"Duis ipsum eiusmod magna"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "ip": "10.89.32.5"
  }
]
Header NameExample
on-behalf-of"do in"
Request Payload
Response Payload
{}

Suppressions - Global Suppressions(4 operations)

Header NameExample
on-behalf-of"eiusmod"
Request Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Response Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Query Parameter NameExample
start_time63277610
end_time38493626
limit23615861
offset45087733
Header NameExample
on-behalf-of"dolor pariatur labore velit"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com"
  }
]
Header NameExample
on-behalf-of"dolore nostrud proident Duis"
Request Payload
Response Payload
{
  "recipient_email": "test@example.com"
}
Header NameExample
on-behalf-of"velit quis"
Request Payload
Response Payload
{}

Suppressions - Unsubscribe Groups(5 operations)

Header NameExample
on-behalf-of"tempor anim velit"
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
id77170331
Header NameExample
on-behalf-of"pariatur"
Request Payload
Response Payload
[
  {
    "id": 1234,
    "name": "Unsubscribe Group",
    "description": "An Unsubscribe Group",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 1234
  },
  {
    "id": 1234,
    "name": "Unsubscribe Group",
    "description": "An Unsubscribe Group",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 1234
  }
]
Header NameExample
on-behalf-of"ea laborum amet nostrud"
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"est ut aliqua"
Request Payload
{
  "id": 103,
  "name": "Item Suggestions",
  "description": "Suggestions for items our users might like."
}
Response Payload
{
  "id": 103,
  "name": "Item Suggestions",
  "description": "Suggestions for items our users might like."
}
Header NameExample
on-behalf-of"ipsum in incididunt"
Request Payload
Response Payload
{}

Suppressions - Suppressions(6 operations)

Header NameExample
on-behalf-of"consectetur qui esse"
Request Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Response Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Header NameExample
on-behalf-of"mollit Duis tempor Lorem"
Request Payload
Response Payload
[
  "example@example.com",
  "example2@example.com"
]
Header NameExample
on-behalf-of"sed"
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"dolor est et ad"
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"dolor pariatur"
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"elit aliquip dolor"
Request Payload
Response Payload
Error generating example

Invalid Emails API(4 operations)

Query Parameter NameExample
start_time-88300877
end_time6428771
limit44297797
offset-10709995
Header NameExample
on-behalf-of"ut anim eiusmod"
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"esse ullamco aliquip nulla"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"est velit"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]
Header NameExample
on-behalf-of"aliquip sit proident"
Request Payload
Response Payload
{}
Service Homepage: sendgrid.com/en-us
API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started
emails