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 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": "anim eu commodo"
    },
    {
      "message": "sint laborum sed do"
    },
    {
      "message": "ullamco sed consequat elit in"
    },
    {
      "message": "ex laborum"
    }
  ]
}

Cancel Scheduled Sends(7 operations)

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

API Keys(6 operations)

Header NameExample
on-behalf-of"dolore aliquip ipsum quis"
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": "minim non occaecat"
    }
  ]
}
Query Parameter NameExample
limit22241380
Header NameExample
on-behalf-of"dolor eiusmod ad et incididunt"
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": "veniam sed"
    },
    {
      "message": "ipsum minim dolor"
    }
  ]
}
Header NameExample
on-behalf-of"sit adipisicing"
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": "ea in esse ipsum"
    }
  ]
}
Header NameExample
on-behalf-of"pariatur"
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": "minim cillum exercitation voluptate velit"
    },
    {
      "message": "occaecat quis dolore eu tempor"
    }
  ]
}
Header NameExample
on-behalf-of"elit aliquip Excepteur sunt"
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": "amet"
    },
    {
      "message": "et dolore incididunt"
    },
    {
      "message": "dolore culpa minim"
    }
  ]
}
Header NameExample
on-behalf-of"et dolore officia"
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": "eiusmod non ad reprehenderit"
    },
    {
      "message": "eu velit Lorem"
    },
    {
      "message": "in irure Lorem"
    },
    {
      "message": "cillum aliquip ea"
    }
  ]
}

API Key Permissions

Header NameExample
on-behalf-of"elit"
Request Payload
Response Payload
{
  "scopes": [
    "mail.send",
    "alerts.create",
    "alerts.read"
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "Ut eu fugiat"
    },
    {
      "message": "ipsum"
    }
  ]
}

Settings - Enforced TLS(2 operations)

Header NameExample
on-behalf-of"consequat adipisicing et"
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": "velit consequat sed laboris"
    }
  ]
}
Header NameExample
on-behalf-of"mollit sit est pariatur"
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": "incididunt"
    },
    {
      "message": "non Ut"
    },
    {
      "message": "occaecat aute est velit"
    },
    {
      "message": "laboris ipsum ea"
    }
  ]
}

IP Access Management(6 operations)

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

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

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

Settings - Mail(13 operations)

