View All Services

Sendgrid V3 Mock Server

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

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

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

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

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



Mail Send

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

Cancel Scheduled Sends(7 operations)

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

API Keys(6 operations)

Header NameExample
on-behalf-of"dolore"
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": "est quis exercitation"
    },
    {
      "message": "aliquip non anim"
    }
  ]
}
Query Parameter NameExample
limit-9507066
Header NameExample
on-behalf-of"fugiat cillum commodo voluptate ea"
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": "est consectetur"
    }
  ]
}
Header NameExample
on-behalf-of"sed aliqua adipisicing reprehenderit nulla"
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"
    },
    {
      "message": "sunt Duis"
    }
  ]
}
Header NameExample
on-behalf-of"proident incididunt in reprehenderit"
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": "voluptate aliquip consequat occaecat pariatur"
    }
  ]
}
Header NameExample
on-behalf-of"nisi"
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": "dolore dolore amet sed reprehenderit"
    },
    {
      "message": "Ut Duis"
    },
    {
      "message": "consectetur do"
    },
    {
      "message": "officia commodo in consequat quis"
    }
  ]
}
Header NameExample
on-behalf-of"fugiat"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "non cupidatat nostrud enim in"
    },
    {
      "message": "consectetur dolore qui sunt"
    }
  ]
}

API Key Permissions

Header NameExample
on-behalf-of"et"
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": "enim do"
    },
    {
      "message": "occaecat Lorem aliqua Excepteur dolor"
    },
    {
      "message": "consectetur"
    },
    {
      "message": "pariatur"
    }
  ]
}

Settings - Enforced TLS(2 operations)

Header NameExample
on-behalf-of"labore reprehenderit nulla cupidatat commodo"
Request Payload
Response Payload
{
  "require_tls": false,
  "require_valid_cert": false
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "elit cillum irure cupidatat aliquip"
    },
    {
      "message": "consectetur officia nostrud"
    },
    {
      "message": "fugiat eu aliqua"
    }
  ]
}
Header NameExample
on-behalf-of"enim in"
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": "fugiat"
    },
    {
      "message": "laboris nostrud"
    },
    {
      "message": "in aute mollit"
    },
    {
      "message": "magna deserunt cupidatat aliquip"
    },
    {
      "message": "ex est consectetur proident"
    }
  ]
}

IP Access Management(6 operations)

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

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

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

Settings - Mail(13 operations)

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

Settings - Partner(3 operations)

Header NameExample
on-behalf-of"labore dolor minim"
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"est irure ea"
Request Payload
Response Payload
{
  "enable_subuser_statistics": false,
  "enabled": true,
  "license_key": ""
}
Query Parameter NameExample
limit82493179
offset-13111406
Header NameExample
on-behalf-of"consectetur"
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"eu tempor eiusmod"
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": "quis et Duis ipsum dolor",
      "field": "velit"
    }
  ]
}
Query Parameter NameExample
limit486
offset75222728
Header NameExample
on-behalf-of"irure exercitation"
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"sed dolor Excepteur culpa"
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
limit31766821
offset-99287673
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"deserunt qui ullamco in ipsum"
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"eiusmod veniam cupidatat elit reprehenderit"
Request Payload
Response Payload
{
  "username": "teammate1",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update",
    "..."
  ],
  "user_type": "admin",
  "is_admin": true,
  "phone": "123-345-3453",
  "website": "www.example.com",
  "company": "ACME Inc.",
  "address": "123 Acme St",
  "address2": "",
  "city": "City",
  "state": "CA",
  "country": "USA",
  "zip": "12345"
}
Header NameExample
on-behalf-of"ea ex Ut"
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"tempor esse"
Request Payload
Response Payload
{
  "errors": [
    {
      "message": "esse adipisicing dolor",
      "field": "ex dolore laborum Duis"
    }
  ]
}
{
  "errors": [
    {
      "message": "username not found",
      "field": "username"
    }
  ]
}
Request Payload
Response Payload
{
  "scope_group_name": "Stats"
}
{}
{
  "errors": [
    {
      "message": "laborum sed minim",
      "field": "culpa dolore incididunt"
    },
    {
      "message": "pariatur anim",
      "field": "aliqua"
    },
    {
      "message": "Ut eiusmod aute sint",
      "field": "incididunt"
    },
    {
      "message": "dolor labore ullamco aute sed",
      "field": "nulla enim veniam dolore"
    },
    {
      "message": "qui",
      "field": "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"esse sit aliqua mollit"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "magna enim reprehenderit laboris ex",
      "field": "exercitation consequat proident ullamco do"
    },
    {
      "message": "elit Ut aliquip velit",
      "field": "deserunt in adipisicing"
    },
    {
      "message": "dolore",
      "field": "culpa"
    },
    {
      "message": "adipisicing aliquip dolor",
      "field": "ipsum"
    },
    {
      "message": "Excepteur et do",
      "field": "ex"
    }
  ]
}

Alerts(5 operations)

Header NameExample
Authorization"exercitation id in reprehenderit"
on-behalf-of"Excepteur quis velit voluptate"
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": "reprehenderit",
  "message": "culpa labore et elit"
}
Header NameExample
Authorization"Lorem consectetur"
on-behalf-of"fugiat dolor cupidatat ullamco"
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"quis ut"
on-behalf-of"ipsum id"
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"laborum"
Request Payload
Response Payload
{}
Header NameExample
on-behalf-of"ea ut sit ullamco"
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"deserunt ullamco"
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"commodo irure dolor dolore ex"
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"enim eiusmod"
Request Payload
Response Payload
{
  "reputation": 100,
  "type": "paid"
}
Header NameExample
on-behalf-of"labore ut"
Request Payload
Response Payload
{
  "email": "test@example.com"
}
Header NameExample
on-behalf-of"velit aliqua magna"
Request Payload
{
  "email": "example@example.com"
}
Response Payload
{
  "email": "example@example.com"
}
Header NameExample
on-behalf-of"velit incididunt in"
Request Payload
Response Payload
{
  "username": "test_username",
  "user_id": 1
}
Header NameExample
on-behalf-of"amet"
Request Payload
{
  "username": "test_username"
}
Response Payload
{
  "username": "test_username"
}
Header NameExample
on-behalf-of"veniam nisi eiusmod id"
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"exercitation"
Request Payload
{
  "new_password": "new_password",
  "old_password": "old_password"
}
Response Payload
{}

Subusers API(6 operations)

Query Parameter NameExample
usernamequis et velit dolor
limit72181366
offset33474709
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
usernamesvoluptate enim qui
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*adipisicing minim incididunt
sort_by_metricdolore
sort_by_directionasc
limit78668026
offset-81365965
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 pariatur eu
subuserin enim
sort_by_metricclicks
sort_by_directionasc
limit17620024
offset29233874
Request Payload
Response Payload
{
  "date": "2016-02-01",
  "stats": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 0,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 1,
        "processed": 0,
        "requests": 100,
        "spam_report_drops": 0,
        "spam_reports": 99,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user1",
      "type": "subuser"
    },
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 10,
        "processed": 10,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user2",
      "type": "subuser"
    }
  ]
}
Query Parameter NameExample
sort_by_directionasc
start_date*mollit aliqua non anim velit
end_datedolore velit veniam sint
limit-77629789
offset-44040720
aggregated_byDuis qui quis
sort_by_metricExcepteur in minim
Request Payload
Response Payload
{
  "date": "2015-10-11",
  "stats": []
}
Query Parameter NameExample
limit80800188
offset-61488748
aggregated_byweek
subusers*do Lorem
start_date*aliquip Lorem deserunt amet minim
end_dateveniam laborum aute sunt ut
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"do Ut"
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
limit55592315
offset17312517
ipnostrud nulla sit
Header NameExample
on-behalf-of"sed velit"
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"cupidatat"
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"fugiat non voluptate sed"
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"est adipisicing dolor"
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": "eu id ullamco",
    "field": "reprehenderit sint eu magna ad"
  }
}

IP Pools(7 operations)

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

IP Addresses(5 operations)

Request Payload
{
  "count": 90323478,
  "subusers": [
    "subuser1",
    "subuser2"
  ],
  "warmup": true,
  "user_can_send": true
}
Response Payload
{
  "ips": [
    {
      "ip": "1.2.3.4",
      "subusers": [
        "user",
        "subuser1"
      ]
    },
    {
      "ip": "1.2.3.5",
      "subusers": [
        "user",
        "subuser1"
      ]
    }
  ],
  "remaining_ips": 1,
  "warmup": true
}
{
  "errors": [
    {
      "field": null,
      "message": "one or more subusers do not belong to this user"
    }
  ]
}
Query Parameter NameExample
ipadipisicing culpa qui
exclude_whitelabelsfalse
limit-12419172
offset20127525
subuserquis dolor ex exercitation
sort_by_directiondesc
Request Payload
Response Payload
[
  {
    "ip": "192.168.1.1",
    "pools": [
      "pool1",
      "pool2"
    ],
    "whitelabeled": false,
    "start_date": 1409616000,
    "subusers": [
      "tim@sendgrid.net"
    ],
    "warmup": false,
    "assigned_at": 1482883200
  },
  {
    "ip": "208.115.214.22",
    "pools": [],
    "whitelabeled": true,
    "rdns": "o1.email.burgermail.com",
    "start_date": 1409616000,
    "subusers": [],
    "warmup": false,
    "assigned_at": 1482883200
  }
]
Request Payload
Response Payload
{
  "results": [
    {
      "remaining": 2,
      "period": "month",
      "price_per_ip": 20
    }
  ]
}
Request Payload
Response Payload
[
  {
    "ip": "167.89.21.3",
    "pools": [
      "new_test5"
    ],
    "warmup": true,
    "start_date": 1409616000
  }
]
Request Payload
Response Payload
{
  "ip": "000.00.00.0",
  "subusers": [
    "subuser1",
    "subuser2"
  ],
  "rdns": "o1.em.example.com",
  "pools": [
    "test1"
  ],
  "warmup": false,
  "start_date": null,
  "whitelabeled": true
}

Domain Authentication(12 operations)

Query Parameter NameExample
limit-80134230
offset-7059118
exclude_subusersfalse
usernameamet
domainexercitation pariatur enim culpa amet
Header NameExample
on-behalf-of"ullamco"
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"voluptate nisi in deserunt proident"
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 ipsum voluptate"
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"nulla 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"id veniam"
Request Payload
Response Payload
{}
Query Parameter NameExample
domainvelit irure laborum et
Header NameExample
on-behalf-of"enim"
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"aliquip sed"
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"occaecat tempor et"
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"exercitation"
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*occaecat laboris
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
usernamefugiat veniam
Request Payload
Response Payload
{}
Request Payload
{
  "username": "jdoe"
}
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "mail@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}

Sender Verification(8 operations)

Request Payload
Response Payload
{
  "results": {
    "soft_failures": [
      "gmail.com"
    ],
    "hard_failures": [
      "yahoo.com"
    ]
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "do nulla"
    },
    {
      "message": "eiusmod sit in cupidatat ut"
    },
    {
      "message": "do aliqua Excepteur et sit"
    }
  ]
}
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": "aute aliqua"
    },
    {
      "message": "id Excepteur elit"
    },
    {
      "message": "officia eiusmod dolor"
    }
  ]
}
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": "laborum",
      "message": "cupidatat non ullamco ut",
      "error_id": "minim"
    },
    {
      "field": "minim occaecat",
      "message": "esse anim ut culpa velit",
      "error_id": "sed laboris"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "eiusmod aute"
    },
    {
      "message": "pariatur ad"
    },
    {
      "message": "sint esse anim"
    },
    {
      "message": "non"
    }
  ]
}
Query Parameter NameExample
limit-84667904.74525574
lastSeenID-99573454.28318782
id-11523023
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": "laborum"
    },
    {
      "message": "sunt eu pariatur"
    },
    {
      "message": "culpa sed aute dolore Lorem"
    },
    {
      "message": "et quis veniam aliquip"
    }
  ]
}
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": "officia ut ut Lorem",
      "error_id": "irure consequat"
    },
    {
      "message": "ipsum",
      "error_id": "nostrud eu amet laborum dolore"
    },
    {
      "message": "in irure",
      "error_id": "voluptate"
    },
    {
      "message": "cillum voluptate amet reprehenderit",
      "error_id": "labore consectetur pariatur"
    },
    {
      "message": "dolore irure",
      "error_id": "magna"
    }
  ]
}
{
  "errors": [
    {
      "message": "nostrud"
    }
  ]
}
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": "consequat adipisicing",
      "message": "magna elit commodo enim Lorem",
      "error_id": "Duis enim velit"
    },
    {
      "field": "culpa in",
      "message": "exercitation sunt pariatur",
      "error_id": "minim quis"
    },
    {
      "field": "consectetur Lorem culpa",
      "message": "commodo est",
      "error_id": "in cillum ad"
    },
    {
      "field": "in ut aute dolore",
      "message": "esse aute commodo laborum laboris",
      "error_id": "ipsum ullamco laboris"
    },
    {
      "field": "incididunt sit aute",
      "message": "ut ad eiusmod",
      "error_id": "nisi veniam in"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "laborum occaecat in magna",
      "error_id": "et"
    },
    {
      "message": "pariatur sit consequat",
      "error_id": "est irure ex anim sit"
    },
    {
      "message": "mollit sit magna dolore nulla",
      "error_id": "ut deserunt incididunt"
    },
    {
      "message": "dolor esse Lorem",
      "error_id": "elit Ut eu"
    }
  ]
}
{
  "errors": [
    {
      "message": "ipsum reprehenderit",
      "error_id": "elit"
    },
    {
      "message": "Duis",
      "error_id": "Duis"
    },
    {
      "message": "exercitation quis ut",
      "error_id": "aliqua mollit"
    },
    {
      "message": "quis officia",
      "error_id": "id aliquip in cillum nisi"
    }
  ]
}
{
  "errors": [
    {
      "message": "Excepteur eiusmod"
    },
    {
      "message": "elit ea sint mollit Ut"
    },
    {
      "message": "ex"
    },
    {
      "message": "occaecat"
    },
    {
      "message": "reprehenderit minim id labore"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ex",
      "error_id": "esse sit officia"
    }
  ]
}
{
  "errors": [
    {
      "message": "enim",
      "error_id": "culpa"
    },
    {
      "message": "culpa aliqua aliquip eiusmod",
      "error_id": "adipisicing commodo fugiat ad ex"
    },
    {
      "message": "dolor veniam",
      "error_id": "ullamco non aute dolore in"
    }
  ]
}
{
  "errors": [
    {
      "message": "cupidatat nisi aliqua do"
    },
    {
      "message": "aliquip"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "message": "voluptate",
      "error_id": "occaecat ut"
    },
    {
      "message": "Excepteur",
      "error_id": "cillum nostrud veniam sint reprehenderit"
    },
    {
      "message": "fugiat qui",
      "error_id": "nulla culpa"
    },
    {
      "message": "amet ex fugiat",
      "error_id": "enim eu culpa"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "in sint elit adipisicing",
      "error_id": "Excepteur mollit nisi"
    },
    {
      "message": "enim amet qui",
      "error_id": "in non"
    },
    {
      "message": "Duis",
      "error_id": "deserunt dolor labore sit"
    },
    {
      "message": "eiusmod",
      "error_id": "in"
    },
    {
      "message": "eiusmod dolor",
      "error_id": "ut anim do"
    }
  ]
}
{
  "errors": [
    {
      "message": "nulla quis do"
    }
  ]
}

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": "adipisicing ut",
  "field": "proident ut in aliqua",
  "error_id": "adipisicing"
}
{
  "errors": [
    {
      "message": "ex tempor nulla deserunt",
      "field": "sunt",
      "error_id": "incididunt nostrud"
    }
  ]
}
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": "ea Ut laborum Duis consequat",
      "field": "amet",
      "error_id": "voluptate dolor nostrud pariatur elit"
    },
    {
      "message": "officia",
      "field": "quis fugiat eu",
      "error_id": "velit eiusmod"
    },
    {
      "message": "proident",
      "field": "elit magna reprehenderit in ex",
      "error_id": "amet"
    }
  ]
}
{
  "errors": [
    {
      "message": "aliquip adipisicing minim dolore consectetur",
      "field": "eu officia",
      "error_id": "Excepteur dolore commodo Duis"
    },
    {
      "message": "culpa in",
      "field": "incididunt veniam velit",
      "error_id": "officia dolore occaecat"
    }
  ]
}
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": "consequat veniam sunt sint aliqua",
      "field": "aute aliqua labore et",
      "error_id": "fugiat dolor do ullamco"
    },
    {
      "message": "enim non",
      "field": "ipsum exercitation",
      "error_id": "deserunt"
    },
    {
      "message": "sunt irure",
      "field": "labore exercitation ex adipisicing in",
      "error_id": "laborum reprehenderit"
    },
    {
      "message": "magna",
      "field": "amet deserunt culpa aute dolore",
      "error_id": "est"
    }
  ]
}
{
  "errors": [
    {
      "message": "dolore pariatur",
      "field": "ad aliquip dolor labore",
      "error_id": "laboris"
    },
    {
      "message": "ut",
      "field": "in dolor occaecat eu labore",
      "error_id": "amet velit irure Excepteur"
    },
    {
      "message": "Excepteur nostrud occaecat aliquip fugiat",
      "field": "officia",
      "error_id": "veniam adipisicing dolor"
    },
    {
      "message": "proident voluptate irure consequat tempor",
      "field": "anim ipsum amet mollit",
      "error_id": "aliqua eiusmod Lorem ullamco"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "message": "ut dolor ipsum adipisicing laboris",
      "field": "in elit commodo in",
      "error_id": "ea esse Excepteur dolor"
    },
    {
      "message": "dolore nulla eu",
      "field": "officia sit sint enim cupidatat",
      "error_id": "et mollit dolor do enim"
    },
    {
      "message": "Lorem ut ad",
      "field": "ad dolore cupidatat minim culpa",
      "error_id": "laborum"
    }
  ]
}
{
  "errors": [
    {
      "message": "est cupidatat proident Ut",
      "field": "mollit aliqua incididunt qui",
      "error_id": "exercitation officia anim"
    }
  ]
}
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": "voluptate veniam Duis eiusmod nostrud",
      "field": "occaecat fugiat labore sed anim",
      "error_id": "proident"
    }
  ]
}
Query Parameter NameExample
page_size17970352
page_tokenest
summaryfalse
Request Payload
Response Payload
{
  "result": [
    {
      "id": "3247eaea-c912-42a3-b0bc-60bdaf210396",
      "name": "Welcome Email",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/llny8o5b3m636z92p7hbjnmq1jvpka39p370jwtin2s1wxv7x1sgm0y5fk518d0s.png",
      "subject": "Welcom to the Cake or Pie Cafe",
      "created_at": "2021-04-09T17:29:46Z",
      "updated_at": "2021-04-09T17:29:55Z",
      "editor": "code",
      "categories": [
        "welcome",
        "new customer"
      ]
    },
    {
      "id": "02dfd792-f31f-439a-a79e-5c47fbcfdbac",
      "name": "Monthly Promo",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/hfyxahd7ues2ajuoeoqq2xe6ibdasl1q89ox0y9ncya2ftpoicssmtf9ddus4c39.png",
      "subject": "Free Dozen Cupcakes",
      "created_at": "2021-04-09T17:29:21Z",
      "updated_at": "2021-04-09T17:29:42Z",
      "editor": "design",
      "categories": [
        "promo",
        "coupon"
      ]
    },
    {
      "id": "e54be823-19ef-4c6f-8b60-efd7514f492d",
      "name": "Duplicate: Ingrid & Anders",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/12kni9gjpyb9uxmwr9vk7unycjr70u95zoyhe9sg2zounul2zg7dih1s20k13q2z.png",
      "subject": "Welcome to Ingrid & Anders!",
      "created_at": "2020-10-09T17:33:46Z",
      "updated_at": "2021-04-07T19:57:52Z",
      "editor": "design",
      "categories": []
    }
  ],
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/designs?page_token=vHdvHCg0w1F-TmWJcPNpTEnFY2aPEmRBHONwOgZ6TgJbX2_I",
    "count": 3
  }
}
Request Payload
{
  "name": "Ahoy, Cake or Pie Cafe!",
  "editor": "design"
}
Response Payload
{
  "id": "abe0877f-a224-21e2-b62e-c789d326cda5",
  "name": "Ahoy, Pre-built Design!",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: courier, monospace;\n      font-size: 16px;\n    }\n    body {\n      color: #FFFFFF;\n    }\n    body a {\n      color: #fe5d61;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start-->\n\n     <!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#fe5d61\" data-body-style=\"font-size:16px; font-family:courier, monospace; color:#FFFFFF; background-color:#f2f4fb;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#f2f4fb\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#f2f4fb\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#FFFFFF; text-align:left;\" bgcolor=\"#f2f4fb\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p>You've found the secret!</p>\n      </td>\n    </tr>\n  </table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"98ndJyAY9BSGjoVqrr6FYx\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:30px 0px 30px 0px;\" valign=\"top\" align=\"left\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:40% !important; width:40%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/9d9c1f3d8009c42bbe60c0355f1ed23e86c3f5619173e83a9328b9214e42e1c1d5e009ed5cc4c8f3efedfc33d46bba2f4577b143607025a29add6e89ab4662ad.png\" alt=\"Off Grid Adventures\" width=\"240\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"3Ypdby9Xfsf2rN27zTDEfN\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/e324b295c47223f1a936198fbd4e5d4b239ff86c6d6c89d4d0eb8d7c61028921abfc4901ba607f6dcb7acc7067bb0c6df4313726b14b8274e0b2c98cdf8b58d2.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"7pyDCmyDaGcm5WsBBSaEgv\" data-mc-module-version=\"2019-10-22\">\n      <tbody><tr>\n        <td style=\"background-color:#FE5D61; padding:50px 0px 30px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#FE5D61\"><div><div style=\"font-family: inherit; text-align: center\"><span style=\"font-size: 24px\">Welcome to the family!</span></div><div></div></div></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"nSVYnVzPLnGZ4wUdynLiKo\" data-mc-module-version=\"2019-10-22\">\n      <tbody><tr>\n        <td style=\"background-color:#fe5d61; padding:30px 50px 30px 50px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#fe5d61\"><div><div style=\"font-family: inherit; text-align: center\">You've found a community of travelers that are just like you.</div>\n<div style=\"font-family: inherit; text-align: center\">&nbsp;</div>\n<div style=\"font-family: inherit; text-align: center\">We don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.</div>\n<div style=\"font-family: inherit; text-align: center\">&nbsp;</div>\n<div style=\"font-family: inherit; text-align: center\">Ready for your next authentic travel experience?</div><div></div></div></td>\n      </tr>\n    </tbody></table><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"module\" data-role=\"module-button\" data-type=\"button\" role=\"module\" style=\"table-layout:fixed\" width=\"100%\" data-muid=\"4ywPd9vJ6WFyV1Si75h9vh\"><tbody><tr><td align=\"center\" bgcolor=\"#fe5d61\" class=\"outer-td\" style=\"padding:10px 10px 60px 10px; background-color:#fe5d61;\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"button-css__deep-table___2OZyb wrapper-mobile\" style=\"text-align:center\"><tbody><tr><td align=\"center\" bgcolor=\"#ffffff\" class=\"inner-td\" style=\"border-radius:6px; font-size:16px; text-align:center; background-color:inherit;\"><a style=\"background-color:#ffffff; border:1px solid #ffffff; border-color:#ffffff; border-radius:3px; border-width:1px; color:#fe5d61; display:inline-block; font-size:16px; font-weight:700; letter-spacing:1px; line-height:40px; padding:12px 20px 12px 20px; text-align:center; text-decoration:none; border-style:solid;\" href=\"\" target=\"_blank\">Browse Gallery</a></td></tr></tbody></table></td></tr></tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"6jxKSRk9dKQ1Tvi1wtnu8q\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/0accac77b1e34c614730ab732317a493478835c96bd549fb2df7a921ec1177fdb30d6d33e1d0a33d8c6c579344890ae408ce13aaed0e478f1fd6d2219d308365.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"iYySZ4rAB78PLoW7vU13Bb\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"divider\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"mVyZz43HETwfwb72TGh4iy\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 0px 0px;\" role=\"module-content\" height=\"100%\" valign=\"top\" bgcolor=\"\">\n          <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" align=\"center\" width=\"100%\" height=\"3px\" style=\"line-height:3px; font-size:3px;\">\n            <tbody><tr>\n              <td style=\"padding:0px 0px 3px 0px;\" bgcolor=\"#ffffff\"></td>\n            </tr>\n          </tbody></table>\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"sfek66tVLi5d2iy5jmSawj\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"social\" align=\"center\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"87277ffe-54ed-4792-94f3-0a973b71c268\">\n    <tbody>\n      <tr>\n        <td valign=\"top\" style=\"padding:0px 0px 0px 0px; font-size:6px; line-height:10px;\" align=\"center\">\n          <table align=\"center\" style=\"-webkit-margin-start:auto;-webkit-margin-end:auto;\">\n            <tbody><tr align=\"center\"><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.facebook.com/sendgrid/\" target=\"_blank\" alt=\"Facebook\" title=\"Facebook\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Facebook\" title=\"Facebook\" src=\"https://mc.sendgrid.com/assets/social/white/facebook.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor\" target=\"_blank\" alt=\"Twitter\" title=\"Twitter\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Twitter\" title=\"Twitter\" src=\"https://mc.sendgrid.com/assets/social/white/twitter.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.instagram.com/sendgrid/?hl=en\" target=\"_blank\" alt=\"Instagram\" title=\"Instagram\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Instagram\" title=\"Instagram\" src=\"https://mc.sendgrid.com/assets/social/white/instagram.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.pinterest.com/sendgrid/\" target=\"_blank\" alt=\"Pinterest\" title=\"Pinterest\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Pinterest\" title=\"Pinterest\" src=\"https://mc.sendgrid.com/assets/social/white/pinterest.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td></tr></tbody>\n          </table>\n        </td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module unsubscribe-css__unsubscribe___2CDlR\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#FFFFFF; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:center;\" data-muid=\"txBUUpmixSjuZ5Ad69p1sX\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "plain_content": "You've found the secret!\n\nWelcome to the family!\n\nYou've found a community of travelers that are just like you.\n\nWe don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.\n\nReady for your next authentic travel experience?\n\nBrowse Gallery\n\n( https://www.facebook.com/sendgrid/ ) ( https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor ) ( https://www.instagram.com/sendgrid/?hl=en ) ( https://www.pinterest.com/sendgrid/ )\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
  "generate_plain_content": true,
  "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/a85b4b202ff28094828f11ff472360caecf67ead2d186b69b45c904b9251aa0b.png",
  "subject": "Welcome to the family!",
  "created_at": "2021-04-30T19:15:28Z",
  "updated_at": "2021-04-30T19:15:28Z",
  "editor": "design",
  "categories": []
}
{
  "errors": [
    {
      "message": "eu",
      "field": "officia",
      "error_id": "cupidatat incididunt sed sint magna"
    },
    {
      "message": "dolor tempor in",
      "field": "qui sunt pariatur",
      "error_id": "eu eiusmod dolor in nisi"
    },
    {
      "message": "in qui anim deserunt",
      "field": "Excepteur magna",
      "error_id": "amet"
    },
    {
      "message": "adipisicing veniam commodo sed",
      "field": "Lorem",
      "error_id": "cupidatat aliquip sint Ut fugiat"
    },
    {
      "message": "nostrud tempor",
      "field": "tempor ullamco elit",
      "error_id": "commodo officia in id dolor"
    }
  ]
}
{
  "errors": [
    {
      "message": "consequat aliqua in tempor est",
      "field": "dolor ea",
      "error_id": "proident velit in officia"
    },
    {
      "message": "consequat",
      "field": "minim adipisicing ad ea",
      "error_id": "do"
    },
    {
      "message": "sint sit do nisi",
      "field": "dolor eu occaecat Lorem",
      "error_id": "Duis reprehenderit"
    },
    {
      "message": "amet Excepteur",
      "field": "dolore aliqua qui",
      "error_id": "amet esse"
    }
  ]
}
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": "consectetur",
      "field": "Lorem pariatur et elit",
      "error_id": "dolore"
    },
    {
      "message": "ut aliqua",
      "field": "irure anim reprehenderit",
      "error_id": "sint minim ut Ut exercitation"
    }
  ]
}
{
  "errors": [
    {
      "message": "ipsum",
      "field": "laboris",
      "error_id": "nisi tempor magna qui"
    },
    {
      "message": "non consectetur",
      "field": "mollit qui officia Duis",
      "error_id": "in Duis qui"
    }
  ]
}
Query Parameter NameExample
page_size38401397
page_tokenvelit sint fugiat
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": [
    "11249eef-68ab-bfc7-9f41-1b75f317e059",
    "dd664bd0-4123-a1ec-8a95-80ff02365a0a",
    "9e459856-5939-6763-0129-36316951fbc7"
  ],
  "contacts": [
    {
      "address_line_1": "tempor",
      "address_line_2": "nisi volupt",
      "alternate_emails": [
        "dolore est sint officia proident",
        "dolor el",
        "do qui elit consequat id",
        "veniam qui minim dolore dolor",
        "enim consequat"
      ],
      "city": "consectetur",
      "country": "voluptate iru",
      "email": "incididunt in dolore aute",
      "first_name": "eu",
      "last_name": "do",
      "postal_code": "sunt in qui deserunt",
      "state_province_region": "Duis in ut non",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "nisi Ut laboris aliqua enim",
      "address_line_2": "ea",
      "alternate_emails": [
        "occaecat",
        "cupidatat",
        "nisi",
        "tempor",
        "adipisicing est in mollit"
      ],
      "city": "nost",
      "country": "pariatur voluptate velit",
      "email": "non in",
      "first_name": "culpa mollit Ut",
      "last_name": "l",
      "postal_code": "culpa",
      "state_province_region": "et",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "sunt dolor",
      "address_line_2": "fugiat tempor",
      "alternate_emails": [
        "elit commodo",
        "sed dolor Lorem commodo minim",
        "commodo irure mollit",
        "dolore elit",
        "officia sunt Lorem"
      ],
      "city": "Lorem nul",
      "country": "adipisicing id sit",
      "email": "magna ad",
      "first_name": "Ut Excepteur cu",
      "last_name": "Excepteur culpa ullamco proide",
      "postal_code": "proident sunt eiusmod dolor",
      "state_province_region": "tempor id nisi",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "anim Ut",
      "address_line_2": "ipsum enim amet Lorem",
      "alternate_emails": [
        "irure nostrud nulla in",
        "est cupidatat",
        "nostrud proident adipisicing",
        "eu et Duis id",
        "laboris aliquip dolor"
      ],
      "city": "labore ullamco anim commodo elit",
      "country": "nostrud ut",
      "email": "consectetur in qui voluptate",
      "first_name": "proident enim anim velit",
      "last_name": "sed ",
      "postal_code": "laborum in",
      "state_province_region": "dolor nostrud",
      "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": "tempor eu est qui",
      "address_line_2": "consectetur",
      "alternate_emails": [
        "incididunt ex Ut deserunt nulla",
        "in magna eu amet non",
        "irure eu minim consequat",
        "in",
        "amet elit"
      ],
      "city": "enim non ullamco",
      "country": "et sed",
      "email": "Ut et ipsum",
      "first_name": "Lorem sed consequat dolore",
      "last_name": "aute minim",
      "postal_code": "nulla sit quis consectetur",
      "state_province_region": "minim ut",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "tempor veniam",
      "address_line_2": "irure elit",
      "alternate_emails": [
        "aliqua",
        "commodo fugiat anim officia",
        "adipisicing aliquip pariatur",
        "",
        "et minim qui non"
      ],
      "city": "in ullamco",
      "country": "commodo ullamco",
      "email": "in ea et",
      "first_name": "occaecat nul",
      "last_name": "ipsum m",
      "postal_code": "irure est amet",
      "state_province_region": "irure et eu est",
      "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": "fugiat",
      "address_line_2": "do cillum pariatur dolor",
      "alternate_emails": [
        "esse Excepteur anim consequat Duis",
        "Lorem",
        "veniam pari",
        "sed irure fugiat in aliquip",
        "Duis aute pariatur"
      ],
      "city": "in commodo mo",
      "country": "in Duis",
      "email": "dolore amet consequat consectetur",
      "first_name": "ad est",
      "last_name": "off",
      "postal_code": "sint sed nulla veniam non",
      "state_province_region": "in in laborum cupidatat 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": "",
      "address_line_2": "velit voluptate ",
      "alternate_emails": [
        "anim proident cillum",
        "reprehenderit laboris",
        "in aute cillum culpa et",
        "sint deserunt eiusmod sunt veniam",
        "ad commodo"
      ],
      "city": "pariatur Ut qui",
      "country": "in laborum labore ali",
      "email": "Duis quis ex",
      "first_name": "ullamco deserunt",
      "last_name": "adipisicing",
      "postal_code": "nisi",
      "state_province_region": "magna",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "dolore officia",
      "address_line_2": "laboris voluptate incididunt nostrud",
      "alternate_emails": [
        "id",
        "Excepteur",
        "mollit consequat eu",
        "enim deserunt",
        "irure labor"
      ],
      "city": "id Excepteur cupidatat",
      "country": "velit",
      "email": "voluptate in culpa",
      "first_name": "mi",
      "last_name": "ea commodo",
      "postal_code": "laboris enim voluptate",
      "state_province_region": "sint officia Excepteur nisi labore",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "anim",
      "address_line_2": "non nulla",
      "alternate_emails": [
        "ea dolore Duis",
        "incididunt",
        "dolore velit eu",
        "in",
        "sunt ut dolor Duis adipisicing"
      ],
      "city": "pariatur",
      "country": "fugiat con",
      "email": "dolor consequat in ad",
      "first_name": "oc",
      "last_name": "ea fugiat est",
      "postal_code": "ipsum cupidatat",
      "state_province_region": "Lorem",
      "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": "adipisicing Lorem enim ea deserunt"
}
{
  "errors": [
    {
      "message": "dolor nisi eiusmod enim consectetur",
      "field": "Ut aliqua irure",
      "error_id": "ea",
      "parameter": "Ut est pariatur ea reprehenderit"
    },
    {
      "message": "in dolor cillum veniam",
      "field": "voluptate exercitation occaecat cillum",
      "error_id": "exercitation quis est",
      "parameter": "pariatur ullamco"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "nulla"
    },
    {
      "message": "reprehenderit aliqua enim eiusmod est"
    },
    {
      "message": "fugiat laborum amet elit"
    },
    {
      "message": "fugiat voluptate esse"
    }
  ]
}
Query Parameter NameExample
delete_all_contactsaute mollit ad consequat
idsin aliquip exercitation non Excepteur
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": "aliquip ad"
    },
    {
      "message": "magna"
    }
  ]
}
Request Payload
Response Payload
{
  "result": [
    {
      "id": "Duis",
      "first_name": "ea non ut aliquip",
      "last_name": "ut ea sunt",
      "unique_name": "cupidatat laborum voluptate",
      "email": "sed deserunt Lorem adipisicing",
      "alternate_emails": [
        "incididunt et sunt enim",
        "eu dolor proident id cillum",
        "pariatur aute ut et",
        "reprehenderit esse in eiusmod",
        "consectetur irure ex sed"
      ],
      "address_line_1": "anim",
      "address_line_2": "sint laboris",
      "city": "nostrud fugiat",
      "state_province_region": "aute quis",
      "country": "eiusmod",
      "postal_code": "aute tempor ipsum Excepteur fugiat",
      "phone_number": "cillum dolore anim",
      "whatsapp": "nisi",
      "line": "nostrud laborum non",
      "facebook": "culpa dolore et laborum",
      "list_ids": [
        "aute quis magna",
        "anim esse culpa id ex",
        "aliquip adipisicing id"
      ],
      "segment_ids": [
        "et",
        "in tempor dolor nulla",
        "dolore",
        "incididunt",
        "consectetur sint cillum"
      ],
      "custom_fields": {},
      "created_at": "Duis",
      "updated_at": "ad",
      "_metadata": {
        "self": "qui"
      }
    },
    {
      "id": "aliqua ex adipisicing ut",
      "first_name": "fugiat",
      "last_name": "in ad do velit",
      "unique_name": "minim",
      "email": "Duis nisi in",
      "alternate_emails": [
        "proident ipsum irure",
        "reprehenderit magna sint"
      ],
      "address_line_1": "ut esse pariatur",
      "address_line_2": "tempor sunt ad",
      "city": "velit",
      "state_province_region": "fugiat dolore",
      "country": "deserunt magna",
      "postal_code": "amet in",
      "phone_number": "sit",
      "whatsapp": "velit minim fugiat ex aute",
      "line": "amet quis",
      "facebook": "Ut aute",
      "list_ids": [
        "eiusmod commodo elit Excepteur",
        "in esse culpa",
        "ex"
      ],
      "segment_ids": [
        "pariatur cupidatat proident"
      ],
      "custom_fields": {},
      "created_at": "qui sint minim dolor",
      "updated_at": "ut aute ex eiusmod",
      "_metadata": {
        "self": "nostrud ea"
      }
    }
  ],
  "_metadata": {
    "self": "sed dolore"
  },
  "contact_count": -17393753
}
{
  "errors": [
    {
      "message": "ipsum irure in sit",
      "field": "cupidatat reprehenderit",
      "error_id": "aute",
      "parameter": "velit aute ut"
    },
    {
      "message": "in ad do mollit eu",
      "field": "ea incididunt exercitation",
      "error_id": "adipisicing in",
      "parameter": "Excepteur fugiat est consectetur"
    },
    {
      "message": "ut ut adipisicing",
      "field": "cillum minim aliquip",
      "error_id": "incididunt dolore magna nisi",
      "parameter": "pariatur"
    },
    {
      "message": "pariatur aute nostrud",
      "field": "laborum dolor",
      "error_id": "est nulla",
      "parameter": "nostrud incididunt magna ullamco"
    },
    {
      "message": "dolor minim deserunt",
      "field": "labore incididunt elit Lorem",
      "error_id": "adipisicing eu qui officia cupidatat",
      "parameter": "sint voluptate"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "sint in cupidatat Ut"
    },
    {
      "message": "deserunt nostrud laboris"
    }
  ]
}
Request Payload
Response Payload
{
  "contact_count": 85588665,
  "billable_count": 95978466,
  "billable_breakdown": {
    "total": -86436004,
    "breakdown": {}
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "commodo"
    },
    {
      "message": "sunt ullamco non elit"
    },
    {
      "message": "amet deserunt"
    },
    {
      "message": "tempor commodo"
    },
    {
      "message": "voluptate"
    }
  ]
}
Request Payload
{
  "list_ids": [
    "5ec67a63-5de7-97e3-fcf0-f7d1f1bd3186",
    "c4e43523-025b-24f3-8e0c-c5641a03794b",
    "8bff948f-3d69-7d1a-33c0-d07df20ca4ab",
    "e5f7cce4-68d4-e195-d98f-3a9c8395d8ba"
  ],
  "segment_ids": [
    "voluptate aliquip aute ullamco eiusmod",
    "ipsum ex"
  ],
  "notifications": {
    "email": false
  },
  "file_type": "csv",
  "max_file_size": -71343989
}
Response Payload
{
  "_metadata": {
    "prev": "https://eXlnfYgDN.znnvXdI,ranA",
    "self": "https://fwQJOGsOpZSH.mbzI.,,CzZLGQVcT+lAeezvH4Fxc7SxO1h,fwug9xS,wRq4u0GmvvMYarFvYsuKbex8ZaSFEWwdBiyBu",
    "next": "https://tbpyRbiMMaWZnkwjJ.xhsq,+LAsv.uMj,YtA",
    "count": -30294688.488785446
  },
  "id": "nulla ipsum"
}
{
  "errors": [
    {
      "message": "incididunt",
      "field": "ut fugiat sint",
      "error_id": "sunt consectetur tempor exercitation aliquip",
      "parameter": "proident ullamco aliquip Excepteur consectetur"
    },
    {
      "message": "irure",
      "field": "aliquip Lorem",
      "error_id": "ad Ut voluptate",
      "parameter": "cillum ad proident Excepteur"
    },
    {
      "message": "nisi nostrud",
      "field": "mollit in laborum laboris",
      "error_id": "sit amet",
      "parameter": "Ut"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "anim Ut adipisicing do"
    },
    {
      "message": "cillum consectetur ex ad deserunt"
    },
    {
      "message": "minim anim eiusmod dolor in"
    },
    {
      "message": "nulla pariatur voluptate ea"
    },
    {
      "message": "in aliqua culpa Excepteur"
    }
  ]
}
Request Payload
Response Payload
{
  "result": [
    {
      "id": "aliquip eu enim cillum",
      "status": "ad aliquip quis proident nulla",
      "created_at": "laboris veniam proident velit",
      "completed_at": "irure",
      "expires_at": "veniam esse cillum et incididunt",
      "urls": [
        "velit in sit deserunt",
        "adipisicing Excepteur ipsum ea non",
        "Duis elit fugiat"
      ],
      "user_id": "veniam",
      "export_type": "veniam eiusmod amet",
      "segments": [
        {
          "ID": "dolore est eu laboris velit",
          "Name": "reprehenderit"
        },
        {
          "ID": "sint",
          "Name": "ullamco consectetur cupidatat"
        },
        {
          "ID": "dolore enim ipsum aliqua",
          "Name": "culpa Lorem nisi magna"
        },
        {
          "ID": "voluptate in occaecat sunt laborum",
          "Name": "in ea irure"
        }
      ],
      "lists": [
        {
          "ID": "ex proident voluptate irure",
          "Name": "anim cupidatat"
        }
      ],
      "_metadata": {
        "prev": "id Excepteur dolore",
        "self": "irure nostrud quis aliquip veniam",
        "next": "veniam nulla"
      }
    }
  ],
  "_metadata": {
    "prev": "exercitation officia incididunt sed ex",
    "self": "minim",
    "next": "adipisicing deserunt in irure"
  }
}
{
  "errors": [
    {
      "message": "aliquip Duis et sed",
      "": "ut irure",
      "error_id": "commodo aliquip occaecat nostrud"
    },
    {
      "message": "sint",
      "": "ipsum ut culpa",
      "error_id": "exercitation dolore et quis ex"
    },
    {
      "message": "consequat anim veniam commodo consectetur",
      "": "est sed",
      "error_id": "cupidatat nulla proident"
    },
    {
      "message": "quis",
      "": "eiusmod aute",
      "error_id": "labore"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "aute sed"
    },
    {
      "message": "laboris non est minim ut"
    },
    {
      "message": "voluptate"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "nulla ut",
  "first_name": "reprehenderit",
  "last_name": "ea quis sed elit",
  "unique_name": "consectetur deserunt nostrud pariatur ad",
  "email": "velit",
  "alternate_emails": [
    "labore id in do",
    "ut in adipisicing laborum"
  ],
  "address_line_1": "consequat do nisi",
  "address_line_2": "ex exercitation",
  "city": "occaecat",
  "state_province_region": "irure",
  "country": "dolor Ut fugiat proident tempor",
  "postal_code": "ut Excepteur",
  "phone_number": "in do ad cupidatat in",
  "whatsapp": "ex reprehenderit ullamco et labore",
  "line": "est minim",
  "facebook": "Ut elit",
  "list_ids": [
    "magna ea et laboris dolore",
    "dolor",
    "aliquip",
    "irure sed"
  ],
  "segment_ids": [
    "cillum laborum dolor"
  ],
  "custom_fields": {},
  "created_at": "occaecat sit",
  "updated_at": "dolore pariatur nulla in",
  "_metadata": {
    "self": "do aliquip nostrud fugiat"
  }
}
{
  "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": "magna ex et"
    },
    {
      "message": "cillum irure sit Excepteur culpa"
    }
  ]
}
Request Payload
{
  "query": "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')"
}
Response Payload
{
  "result": [
    {
      "id": "aute nostrud",
      "first_name": "enim dolore proident eiusmod ipsum",
      "last_name": "ad quis deserunt velit dolore",
      "unique_name": "commodo tempor",
      "email": "eu",
      "alternate_emails": [
        "qui consequat voluptate",
        "minim",
        "pariatur do adipisicing",
        "minim mollit adipisicing",
        "ad est sed consequat"
      ],
      "address_line_1": "dolor ullamco non",
      "address_line_2": "aliquip sint esse",
      "city": "proident cillum elit Ut",
      "state_province_region": "reprehenderit sed",
      "country": "cupidatat ipsum quis in dolore",
      "postal_code": "commodo veniam Ut est aute",
      "phone_number": "pariatur cupidatat",
      "whatsapp": "ex exercitation dolor consectetur proident",
      "line": "minim Duis veniam",
      "facebook": "consectetur aliquip sunt reprehenderit",
      "list_ids": [
        "mollit Duis sit sunt nostrud",
        "reprehenderit deserunt"
      ],
      "segment_ids": [
        "aliqua labore sed deserunt",
        "sint dolor Lorem",
        "quis",
        "officia",
        "Ut deserunt nostrud"
      ],
      "custom_fields": {},
      "created_at": "ut aliquip dolore",
      "updated_at": "sint ipsum mollit aliquip consequat",
      "_metadata": {
        "self": "magna qui et"
      }
    }
  ],
  "_metadata": {
    "self": "eu"
  },
  "contact_count": -15893398.36304009
}
{
  "errors": [
    {
      "field": "aute commodo mollit deserunt",
      "message": "reprehenderit adipisicing"
    },
    {
      "field": "quis ut pariatur sit nisi",
      "message": "esse qui ad reprehenderit"
    },
    {
      "field": "quis amet",
      "message": "cupidatat velit est"
    },
    {
      "field": "ullamco nostrud deserunt pariatur mollit",
      "message": "aliquip"
    }
  ]
}
{
  "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": "ut aliqua ex"
    },
    {
      "message": "commodo dolor"
    },
    {
      "message": "mollit laboris voluptate amet"
    },
    {
      "message": "sunt"
    },
    {
      "message": "elit"
    }
  ]
}
Request Payload
{
  "list_ids": [
    "reprehenderit",
    "veniam nulla elit sed consequat",
    "cupidatat ullamco",
    "culpa ullamco dolore",
    "labore exercitation"
  ],
  "file_type": "csv",
  "field_mappings": [
    null,
    "sint et do",
    null
  ]
}
Response Payload
{
  "job_id": "dolore aliquip deserunt",
  "upload_uri": "non officia nisi eiusmod laboris",
  "upload_headers": [
    {
      "header": "laborum dolor",
      "value": "ut"
    },
    {
      "header": "ex irure nostrud",
      "value": "dolore veniam enim ea"
    }
  ]
}
{
  "errors": [
    {
      "message": "Lorem proident quis",
      "field": "qui adipisicing",
      "error_id": "nisi sit",
      "parameter": "elit"
    },
    {
      "message": "Duis ut labore",
      "field": "adipisicing sed et deserunt",
      "error_id": "nulla do velit cupidatat aute",
      "parameter": "in laborum"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "veniam consequat in fugiat esse",
      "field": "aliqua",
      "error_id": "non consectetur sit ex Ut",
      "parameter": "mollit ad"
    },
    {
      "message": "do adipisicing",
      "field": "officia laborum consequat veniam aute",
      "error_id": "consequat ut cillum",
      "parameter": "cillum"
    },
    {
      "message": "sed",
      "field": "dolor consequat Duis irure aute",
      "error_id": "aliquip",
      "parameter": "sunt consectetur irure est"
    }
  ]
}
{
  "errors": [
    {
      "message": "proident dolor non Duis quis"
    },
    {
      "message": "incididunt cupidatat"
    },
    {
      "message": "cillum culpa ullamco"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "deserunt labore non ipsum",
  "status": "dolore",
  "job_type": "consequat aute occaecat",
  "results": {
    "requested_count": 17792693.923572496,
    "created_count": 21507616.03638789,
    "updated_count": 60070127.400859624,
    "deleted_count": -23784298.55082524,
    "errored_count": 62679016.3425166,
    "errors_url": "cupidatat"
  },
  "started_at": "ad ex minim",
  "finished_at": "fugiat consectetur exercitation Duis incididunt"
}
{
  "errors": {
    "message": "in et proident consectetur",
    "field": "qui sed occaecat officia",
    "error_id": "mollit ex ad",
    "parameter": "incididunt elit et anim deserunt"
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "Excepteur magna sint"
    },
    {
      "message": "sint dolor eiusmod"
    },
    {
      "message": "nulla do"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "dolor ex veniam",
  "status": "pending",
  "created_at": "elit",
  "updated_at": "consequat enim cillum",
  "completed_at": "minim",
  "expires_at": "sint",
  "urls": [
    "exercitation reprehenderit nostrud sunt velit",
    "laborum ut in in dolor"
  ],
  "message": "veniam ut aliqua dolor irure",
  "_metadata": {
    "prev": "http://pmxGGaVGJXNf.jkbCeBTFRVTAsNsOV-1JWdwcHkvVvgpnqgvmj93N2rVh2",
    "self": "https://GoviJhzxPMPesYHKhNn.pgfS1t6G67kaHfSG3wc0YKmqAc-VSz-TVFNNP7KSikVtIWD1iTAQ",
    "next": "http://dHZoEleAdvNBGxvbfpYVAVQBboLqy.nejUw8ifdbPlBBAn62pJUFUwuGeGGiF7y-RDeIA5d,,1",
    "count": 66855278.33926609
  },
  "contact_count": -66409955
}
{
  "errors": [
    {
      "message": "et do dolor dolor",
      "field": "nisi officia",
      "error_id": "labore elit sunt mollit",
      "parameter": "id commodo Lorem irure officia"
    },
    {
      "message": "non",
      "field": "ipsum anim",
      "error_id": "est dolor minim amet",
      "parameter": "esse aute irure"
    },
    {
      "message": "labore",
      "field": "aute ea",
      "error_id": "ut",
      "parameter": "enim tempor"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "elit nisi non"
    },
    {
      "message": "occaecat"
    },
    {
      "message": "reprehenderit minim aute non"
    }
  ]
}
Request Payload
{
  "ids": [
    "1234",
    "1235"
  ]
}
Response Payload
{
  "result": [
    {
      "id": "ut fugiat exercitation nisi",
      "first_name": "tempor quis do labore",
      "last_name": "in deserunt",
      "unique_name": "eu aliqua",
      "email": "Lorem quis sunt magna",
      "alternate_emails": [
        "sunt",
        "deserunt consectetur ullamco ex",
        "dolor laboris veniam",
        "aliquip occaecat cillum",
        "ex amet consectetur sunt eiusmod"
      ],
      "address_line_1": "incididunt qui",
      "address_line_2": "in ex non cupidatat",
      "city": "ex nulla dolor in",
      "state_province_region": "sunt nostrud",
      "country": "mollit voluptate laborum fugiat quis",
      "postal_code": "deserunt sit irure nulla dolore",
      "phone_number": "do aute",
      "whatsapp": "nulla",
      "line": "fugiat elit non anim sed",
      "facebook": "deserunt ullamco sit dolor",
      "list_ids": [
        "anim",
        "cillum tempor sint fugiat"
      ],
      "segment_ids": [
        "anim eu commodo Lorem",
        "fugiat laborum aute"
      ],
      "custom_fields": {},
      "created_at": "non amet ut Duis",
      "updated_at": "labore pariatur qui non",
      "_metadata": {
        "self": "ea nostrud veniam enim"
      }
    },
    {
      "id": "cillum",
      "first_name": "elit",
      "last_name": "ut dolore",
      "unique_name": "veniam aliquip labore Excepteur",
      "email": "Lorem sint in nisi reprehenderit",
      "alternate_emails": [
        "est tempor id",
        "dolor quis anim",
        "eu Duis anim sint",
        "in sit fugiat consectetur elit",
        "consequat anim"
      ],
      "address_line_1": "id",
      "address_line_2": "irure aliqua Duis laborum",
      "city": "do Ut reprehenderit anim Lorem",
      "state_province_region": "sed non",
      "country": "enim esse culpa in commodo",
      "postal_code": "dolore pariatur dolore irure",
      "phone_number": "fugiat",
      "whatsapp": "laborum laboris eu",
      "line": "nostrud",
      "facebook": "adipisicing",
      "list_ids": [
        "officia ullamco occaecat",
        "nulla anim occaecat non",
        "incididunt mollit ad sint dolor",
        "est dolor dolore",
        "ut pariatur"
      ],
      "segment_ids": [
        "qui ipsum",
        "nulla officia Duis",
        "anim dolore consequat voluptate nisi",
        "dolore eiusmod aliqua",
        "sit sunt elit"
      ],
      "custom_fields": {},
      "created_at": "eiusmod nulla",
      "updated_at": "laboris",
      "_metadata": {
        "self": "non reprehenderit"
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "mollit est tempor aliqua"
    },
    {
      "message": "exercitation nisi do"
    },
    {
      "message": "minim enim in incididunt"
    }
  ]
}
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": "in velit"
    },
    {
      "message": "fugiat Duis ea id"
    }
  ]
}

Segmenting Contacts V2 - Beta(5 operations)

Request Payload
{
  "name": "ea nulla fug",
  "parent_list_ids": [
    "voluptate sed esse",
    "laboris dolor labore culpa sunt",
    "et",
    "labore id anim non"
  ],
  "query_dsl": "nulla Duis"
}
Response Payload
{
  "id": "6cbb5ef6-66d0-6dc6-fdb8-380cfe72cce4",
  "name": "Lorem officia et nostrud",
  "query_dsl": "nisi in et",
  "contacts_count": 60869374,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "amet proident",
  "updated_at": "do",
  "sample_updated_at": "ipsum sint labore tempor anim",
  "next_sample_update": "irure in in",
  "parent_list_ids": [
    "consequat",
    "velit sunt est pariatur",
    "in anim aliqua cupidatat ut",
    "pariatur in in occaecat"
  ],
  "query_version": "elit eiusmod nisi in esse",
  "status": {
    "query_validation": "esse sint sit culpa ad",
    "error_message": "irure culpa"
  }
}
{
  "errors": [
    {
      "field": "magna reprehenderit minim occaecat",
      "message": "mollit est"
    },
    {
      "field": "qui ut minim dolore id",
      "message": "id"
    }
  ]
}
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": "ut et esse irure ut",
      "message": "in qui anim ad eu"
    },
    {
      "field": "eu ut dolore cillum velit",
      "message": "enim proident ex nostrud"
    },
    {
      "field": "id reprehenderit",
      "message": "sit ex"
    },
    {
      "field": "deserunt",
      "message": "esse veniam cupidatat tempor"
    }
  ]
}
Query Parameter NameExample
parent_list_idsin ut proident
no_parent_list_idfalse
Request Payload
Response Payload
{
  "id": "04f7599a-966b-aa61-2a65-ac6ad0b007c9",
  "name": "velit qui ipsum ut Lorem",
  "contacts_count": 71853085,
  "created_at": "laborum",
  "updated_at": "sint",
  "sample_updated_at": "ut ullamco anim aute",
  "next_sample_update": "deserunt cillum sit",
  "parent_list_ids": [
    "est Ut exercitation aliqua cupidatat",
    "aute occaecat reprehenderit sint",
    "aliqua velit",
    "labore aliqua pariatur"
  ],
  "query_version": "elit",
  "_metadata": {
    "prev": "https://rNdsbnztPXDRhZz.jalz4w3+Cqyf1VAk",
    "self": "http://WCCuNNxbTIFfD.xrSNTOd3WAZ5ldkQvwgSPAX-lNUdmCWb",
    "next": "http://KFoUuNJie.gubGG5ZoEY8l2cvr2kJQxShLsQJvEe.M1HehEKodsR5NS-wAQEC2s",
    "count": 81564774
  },
  "status": {
    "query_validation": "velit sed nostrud anim",
    "error_message": "reprehenderit officia in"
  }
}
{
  "errors": [
    {
      "field": "veniam non in",
      "message": "sed minim nisi"
    },
    {
      "field": "Excepteur in",
      "message": "irure dolor sunt Ut elit"
    },
    {
      "field": "pariatur adipisicing minim",
      "message": "et nostrud in do"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "proident ut",
      "message": "elit"
    },
    {
      "field": "aliquip Ut in sint",
      "message": "reprehenderit"
    }
  ]
}
Request Payload
{
  "name": "elit eu id aute Duis",
  "query_dsl": "non consectetur commodo"
}
Response Payload
{
  "id": "94e51f3e-69a7-84c2-17ba-c7e49306a70d",
  "name": "aliquip sed eiusmod ut",
  "query_dsl": "eiusmod incididunt",
  "contacts_count": -48360799,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "nisi proident in ut reprehenderit",
  "updated_at": "ex eu Ut laborum",
  "sample_updated_at": "ad dolor",
  "next_sample_update": "sunt et irure est esse",
  "parent_list_ids": [
    "cupidatat aliquip sunt amet",
    "laborum voluptate",
    "Duis adipisicing",
    "aute irure",
    "magna aliqua sed in"
  ],
  "query_version": "Duis cupidatat labore",
  "status": {
    "query_validation": "labore",
    "error_message": "Duis culpa adipisicing Ut amet"
  }
}
{
  "errors": [
    {
      "field": "Duis ipsum Lorem magna",
      "message": "ut cupidatat culpa nulla est"
    },
    {
      "field": "exercitation culpa",
      "message": "aliqua ea ullamco esse amet"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "proident anim in Excepteur dolor",
      "message": "elit qui sint adipisicing"
    },
    {
      "field": "aliquip ut quis dolor labore",
      "message": "et Ut Duis"
    },
    {
      "field": "adipisicing in labore ea",
      "message": "id pariatur in irure"
    },
    {
      "field": "enim irure cillum eiusmod qui",
      "message": "consectetur minim anim mollit commodo"
    }
  ]
}
Query Parameter NameExample
contacts_sampletrue
Request Payload
Response Payload
{
  "id": "81a83b79-d2bd-7392-a006-0d3da9aface8",
  "name": "elit in ea",
  "query_dsl": "aute",
  "contacts_count": 84597982,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "ut reprehenderit laborum",
  "updated_at": "cupidatat",
  "sample_updated_at": "sunt",
  "next_sample_update": "incididunt eu in",
  "parent_list_ids": [
    "ut velit nulla",
    "consectetur do Lorem eu",
    "commodo",
    "incididunt enim sit",
    "dolor dolore"
  ],
  "query_version": "consequat cupidatat proident",
  "status": {
    "query_validation": "magna",
    "error_message": "consequat incididunt pariatur sunt et"
  }
}
{
  "errors": [
    {
      "field": "nostrud",
      "message": "do"
    },
    {
      "field": "in voluptate nulla",
      "message": "cupidatat esse in"
    },
    {
      "field": "ad",
      "message": "pariatur"
    },
    {
      "field": "commodo eu",
      "message": "exercitation et reprehenderit sed"
    },
    {
      "field": "aute dolore pariatur",
      "message": "ullamco nisi sit veniam minim"
    }
  ]
}
{
  "errors": [
    {
      "field": "cupidatat Ut anim minim",
      "message": "dolor officia in consequat et"
    },
    {
      "field": "enim do sint pariatur",
      "message": "Lorem dolore"
    },
    {
      "field": "pariatur",
      "message": "est cupidatat veniam"
    },
    {
      "field": "aliquip consectetur in et fugiat",
      "message": "officia cillum aute aliqua"
    },
    {
      "field": "deserunt id ut laboris aute",
      "message": "Lorem proident commodo ex"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "in officia exercitation adipisicing sunt",
      "message": "cillum"
    },
    {
      "field": "ullamco ea dolore in reprehenderit",
      "message": "sunt quis nostrud dolor velit"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "dolor sunt fugiat proident labore",
      "message": "nulla"
    },
    {
      "field": "in aliqua",
      "message": "Duis"
    }
  ]
}