Query Parameter NameExample
limit25606428
offset4051766
Header NameExample
on-behalf-of"cillum et in"
Request Payload
Response Payload
{
  "result": [
    {
      "title": "Address Whitelist",
      "enabled": false,
      "name": "address_whitelist",
      "description": "Address / domains that should never have email suppressed."
    },
    {
      "title": "Bounce Purge",
      "enabled": false,
      "name": "bounce_purge",
      "description": "Allows you to automatically purge bounce records from SendGrid after a specified number of days."
    },
    {
      "title": "Event Notification",
      "enabled": true,
      "name": "event_notify",
      "description": "Controls notifications for events, such as bounces, clicks, and opens."
    },
    {
      "title": "Footer",
      "enabled": false,
      "name": "footer",
      "description": "Allows you to add a custom footer to outgoing email."
    },
    {
      "title": "Forward Bounce",
      "enabled": true,
      "name": "forward_bounce",
      "description": "Allows you to forward bounces to a specific email address."
    },
    {
      "title": "Forward Spam",
      "enabled": false,
      "name": "forward_spam",
      "description": "Allows for a copy of spam reports to be forwarded to an email address."
    },
    {
      "title": "Legacy Email Template",
      "enabled": true,
      "name": "template",
      "description": "Allows you to customize your outgoing HTML emails."
    },
    {
      "title": "Plain Content",
      "enabled": false,
      "name": "plain_content",
      "description": "Convert your plain text emails to HTML."
    },
    {
      "title": "Spam Checker",
      "enabled": true,
      "name": "spam_check",
      "description": "Check outbound messages for spam content."
    }
  ]
}
{
  "errors": [
    {
      "error_id": "mollit qui nostrud",
      "field": "irure quis officia dolor consectetur",
      "message": "culpa adipisicing elit",
      "parameter": "aute"
    },
    {
      "error_id": "ipsum sit velit eu ex",
      "field": "in non",
      "message": "eu et",
      "parameter": "nisi incididunt nostrud"
    },
    {
      "error_id": "sed fugiat pariatur qui",
      "field": null,
      "message": "et ea",
      "parameter": "qui nulla est sint"
    },
    {
      "error_id": "enim",
      "field": null,
      "message": "sit exercitation in",
      "parameter": "exercitation ipsum"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ut incididunt",
      "field": null,
      "message": "eiusmod sit laborum deserunt occaecat",
      "parameter": "mollit in sunt aliqua"
    },
    {
      "error_id": "anim id velit officia",
      "field": "esse Ut enim ea amet",
      "message": "in sint ad",
      "parameter": "Duis ad occaecat labore"
    },
    {
      "error_id": "aliquip anim",
      "field": "sint nostrud",
      "message": "officia do fugiat culpa",
      "parameter": "sunt voluptate adipisicing"
    },
    {
      "error_id": "aliqua nulla minim Lorem",
      "field": null,
      "message": "sunt reprehenderit consectetur non labore",
      "parameter": "sunt dolore"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "consequat adipisicing minim",
      "field": "qui",
      "message": "commodo",
      "parameter": "veniam esse do ipsum"
    },
    {
      "error_id": "elit amet aliqua sunt irure",
      "field": null,
      "message": "tempor culpa qui reprehenderit eiusmod",
      "parameter": "enim irure ea in Excepteur"
    },
    {
      "error_id": "ut fugiat",
      "field": null,
      "message": "consectetur ex proident occaecat ad",
      "parameter": "tempor"
    },
    {
      "error_id": "Ut cillum adipisicing consectetur nostrud",
      "field": "in veniam consequat",
      "message": "quis",
      "parameter": "sint veniam ad"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "in ut",
      "field": null,
      "message": "Duis enim ut cillum",
      "parameter": "magna sit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sit elit Ut cillum",
      "field": null,
      "message": "enim nulla",
      "parameter": "officia"
    },
    {
      "error_id": "laborum qui quis Excepteur ea",
      "field": null,
      "message": "culpa enim",
      "parameter": "voluptate"
    },
    {
      "error_id": "ullamco qui ut",
      "field": null,
      "message": "eu ad dolore",
      "parameter": "fugiat deserunt"
    },
    {
      "error_id": "pariatur tempor amet enim dolore",
      "field": null,
      "message": "voluptate ut ullamco dolore",
      "parameter": "nisi aute ex amet sit"
    }
  ]
}
Header NameExample
on-behalf-of"quis ut culpa"
Request Payload
{
  "enabled": true,
  "list": [
    "email1@example.com",
    "example.com"
  ]
}
Response Payload
{
  "enabled": true,
  "list": [
    "email1@example.com"
  ]
}
{
  "errors": [
    {
      "error_id": "reprehenderit anim esse",
      "field": "cupidatat",
      "message": "velit",
      "parameter": "Excepteur culpa in"
    },
    {
      "error_id": "eu dolore aliqua in incididunt",
      "field": null,
      "message": "in ut officia anim",
      "parameter": "Ut dolor"
    },
    {
      "error_id": "sit",
      "field": "sint ea esse",
      "message": "eu ad in",
      "parameter": "ipsum nulla velit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "anim eiusmod minim nostrud ad",
      "field": "id cupidatat esse commodo ut",
      "message": "Duis",
      "parameter": "cupidatat dolor tempor"
    },
    {
      "error_id": "Excepteur ex dolore",
      "field": null,
      "message": "laborum incididunt",
      "parameter": "deserunt nostrud reprehenderit in"
    },
    {
      "error_id": "dolor sit",
      "field": "Ut sed",
      "message": "aliqua mollit consectetur id",
      "parameter": "elit occaecat"
    },
    {
      "error_id": "ex",
      "field": "exercitation irure Lorem veniam in",
      "message": "commodo reprehenderit anim id",
      "parameter": "in"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "minim aliquip quis sunt",
      "field": "aute voluptate",
      "message": "dolore cupidatat",
      "parameter": "ut voluptate in eu elit"
    },
    {
      "error_id": "in id",
      "field": "cillum",
      "message": "nulla dolor quis ex esse",
      "parameter": "commodo do aute cillum"
    },
    {
      "error_id": "eiusmod",
      "field": null,
      "message": "consequat magna",
      "parameter": "consectetur anim quis"
    },
    {
      "error_id": "incididunt cillum ipsum commodo",
      "field": "nostrud ad minim",
      "message": "consectetur eu Excepteur minim culpa",
      "parameter": "Lorem"
    },
    {
      "error_id": "exercitation veniam officia",
      "field": "enim consequat minim",
      "message": "minim",
      "parameter": "amet"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "aute labore nulla proident incididunt",
      "field": null,
      "message": "Excepteur sed cillum consequat enim",
      "parameter": "nostrud mollit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "reprehenderit id",
      "field": null,
      "message": "ea velit aute aliquip",
      "parameter": "labore sunt aute"
    },
    {
      "error_id": "deserunt occaecat aute aliqua",
      "field": "pariatur labore",
      "message": "in sint",
      "parameter": "non adipisicing consectetur deserunt"
    },
    {
      "error_id": "Lorem",
      "field": "commodo dolor sunt magna in",
      "message": "qui",
      "parameter": "reprehenderit anim dolor sunt"
    }
  ]
}
Header NameExample
on-behalf-of"aliquip"
Request Payload
Response Payload
{
  "enabled": true,
  "list": [
    "example.com",
    "jane_doe@example1.com"
  ]
}
{
  "errors": [
    {
      "error_id": "velit pariatur est cupidatat",
      "field": null,
      "message": "cillum id veniam",
      "parameter": "dolore culpa ut non veniam"
    },
    {
      "error_id": "aliqua cupidatat",
      "field": null,
      "message": "eu consequat sed amet ea",
      "parameter": "proident ipsum pariatur"
    },
    {
      "error_id": "Ut ut cillum id tempor",
      "field": "amet et",
      "message": "magna",
      "parameter": "Excepteur"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sed Excepteur Duis deserunt voluptate",
      "field": "eu",
      "message": "consequat magna dolore nostrud Ut",
      "parameter": "ut id adipisicing non"
    },
    {
      "error_id": "aliquip Duis",
      "field": null,
      "message": "velit culpa aliqua",
      "parameter": "ad anim elit in veniam"
    },
    {
      "error_id": "sint non nisi in",
      "field": "Ut deserunt",
      "message": "mollit nostrud nisi",
      "parameter": "sunt amet sint"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ad minim exercitation anim non",
      "field": null,
      "message": "consectetur",
      "parameter": "ullamco ipsum sit aliqua non"
    },
    {
      "error_id": "officia",
      "field": "in Lorem",
      "message": "dolore nulla",
      "parameter": "ullamco sed consequat magna laboris"
    },
    {
      "error_id": "officia sunt fugiat",
      "field": null,
      "message": "eiusmod commodo",
      "parameter": "adipisicing proident in"
    },
    {
      "error_id": "aliqua",
      "field": null,
      "message": "in cupidatat ut eiusmod et",
      "parameter": "velit ullamco Ut ut anim"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "nulla mollit aliquip",
      "field": "ut",
      "message": "cupidatat Ut eiusmod",
      "parameter": "quis et dolor"
    },
    {
      "error_id": "labore ut",
      "field": null,
      "message": "non voluptate elit Lorem irure",
      "parameter": "et"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "irure culpa",
      "field": "ea Lorem minim officia incididunt",
      "message": "non nostrud",
      "parameter": "fugiat"
    },
    {
      "error_id": "commodo",
      "field": null,
      "message": "irure sit Excepteur ullamco",
      "parameter": "pariatur eu"
    }
  ]
}
Header NameExample
on-behalf-of"aute labore"
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": "id Lorem aute pariatur",
      "field": "nulla qui aliqua quis Excepteur",
      "message": "velit qui et",
      "parameter": "non aliquip dolore"
    },
    {
      "error_id": "amet consectetur Lorem magna",
      "field": null,
      "message": "aliquip eu elit",
      "parameter": "aliqua tempor minim"
    },
    {
      "error_id": "Duis consequat voluptate ea enim",
      "field": "in qui Duis nostrud",
      "message": "laborum ea laboris",
      "parameter": "in nulla aute"
    },
    {
      "error_id": "ad qui in sed",
      "field": "anim ex ullamco enim est",
      "message": "laborum",
      "parameter": "pariatur dolor in ad"
    },
    {
      "error_id": "eiusmod ex quis amet",
      "field": null,
      "message": "sed officia",
      "parameter": "aliqua consequat Ut Duis"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ut fugiat consectetur tempor",
      "field": null,
      "message": "exercitation laborum in culpa reprehenderit",
      "parameter": "ullamco Ut in proident irure"
    },
    {
      "error_id": "ex qui",
      "field": "magna nisi",
      "message": "exercitation",
      "parameter": "ea sit aute incididunt cillum"
    },
    {
      "error_id": "Ut",
      "field": "ad in minim culpa ipsum",
      "message": "amet aliquip",
      "parameter": "ad enim tempor in"
    },
    {
      "error_id": "voluptate Lorem anim",
      "field": "quis",
      "message": "qui aute fugiat",
      "parameter": "reprehenderit ex incididunt"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ea id",
      "field": null,
      "message": "in veniam officia",
      "parameter": "elit dolor aliqua Lorem"
    },
    {
      "error_id": "dolor est et fugiat",
      "field": "do consequat et",
      "message": "aliqua pariatur velit incididunt irure",
      "parameter": "ex"
    },
    {
      "error_id": "culpa elit sit",
      "field": null,
      "message": "est do eu labore Excepteur",
      "parameter": "cupidatat"
    },
    {
      "error_id": "irure fugiat dolor et",
      "field": "fugiat",
      "message": "Excepteur laboris",
      "parameter": "dolor eiusmod"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "deserunt incididunt",
      "field": "velit in",
      "message": "consequat enim minim dolore laboris",
      "parameter": "nostrud"
    },
    {
      "error_id": "aliquip in adipisicing ex",
      "field": "Lorem deserunt ullamco ea Excepteur",
      "message": "proident officia",
      "parameter": "laborum ipsum esse cupidatat"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ut ut dolore officia",
      "field": null,
      "message": "laboris",
      "parameter": "commodo eu eiusmod"
    },
    {
      "error_id": "Excepteur reprehenderit aute sint",
      "field": "eu",
      "message": "in",
      "parameter": "veniam est Lorem"
    },
    {
      "error_id": "culpa ex irure",
      "field": null,
      "message": "eu",
      "parameter": "non nisi adipisicing"
    }
  ]
}
Header NameExample
on-behalf-of"adipisicing ut ex"
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": "Excepteur est",
      "field": null,
      "message": "id occaecat aliquip sunt cupidatat",
      "parameter": "anim aute Excepteur consectetur"
    },
    {
      "error_id": "do nisi",
      "field": "veniam ea exercitation laborum culpa",
      "message": "qui sint",
      "parameter": "nostrud sint reprehenderit"
    },
    {
      "error_id": "ut nulla sunt anim eu",
      "field": null,
      "message": "proident dolor ut",
      "parameter": "ut sed irure aute cillum"
    },
    {
      "error_id": "nisi in ex",
      "field": null,
      "message": "dolor in et ut dolore",
      "parameter": "mollit consectetur qui voluptate nostrud"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "consectetur eiusmod in",
      "field": null,
      "message": "est dolore enim anim",
      "parameter": "enim magna aliqua eiusmod et"
    },
    {
      "error_id": "Lorem ea",
      "field": "cillum magna",
      "message": "occaecat",
      "parameter": "reprehenderit dolor"
    },
    {
      "error_id": "laboris",
      "field": "mollit sit",
      "message": "sint",
      "parameter": "qui"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "laboris",
      "field": null,
      "message": "dolore occaecat",
      "parameter": "deserunt laborum qui id"
    },
    {
      "error_id": "exercitation irure nostrud ut",
      "field": null,
      "message": "Excepteur dolor veniam",
      "parameter": "reprehenderit elit"
    },
    {
      "error_id": "officia aute",
      "field": null,
      "message": "exercitation ullamco laboris",
      "parameter": "culpa ipsum commodo elit laboris"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "minim et sit fugiat",
      "field": "fugiat sunt quis officia labore",
      "message": "occaecat id",
      "parameter": "irure"
    },
    {
      "error_id": "qui minim dolor",
      "field": null,
      "message": "do cupidatat officia",
      "parameter": "adipisicing Lorem"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "tempor",
      "field": null,
      "message": "nulla",
      "parameter": "in"
    },
    {
      "error_id": "nulla veniam Ut adipisicing",
      "field": "non ut id commodo",
      "message": "proident eiusmod laboris",
      "parameter": "Excepteur"
    },
    {
      "error_id": "laborum consequat cupidatat sint",
      "field": "in sit aute",
      "message": "elit veniam tempor",
      "parameter": "cillum"
    },
    {
      "error_id": "deserunt sunt irure Ut",
      "field": null,
      "message": "irure quis elit veniam ut",
      "parameter": "dolore"
    }
  ]
}
Header NameExample
on-behalf-of"ea Excepteur Lorem ex voluptate"
Request Payload
{
  "email": "abuse@example.com",
  "enabled": true
}
Response Payload
{
  "email": "abuse@example.com",
  "enabled": true
}
{
  "errors": [
    {
      "error_id": "ex ea",
      "field": "adipisicing eu mollit sunt",
      "message": "occaecat voluptate eiusmod",
      "parameter": "eiusmod"
    },
    {
      "error_id": "laborum aliqua qui non",
      "field": "et aliqua Lorem",
      "message": "voluptate ex",
      "parameter": "deserunt mollit id dolore elit"
    },
    {
      "error_id": "laboris ut",
      "field": "ad labore nisi ea",
      "message": "ea reprehenderit enim sit Duis",
      "parameter": "pariatur dolore deserunt qui"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "occaecat ut",
      "field": "esse",
      "message": "in",
      "parameter": "aliqua officia cupidatat veniam eiusmod"
    },
    {
      "error_id": "magna",
      "field": "irure ea laborum ullamco voluptate",
      "message": "consequat in",
      "parameter": "ut velit sint"
    },
    {
      "error_id": "laboris exercitation enim eiusmod ut",
      "field": null,
      "message": "aliqua eiusmod ipsum",
      "parameter": "voluptate nisi"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "velit sunt",
      "field": null,
      "message": "nostrud ut",
      "parameter": "et sit"
    },
    {
      "error_id": "aliquip exercitation",
      "field": "adipisicing aliqua sit incididunt",
      "message": "nostrud aliquip nulla consequat",
      "parameter": "tempor non exercitation"
    },
    {
      "error_id": "in enim fugiat",
      "field": "Excepteur",
      "message": "magna ex cupidatat",
      "parameter": "nulla sed sint reprehenderit consequat"
    },
    {
      "error_id": "enim",
      "field": null,
      "message": "in",
      "parameter": "eiusmod commodo"
    },
    {
      "error_id": "ex sit laborum fugiat",
      "field": null,
      "message": "enim dolor",
      "parameter": "deserunt adipisicing Lorem"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "amet Excepteur",
      "field": null,
      "message": "consectetur dolore enim velit ex",
      "parameter": "enim magna"
    },
    {
      "error_id": "exercitation aute",
      "field": "exercitation ut est qui",
      "message": "Duis voluptate amet aliqua mollit",
      "parameter": "amet quis voluptate"
    },
    {
      "error_id": "Duis dolor nulla qui eiusmod",
      "field": null,
      "message": "sit ipsum",
      "parameter": "eiusmod nostrud"
    },
    {
      "error_id": "Ut",
      "field": "dolor",
      "message": "fugiat consectetur",
      "parameter": "esse officia mollit consequat"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "culpa aliqua incididunt ad dolor",
      "field": null,
      "message": "dolore",
      "parameter": "cillum esse"
    },
    {
      "error_id": "Duis in Lorem",
      "field": null,
      "message": "officia esse exercitation",
      "parameter": "anim consequat veniam labore"
    },
    {
      "error_id": "enim anim sunt",
      "field": "sit cillum quis sed",
      "message": "proident",
      "parameter": "ut anim"
    }
  ]
}
Header NameExample
on-behalf-of"in ex"
Request Payload
Response Payload
{
  "email": "abuse@example.com",
  "enabled": true
}
{
  "errors": [
    {
      "error_id": "occaecat elit do",
      "field": null,
      "message": "et fugiat voluptate",
      "parameter": "sit"
    },
    {
      "error_id": "aute",
      "field": "magna",
      "message": "elit dolore irure aliquip proident",
      "parameter": "aliquip officia nulla"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "laboris",
      "field": "cillum laboris ut fugiat",
      "message": "ipsum voluptate non",
      "parameter": "ad minim commodo"
    },
    {
      "error_id": "ad",
      "field": null,
      "message": "nulla est in",
      "parameter": "qui ad"
    },
    {
      "error_id": "quis ullamco Lorem fugiat est",
      "field": null,
      "message": "dolor sed ut culpa",
      "parameter": "ad"
    },
    {
      "error_id": "Duis voluptate labore sunt",
      "field": "commodo tempor in deserunt eu",
      "message": "voluptate magna incididunt et",
      "parameter": "in reprehenderit"
    },
    {
      "error_id": "Ut aliquip nulla sint enim",
      "field": null,
      "message": "aute aliqua Lorem ut",
      "parameter": "dolor amet eu"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "dolore sunt",
      "field": "consectetur dolore sed",
      "message": "eu veniam magna",
      "parameter": "consectetur aliquip Lorem tempor"
    },
    {
      "error_id": "cupidatat officia anim sed",
      "field": "anim et laborum minim",
      "message": "ullamco",
      "parameter": "Lorem"
    },
    {
      "error_id": "qui laborum minim",
      "field": "Lorem culpa ullamco ea",
      "message": "enim adipisicing",
      "parameter": "anim amet enim mollit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "laborum veniam ipsum",
      "field": "aliqua elit",
      "message": "nostrud aute consequat velit",
      "parameter": "sunt"
    },
    {
      "error_id": "laboris id in veniam ut",
      "field": "officia ea reprehenderit",
      "message": "ullamco incididunt commodo quis",
      "parameter": "ipsum Excepteur id officia"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "fugiat",
      "field": null,
      "message": "id magna Excepteur",
      "parameter": "enim esse ut in do"
    },
    {
      "error_id": "ut",
      "field": "do laboris",
      "message": "veniam reprehenderit dolore",
      "parameter": "tempor"
    },
    {
      "error_id": "velit ullamco",
      "field": null,
      "message": "ad sunt elit et laboris",
      "parameter": "fugiat"
    },
    {
      "error_id": "nisi dolore",
      "field": null,
      "message": "ad esse do sint",
      "parameter": "ex"
    },
    {
      "error_id": "pariatur",
      "field": "id eiusmod",
      "message": "ut",
      "parameter": "cillum sit incididunt"
    }
  ]
}
Header NameExample
on-behalf-of"nisi officia laborum"
Request Payload
{
  "enabled": true,
  "html_content": "<% body %>"
}
Response Payload
{
  "enabled": false,
  "html_content": "<p><% body %>Example</p>\n"
}
{
  "errors": [
    {
      "error_id": "ut",
      "field": null,
      "message": "adipisicing officia consequat eu laboris",
      "parameter": "irure exercitation sunt ut sed"
    },
    {
      "error_id": "adipisicing consequat mollit",
      "field": null,
      "message": "adipisicing",
      "parameter": "ea esse laborum Excepteur ad"
    },
    {
      "error_id": "dolore",
      "field": "magna deserunt anim",
      "message": "magna veniam nulla anim pariatur",
      "parameter": "pariatur quis incididunt"
    },
    {
      "error_id": "Lorem eiusmod",
      "field": "proident velit",
      "message": "labore non nulla eiusmod proident",
      "parameter": "nulla proident sunt eu cupidatat"
    },
    {
      "error_id": "sit consequat Duis ipsum",
      "field": "enim reprehenderit anim cupidatat",
      "message": "fugiat cupidatat dolore",
      "parameter": "adipisicing sit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "in et",
      "field": "proident non ea",
      "message": "enim",
      "parameter": "Lorem cupidatat in"
    },
    {
      "error_id": "enim cupidatat reprehenderit",
      "field": null,
      "message": "Excepteur minim",
      "parameter": "culpa eu ea in"
    },
    {
      "error_id": "exercitation",
      "field": "consectetur adipisicing minim ut",
      "message": "laborum",
      "parameter": "aliquip laborum amet anim in"
    },
    {
      "error_id": "Ut officia",
      "field": null,
      "message": "irure",
      "parameter": "consectetur"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "nisi cupidatat Ut cillum enim",
      "field": "nulla ea mollit fugiat do",
      "message": "nisi irure occaecat",
      "parameter": "aliquip laborum quis et labore"
    },
    {
      "error_id": "nostrud id sunt eiusmod",
      "field": "cupidatat ut",
      "message": "reprehenderit esse sed mollit commodo",
      "parameter": "non"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "esse qui ut",
      "field": "aliqua Excepteur ex",
      "message": "cillum velit incididunt nisi consequat",
      "parameter": "enim qui"
    },
    {
      "error_id": "ut ad do Ut deserunt",
      "field": "non dolore nostrud culpa quis",
      "message": "eiusmod Duis",
      "parameter": "enim amet ea"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "in commodo velit",
      "field": null,
      "message": "deserunt nulla ullamco",
      "parameter": "adipisicing nisi sunt exercitation magna"
    },
    {
      "error_id": "do mollit Duis cupidatat pariatur",
      "field": null,
      "message": "voluptate",
      "parameter": "pariatur ut dolore in"
    },
    {
      "error_id": "Lorem aliqua aute",
      "field": "aute dolor labore",
      "message": "reprehenderit do",
      "parameter": "occaecat dolore minim sit consequat"
    },
    {
      "error_id": "aliqua",
      "field": "eu fugiat",
      "message": "consectetur Excepteur mollit incididunt ut",
      "parameter": "eu"
    }
  ]
}
Header NameExample
on-behalf-of"non cupidatat"
Request Payload
Response Payload
{
  "enabled": false,
  "html_content": "<p><% body %>Example</p>\n"
}
{
  "errors": [
    {
      "error_id": "nostrud voluptate ut aliquip",
      "field": null,
      "message": "ut dolore incididunt proident cillum",
      "parameter": "eiusmod amet elit dolor"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ea occaecat cillum reprehenderit",
      "field": null,
      "message": "aliquip in",
      "parameter": "laborum reprehenderit"
    },
    {
      "error_id": "laborum id",
      "field": "dolor",
      "message": "dolor",
      "parameter": "sed"
    },
    {
      "error_id": "aliqua enim deserunt mollit",
      "field": null,
      "message": "pariatur dolore cupidatat commodo eiusmod",
      "parameter": "ut magna dolore"
    },
    {
      "error_id": "ipsum id cupidatat Excepteur aliqua",
      "field": null,
      "message": "consequat sint in",
      "parameter": "in exercitation officia ad"
    },
    {
      "error_id": "tempor id nostrud Duis sed",
      "field": null,
      "message": "sint quis veniam ut",
      "parameter": "id adipisicing laborum Excepteur"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "id dolore est ipsum",
      "field": null,
      "message": "in nostrud amet sunt",
      "parameter": "esse sit dolor laboris fugiat"
    },
    {
      "error_id": "velit tempor culpa do",
      "field": "fugiat in",
      "message": "nostrud Lorem tempor",
      "parameter": "sit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "fugiat elit Duis",
      "field": "aliqua dolore",
      "message": "laboris velit deserunt",
      "parameter": "dolore"
    },
    {
      "error_id": "sunt aliqua",
      "field": null,
      "message": "qui Excepteur ipsum adipisicing",
      "parameter": "aute irure ut ea sit"
    },
    {
      "error_id": "exercitation dolor labore officia",
      "field": "velit id ipsum occaecat",
      "message": "qui magna amet do cupidatat",
      "parameter": "veniam"
    },
    {
      "error_id": "voluptate incididunt",
      "field": null,
      "message": "minim in dolor laborum",
      "parameter": "et ut"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "tempor Ut",
      "field": "Excepteur",
      "message": "Ut incididunt elit ad in",
      "parameter": "dolor fugiat nostrud sit est"
    },
    {
      "error_id": "Excepteur consectetur minim do enim",
      "field": "esse cupidatat exercitation",
      "message": "id mollit nostrud",
      "parameter": "sed"
    },
    {
      "error_id": "irure culpa",
      "field": "consequat Lorem ullamco elit",
      "message": "nostrud ea veniam in",
      "parameter": "velit"
    },
    {
      "error_id": "cillum Duis velit sint mollit",
      "field": "eiusmod dolore dolore",
      "message": "consectetur minim dolore",
      "parameter": "cupidatat"
    },
    {
      "error_id": "magna et",
      "field": null,
      "message": "nulla",
      "parameter": "aliqua dolor esse ut"
    }
  ]
}
Header NameExample
on-behalf-of"in cupidatat ut"
Request Payload
{
  "enabled": true,
  "hard_bounces": 5,
  "soft_bounces": 5
}
Response Payload
{
  "enabled": false,
  "hard_bounces": 5,
  "soft_bounces": 5
}
{
  "errors": [
    {
      "error_id": "do laboris aliqua voluptate Ut",
      "field": null,
      "message": "aliquip ullamco labore fugiat qui",
      "parameter": "ea fugiat et exercitation"
    },
    {
      "error_id": "eu Excepteur",
      "field": null,
      "message": "elit labore veniam dolore",
      "parameter": "dolore sed nisi"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "consectetur ex do",
      "field": "sunt aliqua ut do",
      "message": "quis Duis Lorem magna",
      "parameter": "exercitation ex velit Excepteur Lorem"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "eiusmod",
      "field": "Excepteur",
      "message": "pariatur magna",
      "parameter": "Ut culpa ea et"
    },
    {
      "error_id": "ad amet minim",
      "field": "enim aute",
      "message": "deserunt nostrud tempor ullamco est",
      "parameter": "quis officia fugiat dolore enim"
    },
    {
      "error_id": "ipsum qui Duis esse",
      "field": "veniam sit",
      "message": "Excepteur deserunt qui",
      "parameter": "velit"
    },
    {
      "error_id": "irure cupidatat",
      "field": "dolor eiusmod veniam laboris",
      "message": "nisi ad",
      "parameter": "pariatur"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ad consectetur",
      "field": null,
      "message": "aliquip incididunt ut in fugiat",
      "parameter": "proident minim ea Excepteur"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "nulla ullamco eu voluptate",
      "field": "dolore deserunt",
      "message": "nulla ipsum aliquip sunt aute",
      "parameter": "veniam culpa sunt"
    }
  ]
}
Header NameExample
on-behalf-of"est"
Request Payload
Response Payload
{
  "enabled": false,
  "soft_bounces": 5,
  "hard_bounces": 5
}
{
  "errors": [
    {
      "error_id": "enim dolor veniam ad",
      "field": "incididunt fugiat magna amet officia",
      "message": "elit in non",
      "parameter": "et"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "culpa Lorem",
      "field": null,
      "message": "aliqua Excepteur quis eiusmod",
      "parameter": "consequat Excepteur ex"
    },
    {
      "error_id": "aliquip sunt Lorem Duis",
      "field": null,
      "message": "in velit quis Ut",
      "parameter": "aute ad Ut"
    },
    {
      "error_id": "aute ad laboris veniam est",
      "field": "adipisicing culpa",
      "message": "reprehenderit in voluptate",
      "parameter": "ut culpa"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ipsum dolore aliquip amet",
      "field": null,
      "message": "officia sint esse",
      "parameter": "qui est cillum"
    },
    {
      "error_id": "consequat sunt",
      "field": "ullamco consequat dolor commodo veniam",
      "message": "in ad",
      "parameter": "labore pariatur deserunt dolore"
    },
    {
      "error_id": "Lorem ea qui",
      "field": "nulla minim",
      "message": "cupidatat",
      "parameter": "exercitation veniam ullamco"
    },
    {
      "error_id": "do qui",
      "field": "Duis commodo",
      "message": "labore aute reprehenderit adipisicing",
      "parameter": "ex deserunt sit"
    },
    {
      "error_id": "enim adipisicing laboris dolore cupidatat",
      "field": "irure aliquip ut",
      "message": "ad",
      "parameter": "anim fugiat voluptate"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ipsum amet ut",
      "field": "cillum nisi consectetur esse",
      "message": "do ut eiusmod aliquip",
      "parameter": "eu aute veniam incididunt"
    },
    {
      "error_id": "id nulla Lorem",
      "field": null,
      "message": "adipisicing enim nulla fugiat officia",
      "parameter": "esse ullamco laboris non"
    },
    {
      "error_id": "reprehenderit irure tempor",
      "field": "Ut sint veniam laborum",
      "message": "in",
      "parameter": "consectetur cupidatat"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "esse ad",
      "field": null,
      "message": "ea",
      "parameter": "dolore in minim et commodo"
    },
    {
      "error_id": "ut",
      "field": "reprehenderit",
      "message": "sed occaecat",
      "parameter": "in incididunt consequat"
    },
    {
      "error_id": "in",
      "field": "adipisicing proident dolor",
      "message": "consectetur",
      "parameter": "cupidatat dolor labore mollit"
    },
    {
      "error_id": "dolor Lorem deserunt reprehenderit occaecat",
      "field": null,
      "message": "qui veniam tempor id nulla",
      "parameter": "sed est occaecat"
    }
  ]
}
Header NameExample
on-behalf-of"reprehenderit"
Request Payload
{
  "enabled": true,
  "email": "bounces@example.com"
}
Response Payload
{
  "email": "bounces@example.com",
  "enabled": true
}
{
  "errors": [
    {
      "error_id": "id",
      "field": null,
      "message": "dolore",
      "parameter": "cupidatat aliquip consectetur ex dolore"
    },
    {
      "error_id": "aliquip esse ex",
      "field": "et",
      "message": "sint Lorem",
      "parameter": "Ut"
    },
    {
      "error_id": "in consectetur tempor dolor Excepteur",
      "field": null,
      "message": "fugiat proident dolor nisi",
      "parameter": "laborum do"
    },
    {
      "error_id": "in esse incididunt minim",
      "field": "et occaecat id laboris",
      "message": "Excepteur dolor dolore ullamco in",
      "parameter": "sit officia"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "anim nostrud dolore",
      "field": null,
      "message": "et aute sed",
      "parameter": "ipsum nisi"
    },
    {
      "error_id": "aliquip",
      "field": null,
      "message": "nulla officia",
      "parameter": "quis culpa id laboris commodo"
    },
    {
      "error_id": "ullamco ad esse dolore",
      "field": null,
      "message": "laboris",
      "parameter": "est"
    },
    {
      "error_id": "dolore laborum in enim velit",
      "field": null,
      "message": "veniam cillum",
      "parameter": "et ex in aliquip"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "in consectetur anim",
      "field": "velit sit nisi magna",
      "message": "dolor",
      "parameter": "sed sint nostrud dolore"
    },
    {
      "error_id": "ut qui aute deserunt reprehenderit",
      "field": null,
      "message": "ullamco ut esse cupidatat",
      "parameter": "dolor magna"
    },
    {
      "error_id": "in reprehenderit dolor proident",
      "field": null,
      "message": "amet cupidatat",
      "parameter": "sint enim"
    },
    {
      "error_id": "tempor nostrud laborum",
      "field": "quis aliqua esse",
      "message": "officia",
      "parameter": "occaecat eiusmod enim"
    },
    {
      "error_id": "pariatur",
      "field": "irure esse ut",
      "message": "dolore eiusmod",
      "parameter": "est eu do amet culpa"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "cupidatat dolor dolor proident ut",
      "field": null,
      "message": "qui culpa sunt dolor",
      "parameter": "mollit ipsum Lorem pariatur est"
    },
    {
      "error_id": "eiusmod dolore dolor id in",
      "field": "officia cillum magna consequat nulla",
      "message": "Excepteur",
      "parameter": "do"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ut enim",
      "field": null,
      "message": "laboris",
      "parameter": "Lorem nulla reprehenderit Ut"
    },
    {
      "error_id": "in exercitation nisi",
      "field": "labore Duis irure aliquip",
      "message": "deserunt quis commodo",
      "parameter": "elit"
    },
    {
      "error_id": "sunt dolor",
      "field": "aliquip",
      "message": "dolor",
      "parameter": "eiusmod sint magna"
    }
  ]
}
Header NameExample
on-behalf-of"dolor cillum consequat"
Request Payload
Response Payload
{
  "enabled": true,
  "email": "bounces@example.com"
}
{
  "errors": [
    {
      "error_id": "ex nisi",
      "field": null,
      "message": "proident",
      "parameter": "occaecat id nisi ut"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "reprehenderit dolor in ad laborum",
      "field": null,
      "message": "nostrud do labore incididunt",
      "parameter": "ut ut esse Excepteur cillum"
    },
    {
      "error_id": "adipisicing",
      "field": null,
      "message": "aliqua in",
      "parameter": "dolor fugiat"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "veniam tempor enim",
      "field": "minim ullamco eiusmod",
      "message": "ex ut dolore",
      "parameter": "qui ut veniam"
    },
    {
      "error_id": "aute esse do",
      "field": null,
      "message": "officia",
      "parameter": "dolore Duis velit nostrud"
    },
    {
      "error_id": "eu irure aliquip",
      "field": null,
      "message": "sed exercitation voluptate velit in",
      "parameter": "deserunt exercitation occaecat fugiat ullamco"
    },
    {
      "error_id": "nisi laborum dolore",
      "field": null,
      "message": "ut ex Ut dolore",
      "parameter": "Duis cillum aute eu nisi"
    },
    {
      "error_id": "labore dolore aliqua enim ipsum",
      "field": null,
      "message": "incididunt tempor",
      "parameter": "consequat commodo ut minim qui"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "eiusmod enim aliquip",
      "field": null,
      "message": "enim non Excepteur deserunt ea",
      "parameter": "cillum occaecat adipisicing aute"
    },
    {
      "error_id": "enim veniam",
      "field": null,
      "message": "et nostrud",
      "parameter": "pariatur Duis"
    },
    {
      "error_id": "ut sit",
      "field": "ut Ut",
      "message": "incididunt Lorem tempor",
      "parameter": "ullamco velit cillum"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "deserunt dolor",
      "field": "nostrud",
      "message": "et do",
      "parameter": "Excepteur"
    }
  ]
}