Senders

Header NameExample
on-behalf-of"dolore ut"
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": "proident"
    },
    {
      "message": "ut"
    },
    {
      "message": "dolor qui velit pariatur veniam"
    },
    {
      "message": "ea cupidatat pariatur anim"
    },
    {
      "message": "velit"
    }
  ]
}

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

segmenting contacts(5 operations)

Request Payload
{
  "name": "dolor ut cillum fugiat",
  "parent_list_ids": [
    "Lorem ea",
    "ipsum"
  ],
  "query_dsl": "in ad est laborum eiusmod",
  "parent_list_id": "0396fea4-fa06-bdb2-3696-a1ea06bfaac1"
}
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": "Ut occaecat incididunt"
    },
    {
      "message": "consequat ex"
    },
    {
      "message": "culpa proident"
    },
    {
      "message": "Ut eu do quis"
    },
    {
      "message": "dolore ut quis laboris consectetur"
    }
  ]
}
Query Parameter NameExample
parent_list_idspariatur
no_parent_list_idfalse
Request Payload
Response Payload
{
  "results": [
    {
      "id": "12099613-91e5-4d09-a900-df7626325288",
      "contacts_count": 78434802,
      "created_at": "2921-01-27T19:33:36.479Z",
      "sample_updated_at": "4685-11-26T07:05:04.660Z",
      "updated_at": "2883-07-10T13:13:37.697Z"
    },
    {
      "id": "60c37015-3734-4c8e-b293-68cfa2ae4fa5",
      "contacts_count": 34177253,
      "created_at": "2575-07-26T23:17:20.984Z",
      "sample_updated_at": "3074-09-04T09:49:58.127Z",
      "updated_at": "5116-10-15T07:37:40.838Z",
      "parent_list_id": "fd38af3d-3f69-4947-8dca-5fa967e7be82",
      "name": "amet"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "est nulla"
    },
    {
      "message": "nostrud minim labore laborum magna"
    }
  ]
}
Query Parameter NameExample
query_jsontrue
Request Payload
Response Payload
{
  "id": "3b049926-0a54-4a91-83f0-086ace63c530",
  "contacts_count": -83213117,
  "created_at": "voluptate sunt non fugiat",
  "sample_updated_at": "labore occaecat sunt enim",
  "updated_at": "sunt aliqui",
  "contacts_sample": [
    {
      "contact_id": "e70eac25-1431-4231-bccd-1cfab432301e",
      "primary_email": "KLTF@SurgGzlAxCPOqhOUHYNBLsfpfE.trh",
      "alternate_emails": [
        "dTeJZgU5uN9UYSo@nfIB.ijxg"
      ],
      "first_name": "ullamco esse culpa do",
      "last_name": "officia laboris veniam consequat",
      "address_line_1": "in occaecat labore est tempor",
      "address_line_2": "magna adipisicing",
      "city": "ƞó",
      "state_province_region": "culpa ut",
      "postal_code": -75218567,
      "country": "voluptate in in reprehenderit aliquip",
      "custom_fields": {
        "custom_field_name1": "amet deserunt mollit",
        "custom_field_name2": "minim consequat id"
      }
    },
    {
      "contact_id": "db637d33-bce1-462c-ae9c-91ec4f761de6",
      "primary_email": "t7N5TjDmKhC0@gfdifW.ua",
      "alternate_emails": [
        "gQol@Xcfilli.hc",
        "n4K7OdaVQh@YfsnF.ie",
        "TdnvS3nMStREn@miFjGzNDCPZWhiswJNxrFnOYdUAZEpesQ.yxpu",
        "xRzGDTTzzbYK@eJ.wpgb",
        "iI1rOpx2ct@aZhuYGZBxJLZ.phr"
      ],
      "first_name": "ea et eu",
      "last_name": "velit Ut laborum ipsu",
      "address_line_1": "labore",
      "address_line_2": "non",
      "city": "ĔȸąŸÂ¸ȠɏbɄ",
      "state_province_region": "deserunt dolore",
      "postal_code": -95171713,
      "country": "do",
      "list_ids": [
        "c712288b-2300-4069-bef4-2e05b5948ec3",
        "9003ef29-5eb7-4951-898b-1b102e490d6e"
      ]
    }
  ],
  "name": "enim et anim",
  "query_dsl": "nostrud"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "tempor",
      "field": "adipisicing deserunt"
    },
    {
      "message": "ea culpa elit in",
      "field": "ut"
    },
    {
      "message": "magna nisi",
      "field": "voluptate cillum nisi fugiat do"
    }
  ]
}
{
  "errors": [
    {
      "message": "enim est dolore"
    },
    {
      "message": "aliqua"
    },
    {
      "message": "ullamco laborum"
    },
    {
      "message": "enim Excepteur ea voluptate aliquip"
    }
  ]
}
Request Payload
{
  "name": "i",
  "parent_list_ids": [
    "ut minim nulla proident",
    "reprehenderit"
  ],
  "query_dsl": "aute quis proident velit"
}
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": "adipisicing aute",
      "field": "ut dolore"
    },
    {
      "message": "aute tempor occaecat fugiat",
      "field": "dolor magna tempor in"
    },
    {
      "message": "adipisicing",
      "field": "consectetur in proident sed"
    },
    {
      "message": "reprehenderit in",
      "field": "aliqua pariatur"
    },
    {
      "message": "nostrud ex exercitation",
      "field": "deserunt sit irure"
    }
  ]
}
{
  "errors": [
    {
      "message": "pariatur veniam in quis minim"
    },
    {
      "message": "exercitation irure velit"
    },
    {
      "message": "nostrud ut"
    }
  ]
}
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": "elit qui",
      "field": "sed proident ad ullamco labore"
    },
    {
      "message": "quis in ullamco",
      "field": "dolore ad"
    },
    {
      "message": "dolor minim velit sunt",
      "field": "tempor do"
    },
    {
      "message": "ex eu sunt cillum occaecat",
      "field": "sunt fugiat ut laboris"
    },
    {
      "message": "ex sit nulla",
      "field": "aliqua incididunt labore Ut"
    }
  ]
}
{
  "errors": [
    {
      "message": "quis consequat incididunt sunt"
    }
  ]
}

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": "ullamco ad exercitation dolore dolore",
      "error": "ullamco irure",
      "resources": {
        "type": "labore Excepteur eu proident",
        "ids": [
          "sed occaecat laboris irure",
          "anim qui dolore officia",
          "nisi",
          "Duis pariatur ea eiusmod nostrud"
        ]
      }
    },
    {
      "id": "ipsum",
      "error": "dolor",
      "resources": {
        "type": "non nostrud sunt in",
        "ids": [
          "ullamco veniam amet anim cillum"
        ]
      }
    },
    {
      "id": "Duis sint nostrud",
      "error": "esse eiusmod consequat ad",
      "resources": {
        "type": "mollit",
        "ids": [
          "laboris qui dolore ullamco et"
        ]
      }
    },
    {
      "id": "consectetur velit",
      "error": "elit Lorem deserunt",
      "resources": {
        "type": "Duis dolore ullamco eiusmod",
        "ids": [
          "do labore Duis dolor"
        ]
      }
    }
  ]
}
{}
{
  "errors": [
    {
      "field": "sunt qui elit irure minim",
      "message": "aute consequat id"
    },
    {
      "field": "nostrud incididunt quis",
      "message": "Duis cupidatat Excepteur anim"
    },
    {
      "field": "eu",
      "message": "sit ea minim"
    },
    {
      "field": "nulla dolore laborum",
      "message": "in enim"
    },
    {
      "field": "non",
      "message": "ut"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "Duis commodo"
    }
  ]
}

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": "consectetur deserunt sed",
      "message": "ex Duis nulla veniam",
      "error_id": "pariatur"
    }
  ]
}
{
  "errors": [
    {
      "field": "culpa",
      "message": "tempor enim",
      "error_id": "voluptate laborum"
    },
    {
      "field": "commodo consectetur Ut labore",
      "message": "proident exercitation",
      "error_id": "anim dolor esse est nostrud"
    },
    {
      "field": "Excepteur",
      "message": "culpa dolor",
      "error_id": "sint quis in laboris ut"
    }
  ]
}
Query Parameter NameExample
page_size-85879663
page_tokensit
Request Payload
Response Payload
{
  "result": [
    {
      "id": "8442881c-1bf9-12ab-11ee-f3832c9971b6",
      "name": "non quis labore",
      "abtest": null,
      "status": "draft",
      "categories": [
        "voluptate esse",
        "Excepteur cupidatat id minim",
        "reprehenderit incididunt et non in",
        "in sunt elit Ut aliquip",
        "exercitation tempor dolore commodo",
        "minim dolore occaecat laborum",
        "nulla pariatur",
        "ea proident labore",
        "sed in",
        "velit Duis dolor non"
      ],
      "send_at": "1937-05-24T13:25:41.0Z",
      "is_abtest": false,
      "updated_at": "1911-12-29T21:19:54.0Z",
      "created_at": "1916-07-08T17:34:50.0Z"
    }
  ],
  "_metadata": {
    "prev": "https://Qsdxehf.tsiTbiOdOSPw0-AbfB.BeqzXeTomExTgt",
    "self": "https://wp.vmeeeXroqa3LaaYhqyjwuae9hbiP.PKg+uiHXtct6Fm",
    "next": "https://OGQTLTr.bigHIzOsVzw6B-gKMaFcPejEKgXfDI8GSUonhbbBP-Ezu-osMKGltUSUf+d95BA0j8bop3y9UH",
    "count": 50429641
  }
}
{
  "errors": [
    {
      "field": "sint minim elit",
      "message": "nulla incididunt veniam eiusmod sunt",
      "error_id": "voluptate culpa"
    },
    {
      "field": "irure sunt id dolor est",
      "message": "dolore",
      "error_id": "nisi labore"
    },
    {
      "field": "nisi aute",
      "message": "aliquip dolor mollit non ullamco",
      "error_id": "in"
    },
    {
      "field": "minim deserunt commodo aute",
      "message": "veniam in velit Excepteur",
      "error_id": "proident esse et commodo"
    }
  ]
}
Query Parameter NameExample
ids["est ut","consectetur magna dolor sed","cillum","dolor","dolor ut labore","ut et Lorem","sed","enim sint","Lorem nisi voluptate","enim nisi Excepteur eiusmod esse"]
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "cillum",
      "message": "sed sunt ad",
      "error_id": "esse sunt est ut"
    },
    {
      "field": "deserunt culpa",
      "message": "officia",
      "error_id": "consequat consectetur ut labore"
    },
    {
      "field": "minim mollit enim pariatur",
      "message": "sed",
      "error_id": "id laboris incididunt"
    },
    {
      "field": "Duis Ut quis",
      "message": "id voluptate",
      "error_id": "deserunt dolore eu aliqua"
    },
    {
      "field": "quis consectetur magna velit in",
      "message": "mollit consequat consectetur",
      "error_id": "aute consequat ad"
    }
  ]
}
{
  "errors": [
    {
      "field": "eu cillum",
      "message": "dolor aliqua qui aliquip",
      "error_id": "tempor"
    },
    {
      "field": "nisi irure eiusmod culpa",
      "message": "veniam cupidatat dolore",
      "error_id": "sed adipisicing magna aliquip"
    },
    {
      "field": "exercitation mollit nulla cillum",
      "message": "ex",
      "error_id": "officia cupidatat tempor velit dolore"
    },
    {
      "field": "enim deserunt",
      "message": "in esse eu",
      "error_id": "proident et ullamco"
    },
    {
      "field": "minim sint et",
      "message": "proident dolor",
      "error_id": "dolore commodo deserunt"
    }
  ]
}
Request Payload
{
  "name": "id ex dolore amet"
}
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": "mollit veniam nisi aliquip",
      "message": "dolor in",
      "error_id": "et reprehenderit"
    },
    {
      "field": "deserunt minim sunt aute magna",
      "message": "ex sed ullamco dolor",
      "error_id": "pariatur laboris deserunt"
    },
    {
      "field": "proident pariatur enim",
      "message": "adipisicing velit",
      "error_id": "laborum proident ea dolor esse"
    },
    {
      "field": "est eu quis",
      "message": "non eiusmod",
      "error_id": "ullamco velit irure"
    }
  ]
}
{
  "errors": [
    {
      "field": "dolor nulla fugiat consequat",
      "message": "et",
      "error_id": "culpa qui ad aute fugiat"
    },
    {
      "field": "anim",
      "message": "dolor veniam ea id ut",
      "error_id": "eiusmod dolore dolor et reprehenderit"
    },
    {
      "field": "Ut eiusmod et",
      "message": "in in anim Excepteur aliqua",
      "error_id": "in cupidatat Lorem"
    }
  ]
}
Request Payload
{
  "name": "dolore sit",
  "categories": [
    "esse aliquip anim laborum dolor",
    "sint dolor",
    "do in aliqua dolor",
    "nisi voluptate adipisicing",
    "deserunt ad",
    "laboris sunt enim ullamco fugiat",
    "in aute enim",
    "eu ut et aliquip esse",
    "dolore pariatur laborum",
    "deserunt nostrud velit laborum Duis"
  ],
  "send_at": "1914-10-05T12:20:07.0Z",
  "send_to": {
    "list_ids": [
      "f7c84a8f-a1c4-0d17-056b-733e8ce7088c",
      "aa39f8c6-39a0-27a4-b982-d28b43494277",
      "df27f393-77ed-f34d-add5-6b47c8cf6f02",
      "760e9ff9-09da-408e-5d69-2a3847d1f781",
      "9cf9fe9c-f9a3-8b12-9ad9-7fa1a9a03127",
      "9016469c-6cdf-f304-2d6a-bb2cb848f951",
      "1ea31d2a-9031-263c-813c-47f57e3928f9",
      "291e36e9-4b89-8616-853e-eb74aa354a4d",
      "b93d4961-74de-350b-8d33-7675aa366a6a",
      "92b23b08-a116-da03-6247-9afb1bb6e453"
    ],
    "segment_ids": [
      "35ef6cff-3922-a9c7-0ca7-5d7564e05c40",
      "a1f7e54f-6044-c5df-2c51-946f7e2349e5",
      "145e0f5d-172e-defe-954a-aecf1978d01e",
      "50fba7f2-065e-c5f5-b138-9483bf4b0bd8",
      "0e752db6-ede2-6b4c-112c-5717ca958475",
      "34e39fd2-9117-b9a0-a379-e319b9354527",
      "bb301b27-1ea9-3315-7e5d-55059351a191",
      "376c1983-1111-46d6-27b9-fe0f2ac84d42",
      "518a50c3-01dc-89e3-ef38-84c30449de6e",
      "81ffb291-f998-57f9-55d7-1571ae858a98"
    ],
    "all": false
  },
  "email_config": {
    "subject": "in proident Excepteur ipsum aliqua",
    "html_content": "fugiat magna",
    "plain_content": "voluptate amet ex",
    "generate_plain_content": false,
    "design_id": "do laborum quis",
    "editor": "code",
    "suppression_group_id": 31393001,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  }
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "field": "dolore incididunt pariatur sit",
      "message": "nisi",
      "error_id": "id ea"
    },
    {
      "field": "irure",
      "message": "ullamco occaecat",
      "error_id": "elit reprehenderit ullamco exercitation sed"
    },
    {
      "field": "exercitation laborum esse sint velit",
      "message": "culpa",
      "error_id": "ad"
    },
    {
      "field": "id voluptate dolor ullamco",
      "message": "nisi pariatur quis",
      "error_id": "nisi"
    }
  ]
}
{
  "errors": [
    {
      "field": "ea tempor",
      "message": "laborum",
      "error_id": "consequat nulla enim quis"
    },
    {
      "field": "nostrud exercitation consectetur ut",
      "message": "non laborum",
      "error_id": "ullamco et aute Lorem laborum"
    },
    {
      "field": "pariatur velit laborum deserunt",
      "message": "ex aliqua voluptate in",
      "error_id": "irure aliquip eiusmod dolore sunt"
    },
    {
      "field": "in",
      "message": "dolore occaecat id",
      "error_id": "laborum"
    },
    {
      "field": "est laborum occaecat irure consectetur",
      "message": "aliqua",
      "error_id": "elit"
    }
  ]
}
{
  "errors": [
    {
      "field": "nisi",
      "message": "ex",
      "error_id": "dolore eiusmod Lorem quis sint"
    },
    {
      "field": "ea labore",
      "message": "qui sint anim nisi",
      "error_id": "consequat"
    },
    {
      "field": "deserunt eu ex",
      "message": "ullamco sit ut reprehenderit sed",
      "error_id": "eu deserunt commodo in in"
    }
  ]
}
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": "irure Duis amet",
      "message": "deserunt dolore ex cupidatat pariatur",
      "error_id": "enim officia Lorem"
    },
    {
      "field": "ea eiusmod dolore",
      "message": "in dolore ut commodo",
      "error_id": "pariatur esse laborum"
    },
    {
      "field": "anim nostrud id ipsum",
      "message": "nostrud dolore ut ullamco",
      "error_id": "ullamco"
    },
    {
      "field": "esse minim aute pariatur proident",
      "message": "Duis",
      "error_id": "quis"
    },
    {
      "field": "occaecat",
      "message": "aute sed est ex anim",
      "error_id": "proident consectetur nostrud"
    }
  ]
}
{
  "errors": [
    {
      "field": "culpa",
      "message": "nostrud",
      "error_id": "dolore minim eiusmod aute"
    },
    {
      "field": "cupidatat",
      "message": "labore in",
      "error_id": "elit"
    },
    {
      "field": "non eiusmod mollit cillum",
      "message": "ea Excepteur adipisicing",
      "error_id": "aliqua"
    },
    {
      "field": "laborum ut commodo",
      "message": "dolor voluptate",
      "error_id": "voluptate cupidatat"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "est adipisicing sint ut",
      "message": "sit consectetur dolore dolor",
      "error_id": "cupidatat"
    },
    {
      "field": "sit",
      "message": "sed ex",
      "error_id": "et esse veniam"
    },
    {
      "field": "non",
      "message": "officia dolore exercitation sit minim",
      "error_id": "enim sunt minim Excepteur"
    }
  ]
}
{
  "errors": [
    {
      "field": "et consectetur veniam",
      "message": "nisi",
      "error_id": "in nulla veniam mollit"
    }
  ]
}
Query Parameter NameExample
page_size-67515715
page_tokennisi sed sunt
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": "Excepteur dolor",
      "message": "laborum commodo exercitation",
      "error_id": "dolore dolore"
    },
    {
      "field": "in mollit",
      "message": "officia ad",
      "error_id": "est in Lorem"
    }
  ]
}
Request Payload
{
  "send_at": "3752-01-28T23:21:52.575Z"
}
Response Payload
{
  "send_at": "3752-01-28T23:21:52.575Z",
  "status": "scheduled"
}
{
  "errors": [
    {
      "field": "ad veniam irure labore dolor",
      "message": "minim aute",
      "error_id": "culpa labore eu dolor"
    },
    {
      "field": "est et irure aliquip",
      "message": "consectetur cupidatat",
      "error_id": "sunt tempor cupidatat"
    },
    {
      "field": "nisi in do magna nulla",
      "message": "mollit ea",
      "error_id": "aliquip non eu"
    },
    {
      "field": "pariatur ex incididunt mollit non",
      "message": "mollit quis et",
      "error_id": "eiusmod ex deserunt Lorem"
    },
    {
      "field": "quis aliqua nostrud ad ipsum",
      "message": "officia dolore velit",
      "error_id": "adipisicing sint Duis"
    }
  ]
}
{
  "errors": [
    {
      "field": "dolore nisi deserunt Lorem occaecat",
      "message": "culpa proident do voluptate",
      "error_id": "minim veniam magna"
    },
    {
      "field": "eiusmod consectetur",
      "message": "incididunt reprehenderit id sit",
      "error_id": "exercitation"
    }
  ]
}
Request Payload
Response Payload
{
  "send_at": "1938-08-03T03:49:19.0Z",
  "status": "scheduled"
}
{
  "errors": [
    {
      "field": "esse labore ipsum magna dolor",
      "message": "aliquip qui quis occaecat",
      "error_id": "amet id cupidatat"
    },
    {
      "field": "amet",
      "message": "voluptate sit ullamco in",
      "error_id": "sit nostrud occaecat irure in"
    },
    {
      "field": "do id ea elit",
      "message": "consectetur officia exercitation cillum",
      "error_id": "ipsum consectetur"
    },
    {
      "field": "sed officia ut",
      "message": "velit dolore",
      "error_id": "pariatur"
    }
  ]
}
{
  "errors": [
    {
      "field": "incididunt proident Lorem",
      "message": "quis Excepteur labore",
      "error_id": "sit culpa dolore"
    },
    {
      "field": "consectetur voluptate",
      "message": "qui",
      "error_id": "proident"
    }
  ]
}
Request Payload
Response Payload
{
  "categories": [
    "equipment",
    "shoes",
    "sports"
  ]
}
{
  "errors": [
    {
      "field": "deserunt dolore fugiat ex",
      "message": "ut dolore eiusmod non",
      "error_id": "elit irure nostrud ullamco"
    }
  ]
}

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["Excepteur","eiusmod irure","quis do","enim culpa","in","enim ea tempor irure consectetur","occaecat elit","in reprehenderit Lorem et non","in","et in deserunt dolor"]
page_size25
page_tokenut Excepteur
Request Payload
Response Payload
{
  "results": [
    {
      "id": "c940bf8b-c765-1016-aa88-5e93994bd782",
      "aggregation": "anim minim",
      "step_id": "ut ipsum mollit reprehenderit laboris",
      "stats": {
        "bounce_drops": -6538804,
        "bounces": -3593099,
        "clicks": -72745438,
        "delivered": -14413424,
        "invalid_emails": -3922839,
        "opens": 89098809,
        "requests": -37447409,
        "spam_report_drops": 96106037,
        "spam_reports": 31927562,
        "unique_clicks": -15754480,
        "unique_opens": 70150474,
        "unsubscribes": -12912658
      }
    },
    {
      "id": "9edff53f-8693-fb57-d767-7404b6a876fb",
      "aggregation": "cillum sed irure",
      "step_id": "aliqua in enim esse",
      "stats": {
        "bounce_drops": -56191911,
        "bounces": 12313099,
        "clicks": 99399049,
        "delivered": 63260189,
        "invalid_emails": -61216614,
        "opens": -1960358,
        "requests": -23904534,
        "spam_report_drops": 98903320,
        "spam_reports": 19788647,
        "unique_clicks": 24420094,
        "unique_opens": -89739680,
        "unsubscribes": -3312423
      }
    }
  ],
  "_metadata": {
    "prev": "http://SXJEfNJtLqjzYqUpACDCjQ.rhyOvTBmbwa,b7pKRjH7loREbKBy+Aik9cExoijEf,WuBvqm8aisrZhsM-,kDrUo",
    "self": "https://jsaWkyidKJpqM.vedvtbjNemxEnnPty1Cgxko",
    "next": "https://HeWIZIDg.xkD2SKWagHHf,",
    "count": 27057150.31119977
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
group_by["step_id","step_id"]
step_ids["19ff4594-aa27-9618-8dbe-38dce3aa398a","2933b9f5-690f-9e9c-2539-3f601f7a80c4"]
aggregated_bytotal
start_date1913-01-07
end_date1898-02-21
timezoneelit
page_size59
page_tokencillum consequat
Request Payload
Response Payload
{
  "results": [
    {
      "id": "3c4fbcf6-51aa-b1fd-8aeb-fdc30725044c",
      "aggregation": "in aute",
      "step_id": "do in et",
      "stats": {
        "bounce_drops": -55152084,
        "bounces": -16396220,
        "clicks": -95058982,
        "delivered": 57953588,
        "invalid_emails": -35387168,
        "opens": 96915994,
        "requests": 89795527,
        "spam_report_drops": 36837808,
        "spam_reports": 43430994,
        "unique_clicks": -94690344,
        "unique_opens": -76534017,
        "unsubscribes": -50504514
      }
    }
  ],
  "_metadata": {
    "prev": "http://YhReFDHizmbaTWytX.visfQN680cm25D4AqZFCC1rKo8nELUy,KYHiXB9QMVa490I5VQnt+DrolUew5leNoPDNJDfd9GIbh2",
    "self": "https://xdHQXOhIAXjQazyNudginJtfdZRF.yveknQ,6WzPmruHuX,7dHBcnUoE0o4Z.vS2qbIyNSJUKqzUp+8eF70kJXU0.HWiGBzp5dsQRyFbaGJRVxhZld4vbjtB",
    "next": "http://BBBXlUIlmfCptD.sbxagQ6BO38HMlIilCYh4qwDqk5OGPwGt.p1B5B51v58bLPgvyAx65YKbCA.Vr2m3X",
    "count": 39005167.79052475
  }
}
{
  "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["voluptate dolore ullamco labore ex","quis","elit ullamco Lorem","labore ut","tempor","dolore non","Duis","enim sed consectetur","reprehenderit enim in magna","amet nulla eiusmod"]
page_size63
page_tokenenim dolor amet proident ad
Request Payload
Response Payload
{
  "results": [
    {
      "id": "bd016c6d-c4ff-3f30-ec5f-174c3d3a8a15",
      "ab_variation": "120309a7-76f8-deb6-fcde-e316fcd88c10",
      "ab_phase": "send",
      "aggregation": "occaecat ex ullamco",
      "stats": {
        "bounce_drops": 98142275,
        "bounces": -26248381,
        "clicks": -38868334,
        "delivered": 89276741,
        "invalid_emails": -67228375,
        "opens": 790342,
        "requests": -69132365,
        "spam_report_drops": -95029719,
        "spam_reports": -85719009,
        "unique_clicks": 42447463,
        "unique_opens": 20345312,
        "unsubscribes": -78184934
      }
    },
    {
      "id": "f9a0f80a-991b-26e5-5691-25c172de042c",
      "ab_variation": "7ee9e791-5f9b-16ae-f0a4-5208a491c4ef",
      "ab_phase": "send",
      "aggregation": "dolore in eiusmod",
      "stats": {
        "bounce_drops": -41008062,
        "bounces": -81486793,
        "clicks": 54764786,
        "delivered": 81790024,
        "invalid_emails": -81573720,
        "opens": 68843130,
        "requests": -27688371,
        "spam_report_drops": -47232753,
        "spam_reports": 41393320,
        "unique_clicks": 5681191,
        "unique_opens": -83562133,
        "unsubscribes": 41968087
      }
    },
    {
      "id": "1253b8d3-8e5d-c3a1-5005-18e1cd6f626a",
      "ab_variation": "4c228c44-35e5-0874-6735-0a75b2d77ee0",
      "ab_phase": "send",
      "aggregation": "ipsum et commodo Ut",
      "stats": {
        "bounce_drops": -99165852,
        "bounces": -41840350,
        "clicks": -39738774,
        "delivered": -63647052,
        "invalid_emails": -65374749,
        "opens": -18999543,
        "requests": -25961016,
        "spam_report_drops": 37546767,
        "spam_reports": 43490991,
        "unique_clicks": -86010144,
        "unique_opens": -11457161,
        "unsubscribes": 61254971
      }
    },
    {
      "id": "e383825e-a428-06ba-ef65-8b05f4d41017",
      "ab_variation": "780acaee-9b4d-2c9a-da37-aac56820204c",
      "ab_phase": "send",
      "aggregation": "commodo et incididunt",
      "stats": {
        "bounce_drops": -15286740,
        "bounces": -39093696,
        "clicks": 83199568,
        "delivered": 78298742,
        "invalid_emails": 59149475,
        "opens": 64858532,
        "requests": 52060863,
        "spam_report_drops": -97910594,
        "spam_reports": 39678966,
        "unique_clicks": 30213072,
        "unique_opens": -16417539,
        "unsubscribes": -25573478
      }
    }
  ],
  "_metadata": {
    "prev": "http://wVYAnwJRNUUFHVfJgcfycBIxbYF.vzszGjNG9S",
    "self": "http://MyEopb.nggDU2CDo++0d5EWl3zpz7SPrzij,OrVATuHr8duX8QI4EL90YC31V,",
    "next": "http://jmrgcpnlxtdWWcYdKZjqtKFKkLHeyD.xeDHvUAhIhYBqBtWoxUdxv8.ugxv5Qf+SGPGcRtmcEsvFbCBuhy6pW+8mggSIKegJyEeY.5",
    "count": -79535679.46077329
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
aggregated_byday
start_date1925-04-11
end_date1969-01-16
timezonedo
page_size85
page_tokenproident nisi adipisicing quis
group_by["ab_variation","ab_variation","ab_variation","ab_variation"]
Request Payload
Response Payload
{
  "results": [
    {
      "id": "10ba8f90-a491-a09f-4f1a-57ac5fb7ecb7",
      "ab_variation": "1a782896-25c3-76da-a160-493168a5a74e",
      "ab_phase": "all",
      "aggregation": "est",
      "stats": {
        "bounce_drops": -57738445,
        "bounces": -869018,
        "clicks": -59313334,
        "delivered": 87853426,
        "invalid_emails": 47273385,
        "opens": -79060475,
        "requests": 86564167,
        "spam_report_drops": 84022859,
        "spam_reports": 41507428,
        "unique_clicks": -94244949,
        "unique_opens": 45729185,
        "unsubscribes": 74793015
      }
    },
    {
      "id": "c7fcdfa1-039b-73c2-6947-9523c5f8b805",
      "ab_variation": "ad1065a5-d063-c554-074a-05814f338068",
      "ab_phase": "send",
      "aggregation": "in adipisicing",
      "stats": {
        "bounce_drops": 56798453,
        "bounces": 53352527,
        "clicks": 43789571,
        "delivered": 68787018,
        "invalid_emails": 65114706,
        "opens": 72554990,
        "requests": 11863244,
        "spam_report_drops": 52606739,
        "spam_reports": -62444795,
        "unique_clicks": -86913040,
        "unique_opens": -50671789,
        "unsubscribes": -3041117
      }
    },
    {
      "id": "909a357e-4cb3-d0b4-80e9-5817d59871c5",
      "ab_variation": "1ea427d4-3f3f-c68b-9ca1-a9ebb2ad1ee1",
      "ab_phase": "all",
      "aggregation": "irure ipsum occaecat ut",
      "stats": {
        "bounce_drops": 13774528,
        "bounces": -1085804,
        "clicks": -33998401,
        "delivered": -70339250,
        "invalid_emails": -14689443,
        "opens": -19132181,
        "requests": 65860746,
        "spam_report_drops": -65807591,
        "spam_reports": -33397373,
        "unique_clicks": 30538007,
        "unique_opens": 68626217,
        "unsubscribes": 12865850
      }
    }
  ],
  "_metadata": {
    "prev": "https://zpfFNAu.fik66fs4p3568mKRXgaJ,6fUIIuvyQU0D3hBW,U",
    "self": "https://grpIqHCbbfhJxPjHoKWZ.ybsaWSa4,mwrnM3FbT.7UEglkI,KUu6",
    "next": "https://YlAyJIOFrm.usyHl-4Z3OpWXYMm4gnCfv",
    "count": 92937009.75781131
  }
}
{
  "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["1e2ca161-1111-649d-8785-436dbd9ad41a","5fba3fc3-3dcd-35a3-6b1b-93024e1d7b5e"]
page_size94
page_tokenea non nulla aute
Request Payload
Response Payload
{
  "results": [
    {
      "url": "http://HUlGoXQGWjIMfRfEpNKHDDm.pnERR8H",
      "url_location": 35851720,
      "step_id": "07dacdbb-b5c3-8f8c-e61e-b4f351b76489",
      "clicks": 84883080
    }
  ],
  "total_clicks": -88830084,
  "_metadata": {
    "prev": "https://HJhvOLaEhOJEPesxAXl.fpvf4IqSSmUepKCnDwyCjlFSmPAZorV5y1xQCltIle1xw.",
    "self": "http://vPBEUUOOuLbVlUyigKM.gimyHXmWmfsX7N0HM9.fUezgzxyHj-nB0T24aXVsh9MsCBVMYTBLS,OV+P7PPK",
    "next": "http://BLrshWAhqGjEXnksnlctIxmk.qfdi1NiaQ5XPqP4zfZLbrCOVAazmJ5NhimcjgAQjKKNtaGt1-,",
    "count": 74158793.78412938
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
page_size14
page_tokeneiusmod
group_by["ab_phase","ab_phase","ab_phase","ab_variation","ab_phase"]
ab_variation_id993731fe-f942-2689-0324-6f90b4f0a81d
ab_phase_idsend
Request Payload
Response Payload
{
  "results": [
    {
      "url": "http://ITLgehjLpUaBXFUfFUYFLEDooPyM.priogDDS4",
      "url_location": 34534175,
      "ab_variation": "46b85fe4-3c17-79b0-7377-88f6ba54b654",
      "ab_phase": "test",
      "clicks": 58904294
    }
  ],
  "_metadata": {
    "prev": "http://anQYKuvnEg.pmmx6l.zlcbOL.wrlpSCEXF1hTSiwTlBQUX71xPWyDfQEAq",
    "self": "https://McuvuwFbWRAdzgMjBHjA.nydwlmd-ahI,Adox",
    "next": "http://KCgskdLfKnMZ.loipgXsqPFporCFInrEjid-bnKQG1pNCFYOoU",
    "count": 11751570.249717742
  },
  "total_clicks": 18271221
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
Query Parameter NameExample
ids["nisi sunt eu voluptate id","sint non est in","pariatur","nostrud id tempor aliquip","Lorem in","veniam ea pariatur consectetur","laborum id","nisi qui pariatur consectetur","proident aliqua aliquip commodo pariatur","in dolore"]
timezonecillum eiusmod sit nostrud exercitation
Request Payload
Response Payload
fugiat dolor eu
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
ids["dolor","nostrud","est deserunt sint","nostrud incididunt velit dolor","culpa dolore","Lorem","incididunt tempor dolore consectetur ut","aute ipsum","dolore","ullamco sint veniam incididunt"]
timezoneconsectetur in nisi adipisicing dolore
Request Payload
Response Payload
dolore
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Sender Identities API(6 operations)

Header NameExample
on-behalf-of"proident nostrud eiusmod commodo"
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"ut Lorem eu ullamco voluptate"
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"dolor sit laboris"
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"laborum amet sunt reprehenderit occaecat"
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"labore cupidatat officia voluptate"
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"Ut"
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"cupidatat magna"
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"dolor"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1,
      "name": "the jones",
      "recipient_count": 1
    }
  ]
}
Header NameExample
on-behalf-of"ipsum eiusmod nisi"
Request Payload
[
  1,
  2,
  3,
  4
]
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "list id was invalid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
list_id-32535666
Header NameExample
on-behalf-of"ullamco elit velit ex dolore"
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*-78349863
Header NameExample
on-behalf-of"Lorem magna Ut pariatur ad"
Request Payload
{
  "name": "newlistname"
}
Response Payload
{
  "id": 1234,
  "name": "2016 iPhone Users",
  "recipient_count": 0
}
{
  "errors": [
    {
      "message": "invalid id"
    }
  ]
}
{
  "errors": [
    {
      "message": "List ID does not exist"
    }
  ]
}
Query Parameter NameExample
delete_contactstrue
Header NameExample
on-behalf-of"officia eiusmod minim nostrud in"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "delete_contacts",
      "message": "delete_contacts not a bool"
    },
    {
      "field": "list_id",
      "message": "Returned if list_id is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "List not found: 5"
    }
  ]
}
Query Parameter NameExample
page-79386213
page_size34455044
list_id*45769526
Header NameExample
on-behalf-of"voluptate"
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"elit proident minim"
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"sed fugiat"
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*66768368
recipient_id*-46265313
Header NameExample
on-behalf-of"qui dolore"
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"sit commodo in"
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"consequat officia aliquip"
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"eu"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
{}
{
  "errors": [
    {
      "message": "No recipient ids provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
page-51245903
page_size-73094813
Header NameExample
on-behalf-of"sit esse"
Request Payload
Response Payload
{
  "recipients": []
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"tempor dolore ullamco ex"
Request Payload
Response Payload
{
  "status": [
    {
      "id": "worker_delay",
      "value": "delayed"
    },
    {
      "id": "worker_delay_seconds",
      "value": "75.0"
    }
  ]
}
Header NameExample
on-behalf-of"eu ex"
Request Payload
Response Payload
{
  "recipients": [
    {
      "id": "do culpa aliqua magna",
      "created_at": -63803756.92532754,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "6AZtTL9EgpZ@o.iz",
      "first_name": "enim",
      "last_name": "dolor Ut laboris",
      "last_clicked": null,
      "last_emailed": null,
      "last_opened": -38418563.96143775,
      "updated_at": 43500850.96862188
    },
    {
      "id": "Lorem",
      "created_at": 90761985.96676758,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "VrRuIgiO@eDUarsjU.dop",
      "first_name": null,
      "last_name": null,
      "last_clicked": null,
      "last_emailed": -2539568.838077426,
      "last_opened": null,
      "updated_at": 79612686.28283542
    },
    {
      "id": "velit ipsum",
      "created_at": 65214450.954738945,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "6Nj4L6a@SoPWVmlCHSDpjKpr.cngn",
      "first_name": "est velit dolor magna",
      "last_name": "sed aliqua",
      "last_clicked": 49513763.87354019,
      "last_emailed": -42169842.36836816,
      "last_opened": null,
      "updated_at": -72615443.2249194
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"proident"
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "recipient not found"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "recipient_id is not valid"
    }
  ]
}
Header NameExample
on-behalf-of"commodo"
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"ut est commodo ipsum mollit"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"ea cupidatat Ut non veniam"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
{field_name}aliquip non
Header NameExample
on-behalf-of"commodo sunt"
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"cillum in mollit"
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"Duis amet"
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"sint enim ut in eiusmod"
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"elit sit reprehenderit irure non"
Request Payload
Response Payload
{
  "message": "Custom Field delete is processing."
}
{
  "errors": [
    {
      "message": "Custom field in use by one or more segment conditions"
    },
    {
      "message": "Custom field ID does not exist"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "Custom field ID does not exist"
    }
  ]
}
Header NameExample
on-behalf-of"Ut irure"
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"culpa"
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"labore sunt tempor Ut"
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*92508615
Header NameExample
on-behalf-of"voluptate fugiat adipisicing ad labore"
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_idamet qui non
Header NameExample
on-behalf-of"irure exercitation"
Request Payload
{
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ]
}
Response Payload
{
  "id": 5,
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ],
  "recipient_count": 1
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "segment_id": "segment_id",
      "message": "segment id is not valid"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
delete_contactsfalse
Header NameExample
on-behalf-of"quis dolore"
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
page77272119
page_size84307754
Header NameExample
on-behalf-of"deserunt"
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
limit67230721
categoryconsectetur
offset19492768
Header NameExample
on-behalf-of"nisi mollit culpa labore sit"
Request Payload
Response Payload
[
  {
    "category": "category 1"
  },
  {
    "category": "category 2"
  }
]
{
  "errors": [
    {
      "field": "sort_by",
      "message": "invalid sort value"
    }
  ]
}
Query Parameter NameExample
sort_by_metricex magna nulla
sort_by_directionasc
start_date*nostrud
end_datealiquip aliqua amet est
limit-91161622
offset32961139
aggregated_byday
Header NameExample
on-behalf-of"cillum ex amet dolor"
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*officia reprehenderit
end_datefugiat Excepteur magna commodo mollit
categories*ut in deserunt
limit-83526160
offset62825886
aggregated_byweek
Header NameExample
on-behalf-of"proident"
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"ad"
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
limit27457327
offset39151173
Header NameExample
on-behalf-of"tempor magna"
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"cupidatat pariatur deserunt laborum consequat"
Request Payload
Response Payload
{
  "categories": [
    "spring line"
  ],
  "custom_unsubscribe_url": "",
  "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
  "id": 986724,
  "ip_pool": "marketing",
  "list_ids": [
    110
  ],
  "plain_content": "Check out our spring line!",
  "segment_ids": [
    110
  ],
  "sender_id": 124451,
  "status": "Draft",
  "subject": "New Products for Spring!",
  "suppression_group_id": 42,
  "title": "March Newsletter"
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"ut ex"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"ex ea dolore"
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"amet Excepteur incididunt id et"
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"Excepteur cillum ut minim"
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"labore ad"
Request Payload
{
  "send_at": 1489451436
}
Response Payload
{
  "id": -3362095,
  "send_at": -64997962,
  "status": "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 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"do aliquip nulla nostrud et"
Request Payload
Response Payload
{
  "send_at": 1490778528
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"eu occaecat cillum culpa minim"
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"culpa pariatur et nostrud"
Request Payload
{
  "to": "your.email@example.com"
}
Response Payload
{
  "to": "laborum sit in velit"
}
{
  "errors": [
    {
      "field": "send_at",
      "message": "Please choose a future time for sending your campaign."
    },
    {
      "field": null,
      "message": "The JSON you have submitted cannot be parsed."
    },
    {
      "field": null,
      "message": "You do not have enough credits to send this campaign. Upgrade your plan to send more: https://app.sendgrid.com/settings/billing"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}

Transactional Templates(6 operations)

Header NameExample
on-behalf-of"est mollit"
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,dynamic
page_size*47.15370290573276
page_tokenconsectetur consequat
Header NameExample
on-behalf-of"dolor esse enim mollit"
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": [
    {
      "": "exercitation dolor",
      "message": "laboris",
      "error_id": "ut"
    },
    {
      "": "aute exercitation quis",
      "message": "amet velit nostrud culpa",
      "error_id": "est id nostrud"
    },
    {
      "": "ad",
      "message": "adipisicing culpa",
      "error_id": "incididunt dolore esse"
    },
    {
      "": "dolore deserunt aliqua Duis",
      "message": "sed dolore",
      "error_id": "dolore aute officia id"
    }
  ]
}
Header NameExample
on-behalf-of"aliquip"
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"sed ut ullamco pariatur ex"
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"ad sed Ut deserunt"
Request Payload
{
  "name": "new_example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "new_example_name",
  "versions": []
}
Header NameExample
on-behalf-of"officia"
Request Payload
Response Payload
{}

Transactional Templates Versions(5 operations)

Header NameExample
on-behalf-of"mollit reprehenderit"
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"labore Duis et aute"
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"proident occaecat"
Request Payload
Response Payload
{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
  "active": 1,
  "name": "example_version_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "generate_plain_content": true,
  "subject": "<%subject%>",
  "updated_at": "2019-03-13 18:56:33",
  "editor": "code"
}
Header NameExample
on-behalf-of"labore reprehenderit minim enim"
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"dolore reprehenderit deserunt sunt exercitation"
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"amet non"
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"cupidatat magna ex ullamco nisi"
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"consequat"
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": "minim tempor adipisicing"
    },
    {
      "message": "cillum"
    },
    {
      "message": "laboris Excepteur tempor"
    },
    {
      "message": "pariatur labore"
    }
  ]
}
Query Parameter NameExample
limitsit Lorem nulla adipisicing fugiat
offseteu adipisicing
aggregated_bymonth
start_date*labore dolore magna exercitation esse
end_datequis veniam adipisicing velit
Header NameExample
on-behalf-of"quis"
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"consequat"
Request Payload
Response Payload
{
  "public_key": "anim quis in sint"
}
Header NameExample
on-behalf-of"cillum magna"
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"qui"
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"laborum sunt proident"
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": "Excepteur sed amet qui ut"
    },
    {
      "message": "nulla ad laborum"
    }
  ]
}
Header NameExample
on-behalf-of"voluptate ut magna Excepteur eu"
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": "cupidatat ullamco dolor labore dolor"
    },
    {
      "message": "ea irure aute velit"
    },
    {
      "message": "commodo culpa"
    }
  ]
}
Header NameExample
on-behalf-of"ut incididunt"
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": "Duis eu pariatur nostrud"
    },
    {
      "message": "sunt adipisicing irure consequat et"
    }
  ]
}
Header NameExample
on-behalf-of"minim nulla amet consectetur deserunt"
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 in aliqua"
    },
    {
      "message": "voluptate dolore magna adipisicing cupidatat"
    }
  ]
}

Query(2 operations)

Query Parameter NameExample
query*in dolore occaecat nostrud
limit321.7962903119447
Header NameExample
X-Query-Id"est consequat"
X-Cursor"dolore ad culpa consectetur"
Authorization*"minim velit voluptate nisi non"
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*"Lorem ut"
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
queryproident sed adipisicing
Header NameExample
Authorization*"sint"
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*"velit in ipsum nostrud in"
Request Payload
Response Payload
{
  "presigned_url": "https://example.com",
  "csv": "https://s3-us-west-2.amazonaws.com/sendgrid-rts-development-queries/013c31af-7c9a-49e6-922c-d990f4aff151.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Credential=AKIAI4NOW7APZHRFYGWQ%2F20170728%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-SignedHeaders=host&X-Amz-Date=20170728T223936Z&X-Amz-Signature=5c13ede58b211799ab1a556280bd316c404eac3aef1450c47906a077166c4ab4"
}
{
  "errors": [
    {
      "message": "download token is invalid or expired",
      "field": ""
    }
  ]
}
{
  "errors": [
    {
      "message": "internal server error"
    }
  ]
}

Settings - Tracking(9 operations)

Header NameExample
on-behalf-of"dolor ad"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "open",
      "title": "Open Tracking",
      "description": "lorem ipsum... .",
      "enabled": true
    }
  ]
}
Header NameExample
on-behalf-of"irure nisi dolore"
Request Payload
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"ut cupidatat pariatur do dolor"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"ex cillum eiusmod"
Request Payload
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"Lorem aliqua sit culpa"
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"eu magna et amet"
Request Payload
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"incididunt dolor commodo dolore"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"consequat magna"
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"voluptate eiusmod commodo incididunt in"
Request Payload
{
  "enabled": true,
  "landing": "landing page html",
  "url": "url",
  "replace": "replacement tag",
  "html_content": "html content",
  "plain_content": "text content"
}
Response Payload
{
  "enabled": true,
  "landing": "landing page html",
  "url": "url",
  "replace": "replacement tag",
  "html_content": "html content",
  "plain_content": "text content"
}