Settings - Partner(3 operations)

Header NameExample
on-behalf-of"laborum Duis proident"
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"enim tempor mollit voluptate"
Request Payload
Response Payload
{
  "enable_subuser_statistics": false,
  "enabled": true,
  "license_key": ""
}
Query Parameter NameExample
limit-22338106
offset5267657
Header NameExample
on-behalf-of"occaecat veniam deserunt cupidatat voluptate"
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"voluptate"
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": "veniam",
      "field": "et"
    },
    {
      "message": "aliquip ut",
      "field": "pariatur amet et minim"
    }
  ]
}
Query Parameter NameExample
limit75
offset1733264
Header NameExample
on-behalf-of"velit sunt ex nostrud consectetur"
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 deserunt aliqua"
Request Payload
Response Payload
{
  "pending_id": "abc123abc",
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}
{
  "errors": [
    {
      "message": "invalid pending key",
      "field": "pending_key"
    }
  ]
}
Query Parameter NameExample
limit-2002101
offset86022630
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"eu veniam enim ad magna"
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"ea laborum id"
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"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"in"
Request Payload
Response Payload
{
  "errors": [
    {
      "message": "commodo dolore nostrud id",
      "field": "nisi pariatur proident"
    }
  ]
}
{
  "errors": [
    {
      "message": "username not found",
      "field": "username"
    }
  ]
}
Request Payload
Response Payload
{
  "scope_group_name": "Stats"
}
{}
{
  "errors": [
    {
      "message": "exercitation voluptate",
      "field": "elit voluptate irure dolore"
    },
    {
      "message": "id Ut culpa",
      "field": "ea sint ipsum minim voluptate"
    },
    {
      "message": "est in ullamco ut occaecat",
      "field": "cillum in amet eu do"
    },
    {
      "message": "ipsum incididunt aliqua magna",
      "field": "nostrud occaecat anim officia"
    }
  ]
}
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"magna eu laboris ea occaecat"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "aliqua in",
      "field": "dolore"
    },
    {
      "message": "minim nostrud",
      "field": "consequat"
    },
    {
      "message": "veniam sit",
      "field": "sed consectetur"
    },
    {
      "message": "ut aute veniam",
      "field": "aliquip veniam velit consequat dolore"
    },
    {
      "message": "Excepteur",
      "field": "ad in"
    }
  ]
}

Alerts(5 operations)

Header NameExample
Authorization"exercitation"
on-behalf-of"consequat mollit"
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": "officia",
  "message": "quis exercitation commodo elit"
}
Header NameExample
Authorization"ut fugiat eiusmod"
on-behalf-of"nostrud consequat et pariatur"
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"nulla minim incididunt"
on-behalf-of"Duis anim laboris magna dolor"
Request Payload
Response Payload
{
  "created_at": 1451520930,
  "email_to": "example@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451520930
}
Header NameExample
on-behalf-of"dolor quis ut amet cillum"
Request Payload
Response Payload
{}
Header NameExample
on-behalf-of"laborum"
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"magna velit"
Request Payload
Response Payload
{
  "address": "814 West Chapman Avenue",
  "address2": "",
  "city": "Orange",
  "company": "SendGrid",
  "country": "US",
  "first_name": "Test",
  "last_name": "User",
  "phone": "555-555-5555",
  "state": "CA",
  "website": "http://www.sendgrid.com",
  "zip": "92868"
}
Header NameExample
on-behalf-of"irure Ut sed laboris"
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"dolor magna reprehenderit pariatur"
Request Payload
Response Payload
{
  "reputation": 100,
  "type": "paid"
}
Header NameExample
on-behalf-of"adipisicing"
Request Payload
Response Payload
{
  "email": "test@example.com"
}
Header NameExample
on-behalf-of"ea pariatur dolor ipsum non"
Request Payload
{
  "email": "example@example.com"
}
Response Payload
{
  "email": "example@example.com"
}
Header NameExample
on-behalf-of"veniam Lorem mollit ea est"
Request Payload
Response Payload
{
  "username": "test_username",
  "user_id": 1
}
Header NameExample
on-behalf-of"enim dolor nisi non eiusmod"
Request Payload
{
  "username": "test_username"
}
Response Payload
{
  "username": "test_username"
}
Header NameExample
on-behalf-of"Excepteur ea labore"
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"amet eu dolor"
Request Payload
{
  "new_password": "new_password",
  "old_password": "old_password"
}
Response Payload
{}

Subusers API(6 operations)

Query Parameter NameExample
usernameUt do
limit30758713
offset11867158
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
usernamessunt ex commodo proident
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*incididunt esse pariatur
sort_by_metricnisi in dolore ut
sort_by_directiondesc
limit-85436582
offset-69501083
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*sunt labore nulla
subuserirure eu
sort_by_metricunique_clicks
sort_by_directiondesc
limit-39812642
offset-69499628
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*ut velit mollit esse culpa
end_datecillum sed magna reprehenderit
limit-56030020
offset47039850
aggregated_bymollit cupidatat id adipisicing
sort_by_metricut amet ad dolore
Request Payload
Response Payload
{
  "date": "2015-10-11",
  "stats": []
}
Query Parameter NameExample
limit-16433664
offset36025067
aggregated_bymonth
subusers*labore ullamco aute
start_date*nisi eiusmod dolore consectetur
end_dateesse pariatur reprehenderit ad minim
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"Lorem mollit officia"
Request Payload
{
  "ip": "192.168.1.1",
  "subdomain": "email",
  "domain": "example.com"
}
Response Payload
{
  "id": 123,
  "ip": "192.168.1.2",
  "rdns": "o1.email.example.com",
  "users": [],
  "subdomain": "email",
  "domain": "example.com",
  "valid": true,
  "legacy": false,
  "a_record": {
    "valid": true,
    "type": "a",
    "host": "o1.email.example.com",
    "data": "192.168.1.2"
  }
}
Query Parameter NameExample
limit-71300970
offset-66456571
ipcupidatat reprehenderit Duis dolor
Header NameExample
on-behalf-of"occaecat elit ullamco non"
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"nulla Ut magna Lorem"
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"adipisicing labore quis"
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"nisi magna"
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 commodo reprehenderit",
    "field": "ad eiusmod"
  }
}

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
ipculpa ex in quis
exclude_whitelabelsfalse
limit-42594238
offset1415551
subusernostrud ad incididunt commodo ipsum
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
limit71595761
offset-15447006
exclude_subuserstrue
usernameconsectetur eiusmod laboris aliqua
domainUt ad sed
Header NameExample
on-behalf-of"occaecat Excepteur"
Request Payload
Response Payload
[
  {
    "id": 1,
    "user_id": 7,
    "subdomain": "mail",
    "domain": "example.com",
    "username": "jane@example.com",
    "ips": [
      "192.168.1.1",
      "192.168.1.2"
    ],
    "custom_spf": true,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": true,
    "dns": {
      "mail_cname": {
        "valid": true,
        "type": "cname",
        "host": "mail.example.com",
        "data": "u7.wl.sendgrid.net"
      },
      "dkim1": {
        "valid": true,
        "type": "cname",
        "host": "s1._domainkey.example.com",
        "data": "s1._domainkey.u7.wl.sendgrid.net"
      },
      "dkim2": {
        "valid": true,
        "type": "cname",
        "host": "s2._domainkey.example.com",
        "data": "s2._domainkey.u7.wl.sendgrid.net"
      }
    }
  },
  {
    "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"quis in cillum"
Request Payload
{
  "domain": "example.com",
  "subdomain": "news",
  "username": "john@example.com",
  "ips": [
    "192.168.1.1",
    "192.168.1.2"
  ],
  "custom_spf": true,
  "default": true,
  "automatic_security": false
}
Response Payload
{
  "id": 302183,
  "user_id": 1446226,
  "subdomain": "example",
  "domain": "example.com",
  "username": "mbernier",
  "ips": [],
  "custom_spf": false,
  "default": true,
  "legacy": false,
  "automatic_security": true,
  "valid": false,
  "dns": {
    "mail_cname": {
      "valid": false,
      "type": "cname",
      "host": "example.example.com",
      "data": "u1446226.wl.sendgrid.net"
    },
    "dkim1": {
      "valid": false,
      "type": "cname",
      "host": "s1._domainkey.example.com",
      "data": "s1.domainkey.u1446226.wl.sendgrid.net"
    },
    "dkim2": {
      "valid": false,
      "type": "cname",
      "host": "s2._domainkey.example.com",
      "data": "s2.domainkey.u1446226.wl.sendgrid.net"
    }
  }
}
Header NameExample
on-behalf-of"ullamco ex sint"
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"Excepteur anim Ut laborum"
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"Lorem consectetur pariatur sunt"
Request Payload
Response Payload
{}
Query Parameter NameExample
domainsunt do Lorem
Header NameExample
on-behalf-of"consequat"
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"aliqua exercitation"
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"cillum adipisicing pariatur magna amet"
Request Payload
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "mail@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}
Header NameExample
on-behalf-of"dolore quis nostrud nulla"
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*in
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
usernamevoluptate 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": "eiusmod"
    },
    {
      "message": "qui incididunt Excepteur"
    }
  ]
}
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": "sit esse mollit ex"
    },
    {
      "message": "do nostrud eu"
    }
  ]
}
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": "officia sunt culpa",
      "message": "aliqua anim culpa",
      "error_id": "ipsum"
    },
    {
      "field": "sunt eu cillum",
      "message": "ut Excepteur",
      "error_id": "irure Duis consectetur nisi veniam"
    },
    {
      "field": "sunt cillum",
      "message": "ipsum sint sunt minim dolor",
      "error_id": "ex"
    },
    {
      "field": "consequat sunt",
      "message": "laboris veniam",
      "error_id": "dolore"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "non ullamco dolor labore dolore"
    },
    {
      "message": "tempor veniam"
    },
    {
      "message": "ipsum sed laboris nisi in"
    },
    {
      "message": "sunt dolor ullamco aute labore"
    },
    {
      "message": "Excepteur ut consequat esse nisi"
    }
  ]
}
Query Parameter NameExample
limit24905654.87056005
lastSeenID65926169.27086955
id-60649789
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": "sint proident in velit est"
    }
  ]
}
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": "et proident minim exercitation",
      "error_id": "exercitation adipisicing est"
    }
  ]
}
{
  "errors": [
    {
      "message": "ut"
    }
  ]
}
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": "nostrud sunt commodo est",
      "message": "occaecat",
      "error_id": "magna ex dolore in officia"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "deserunt",
      "error_id": "velit dolore consectetur qui incididunt"
    },
    {
      "message": "enim aliqua qui",
      "error_id": "Lorem"
    }
  ]
}
{
  "errors": [
    {
      "message": "mollit reprehenderit aliqua laborum labore",
      "error_id": "in eu"
    }
  ]
}
{
  "errors": [
    {
      "message": "dolore fugiat sunt"
    },
    {
      "message": "minim"
    },
    {
      "message": "Lorem laboris id elit nostrud"
    },
    {
      "message": "commodo amet proident nulla"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "elit Excepteur qui",
      "error_id": "Lorem"
    },
    {
      "message": "tempor aliqua quis",
      "error_id": "nulla dolore"
    }
  ]
}
{
  "errors": [
    {
      "message": "ipsum eiusmod",
      "error_id": "cillum adipisicing qui veniam"
    },
    {
      "message": "non dolor aliquip sint quis",
      "error_id": "quis consequat ullamco reprehenderit tempor"
    }
  ]
}
{
  "errors": [
    {
      "message": "aute"
    },
    {
      "message": "et enim deserunt ipsum non"
    },
    {
      "message": "deserunt sint incididunt cupidatat aliquip"
    },
    {
      "message": "cillum veniam"
    },
    {
      "message": "veniam Excepteur deserunt"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "message": "mollit commodo sunt id aliquip",
      "error_id": "Excepteur occaecat cupidatat"
    },
    {
      "message": "Lorem",
      "error_id": "aute"
    },
    {
      "message": "id",
      "error_id": "pariatur esse dolor commodo"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "amet nisi aute",
      "error_id": "consequat commodo"
    },
    {
      "message": "Ut pariatur",
      "error_id": "minim"
    },
    {
      "message": "ut id nostrud consectetur adipisicing",
      "error_id": "amet pariatur aliquip Ut"
    },
    {
      "message": "laborum aute",
      "error_id": "Duis in"
    }
  ]
}
{
  "errors": [
    {
      "message": "sint reprehenderit tempor dolor"
    },
    {
      "message": "Duis irure id"
    },
    {
      "message": "culpa"
    },
    {
      "message": "dolore tempor occaecat ex"
    },
    {
      "message": "consectetur"
    }
  ]
}

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

Contacts(13 operations)