Stats(7 operations)

Query Parameter NameExample
limit-53843710
offset16642521
aggregated_bymonth
start_date*do
end_datepariatur
Header NameExample
on-behalf-of"qui nulla velit amet"
Request Payload
Response Payload
[
  {
    "date": "2015-11-03",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
countryUS
limit88503384
offset-19702492
aggregated_bymonth
start_date*ea Lorem magna Duis
end_dateexercitation dolore laboris nulla mollit
Header NameExample
on-behalf-of"in ut"
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
limit60709
offset16611229
aggregated_byday
start_date*sed eiusmod est sunt
end_dateid dolor veniam
Header NameExample
on-behalf-of"sit amet culpa Excepteur"
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*tempor laborum ut sit
end_dateminim veniam
aggregated_byday
Header NameExample
on-behalf-of"consectetur"
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*sit Ut in sed irure
end_datenon tempor
aggregated_bymonth
Header NameExample
on-behalf-of"est"
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_providerssint adipisicing minim
limit863108
offset12952634
aggregated_byweek
start_date*voluptate
end_datenostrud
Header NameExample
on-behalf-of"commodo ullamco dolore"
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
browserseu elit pariatur officia
limit-46016810
offset-14594641
aggregated_bymonth
start_date*amet
end_dateet minim pariatur deserunt
Header NameExample
on-behalf-of"cillum"
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_time84528011
end_time55082142
Header NameExample
Accept*"laboris"
on-behalf-of"officia nostrud est Excepteur"
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"deserunt"
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"Ut laborum sint minim ex"
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*04X@ICjNHVDosVL.nx
Header NameExample
on-behalf-of"quis consequat"
Request Payload
Error generating example
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Blocks API(4 operations)

Query Parameter NameExample
start_time-54491752
end_time-31107355
limit48059580
offset56197122
Header NameExample
on-behalf-of"officia ut commodo voluptate Excepteur"
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"sit voluptate magna labore"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"officia anim quis nisi pariatur"
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"id ex in eiusmod"
Request Payload
Response Payload
{}

Spam Reports API(4 operations)

Query Parameter NameExample
start_time71587896
end_time44320415
limit-13049482
offset63857914
Header NameExample
on-behalf-of"in exercitation ipsum id labore"
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"in occaecat aliqua"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"reprehenderit"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "ip": "10.89.32.5"
  }
]
Header NameExample
on-behalf-of"et nisi commodo"
Request Payload
Response Payload
{}