Request Payload
{
  "list_ids": [
    "18e06e5a-bc2c-bbf3-cd0f-ad636dafa400"
  ],
  "contacts": [
    {
      "address_line_1": "magna nisi culpa cillu",
      "address_line_2": "voluptate",
      "alternate_emails": [
        "consectetur q",
        "ullamco pariatur reprehenderit",
        "ut irure",
        "sunt mollit",
        "consequat voluptate des"
      ],
      "city": "sint reprehenderit dolore",
      "country": "fug",
      "email": "adipisicing eiusmod elit",
      "first_name": "minim laborum",
      "last_name": "do sunt eiusmo",
      "postal_code": "consequat Duis non",
      "state_province_region": "quis",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "eu ipsum dolor laborum ea",
      "address_line_2": "proident mag",
      "alternate_emails": [
        "enim adipisicing",
        "labore voluptate incididunt Lorem",
        "pariatur eiusmod in minim dolore",
        "amet Excepteur",
        "cillum irur"
      ],
      "city": "Excepteur in ullamco non Ut",
      "country": "consectetur nisi co",
      "email": "anim Excepteur",
      "first_name": "in cillum",
      "last_name": "non ",
      "postal_code": "deserunt veniam nisi nostrud",
      "state_province_region": "irure Duis aliquip ipsum an",
      "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": "id aliqua laboris do dolor",
      "address_line_2": "officia enim dolore cupidatat sunt",
      "alternate_emails": [
        "culpa minim in",
        "Duis dolor quis veniam proident",
        "enim ipsum dolore minim sed",
        "nisi nostrud",
        "elit ullamco"
      ],
      "city": "ex",
      "country": "in",
      "email": "ad commodo",
      "first_name": "ullamco Duis oc",
      "last_name": "exercitation et cupidatat aliquip r",
      "postal_code": "qui commodo",
      "state_province_region": "nisi reprehenderit su",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "ad in",
      "address_line_2": "non commodo in minim amet",
      "alternate_emails": [
        "ut in enim ullamco Excepteur",
        "Lorem Ut ut in",
        "eu aliquip commodo",
        "veniam dolore sed dolor e",
        "do incididunt"
      ],
      "city": "labore",
      "country": "magna aliquip cupidatat",
      "email": "in nulla quis pari",
      "first_name": "eiusmod",
      "last_name": "minim in proident elit dolore",
      "postal_code": "ad",
      "state_province_region": "dolore",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "dolore",
      "address_line_2": "Duis",
      "alternate_emails": [
        "sint dolore pariatur",
        "nisi proident do",
        "aliquip aute nostrud ut",
        "ut",
        "ad nisi ea"
      ],
      "city": "ea in enim ipsum",
      "country": "voluptat",
      "email": "exercitation in",
      "first_name": "in enim velit",
      "last_name": "ex",
      "postal_code": "ut",
      "state_province_region": "Except",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "sint",
      "address_line_2": "adipisicing cupidata",
      "alternate_emails": [
        "proident in Excepteur ut",
        "aute",
        "minim ad",
        "fugiat aliquip in Ut",
        "do exercitation"
      ],
      "city": "cupidatat",
      "country": "officia",
      "email": "mollit reprehenderit sed eu",
      "first_name": "do laboris ",
      "last_name": "conseq",
      "postal_code": "in Excepteur consequat ea adipisicing",
      "state_province_region": "in et mollit",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "culpa",
      "address_line_2": "exercitation velit nisi eiusmod",
      "alternate_emails": [
        "id reprehenderit amet in fugiat",
        "aute ad do consectetu",
        "officia Duis nulla quis ullamco",
        "fugiat",
        "ipsum"
      ],
      "city": "nulla ",
      "country": "nisi laborum aliquip co",
      "email": "eiusmod",
      "first_name": "sit enim dolor officia",
      "last_name": "nostrud in aliquip deserunt",
      "postal_code": "reprehenderit",
      "state_province_region": "sunt sed 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": "incididunt nulla",
      "address_line_2": "magna vo",
      "alternate_emails": [
        "tempor mollit magna ut",
        "mollit l",
        "commodo est laboris sunt eu",
        "do et fugiat incididunt",
        "ipsum sint dolor minim"
      ],
      "city": "Ut culpa",
      "country": "minim ea",
      "email": "nisi",
      "first_name": "dolore sit in cupidatat",
      "last_name": "in ut do",
      "postal_code": "veniam elit",
      "state_province_region": "in amet commo",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "nulla sint",
      "address_line_2": "tempor dolore officia ",
      "alternate_emails": [
        "adipisicing magna consectetur",
        "laboris et fugi",
        "Duis adipisicing eiusmod pariatur",
        "do anim ipsum ut Excepteur",
        "sunt laboris"
      ],
      "city": "est ad Excepteur",
      "country": "laboris voluptate in nulla id",
      "email": "cupidatat",
      "first_name": "velit eiusmod",
      "last_name": "ullamco dolor",
      "postal_code": "laboris cupidatat id in consectetur",
      "state_province_region": "tempor no",
      "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": "cillum dolor",
      "address_line_2": "fugiat commodo anim occaecat",
      "alternate_emails": [
        "ipsum",
        "in",
        "nostrud pariatur deserunt veniam magna",
        "cupidatat voluptate labore aute",
        "culpa id ex Duis"
      ],
      "city": "esse magna pariatur",
      "country": "Ut commodo reprehenderit sed",
      "email": "ut sed Lorem laborum",
      "first_name": "adipisicin",
      "last_name": "deserunt",
      "postal_code": "ea labore dolor nisi incididunt",
      "state_province_region": "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."
      }
    }
  ]
}
Response Payload
{
  "job_id": "nostrud"
}
{
  "errors": [
    {
      "message": "adipisicing sint",
      "field": "do mollit dolor adipisicing ex",
      "error_id": "tempor ex",
      "parameter": "Duis"
    },
    {
      "message": "dolore",
      "field": "eu consectetur",
      "error_id": "culpa ipsum incididunt",
      "parameter": "in ipsum mollit sit Lorem"
    },
    {
      "message": "proident irure incididunt culpa",
      "field": "in Duis ipsum id consequat",
      "error_id": "incididunt",
      "parameter": "irure fugiat"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "consequat reprehenderit"
    }
  ]
}
Query Parameter NameExample
delete_all_contactsenim laborum culpa
idsreprehenderit fugiat
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": "Ut voluptate proident qui incididunt"
    },
    {
      "message": "pariatur"
    },
    {
      "message": "Ut Lorem eu qui"
    }
  ]
}
Request Payload
Response Payload
{
  "result": [
    {
      "id": "dolor Excepteur",
      "first_name": "Excepteur",
      "last_name": "deserunt",
      "unique_name": "aliquip do",
      "email": "laborum non cupidatat",
      "alternate_emails": [
        "labore consectetur"
      ],
      "address_line_1": "quis aute occaecat ipsum",
      "address_line_2": "aliquip Ut",
      "city": "non do commodo velit sint",
      "state_province_region": "cupidatat exercitation magna",
      "country": "reprehenderit sed in non",
      "postal_code": "aute ea incididunt",
      "phone_number": "reprehenderit",
      "whatsapp": "ut dolor",
      "line": "incididunt proident sed culpa",
      "facebook": "sed pariatur",
      "list_ids": [
        "elit",
        "sint",
        "eiusmod voluptate adipisicing",
        "ad",
        "consectetur enim labore cillum exercitation"
      ],
      "segment_ids": [
        "aute",
        "eiusmod eu tempor elit",
        "sed est ut ipsum ex",
        "consequat incididunt",
        "proident labore sint"
      ],
      "custom_fields": {},
      "created_at": "in cillum est occaecat",
      "updated_at": "dolor veniam",
      "_metadata": {
        "self": "id in"
      }
    },
    {
      "id": "ad dolore consectetur",
      "first_name": "est nulla Excepteur ex",
      "last_name": "Excepteur incididunt aliqua sint",
      "unique_name": "non deserunt elit Ut",
      "email": "sint mollit nostrud",
      "alternate_emails": [
        "fugiat voluptate est amet dolore",
        "ea minim veniam in ut",
        "non dolore",
        "aliqua"
      ],
      "address_line_1": "nulla reprehenderit",
      "address_line_2": "Excepteur minim",
      "city": "ullamco sunt",
      "state_province_region": "aliqua Lorem ex",
      "country": "exercitation et",
      "postal_code": "et pariatur nulla dolor",
      "phone_number": "id in laboris",
      "whatsapp": "ea eiusmod minim",
      "line": "ullamco ut",
      "facebook": "nulla ad",
      "list_ids": [
        "non deserunt eiusmod",
        "ut Ut proident"
      ],
      "segment_ids": [
        "in",
        "nulla occaecat"
      ],
      "custom_fields": {},
      "created_at": "sint ut Lorem aliquip",
      "updated_at": "elit",
      "_metadata": {
        "self": "laborum amet dolor tempor"
      }
    }
  ],
  "_metadata": {
    "self": "ullamco labore"
  },
  "contact_count": 66884870
}
{
  "errors": [
    {
      "message": "sunt minim deserunt sint",
      "field": "aute mollit",
      "error_id": "culpa cupidatat",
      "parameter": "aute aliqua Duis Ut qui"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "consectetur nostrud est"
    },
    {
      "message": "dolore do"
    }
  ]
}
Request Payload
Response Payload
{
  "contact_count": -57428965,
  "billable_count": 39994453,
  "billable_breakdown": {
    "total": -6635930,
    "breakdown": {}
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "id magna veniam"
    },
    {
      "message": "adipisicing aliquip"
    }
  ]
}
Request Payload
{
  "list_ids": [
    "e54fbeb4-20d2-3ef5-d2c0-a5a7fba381cc",
    "83071082-a8b2-e7aa-34c5-27f28aadcad3",
    "beab1ff8-90e2-473a-2a43-c9348e77865a"
  ],
  "segment_ids": [
    "velit laborum irure",
    "nulla"
  ],
  "notifications": {
    "email": true
  },
  "file_type": "json",
  "max_file_size": 55665945
}
Response Payload
{
  "_metadata": {
    "prev": "http://PSAxudpvJTkUAhUHiGzhA.usidZgpdWuGOO7c2Jlfida523QYEJcPjRb-ZibJMfoowWpRfWW8",
    "self": "http://xPpjVguPCJQcYO.jbqNOtdur6QHkBrQ36",
    "next": "https://gzrdRHeAIQyaJrsfDrhgXmuZlsppGqBw.vmcU+zZsXf.TgJl",
    "count": 79220927.68611968
  },
  "id": "ut aliquip"
}
{
  "errors": [
    {
      "message": "tempor",
      "field": "exercitation",
      "error_id": "sint fugiat dolore anim aute",
      "parameter": "fugiat sint"
    },
    {
      "message": "commodo culpa in",
      "field": "non ullamco labore Lorem",
      "error_id": "eiusmod",
      "parameter": "nostrud Lorem consectetur consequat"
    },
    {
      "message": "ut",
      "field": "cillum enim Ut",
      "error_id": "minim eu nulla non ex",
      "parameter": "culpa consectetur reprehenderit"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "occaecat ullamco"
    },
    {
      "message": "irure elit in Lorem dolor"
    },
    {
      "message": "amet in proident"
    },
    {
      "message": "dolor"
    },
    {
      "message": "proident exercitation"
    }
  ]
}
Request Payload
Response Payload
{
  "result": [
    {
      "id": "veniam Lorem elit officia tempor",
      "status": "aliquip nisi officia ut",
      "created_at": "eiusmod magna",
      "completed_at": "Duis ut",
      "expires_at": "nisi non",
      "urls": [
        "sit dolor non labore",
        "dolore ex Duis et sit",
        "ut",
        "ad mollit labore",
        "esse officia qui enim consectetur"
      ],
      "user_id": "veniam cillum Lorem",
      "export_type": "non",
      "segments": [
        {
          "ID": "eu occaecat dolor esse qui",
          "Name": "in cupidatat labore Ut dolore"
        }
      ],
      "lists": [
        {
          "ID": "esse in mollit veniam",
          "Name": "amet"
        }
      ],
      "_metadata": {
        "prev": "cillum in",
        "self": "non ex amet elit aliqua",
        "next": "esse amet sint voluptate in"
      }
    },
    {
      "id": "consequat laboris dolor laborum amet",
      "status": "reprehenderit est Lorem ut velit",
      "created_at": "Duis ipsum ullamco exercitation veniam",
      "completed_at": "adipisicing nisi dolore",
      "expires_at": "et Ut id veniam",
      "urls": [
        "in",
        "ea occaecat",
        "aute cupidatat",
        "culpa esse nisi magna"
      ],
      "user_id": "proident sunt exercitation",
      "export_type": "nulla Excepteur magna aliqua sint",
      "segments": [
        {
          "ID": "ut nisi ea enim",
          "Name": "laborum fugiat qui"
        },
        {
          "ID": "Duis dolore ullamco commodo aute",
          "Name": "dolore"
        }
      ],
      "lists": [
        {
          "ID": "laborum consectetur",
          "Name": "quis Lorem"
        },
        {
          "ID": "dolore",
          "Name": "dolor ex Duis cupidatat"
        },
        {
          "ID": "sed",
          "Name": "eiusmod sint veniam culpa"
        },
        {
          "ID": "eiusmod veniam anim",
          "Name": "dolore"
        }
      ],
      "_metadata": {
        "prev": "nostrud magna laborum",
        "self": "ipsum consequat",
        "next": "cupidatat sint Ut laboris"
      }
    },
    {
      "id": "consectetur laborum in",
      "status": "deserunt",
      "created_at": "sint id",
      "completed_at": "ut fugiat labore nulla",
      "expires_at": "occaecat magna in nulla",
      "urls": [
        "sint nulla",
        "sunt magna",
        "esse nisi magna",
        "reprehenderit ullamco tempor culpa"
      ],
      "user_id": "velit pariatur sit exercitation irure",
      "export_type": "adipisicing fugiat eu",
      "segments": [
        {
          "ID": "aliquip proident non",
          "Name": "nostrud aliquip dolore esse"
        },
        {
          "ID": "ea ex dolor sed aliqua",
          "Name": "nulla cillum pariatur laboris ipsum"
        },
        {
          "ID": "non ut nulla amet",
          "Name": "dolore quis est in"
        },
        {
          "ID": "sunt proident",
          "Name": "consequat est"
        },
        {
          "ID": "ut",
          "Name": "ullamco anim aliqua fugiat ea"
        }
      ],
      "lists": [
        {
          "ID": "fugiat do id",
          "Name": "id ipsum ea voluptate"
        },
        {
          "ID": "adipisicing et dolor",
          "Name": "ut irure eiusmod fugiat"
        }
      ],
      "_metadata": {
        "prev": "dolor sint commodo",
        "self": "ea aute pariatur id est",
        "next": "Excepteur eu ipsum sit in"
      }
    },
    {
      "id": "aliqua pariatur esse non Duis",
      "status": "sit consectetur sunt enim amet",
      "created_at": "sint voluptate laborum Excepteur",
      "completed_at": "Lorem aute",
      "expires_at": "laboris officia exercitation cillum",
      "urls": [
        "non reprehenderit incididunt mollit",
        "irure aliqua laborum",
        "consectetur amet in"
      ],
      "user_id": "aute",
      "export_type": "consectetur",
      "segments": [
        {
          "ID": "ad enim",
          "Name": "aliqua anim nisi"
        }
      ],
      "lists": [
        {
          "ID": "laboris",
          "Name": "eu"
        },
        {
          "ID": "id commodo sint",
          "Name": "adipisicing nulla deserunt"
        },
        {
          "ID": "eiusmod incididunt est anim",
          "Name": "ea est"
        },
        {
          "ID": "aliquip",
          "Name": "minim officia consequat proident ipsum"
        },
        {
          "ID": "cupidatat dolore culpa",
          "Name": "Ut"
        }
      ],
      "_metadata": {
        "prev": "laborum laboris Ut",
        "self": "eiusmod eu",
        "next": "ullamco aliquip"
      }
    },
    {
      "id": "aliqua consequat proident",
      "status": "reprehenderit",
      "created_at": "nostrud consequat adipisicing officia",
      "completed_at": "qui enim",
      "expires_at": "in incididunt sunt ex ad",
      "urls": [
        "non",
        "ullamco quis adipisicing mollit",
        "tempor aute id qui Excepteur",
        "ipsum sint amet cillum",
        "ipsum consequat voluptate"
      ],
      "user_id": "ut aute tempor non ut",
      "export_type": "quis qui adipisicing id",
      "segments": [
        {
          "ID": "in fugiat Lorem",
          "Name": "in dolore dolor"
        },
        {
          "ID": "fugiat reprehenderit adipisicing",
          "Name": "laborum Lorem ipsum pariatur"
        }
      ],
      "lists": [
        {
          "ID": "exercitation reprehenderit irure",
          "Name": "tempor dolore sunt in"
        },
        {
          "ID": "veniam officia ut nostrud",
          "Name": "laboris quis sint labore esse"
        },
        {
          "ID": "ut sint ullamco quis",
          "Name": "ipsum esse"
        },
        {
          "ID": "occaecat laboris",
          "Name": "magna in reprehenderit enim"
        },
        {
          "ID": "laboris",
          "Name": "ut dolore in ea sint"
        }
      ],
      "_metadata": {
        "prev": "ad nisi nostrud et",
        "self": "quis voluptate do ex Ut",
        "next": "adipisicing cupidatat velit"
      }
    }
  ],
  "_metadata": {
    "prev": "nisi",
    "self": "reprehenderit consequat proident",
    "next": "nulla enim voluptate in"
  }
}
{
  "errors": [
    {
      "message": "Ut fugiat cupidatat",
      "": "quis in consectetur sed",
      "error_id": "Excepteur"
    },
    {
      "message": "laborum qui ipsum",
      "": "Ut velit",
      "error_id": "fugiat proident"
    },
    {
      "message": "eiusmod",
      "": "ea veniam ut magna dolor",
      "error_id": "ad magna incididunt adipisicing laboris"
    },
    {
      "message": "occaecat",
      "": "irure Duis ex Excepteur",
      "error_id": "consectetur culpa"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ea pariatur enim sint ad"
    },
    {
      "message": "sunt adipisicing dolore ea"
    },
    {
      "message": "dolor consequat minim laboris amet"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "Ut nisi",
  "first_name": "labore",
  "last_name": "minim tempor cupidatat",
  "unique_name": "non sed",
  "email": "dolor sint quis",
  "alternate_emails": [
    "Lorem qui",
    "tempor qui adipisicing laborum Ut",
    "irure",
    "sunt occaecat veniam minim",
    "veniam minim"
  ],
  "address_line_1": "enim Excepteur dolor anim dolor",
  "address_line_2": "ex sint",
  "city": "aliqua",
  "state_province_region": "cillum labore aliquip",
  "country": "irure exercitation",
  "postal_code": "velit et fugiat dolore",
  "phone_number": "ut",
  "whatsapp": "aliqua Lorem amet",
  "line": "laborum",
  "facebook": "in",
  "list_ids": [
    "sed"
  ],
  "segment_ids": [
    "consequat aute Excepteur",
    "sit id voluptate occaecat",
    "ipsum",
    "consectetur irure",
    "esse eu minim aliquip"
  ],
  "custom_fields": {},
  "created_at": "nostrud in",
  "updated_at": "laborum nulla anim culpa",
  "_metadata": {
    "self": "in ut laborum magna qui"
  }
}
{
  "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": "quis irure"
    },
    {
      "message": "consequat ut"
    }
  ]
}
Request Payload
{
  "query": "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')"
}
Response Payload
{
  "result": [
    {
      "id": "dolor magna enim",
      "first_name": "Lorem ut",
      "last_name": "ipsum fugiat do dolor",
      "unique_name": "quis deserunt ad",
      "email": "nulla in",
      "alternate_emails": [
        "tempor exercitation ipsum cupidatat nisi",
        "dolore reprehenderit"
      ],
      "address_line_1": "sit sed",
      "address_line_2": "reprehenderit ad in aliquip",
      "city": "ea dolor esse",
      "state_province_region": "eiusmod sunt Ut enim",
      "country": "et consequat ullamco",
      "postal_code": "exercitation culpa consectetur",
      "phone_number": "non",
      "whatsapp": "esse do",
      "line": "eu cillum",
      "facebook": "in pariatur proident",
      "list_ids": [
        "et aute elit ea amet",
        "culpa mollit",
        "aliquip",
        "ea",
        "Ut in sint"
      ],
      "segment_ids": [
        "qui officia",
        "fugiat id dolore",
        "velit exercitation sed",
        "cupidatat culpa",
        "sint"
      ],
      "custom_fields": {},
      "created_at": "ut ipsum proident do culpa",
      "updated_at": "sint dolore ea",
      "_metadata": {
        "self": "aute eu amet ad ex"
      }
    },
    {
      "id": "Ut",
      "first_name": "eiusmod minim Excepteur",
      "last_name": "cupidatat aliquip",
      "unique_name": "exercitation",
      "email": "et incididunt elit Duis enim",
      "alternate_emails": [
        "proident reprehenderit",
        "enim pariatur Duis",
        "mollit in qui consequat voluptate"
      ],
      "address_line_1": "laboris est velit ex Excepteur",
      "address_line_2": "non",
      "city": "reprehenderit ex ad",
      "state_province_region": "fugiat esse",
      "country": "in et consectetur irure Duis",
      "postal_code": "nulla amet consequat dolor quis",
      "phone_number": "do consequat sint magna ad",
      "whatsapp": "aliqua in incididunt proident cupidatat",
      "line": "amet non officia",
      "facebook": "amet ea nostrud in voluptate",
      "list_ids": [
        "laboris nostrud non irure",
        "voluptate nostrud dolore",
        "dolore enim"
      ],
      "segment_ids": [
        "quis",
        "voluptate",
        "sed",
        "veniam Excepteur amet ullamco consectetur",
        "et cupidatat"
      ],
      "custom_fields": {},
      "created_at": "consectetur ullamco occaecat",
      "updated_at": "ullamco in aliqua aute",
      "_metadata": {
        "self": "Ut dolore"
      }
    },
    {
      "id": "do",
      "first_name": "sunt quis ex in",
      "last_name": "Ut adipisicing",
      "unique_name": "anim ea voluptate",
      "email": "fugiat mollit nulla elit anim",
      "alternate_emails": [
        "laboris minim dolore"
      ],
      "address_line_1": "laborum est commodo",
      "address_line_2": "consectetur adipisicing anim proident",
      "city": "veniam mollit ut",
      "state_province_region": "nisi amet eiusmod",
      "country": "exercitation eiusmod irure reprehenderit consequat",
      "postal_code": "ut dolor consectetur magna",
      "phone_number": "reprehenderit cillum",
      "whatsapp": "eiusmod cupidatat do officia eu",
      "line": "est Excepteur mollit consequat veniam",
      "facebook": "incididunt consequat cupidatat ad est",
      "list_ids": [
        "in ullamco veniam minim ad",
        "irure qui in consectetur",
        "ad deserunt ut",
        "consequat reprehenderit officia",
        "id"
      ],
      "segment_ids": [
        "Duis eiusmod Ut dolore"
      ],
      "custom_fields": {},
      "created_at": "enim esse",
      "updated_at": "dolor ipsum",
      "_metadata": {
        "self": "incididunt sed ullamco aliquip"
      }
    },
    {
      "id": "pariatur Excepteur tempor",
      "first_name": "occaecat",
      "last_name": "est",
      "unique_name": "labore Excepteur nisi",
      "email": "in do laborum in",
      "alternate_emails": [
        "eiusmod adipisicing nostrud ad magna"
      ],
      "address_line_1": "occaecat",
      "address_line_2": "laboris",
      "city": "aliquip Excepteur nisi et magna",
      "state_province_region": "culpa reprehenderit id",
      "country": "Duis amet aliquip consectetur",
      "postal_code": "ex reprehenderit proident",
      "phone_number": "tempor ea irure",
      "whatsapp": "non voluptate culpa velit labore",
      "line": "reprehenderit irure",
      "facebook": "veniam Ut tempor voluptate",
      "list_ids": [
        "pariatur in",
        "dolore dolore minim ad aliquip",
        "in et elit",
        "nisi",
        "fugiat aliquip"
      ],
      "segment_ids": [
        "est",
        "occaecat ex magna voluptate nisi",
        "nulla ut esse non ex",
        "eiusmod est nulla",
        "pariatur voluptate deserunt"
      ],
      "custom_fields": {},
      "created_at": "in Duis magna cillum officia",
      "updated_at": "in officia",
      "_metadata": {
        "self": "Ut reprehenderit culpa dolor ut"
      }
    }
  ],
  "_metadata": {
    "self": "dolore elit ea fugiat amet"
  },
  "contact_count": -44827573.85102549
}
{
  "errors": [
    {
      "field": "minim",
      "message": "consequat voluptate id dolore"
    },
    {
      "field": "non occaecat mollit pariatur dolore",
      "message": "dolor anim nisi in in"
    },
    {
      "field": "et ut dolor",
      "message": "consequat culpa fugiat sint eu"
    },
    {
      "field": "quis voluptate",
      "message": "nostrud adipisicing aliquip esse"
    }
  ]
}
{
  "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": "esse"
    },
    {
      "message": "cupidatat ut"
    },
    {
      "message": "labore"
    },
    {
      "message": "reprehenderit cillum irure deserunt magna"
    },
    {
      "message": "quis eu est tempor in"
    }
  ]
}
Request Payload
{
  "list_ids": [
    "ut fugiat officia Excepteur pariatur",
    "Excepteur",
    "dolor Ut sed",
    "ullamco labore velit aliquip"
  ],
  "file_type": "csv",
  "field_mappings": [
    null,
    "occaecat tempor"
  ]
}
Response Payload
{
  "job_id": "ipsum occaecat ad",
  "upload_uri": "culpa magna nostrud tempor laboris",
  "upload_headers": [
    {
      "header": "dolore nostrud ea in proident",
      "value": "exercitation eiusmod ut esse reprehenderit"
    },
    {
      "header": "deserunt velit ea exercitation",
      "value": "esse"
    }
  ]
}
{
  "errors": [
    {
      "message": "aliquip Ut Lorem sed",
      "field": "nulla",
      "error_id": "ea ex exercitation in dolore",
      "parameter": "laboris deserunt in voluptate"
    },
    {
      "message": "ex proident",
      "field": "occaecat est voluptate laboris adipisicing",
      "error_id": "Lorem officia id exercitation pariatur",
      "parameter": "elit quis"
    },
    {
      "message": "culpa nostrud velit officia fugiat",
      "field": "exercitation ullamco do ut magna",
      "error_id": "cillum sunt eiusmod eu in",
      "parameter": "sunt ullamco aliqua quis veniam"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "labore quis voluptate esse sed",
      "field": "in dolor pariatur Excepteur aliqua",
      "error_id": "laborum ipsum labore",
      "parameter": "dolor nisi fugiat labore anim"
    },
    {
      "message": "dolor commodo Duis nostrud labore",
      "field": "aliqua culpa ad",
      "error_id": "ullamco occaecat",
      "parameter": "eu laboris cillum do"
    },
    {
      "message": "nulla",
      "field": "ullamco irure exercitation in aliquip",
      "error_id": "minim Duis",
      "parameter": "et nisi laborum in eiusmod"
    }
  ]
}
{
  "errors": [
    {
      "message": "laboris dolor ipsum"
    },
    {
      "message": "et Duis Lorem"
    },
    {
      "message": "quis occaecat velit Excepteur"
    },
    {
      "message": "anim nulla reprehenderit dolore"
    },
    {
      "message": "adipisicing qui ex et Excepteur"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "minim",
  "status": "laboris dolor Excepteur mollit",
  "job_type": "mollit commodo culpa laboris",
  "results": {
    "requested_count": 61435961.722694725,
    "created_count": 16806522.156504005,
    "updated_count": -12019868.591952816,
    "deleted_count": -3552612.808586672,
    "errored_count": 86900422.4271397,
    "errors_url": "aliquip eiusmod"
  },
  "started_at": "amet sunt Excepteur proident",
  "finished_at": "Ut"
}
{
  "errors": {
    "message": "laboris",
    "field": "dolore",
    "error_id": "in Excepteur",
    "parameter": "cupidatat veniam labore aliquip nulla"
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "cupidatat nostrud"
    }
  ]
}
Request Payload
Response Payload
{
  "id": "consectetur Duis",
  "status": "pending",
  "created_at": "occaecat ut cupidatat Duis",
  "updated_at": "nulla",
  "completed_at": "quis",
  "expires_at": "magna",
  "urls": [
    "sint magna nulla id Excepteur"
  ],
  "message": "consectetur velit ipsum",
  "_metadata": {
    "prev": "http://s.jzxkSf8UW5MUGD+I,ExULwAyxAmoY1-DX8vwrZynJ1-2E2WtjNAB.VQ+g9N",
    "self": "http://WsOzpvMXbSKNopvp.ozNW6k.fLyTipOXJzVPPXefMTEaNzfJHd,zPIaIQ+sEJypEEWOtXfX1zv5Ztgmrar-A",
    "next": "https://O.gfHCtOHu,EI-iutsRH0pX-I6uMULEB,4len2EEtMWAcoSzC7K-lfCIC4-n2Vbsm-P8r",
    "count": -49519031.0509126
  },
  "contact_count": -55344241
}
{
  "errors": [
    {
      "message": "consequat fugiat",
      "field": "veniam",
      "error_id": "fugiat aute dolore ad",
      "parameter": "aliqua enim laboris non"
    },
    {
      "message": "fugiat",
      "field": "aliquip officia sit elit mollit",
      "error_id": "velit qui et",
      "parameter": "tempor sit dolore in"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "et qui pariatur nulla in"
    },
    {
      "message": "adipisicing esse"
    },
    {
      "message": "sit culpa fugiat"
    },
    {
      "message": "tempor voluptate dolore"
    }
  ]
}
Request Payload
{
  "ids": [
    "1234",
    "1235"
  ]
}
Response Payload
{
  "result": [
    {
      "id": "Lorem esse eiusmod",
      "first_name": "ea in aliqua in",
      "last_name": "pariatur minim Duis est fugiat",
      "unique_name": "adipisicing aliqua",
      "email": "ipsum laborum",
      "alternate_emails": [
        "dolor minim"
      ],
      "address_line_1": "fugiat quis deserunt",
      "address_line_2": "deserunt aute",
      "city": "nostrud est labore",
      "state_province_region": "reprehenderit ipsum sunt",
      "country": "dolor",
      "postal_code": "ex consectetur occaecat anim",
      "phone_number": "laborum dolore ipsum",
      "whatsapp": "adipisicing",
      "line": "eiusmod ex in officia",
      "facebook": "velit",
      "list_ids": [
        "commodo eiusmod consequat dolore labore",
        "Lorem",
        "elit",
        "incididunt in amet eu reprehenderit"
      ],
      "segment_ids": [
        "cupidatat officia",
        "proident ex",
        "ea",
        "aute sit",
        "deserunt consequat occaecat et ad"
      ],
      "custom_fields": {},
      "created_at": "commodo Lorem laboris",
      "updated_at": "ut labore eiusmod exercitation quis",
      "_metadata": {
        "self": "nulla"
      }
    },
    {
      "id": "labore elit",
      "first_name": "adipisicing",
      "last_name": "adipisicing cillum qui consectetur Excepteur",
      "unique_name": "ipsum",
      "email": "amet",
      "alternate_emails": [
        "nulla aliqua aliquip cupidatat deserunt",
        "est Lorem"
      ],
      "address_line_1": "mollit cupidatat laborum eiusmod",
      "address_line_2": "ex ad culpa anim in",
      "city": "esse sint labore",
      "state_province_region": "magna Lorem",
      "country": "minim incididunt dolore",
      "postal_code": "sed consequat",
      "phone_number": "commodo sed ut",
      "whatsapp": "qui fugiat dolore reprehenderit deserunt",
      "line": "deserunt mollit proident nisi dolor",
      "facebook": "ad",
      "list_ids": [
        "ea ipsum incididunt",
        "elit non proident laboris adipisicing"
      ],
      "segment_ids": [
        "dolore velit"
      ],
      "custom_fields": {},
      "created_at": "nulla reprehenderit",
      "updated_at": "Excepteur dolor in",
      "_metadata": {
        "self": "minim"
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "et ut cillum"
    }
  ]
}
Request Payload
{
  "emails": [
    "jane_doe@example.com",
    "john_doe@example.com",
    "joann_doe@example.com"
  ]
}
Response Payload
{
  "result": {
    "jane_doe@example.com": {
      "contact": {
        "address_line_1": "",
        "address_line_2": "",
        "alternate_emails": [
          "janedoe@example1.com"
        ],
        "city": "",
        "country": "",
        "email": "jane_doe@example.com",
        "first_name": "Jane",
        "id": "asdf-Jkl-zxCvBNm",
        "last_name": "Doe",
        "list_ids": [],
        "segment_ids": [],
        "postal_code": "",
        "state_province_region": "",
        "phone_number": "",
        "whatsapp": "",
        "line": "",
        "facebook": "",
        "unique_name": "",
        "custom_fields": {},
        "created_at": "2021-03-02T15:25:47Z",
        "updated_at": "2021-03-30T15:26:16Z",
        "_metadata": {
          "self": "<metadata_url>"
        }
      }
    },
    "john_doe@example.com": {
      "contact": {
        "address_line_1": "",
        "address_line_2": "",
        "alternate_emails": [],
        "city": "",
        "country": "",
        "email": "john_doe@example.com",
        "first_name": "Jane",
        "id": "asdf-Jkl-qWeRTy",
        "last_name": "Doe",
        "list_ids": [],
        "segment_ids": [],
        "postal_code": "",
        "state_province_region": "",
        "phone_number": "",
        "whatsapp": "",
        "line": "",
        "facebook": "",
        "unique_name": "",
        "custom_fields": {},
        "created_at": "2020-01-02T15:25:47Z",
        "updated_at": "2020-12-20T15:26:16Z",
        "_metadata": {
          "self": "<metadata_url>"
        }
      }
    },
    "joann_doe@example.com": {
      "error": "contact not found"
    }
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "adipisicing velit laboris sunt"
    },
    {
      "message": "laborum eu exercitation qui in"
    },
    {
      "message": "sed laboris exercitation veniam amet"
    },
    {
      "message": "tempor deserunt aute est consectetur"
    },
    {
      "message": "sint commodo"
    }
  ]
}

Segmenting Contacts V2 - Beta(5 operations)

Request Payload
{
  "name": "commodo ut",
  "parent_list_ids": [
    "proident",
    "ut",
    "eiusmod non ut amet ea",
    "irure tempor enim sit velit"
  ],
  "query_dsl": "veniam ex"
}
Response Payload
{
  "id": "637af0ca-516c-c210-a3c4-eaf9b397254d",
  "name": "Except",
  "query_dsl": "labore",
  "contacts_count": -49140955,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "officia",
  "updated_at": "pariatur in",
  "sample_updated_at": "esse do laborum aliqua",
  "next_sample_update": "Ut amet",
  "parent_list_ids": [
    "magna"
  ],
  "query_version": "mollit consequat deserunt elit",
  "status": {
    "query_validation": "do proident pariatur occaecat est",
    "error_message": "et aliqua est velit"
  }
}
{
  "errors": [
    {
      "field": "in velit ea",
      "message": "et anim"
    },
    {
      "field": "nulla id in labore",
      "message": "aliqua elit pariatur eiusmod"
    }
  ]
}
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": "minim Duis",
      "message": "in officia in cupidatat"
    },
    {
      "field": "ipsum veniam",
      "message": "minim"
    },
    {
      "field": "Lorem",
      "message": "amet reprehenderit"
    },
    {
      "field": "ut ad Excepteur dolor",
      "message": "Ut Excepteur exercitation ullamco fugiat"
    }
  ]
}
Query Parameter NameExample
parent_list_idssint velit occaecat
no_parent_list_idfalse
Request Payload
Response Payload
{
  "id": "4bb0e006-a1d8-a1e9-6b5f-8f8e71a5ee45",
  "name": "reprehenderit in",
  "contacts_count": 72349212,
  "created_at": "amet consectetur elit dolore",
  "updated_at": "et",
  "sample_updated_at": "in sit laborum eu",
  "next_sample_update": "nisi labore veniam",
  "parent_list_ids": [
    "ullamco anim in ut",
    "nisi magna",
    "nostrud culpa laboris Duis sint",
    "adipisicing consequat id"
  ],
  "query_version": "ad nulla esse elit minim",
  "_metadata": {
    "prev": "http://vJKVWahUyGhOCnrdInwpSrnoSxpDrGh.ghmPBpiJUe+X2jsRFd6zVWa15BzkWWNN7fDwIvHVzUdOFKm.xhEsAUdRJwt3",
    "self": "https://AtJNgsQwxYsKHDeCBf.fxnhCip6CxO.kuJN32CkEJI7KtEn8UmZHIT",
    "next": "http://UgLYfsLPtbVpjvErmZG.rbcsh3qviktKs.afzyruHsS44Q-,8QJYWSYBqmt--l1hkm",
    "count": 51423838
  },
  "status": {
    "query_validation": "eiusmod dolor enim",
    "error_message": "ut"
  }
}
{
  "errors": [
    {
      "field": "laborum",
      "message": "ut nostrud non aliqua sunt"
    },
    {
      "field": "anim",
      "message": "ut labore non"
    },
    {
      "field": "consequat officia",
      "message": "nulla eu tempor magna"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "minim culpa",
      "message": "anim minim tempor do"
    },
    {
      "field": "cupidatat id in",
      "message": "cupidatat exercitation id amet"
    },
    {
      "field": "pariatur Lorem consequat",
      "message": "voluptate ut amet occaecat"
    },
    {
      "field": "officia laboris ullamco consectetur adipisicing",
      "message": "sed qui irure"
    }
  ]
}
Request Payload
{
  "name": "Lorem in mollit",
  "query_dsl": "dolor nisi fugiat"
}
Response Payload
{
  "id": "d52883d5-e44e-f51e-c114-1044295c24e5",
  "name": "anim",
  "query_dsl": "cupidatat in quis",
  "contacts_count": -73650682,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "dolore",
  "updated_at": "fugiat in",
  "sample_updated_at": "aliqua cupidatat sed",
  "next_sample_update": "dolor sint sit consectetur aliqua",
  "parent_list_ids": [
    "irure ut",
    "do id reprehenderit tempor fugiat"
  ],
  "query_version": "sint quis cupidatat esse velit",
  "status": {
    "query_validation": "Duis dolor dolore quis occaecat",
    "error_message": "Excepteur"
  }
}
{
  "errors": [
    {
      "field": "Lorem ea occaecat",
      "message": "laborum enim Excepteur voluptate tempor"
    },
    {
      "field": "laboris quis anim ullamco",
      "message": "aliqua"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "laboris deserunt do fugiat sunt",
      "message": "aliquip ut aliqua"
    },
    {
      "field": "quis",
      "message": "occaecat sint commodo anim voluptate"
    },
    {
      "field": "occaecat",
      "message": "consectetur consequat"
    }
  ]
}
Query Parameter NameExample
contacts_samplefalse
Request Payload
Response Payload
{
  "id": "5285db7b-aa16-5427-c4b1-20936266534c",
  "name": "dolore cupidatat",
  "query_dsl": "in",
  "contacts_count": 36867746,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "incididunt Excepteur",
  "updated_at": "dolor in officia",
  "sample_updated_at": "est sit",
  "next_sample_update": "et occaecat nisi enim ad",
  "parent_list_ids": [
    "Duis nisi ut deserunt"
  ],
  "query_version": "esse minim aliqua commodo",
  "status": {
    "query_validation": "ullamco consectetur pariatur",
    "error_message": "velit reprehenderit dolor magna aute"
  }
}
{
  "errors": [
    {
      "field": "fugiat reprehenderit",
      "message": "laboris adipisicing"
    }
  ]
}
{
  "errors": [
    {
      "field": "non commodo cupidatat ipsum",
      "message": "proident velit aliqua esse"
    },
    {
      "field": "sunt",
      "message": "ex Lorem"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "deserunt nulla",
      "message": "id magna incididunt sit qui"
    },
    {
      "field": "qui",
      "message": "laboris minim exercitation"
    },
    {
      "field": "nostrud",
      "message": "ut"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "amet eu ex Lorem",
      "message": "laboris in"
    },
    {
      "field": "ipsum cillum laboris",
      "message": "Excepteur"
    },
    {
      "field": "commodo Lorem nostrud laboris sunt",
      "message": "elit ad laboris esse"
    }
  ]
}

Senders

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

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

segmenting contacts(5 operations)

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

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": "ex consequat sed",
      "error": "veniam laborum occaecat ex ad",
      "resources": {
        "type": "mollit reprehenderit magna Excepteur aliquip",
        "ids": [
          "voluptate",
          "in nostrud",
          "elit esse ad ut",
          "qui eiusmod labore"
        ]
      }
    },
    {
      "id": "amet aliquip laborum mollit",
      "error": "sunt",
      "resources": {
        "type": "dolore non",
        "ids": [
          "dolor fugiat nisi culpa",
          "eiusmod consequat",
          "in laborum exercitation et",
          "dolore do"
        ]
      }
    },
    {
      "id": "cupidatat occaecat elit Duis",
      "error": "consectetur",
      "resources": {
        "type": "minim",
        "ids": [
          "ullamco occaecat velit fugiat anim",
          "qui"
        ]
      }
    }
  ]
}
{}
{
  "errors": [
    {
      "field": "do mollit exercitation laborum",
      "message": "Lorem eiusmod aliqua"
    },
    {
      "field": "nostrud officia consectetur irure",
      "message": "ut"
    },
    {
      "field": "officia",
      "message": "ullamco ut in"
    },
    {
      "field": "sed",
      "message": "minim amet"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "dolore Lorem dolore"
    },
    {
      "message": "eu proident aliqua velit exercitation"
    },
    {
      "message": "sit reprehenderit in ullamco"
    },
    {
      "message": "fugiat Lorem"
    },
    {
      "message": "consequat"
    }
  ]
}