Suppressions - Global Suppressions(4 operations)

Header NameExample
on-behalf-of"incididunt irure quis in non"
Request Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Response Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Query Parameter NameExample
start_time16103954
end_time-71849875
limit66279135
offset72879939
Header NameExample
on-behalf-of"laboris Ut"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com"
  }
]
Header NameExample
on-behalf-of"in pariatur sunt veniam ut"
Request Payload
Response Payload
{
  "recipient_email": "test@example.com"
}
Header NameExample
on-behalf-of"dolore ex deserunt adipisicing dolor"
Request Payload
Response Payload
{}

Suppressions - Unsubscribe Groups(5 operations)

Header NameExample
on-behalf-of"ut anim"
Request Payload
{
  "name": "Product Suggestions",
  "description": "Suggestions for products our users might like.",
  "is_default": true
}
Response Payload
{
  "id": 103,
  "name": "Product Suggestions",
  "description": "Suggestions for products our users might like.",
  "is_default": false
}
Query Parameter NameExample
id-2829509
Header NameExample
on-behalf-of"consectetur"
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"dolor in"
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"commodo in laborum"
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"non"
Request Payload
Response Payload
{}

Suppressions - Suppressions(6 operations)

Header NameExample
on-behalf-of"ut magna ut dolor"
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"elit adipisicing labore ad"
Request Payload
Response Payload
[
  "example@example.com",
  "example2@example.com"
]
Header NameExample
on-behalf-of"quis"
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"commodo"
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"Excepteur occaecat ipsum fugiat irure"
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"ipsum ut dolore"
Request Payload
Response Payload
Error generating example

Invalid Emails API(4 operations)

Query Parameter NameExample
start_time77051610
end_time-21160254
limit-20076278
offset32194511
Header NameExample
on-behalf-of"eu"
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"dolor sed aliquip"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"qui"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]
Header NameExample
on-behalf-of"dolore"
Request Payload
Response Payload
{}
Service Homepage: sendgrid.com/en-us
API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started
emails