Single Sends(11 operations)

Request Payload
{
  "name": "Example API Created Single Send",
  "categories": [
    "unique opens"
  ],
  "send_to": {
    "all": true
  },
  "email_config": {
    "design_id": "<your-design-id>",
    "editor": "design",
    "suppression_group_id": 12345,
    "sender_id": 1234567
  }
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "field": "eu",
      "message": "dolore cillum ex voluptate",
      "error_id": "eu dolor ad et"
    },
    {
      "field": "proident",
      "message": "nisi",
      "error_id": "officia"
    },
    {
      "field": "laboris labore pariatur amet",
      "message": "deserunt",
      "error_id": "non nisi minim Ut"
    },
    {
      "field": "non exercitation dolore",
      "message": "fugiat veniam cillum ex ullamco",
      "error_id": "reprehenderit aliquip ullamco"
    },
    {
      "field": "enim consectetur reprehenderit tempor fugiat",
      "message": "aliquip fugiat Duis nisi est",
      "error_id": "fugiat ut"
    }
  ]
}
{
  "errors": [
    {
      "field": "labore veniam in",
      "message": "laboris Ut cillum",
      "error_id": "anim irure fugiat incididunt"
    },
    {
      "field": "deserunt ad cupidatat aliquip magna",
      "message": "ea in aliqua ad",
      "error_id": "amet ad commodo aliquip Ut"
    }
  ]
}
Query Parameter NameExample
page_size74656572
page_tokenin labore quis Duis
Request Payload
Response Payload
{
  "result": [
    {
      "id": "e0125106-4292-979f-e0c6-d2c4db81081f",
      "name": "dolore amet",
      "abtest": {
        "type": "content",
        "winner_criteria": "open",
        "test_percentage": -7865202,
        "duration": "esse in",
        "winning_template_id": "nostrud in mollit dolor",
        "winner_selected_at": null,
        "expiration_date": null
      },
      "status": "draft",
      "categories": [
        "quis esse in dolore",
        "ad",
        "velit",
        "anim cupidatat",
        "nisi culpa eiusmod aliqua",
        "aliquip proident commodo",
        "nostrud quis proident fugiat tempor",
        "Duis sunt",
        "exercitation",
        "ex cupidatat"
      ],
      "send_at": "1932-02-14T20:53:10.0Z",
      "is_abtest": true,
      "updated_at": "1917-05-27T05:01:53.0Z",
      "created_at": "1966-08-18T02:57:01.0Z"
    },
    {
      "id": "a8f2329a-67b7-e930-fbb3-aae79e11be2e",
      "name": "cupidatat in veniam nostru",
      "abtest": {
        "type": "subject",
        "winner_criteria": "open",
        "test_percentage": -1933092,
        "duration": "ipsum",
        "winning_template_id": "aute reprehenderit in",
        "winner_selected_at": null,
        "expiration_date": "ex sint proident magna occaecat"
      },
      "status": "triggered",
      "categories": [
        "laboris tempor anim fugiat ipsum",
        "amet",
        "officia aliquip",
        "consequat esse aliqua",
        "consectetur",
        "veniam incididunt cillum",
        "ea nostrud proident veniam",
        "amet in eu minim",
        "minim esse ad id",
        "fugiat magna deserunt sit sed"
      ],
      "send_at": "1926-10-29T07:44:24.0Z",
      "is_abtest": false,
      "updated_at": "1901-04-02T01:01:18.0Z",
      "created_at": "1941-12-05T07:25:43.0Z"
    }
  ],
  "_metadata": {
    "prev": "https://neraPKhAozdAexFVtrXmLeZMo.vhpozE613M5SdEMWeH+Cd0fRjRKm.2tzEmywnviuHFvb-GtdsVUCuPqKGAFYPnei",
    "self": "http://QtkMxwEY.biLZ5--S8dA,OzBieY3y7YyA8p7lMJW.3OuWjLeH+m",
    "next": "https://GzFuMdAYFimyzP.kfpEQ,KS4SUARv7,WvouQYrvErT6neWGsMpzm7gw-97eDjcI3JcGhsmJ",
    "count": 8914180
  }
}
{
  "errors": [
    {
      "field": "incididunt anim ex consequat",
      "message": "ex",
      "error_id": "ipsum dolore"
    },
    {
      "field": "reprehenderit sed consectetur",
      "message": "Lorem Duis sit",
      "error_id": "culpa ipsum ut adipisicing"
    }
  ]
}
Query Parameter NameExample
ids["dolore do","deserunt pariatur qui","ut id dolore minim","in","id occaecat","magna commodo ut do","anim magna proident aute quis","est irure officia","consectetur","dolor officia voluptate"]
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "adipisicing esse do",
      "message": "non proident nulla commodo",
      "error_id": "fugiat ex proident velit"
    },
    {
      "field": "Duis mollit",
      "message": "veniam dolore nostrud Excepteur dolore",
      "error_id": "aute officia Ut irure"
    },
    {
      "field": "dolor occaecat mollit ut sit",
      "message": "voluptate laborum exercitation",
      "error_id": "tempor aliqua in"
    },
    {
      "field": "minim aliqua laboris magna",
      "message": "dolor",
      "error_id": "id tempor"
    },
    {
      "field": "esse Duis id velit",
      "message": "id ullamco aute nisi ea",
      "error_id": "labore"
    }
  ]
}
{
  "errors": [
    {
      "field": "voluptate sunt ut dolore",
      "message": "aute mollit ea aliquip",
      "error_id": "mollit"
    },
    {
      "field": "cupidatat",
      "message": "consectetur eu consequat occaecat quis",
      "error_id": "consequat qui"
    },
    {
      "field": "pariatur eiusmod mollit",
      "message": "consequat cillum pariatur Ut in",
      "error_id": "elit amet sed consectetur"
    },
    {
      "field": "sed",
      "message": "in sed in dolor enim",
      "error_id": "velit mollit"
    }
  ]
}
Request Payload
{
  "name": "Ut"
}
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": "veniam sint ipsum dolor",
      "message": "in ut eiusmod sunt",
      "error_id": "pariatur labore"
    },
    {
      "field": "proident",
      "message": "occaecat consequat deserunt reprehenderit non",
      "error_id": "dolore consectetur deserunt ex Duis"
    },
    {
      "field": "laborum labore ut",
      "message": "cillum",
      "error_id": "occaecat nisi"
    },
    {
      "field": "velit eiusmod qui minim irure",
      "message": "sit",
      "error_id": "cillum proident nostrud voluptate est"
    }
  ]
}
{
  "errors": [
    {
      "field": "in",
      "message": "Lorem sit qui",
      "error_id": "proident cupidatat consequat"
    },
    {
      "field": "dolore fugiat",
      "message": "nisi Excepteur enim",
      "error_id": "adipisicing amet"
    },
    {
      "field": "et exercitation sunt",
      "message": "dolor nisi sint qui sed",
      "error_id": "consectetur"
    },
    {
      "field": "sit officia magna",
      "message": "ad aute",
      "error_id": "velit"
    },
    {
      "field": "ut dolore do laborum",
      "message": "ad amet ipsum",
      "error_id": "Ut voluptate nostrud mollit in"
    }
  ]
}
Request Payload
{
  "name": "in pariatur Lorem aute",
  "categories": [
    "Ut minim irure qui fugiat",
    "consequat",
    "veniam voluptate",
    "minim irure Ut non",
    "elit",
    "velit sed",
    "cillum Excepteur",
    "minim laboris",
    "esse nulla ea",
    "Lorem ad nostrud dolor id"
  ],
  "send_at": "1897-06-03T16:16:12.0Z",
  "send_to": {
    "list_ids": [
      "5806b47c-9d97-0ee9-fa83-eb87f53bedd6",
      "c0f5ce11-a702-90ef-60ac-7d2ac4064a9e",
      "11603134-fac9-86af-67d1-a6f0af006ffb",
      "5b8c2aab-263b-3baa-c4fd-76a4ffcf0001",
      "9d68c444-b042-c4df-9ddb-cd66c3da3ec4",
      "0cba5c0c-86e9-8581-4154-c8e94b5211d7",
      "3ffc58ff-024e-5657-c767-1fcee249bb11",
      "7289d4ee-c1ec-49dc-a221-37d46f500911",
      "b6d567cd-34d9-ba30-7b4b-66b7084bbdac",
      "b734df13-378e-5e5c-2185-22b6efe477ec"
    ],
    "segment_ids": [
      "5b2d5c20-1613-e66a-4d01-2d67580bfd1f",
      "c6a195ec-8406-c18c-c284-5f79c9a1a43f",
      "a3190b5d-4259-f134-cc99-593e28b7e5c5",
      "aed1e536-b096-3e54-c511-0320dc80c272",
      "abfa0199-6978-2d6c-36d4-94869832257a",
      "f2f4a430-097d-a21b-1042-bae4116cb1f3",
      "b93754c8-bbce-db5d-c754-fe5262d9d312",
      "5ba49d8d-ab0f-1382-2648-677872d2e505",
      "92c913ec-99f9-81c0-cedd-28255e0d72b6",
      "5742d982-3ad8-2ed5-2df8-92b2cb67c4c9"
    ],
    "all": false
  },
  "email_config": {
    "subject": "magna proident",
    "html_content": "laboris Lorem dolor deserunt id",
    "plain_content": "id ex",
    "generate_plain_content": true,
    "design_id": "cillum labore incididunt",
    "editor": "code",
    "suppression_group_id": -34028192,
    "custom_unsubscribe_url": "https://deBxIeFDkja.siydlplN",
    "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": "Ut reprehenderit",
      "message": "aute elit",
      "error_id": "et"
    }
  ]
}
{
  "errors": [
    {
      "field": "commodo dolor cupidatat eiusmod",
      "message": "laboris",
      "error_id": "adipisicing irure ut laboris"
    },
    {
      "field": "in quis dolore adipisicing in",
      "message": "sint reprehenderit",
      "error_id": "veniam incididunt minim"
    },
    {
      "field": "in sunt laborum dolor",
      "message": "quis incididunt tempor ullamco",
      "error_id": "laboris dolore in sint amet"
    },
    {
      "field": "ipsum culpa pariatur",
      "message": "ad",
      "error_id": "culpa do quis et tempor"
    }
  ]
}
{
  "errors": [
    {
      "field": "ullamco est ut",
      "message": "est nulla enim voluptate dolore",
      "error_id": "nostrud incididunt"
    }
  ]
}
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": "tempor",
      "message": "incididunt",
      "error_id": "commodo dolore dolor aute"
    },
    {
      "field": "do ut in",
      "message": "ea aute ut",
      "error_id": "qui"
    },
    {
      "field": "in pariatur deserunt minim Excepteur",
      "message": "magna sunt commodo",
      "error_id": "minim Excepteur aute"
    },
    {
      "field": "sed fugiat sit in",
      "message": "amet tempor laboris proident",
      "error_id": "eu sit"
    },
    {
      "field": "dolore laborum do Excepteur",
      "message": "minim ea elit sed fugiat",
      "error_id": "consequat ex commodo"
    }
  ]
}
{
  "errors": [
    {
      "field": "in amet",
      "message": "et officia nulla",
      "error_id": "culpa adipisicing"
    },
    {
      "field": "adipisicing et",
      "message": "eu",
      "error_id": "ut consectetur labore enim"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "officia",
      "message": "eiusmod",
      "error_id": "Lorem irure"
    },
    {
      "field": "magna minim labore eiusmod",
      "message": "magna veniam",
      "error_id": "ut labore sunt reprehenderit"
    }
  ]
}
{
  "errors": [
    {
      "field": "ipsum non",
      "message": "laboris ullamco labore sed in",
      "error_id": "officia adipisicing dolor laboris"
    },
    {
      "field": "ut",
      "message": "sunt",
      "error_id": "enim dolore aute Lorem"
    },
    {
      "field": "et",
      "message": "culpa qui in",
      "error_id": "irure"
    },
    {
      "field": "culpa",
      "message": "irure eiusmod dolore non",
      "error_id": "cillum incididunt ad magna proident"
    },
    {
      "field": "esse consequat proident",
      "message": "Duis",
      "error_id": "anim ex deserunt"
    }
  ]
}
Query Parameter NameExample
page_size54362780
page_tokenin ut ullamco pariatur eiusmod
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": "id ipsum pariatur",
      "message": "non",
      "error_id": "dolor in esse deserunt"
    },
    {
      "field": "dolore est ea ut",
      "message": "consectetur",
      "error_id": "enim"
    }
  ]
}
Request Payload
{
  "send_at": "3752-01-28T23:21:52.575Z"
}
Response Payload
{
  "send_at": "3752-01-28T23:21:52.575Z",
  "status": "scheduled"
}
{
  "errors": [
    {
      "field": "consectetur esse in in qui",
      "message": "elit minim",
      "error_id": "aliquip"
    },
    {
      "field": "in exercitation officia",
      "message": "aute incididunt enim reprehenderit non",
      "error_id": "sed do nulla laborum nisi"
    },
    {
      "field": "voluptate",
      "message": "labore mollit quis qui",
      "error_id": "mollit anim"
    }
  ]
}
{
  "errors": [
    {
      "field": "velit Excepteur",
      "message": "aute ad Excepteur consectetur",
      "error_id": "elit quis voluptate pariatur"
    }
  ]
}
Request Payload
Response Payload
{
  "send_at": "1929-02-09T22:13:56.0Z",
  "status": "triggered"
}
{
  "errors": [
    {
      "field": "pariatur culpa deserunt voluptate",
      "message": "officia",
      "error_id": "sit"
    },
    {
      "field": "ut",
      "message": "non commodo irure dolore",
      "error_id": "eiusmod laborum velit aliquip sunt"
    },
    {
      "field": "dolor id do",
      "message": "eiusmod consectetur",
      "error_id": "enim"
    },
    {
      "field": "Excepteur pariatur non",
      "message": "qui magna quis proident velit",
      "error_id": "et occaecat sit pariatur veniam"
    },
    {
      "field": "ut dolor aute laborum sunt",
      "message": "proident cillum qui",
      "error_id": "dolor anim aliqua veniam sint"
    }
  ]
}
{
  "errors": [
    {
      "field": "commodo culpa fugiat dolore ad",
      "message": "laboris sit irure",
      "error_id": "sint non aliquip"
    },
    {
      "field": "pariatur sint deserunt labore",
      "message": "ut reprehenderit quis aliquip",
      "error_id": "nostrud cupidatat sunt voluptate"
    }
  ]
}
Request Payload
Response Payload
{
  "categories": [
    "equipment",
    "shoes",
    "sports"
  ]
}
{
  "errors": [
    {
      "field": "pariatur irure esse in magna",
      "message": "ut veniam",
      "error_id": "sint dolore culpa et ea"
    },
    {
      "field": "proident",
      "message": "aliqua cupidatat",
      "error_id": "consequat"
    }
  ]
}

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["mollit quis sit","et dolore anim occaecat exercitation","Duis nostrud aute velit sint","ipsum occaecat sint","in","consectetur labore","ut commodo","laborum dolore officia labore","Duis nostrud esse nulla","laboris veniam dolor laborum"]
page_size35
page_tokenpariatur dolor ex
Request Payload
Response Payload
{
  "results": [
    {
      "id": "cf3f0200-8d8a-4835-a662-f2cf49baf64c",
      "aggregation": "voluptate non commodo cupidatat irure",
      "step_id": "veniam occaecat",
      "stats": {
        "bounce_drops": 96521270,
        "bounces": 44647062,
        "clicks": -93733519,
        "delivered": 42765976,
        "invalid_emails": -30176189,
        "opens": -47549446,
        "requests": 22540081,
        "spam_report_drops": 54329613,
        "spam_reports": 2990767,
        "unique_clicks": -68800274,
        "unique_opens": -79666597,
        "unsubscribes": 1599449
      }
    },
    {
      "id": "9736e18d-b88d-2df5-1760-5d536188303f",
      "aggregation": "et incididunt ullamco pariatur irure",
      "step_id": "cupidatat",
      "stats": {
        "bounce_drops": 15130525,
        "bounces": 71906533,
        "clicks": -90574378,
        "delivered": 92062096,
        "invalid_emails": 50556999,
        "opens": 72651075,
        "requests": 60905834,
        "spam_report_drops": 86997175,
        "spam_reports": 96819779,
        "unique_clicks": 63644642,
        "unique_opens": -68905591,
        "unsubscribes": -83148602
      }
    },
    {
      "id": "99e38dac-e304-4ac9-d571-945e7df73c36",
      "aggregation": "consectetur elit sunt esse",
      "step_id": "minim",
      "stats": {
        "bounce_drops": 93889700,
        "bounces": -66955168,
        "clicks": 40757332,
        "delivered": 86523949,
        "invalid_emails": -61479797,
        "opens": 40411959,
        "requests": -36671404,
        "spam_report_drops": -91877058,
        "spam_reports": 13617201,
        "unique_clicks": -16741516,
        "unique_opens": -35776766,
        "unsubscribes": -5462283
      }
    }
  ],
  "_metadata": {
    "prev": "https://ZiVNz.zlanIPpwPzBRfmLAlOq",
    "self": "https://ZWadmsIkofLEeJ.ysycZMJSPmcpUK3PhO7",
    "next": "http://VQfqOPEQdMuKiZtWrrTKkXlVIRZUCOxl.pwbkC3Ohf,fp",
    "count": -24862511.616090283
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
group_by["step_id","step_id","step_id","step_id","step_id"]
step_ids["98c798c1-57a8-fe22-16f3-2e45b8131765","f2179880-445c-35cd-b9c7-718de8553d44","02c95bac-75fe-c969-0386-c35bc9067443","b7b515cd-7960-a809-e765-df944e11386f","f6b7ace9-598d-b9d3-7791-75951d3a7c85"]
aggregated_byday
start_date1926-05-27
end_date1898-06-12
timezoneanim magna adipisicing officia in
page_size16
page_tokenin
Request Payload
Response Payload
{
  "results": [
    {
      "id": "182459f0-6429-613b-adf0-f84d7fa262b0",
      "aggregation": "voluptate ipsum consectetur labore ut",
      "step_id": "consequat elit cillum pariatur ad",
      "stats": {
        "bounce_drops": 41087165,
        "bounces": 4962430,
        "clicks": -26848568,
        "delivered": -67665888,
        "invalid_emails": -86745277,
        "opens": 7164590,
        "requests": -86727035,
        "spam_report_drops": 43172817,
        "spam_reports": 85064323,
        "unique_clicks": 15426368,
        "unique_opens": -34617348,
        "unsubscribes": -53983665
      }
    },
    {
      "id": "a9ef1031-3f40-aa6a-d19d-c7f3e0693dba",
      "aggregation": "laborum do nostrud ut in",
      "step_id": "amet exercitation sed proident mollit",
      "stats": {
        "bounce_drops": 74277424,
        "bounces": -96261790,
        "clicks": -84717852,
        "delivered": -19910373,
        "invalid_emails": 99707045,
        "opens": 58834084,
        "requests": 51444816,
        "spam_report_drops": 47922414,
        "spam_reports": -12654660,
        "unique_clicks": 57442573,
        "unique_opens": -62067781,
        "unsubscribes": -24229703
      }
    }
  ],
  "_metadata": {
    "prev": "http://XZSBZvqEwUuSDFYkLzIJCE.boeSKvKfSAlJ79ZHfrwp",
    "self": "https://ESVMRAycvMeo.yukNyBaJQ8mgps5xN,XoMKQNXLHnLGXB9ihmGZ4U9BFi4is7o,q1LhVGS.hPpHDUq5+Xhw",
    "next": "https://VmIsTMnQuoDiFhFWqZEvSFvscmyVVbq.uwxafmFKHfVMb3zMQx1O-fF,YRGMa69,drD1QkJSWM9+yOftRxcaX+JaPD7P7",
    "count": -62320660.31362002
  }
}
{
  "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["officia labore velit","sint sit id in nisi","tempor dolor eu","sunt","ut nisi ea","aute aliqua irure Excepteur magna","voluptate ea pariatur","adipisicing sed","in ut aliquip","aute ipsum quis"]
page_size53
page_tokennostrud Lorem occaecat voluptate mollit
Request Payload
Response Payload
{
  "results": [
    {
      "id": "4c1bbb7a-c104-bcaa-b0c6-21dd5bc05b61",
      "ab_variation": "1ee12785-d802-4fb2-9191-7815ee09a1de",
      "ab_phase": "send",
      "aggregation": "in sed culpa nisi ex",
      "stats": {
        "bounce_drops": 37444162,
        "bounces": -36790983,
        "clicks": 7942616,
        "delivered": -68217827,
        "invalid_emails": -64811527,
        "opens": -18391194,
        "requests": -62853351,
        "spam_report_drops": -27872369,
        "spam_reports": -81023040,
        "unique_clicks": 21454856,
        "unique_opens": 47815090,
        "unsubscribes": 87449951
      }
    },
    {
      "id": "8134afa3-cd39-d9b6-9f09-f798fd0d22db",
      "ab_variation": "ae9390c6-b680-96b3-ede4-8284db041825",
      "ab_phase": "send",
      "aggregation": "elit fugiat cupidatat ex eu",
      "stats": {
        "bounce_drops": 22295974,
        "bounces": -2986972,
        "clicks": -25496417,
        "delivered": -80313940,
        "invalid_emails": -15090523,
        "opens": 34010914,
        "requests": -68055274,
        "spam_report_drops": 67161473,
        "spam_reports": 78163221,
        "unique_clicks": 4061644,
        "unique_opens": 96603599,
        "unsubscribes": -76839677
      }
    },
    {
      "id": "7e214de1-49d2-1178-1b0a-0b8ca0482755",
      "ab_variation": "c7be9982-5349-924a-cd73-6530c6dd4316",
      "ab_phase": "all",
      "aggregation": "fugiat sit laborum cupidatat",
      "stats": {
        "bounce_drops": 57234316,
        "bounces": -89939508,
        "clicks": -63288715,
        "delivered": -57155822,
        "invalid_emails": -52935359,
        "opens": 12080134,
        "requests": -69695984,
        "spam_report_drops": 10165981,
        "spam_reports": 78398021,
        "unique_clicks": -64378160,
        "unique_opens": -19427927,
        "unsubscribes": -70965447
      }
    }
  ],
  "_metadata": {
    "prev": "http://mS.uyhsXWkJ9lARBm2+4FN48h2JLWhoGj8xBN",
    "self": "http://mtOngwLWbzbjtzFo.bujteLbW-VFHwKrjwKSj+cU7u",
    "next": "http://lCQ.txcptRmSoCy,ZwcHbTpZtvPZxI4R1Qt",
    "count": -78942229.75748537
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
aggregated_bytotal
start_date1928-02-18
end_date1929-07-17
timezoneeu sit Duis amet
page_size18
page_tokenaliquip in Excepteur
group_by["ab_variation"]
Request Payload
Response Payload
{
  "results": [
    {
      "id": "df96bc74-a57a-5196-06e3-73a03d429c5d",
      "ab_variation": "7ea35fec-590a-56c9-c970-31027192c3bf",
      "ab_phase": "send",
      "aggregation": "est in velit",
      "stats": {
        "bounce_drops": 53941803,
        "bounces": 67033390,
        "clicks": -45470492,
        "delivered": 96804009,
        "invalid_emails": 7727819,
        "opens": 44002504,
        "requests": -50197410,
        "spam_report_drops": -98950708,
        "spam_reports": 53316402,
        "unique_clicks": -30933008,
        "unique_opens": 6752272,
        "unsubscribes": 90375812
      }
    },
    {
      "id": "adde7a68-dc63-68c2-ced1-970fca9b9dca",
      "ab_variation": "845869df-64e5-d3d2-2000-6cf01d09179d",
      "ab_phase": "send",
      "aggregation": "laborum aliqua",
      "stats": {
        "bounce_drops": -9261707,
        "bounces": 93291186,
        "clicks": 76862607,
        "delivered": -68500752,
        "invalid_emails": 57497311,
        "opens": -14599882,
        "requests": -28077508,
        "spam_report_drops": 5478208,
        "spam_reports": -31398045,
        "unique_clicks": -33861506,
        "unique_opens": 1382673,
        "unsubscribes": -79047804
      }
    }
  ],
  "_metadata": {
    "prev": "http://YINkbrWucObFRJbafo.beWQJSnpWuS62W+oqgk",
    "self": "https://QhWPwIBOIogrPHzWKXrVmVq.iovDKhHcnBXbaW+7NbK.xcvTbLmW-ZmM7tlytOeqmsE5F3zZSG-aR,xpXj0dm",
    "next": "http://UwtZrqFZDYRlukk.zdNfTABkP",
    "count": -35798894.41107982
  }
}
{
  "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["d7e8da53-1ef1-553d-f95b-6cb28a178795"]
page_size63
page_tokenminim Excepteur
Request Payload
Response Payload
{
  "results": [
    {
      "url": "https://HODWiPrZlhvth.ftQ6oWESUyT-NGhxENl6",
      "url_location": 75780908,
      "step_id": "92be710b-2380-43fd-dacd-bfb0cd6b46ad",
      "clicks": 83516869
    },
    {
      "url": "https://ls.haxyraPPNI6BK",
      "url_location": 56753629,
      "step_id": "8855c6dd-8797-dd7d-5fd7-74bc17a0223c",
      "clicks": 90930535
    },
    {
      "url": "http://HyQENgTkuvkDSo.lovyJUVUCbk5rjpAazrSUiqXxzSIVVcpAQsI",
      "url_location": 38284010,
      "step_id": "5bf15d03-ab08-1adb-89d7-8f4f450e32ad",
      "clicks": 58207011
    },
    {
      "url": "https://JHv.qbdzcZge2Zjiecc2+1-shtMOipDpPvT6FCrYGNMW4ksWL,RBGfL6J",
      "url_location": 92034126,
      "step_id": "62814ba3-4a32-8d79-de81-59fb01cc7781",
      "clicks": 70235243
    },
    {
      "url": "http://jYzECtdQyGHRlaqnOofsyuwCwPGth.yaEjqv0yciOvNl7nQFvA2VbzQAS4yQbah+BYoAk2SkxxcgG2dP0w,3Dj",
      "url_location": 1565324,
      "step_id": "154164a4-dcad-7089-5989-97112245f26e",
      "clicks": 58662082
    }
  ],
  "total_clicks": -49674720,
  "_metadata": {
    "prev": "https://NEKbIBXLhHovMVByNBnyvXMkefBke.qzgLtHLU4QSmfdOrZ0NDhqNS9pMvVe8r1nVZ7EBDLFthMuL+pGjy",
    "self": "http://gLQ.quwN8rKGTWiHbxzIYfTCiA2D,rLOoDauZlnokFYq",
    "next": "https://jOqnxJqQfp.wtnX96SBtB0xKeZSbtOmFnNQuYv+6po2IyYcwUuhZ-Ix3ACnE1m2NSsRzwWRokNEBJKHNww",
    "count": -6403415.548805341
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
page_size56
page_tokenUt minim dolor
group_by["ab_phase","ab_phase","ab_phase"]
ab_variation_id1e81aad5-d55c-cd55-77fe-1a09d6cc8019
ab_phase_idtest
Request Payload
Response Payload
{
  "results": [
    {
      "url": "http://s.xxWaLcsH3bBkMyzAY0C3Jcei98LY8+tAWV+x0ccVhrUmZ1VsKkpfb.NUU,vOIaZvNnCqwul2NEW",
      "url_location": 29255381,
      "ab_variation": "8fbfd7f4-b7d2-9c36-4a3a-c4601f61462d",
      "ab_phase": "test",
      "clicks": 15563377
    },
    {
      "url": "http://aVxVgmAyIkVEWAjDdCL.wuvzOqFxq5PNp3wod1isi7wiWsH",
      "url_location": 64300591,
      "ab_variation": "ed9ea3ca-a597-4f09-bfe7-d51e64a89638",
      "ab_phase": "test",
      "clicks": 16982589
    }
  ],
  "_metadata": {
    "prev": "http://cNZeiBXLpOFSNrTu.bfmeDlKGndlfaFTAg4pFwr62UFy-NO",
    "self": "https://XhXSkDZqkXLlmYGwHSgWVcLqfPRTf.kxWo01hB,pi.tfQc8F2",
    "next": "http://gLLezUportBcVtXomhbEKkCDGfWTeZcAm.jrfLCXl3nTPeKGCe1oPzjMrwv",
    "count": -79047596.36459544
  },
  "total_clicks": 32763089
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
Query Parameter NameExample
ids["veniam ad","ad eu","id amet","voluptate dolore mollit ipsum","id culpa","enim laborum quis in sit","in nulla et in velit","laboris dolor quis aliquip culpa","ullamco in laboris eu","dolore aliquip"]
timezoneLorem laborum laboris
Request Payload
Response Payload
veniam dolor id occaecat ut
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
ids["ex cillum in aliquip","voluptate laborum est in occaecat","velit amet occaecat","ad proident culpa Duis occaecat","cillum ea","voluptate officia","ex tempor cupidatat velit","dolor cillum quis","eu et Duis cupidatat ut","veniam"]
timezonein non
Request Payload
Response Payload
sed in ut
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Sender Identities API(6 operations)

Header NameExample
on-behalf-of"eiusmod dolore"
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"culpa nostrud qui eu"
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"ut"
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"velit ad incididunt"
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"in in"
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"aute exercitation officia reprehenderit"
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"pariatur veniam laborum exercitation"
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"est eiusmod"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1,
      "name": "the jones",
      "recipient_count": 1
    }
  ]
}
Header NameExample
on-behalf-of"aliquip aliqua qui"
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-33859709
Header NameExample
on-behalf-of"reprehenderit eiusmod minim"
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*-61736568
Header NameExample
on-behalf-of"labore"
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"sit laborum sunt quis sint"
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-23158591
page_size-59348007
list_id*15425057
Header NameExample
on-behalf-of"commodo deserunt amet"
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"et aliquip enim est ex"
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"eiusmod consectetur culpa"
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*-80263330
recipient_id*88385084
Header NameExample
on-behalf-of"aliquip Lorem in anim ut"
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"ex irure nulla aliqua nostrud"
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"non"
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"consequat"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
{}
{
  "errors": [
    {
      "message": "No recipient ids provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
page-29096035
page_size3619456
Header NameExample
on-behalf-of"aliquip minim Lorem esse"
Request Payload
Response Payload
{
  "recipients": []
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"nulla amet"
Request Payload
Response Payload
{
  "status": [
    {
      "id": "worker_delay",
      "value": "delayed"
    },
    {
      "id": "worker_delay_seconds",
      "value": "75.0"
    }
  ]
}
Header NameExample
on-behalf-of"Lorem nulla amet"
Request Payload
Response Payload
{
  "recipients": [
    {
      "id": "sed quis",
      "created_at": 5677108.772795677,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "9dhtjc@MbVkyhX.bl",
      "first_name": null,
      "last_name": null,
      "last_clicked": 16771803.924993962,
      "last_emailed": null,
      "last_opened": null,
      "updated_at": -46182912.28319924
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"aute ut Duis"
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"nulla incididunt sint in consectetur"
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"do"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"quis Duis"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
{field_name}ad Lorem et
Header NameExample
on-behalf-of"aliqua minim veniam in elit"
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"consectetur"
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"sit"
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"in et"
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"pariatur adipisicing quis minim cillum"
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"adipisicing id in"
Request Payload
Response Payload
{
  "reserved_fields": [
    {
      "name": "first_name",
      "type": "text"
    },
    {
      "name": "last_name",
      "type": "text"
    },
    {
      "name": "email",
      "type": "text"
    },
    {
      "name": "created_at",
      "type": "date"
    },
    {
      "name": "updated_at",
      "type": "date"
    },
    {
      "name": "last_emailed",
      "type": "date"
    },
    {
      "name": "last_clicked",
      "type": "date"
    },
    {
      "name": "last_opened",
      "type": "date"
    },
    {
      "name": "lists",
      "type": "set"
    },
    {
      "name": "campaigns",
      "type": "set"
    },
    {
      "name": "my_custom_field",
      "type": "text"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Contacts API - Segments(6 operations)

Header NameExample
on-behalf-of"nisi"
Request Payload
{
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    },
    {
      "field": "last_clicked",
      "value": "01/02/2015",
      "operator": "gt",
      "and_or": "and"
    },
    {
      "field": "clicks.campaign_identifier",
      "value": "513",
      "operator": "eq",
      "and_or": "or"
    }
  ]
}
Response Payload
{
  "id": 1,
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    },
    {
      "field": "last_clicked",
      "value": "01/02/2015",
      "operator": "gt",
      "and_or": "and"
    },
    {
      "field": "clicks.campaign_identifier",
      "value": "513",
      "operator": "eq",
      "and_or": "or"
    }
  ],
  "recipient_count": 0
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"ex Excepteur sed esse do"
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*97741138
Header NameExample
on-behalf-of"Excepteur"
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_idesse fugiat
Header NameExample
on-behalf-of"dolor"
Request Payload
{
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ]
}
Response Payload
{
  "id": 5,
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ],
  "recipient_count": 1
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "segment_id": "segment_id",
      "message": "segment id is not valid"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
delete_contactstrue
Header NameExample
on-behalf-of"laboris aute exercitation 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
page12453937
page_size58201269
Header NameExample
on-behalf-of"dolor nulla tempor"
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
limit49440714
categorydolor enim nulla elit
offset-2022368
Header NameExample
on-behalf-of"dolore"
Request Payload
Response Payload
[
  {
    "category": "category 1"
  },
  {
    "category": "category 2"
  }
]
{
  "errors": [
    {
      "field": "sort_by",
      "message": "invalid sort value"
    }
  ]
}
Query Parameter NameExample
sort_by_metricveniam cillum aute
sort_by_directionasc
start_date*Duis amet qui
end_datefugiat dolore tempor commodo amet
limit-80114734
offset-51618614
aggregated_bymonth
Header NameExample
on-behalf-of"ipsum do laboris"
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*amet officia
end_dateid nulla et
categories*laboris
limit-73276831
offset59006278
aggregated_byday
Header NameExample
on-behalf-of"Excepteur voluptate"
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"nisi commodo"
Request Payload
{
  "title": "March Newsletter",
  "subject": "New Products for Spring!",
  "sender_id": 124451,
  "list_ids": [
    110,
    124
  ],
  "segment_ids": [
    110
  ],
  "categories": [
    "spring line"
  ],
  "suppression_group_id": 42,
  "custom_unsubscribe_url": "",
  "ip_pool": "marketing",
  "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
  "plain_content": "Check out our spring line!"
}
Response Payload
{
  "id": 986724,
  "title": "March Newsletter",
  "subject": "New Products for Spring!",
  "sender_id": 124451,
  "list_ids": [
    110,
    124
  ],
  "segment_ids": [
    110
  ],
  "categories": [
    "spring line"
  ],
  "suppression_group_id": 42,
  "custom_unsubscribe_url": "",
  "ip_pool": "marketing",
  "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
  "plain_content": "Check out our spring line!",
  "status": "Draft"
}
{
  "errors": [
    {
      "field": "title",
      "message": "title can't be blank"
    },
    {
      "field": "title",
      "message": "title is too long (maximum is 100 characters)"
    },
    {
      "field": "categories",
      "message": "categories exceeds 10 category limit"
    },
    {
      "field": "html_content",
      "message": "html_content exceeds the 1MB limit"
    },
    {
      "field": "plain_content",
      "message": "plain_content exceeds the 1MB limit"
    },
    {
      "field": "sender_id",
      "message": "sender_id does not exist"
    },
    {
      "field": "sender_id",
      "message": "sender_id is not a verified sender identity"
    },
    {
      "field": "list_ids",
      "message": "list_ids do not all exist"
    },
    {
      "field": "segment_ids",
      "message": "segment_ids do not all exist"
    },
    {
      "field": "ip_pool",
      "message": "The ip pool you provided is invalid"
    },
    {
      "field": "suppression_group_id",
      "message": "suppression_group_id does not exist"
    },
    {
      "field": "unsubscribes",
      "message": "Either suppression_group_id or custom_unsubscribe_url may be set/used, but not both. Please remove one before setting the other."
    },
    {
      "field": null,
      "message": "The JSON you have submitted cannot be parsed."
    },
    {
      "field": null,
      "message": "You've reached your limit of 250 campaigns. Please delete one or more and try again."
    }
  ]
}
{}
Query Parameter NameExample
limit-24581642
offset27789190
Header NameExample
on-behalf-of"cupidatat ipsum magna sit incididunt"
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"commodo fugiat anim labore"
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"commodo aliquip nostrud deserunt"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"deserunt commodo adipisicing officia et"
Request Payload
{
  "title": "May Newsletter",
  "subject": "New Products for Summer!",
  "categories": [
    "summer line"
  ],
  "html_content": "<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>",
  "plain_content": "Check out our summer line!"
}
Response Payload
{
  "id": 986724,
  "title": "May Newsletter",
  "subject": "New Products for Summer!",
  "sender_id": 124451,
  "list_ids": [
    110,
    124
  ],
  "segment_ids": [
    110
  ],
  "categories": [
    "summer line"
  ],
  "suppression_group_id": 42,
  "custom_unsubscribe_url": "",
  "ip_pool": "marketing",
  "html_content": "<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>",
  "plain_content": "Check out our summer line!",
  "status": "Draft"
}
{
  "errors": [
    {
      "field": "title",
      "message": "title can't be blank"
    },
    {
      "field": "title",
      "message": "title is too long (maximum is 100 characters)"
    },
    {
      "field": "categories",
      "message": "categories exceeds 10 category limit"
    },
    {
      "field": "html_content",
      "message": "html_content exceeds the 1MB limit"
    },
    {
      "field": "plain_content",
      "message": "plain_content exceeds the 1MB limit"
    },
    {
      "field": "sender_id",
      "message": "sender_id does not exist"
    },
    {
      "field": "sender_id",
      "message": "sender_id is not a verified sender identity"
    },
    {
      "field": "list_ids",
      "message": "list_ids do not all exist"
    },
    {
      "field": "segment_ids",
      "message": "segment_ids do not all exist"
    },
    {
      "field": "ip_pool",
      "message": "The ip pool you provided is invalid"
    },
    {
      "field": "suppression_group_id",
      "message": "suppression_group_id does not exist"
    },
    {
      "field": "unsubscribes",
      "message": "Either suppression_group_id or custom_unsubscribe_url may be set/used, but not both. Please remove one before setting the other."
    },
    {
      "field": null,
      "message": "The JSON you have submitted cannot be parsed."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "You may only update a campaign when it is in draft mode."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"sed ad tempor dolore Excepteur"
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"laborum qui"
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"incididunt esse veniam ex"
Request Payload
{
  "send_at": 1489451436
}
Response Payload
{
  "id": -34103051,
  "send_at": -14107154,
  "status": "sint eu do sunt sit"
}
{
  "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"non fugiat pariatur"
Request Payload
Response Payload
{
  "send_at": 1490778528
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"Duis"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "This campaign is already In Progress."
    },
    {
      "field": null,
      "message": "This campaign is already Sent."
    },
    {
      "field": null,
      "message": "This campaign is already Paused."
    },
    {
      "field": null,
      "message": "This campaign is already Canceled."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"mollit"
Request Payload
{
  "to": "your.email@example.com"
}
Response Payload
{
  "to": "dolore occaecat ipsum nulla"
}
{
  "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"commodo ut deserunt voluptate"
Request Payload
{
  "name": "example_name",
  "generation": "dynamic"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "example_name",
  "generation": "legacy",
  "versions": []
}
Query Parameter NameExample
generationslegacy
page_size*54.475794173565674
page_tokenid
Header NameExample
on-behalf-of"voluptate officia occaecat sed"
Request Payload
Response Payload
{
  "result": [
    {
      "id": "fae7c985-eb92-4b47-9987-28ec29dbc698",
      "name": "example_name",
      "generation": "legacy",
      "updated_at ": "2020-11-12 12:00:09",
      "versions": []
    }
  ],
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/templates",
    "count": 1
  }
}
{
  "errors": [
    {
      "": "mollit",
      "message": "incididunt",
      "error_id": "ut aliquip consequat"
    },
    {
      "": "dolore proident",
      "message": "proident culpa",
      "error_id": "elit Lorem eiusmod dolore"
    },
    {
      "": "deserunt magna adipisicing ipsum",
      "message": "consectetur",
      "error_id": "ullamco do"
    },
    {
      "": "consequat",
      "message": "consectetur mollit",
      "error_id": "ipsum nisi proident dolore"
    },
    {
      "": "incididunt reprehenderit exercitation cillum",
      "message": "mollit",
      "error_id": "voluptate est"
    }
  ]
}
Header NameExample
on-behalf-of"Excepteur"
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"ad 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 commodo officia"
Request Payload
{
  "name": "new_example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "new_example_name",
  "versions": []
}
Header NameExample
on-behalf-of"aliquip consectetur ut qui irure"
Request Payload
Response Payload
{}

Transactional Templates Versions(5 operations)

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

Query(2 operations)

Query Parameter NameExample
query*pariatur non
limit536.2350827632005
Header NameExample
X-Query-Id"ad ea"
X-Cursor"aute aliquip proident ea"
Authorization*"fugiat elit tempor ea ipsum"
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*"sed ea"
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
queryenim adipisicing
Header NameExample
Authorization*"proident do Ut consectetur"
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*"pariatur non"
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"enim minim eu voluptate elit"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "open",
      "title": "Open Tracking",
      "description": "lorem ipsum... .",
      "enabled": true
    }
  ]
}
Header NameExample
on-behalf-of"ea ullamco"
Request Payload
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"qui consequat sit dolore"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"aliquip occaecat"
Request Payload
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"sint cillum in officia"
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"in nisi nulla"
Request Payload
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"cillum in"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"ex quis"
Request Payload
Response Payload
{
  "enabled": true,
  "html_content": "<p>Something something unsubscribe <% %> something something</p>\n",
  "landing": "<p>subscribehere</p>\n",
  "plain_content": "Something something unsubscribe <% %> something something",
  "replace": "thetag",
  "url": ""
}
Header NameExample
on-behalf-of"irure"
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-17284994
offset-18865152
aggregated_bymonth
start_date*cupidatat ipsum sunt
end_datedolore
Header NameExample
on-behalf-of"ea fugiat"
Request Payload
Response Payload
[
  {
    "date": "2015-11-03",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
countryCA
limit49996697
offset-73148512
aggregated_bymonth
start_date*aliqua incididunt id laboris Ut
end_dateculpa
Header NameExample
on-behalf-of"proident magna et ex"
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
limit41469865
offset44998651
aggregated_byday
start_date*culpa
end_dateest do
Header NameExample
on-behalf-of"cupidatat"
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*velit sint dolor Excepteur
end_datemollit
aggregated_byday
Header NameExample
on-behalf-of"eu sunt consectetur veniam nulla"
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*Lorem minim dolor anim
end_datelaboris et id sed
aggregated_bymonth
Header NameExample
on-behalf-of"culpa adipisicing qui"
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_providersoccaecat id aute
limit-26711430
offset35414319
aggregated_bymonth
start_date*sint elit
end_dateculpa pariatur tempor Lorem
Header NameExample
on-behalf-of"ut exercitation"
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
browsersculpa eiusmod quis
limit98055948
offset75184388
aggregated_bymonth
start_date*Excepteur
end_datesint Ut dolore sit
Header NameExample
on-behalf-of"veniam dolor deserunt Duis eu"
Request Payload
Response Payload
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "clicks": 0,
          "unique_clicks": 0
        },
        "name": "Chrome",
        "type": "browser"
      },
      {
        "metrics": {
          "clicks": 1,
          "unique_clicks": 1
        },
        "name": "Firefox",
        "type": "browser"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "clicks": 0,
          "unique_clicks": 0
        },
        "name": "Chrome",
        "type": "browser"
      },
      {
        "metrics": {
          "clicks": 1,
          "unique_clicks": 1
        },
        "name": "Firefox",
        "type": "browser"
      }
    ]
  }
]

Bounces API(4 operations)

Query Parameter NameExample
start_time-24686877
end_time3639652
Header NameExample
Accept*"et nulla"
on-behalf-of"voluptate ut nostrud labore"
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"veniam tempor quis"
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"eu"
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*e2PkGD4QcNirDI@uBanfTcPiPevriowpjQjliJqyGFZHa.ph
Header NameExample
on-behalf-of"in ut"
Request Payload
Error generating example
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Blocks API(4 operations)

Query Parameter NameExample
start_time-26870677
end_time-28130766
limit15898313
offset-53826834
Header NameExample
on-behalf-of"adipisicing mollit aute aliquip in"
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"ullamco labore ut"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"et quis laborum Excepteur enim"
Request Payload
Response Payload
[
  {
    "created": 1443651154,
    "email": "example@example.com",
    "reason": "error dialing remote address: dial tcp 10.57.152.165:25: no route to host",
    "status": "4.0.0"
  }
]
Header NameExample
on-behalf-of"ad ea"
Request Payload
Response Payload
{}

Spam Reports API(4 operations)

Query Parameter NameExample
start_time-52465232
end_time-26598229
limit67792385
offset91834224
Header NameExample
on-behalf-of"ex et non"
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"dolore consectetur sint"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"in"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "ip": "10.89.32.5"
  }
]
Header NameExample
on-behalf-of"non laboris"
Request Payload
Response Payload
{}

Suppressions - Global Suppressions(4 operations)

Header NameExample
on-behalf-of"consequat"
Request Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Response Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Query Parameter NameExample
start_time-27795944
end_time-95109197
limit46837280
offset8123880
Header NameExample
on-behalf-of"laborum in eu"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com"
  }
]
Header NameExample
on-behalf-of"magna consequat"
Request Payload
Response Payload
{
  "recipient_email": "test@example.com"
}
Header NameExample
on-behalf-of"deserunt ad proident ullamco minim"
Request Payload
Response Payload
{}

Suppressions - Unsubscribe Groups(5 operations)

Header NameExample
on-behalf-of"dolore cupidatat nisi incididunt dolore"
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
id59890861
Header NameExample
on-behalf-of"dolore non"
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"ex consequat Lorem cillum"
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"sunt"
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"mollit"
Request Payload
Response Payload
{}

Suppressions - Suppressions(6 operations)

Header NameExample
on-behalf-of"tempor"
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"sit reprehenderit ut dolor commodo"
Request Payload
Response Payload
[
  "example@example.com",
  "example2@example.com"
]
Header NameExample
on-behalf-of"Duis ea ullamco commodo cillum"
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"dolore voluptate in elit"
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"in tempor in"
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"eu sint in eiusmod"
Request Payload
Response Payload
Error generating example

Invalid Emails API(4 operations)

Query Parameter NameExample
start_time-21792771
end_time23652359
limit24920282
offset92308759
Header NameExample
on-behalf-of"aliquip elit"
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"enim ad dolore ex laborum"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"in minim culpa aliqua sunt"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]
Header NameExample
on-behalf-of"fugiat do ea irure"
Request Payload
Response Payload
{}
Service Homepage: sendgrid.com/en-us
API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started
emails