Sendgrid V3 Virtual Sandbox

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.

Use this hosted sandbox to simulate Sendgrid V3 APIs without authentication, API keys, or extra dependencies. Point your code or SDK to the Beeceptor base URL, preferably through an environment variable or feature flag, and switch back to the production API when ready. This keeps your integration code consistent across local development, QA, demos, and production.

Sendgrid V3 virtual sandbox is up and running!

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

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

Mail Send

POST

/v3/mail/send

The Mail Send endpoint allows you to send email over SendGrid’s v3 Web API, the most recent version of our API. If you are looking for documentation about the v2 Mail Send endpoint, see our [v2 API Reference](https://sendgrid.com/docs/API_Reference/Web_API/mail.html). ## Helper Libraries Twilio S

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": "in proident ea nulla magna"
    }
  ]
}

Cancel Scheduled Sends(7 operations)

POST

/v3/mail/batch

**This endpoint allows you to generate a new batch ID.** Once a `batch_id` is created, you can associate it with a scheduled send using the `/mail/send` endpoint. Passing the `batch_id` as a field in the `/mail/send` request body will assign the ID to the send you are creating. Once an ID is asso

Header Name	Example
`on-behalf-of`	`"Lorem culpa eiusmod"`

Request Payload

Response Payload

{
  "batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi"
}

{
  "errors": [
    {
      "field": "reprehenderit mollit consequat ea",
      "help": {},
      "message": "labore incididunt do veniam"
    },
    {
      "field": "est sint exercitation",
      "help": {},
      "message": "culpa"
    },
    {
      "field": "anim Duis voluptate velit",
      "help": {},
      "message": "nulla mollit"
    },
    {
      "field": "cillum sunt dolore Excepteur",
      "help": {},
      "message": "in"
    }
  ],
  "id": "id irure dolor sed ullamco"
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "velit in"
    },
    {
      "message": "Duis Ut nisi"
    },
    {
      "message": "eu occaecat officia Excepteur"
    }
  ]
}

POST

/v3/user/scheduled_sends

**This endpoint allows you to cancel or pause a scheduled send associated with a `batch_id`.** Passing this endpoint a `batch_id` and status will cancel or pause the scheduled send. Once a scheduled send is set to `pause` or `cancel` you must use the "Update a scheduled send" endpoint to change i

Header Name	Example
`on-behalf-of`	`"anim laborum aliqua"`

Request Payload

{
  "batch_id": "YOUR_BATCH_ID",
  "status": "pause"
}

Response Payload

{
  "batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi",
  "status": "pause"
}

{
  "errors": [
    {
      "field": "ullamco consectetur nulla irure",
      "help": {},
      "message": "do aute sunt"
    }
  ],
  "id": "culpa Lorem"
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "tempor laboris dolore"
    },
    {
      "message": "est cupidatat anim proident et"
    }
  ]
}

GET

/v3/user/scheduled_sends

**This endpoint allows you to retrieve all cancelled and paused scheduled send information.** This endpoint will return only the scheduled sends that are associated with a `batch_id`. If you have scheduled a send using the `/mail/send` endpoint and the `send_at` field but no `batch_id`, the send w

Header Name	Example
`on-behalf-of`	`"in minim"`

Request Payload

Response Payload

[
  {
    "batch_id": "QzZmYzLTVWIwYgYzJlM2NhNWI",
    "status": "cancel"
  },
  {
    "batch_id": "mQzZmYzLTVlM2NhNWIwYgYzJl",
    "status": "cancel"
  }
]

{
  "errors": [
    {
      "field": "proident minim ullamco",
      "help": {},
      "message": "enim irure nisi"
    },
    {
      "field": "Ut deserunt do sunt",
      "help": {},
      "message": "et sunt Duis cupidatat"
    },
    {
      "field": "minim cupidatat ut reprehenderit in",
      "help": {},
      "message": "enim Excepteur eu velit"
    },
    {
      "field": "et anim laborum in",
      "help": {},
      "message": "dolor sed do est eu"
    }
  ],
  "id": "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 tempor amet id"
    },
    {
      "message": "elit nostrud"
    },
    {
      "message": "minim"
    },
    {
      "message": "eu fugiat proident amet"
    }
  ]
}

GET

/v3/mail/batch/{batch_id}

**This endpoint allows you to validate a batch ID.** When you pass a valid `batch_id` to this endpoint, it will return a `200` status code and the batch ID itself. If you pass an invalid `batch_id` to the endpoint, you will receive a `400` level status code and an error message. A `batch_id` doe

Header Name	Example
`on-behalf-of`	`"quis do"`

Request Payload

Response Payload

{
  "batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi"
}

{
  "errors": [
    {
      "field": "labore",
      "help": {},
      "message": "officia"
    }
  ],
  "id": "pariatur enim nostrud et"
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "dolore ut deserunt ut"
    }
  ]
}

GET

/v3/user/scheduled_sends/{batch_id}

**This endpoint allows you to retrieve the cancel/paused scheduled send information for a specific `batch_id`.**

Header Name	Example
`on-behalf-of`	`"sit"`

Request Payload

Response Payload

[
  {
    "batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi",
    "status": "cancel"
  },
  {
    "batch_id": "IbLdyLYULb7Rj8GKSx7u025ouWVlAiMg",
    "status": "pause"
  }
]

{
  "errors": [
    {
      "field": "cillum id ea",
      "help": {},
      "message": "labore laborum occaecat dolor"
    },
    {
      "field": "qui dolor tempor irure",
      "help": {},
      "message": "ipsum amet"
    },
    {
      "field": "reprehenderit Ut",
      "help": {},
      "message": "sed"
    },
    {
      "field": "tempor",
      "help": {},
      "message": "cillum ad anim laboris laborum"
    },
    {
      "field": "sed est Excepteur sit",
      "help": {},
      "message": "qui est sunt enim"
    }
  ],
  "id": "dolor tempor"
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "anim"
    },
    {
      "message": "nisi sed"
    },
    {
      "message": "anim Excepteur"
    },
    {
      "message": "fugiat tempor laborum eu ullamco"
    },
    {
      "message": "culpa"
    }
  ]
}

PATCH

/v3/user/scheduled_sends/{batch_id}

**This endpoint allows you to update the status of a scheduled send for the given `batch_id`.** If you have already set a `cancel` or `pause` status on a scheduled send using the "Cancel or pause a scheduled send" endpoint, you can update it's status using this endpoint. Attempting to update a sta

Header Name	Example
`on-behalf-of`	`"cillum ad"`

Request Payload

{
  "status": "pause"
}

Response Payload

Error generating example

{
  "errors": [
    {
      "field": "exercitation sed veniam",
      "help": {},
      "message": "veniam occaecat dolor"
    },
    {
      "field": "est aliqua",
      "help": {},
      "message": "quis ullamco est"
    },
    {
      "field": "Duis anim tempor Lorem",
      "help": {},
      "message": "commodo"
    },
    {
      "field": "sed ex irure est",
      "help": {},
      "message": "consequat culpa elit pariatur"
    }
  ],
  "id": "consectetur officia velit"
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "ad irure non mollit eiusmod"
    },
    {
      "message": "ut Duis eu eiusmod"
    },
    {
      "message": "proident veniam in"
    },
    {
      "message": "dolore mollit"
    },
    {
      "message": "eu Ut do aliquip in"
    }
  ]
}

DELETE

/v3/user/scheduled_sends/{batch_id}

**This endpoint allows you to delete the cancellation/pause of a scheduled send.** Scheduled sends cancelled less than 10 minutes before the scheduled time are not guaranteed to be cancelled.

Header Name	Example
`on-behalf-of`	`"cupidatat in aute dolor aliquip"`

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "errors": [
    {
      "field": "elit anim in nostrud",
      "help": {},
      "message": "incididunt qui occaecat eiusmod magna"
    },
    {
      "field": "aliqua pariatur",
      "help": {},
      "message": "nisi ea culpa aute consectetur"
    },
    {
      "field": "sed ullamco",
      "help": {},
      "message": "cupidatat dolore"
    },
    {
      "field": "est Duis reprehenderit in occaecat",
      "help": {},
      "message": "non Lorem do"
    },
    {
      "field": "elit ut ipsum",
      "help": {},
      "message": "esse voluptate"
    }
  ],
  "id": "velit dolor magna Duis nostrud"
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "culpa dolor nisi"
    },
    {
      "message": "Lorem"
    },
    {
      "message": "sit nisi Ut elit adipisicing"
    },
    {
      "message": "officia ut"
    },
    {
      "message": "elit non exercitation fugiat"
    }
  ]
}

API Keys(6 operations)

POST

/v3/api_keys

**This endpoint allows you to create a new API Key for the user.** To create your initial SendGrid API Key, you should [use the SendGrid App](https://app.sendgrid.com/settings/api_keys). Once you have created a first key with scopes to manage additional API keys, you can use this API for all other

Header Name	Example
`on-behalf-of`	`"incididunt proident in"`

Request Payload

{
  "name": "My API Key",
  "scopes": [
    "mail.send",
    "alerts.create",
    "alerts.read"
  ]
}

Response Payload

{
  "api_key": "SG.xxxxxxxx.yyyyyyyy",
  "api_key_id": "xxxxxxxx",
  "name": "My API Key",
  "scopes": [
    "mail.send",
    "alerts.create",
    "alerts.read"
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "consequat sed consectetur sunt"
    },
    {
      "message": "labore ullamco"
    },
    {
      "message": "nostrud veniam"
    },
    {
      "message": "sunt"
    },
    {
      "message": "dolore dolore ea adipisicing sint"
    }
  ]
}

GET

/v3/api_keys

**This endpoint allows you to retrieve all API Keys that belong to the authenticated user.** A successful response from this API will include all available API keys' names and IDs. For security reasons, there is not a way to retrieve the key itself after it's created. If you lose your API key, yo

Query Parameter Name	Example
`limit`	`-81361637`

Header Name	Example
`on-behalf-of`	`"pariatur dolor"`

Request Payload

Response Payload

{
  "result": [
    {
      "name": "API Key Name",
      "api_key_id": "some-apikey-id"
    },
    {
      "name": "API Key Name 2",
      "api_key_id": "another-apikey-id"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "irure laborum ut nulla"
    },
    {
      "message": "ut pariatur"
    },
    {
      "message": "cillum qui"
    },
    {
      "message": "irure dolor dolor dolore"
    }
  ]
}

GET

/v3/api_keys/{api_key_id}

**This endpoint allows you to retrieve a single API key using an `api_key_id`.** The endpoint will return a key's name, ID, and scopes. If the API Key ID does not, exist a `404` status will be returned. See the [API Key Permissions List](https://sendgrid.api-docs.io/v3.0/how-to-use-the-sendgrid-v

Header Name	Example
`on-behalf-of`	`"nisi"`

Request Payload

Response Payload

{
  "result": [
    {
      "name": "API Key Name",
      "api_key_id": "some-apikey-id"
    },
    {
      "name": "API Key Name 2",
      "api_key_id": "another-apikey-id"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "est ut mollit officia"
    },
    {
      "message": "ex minim nostrud aliqua proident"
    },
    {
      "message": "in"
    },
    {
      "message": "qui"
    }
  ]
}

PATCH

/v3/api_keys/{api_key_id}

**This endpoint allows you to update the name of an existing API Key.** You must pass this endpoint a JSON request body with a `name` property, which will be used to rename the key associated with the `api_key_id` passed in the URL.

Header Name	Example
`on-behalf-of`	`"Lorem laborum eiusmod"`

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": "mollit est consectetur sed"
    },
    {
      "message": "quis"
    },
    {
      "message": "id occaecat"
    }
  ]
}

PUT

/v3/api_keys/{api_key_id}

**This endpoint allows you to update the name and scopes of a given API key.** You must pass this endpoint a JSON request body with a `name` field and a `scopes` array containing at least one scope. The `name` and `scopes` fields will be used to update the key associated with the `api_key_id` in t

Header Name	Example
`on-behalf-of`	`"in minim et nulla"`

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": "tempor qui voluptate consequat ex"
    },
    {
      "message": "cillum anim deserunt in nostrud"
    },
    {
      "message": "tempor sit in"
    }
  ]
}

DELETE

/v3/api_keys/{api_key_id}

**This endpoint allows you to revoke an existing API Key using an `api_key_id`** Authentications using a revoked API Key will fail after after some small propogation delay. If the API Key ID does not exist, a `404` status will be returned.

Header Name	Example
`on-behalf-of`	`"quis labore eu"`

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": "anim nostrud dolore"
    },
    {
      "message": "do dolore nostrud consectetur"
    },
    {
      "message": "aute officia laborum nisi cupidatat"
    },
    {
      "message": "sed labore"
    },
    {
      "message": "cupidatat dolor voluptate"
    }
  ]
}

API Key Permissions

GET

/v3/scopes

**This endpoint returns a list of all scopes that this user has access to.** API Keys are used to authenticate with [SendGrid's v3 API](https://sendgrid.api-docs.io/v3.0/how-to-use-the-sendgrid-v3-api/api-authorization). API Keys may be assigned certain permissions, or scopes, that limit which AP

Header Name	Example
`on-behalf-of`	`"tempor id proident labore"`

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": "proident mollit"
    },
    {
      "message": "mollit Excepteur"
    },
    {
      "message": "culpa cupidatat"
    },
    {
      "message": "amet elit laboris deserunt"
    }
  ]
}

Settings - Enforced TLS(2 operations)

GET

/v3/user/settings/enforced_tls

**This endpoint allows you to retrieve your current Enforced TLS settings.** The Enforced TLS settings specify whether or not the recipient is required to support TLS or have a valid certificate. If either `require_tls` or `require_valid_cert` is set to `true`, the recipient must support TLS 1.1

Header Name	Example
`on-behalf-of`	`"sit qui"`

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": "Lorem ea ullamco Ut"
    },
    {
      "message": "dolore eu laborum"
    },
    {
      "message": "ex ad sunt"
    }
  ]
}

PATCH

/v3/user/settings/enforced_tls

**This endpoint allows you to update your Enforced TLS settings.** To require TLS from recipients, set `require_tls` to `true`. If either `require_tls` or `require_valid_cert` is set to `true`, the recipient must support TLS 1.1 or higher or have a valid certificate. If these conditions are not me

Header Name	Example
`on-behalf-of`	`"exercitation aliquip"`

Request Payload

{
  "require_tls": true,
  "require_valid_cert": true
}

Response Payload

{
  "require_tls": true,
  "require_valid_cert": false
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "ut"
    },
    {
      "message": "irure Lorem proident"
    },
    {
      "message": "officia ipsum culpa amet in"
    },
    {
      "message": "do in aliquip"
    },
    {
      "message": "Duis"
    }
  ]
}

IP Access Management(6 operations)

POST

/v3/access_settings/whitelist

**This endpoint allows you to add one or more allowed IP addresses.** To allow one or more IP addresses, pass them to this endpoint in an array. Once an IP address is added to your allow list, it will be assigned an `id` that can be used to remove the address. You can retrieve the ID associated wi

Header Name	Example
`on-behalf-of`	`"deserunt"`

Request Payload

{
  "ips": [
    {
      "ip": "192.168.1.1"
    },
    {
      "ip": "192.*.*.*"
    },
    {
      "ip": "192.168.1.3/32"
    }
  ]
}

Response Payload

{
  "result": [
    {
      "id": 1,
      "ip": "192.168.1.1/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    },
    {
      "id": 2,
      "ip": "192.0.0.0/8",
      "created_at": 1441824715,
      "updated_at": 1441824715
    },
    {
      "id": 3,
      "ip": "192.168.1.3/32",
      "created_at": 1441824715,
      "updated_at": 1441824715
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "voluptate aliquip et nulla"
    },
    {
      "message": "consectetur enim nulla ipsum"
    }
  ]
}

GET

/v3/access_settings/whitelist

**This endpoint allows you to retrieve a list of IP addresses that are currently allowed to access your account.** Each IP address returned to you will have `created_at` and `updated_at` dates. Each IP will also be associated with an `id` that can be used to remove the address from your allow list.

Header Name	Example
`on-behalf-of`	`"Excepteur magna"`

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": "cillum mollit aliqua quis in"
    },
    {
      "message": "proident sint Lorem"
    },
    {
      "message": "Lorem Ut"
    },
    {
      "message": "nostrud laboris mollit anim commodo"
    }
  ]
}

DELETE

/v3/access_settings/whitelist

**This endpoint allows you to remove one or more IP addresses from your list of allowed addresses.** To remove one or more IP addresses, pass this endpoint an array containing the ID(s) associated with the IP(s) you intend to remove. You can retrieve the IDs associated with your allowed IP address

Header Name	Example
`on-behalf-of`	`"Ut ex id"`

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": "occaecat et Excepteur sunt aliqua"
    },
    {
      "message": "consequat deserunt irure aliquip non"
    },
    {
      "message": "minim ut occaecat ullamco Duis"
    },
    {
      "message": "nostrud magna"
    }
  ]
}

GET

/v3/access_settings/activity

**This endpoint allows you to retrieve a list of all of the IP addresses that recently attempted to access your account either through the User Interface or the API.**

Query Parameter Name	Example
`limit`	`-18035475`

Header Name	Example
`on-behalf-of`	`"irure dolor"`

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": "elit laboris nisi ullamco"
    },
    {
      "message": "elit eiusmod non magna"
    },
    {
      "message": "ad"
    },
    {
      "message": "est dolor aliquip ex Excepteur"
    },
    {
      "message": "eiusmod exercitation nisi fugiat enim"
    }
  ]
}

GET

/v3/access_settings/whitelist/{rule_id}

**This endpoint allows you to retreive a specific IP address that has been allowed to access your account.** You must include the ID for the specific IP address you want to retrieve in your call. You can retrieve the IDs associated with your allowed IP addresses using the "Retrieve a list of curr

Header Name	Example
`on-behalf-of`	`"exercitation anim id"`

Request Payload

Response Payload

{
  "id": 1,
  "ip": "192.168.1.1",
  "created_at": 1441824715,
  "updated_at": 1441824715
}

DELETE

/v3/access_settings/whitelist/{rule_id}

**This endpoint allows you to remove a specific IP address from your list of allowed addresses.** When removing a specific IP address from your list, you must include the ID in your call. You can retrieve the IDs associated with your allowed IP addresses using the "Retrieve a list of currently al

Header Name	Example
`on-behalf-of`	`"in amet"`

Request Payload

Response Payload

{}

Certificates(5 operations)

POST

/v3/sso/certificates

**This endpoint allows you to create an SSO certificate.**

Request Payload

{
  "public_certificate": "<your x509 certificate>",
  "enabled": false,
  "integration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

Response Payload

{
  "public_certificate": "<your x509 certificate>",
  "id": 66138975,
  "not_before": 1621289880,
  "not_after": 1621289880,
  "intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

[
  {
    "error_id": "occaecat sed",
    "field": "dolor amet Duis",
    "message": "fugiat"
  },
  {
    "error_id": "do sit labore",
    "field": "in amet do",
    "message": "dolor voluptate irure cillum laboris"
  },
  {
    "error_id": "officia quis",
    "field": "veniam do",
    "message": "est culpa tempor fugiat do"
  },
  {
    "error_id": "anim nostrud commodo veniam",
    "field": "dolor",
    "message": "et"
  }
]

[
  {
    "error_id": "incididunt",
    "field": "cillum",
    "message": "sed"
  },
  {
    "error_id": "Ut",
    "field": "ipsum ullamco enim non",
    "message": "proident"
  },
  {
    "error_id": "aute Excepteur dolore mollit cupidatat",
    "field": "dolore nisi laborum enim laboris",
    "message": "aute"
  },
  {
    "error_id": "qui amet fugiat",
    "field": "do aute et ea reprehenderit",
    "message": "nisi aliquip sunt"
  }
]

[
  {
    "error_id": "commodo",
    "field": "minim ex",
    "message": "magna elit cillum"
  },
  {
    "error_id": "commodo elit dolore et anim",
    "field": null,
    "message": "minim id ad"
  },
  {
    "error_id": "sint ut dolor et",
    "field": "nisi Ut",
    "message": "aliquip enim mollit deserunt"
  },
  {
    "error_id": "Excepteur anim",
    "field": null,
    "message": "nulla id dolor"
  },
  {
    "error_id": "occaecat ex culpa",
    "field": "magna adipisicing quis nulla ex",
    "message": "sit fugiat"
  }
]

[
  {
    "error_id": "anim aliqua",
    "field": "Lorem",
    "message": "ut ipsum ullamco dolore"
  },
  {
    "error_id": "magna laborum nostrud in qui",
    "field": "do commodo officia laborum consequat",
    "message": "fugiat cupidatat in minim quis"
  },
  {
    "error_id": "sed in",
    "field": "eu pariatur nulla in",
    "message": "ut sit consequat"
  },
  {
    "error_id": "id ullamco nostrud commodo labore",
    "field": null,
    "message": "nostrud dolor"
  }
]

[
  {
    "error_id": "proident",
    "field": null,
    "message": "irure enim fugiat dolore pariatur"
  },
  {
    "error_id": "mollit ad laborum occaecat eu",
    "field": "anim",
    "message": "non fugiat aliquip quis"
  }
]

GET

/v3/sso/integrations/{integration_id}/certificates

**This endpoint allows you to retrieve all your IdP configurations by configuration ID.** The `integration_id` expected by this endpoint is the `id` returned in the response by the "Get All SSO Integrations" endpoint.

Request Payload

Response Payload

[
  {
    "public_certificate": "<your x509 certificate>",
    "id": 66138975,
    "not_before": 1621289880,
    "not_after": 1621289880,
    "intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
  }
]

[
  {
    "error_id": "ut",
    "field": null,
    "message": "non commodo ut"
  },
  {
    "error_id": "eiusmod Ut",
    "field": null,
    "message": "aute cupidatat magna deserunt"
  },
  {
    "error_id": "cupidatat Lorem",
    "field": "ipsum enim do",
    "message": "id eiusmod ex"
  },
  {
    "error_id": "eiusmod laboris aliqua velit",
    "field": "quis ut velit",
    "message": "consequat Duis cupidatat fugiat exercitation"
  },
  {
    "error_id": "pariatur officia",
    "field": null,
    "message": "esse quis"
  }
]

[
  {
    "error_id": "Duis consequat",
    "field": "commodo nulla velit anim",
    "message": "laboris aute"
  },
  {
    "error_id": "qui voluptate",
    "field": "laboris non in",
    "message": "ex"
  },
  {
    "error_id": "deserunt",
    "field": null,
    "message": "quis"
  },
  {
    "error_id": "velit Duis tempor laboris",
    "field": null,
    "message": "Ut Excepteur officia sit"
  }
]

[
  {
    "error_id": "fugiat laborum ullamco elit dolor",
    "field": null,
    "message": "reprehenderit ex deserunt sed sint"
  },
  {
    "error_id": "Ut esse",
    "field": null,
    "message": "cillum in veniam est"
  },
  {
    "error_id": "aute occaecat ea",
    "field": null,
    "message": "adipisicing"
  },
  {
    "error_id": "veniam aliqua exercitation eu sed",
    "field": null,
    "message": "voluptate"
  },
  {
    "error_id": "et officia exercitation id",
    "field": null,
    "message": "consectetur dolor velit in"
  }
]

[
  {
    "error_id": "dolor sed elit reprehenderit",
    "field": null,
    "message": "nulla sit"
  },
  {
    "error_id": "ut sit ut",
    "field": "officia commodo dolor non amet",
    "message": "eu sit officia"
  },
  {
    "error_id": "ad mollit cillum id dolore",
    "field": "sunt eu adipisicing Lorem",
    "message": "pariatur cupidatat sint"
  }
]

[
  {
    "error_id": "ullamco in cupidatat amet do",
    "field": null,
    "message": "velit"
  },
  {
    "error_id": "id",
    "field": null,
    "message": "dolore ut sunt"
  }
]

GET

/v3/sso/certificates/{cert_id}

**This endpoint allows you to retrieve an individual SSO certificate.**

Request Payload

Response Payload

{
  "public_certificate": "<your x509 certificate>",
  "id": 66138975,
  "not_before": 1621289880,
  "not_after": 1621289880,
  "intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

[
  {
    "error_id": "veniam",
    "field": null,
    "message": "ad sunt adipisicing"
  },
  {
    "error_id": "anim exercitation veniam occaecat",
    "field": null,
    "message": "reprehenderit ex Duis minim consectetur"
  },
  {
    "error_id": "exercitation commodo nostrud",
    "field": "irure eu laboris magna nulla",
    "message": "laborum consequat veniam"
  },
  {
    "error_id": "culpa aliquip",
    "field": "ut sunt et aliquip",
    "message": "in"
  }
]

[
  {
    "error_id": "deserunt enim sint aute",
    "field": "proident ad occaecat velit sunt",
    "message": "reprehenderit enim do magna dolore"
  },
  {
    "error_id": "qui ut velit Duis sed",
    "field": "quis non et anim",
    "message": "quis consectetur"
  },
  {
    "error_id": "reprehenderit labore",
    "field": "ut magna anim",
    "message": "reprehenderit officia exercitation minim"
  },
  {
    "error_id": "ea nulla pariatur",
    "field": null,
    "message": "aliqua Duis"
  },
  {
    "error_id": "labore",
    "field": "nulla mollit ex nostrud",
    "message": "nostrud voluptate Lorem"
  }
]

[
  {
    "error_id": "culpa ut",
    "field": null,
    "message": "sed amet voluptate"
  },
  {
    "error_id": "exercitation aliquip amet Ut",
    "field": null,
    "message": "labore sint et veniam"
  },
  {
    "error_id": "laborum pariatur mollit",
    "field": "elit tempor proident Ut",
    "message": "Ut"
  },
  {
    "error_id": "esse",
    "field": null,
    "message": "esse eu dolor tempor"
  }
]

[
  {
    "error_id": "Duis Excepteur Lorem aliqua dolore",
    "field": null,
    "message": "nulla magna Ut laboris"
  },
  {
    "error_id": "aliqua nulla",
    "field": "dolor enim",
    "message": "exercitation culpa Ut"
  }
]

[
  {
    "error_id": "cillum aliquip proident",
    "field": null,
    "message": "dolor aliqua et in consectetur"
  },
  {
    "error_id": "non reprehenderit nostrud",
    "field": "nostrud dolore sint",
    "message": "cillum est occaecat nisi"
  },
  {
    "error_id": "aute aliqua Duis",
    "field": null,
    "message": "id laborum dolore"
  },
  {
    "error_id": "in",
    "field": null,
    "message": "anim occaecat voluptate fugiat"
  },
  {
    "error_id": "ipsum Lorem aliqua",
    "field": null,
    "message": "magna ipsum id cillum"
  }
]

PATCH

/v3/sso/certificates/{cert_id}

**This endpoint allows you to update an existing certificate by ID.** You can retrieve a certificate's ID from the response provided by the "Get All SSO Integrations" endpoint.

Request Payload

{
  "public_certificate": "<your x509 certificate>",
  "enabled": false,
  "intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

Response Payload

[
  {
    "error_id": "amet aliqua consectetur deserunt laborum",
    "field": null,
    "message": "dolore officia laborum commodo"
  }
]

[
  {
    "error_id": "enim id pariatur non",
    "field": "est dolore incididunt culpa reprehenderit",
    "message": "irure in commodo"
  }
]

[
  {
    "error_id": "exercitation ad amet",
    "field": null,
    "message": "sint aliquip exercitation id"
  },
  {
    "error_id": "adipisicing consectetur aliquip",
    "field": "ut",
    "message": "consequat non sunt"
  },
  {
    "error_id": "sit consectetur eu aute aliquip",
    "field": "reprehenderit laborum",
    "message": "sed non incididunt"
  }
]

[
  {
    "error_id": "ut",
    "field": null,
    "message": "reprehenderit non"
  },
  {
    "error_id": "et",
    "field": null,
    "message": "cupidatat"
  },
  {
    "error_id": "irure magna",
    "field": "consectetur",
    "message": "elit"
  },
  {
    "error_id": "non dolor commodo",
    "field": "sunt magna cillum",
    "message": "incididunt mollit sed"
  },
  {
    "error_id": "ullamco quis",
    "field": null,
    "message": "nisi ipsum enim in laboris"
  }
]

[
  {
    "error_id": "dolor culpa ipsum",
    "field": null,
    "message": "veniam anim dolore exercitation"
  },
  {
    "error_id": "culpa",
    "field": null,
    "message": "irure"
  },
  {
    "error_id": "Lorem Duis non dolor ipsum",
    "field": "cillum mollit est aliquip ex",
    "message": "aliquip cillum"
  },
  {
    "error_id": "Ut",
    "field": "dolore proident ut",
    "message": "Excepteur in reprehenderit dolore aliquip"
  }
]

DELETE

/v3/sso/certificates/{cert_id}

**This endpoint allows you to delete an SSO certificate.** You can retrieve a certificate's ID from the response provided by the "Get All SSO Integrations" endpoint.

Request Payload

Response Payload

{
  "public_certificate": "<your x509 certificate>",
  "id": 66138975,
  "not_before": 1621289880,
  "not_after": 1621289880,
  "intergration_id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

[
  {
    "error_id": "dolore eiusmod reprehenderit fugiat ullamco",
    "field": "sint aliquip ut culpa sunt",
    "message": "id esse incididunt"
  },
  {
    "error_id": "consequat",
    "field": "in ut dolore minim cupidatat",
    "message": "quis nulla"
  },
  {
    "error_id": "dolore non",
    "field": "voluptate sunt consectetur aliquip",
    "message": "ad dolore consectetur esse velit"
  },
  {
    "error_id": "consectetur",
    "field": null,
    "message": "velit"
  },
  {
    "error_id": "sunt commodo",
    "field": null,
    "message": "commodo esse laboris qui dolore"
  }
]

[
  {
    "error_id": "in adipisicing occaecat",
    "field": "magna veniam elit",
    "message": "sed incididunt culpa"
  }
]

[
  {
    "error_id": "consectetur in",
    "field": null,
    "message": "tempor exercitation ea dolor"
  },
  {
    "error_id": "sit culpa",
    "field": null,
    "message": "dolore ea laborum irure"
  },
  {
    "error_id": "et consectetur ut cupidatat ea",
    "field": "pariatur ad et",
    "message": "consectetur"
  }
]

[
  {
    "error_id": "Excepteur",
    "field": "laborum reprehenderit",
    "message": "minim dolor magna amet est"
  },
  {
    "error_id": "elit",
    "field": null,
    "message": "officia mollit veniam"
  },
  {
    "error_id": "irure cillum",
    "field": null,
    "message": "minim amet ullamco dolor"
  },
  {
    "error_id": "Ut ut quis adipisicing sed",
    "field": null,
    "message": "pariatur exercitation"
  }
]

[
  {
    "error_id": "culpa aliquip exercitation nulla",
    "field": null,
    "message": "nostrud consectetur tempor est"
  },
  {
    "error_id": "proident dolor officia",
    "field": "occaecat",
    "message": "labore minim dolor sint eiusmod"
  },
  {
    "error_id": "enim do exercitation",
    "field": "commodo eiusmod ad",
    "message": "culpa"
  },
  {
    "error_id": "dolore nulla sit",
    "field": null,
    "message": "Ut deserunt voluptate esse"
  },
  {
    "error_id": "magna culpa incididunt sit",
    "field": null,
    "message": "officia enim qui ullamco cillum"
  }
]

Single Sign-On Settings(5 operations)

POST

/v3/sso/integrations

**This endpoint allows you to create an SSO integration.**

Request Payload

{
  "name": "Twilio SendGrid",
  "enabled": true,
  "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
  "signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
  "entity_id": "http://www.okta.com/${org.externalKey}",
  "completed_integration": true,
  "id": "b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

Response Payload

{
  "name": "Twilio SendGrid",
  "enabled": true,
  "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
  "signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
  "entity_id": "http://www.okta.com/${org.externalKey}",
  "last_updated": 1621288964
}

[
  {
    "error_id": "quis ut",
    "field": "do cillum deserunt et laborum",
    "message": "cupidatat commodo nostrud do"
  }
]

[
  {
    "error_id": "quis non eu esse",
    "field": null,
    "message": "dolor ullamco cillum"
  },
  {
    "error_id": "nostrud enim quis Lorem dolore",
    "field": "deserunt dolor ex quis",
    "message": "qui exercitation commodo dolore"
  },
  {
    "error_id": "sunt",
    "field": null,
    "message": "sed labore et"
  },
  {
    "error_id": "veniam sunt tempor consequat",
    "field": null,
    "message": "aliquip sit cillum"
  }
]

[
  {
    "error_id": "nisi ipsum",
    "field": "ut Duis",
    "message": "magna voluptate velit in dolor"
  },
  {
    "error_id": "cillum ut veniam sit magna",
    "field": null,
    "message": "quis eiusmod sed id aliquip"
  }
]

[
  {
    "error_id": "et",
    "field": null,
    "message": "eiusmod ipsum"
  }
]

[
  {
    "error_id": "do deserunt ea veniam aliquip",
    "field": "pariatur culpa sed",
    "message": "veniam amet dolor pariatur"
  },
  {
    "error_id": "ut",
    "field": null,
    "message": "nulla cupidatat"
  },
  {
    "error_id": "fugiat reprehenderit Lorem velit",
    "field": null,
    "message": "non"
  },
  {
    "error_id": "ullamco adipisicing magna reprehenderit",
    "field": null,
    "message": "officia mollit dolore"
  },
  {
    "error_id": "consequat eiusmod labore enim",
    "field": null,
    "message": "ut dolore incididunt ut"
  }
]

GET

/v3/sso/integrations

**This endpoint allows you to retrieve all SSO integrations tied to your Twilio SendGrid account.** The IDs returned by this endpoint can be used by the APIs additional endpoints to modify your SSO integrations.

Query Parameter Name	Example
`si`	`true`

Request Payload

Response Payload

[
  {
    "name": "Twilio SendGrid",
    "enabled": true,
    "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
    "signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
    "entity_id": "http://www.okta.com/${org.externalKey}",
    "last_updated": 1621288520,
    "completed_integration": true,
    "id": "b0b98502-9408-4b24-9e3d-31ed7cb15312",
    "single_signon_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312",
    "audience_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312"
  }
]

[
  {
    "error_id": "ad",
    "field": "aute commodo mollit",
    "message": "laboris ut Excepteur"
  },
  {
    "error_id": "est deserunt Lorem sit",
    "field": "aliquip ad esse dolore",
    "message": "cupidatat ullamco sint proident occaecat"
  }
]

[
  {
    "error_id": "Ut officia esse",
    "field": null,
    "message": "anim"
  },
  {
    "error_id": "in Lorem ut",
    "field": null,
    "message": "ut amet non Ut fugiat"
  },
  {
    "error_id": "ullamco in occaecat",
    "field": "ea laborum",
    "message": "Ut labore dolore laborum occaecat"
  },
  {
    "error_id": "Excepteur non deserunt et",
    "field": "Duis ut",
    "message": "dolor nisi"
  }
]

[
  {
    "error_id": "pariatur non cupidatat culpa",
    "field": null,
    "message": "magna dolore"
  }
]

[
  {
    "error_id": "laboris aute ullamco",
    "field": null,
    "message": "ex cupidatat aliquip veniam"
  },
  {
    "error_id": "sed",
    "field": "sed mollit velit",
    "message": "sunt in dolor sint"
  }
]

[
  {
    "error_id": "ex magna labore",
    "field": null,
    "message": "deserunt esse incididunt culpa"
  },
  {
    "error_id": "commodo consectetur voluptate exercitation velit",
    "field": "aliqua",
    "message": "dolore ut proident cillum"
  },
  {
    "error_id": "minim sed eu velit enim",
    "field": "deserunt laboris",
    "message": "adipisicing deserunt commodo in"
  },
  {
    "error_id": "sunt",
    "field": "eu",
    "message": "non enim magna irure adipisicing"
  }
]

GET

/v3/sso/integrations/{id}

**This endpoint allows you to retrieve an SSO integration by ID.** You can retrieve the IDs for your configurations from the response provided by the "Get All SSO Integrations" endpoint.

Query Parameter Name	Example
`si`	`false`

Request Payload

Response Payload

{
  "name": "Twilio SendGrid",
  "enabled": true,
  "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
  "signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
  "entity_id": "http://www.okta.com/${org.externalKey}",
  "last_updated": 1621288964,
  "completed_integration": true,
  "id": "b0b98502-9408-4b24-9e3d-31ed7cb15312",
  "audience_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

[
  {
    "error_id": "consequat irure sint qui",
    "field": null,
    "message": "pariatur"
  },
  {
    "error_id": "fugiat dolor",
    "field": null,
    "message": "elit ullamco"
  },
  {
    "error_id": "deserunt proident aute in in",
    "field": null,
    "message": "labore elit est"
  },
  {
    "error_id": "consectetur incididunt",
    "field": "velit sunt sit ad elit",
    "message": "non et aliquip tempor enim"
  },
  {
    "error_id": "nulla deserunt ex",
    "field": "culpa esse occaecat ut",
    "message": "labore"
  }
]

[
  {
    "error_id": "ea exercitation incididunt dolor",
    "field": "laborum enim officia aute",
    "message": "qui enim nostrud"
  },
  {
    "error_id": "ut",
    "field": "magna nisi in",
    "message": "dolor mollit esse in sunt"
  },
  {
    "error_id": "nisi consectetur",
    "field": "proident nulla",
    "message": "voluptate"
  },
  {
    "error_id": "deserunt in non in nostrud",
    "field": "tempor consequat",
    "message": "in ut"
  },
  {
    "error_id": "et in exercitation",
    "field": null,
    "message": "aliqua id enim cillum ipsum"
  }
]

[
  {
    "error_id": "veniam",
    "field": "aliquip irure",
    "message": "ipsum laborum consequat eu ullamco"
  },
  {
    "error_id": "sint nulla eu",
    "field": "nisi voluptate commodo non",
    "message": "dolore Duis do"
  },
  {
    "error_id": "mollit aliquip commodo nostrud in",
    "field": null,
    "message": "anim labore"
  },
  {
    "error_id": "laboris in",
    "field": null,
    "message": "exercitation Lorem Excepteur velit"
  }
]

[
  {
    "error_id": "fugiat",
    "field": "deserunt aute dolore",
    "message": "cupidatat voluptate Lorem laborum"
  },
  {
    "error_id": "fugiat non Excepteur",
    "field": null,
    "message": "cupidatat et"
  }
]

[
  {
    "error_id": "anim pariatur",
    "field": null,
    "message": "cupidatat dolor sit ullamco"
  }
]

PATCH

/v3/sso/integrations/{id}

**This endpoint allows you to modify an exisiting SSO integration.** You can retrieve the IDs for your configurations from the response provided by the "Get All SSO Integrations" endpoint.

Query Parameter Name	Example
`si`	`true`

Request Payload

{
  "name": "Twilio SendGrid",
  "enabled": true,
  "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
  "signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
  "entity_id": "http://www.okta.com/${org.externalKey}",
  "last_updated": 1621288964,
  "completed_integration": true
}

Response Payload

{
  "name": "Twilio SendGrid",
  "enabled": true,
  "signin_url": "https://example.okta.com/home/examplecompany/yokpGWsmpRUcuvXFb4x6/nfaVADNhuHvvReAEV4x6",
  "signout_url": "https://example.okta.com/login/signout?fromURI=exampleappurl",
  "entity_id": "http://www.okta.com/${org.externalKey}",
  "last_updated": 1621288964,
  "id": "b0b98502-9408-4b24-9e3d-31ed7cb15312",
  "single_signon_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312",
  "audience_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312"
}

[
  {
    "error_id": "sunt tempor quis reprehenderit est",
    "field": "sit",
    "message": "laboris tempor magna deserunt esse"
  },
  {
    "error_id": "et Ut irure pariatur",
    "field": null,
    "message": "reprehenderit quis ipsum"
  },
  {
    "error_id": "dolor laborum pariatur non nisi",
    "field": "laborum labore cupidatat adipisicing enim",
    "message": "magna Excepteur amet cupidatat qui"
  }
]

[
  {
    "error_id": "ad labore sit",
    "field": null,
    "message": "esse in dolor"
  },
  {
    "error_id": "dolor esse",
    "field": null,
    "message": "dolore reprehenderit non laboris"
  }
]

[
  {
    "error_id": "enim mollit amet cupidatat aute",
    "field": null,
    "message": "et Ut culpa"
  }
]

[
  {
    "error_id": "amet",
    "field": "labore amet",
    "message": "reprehenderit irure labore ea ut"
  },
  {
    "error_id": "magna cupidatat qui voluptate esse",
    "field": null,
    "message": "eiusmod velit non nulla"
  },
  {
    "error_id": "ad laboris nulla sit",
    "field": null,
    "message": "dolore nulla Excepteur anim sed"
  },
  {
    "error_id": "tempor fugiat sed",
    "field": "ea Lorem nulla nisi",
    "message": "aute do officia dolore"
  }
]

[
  {
    "error_id": "esse voluptate reprehenderit veniam mollit",
    "field": "irure dolor anim ad",
    "message": "consequat"
  },
  {
    "error_id": "esse aute dolor",
    "field": "nulla commodo voluptate",
    "message": "Duis dolor proident exercitation"
  }
]

DELETE

/v3/sso/integrations/{id}

**This endpoint allows you to delete an IdP configuration by ID.** You can retrieve the IDs for your configurations from the response provided by the "Get All SSO Integrations" endpoint.

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

[
  {
    "error_id": "ut adipisicing eu",
    "field": "aliqua culpa minim ut commodo",
    "message": "Duis fugiat"
  },
  {
    "error_id": "nulla ipsum",
    "field": "dolor cillum Excepteur",
    "message": "labore voluptate"
  }
]

[
  {
    "error_id": "elit",
    "field": "sed ex officia sit do",
    "message": "consequat fugiat quis laborum aliquip"
  }
]

[
  {
    "error_id": "aliqua dolor dolor",
    "field": "enim",
    "message": "laboris esse quis consectetur et"
  }
]

[
  {
    "error_id": "et occaecat esse anim sed",
    "field": "dolor Duis nostrud",
    "message": "ut culpa elit aliqua sunt"
  },
  {
    "error_id": "ad esse occaecat qui",
    "field": "ut dolor amet incididunt ad",
    "message": "Lorem Ut magna esse proident"
  },
  {
    "error_id": "sint enim Excepteur",
    "field": null,
    "message": "laborum voluptate"
  }
]

[
  {
    "error_id": "non sit qui sed commodo",
    "field": "irure",
    "message": "irure sint do exercitation sed"
  }
]

Single Sign-On Teammates(2 operations)

POST

/v3/sso/teammates

**This endpoint allows you to create an SSO Teammate.** The email provided for this user will also function as the Teammate’s username.

Request Payload

{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane_doe@example.com",
  "scopes": [
    "mail.batch.create",
    "mail.batch.delete",
    "mail.batch.read",
    "mail.batch.update",
    "mail.send"
  ]
}

Response Payload

{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane_doe@example.com",
  "is_read_only": true,
  "username": "jane_doe@example.com",
  "is_sso": true
}

[
  {
    "error_id": "sunt velit",
    "field": null,
    "message": "ipsum"
  }
]

[
  {
    "error_id": "eu Ut veniam dolor",
    "field": null,
    "message": "irure labore"
  },
  {
    "error_id": "quis ex pariatur sit",
    "field": "incididunt officia",
    "message": "occaecat"
  }
]

[
  {
    "error_id": "dolor sit quis",
    "field": null,
    "message": "et in commodo ea consequat"
  },
  {
    "error_id": "sint amet fugiat ut",
    "field": "ex voluptate Excepteur fugiat",
    "message": "irure est reprehenderit veniam sunt"
  }
]

[
  {
    "error_id": "eu deserunt laborum quis magna",
    "field": null,
    "message": "dolor ex mollit nulla"
  },
  {
    "error_id": "ipsum",
    "field": null,
    "message": "sunt aliqua laboris"
  }
]

[
  {
    "error_id": "Excepteur",
    "field": null,
    "message": "Ut adipisicing"
  },
  {
    "error_id": "Excepteur eu sed dolor ut",
    "field": "tempor pariatur cupidatat adipisicing culpa",
    "message": "commodo ea anim"
  },
  {
    "error_id": "magna nisi quis adipisicing in",
    "field": null,
    "message": "esse dolore"
  }
]

PATCH

/v3/sso/teammates/{username}

**This endpoint allows you to modify an existing SSO Teammate.** To turn a teammate into an admin, the request body should contain the `is_admin` field set to `true`. Otherwise, set `is_admin` to false and pass in all the scopes that a teammate should have. Only the parent user and Teammates with

Request Payload

{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane_doe@example.com",
  "scopes": [
    "mail.batch.create",
    "mail.batch.delete",
    "mail.batch.read",
    "mail.batch.update",
    "mail.send"
  ],
  "is_admin": false
}

Response Payload

{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane_doe@example.com",
  "is_admin": false,
  "username": "jane_doe@example.com",
  "is_sso": true,
  "address": "1234 Fake St.",
  "address2": "Suite 5",
  "city": "San Francisco",
  "state": "CA",
  "zip": "94105",
  "Country": "United States",
  "phone": "+15555555555",
  "user_type": "teammate"
}

[
  {
    "error_id": "voluptate in fugiat elit",
    "field": null,
    "message": "adipisicing"
  },
  {
    "error_id": "pariatur deserunt officia",
    "field": "in fugiat",
    "message": "laborum Lorem"
  },
  {
    "error_id": "eu pariatur dolor exercitation",
    "field": "quis veniam",
    "message": "consequat mollit minim ut ex"
  }
]

[
  {
    "error_id": "Excepteur aliquip enim cupidatat",
    "field": "non deserunt sunt",
    "message": "velit officia incididunt"
  },
  {
    "error_id": "officia quis ipsum proident consequat",
    "field": "in",
    "message": "id quis elit aute"
  }
]

[
  {
    "error_id": "id nisi consectetur culpa",
    "field": "et",
    "message": "dolore cupidatat"
  }
]

[
  {
    "error_id": "elit incididunt id",
    "field": "qui ullamco aute",
    "message": "voluptate eu dolor pariatur"
  },
  {
    "error_id": "voluptate",
    "field": null,
    "message": "veniam magna occaecat pariatur cillum"
  },
  {
    "error_id": "sunt eiusmod amet quis",
    "field": null,
    "message": "aute sit ex officia laborum"
  },
  {
    "error_id": "aliqua mollit minim irure proident",
    "field": null,
    "message": "fugiat cillum occaecat magna laborum"
  },
  {
    "error_id": "qui fugiat non",
    "field": "ex fugiat eu",
    "message": "ad sunt"
  }
]

[
  {
    "error_id": "commodo",
    "field": "incididunt cillum in ullamco nostrud",
    "message": "cillum irure elit"
  },
  {
    "error_id": "nisi irure",
    "field": null,
    "message": "dolore ullamco fugiat"
  },
  {
    "error_id": "aliquip occaecat sunt Excepteur",
    "field": "minim commodo labore eu ut",
    "message": "ea deserunt labore"
  },
  {
    "error_id": "dolor",
    "field": null,
    "message": "anim"
  },
  {
    "error_id": "sint laboris magna laborum esse",
    "field": "elit",
    "message": "velit"
  }
]

Settings - Mail(13 operations)

GET

/v3/mail_settings

**This endpoint allows you to retrieve a list of all mail settings.** Each setting will be returned with an `enabled` status set to `true` or `false` and a short description that explains what the setting does.

Query Parameter Name	Example
`limit`	`83186710`
`offset`	`-20873761`

Header Name	Example
`on-behalf-of`	`"eu proident sit in deserunt"`

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": "dolore quis dolore ipsum",
      "field": null,
      "message": "commodo nostrud Lorem ut",
      "parameter": "in reprehenderit dolore proident commodo"
    },
    {
      "error_id": "pariatur",
      "field": "elit aliquip irure fugiat proident",
      "message": "laborum consequat",
      "parameter": "laborum id fugiat magna sint"
    },
    {
      "error_id": "sunt est",
      "field": null,
      "message": "amet proident esse",
      "parameter": "aliquip"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "in velit",
      "field": "dolor irure deserunt",
      "message": "esse aliqua sunt",
      "parameter": "et magna"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ipsum mollit commodo",
      "field": "culpa tempor",
      "message": "Excepteur ut",
      "parameter": "fugiat sed commodo deserunt veniam"
    },
    {
      "error_id": "anim in voluptate enim velit",
      "field": "incididunt",
      "message": "culpa",
      "parameter": "eu officia deserunt est"
    },
    {
      "error_id": "tempor labore do ullamco",
      "field": null,
      "message": "consectetur",
      "parameter": "Ut pariatur elit sunt aliquip"
    },
    {
      "error_id": "aliqua",
      "field": "commodo",
      "message": "proident cupidatat dolor Duis Ut",
      "parameter": "aute officia consectetur fugiat"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "Excepteur do in consequat amet",
      "field": null,
      "message": "amet proident",
      "parameter": "labore"
    },
    {
      "error_id": "aliquip ut",
      "field": null,
      "message": "esse anim dolor",
      "parameter": "sint Ut ad incididunt"
    },
    {
      "error_id": "pariatur labore",
      "field": null,
      "message": "Duis officia ea voluptate",
      "parameter": "eu aliquip et"
    },
    {
      "error_id": "voluptate anim culpa id aliqua",
      "field": null,
      "message": "reprehenderit tempor Lorem magna sunt",
      "parameter": "deserunt nisi in officia"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ad Ut officia magna",
      "field": null,
      "message": "cillum deserunt Lorem aute Ut",
      "parameter": "labore Excepteur in cillum"
    },
    {
      "error_id": "Lorem fugiat dolore commodo Excepteur",
      "field": null,
      "message": "minim tempor anim",
      "parameter": "ea in reprehenderit"
    },
    {
      "error_id": "tempor do fugiat",
      "field": null,
      "message": "ipsum nulla nostrud proident",
      "parameter": "ut ex dolore dolor aute"
    },
    {
      "error_id": "amet incididunt laborum ut nulla",
      "field": "mollit ut",
      "message": "commodo exercitation eu laboris aliquip",
      "parameter": "ad in"
    }
  ]
}

PATCH

/v3/mail_settings/address_whitelist

**This endpoint allows you to update your current email address whitelist settings.** You can select whether or not this setting should be enabled by assigning the `enabled` field a `true` or `false` value. Passing only the `enabled` field to this endpoint will not alter your current `list` of wh

Header Name	Example
`on-behalf-of`	`"enim velit incididunt"`

Request Payload

{
  "enabled": true,
  "list": [
    "email1@example.com",
    "example.com"
  ]
}

Response Payload

{
  "enabled": true,
  "list": [
    "email1@example.com"
  ]
}

{
  "errors": [
    {
      "error_id": "proident nostrud",
      "field": null,
      "message": "cupidatat eu id ut",
      "parameter": "ut do in sunt sit"
    },
    {
      "error_id": "non labore dolore",
      "field": null,
      "message": "quis culpa et qui",
      "parameter": "ipsum pariatur reprehenderit in labore"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "proident cupidatat Lorem consectetur",
      "field": null,
      "message": "mollit",
      "parameter": "culpa aliqua aliquip anim sint"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "occaecat",
      "field": "labore magna cillum",
      "message": "ut aliqua exercitation sit",
      "parameter": "laboris"
    },
    {
      "error_id": "qui do velit eiusmod sint",
      "field": null,
      "message": "consequat",
      "parameter": "sed dolor"
    },
    {
      "error_id": "mollit culpa occaecat",
      "field": null,
      "message": "pariatur fugiat aliqua veniam",
      "parameter": "sunt culpa sint"
    },
    {
      "error_id": "cupidatat aliquip quis eu exercitation",
      "field": "culpa non occaecat ea Excepteur",
      "message": "consectetur",
      "parameter": "pariatur"
    },
    {
      "error_id": "tempor ex magna",
      "field": null,
      "message": "et officia commodo",
      "parameter": "mollit dolor tempor sint"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "enim sed velit",
      "field": null,
      "message": "aute",
      "parameter": "adipisicing"
    },
    {
      "error_id": "consectetur",
      "field": "eu",
      "message": "ut eu quis occaecat amet",
      "parameter": "nulla"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "consequat",
      "field": null,
      "message": "nostrud et ullamco voluptate",
      "parameter": "proident consectetur"
    },
    {
      "error_id": "eu minim ea",
      "field": null,
      "message": "Lorem culpa",
      "parameter": "dolore veniam aute"
    }
  ]
}

GET

/v3/mail_settings/address_whitelist

**This endpoint allows you to retrieve your current email address whitelist settings.** The Address Whitelist setting allows you to specify email addresses or domains for which mail should never be suppressed. For example, if you own the domain `example.com`, and one or more of your recipients us

Header Name	Example
`on-behalf-of`	`"dolor dolore Duis qui"`

Request Payload

Response Payload

{
  "enabled": true,
  "list": [
    "example.com",
    "jane_doe@example1.com"
  ]
}

{
  "errors": [
    {
      "error_id": "ullamco in",
      "field": null,
      "message": "in magna dolor minim",
      "parameter": "sunt"
    },
    {
      "error_id": "id culpa ipsum qui",
      "field": "Lorem labore tempor culpa",
      "message": "voluptate cupidatat",
      "parameter": "sed eu ad dolore occaecat"
    },
    {
      "error_id": "tempor in deserunt ut esse",
      "field": "officia non nulla",
      "message": "ullamco ut et",
      "parameter": "in anim nulla laborum"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "veniam ipsum voluptate",
      "field": null,
      "message": "nisi",
      "parameter": "nulla eiusmod dolor sed deserunt"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "in",
      "field": null,
      "message": "velit voluptate pariatur",
      "parameter": "ut"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "anim dolor enim cupidatat",
      "field": "dolor pariatur quis",
      "message": "voluptate adipisicing exercitation",
      "parameter": "nostrud enim ut officia"
    },
    {
      "error_id": "veniam do",
      "field": "velit pariatur",
      "message": "quis est",
      "parameter": "velit id et"
    },
    {
      "error_id": "nisi amet irure Lorem",
      "field": null,
      "message": "consequat pariatur nulla qui est",
      "parameter": "commodo ut"
    },
    {
      "error_id": "exercitation culpa tempor",
      "field": "non cillum pariatur",
      "message": "fugiat",
      "parameter": "anim laboris officia tempor"
    },
    {
      "error_id": "labore esse Ut ea",
      "field": null,
      "message": "tempor nisi est",
      "parameter": "minim aliqua exercitation"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "magna labore eu sed mollit",
      "field": "laboris",
      "message": "Duis consectetur dolor in",
      "parameter": "laboris in"
    },
    {
      "error_id": "Lorem non",
      "field": "non ut cillum",
      "message": "labore incididunt deserunt aliqua",
      "parameter": "consequat nulla"
    },
    {
      "error_id": "id reprehenderit",
      "field": "cillum enim",
      "message": "laborum nisi consectetur laboris",
      "parameter": "laborum elit ut dolor"
    }
  ]
}

PATCH

/v3/mail_settings/footer

**This endpoint allows you to update your current Footer mail settings.** The Footer setting will insert a custom footer at the bottom of your text and HTML email message bodies. You can insert your HTML or plain text directly using this endpoint, or you can create the footer using the [Mail Sett

Header Name	Example
`on-behalf-of`	`"Lorem dolor"`

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": "laborum",
      "field": null,
      "message": "et dolore sit",
      "parameter": "deserunt id ea ut"
    },
    {
      "error_id": "officia pariatur laboris aute dolor",
      "field": null,
      "message": "sunt irure",
      "parameter": "commodo cillum pariatur esse do"
    },
    {
      "error_id": "eiusmod ad",
      "field": null,
      "message": "qui in",
      "parameter": "reprehenderit est"
    },
    {
      "error_id": "adipisicing enim laboris eiusmod est",
      "field": null,
      "message": "irure Duis amet cupidatat fugiat",
      "parameter": "id Excepteur ea consequat laborum"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "culpa in consequat sint",
      "field": "ut deserunt",
      "message": "adipisicing ex officia cupidatat minim",
      "parameter": "laboris sed est reprehenderit fugiat"
    },
    {
      "error_id": "ipsum",
      "field": null,
      "message": "dolore",
      "parameter": "Excepteur Ut occaecat"
    },
    {
      "error_id": "pariatur",
      "field": "et",
      "message": "anim culpa cupidatat nulla deserunt",
      "parameter": "sit officia veniam"
    },
    {
      "error_id": "non",
      "field": null,
      "message": "nisi anim reprehenderit elit",
      "parameter": "ipsum deserunt laboris sit"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "amet irure sed",
      "field": null,
      "message": "ut",
      "parameter": "laboris"
    },
    {
      "error_id": "minim",
      "field": null,
      "message": "aliqua",
      "parameter": "mollit culpa ut anim ut"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "magna labore dolor aliqua dolore",
      "field": "do sint dolor tempor eiusmod",
      "message": "sed in exercitation aute Excepteur",
      "parameter": "pariatur in"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "qui quis",
      "field": "proident dolore Excepteur Lorem non",
      "message": "pariatur enim voluptate",
      "parameter": "proident nulla sunt Lorem"
    },
    {
      "error_id": "dolor",
      "field": null,
      "message": "minim",
      "parameter": "adipisicing incididunt"
    }
  ]
}

GET

/v3/mail_settings/footer

**This endpoint allows you to retrieve your current Footer mail settings.** The Footer setting will insert a custom footer at the bottom of your text and HTML email message bodies. You can insert your HTML or plain text directly using the "Update footer mail settings" endpoint, or you can create

Header Name	Example
`on-behalf-of`	`"dolore voluptate"`

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": "cillum fugiat",
      "field": "ut labore veniam et",
      "message": "veniam Ut",
      "parameter": "irure mollit exercitation incididunt"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "occaecat minim pariatur nulla",
      "field": null,
      "message": "Ut irure consectetur",
      "parameter": "dolore deserunt elit"
    },
    {
      "error_id": "consequat nostrud anim",
      "field": "amet cillum velit consequat sed",
      "message": "Duis eiusmod dolor deserunt",
      "parameter": "cillum anim ea ipsum"
    },
    {
      "error_id": "laboris Duis deserunt",
      "field": null,
      "message": "cillum sint laborum minim mollit",
      "parameter": "pariatur esse"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "quis incididunt adipisicing officia eu",
      "field": "dolore in",
      "message": "occaecat",
      "parameter": "enim commodo esse"
    },
    {
      "error_id": "minim ex quis commodo laborum",
      "field": "ea culpa Lorem occaecat minim",
      "message": "non dolor ad nostrud",
      "parameter": "elit"
    },
    {
      "error_id": "aute eu Excepteur est exercitation",
      "field": "sed nulla commodo",
      "message": "velit Duis dolore",
      "parameter": "Ut dolore"
    },
    {
      "error_id": "esse consequat",
      "field": null,
      "message": "fugiat consequat laboris dolore",
      "parameter": "adipisicing sit"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "labore",
      "field": null,
      "message": "et voluptate",
      "parameter": "reprehenderit"
    },
    {
      "error_id": "in deserunt irure consectetur",
      "field": "quis",
      "message": "in enim veniam ullamco",
      "parameter": "sunt aliqua"
    },
    {
      "error_id": "officia ad",
      "field": null,
      "message": "et sit",
      "parameter": "consectetur"
    },
    {
      "error_id": "ad Duis fugiat",
      "field": "ad",
      "message": "enim est nisi",
      "parameter": "sunt occaecat"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "occaecat tempor veniam",
      "field": null,
      "message": "dolor adipisicing enim",
      "parameter": "et quis veniam sint"
    }
  ]
}

PATCH

/v3/mail_settings/forward_spam

**This endpoint allows you to update your current Forward Spam mail settings.** Enabling the Forward Spam setting allows you to specify `email` addresses to which spam reports will be forwarded. You can set multiple addresses by passing this endpoint a comma separated list of emails in a single st

Header Name	Example
`on-behalf-of`	`"officia aliquip ea Lorem"`

Request Payload

{
  "email": "abuse@example.com",
  "enabled": true
}

Response Payload

{
  "email": "abuse@example.com",
  "enabled": true
}

{
  "errors": [
    {
      "error_id": "dolore nostrud ullamco",
      "field": null,
      "message": "ea adipisicing nisi esse aliquip",
      "parameter": "culpa irure cillum sit"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "elit ea quis proident",
      "field": "cillum consequat in voluptate irure",
      "message": "ipsum Duis aliquip",
      "parameter": "aute incididunt laboris"
    },
    {
      "error_id": "occaecat",
      "field": "culpa nulla in ad ut",
      "message": "commodo et",
      "parameter": "ea in non anim esse"
    },
    {
      "error_id": "mollit eiusmod proident occaecat ea",
      "field": "non commodo ea",
      "message": "elit magna",
      "parameter": "ex"
    },
    {
      "error_id": "aliquip",
      "field": "officia anim sunt Ut est",
      "message": "nostrud",
      "parameter": "labore reprehenderit"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ullamco deserunt",
      "field": null,
      "message": "sunt",
      "parameter": "tempor dolore qui aliqua"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "sunt ipsum sint",
      "field": null,
      "message": "esse ut minim",
      "parameter": "sit ut occaecat"
    },
    {
      "error_id": "culpa quis qui sunt",
      "field": null,
      "message": "aute consequat",
      "parameter": "proident"
    },
    {
      "error_id": "ad ut",
      "field": null,
      "message": "ex dolore",
      "parameter": "amet elit do"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "cupidatat",
      "field": null,
      "message": "non fugiat culpa ex ut",
      "parameter": "ut"
    },
    {
      "error_id": "proident Excepteur in mollit dolore",
      "field": null,
      "message": "dolore ut incididunt reprehenderit esse",
      "parameter": "ut"
    },
    {
      "error_id": "Ut tempor",
      "field": null,
      "message": "esse ut",
      "parameter": "cillum pariatur consectetur"
    }
  ]
}

GET

/v3/mail_settings/forward_spam

**This endpoint allows you to retrieve your current Forward Spam mail settings.** Enabling the Forward Spam setting allows you to specify `email` addresses to which spam reports will be forwarded. This endpoint returns any email address(es) you have set to receive forwarded spam and an `enabled` s

Header Name	Example
`on-behalf-of`	`"culpa ea"`

Request Payload

Response Payload

{
  "email": "abuse@example.com",
  "enabled": true
}

{
  "errors": [
    {
      "error_id": "ullamco",
      "field": "fugiat id",
      "message": "elit qui cillum aliquip velit",
      "parameter": "aliquip voluptate incididunt fugiat"
    },
    {
      "error_id": "pariatur dolore anim",
      "field": "ex do",
      "message": "culpa voluptate Excepteur nisi",
      "parameter": "aliquip"
    },
    {
      "error_id": "aliqua voluptate",
      "field": null,
      "message": "Excepteur et aute irure",
      "parameter": "cupidatat velit eu ad in"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "nisi consectetur",
      "field": "quis aliqua",
      "message": "laborum occaecat",
      "parameter": "commodo"
    },
    {
      "error_id": "reprehenderit ut",
      "field": "ipsum",
      "message": "eiusmod velit in aute est",
      "parameter": "Excepteur anim pariatur voluptate eu"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "esse ipsum",
      "field": "quis ipsum nostrud",
      "message": "sint culpa exercitation",
      "parameter": "Duis ex elit aliquip"
    },
    {
      "error_id": "esse ea",
      "field": null,
      "message": "consequat veniam aliquip nisi",
      "parameter": "dolor"
    },
    {
      "error_id": "laboris id",
      "field": "cillum consequat",
      "message": "exercitation anim",
      "parameter": "velit aliquip fugiat cillum"
    },
    {
      "error_id": "cillum aliquip id laboris",
      "field": null,
      "message": "id Ut eiusmod in labore",
      "parameter": "cupidatat esse Ut id do"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "quis",
      "field": null,
      "message": "aliquip aliqua do magna proident",
      "parameter": "mollit"
    },
    {
      "error_id": "officia culpa esse et amet",
      "field": null,
      "message": "laboris aliqua ipsum exercitation id",
      "parameter": "enim ipsum nulla laboris in"
    },
    {
      "error_id": "non Lorem proident consectetur",
      "field": null,
      "message": "ut sed ad",
      "parameter": "ea sit"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "dolor",
      "field": "aliquip",
      "message": "commodo",
      "parameter": "ut veniam"
    },
    {
      "error_id": "exercitation ullamco veniam",
      "field": null,
      "message": "ea pariatur cillum ut ex",
      "parameter": "et ut esse occaecat"
    },
    {
      "error_id": "ad",
      "field": "reprehenderit",
      "message": "exercitation",
      "parameter": "ut ut cupidatat"
    }
  ]
}

PATCH

/v3/mail_settings/template

**This endpoint allows you to update your current legacy email template settings.** This setting refers to our original email templates. We currently support more fully featured [Dynamic Transactional Templates](https://sendgrid.com/docs/ui/sending-email/how-to-send-an-email-with-dynamic-transacti

Header Name	Example
`on-behalf-of`	`"dolor pariatur minim adipisicing"`

Request Payload

{
  "enabled": true,
  "html_content": "<% body %>"
}

Response Payload

{
  "enabled": false,
  "html_content": "<p><% body %>Example</p>\n"
}

{
  "errors": [
    {
      "error_id": "Excepteur ad officia eiusmod in",
      "field": "est reprehenderit adipisicing cillum",
      "message": "proident enim",
      "parameter": "deserunt in sint commodo"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "aliquip Duis mollit",
      "field": "eu sit proident",
      "message": "consectetur commodo dolore adipisicing eiusmod",
      "parameter": "culpa ipsum dolore fugiat voluptate"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "labore cupidatat",
      "field": null,
      "message": "sint amet aute ea",
      "parameter": "ea in esse"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "commodo sunt labore aute irure",
      "field": null,
      "message": "sint ea dolore",
      "parameter": "veniam nisi Excepteur"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "enim dolor quis pariatur sed",
      "field": "pariatur",
      "message": "cillum",
      "parameter": "tempor irure incididunt exercitation"
    }
  ]
}

GET

/v3/mail_settings/template

**This endpoint allows you to retrieve your current legacy email template settings.** This setting refers to our original email templates. We currently support more fully featured [Dynamic Transactional Templates](https://sendgrid.com/docs/ui/sending-email/how-to-send-an-email-with-dynamic-transac

Header Name	Example
`on-behalf-of`	`"in"`

Request Payload

Response Payload

{
  "enabled": false,
  "html_content": "<p><% body %>Example</p>\n"
}

{
  "errors": [
    {
      "error_id": "cupidatat ut",
      "field": "amet nisi ipsum laborum nostrud",
      "message": "in qui ut cillum",
      "parameter": "exercitation fugiat ut reprehenderit irure"
    },
    {
      "error_id": "consequat Ut eiusmod nulla",
      "field": null,
      "message": "ea",
      "parameter": "dolore exercitation eu amet officia"
    },
    {
      "error_id": "laborum cillum dolore Lorem",
      "field": "incididunt occaecat",
      "message": "in amet",
      "parameter": "minim ea magna id do"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "aliquip nisi dolore proident dolore",
      "field": "est ut",
      "message": "in anim voluptate deserunt sunt",
      "parameter": "quis in consectetur ut in"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "sed Excepteur pariatur esse elit",
      "field": null,
      "message": "amet",
      "parameter": "sunt proident"
    },
    {
      "error_id": "Duis esse eiusmod sed est",
      "field": null,
      "message": "ullamco occaecat ut aliqua",
      "parameter": "id aliquip quis do"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "laboris",
      "field": null,
      "message": "ea reprehenderit fugiat aliquip dolore",
      "parameter": "consequat non"
    },
    {
      "error_id": "voluptate nulla id",
      "field": "ex in eiusmod",
      "message": "ut Lorem velit",
      "parameter": "adipisicing tempor elit"
    },
    {
      "error_id": "consectetur et est",
      "field": "nisi et commodo sunt",
      "message": "occaecat dolore",
      "parameter": "dolore cillum"
    },
    {
      "error_id": "cupidatat",
      "field": "occaecat cillum",
      "message": "eiusmod exercitation",
      "parameter": "incididunt qui aliquip dolore"
    },
    {
      "error_id": "velit mollit cillum aliquip dolor",
      "field": null,
      "message": "ex minim nulla cupidatat",
      "parameter": "voluptate non commodo mollit tempor"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "Lorem voluptate nulla mollit eu",
      "field": null,
      "message": "id sed pariatur incididunt",
      "parameter": "irure nisi"
    },
    {
      "error_id": "Duis consequat",
      "field": null,
      "message": "cupidatat Ut in",
      "parameter": "nostrud ad proident commodo"
    },
    {
      "error_id": "laborum reprehenderit sunt aute do",
      "field": "irure consectetur aute dolor",
      "message": "in deserunt",
      "parameter": "pariatur qui id"
    }
  ]
}

PATCH

/v3/mail_settings/bounce_purge

**This endpoint allows you to update your current bounce and purge settings.** The Bounce Perge setting allows you to set a schedule that Twilio SendGrid will use to automatically delete contacts from your soft and hard bounce suppression lists. The schedule is set in full days by assigning the nu

Header Name	Example
`on-behalf-of`	`"exercitation cillum"`

Request Payload

{
  "enabled": true,
  "hard_bounces": 5,
  "soft_bounces": 5
}

Response Payload

{
  "enabled": false,
  "hard_bounces": 5,
  "soft_bounces": 5
}

{
  "errors": [
    {
      "error_id": "sint magna aute",
      "field": null,
      "message": "in Duis velit sint",
      "parameter": "cillum minim ipsum qui enim"
    },
    {
      "error_id": "do non",
      "field": null,
      "message": "Ut magna",
      "parameter": "dolor voluptate irure"
    },
    {
      "error_id": "ad in",
      "field": null,
      "message": "eu ut officia adipisicing non",
      "parameter": "cupidatat id laboris ex"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "velit est",
      "field": null,
      "message": "deserunt",
      "parameter": "consequat dolor"
    },
    {
      "error_id": "laborum sint in",
      "field": "dolor",
      "message": "dolore minim eu",
      "parameter": "in pariatur"
    },
    {
      "error_id": "deserunt",
      "field": "consectetur nulla culpa Lorem",
      "message": "mollit aute",
      "parameter": "aliquip minim laborum nulla"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "incididunt in",
      "field": "pariatur amet Excepteur",
      "message": "sint labore Duis eiusmod ea",
      "parameter": "in ad anim sint"
    },
    {
      "error_id": "ullamco aute adipisicing ipsum Ut",
      "field": "commodo eu",
      "message": "velit Excepteur magna deserunt",
      "parameter": "minim"
    },
    {
      "error_id": "irure",
      "field": null,
      "message": "nulla nostrud officia",
      "parameter": "nisi in cupidatat do dolore"
    },
    {
      "error_id": "dolore est esse aliquip dolor",
      "field": null,
      "message": "ad fugiat in",
      "parameter": "occaecat in eiusmod"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "in",
      "field": null,
      "message": "in",
      "parameter": "qui quis laboris nostrud nulla"
    },
    {
      "error_id": "Duis",
      "field": "ullamco",
      "message": "incididunt",
      "parameter": "ad proident labore sunt commodo"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "cupidatat aute nisi dolore",
      "field": null,
      "message": "ullamco exercitation mollit aliquip",
      "parameter": "nostrud non mollit enim nisi"
    },
    {
      "error_id": "elit mollit et aliquip ut",
      "field": null,
      "message": "esse",
      "parameter": "amet est laboris fugiat"
    },
    {
      "error_id": "in dolor",
      "field": null,
      "message": "reprehenderit nisi",
      "parameter": "proident aliqua commodo consequat tempor"
    },
    {
      "error_id": "consectetur Duis in",
      "field": "labore ullamco",
      "message": "deserunt velit laboris",
      "parameter": "ut eu"
    }
  ]
}

GET

/v3/mail_settings/bounce_purge

**This endpoint allows you to retrieve your current bounce and purge settings.** The Bounce Perge setting allows you to set a schedule that Twilio SendGrid will use to automatically delete contacts from your soft and hard bounce suppression lists. A hard bounce occurs when an email message has be

Header Name	Example
`on-behalf-of`	`"in aute Lorem reprehenderit"`

Request Payload

Response Payload

{
  "enabled": false,
  "soft_bounces": 5,
  "hard_bounces": 5
}

{
  "errors": [
    {
      "error_id": "mollit ad ex sint aliquip",
      "field": null,
      "message": "officia ea",
      "parameter": "Duis"
    },
    {
      "error_id": "et Duis",
      "field": "veniam consectetur fugiat elit",
      "message": "velit dolor consequat",
      "parameter": "esse eiusmod sint Excepteur in"
    },
    {
      "error_id": "qui nulla",
      "field": "amet",
      "message": "magna",
      "parameter": "adipisicing ut in in fugiat"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "nisi dolore laborum et",
      "field": null,
      "message": "nisi aute culpa",
      "parameter": "in sit"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "dolore sint id voluptate Excepteur",
      "field": null,
      "message": "velit est incididunt ex veniam",
      "parameter": "cupidatat ut mollit"
    },
    {
      "error_id": "anim",
      "field": "dolor eiusmod proident",
      "message": "et sunt proident in",
      "parameter": "incididunt"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "enim aliquip consequat Excepteur aute",
      "field": null,
      "message": "Lorem in",
      "parameter": "exercitation dolore Ut"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ad quis incididunt adipisicing",
      "field": null,
      "message": "quis",
      "parameter": "id elit sint in"
    },
    {
      "error_id": "cupidatat",
      "field": "cupidatat officia in",
      "message": "ullamco",
      "parameter": "qui enim dolore"
    }
  ]
}

PATCH

/v3/mail_settings/forward_bounce

**This endpoint allows you to update your current bounce forwarding mail settings.** Enabling the Forward Bounce setting allows you to specify an `email` address to which bounce reports will be forwarded. You can also configure the Forward Spam mail settings in the [Mail Settings section of the T

Header Name	Example
`on-behalf-of`	`"ut exercitation pariatur sed"`

Request Payload

{
  "enabled": true,
  "email": "bounces@example.com"
}

Response Payload

{
  "email": "bounces@example.com",
  "enabled": true
}

{
  "errors": [
    {
      "error_id": "sunt magna sed",
      "field": "incididunt sunt tempor cupidatat",
      "message": "voluptate quis",
      "parameter": "sit veniam adipisicing ut"
    },
    {
      "error_id": "commodo Ut incididunt laboris",
      "field": "adipisicing qui occaecat exercitation sit",
      "message": "pariatur est aliquip enim",
      "parameter": "voluptate eiusmod"
    },
    {
      "error_id": "Excepteur nostrud est magna",
      "field": null,
      "message": "ut culpa",
      "parameter": "labore eu mollit magna sed"
    },
    {
      "error_id": "ullamco",
      "field": "ea quis pariatur",
      "message": "tempor mollit",
      "parameter": "sed ad"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "enim aliqua ut Ut nostrud",
      "field": null,
      "message": "ipsum in nostrud in",
      "parameter": "occaecat cupidatat"
    },
    {
      "error_id": "officia proident qui quis",
      "field": "ut deserunt in",
      "message": "velit quis commodo",
      "parameter": "cillum Ut sint ullamco laboris"
    },
    {
      "error_id": "adipisicing officia id",
      "field": "dolor Lorem ut non",
      "message": "in do Duis in",
      "parameter": "consequat ipsum amet proident dolor"
    },
    {
      "error_id": "proident consectetur laboris eu",
      "field": "elit sit do aute cillum",
      "message": "veniam",
      "parameter": "proident Ut"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "id nulla in in sit",
      "field": "laboris ea",
      "message": "eiusmod ullamco",
      "parameter": "mollit in nisi"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "pariatur consequat nostrud in",
      "field": "sit",
      "message": "esse aliqua velit",
      "parameter": "mollit nisi aliquip officia"
    },
    {
      "error_id": "laborum dolore dolor ut officia",
      "field": "cupidatat",
      "message": "et quis",
      "parameter": "fugiat voluptate esse"
    },
    {
      "error_id": "irure",
      "field": "proident eiusmod aute officia voluptate",
      "message": "commodo in",
      "parameter": "nulla"
    },
    {
      "error_id": "velit aute pariatur nulla quis",
      "field": "ullamco pariatur labore",
      "message": "amet dolore nisi ad fugiat",
      "parameter": "veniam voluptate cupidatat"
    },
    {
      "error_id": "anim tempor deserunt aute",
      "field": null,
      "message": "eu aliquip consequat Lorem",
      "parameter": "sunt laborum tempor in qui"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ea in ullamco dolore",
      "field": null,
      "message": "exercitation",
      "parameter": "amet"
    }
  ]
}

GET

/v3/mail_settings/forward_bounce

**This endpoint allows you to retrieve your current bounce forwarding mail settings.** Enabling the Forward Bounce setting allows you to specify `email` addresses to which bounce reports will be forwarded. This endpoint returns the email address you have set to receive forwarded bounces and an `en

Header Name	Example
`on-behalf-of`	`"aliquip proident"`

Request Payload

Response Payload

{
  "enabled": true,
  "email": "bounces@example.com"
}

{
  "errors": [
    {
      "error_id": "exercitation Ut",
      "field": null,
      "message": "in",
      "parameter": "veniam Duis ullamco eu"
    },
    {
      "error_id": "exercitation quis",
      "field": null,
      "message": "sint dolore ullamco laboris nostrud",
      "parameter": "Excepteur Ut pariatur exercitation"
    },
    {
      "error_id": "ut occaecat ea",
      "field": null,
      "message": "aliquip amet do adipisicing",
      "parameter": "laboris ex"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "nulla elit",
      "field": "voluptate pariatur",
      "message": "et",
      "parameter": "reprehenderit est do"
    },
    {
      "error_id": "labore sit cillum",
      "field": null,
      "message": "deserunt esse enim",
      "parameter": "eiusmod do consequat mollit consectetur"
    },
    {
      "error_id": "velit Lorem sunt proident",
      "field": null,
      "message": "culpa",
      "parameter": "est labore occaecat sunt"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "Lorem exercitation cillum",
      "field": null,
      "message": "Lorem irure magna anim",
      "parameter": "deserunt et"
    },
    {
      "error_id": "dolore ipsum Excepteur culpa sit",
      "field": "laborum Ut aliqua",
      "message": "aliquip",
      "parameter": "aliqua dolore in minim est"
    },
    {
      "error_id": "Lorem dolor",
      "field": "nisi dolore esse reprehenderit ex",
      "message": "esse exercitation id",
      "parameter": "aliqua enim id sint"
    },
    {
      "error_id": "sunt",
      "field": null,
      "message": "eiusmod in",
      "parameter": "cupidatat nulla"
    },
    {
      "error_id": "dolore Ut et aliqua",
      "field": "aute",
      "message": "dolor sunt",
      "parameter": "ullamco tempor"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "proident",
      "field": null,
      "message": "ad",
      "parameter": "eiusmod dolor id incididunt officia"
    },
    {
      "error_id": "quis magna",
      "field": null,
      "message": "officia",
      "parameter": "ea aute"
    },
    {
      "error_id": "proident",
      "field": null,
      "message": "enim nisi in labore in",
      "parameter": "ut pariatur magna consectetur id"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "aliquip consequat in incididunt",
      "field": null,
      "message": "incididunt",
      "parameter": "et reprehenderit"
    },
    {
      "error_id": "dolor cupidatat nisi Excepteur",
      "field": "sunt in dolor",
      "message": "velit",
      "parameter": "adipisicing"
    }
  ]
}

Settings - Partner(3 operations)

PATCH

/v3/partner_settings/new_relic

**This endpoint allows you to update or change your New Relic partner settings.** Our partner settings allow you to integrate your SendGrid account with our partners to increase your SendGrid experience and functionality. For more information about our partners, and how you can begin integrating w

Header Name	Example
`on-behalf-of`	`"cillum sint"`

Request Payload

{
  "license_key": "",
  "enabled": true,
  "enable_subuser_statistics": true
}

Response Payload

{
  "enable_subuser_statistics": true,
  "enabled": true,
  "license_key": ""
}

GET

/v3/partner_settings/new_relic

**This endpoint allows you to retrieve your current New Relic partner settings.** Our partner settings allow you to integrate your SendGrid account with our partners to increase your SendGrid experience and functionality. For more information about our partners, and how you can begin integrating w

Header Name	Example
`on-behalf-of`	`"in sunt"`

Request Payload

Response Payload

{
  "enable_subuser_statistics": false,
  "enabled": true,
  "license_key": ""
}

GET

/v3/partner_settings

**This endpoint allows you to retrieve a list of all partner settings that you can enable.** Our partner settings allow you to integrate your SendGrid account with our partners to increase your SendGrid experience and functionality. For more information about our partners, and how you can begin in

Query Parameter Name	Example
`limit`	`79317764`
`offset`	`-41433633`

Header Name	Example
`on-behalf-of`	`"sunt labore"`

Request Payload

Response Payload

{
  "result": [
    {
      "title": "Partner title",
      "enabled": true,
      "name": "partner_name",
      "description": "A description of a partner."
    }
  ]
}

Teammates(11 operations)

POST

/v3/teammates

**This endpoint allows you to invite a Teammate to your account via email.** You can set a Teammate's initial permissions using the `scopes` array in the request body. Teammate's will receive a minimum set of scopes from Twilio SendGrid that are necessary for the Teammate to function. **Note:** A

Header Name	Example
`on-behalf-of`	`"ut dolore"`

Request Payload

{
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}

Response Payload

{
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}

{
  "errors": [
    {
      "field": "esse fugiat",
      "message": "laboris consequat dolor"
    }
  ]
}

GET

/v3/teammates

**This endpoint allows you to retrieve a list of all current Teammates.** You can limit the number of results returned using the `limit` query paramater. To return results from a specific Teammate, use the `offset` paramter. The Response Headers will include pagination info.

Query Parameter Name	Example
`limit`	`256`
`offset`	`57543599`

Header Name	Example
`on-behalf-of`	`"ut"`

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"
    }
  ]
}

POST

/v3/teammates/pending/{token}/resend

**This endpoint allows you to resend a Teammate invitation.** Teammate invitations will expire after 7 days. Resending an invitation will reset the expiration date.

Header Name	Example
`on-behalf-of`	`"ea"`

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"
    }
  ]
}

GET

/v3/scopes/requests

**This endpoint allows you to retrieve a list of all recent access requests.** The Response Header's `link` parameter will include pagination info.

Query Parameter Name	Example
`limit`	`17336516`
`offset`	`-66229226`

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"
  }
]

GET

/v3/teammates/pending

**This endpoint allows you to retrieve a list of all pending Teammate invitations.** Each teammate invitation is valid for 7 days. Users may resend the invitation to refresh the expiration date.

Header Name	Example
`on-behalf-of`	`"in in nisi"`

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
    }
  ]
}

GET

/v3/teammates/{username}

**This endpoint allows you to retrieve a specific Teammate by username.** You can retrieve the username's for each of your Teammates using the "Retrieve all Teammates" endpoint.

Header Name	Example
`on-behalf-of`	`"in nisi ea"`

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"
}

PATCH

/v3/teammates/{username}

**This endpoint allows you to update a teammate’s permissions.** To turn a teammate into an admin, the request body should contain an `is_admin` set to `true`. Otherwise, set `is_admin` to `false` and pass in all the scopes that a teammate should have. **Only the parent user or other admin teamma

Header Name	Example
`on-behalf-of`	`"Lorem sed do adipisicing"`

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"
    }
  ]
}

DELETE

/v3/teammates/{username}

**This endpoint allows you to delete a teammate.** **Only the parent user or an admin teammate can delete another teammate.**

Header Name	Example
`on-behalf-of`	`"laborum in minim nulla elit"`

Request Payload

Response Payload

{
  "errors": [
    {
      "field": "in",
      "message": "esse"
    }
  ]
}

{
  "errors": [
    {
      "message": "username not found",
      "field": "username"
    }
  ]
}

PATCH

/v3/scopes/requests/{request_id}/approve

**This endpoint allows you to approve an access attempt.** **Note:** Only teammate admins may approve another teammate’s access request.

Request Payload

Response Payload

{
  "scope_group_name": "Stats"
}

{}

{
  "errors": [
    {
      "field": "minim laboris occaecat",
      "message": "qui sint dolor irure"
    },
    {
      "field": "quis minim Ut",
      "message": "est ipsum"
    },
    {
      "field": "magna ea in in commodo",
      "message": "in Excepteur"
    },
    {
      "field": "elit sunt cillum",
      "message": "laborum deserunt fugiat"
    },
    {
      "field": "consectetur reprehenderit non",
      "message": "do"
    }
  ]
}

DELETE

/v3/scopes/requests/{request_id}

**This endpoint allows you to deny an attempt to access your account.** **Note:** Only teammate admins may delete a teammate's access request.

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"
    }
  ]
}

DELETE

/v3/teammates/pending/{token}

**This endpoint allows you to delete a pending teammate invite.**

Header Name	Example
`on-behalf-of`	`"magna eu ut"`

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "errors": [
    {
      "field": "sint",
      "message": "dolor deserunt cillum"
    },
    {
      "field": "ullamco ipsum",
      "message": "anim"
    }
  ]
}

Alerts(5 operations)

POST

/v3/alerts

**This endpoint allows you to create a new alert.** Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics. There are two types of alerts that can be created with this endpoint: * `usage_limit` allows you to set the threshold at which an ale

Header Name	Example
`Authorization`	`"qui minim occaecat sunt"`
`on-behalf-of`	`"in adipisicing mollit fugiat ut"`

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": "eiusmod dolor cupidatat culpa nulla",
  "message": "esse sed Lorem dolore"
}

GET

/v3/alerts

**This endpoint allows you to retrieve all of your alerts.** Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics. * Usage alerts allow you to set the threshold at which an alert will be sent. * Stats notifications allow you to set how fre

Header Name	Example
`Authorization`	`"mollit"`
`on-behalf-of`	`"dolore Ut aute nostrud Excepteur"`

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
  }
]

GET

/v3/alerts/{alert_id}

**This endpoint allows you to retrieve a specific alert.** Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics. * Usage alerts allow you to set the threshold at which an alert will be sent. * Stats notifications allow you to set how frequ

Header Name	Example
`Authorization`	`"ex adipisicing eu et tempor"`
`on-behalf-of`	`"officia"`

Request Payload

Response Payload

{
  "created_at": 1451520930,
  "email_to": "example@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451520930
}

DELETE

/v3/alerts/{alert_id}

**This endpoint allows you to delete an alert.** Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics. * Usage alerts allow you to set the threshold at which an alert will be sent. * Stats notifications allow you to set how frequently you

Header Name	Example
`on-behalf-of`	`"Lorem incididunt quis sunt consectetur"`

Request Payload

Response Payload

{}

PATCH

/v3/alerts/{alert_id}

**This endpoint allows you to update an alert.** Alerts allow you to specify an email address to receive notifications regarding your email usage or statistics. * Usage alerts allow you to set the threshold at which an alert will be sent. * Stats notifications allow you to set how frequently you

Header Name	Example
`on-behalf-of`	`"eiusmod dolor dolore 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)

GET

/v3/user/profile

Get a user's profile

Header Name	Example
`on-behalf-of`	`"ullamco dolor"`

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"
}

PATCH

/v3/user/profile

**This endpoint allows you to update your current profile details.** Any one or more of the parameters can be updated via the PATCH `/user/profile` endpoint. You must include at least one when you PATCH.

Header Name	Example
`on-behalf-of`	`"pariatur"`

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"
    }
  ]
}

GET

/v3/user/account

**This endpoint allows you to retrieve your user account details.** Your user's account information includes the user's account type and reputation.

Header Name	Example
`on-behalf-of`	`"voluptate ut in minim"`

Request Payload

Response Payload

{
  "reputation": 100,
  "type": "paid"
}

GET

/v3/user/email

**This endpoint allows you to retrieve the email address currently on file for your account.**

Header Name	Example
`on-behalf-of`	`"dolor pariatur non minim"`

Request Payload

Response Payload

{
  "email": "test@example.com"
}

PUT

/v3/user/email

**This endpoint allows you to update the email address currently on file for your account.**

Header Name	Example
`on-behalf-of`	`"minim cillum"`

Request Payload

{
  "email": "example@example.com"
}

Response Payload

{
  "email": "example@example.com"
}

GET

/v3/user/username

**This endpoint allows you to retrieve your current account username.**

Header Name	Example
`on-behalf-of`	`"est"`

Request Payload

Response Payload

{
  "username": "test_username",
  "user_id": 1
}

PUT

/v3/user/username

**This endpoint allows you to update the username for your account.**

Header Name	Example
`on-behalf-of`	`"ipsum ut consequat esse"`

Request Payload

{
  "username": "test_username"
}

Response Payload

{
  "username": "test_username"
}

GET

/v3/user/credits

**This endpoint allows you to retrieve the current credit balance for your account.** Each account has a credit balance, which is a base number of emails it can send before receiving per-email charges. For more information about credits and billing, see [Billing and Plan details information](https

Header Name	Example
`on-behalf-of`	`"ut dolore in magna proident"`

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"
}

PUT

/v3/user/password

**This endpoint allows you to update your password.**

Header Name	Example
`on-behalf-of`	`"labore cupidatat deserunt"`

Request Payload

{
  "new_password": "new_password",
  "old_password": "old_password"
}

Response Payload

{}

Subusers API(6 operations)

GET

/v3/subusers

**This endpoint allows you to retrieve a list of all of your subusers.** You can choose to retrieve specific subusers as well as limit the results that come back from the API.

Query Parameter Name	Example
`username`	`sed`
`limit`	`-89484656`
`offset`	`77097452`

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"
    }
  ]
}

POST

/v3/subusers

**This endpoint allows you to create a new subuser.**

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"
    }
  ]
}

PATCH

/v3/subusers/{subuser_name}

**This endpoint allows you to enable or disable a subuser.**

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"
    }
  ]
}

DELETE

/v3/subusers/{subuser_name}

**This endpoint allows you to delete a subuser.** This is a permanent action. Once deleted, a subuser cannot be retrieved.

Request Payload

Response Payload

{}

{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

GET

/v3/subusers/reputations

**This endpoint allows you to request the reputations for your subusers.** Subuser sender reputations give a good idea how well a sender is doing with regards to how recipients and recipient servers react to the mail that is being received. When a bounce, spam report, or other negative action happ

Query Parameter Name	Example
`usernames`	`est`

Request Payload

Response Payload

[
  {
    "username": "example_subuser",
    "reputation": 99
  },
  {
    "username": "example_subuser2",
    "reputation": 95.2
  }
]

PUT

/v3/subusers/{subuser_name}/ips

**This endpoint allows you update your subusers' assigned IP.** Each subuser should be assigned to an IP address from which all of this subuser's mail will be sent. Often, this is the same IP as the parent account, but each subuser can have one or more of their own IP addresses as well. More inf

Request Payload

[
  "127.0.0.1"
]

Response Payload

{
  "ips": [
    "127.0.0.1"
  ]
}

{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Subuser Monitor Settings(4 operations)

GET

/v3/subusers/{subuser_name}/monitor

Retrieve monitor settings for a subuser

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"
    }
  ]
}

POST

/v3/subusers/{subuser_name}/monitor

Create monitor settings

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"
    }
  ]
}

PUT

/v3/subusers/{subuser_name}/monitor

Update Monitor Settings for a subuser

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"
    }
  ]
}

DELETE

/v3/subusers/{subuser_name}/monitor

Delete monitor settings

Request Payload

Response Payload

{}

{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

{
  "errors": [
    {
      "field": null,
      "message": "No monitor settings for this user"
    }
  ]
}

Subuser Statistics(4 operations)

GET

/v3/subusers/{subuser_name}/stats/monthly

**This endpoint allows you to retrive the monthly email statistics for a specific subuser.** When using the `sort_by_metric` to sort your stats by a specific metric, you can not sort by the following metrics: `bounce_drops`, `deferred`, `invalid_emails`, `processed`, `spam_report_drops`, `spam_rep

Query Parameter Name	Example
`date`*	`occaecat`
`sort_by_metric`	`cupidatat labore veniam`
`sort_by_direction`	`desc`
`limit`	`-75165187`
`offset`	`-93277207`

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"
    }
  ]
}

GET

/v3/subusers/stats/monthly

**This endpoint allows you to retrieve the monthly email statistics for all subusers over the given date range.** When using the `sort_by_metric` to sort your stats by a specific metric, you can not sort by the following metrics: `bounce_drops`, `deferred`, `invalid_emails`, `processed`, `spam_rep

Query Parameter Name	Example
`date`*	`in`
`subuser`	`dolore cupidatat`
`sort_by_metric`	`blocks`
`sort_by_direction`	`asc`
`limit`	`49426706`
`offset`	`-5096741`

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"
    }
  ]
}

GET

/v3/subusers/stats/sums

**This endpoint allows you to retrieve the total sums of each email statistic metric for all subusers over the given date range.**

Query Parameter Name	Example
`sort_by_direction`	`desc`
`start_date`*	`id`
`end_date`	`occaecat dolore cillum ipsum`
`limit`	`-39501526`
`offset`	`60809917`
`aggregated_by`	`proident aute`
`sort_by_metric`	`laboris deserunt`

Request Payload

Response Payload

{
  "date": "2015-10-11",
  "stats": []
}

GET

/v3/subusers/stats

**This endpoint allows you to retrieve the email statistics for the given subusers.** You may retrieve statistics for up to 10 different subusers by including an additional _subusers_ parameter for each additional subuser.

Query Parameter Name	Example
`limit`	`85170997`
`offset`	`35130768`
`aggregated_by`	`week`
`subusers`*	`deserunt ullamco culpa reprehenderit dolore`
`start_date`*	`Lorem labore aliqua cillum tempor`
`end_date`	`sit`

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)

POST

/v3/whitelabel/links

**This endpoint allows you to create a new branded link.** To create the link branding, supply the root domain and, optionally, the subdomain — these go into separate fields in your request body. The root domain should match your FROM email address. If you provide a subdomain, it must be differen

Header Name	Example
`on-behalf-of`	`"ullamco anim Lorem esse aliquip"`

Request Payload

{
  "domain": "example.com",
  "subdomain": "mail",
  "default": true
}

Response Payload

{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "john@example.com",
  "user_id": 7,
  "default": false,
  "valid": true,
  "legacy": false,
  "dns": {
    "domain_cname": {
      "valid": true,
      "type": "cname",
      "host": "mail.example.com",
      "data": "sendgrid.net"
    },
    "owner_cname": {
      "valid": true,
      "type": "cname",
      "host": "7.example.com",
      "data": "sendgrid.net"
    }
  }
}

GET

/v3/whitelabel/links

**This endpoint allows you to retrieve all branded links**. You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request.

Query Parameter Name	Example
`limit`	`8663191`

Header Name	Example
`on-behalf-of`	`"irure enim"`

Request Payload

Response Payload

[
  {
    "id": 1,
    "domain": "example.com",
    "subdomain": "mail",
    "username": "john@example.com",
    "user_id": 7,
    "default": true,
    "valid": true,
    "legacy": false,
    "dns": {
      "domain_cname": {
        "valid": true,
        "type": "cname",
        "host": "mail.example.com",
        "data": "sendgrid.net"
      },
      "owner_cname": {
        "valid": true,
        "type": "cname",
        "host": "7.example.com",
        "data": "sendgrid.net"
      }
    }
  },
  {
    "id": 2,
    "domain": "example2.com",
    "subdomain": "news",
    "username": "john@example.com",
    "user_id": 8,
    "default": false,
    "valid": false,
    "legacy": false,
    "dns": {
      "domain_cname": {
        "valid": true,
        "type": "cname",
        "host": "news.example2.com",
        "data": "sendgrid.net"
      },
      "owner_cname": {
        "valid": false,
        "type": "cname",
        "host": "8.example2.com",
        "data": "sendgrid.net"
      }
    }
  }
]

POST

/v3/whitelabel/links/{id}/validate

**This endpoint allows you to validate a branded link.** You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request.

Header Name	Example
`on-behalf-of`	`"commodo dolore enim incididunt"`

Request Payload

Response Payload

{
  "id": 1,
  "valid": true,
  "validation_results": {
    "domain_cname": {
      "valid": false,
      "reason": "Expected CNAME to match \"sendgrid.net.\" but found \"example.com.\"."
    },
    "owner_cname": {
      "valid": true,
      "reason": null
    }
  }
}

{
  "errors": [
    {
      "message": "internal error getting CNAME"
    }
  ]
}

POST

/v3/whitelabel/links/{link_id}/subuser

**This endpoint allows you to associate a branded link with a subuser account.** Link branding can be associated with subusers from the parent account. This functionality allows subusers to send mail using their parent's link branding. To associate link branding, the parent account must first crea

Request Payload

{
  "username": "jane@example.com"
}

Response Payload

{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "john@example.com",
  "user_id": 7,
  "default": false,
  "valid": true,
  "legacy": false,
  "dns": {
    "domain_cname": {
      "valid": true,
      "type": "cname",
      "host": "mail.example.com",
      "data": "sendgrid.net"
    },
    "owner_cname": {
      "valid": true,
      "type": "cname",
      "host": "7.example.com",
      "data": "sendgrid.net"
    }
  }
}

GET

/v3/whitelabel/links/{id}

**This endpoint allows you to retrieve a specific branded link by providing its ID.** You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request.

Header Name	Example
`on-behalf-of`	`"ut proident"`

Request Payload

Response Payload

{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "john@example.com",
  "user_id": 7,
  "default": false,
  "valid": true,
  "legacy": false,
  "dns": {
    "domain_cname": {
      "valid": true,
      "type": "cname",
      "host": "mail.example.com",
      "data": "sendgrid.net"
    },
    "owner_cname": {
      "valid": true,
      "type": "cname",
      "host": "7.example.com",
      "data": "sendgrid.net"
    }
  }
}

PATCH

/v3/whitelabel/links/{id}

**This endpoint allows you to update a specific branded link. You can use this endpoint to change a branded link's default status.** You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request.

Header Name	Example
`on-behalf-of`	`"cupidatat exercitation"`

Request Payload

{
  "default": true
}

Response Payload

{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "john@example.com",
  "user_id": 7,
  "default": true,
  "valid": true,
  "legacy": false,
  "dns": {
    "domain_cname": {
      "valid": true,
      "type": "cname",
      "host": "mail.example.com",
      "data": "sendgrid.net"
    },
    "owner_cname": {
      "valid": true,
      "type": "cname",
      "host": "7.example.com",
      "data": "sendgrid.net"
    }
  }
}

DELETE

/v3/whitelabel/links/{id}

**This endpoint allows you to delete a branded link.** Your request will receive a response with a 204 status code if the deletion was successful. The call does not return the link's details, so if you wish to record these make sure you call the "Retrieve a branded link" endpoint *before* you req

Header Name	Example
`on-behalf-of`	`"magna"`

Request Payload

Response Payload

{}

GET

/v3/whitelabel/links/default

**This endpoint allows you to retrieve the default branded link.** The default branded link is the actual URL to be used when sending messages. If you have more than one branded link, the default is determined by the following order: * The validated branded link marked as `default` (set when you

Query Parameter Name	Example
`domain`	`aliquip eu`

Header Name	Example
`on-behalf-of`	`"Ut laboris tempor aliqua Lorem"`

Request Payload

Response Payload

{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "john@example.com",
  "user_id": 7,
  "default": false,
  "valid": true,
  "legacy": false,
  "dns": {
    "domain_cname": {
      "valid": true,
      "type": "cname",
      "host": "mail.example.com",
      "data": "sendgrid.net"
    },
    "owner_cname": {
      "valid": true,
      "type": "cname",
      "host": "7.example.com",
      "data": "sendgrid.net"
    }
  }
}

GET

/v3/whitelabel/links/subuser

**This endpoint allows you to retrieve the branded link associated with a subuser.** Link branding can be associated with subusers from the parent account. This functionality allows subusers to send mail using their parent's link branding. To associate link branding, the parent account must first

Query Parameter Name	Example
`username`*	`aliqua ullamco occaecat consequat officia`

Request Payload

Response Payload

{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "john@example.com",
  "user_id": 7,
  "default": false,
  "valid": true,
  "legacy": false,
  "dns": {
    "domain_cname": {
      "valid": true,
      "type": "cname",
      "host": "mail.example.com",
      "data": "sendgrid.net"
    },
    "owner_cname": {
      "valid": true,
      "type": "cname",
      "host": "7.example.com",
      "data": "sendgrid.net"
    }
  }
}

DELETE

/v3/whitelabel/links/subuser

**This endpoint allows you to take a branded link away from a subuser.** Link branding can be associated with subusers from the parent account. This functionality allows subusers to send mail using their parent's link branding. To associate link branding, the parent account must first create a bra

Query Parameter Name	Example
`username`*	`labore`

Request Payload

Response Payload

{}

IP Warmup(4 operations)

POST

/v3/ips/warmup

**This endpoint allows you to put an IP address into warmup mode.**

Request Payload

{
  "ip": "0.0.0.0"
}

Response Payload

[
  {
    "ip": "0.0.0.0",
    "start_date": 1409616000
  }
]

{
  "errors": [
    {
      "field": null,
      "message": "resource not found"
    }
  ]
}

GET

/v3/ips/warmup

**This endpoint allows you to retrieve all of your IP addresses that are currently warming up.**

Request Payload

Response Payload

[
  {
    "ip": "0.0.0.0",
    "start_date": 1409616000
  }
]

GET

/v3/ips/warmup/{ip_address}

**This endpoint allows you to retrieve the warmup status for a specific IP address.** You can retrieve all of your warming IPs using the "Retrieve all IPs currently in warmup" endpoint.

Request Payload

Response Payload

[
  {
    "ip": "0.0.0.0",
    "start_date": 1409616000
  }
]

{
  "errors": [
    {
      "field": null,
      "message": "resource not found"
    }
  ]
}

DELETE

/v3/ips/warmup/{ip_address}

**This endpoint allows you to remove an IP address from warmup mode.** Your request will return a 204 status code if the specified IP was successfully removed from warmup mode. To retrieve details of the IP’s warmup status *before* removing it from warmup mode, call the "Retrieve the warmpup stat

Request Payload

Response Payload

{}

{
  "errors": [
    {
      "field": null,
      "message": "resource not found"
    }
  ]
}

Reverse DNS(5 operations)

POST

/v3/whitelabel/ips

**This endpoint allows you to set up reverse DNS.**

Header Name	Example
`on-behalf-of`	`"Lorem exercitation"`

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"
  }
}

GET

/v3/whitelabel/ips

**This endpoint allows you to retrieve all of the Reverse DNS records created by this account.** You may include a search key by using the `ip` query string parameter. This enables you to perform a prefix search for a given IP segment (e.g., `?ip="192."`). Use the `limit` query string parameter t

Query Parameter Name	Example
`limit`	`8034929`
`offset`	`-53039558`
`ip`	`Excepteur mollit dolore`

Header Name	Example
`on-behalf-of`	`"laboris Ut"`

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"
    }
  }
]

POST

/v3/whitelabel/ips/{id}/validate

**This endpoint allows you to validate a reverse DNS record.** Always check the `valid` property of the response’s `validation_results.a_record` object. This field will indicate whether it was possible to validate the reverse DNS record. If the `validation_results.a_record.valid` is `false`, this

Header Name	Example
`on-behalf-of`	`"commodo pariatur irure ullamco"`

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"
    }
  ]
}

GET

/v3/whitelabel/ips/{id}

**This endpoint allows you to retrieve a reverse DNS record.** You can retrieve the IDs associated with all your reverse DNS records using the "Retrieve all reverse DNS records" endpoint.

Header Name	Example
`on-behalf-of`	`"id nulla proident pariatur incididunt"`

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"
  }
}

DELETE

/v3/whitelabel/ips/{id}

**This endpoint allows you to delete a reverse DNS record.** A call to this endpoint will respond with a 204 status code if the deletion was successful. You can retrieve the IDs associated with all your reverse DNS records using the "Retrieve all reverse DNS records" endpoint.

Header Name	Example
`on-behalf-of`	`"do in anim id fugiat"`

Request Payload

Response Payload

{}

Email Address Validation

POST

/v3/validations/email

**This endpoint allows you to validate an email address.**

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

POST

/v3/whitelabel/dns/email

**This endpoint is used to share DNS records with a colleagues** Use this endpoint to send SendGrid-generated DNS record information to a co-worker so they can enter it into your DNS provider to validate your domain and link branding. What type of records are sent will depend on whether you have

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": "laborum ex consectetur id magna",
    "field": "reprehenderit nulla nisi nostrud Lorem"
  }
}

IP Pools(7 operations)

POST

/v3/ips/pools

**This endpoint allows you to create an IP pool.** Before you can create an IP pool, you need to activate the IP in your SendGrid account: 1. Log into your SendGrid account. 1. Navigate to **Settings** and then select **IP Addresses**. 1. Find the IP address you want to activate and then cli

Request Payload

{
  "name": "marketing"
}

Response Payload

{
  "name": "marketing"
}

GET

/v3/ips/pools

**This endpoint allows you to get all of your IP pools.**

Request Payload

Response Payload

[
  {
    "name": "marketing"
  },
  {
    "name": "transactional"
  }
]

POST

/v3/ips/pools/{pool_name}/ips

**This endpoint allows you to add an IP address to an IP pool.** You can add the same IP address to multiple pools. It may take up to 60 seconds for your IP address to be added to a pool after your request is made. Before you can add an IP to a pool, you need to activate it in your SendGrid accou

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"
    }
  ]
}

GET

/v3/ips/pools/{pool_name}

**This endpoint allows you to get all of the IP addresses that are in a specific IP pool.**

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"
    }
  ]
}

PUT

/v3/ips/pools/{pool_name}

**This endpoint allows you to update the name of an IP pool.**

Request Payload

{
  "name": "new_pool_name"
}

Response Payload

{
  "name": "new_pool_name"
}

{
  "errors": [
    {
      "field": null,
      "message": "ip pool not found"
    }
  ]
}

DELETE

/v3/ips/pools/{pool_name}

**This endpoint allows you to delete an IP pool.**

Request Payload

Response Payload

{}

{
  "error": "Unable to locate specified IPs Pool"
}

DELETE

/v3/ips/pools/{pool_name}/ips/{ip}

**This endpoint allows you to remove an IP address from an IP pool.**

Request Payload

Response Payload

{}

{
  "error": "Unable to locate specified IPs Pool"
}

IP Addresses(5 operations)

POST

/v3/ips

**This endpoint is for adding a(n) IP Address(es) to your account.**

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"
    }
  ]
}

GET

/v3/ips

**This endpoint allows you to retrieve a list of all assigned and unassigned IPs.** Response includes warm up status, pools, assigned subusers, and reverse DNS info. The start_date field corresponds to when warmup started for that IP. A single IP address or a range of IP addresses may be dedicate

Query Parameter Name	Example
`ip`	`dolor`
`exclude_whitelabels`	`false`
`limit`	`-57587063`
`offset`	`85673466`
`subuser`	`voluptate sed sint`
`sort_by_direction`	`asc`

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
  }
]

GET

/v3/ips/remaining

**This endpoint gets amount of IP Addresses that can still be created during a given period and the price of those IPs.**

Request Payload

Response Payload

{
  "results": [
    {
      "remaining": 2,
      "period": "month",
      "price_per_ip": 20
    }
  ]
}

GET

/v3/ips/assigned

**This endpoint allows you to retrieve only assigned IP addresses.** A single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP is based on the aggregate performance of all the senders who use it.

Request Payload

Response Payload

[
  {
    "ip": "167.89.21.3",
    "pools": [
      "new_test5"
    ],
    "warmup": true,
    "start_date": 1409616000
  }
]

GET

/v3/ips/{ip_address}

**This endpoint allows you to see which IP pools a particular IP address has been added to.** The same IP address can be added to multiple IP pools. A single IP address or a range of IP addresses may be dedicated to an account in order to send email for multiple domains. The reputation of this IP

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)

GET

/v3/whitelabel/domains

**This endpoint allows you to retrieve a list of all domains you have authenticated.**

Query Parameter Name	Example
`limit`	`52685850`
`offset`	`-20194064`
`exclude_subusers`	`false`
`username`	`qui`
`domain`	`Excepteur tempor voluptate Duis`

Header Name	Example
`on-behalf-of`	`"voluptate laborum elit"`

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"
      }
    }
  }
]

POST

/v3/whitelabel/domains

**This endpoint allows you to authenticate a domain.** If you are authenticating a domain for a subuser, you have two options: 1. Use the "username" parameter. This allows you to authenticate a domain on behalf of your subuser. This means the subuser is able to see and modify the authenticated dom

Header Name	Example
`on-behalf-of`	`"occaecat et officia deserunt"`

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"
    }
  }
}

GET

/v3/whitelabel/domains/{domain_id}

**This endpoint allows you to retrieve a specific authenticated domain.**

Header Name	Example
`on-behalf-of`	`"aute deserunt ex occaecat"`

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"
    }
  }
}

PATCH

/v3/whitelabel/domains/{domain_id}

**This endpoint allows you to update the settings for an authenticated domain.**

Header Name	Example
`on-behalf-of`	`"in ut"`

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"
      }
    }
  }
]

DELETE

/v3/whitelabel/domains/{domain_id}

**This endpoint allows you to delete an authenticated domain.**

Header Name	Example
`on-behalf-of`	`"Duis tempor reprehenderit sit ut"`

Request Payload

Response Payload

{}

GET

/v3/whitelabel/domains/default

**This endpoint allows you to retrieve the default authentication for a domain.** When creating or updating a domain authentication, you can set the domain as a default. The default domain will be used to send all mail. If you have multiple authenticated domains, the authenticated domain matching

Query Parameter Name	Example
`domain`	`esse qui`

Header Name	Example
`on-behalf-of`	`"esse minim"`

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"
      }
    }
  }
]

POST

/v3/whitelabel/domains/{id}/ips

**This endpoint allows you to add an IP address to an authenticated domain.**

Header Name	Example
`on-behalf-of`	`"et deserunt ullamco exercitation ut"`

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
    }
  }
}

DELETE

/v3/whitelabel/domains/{id}/ips/{ip}

**This endpoint allows you to remove an IP address from that domain's authentication.**

Header Name	Example
`on-behalf-of`	`"proident"`

Request Payload

Response Payload

{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "mail@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}

POST

/v3/whitelabel/domains/{id}/validate

**This endpoint allows you to validate an authenticated domain. If it fails, it will return an error message describing why the domain could not be validated.**

Header Name	Example
`on-behalf-of`	`"nisi elit"`

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"
    }
  ]
}

GET

/v3/whitelabel/domains/subuser

**This endpoint allows you to retrieve all of the authenticated domains that have been assigned to a specific subuser.** Authenticated domains can be associated with (i.e. assigned to) subusers from a parent account. This functionality allows subusers to send mail using their parent's domain authe

Query Parameter Name	Example
`username`*	`id sunt eu nisi`

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
    }
  }
}

DELETE

/v3/whitelabel/domains/subuser

**This endpoint allows you to disassociate a specific authenticated domain from a subuser.** Authenticated domains can be associated with (i.e. assigned to) subusers from a parent account. This functionality allows subusers to send mail using their parent's domain authentication. To associate an a

Query Parameter Name	Example
`username`	`Duis Lorem Ut in`

Request Payload

Response Payload

{}

POST

/v3/whitelabel/domains/{domain_id}/subuser

**This endpoint allows you to associate a specific authenticated domain with a subuser.** Authenticated domains can be associated with (i.e. assigned to) subusers from a parent account. This functionality allows subusers to send mail using their parent's domain authentication. To associate an auth

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)

GET

/v3/verified_senders/domains

**This endpoint returns a list of domains known to implement DMARC and categorizes them by failure type — hard failure or soft failure**. Domains listed as hard failures will not deliver mail when used as a [Sender Identity](https://sendgrid.com/docs/for-developers/sending-email/sender-identity/)

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": "nulla quis"
    },
    {
      "message": "incididunt pariatur"
    },
    {
      "message": "anim pariatur enim dolore"
    }
  ]
}

GET

/v3/verified_senders/steps_completed

**This endpoint allows you to determine which of SendGrid’s verification processes have been completed for an account**. This endpoint returns boolean values, `true` and `false`, for [Domain Authentication](https://sendgrid.com/docs/for-developers/sending-email/sender-identity/#domain-authenticati

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": "quis sunt qui consectetur"
    },
    {
      "message": "proident magna sunt"
    },
    {
      "message": "mollit exercitation in voluptate"
    },
    {
      "message": "adipisicing voluptate sit enim"
    }
  ]
}

POST

/v3/verified_senders

**This endpoint allows you to create a new Sender Identify**. Upon successful submission of a `POST` request to this endpoint, an identity will be created, and a verification email will be sent to the address assigned to the `from_email` field. You must complete the verification process using the

Request Payload

{
  "nickname": "Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105"
}

Response Payload

{
  "id": 1234,
  "nickname": "Example Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St.",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105",
  "verified": true,
  "locked": false
}

{
  "errors": [
    {
      "error_id": "quis sunt Excepteur incididunt in",
      "field": "id",
      "message": "eiusmod dolore elit"
    },
    {
      "error_id": "occaecat sit officia",
      "field": "Ut ea proident",
      "message": "commodo tempor sit"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "tempor"
    },
    {
      "message": "consectetur veniam incididunt"
    },
    {
      "message": "occaecat reprehenderit minim"
    },
    {
      "message": "eiusmod dolore in"
    }
  ]
}

GET

/v3/verified_senders

**This endpoint allows you to retrieve all the Sender Identities associated with an account.** This endpoint will return both verified and unverified senders. You can limit the number of results returned using the `limit`, `lastSeenID`, and `id` query string parameters. * `limit` allows you to s

Query Parameter Name	Example
`limit`	`44202768.68391499`
`lastSeenID`	`-46578567.31413586`
`id`	`-20719442`

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": "Ut non in officia"
    },
    {
      "message": "nostrud veniam proident Lorem consectetur"
    },
    {
      "message": "Duis in"
    },
    {
      "message": "labore ex"
    }
  ]
}

GET

/v3/verified_senders/verify/{token}

**This endpoint allows you to verify a sender requests.** The token is generated by SendGrid and included in a verification email delivered to the address that's pending verification.

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "officia eu dolor aute",
      "message": "exercitation do"
    },
    {
      "error_id": "minim ea officia aute nisi",
      "message": "nostrud exercitation"
    },
    {
      "error_id": "mollit deserunt eiusmod",
      "message": "officia"
    }
  ]
}

{
  "errors": [
    {
      "message": "sunt deserunt elit"
    },
    {
      "message": "Lorem aliqua"
    },
    {
      "message": "ut pariatur non"
    },
    {
      "message": "cupidatat qui in"
    }
  ]
}

PATCH

/v3/verified_senders/{id}

**This endpoint allows you to update an existing Sender Identity**. Pass the `id` assigned to a Sender Identity to this endpoint as a path parameter. Include any fields you wish to update in the request body in JSON format. You can retrieve the IDs associated with Sender Identities by passing a `

Request Payload

{
  "nickname": "Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105"
}

Response Payload

{
  "id": 1234,
  "nickname": "Example Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St.",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105",
  "verified": true,
  "locked": false
}

{
  "errors": [
    {
      "error_id": "ut dolor ad",
      "field": "labore magna anim Ut",
      "message": "ipsum velit voluptate sunt enim"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "laborum ipsum nisi anim aliquip",
      "message": "qui sunt Ut"
    },
    {
      "error_id": "enim",
      "message": "ex"
    },
    {
      "error_id": "sit exercitation aliquip enim",
      "message": "tempor ullamco"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "reprehenderit veniam labore",
      "message": "cillum"
    },
    {
      "error_id": "qui",
      "message": "sint irure"
    },
    {
      "error_id": "proident et Excepteur laborum",
      "message": "reprehenderit minim Duis mollit consectetur"
    },
    {
      "error_id": "tempor ea esse minim",
      "message": "commodo"
    }
  ]
}

{
  "errors": [
    {
      "message": "ut commodo non aute quis"
    },
    {
      "message": "reprehenderit dolor"
    },
    {
      "message": "laborum ad elit enim cillum"
    },
    {
      "message": "mollit consectetur ad"
    },
    {
      "message": "Duis mollit irure proident"
    }
  ]
}

DELETE

/v3/verified_senders/{id}

**This endpoint allows you to delete a Sender Identity**. Pass the `id` assigned to a Sender Identity to this endpoint to delete the Sender Identity from your account. You can retrieve the IDs associated with Sender Identities using the "Get All Verified Senders" endpoint.

Request Payload

Response Payload

{}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "culpa dolore consectetur",
      "message": "dolore eiusmod et"
    },
    {
      "error_id": "ea deserunt",
      "message": "dolor esse"
    },
    {
      "error_id": "voluptate aliquip Excepteur",
      "message": "ullamco irure"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "consequat",
      "message": "quis"
    },
    {
      "error_id": "cupidatat consequat",
      "message": "tempor cillum deserunt commodo Excepteur"
    }
  ]
}

{
  "errors": [
    {
      "message": "laboris qui adipisicing"
    },
    {
      "message": "consectetur ut amet cupidatat"
    },
    {
      "message": "occaecat in ad"
    },
    {
      "message": "veniam anim sed magna ut"
    },
    {
      "message": "dolor aute nostrud Duis"
    }
  ]
}

POST

/v3/verified_senders/resend/{id}

**This endpoint allows you to resend a verification email to a specified Sender Identity**. Passing the `id` assigned to a Sender Identity to this endpoint will resend a verification email to the `from_address` associated with the Sender Identity. This can be useful if someone loses their verifica

Request Payload

Response Payload

{}

{
  "errors": [
    {
      "error_id": "Excepteur amet ex non aliqua",
      "message": "velit"
    },
    {
      "error_id": "culpa cupidatat",
      "message": "Excepteur cillum"
    },
    {
      "error_id": "amet aliquip incididunt",
      "message": "culpa minim deserunt"
    },
    {
      "error_id": "sit dolor tempor",
      "message": "Lorem"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "exercitation quis officia consequat consectetur",
      "message": "et quis laborum mollit nostrud"
    },
    {
      "error_id": "et",
      "message": "commodo quis Excepteur dolore consectetur"
    },
    {
      "error_id": "cupidatat commodo sed nostrud incididunt",
      "message": "ullamco"
    },
    {
      "error_id": "enim ut ullamco esse id",
      "message": "minim aliquip magna elit"
    },
    {
      "error_id": "occaecat",
      "message": "commodo in qui enim"
    }
  ]
}

{
  "errors": [
    {
      "message": "Excepteur ut aliquip velit cillum"
    }
  ]
}

Designs API(9 operations)

POST

/v3/designs/{id}

**This endpoint allows you to duplicate one of your existing designs**. Modifying an existing design is often the easiest way to create something new. You are not required to pass any data in the body of a request to this endpoint. If you choose to leave the `name` field blank, your duplicate wil

Request Payload

{
  "name": "Ahoy, Cake or Pie Cafe!",
  "editor": "design"
}

Response Payload

{
  "id": "15b85720-ce48-48ef-8a07-672b0d3455da",
  "name": "Ahoy, Cake or Pie Cafe!",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: arial,helvetica,sans-serif;\n      font-size: 14px;\n    }\n    body {\n      color: #000000;\n    }\n    body a {\n      color: #1188E6;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    ul ul ul ul  {\n      list-style-type: disc !important;\n    }\n    ol ol {\n      list-style-type: lower-roman !important;\n    }\n    ol ol ol {\n      list-style-type: lower-latin !important;\n    }\n    ol ol ol ol {\n      list-style-type: decimal !important;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start--><!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p></p>\n      </td>\n    </tr>\n  </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n    <tbody>\n      <tr>\n        <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "plain_content": "Ahoy, World!\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
  "generate_plain_content": false,
  "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/79bb769ae6464960a307040120ad6f9921896fe9825e845ad1f24d12285ea068.png",
  "subject": "Getting Started",
  "created_at": "2021-04-30T19:00:16Z",
  "updated_at": "2021-04-30T19:00:16Z",
  "editor": "design",
  "categories": []
}

{
  "error_id": "amet",
  "field": "consequat aliquip in dolore sint",
  "message": "mollit consectetur adipisicing"
}

{
  "errors": [
    {
      "error_id": "deserunt",
      "field": "consequat non",
      "message": "Ut mollit non labore in"
    }
  ]
}

GET

/v3/designs/{id}

**This endpoint allows you to retrieve a single design**. A GET request to `/designs/{id}` will retrieve details about a specific design in your Design Library. This endpoint is valuable when retrieving information stored in a field that you wish to update using a PATCH request.

Request Payload

Response Payload

{
  "id": "15b85720-ce48-48ef-8a07-672b0d3455da",
  "name": "Ahoy, World!",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: arial,helvetica,sans-serif;\n      font-size: 14px;\n    }\n    body {\n      color: #000000;\n    }\n    body a {\n      color: #1188E6;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    ul ul ul ul  {\n      list-style-type: disc !important;\n    }\n    ol ol {\n      list-style-type: lower-roman !important;\n    }\n    ol ol ol {\n      list-style-type: lower-latin !important;\n    }\n    ol ol ol ol {\n      list-style-type: decimal !important;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start--><!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p></p>\n      </td>\n    </tr>\n  </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n    <tbody>\n      <tr>\n        <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "plain_content": "Ahoy, World!\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
  "generate_plain_content": false,
  "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/5yysvuyi1lpdnxo1ym8ax8yd7ompve3azjtme76gamdace01vko3eyn1kzso1lhy.png",
  "subject": "Getting Started",
  "created_at": "2021-04-30T18:51:20Z",
  "updated_at": "2021-04-30T18:51:20Z",
  "editor": "design",
  "categories": []
}

{
  "errors": [
    {
      "error_id": "eu deserunt nisi Lorem",
      "field": "ex sed exercitation",
      "message": "in"
    },
    {
      "error_id": "cillum amet dolore laborum",
      "field": "nostrud Excepteur",
      "message": "non Ut tempor sunt"
    },
    {
      "error_id": "ut id velit irure",
      "field": "pariatur elit est dolor in",
      "message": "commodo sed consectetur proident"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ea consequat",
      "field": "tempor veniam id",
      "message": "aliqua irure"
    }
  ]
}

PATCH

/v3/designs/{id}

**This endpoint allows you to edit a design**. The Design API supports PATCH requests, which allow you to make partial updates to a single design. Passing data to a specific field will update only the data stored in that field; all other fields will be unaltered. For example, updating a design's

Request Payload

{
  "name": "Ahoy, World!",
  "subject": "Getting Started",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: arial,helvetica,sans-serif;\n      font-size: 14px;\n    }\n    body {\n      color: #000000;\n    }\n    body a {\n      color: #1188E6;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    ul ul ul ul  {\n      list-style-type: disc !important;\n    }\n    ol ol {\n      list-style-type: lower-roman !important;\n    }\n    ol ol ol {\n      list-style-type: lower-latin !important;\n    }\n    ol ol ol ol {\n      list-style-type: decimal !important;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start--><!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p></p>\n      </td>\n    </tr>\n  </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n    <tbody>\n      <tr>\n        <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "generate_plain_content": false,
  "categories": [
    "promotions"
  ]
}

Response Payload

{
  "id": "15b85720-ce48-48ef-8a07-672b0d3455da",
  "name": "Ahoy, World!",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: arial,helvetica,sans-serif;\n      font-size: 14px;\n    }\n    body {\n      color: #000000;\n    }\n    body a {\n      color: #1188E6;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    ul ul ul ul  {\n      list-style-type: disc !important;\n    }\n    ol ol {\n      list-style-type: lower-roman !important;\n    }\n    ol ol ol {\n      list-style-type: lower-latin !important;\n    }\n    ol ol ol ol {\n      list-style-type: decimal !important;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start--><!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p></p>\n      </td>\n    </tr>\n  </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n    <tbody>\n      <tr>\n        <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "generate_plain_content": false,
  "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/5yysvuyi1lpdnxo1ym8ax8yd7ompve3azjtme76gamdace01vko3eyn1kzso1lhy.png",
  "subject": "Getting Started",
  "created_at": "2021-04-30T18:51:20Z",
  "updated_at": "2021-04-30T18:51:20Z",
  "editor": "design",
  "categories": [
    "promotions"
  ]
}

{
  "errors": [
    {
      "error_id": "do culpa cillum nulla",
      "field": "id quis Ut aliquip amet",
      "message": "commodo amet"
    },
    {
      "error_id": "in",
      "field": "dolore cupidatat enim aliqua ex",
      "message": "ea commodo pariatur"
    },
    {
      "error_id": "ex ipsum laboris culpa mollit",
      "field": "do veniam",
      "message": "Excepteur pariatur nostrud nisi"
    },
    {
      "error_id": "laborum cillum consectetur enim",
      "field": "magna adipisicing sit",
      "message": "in ipsum magna irure"
    },
    {
      "error_id": "enim aliquip ipsum",
      "field": "Ut nisi",
      "message": "ullamco ut reprehenderit"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "cillum",
      "field": "Lorem",
      "message": "aute labore"
    },
    {
      "error_id": "veniam occaecat",
      "field": "eiusmod culpa enim",
      "message": "eu enim"
    },
    {
      "error_id": "non labore in officia et",
      "field": "in anim",
      "message": "sed eiusmod aute"
    }
  ]
}

DELETE

/v3/designs/{id}

**This endpoint allows you to delete a single design**. Be sure to check the ID of the design you intend to delete before making this request; deleting a design is a permanent action.

Request Payload

Response Payload

{}

{
  "errors": [
    {
      "error_id": "do",
      "field": "mollit ullamco ea ex enim",
      "message": "labore dolor quis adipisicing anim"
    },
    {
      "error_id": "eiusmod sit ut id ipsum",
      "field": "aute",
      "message": "aute qui reprehenderit"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "tempor laborum nisi Duis sint",
      "field": "dolore reprehenderit veniam eiusmod velit",
      "message": "consequat sunt"
    },
    {
      "error_id": "aute sunt sit nostrud aliquip",
      "field": "anim laborum fugiat",
      "message": "pariatur ea dolor deserunt"
    },
    {
      "error_id": "eu sit labore",
      "field": "ipsum minim do anim",
      "message": "occaecat aliqua fugiat sunt in"
    },
    {
      "error_id": "esse Duis in eu",
      "field": "qui in sed",
      "message": "eu in Lorem Ut"
    },
    {
      "error_id": "non",
      "field": "cupidatat minim voluptate et nisi",
      "message": "enim veniam"
    }
  ]
}

POST

/v3/designs

**This endpoint allows you to create a new design**. You can add a new design by passing data, including a string of HTML email content, to `/designs`. When creating designs from scratch, be aware of the styling constraints inherent to many email clients. For a list of best practices, see our guid

Request Payload

{
  "name": "Ahoy, World!",
  "editor": "design",
  "subject": "Getting Started",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: arial,helvetica,sans-serif;\n      font-size: 14px;\n    }\n    body {\n      color: #000000;\n    }\n    body a {\n      color: #1188E6;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    ul ul ul ul  {\n      list-style-type: disc !important;\n    }\n    ol ol {\n      list-style-type: lower-roman !important;\n    }\n    ol ol ol {\n      list-style-type: lower-latin !important;\n    }\n    ol ol ol ol {\n      list-style-type: decimal !important;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start--><!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p></p>\n      </td>\n    </tr>\n  </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n    <tbody>\n      <tr>\n        <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "plain_content": "Ahoy, World!\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )"
}

Response Payload

{
  "id": "3247eaea-c912-42a3-b0bc-60bdaf210396",
  "name": "Ahoy, World!",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: arial,helvetica,sans-serif;\n      font-size: 14px;\n    }\n    body {\n      color: #000000;\n    }\n    body a {\n      color: #1188E6;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    ul ul ul ul  {\n      list-style-type: disc !important;\n    }\n    ol ol {\n      list-style-type: lower-roman !important;\n    }\n    ol ol ol {\n      list-style-type: lower-latin !important;\n    }\n    ol ol ol ol {\n      list-style-type: decimal !important;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start--><!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#1188E6\" data-body-style=\"font-size:14px; font-family:arial,helvetica,sans-serif; color:#000000; background-color:#FFFFFF;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#FFFFFF\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#FFFFFF\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#000000; text-align:left;\" bgcolor=\"#FFFFFF\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p></p>\n      </td>\n    </tr>\n  </table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"41f90842-501c-4f08-96c9-17c0f74cb841\" data-mc-module-version=\"2019-10-22\">\n    <tbody>\n      <tr>\n        <td style=\"padding:18px 0px 18px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"\" role=\"module-content\"><div><div style=\"font-family: inherit; text-align: inherit\">Ahoy, World!</div><div></div></div></td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#444444; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:Center;\" data-muid=\"4e838cf3-9892-4a6d-94d6-170e474d21e5\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" target=\"_blank\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "plain_content": "Ahoy, World!\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
  "generate_plain_content": false,
  "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/kjlrmded0qnrscv8zqr39npoimrpdwgiax59q8iq6ovj7yoks2fzxoxpfjpwph6o.png",
  "subject": "Getting Started",
  "created_at": "2021-04-30T18:51:20Z",
  "updated_at": "2021-04-30T18:51:20Z",
  "editor": "design",
  "categories": []
}

{
  "errors": [
    {
      "error_id": "Excepteur Ut eiusmod",
      "field": "ad",
      "message": "Excepteur irure non et sint"
    },
    {
      "error_id": "veniam quis",
      "field": "ut Lorem consectetur deserunt",
      "message": "ex dolore incididunt consequat"
    }
  ]
}

GET

/v3/designs

**This endpoint allows you to retrieve a list of designs already stored in your Design Library**. A GET request to `/designs` will return a list of your existing designs. This endpoint will not return the pre-built Twilio SendGrid designs. Pre-built designs can be retrieved using the `/designs/pre

Query Parameter Name	Example
`page_size`	`68999476`
`page_token`	`Excepteur ut incididunt`
`summary`	`true`

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
  }
}

POST

/v3/designs/pre-builts/{id}

**This endpoint allows you to duplicate one of the pre-built Twilio SendGrid designs**. Like duplicating one of your existing designs, you are not required to pass any data in the body of a request to this endpoint. If you choose to leave the `name` field blank, your duplicate will be assigned the

Request Payload

{
  "name": "Ahoy, Cake or Pie Cafe!",
  "editor": "design"
}

Response Payload

{
  "id": "abe0877f-a224-21e2-b62e-c789d326cda5",
  "name": "Ahoy, Pre-built Design!",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: courier, monospace;\n      font-size: 16px;\n    }\n    body {\n      color: #FFFFFF;\n    }\n    body a {\n      color: #fe5d61;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start-->\n\n     <!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#fe5d61\" data-body-style=\"font-size:16px; font-family:courier, monospace; color:#FFFFFF; background-color:#f2f4fb;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#f2f4fb\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#f2f4fb\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#FFFFFF; text-align:left;\" bgcolor=\"#f2f4fb\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p>You've found the secret!</p>\n      </td>\n    </tr>\n  </table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"98ndJyAY9BSGjoVqrr6FYx\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:30px 0px 30px 0px;\" valign=\"top\" align=\"left\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:40% !important; width:40%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/9d9c1f3d8009c42bbe60c0355f1ed23e86c3f5619173e83a9328b9214e42e1c1d5e009ed5cc4c8f3efedfc33d46bba2f4577b143607025a29add6e89ab4662ad.png\" alt=\"Off Grid Adventures\" width=\"240\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"3Ypdby9Xfsf2rN27zTDEfN\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/e324b295c47223f1a936198fbd4e5d4b239ff86c6d6c89d4d0eb8d7c61028921abfc4901ba607f6dcb7acc7067bb0c6df4313726b14b8274e0b2c98cdf8b58d2.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"7pyDCmyDaGcm5WsBBSaEgv\" data-mc-module-version=\"2019-10-22\">\n      <tbody><tr>\n        <td style=\"background-color:#FE5D61; padding:50px 0px 30px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#FE5D61\"><div><div style=\"font-family: inherit; text-align: center\"><span style=\"font-size: 24px\">Welcome to the family!</span></div><div></div></div></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"nSVYnVzPLnGZ4wUdynLiKo\" data-mc-module-version=\"2019-10-22\">\n      <tbody><tr>\n        <td style=\"background-color:#fe5d61; padding:30px 50px 30px 50px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#fe5d61\"><div><div style=\"font-family: inherit; text-align: center\">You've found a community of travelers that are just like you.</div>\n<div style=\"font-family: inherit; text-align: center\">&nbsp;</div>\n<div style=\"font-family: inherit; text-align: center\">We don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.</div>\n<div style=\"font-family: inherit; text-align: center\">&nbsp;</div>\n<div style=\"font-family: inherit; text-align: center\">Ready for your next authentic travel experience?</div><div></div></div></td>\n      </tr>\n    </tbody></table><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"module\" data-role=\"module-button\" data-type=\"button\" role=\"module\" style=\"table-layout:fixed\" width=\"100%\" data-muid=\"4ywPd9vJ6WFyV1Si75h9vh\"><tbody><tr><td align=\"center\" bgcolor=\"#fe5d61\" class=\"outer-td\" style=\"padding:10px 10px 60px 10px; background-color:#fe5d61;\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"button-css__deep-table___2OZyb wrapper-mobile\" style=\"text-align:center\"><tbody><tr><td align=\"center\" bgcolor=\"#ffffff\" class=\"inner-td\" style=\"border-radius:6px; font-size:16px; text-align:center; background-color:inherit;\"><a style=\"background-color:#ffffff; border:1px solid #ffffff; border-color:#ffffff; border-radius:3px; border-width:1px; color:#fe5d61; display:inline-block; font-size:16px; font-weight:700; letter-spacing:1px; line-height:40px; padding:12px 20px 12px 20px; text-align:center; text-decoration:none; border-style:solid;\" href=\"\" target=\"_blank\">Browse Gallery</a></td></tr></tbody></table></td></tr></tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"6jxKSRk9dKQ1Tvi1wtnu8q\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/0accac77b1e34c614730ab732317a493478835c96bd549fb2df7a921ec1177fdb30d6d33e1d0a33d8c6c579344890ae408ce13aaed0e478f1fd6d2219d308365.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"iYySZ4rAB78PLoW7vU13Bb\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"divider\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"mVyZz43HETwfwb72TGh4iy\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 0px 0px;\" role=\"module-content\" height=\"100%\" valign=\"top\" bgcolor=\"\">\n          <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" align=\"center\" width=\"100%\" height=\"3px\" style=\"line-height:3px; font-size:3px;\">\n            <tbody><tr>\n              <td style=\"padding:0px 0px 3px 0px;\" bgcolor=\"#ffffff\"></td>\n            </tr>\n          </tbody></table>\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"sfek66tVLi5d2iy5jmSawj\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"social\" align=\"center\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"87277ffe-54ed-4792-94f3-0a973b71c268\">\n    <tbody>\n      <tr>\n        <td valign=\"top\" style=\"padding:0px 0px 0px 0px; font-size:6px; line-height:10px;\" align=\"center\">\n          <table align=\"center\" style=\"-webkit-margin-start:auto;-webkit-margin-end:auto;\">\n            <tbody><tr align=\"center\"><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.facebook.com/sendgrid/\" target=\"_blank\" alt=\"Facebook\" title=\"Facebook\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Facebook\" title=\"Facebook\" src=\"https://mc.sendgrid.com/assets/social/white/facebook.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor\" target=\"_blank\" alt=\"Twitter\" title=\"Twitter\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Twitter\" title=\"Twitter\" src=\"https://mc.sendgrid.com/assets/social/white/twitter.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.instagram.com/sendgrid/?hl=en\" target=\"_blank\" alt=\"Instagram\" title=\"Instagram\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Instagram\" title=\"Instagram\" src=\"https://mc.sendgrid.com/assets/social/white/instagram.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.pinterest.com/sendgrid/\" target=\"_blank\" alt=\"Pinterest\" title=\"Pinterest\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Pinterest\" title=\"Pinterest\" src=\"https://mc.sendgrid.com/assets/social/white/pinterest.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td></tr></tbody>\n          </table>\n        </td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module unsubscribe-css__unsubscribe___2CDlR\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#FFFFFF; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:center;\" data-muid=\"txBUUpmixSjuZ5Ad69p1sX\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "plain_content": "You've found the secret!\n\nWelcome to the family!\n\nYou've found a community of travelers that are just like you.\n\nWe don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.\n\nReady for your next authentic travel experience?\n\nBrowse Gallery\n\n( https://www.facebook.com/sendgrid/ ) ( https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor ) ( https://www.instagram.com/sendgrid/?hl=en ) ( https://www.pinterest.com/sendgrid/ )\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
  "generate_plain_content": true,
  "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/a85b4b202ff28094828f11ff472360caecf67ead2d186b69b45c904b9251aa0b.png",
  "subject": "Welcome to the family!",
  "created_at": "2021-04-30T19:15:28Z",
  "updated_at": "2021-04-30T19:15:28Z",
  "editor": "design",
  "categories": []
}

{
  "errors": [
    {
      "error_id": "pariatur deserunt",
      "field": "in",
      "message": "cupidatat quis ex Lorem voluptate"
    },
    {
      "error_id": "et deserunt eu",
      "field": "do culpa sit",
      "message": "dolore est qui reprehenderit"
    },
    {
      "error_id": "dolore aute non",
      "field": "velit exercitation",
      "message": "quis velit do sed"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "irure laborum tempor pariatur deserunt",
      "field": "esse",
      "message": "culpa"
    },
    {
      "error_id": "qui occaecat enim consequat",
      "field": "pariatur mollit dolor incididunt",
      "message": "do adipisicing"
    },
    {
      "error_id": "irure ut Ut",
      "field": "exercitation dolor",
      "message": "tempor"
    }
  ]
}

GET

/v3/designs/pre-builts/{id}

**This endpoint allows you to retrieve a single pre-built design**. A GET request to `/designs/pre-builts/{id}` will retrieve details about a specific pre-built design. This endpoint is valuable when retrieving details about a pre-built design that you wish to duplicate and modify.

Request Payload

Response Payload

{
  "id": "6ad69134-7165-48cb-964a-6c3cf03e8af8",
  "name": "Off Grid Adventures",
  "html_content": "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Strict//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd\">\n<html data-editor-version=\"2\" class=\"sg-campaigns\" xmlns=\"http://www.w3.org/1999/xhtml\">\n    <head>\n      <meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n      <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1\">\n      <!--[if !mso]><!-->\n      <meta http-equiv=\"X-UA-Compatible\" content=\"IE=Edge\">\n      <!--<![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n      <xml>\n        <o:OfficeDocumentSettings>\n          <o:AllowPNG/>\n          <o:PixelsPerInch>96</o:PixelsPerInch>\n        </o:OfficeDocumentSettings>\n      </xml>\n      <![endif]-->\n      <!--[if (gte mso 9)|(IE)]>\n  <style type=\"text/css\">\n    body {width: 600px;margin: 0 auto;}\n    table {border-collapse: collapse;}\n    table, td {mso-table-lspace: 0pt;mso-table-rspace: 0pt;}\n    img {-ms-interpolation-mode: bicubic;}\n  </style>\n<![endif]-->\n      <style type=\"text/css\">\n    body, p, div {\n      font-family: courier, monospace;\n      font-size: 16px;\n    }\n    body {\n      color: #FFFFFF;\n    }\n    body a {\n      color: #fe5d61;\n      text-decoration: none;\n    }\n    p { margin: 0; padding: 0; }\n    table.wrapper {\n      width:100% !important;\n      table-layout: fixed;\n      -webkit-font-smoothing: antialiased;\n      -webkit-text-size-adjust: 100%;\n      -moz-text-size-adjust: 100%;\n      -ms-text-size-adjust: 100%;\n    }\n    img.max-width {\n      max-width: 100% !important;\n    }\n    .column.of-2 {\n      width: 50%;\n    }\n    .column.of-3 {\n      width: 33.333%;\n    }\n    .column.of-4 {\n      width: 25%;\n    }\n    @media screen and (max-width:480px) {\n      .preheader .rightColumnContent,\n      .footer .rightColumnContent {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent div,\n      .preheader .rightColumnContent span,\n      .footer .rightColumnContent div,\n      .footer .rightColumnContent span {\n        text-align: left !important;\n      }\n      .preheader .rightColumnContent,\n      .preheader .leftColumnContent {\n        font-size: 80% !important;\n        padding: 5px 0;\n      }\n      table.wrapper-mobile {\n        width: 100% !important;\n        table-layout: fixed;\n      }\n      img.max-width {\n        height: auto !important;\n        max-width: 100% !important;\n      }\n      a.bulletproof-button {\n        display: block !important;\n        width: auto !important;\n        font-size: 80%;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n      }\n      .columns {\n        width: 100% !important;\n      }\n      .column {\n        display: block !important;\n        width: 100% !important;\n        padding-left: 0 !important;\n        padding-right: 0 !important;\n        margin-left: 0 !important;\n        margin-right: 0 !important;\n      }\n      .social-icon-column {\n        display: inline-block !important;\n      }\n    }\n  </style>\n      <!--user entered Head Start-->\n\n     <!--End Head user entered-->\n    </head>\n    <body>\n      <center class=\"wrapper\" data-link-color=\"#fe5d61\" data-body-style=\"font-size:16px; font-family:courier, monospace; color:#FFFFFF; background-color:#f2f4fb;\">\n        <div class=\"webkit\">\n          <table cellpadding=\"0\" cellspacing=\"0\" border=\"0\" width=\"100%\" class=\"wrapper\" bgcolor=\"#f2f4fb\">\n            <tr>\n              <td valign=\"top\" bgcolor=\"#f2f4fb\" width=\"100%\">\n                <table width=\"100%\" role=\"content-container\" class=\"outer\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                  <tr>\n                    <td width=\"100%\">\n                      <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\">\n                        <tr>\n                          <td>\n                            <!--[if mso]>\n    <center>\n    <table><tr><td width=\"600\">\n  <![endif]-->\n                                    <table width=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" style=\"width:100%; max-width:600px;\" align=\"center\">\n                                      <tr>\n                                        <td role=\"modules-container\" style=\"padding:0px 0px 0px 0px; color:#FFFFFF; text-align:left;\" bgcolor=\"#f2f4fb\" width=\"100%\" align=\"left\"><table class=\"module preheader preheader-hide\" role=\"module\" data-type=\"preheader\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"display: none !important; mso-hide: all; visibility: hidden; opacity: 0; color: transparent; height: 0; width: 0;\">\n    <tr>\n      <td role=\"module-content\">\n        <p>You've found the secret!</p>\n      </td>\n    </tr>\n  </table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"98ndJyAY9BSGjoVqrr6FYx\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:30px 0px 30px 0px;\" valign=\"top\" align=\"left\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:40% !important; width:40%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/9d9c1f3d8009c42bbe60c0355f1ed23e86c3f5619173e83a9328b9214e42e1c1d5e009ed5cc4c8f3efedfc33d46bba2f4577b143607025a29add6e89ab4662ad.png\" alt=\"Off Grid Adventures\" width=\"240\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"3Ypdby9Xfsf2rN27zTDEfN\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/e324b295c47223f1a936198fbd4e5d4b239ff86c6d6c89d4d0eb8d7c61028921abfc4901ba607f6dcb7acc7067bb0c6df4313726b14b8274e0b2c98cdf8b58d2.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"7pyDCmyDaGcm5WsBBSaEgv\" data-mc-module-version=\"2019-10-22\">\n      <tbody><tr>\n        <td style=\"background-color:#FE5D61; padding:50px 0px 30px 0px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#FE5D61\"><div><div style=\"font-family: inherit; text-align: center\"><span style=\"font-size: 24px\">Welcome to the family!</span></div><div></div></div></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"text\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"nSVYnVzPLnGZ4wUdynLiKo\" data-mc-module-version=\"2019-10-22\">\n      <tbody><tr>\n        <td style=\"background-color:#fe5d61; padding:30px 50px 30px 50px; line-height:22px; text-align:inherit;\" height=\"100%\" valign=\"top\" bgcolor=\"#fe5d61\"><div><div style=\"font-family: inherit; text-align: center\">You've found a community of travelers that are just like you.</div>\n<div style=\"font-family: inherit; text-align: center\">&nbsp;</div>\n<div style=\"font-family: inherit; text-align: center\">We don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.</div>\n<div style=\"font-family: inherit; text-align: center\">&nbsp;</div>\n<div style=\"font-family: inherit; text-align: center\">Ready for your next authentic travel experience?</div><div></div></div></td>\n      </tr>\n    </tbody></table><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"module\" data-role=\"module-button\" data-type=\"button\" role=\"module\" style=\"table-layout:fixed\" width=\"100%\" data-muid=\"4ywPd9vJ6WFyV1Si75h9vh\"><tbody><tr><td align=\"center\" bgcolor=\"#fe5d61\" class=\"outer-td\" style=\"padding:10px 10px 60px 10px; background-color:#fe5d61;\"><table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" class=\"button-css__deep-table___2OZyb wrapper-mobile\" style=\"text-align:center\"><tbody><tr><td align=\"center\" bgcolor=\"#ffffff\" class=\"inner-td\" style=\"border-radius:6px; font-size:16px; text-align:center; background-color:inherit;\"><a style=\"background-color:#ffffff; border:1px solid #ffffff; border-color:#ffffff; border-radius:3px; border-width:1px; color:#fe5d61; display:inline-block; font-size:16px; font-weight:700; letter-spacing:1px; line-height:40px; padding:12px 20px 12px 20px; text-align:center; text-decoration:none; border-style:solid;\" href=\"\" target=\"_blank\">Browse Gallery</a></td></tr></tbody></table></td></tr></tbody></table><table class=\"wrapper\" role=\"module\" data-type=\"image\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"6jxKSRk9dKQ1Tvi1wtnu8q\">\n      <tbody><tr>\n        <td style=\"font-size:6px; line-height:10px; padding:0px 0px 0px 0px;\" valign=\"top\" align=\"center\"><img class=\"max-width\" border=\"0\" style=\"display:block; color:#000000; text-decoration:none; font-family:Helvetica, arial, sans-serif; font-size:16px; max-width:100% !important; width:100%; height:auto !important;\" src=\"https://mc.sendgrid.com/assets/uploads/0accac77b1e34c614730ab732317a493478835c96bd549fb2df7a921ec1177fdb30d6d33e1d0a33d8c6c579344890ae408ce13aaed0e478f1fd6d2219d308365.png\" alt=\"\" width=\"600\" data-responsive=\"true\" data-proportionally-constrained=\"false\"></td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"iYySZ4rAB78PLoW7vU13Bb\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"divider\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"mVyZz43HETwfwb72TGh4iy\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 0px 0px;\" role=\"module-content\" height=\"100%\" valign=\"top\" bgcolor=\"\">\n          <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" align=\"center\" width=\"100%\" height=\"3px\" style=\"line-height:3px; font-size:3px;\">\n            <tbody><tr>\n              <td style=\"padding:0px 0px 3px 0px;\" bgcolor=\"#ffffff\"></td>\n            </tr>\n          </tbody></table>\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"spacer\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"sfek66tVLi5d2iy5jmSawj\">\n      <tbody><tr>\n        <td style=\"padding:0px 0px 30px 0px;\" role=\"module-content\" bgcolor=\"\">\n        </td>\n      </tr>\n    </tbody></table><table class=\"module\" role=\"module\" data-type=\"social\" align=\"center\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" style=\"table-layout: fixed;\" data-muid=\"87277ffe-54ed-4792-94f3-0a973b71c268\">\n    <tbody>\n      <tr>\n        <td valign=\"top\" style=\"padding:0px 0px 0px 0px; font-size:6px; line-height:10px;\" align=\"center\">\n          <table align=\"center\" style=\"-webkit-margin-start:auto;-webkit-margin-end:auto;\">\n            <tbody><tr align=\"center\"><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.facebook.com/sendgrid/\" target=\"_blank\" alt=\"Facebook\" title=\"Facebook\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Facebook\" title=\"Facebook\" src=\"https://mc.sendgrid.com/assets/social/white/facebook.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor\" target=\"_blank\" alt=\"Twitter\" title=\"Twitter\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Twitter\" title=\"Twitter\" src=\"https://mc.sendgrid.com/assets/social/white/twitter.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.instagram.com/sendgrid/?hl=en\" target=\"_blank\" alt=\"Instagram\" title=\"Instagram\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Instagram\" title=\"Instagram\" src=\"https://mc.sendgrid.com/assets/social/white/instagram.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td><td style=\"padding: 0px 5px;\" class=\"social-icon-column\">\n      <a role=\"social-icon-link\" href=\"https://www.pinterest.com/sendgrid/\" target=\"_blank\" alt=\"Pinterest\" title=\"Pinterest\" style=\"display:inline-block; background-color:#FE5D61; height:30px; width:30px; border-radius:2px; -webkit-border-radius:2px; -moz-border-radius:2px;\">\n        <img role=\"social-icon\" alt=\"Pinterest\" title=\"Pinterest\" src=\"https://mc.sendgrid.com/assets/social/white/pinterest.png\" style=\"height:30px; width:30px;\" height=\"30\" width=\"30\">\n      </a>\n    </td></tr></tbody>\n          </table>\n        </td>\n      </tr>\n    </tbody>\n  </table><div data-role=\"module-unsubscribe\" class=\"module unsubscribe-css__unsubscribe___2CDlR\" role=\"module\" data-type=\"unsubscribe\" style=\"color:#FFFFFF; font-size:12px; line-height:20px; padding:16px 16px 16px 16px; text-align:center;\" data-muid=\"txBUUpmixSjuZ5Ad69p1sX\"><div class=\"Unsubscribe--addressLine\"><p class=\"Unsubscribe--senderName\" style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\">{{Sender_Name}}</p><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><span class=\"Unsubscribe--senderAddress\">{{Sender_Address}}</span>, <span class=\"Unsubscribe--senderCity\">{{Sender_City}}</span>, <span class=\"Unsubscribe--senderState\">{{Sender_State}}</span> <span class=\"Unsubscribe--senderZip\">{{Sender_Zip}}</span></p></div><p style=\"font-family:arial,helvetica,sans-serif; font-size:12px; line-height:20px;\"><a class=\"Unsubscribe--unsubscribeLink\" href=\"{{{unsubscribe}}}\" style=\"\">Unsubscribe</a> - <a href=\"{{{unsubscribe_preferences}}}\" target=\"_blank\" class=\"Unsubscribe--unsubscribePreferences\" style=\"\">Unsubscribe Preferences</a></p></div></td>\n                                      </tr>\n                                    </table>\n                                    <!--[if mso]>\n                                  </td>\n                                </tr>\n                              </table>\n                            </center>\n                            <![endif]-->\n                          </td>\n                        </tr>\n                      </table>\n                    </td>\n                  </tr>\n                </table>\n              </td>\n            </tr>\n          </table>\n        </div>\n      </center>\n    </body>\n  </html>",
  "plain_content": "You've found the secret!\n\nWelcome to the family!\n\nYou've found a community of travelers that are just like you.\n\nWe don't want to be stuck in tourist traps that isolate us from vibrant, local experiences. We want to discover the hidden gems and less-traveled roads of our next destination.\n\nReady for your next authentic travel experience?\n\nBrowse Gallery\n\n( https://www.facebook.com/sendgrid/ ) ( https://twitter.com/sendgrid?ref_src=twsrc%5egoogle%7ctwcamp%5eserp%7ctwgr%5eauthor ) ( https://www.instagram.com/sendgrid/?hl=en ) ( https://www.pinterest.com/sendgrid/ )\n\n{{Sender_Name}}\n\n{{Sender_Address}} , {{Sender_City}} , {{Sender_State}} {{Sender_Zip}}\n\nUnsubscribe ( {{{unsubscribe}}} ) - Unsubscribe Preferences ( {{{unsubscribe_preferences}}} )",
  "generate_plain_content": true,
  "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/a85b4b202ff28094828f11ff472360caecf67ead2d186b69b45c904b9251aa0b.png",
  "subject": "Welcome to the family!",
  "created_at": "2019-09-10T02:11:34Z",
  "updated_at": "2021-01-11T21:47:52Z",
  "editor": "design",
  "categories": []
}

{
  "errors": [
    {
      "error_id": "pariatur officia veniam qui nostrud",
      "field": "elit commodo irure Lorem sint",
      "message": "laborum nulla officia deserunt pariatur"
    },
    {
      "error_id": "fugiat tempor aute",
      "field": "occaecat consectetur cillum magna minim",
      "message": "elit velit"
    },
    {
      "error_id": "quis",
      "field": "Duis aliquip dolor",
      "message": "culpa incididunt est officia labore"
    },
    {
      "error_id": "voluptate sit nulla",
      "field": "sed aute magna ullamco",
      "message": "deserunt dolor sint"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "nostrud",
      "field": "aliqua",
      "message": "anim eiusmod non aute"
    },
    {
      "error_id": "aliquip fugiat laboris",
      "field": "qui esse pariatur",
      "message": "do eiusmod non aute"
    },
    {
      "error_id": "quis nulla occaecat aute",
      "field": "enim sed nisi officia",
      "message": "consequat deserunt"
    }
  ]
}

GET

/v3/designs/pre-builts

**This endpoint allows you to retrieve a list of pre-built designs provided by Twilio SendGrid**. Unlike the `/designs` endpoint where *your* designs are stored, a GET request made to `designs/pre-builts` will retrieve a list of the pre-built Twilio SendGrid designs. This endpoint will not return

Query Parameter Name	Example
`page_size`	`88040472`
`page_token`	`Duis amet mollit`
`summary`	`false`

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)

PUT

/v3/marketing/contacts

**This endpoint allows the [upsert](https://en.wiktionary.org/wiki/upsert) (insert or update) of up to 30,000 contacts, or 6MB of data, whichever is lower**. Because the creation and update of contacts is an asynchronous process, the response will not contain immediate feedback on the processing

Request Payload

{
  "contacts": [
    {
      "address_line_1": "in",
      "address_line_2": "incididunt magna dolore",
      "alternate_emails": [
        "cupidatat dolore",
        "incididunt elit amet aliquip",
        "pariatur ea proident",
        "sit in",
        "velit veniam ex laborum cillum"
      ],
      "city": "Excepteur in consecte",
      "country": "dolore dolor aute consectetur dol",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "deserunt fugiat",
      "first_name": "Duis",
      "last_name": "incididunt sint laboris eiusmod elit",
      "postal_code": "officia",
      "state_province_region": "cupidatat in"
    },
    {
      "address_line_1": "est culpa mollit quis",
      "address_line_2": "esse ipsum",
      "alternate_emails": [
        "est adipisicing qui",
        "cillum",
        "commodo do aliquip",
        "dolor non elit irure Duis",
        "consectetur labore Excepteur culpa in"
      ],
      "city": "Duis voluptate commodo nulla",
      "country": "in laboris in Duis",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "occaecat exercitation sint",
      "first_name": "est",
      "last_name": "exercitation incididunt tempor",
      "postal_code": "dolor anim in Duis voluptate",
      "state_province_region": "sit est proident"
    },
    {
      "address_line_1": "pariatur proident fugiat nostrud ad",
      "address_line_2": "magna",
      "alternate_emails": [
        "labore",
        "do",
        "anim aliquip",
        "velit Excepteur",
        "in anim"
      ],
      "city": "qui nulla sint in",
      "country": "esse mollit ut cupida",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "non eu magna et ipsum",
      "first_name": "incididunt ",
      "last_name": "dolore",
      "postal_code": "ullamco in",
      "state_province_region": "ei"
    },
    {
      "address_line_1": "voluptate adipisicing",
      "address_line_2": "culpa magna dolor qui cupidatat",
      "alternate_emails": [
        "ex ipsum reprehenderit",
        "nisi do minim",
        "sunt Excepteur amet ut fugiat",
        "dolore consectetur aute veniam",
        "voluptate"
      ],
      "city": "amet cupidatat dolor",
      "country": "cillum",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "ullamco aliquip proident exercitation nulla",
      "first_name": "eu eni",
      "last_name": "nisi sed incididunt non",
      "postal_code": "elit deserunt velit",
      "state_province_region": "commodo"
    },
    {
      "address_line_1": "irure",
      "address_line_2": "laboris",
      "alternate_emails": [
        "nulla eu deserunt sed cupidatat",
        "consectetur Lorem",
        "nulla do magna quis",
        "in",
        "Lorem do"
      ],
      "city": "tempor vel",
      "country": "id a",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "sed qui non minim in",
      "first_name": "anim commodo consectetur con",
      "last_name": "in",
      "postal_code": "officia laborum",
      "state_province_region": "eiusmod"
    },
    {
      "address_line_1": "occaecat",
      "address_line_2": "voluptate magna adipisicing elit",
      "alternate_emails": [
        "sint aliquip dolore deserunt",
        "amet do non exercitation eu",
        "eiusmod exercitation",
        "pariatur Lorem",
        "magna Excepteur"
      ],
      "city": "laboris ipsum consequa",
      "country": "pariatur",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "quis deserunt",
      "first_name": "laborum ",
      "last_name": "pariatur consequat eiusmod",
      "postal_code": "veniam do adipisicing mollit exercitation",
      "state_province_region": "eiusmod esse"
    },
    {
      "address_line_1": "Lorem dolore occaecat commodo",
      "address_line_2": "ut",
      "alternate_emails": [
        "minim in commodo magna veniam",
        "ut",
        "mollit in",
        "dolore",
        "elit aliqua fugiat non"
      ],
      "city": "ips",
      "country": "est dolor",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "ut velit minim id ea",
      "first_name": "reprehenderit eu",
      "last_name": "ad",
      "postal_code": "consectetur",
      "state_province_region": "non labore deserunt exercitation ven"
    },
    {
      "address_line_1": "ut reprehenderit sit",
      "address_line_2": "dolor est et nisi",
      "alternate_emails": [
        "",
        "deserunt in occaecat",
        "Ut adipisicing deserunt labore elit",
        "ipsum",
        "est pariatur"
      ],
      "city": "labore laboris deserunt",
      "country": "Lorem deserunt",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "dolor laboris magna",
      "first_name": "conseq",
      "last_name": "pariat",
      "postal_code": "veniam pariatur eu",
      "state_province_region": "sunt ut qui in tempor"
    },
    {
      "address_line_1": "nisi",
      "address_line_2": "Lorem",
      "alternate_emails": [
        "laborum consectetur tempor dolor dolore",
        "nostrud qui irure aute elit",
        "ipsum veniam sed",
        "non officia commodo",
        "sit est"
      ],
      "city": "officia cillum labore Excepteur sun",
      "country": "in occaecat incididunt cupidatat",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "aute dolor ullamco non velit",
      "first_name": "aute esse et",
      "last_name": "sunt",
      "postal_code": "magna",
      "state_province_region": "magna"
    },
    {
      "address_line_1": "consectetur",
      "address_line_2": "dolore minim consequat",
      "alternate_emails": [
        "ipsum fugiat adipisicing",
        "culpa ex aliquip",
        "Ut",
        "aliqua deserunt Lorem nulla",
        "sint Excepteur enim"
      ],
      "city": "id",
      "country": "magna",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "veniam Lorem",
      "first_name": "esse enim velit in",
      "last_name": "sed tempor",
      "postal_code": "Lorem",
      "state_province_region": "ut labore Ut eu"
    }
  ],
  "list_ids": [
    "7f273549-64c4-bc6b-5737-f4a65a087c1d",
    "6a978c58-b086-c888-587a-fbd070e935c3"
  ]
}

Response Payload

{
  "job_id": "nisi"
}

{
  "errors": [
    {
      "error_id": "dolore nulla occaecat",
      "field": "occaecat anim adipisicing minim",
      "message": "aute voluptate consectetur cillum",
      "parameter": "in consequat cillum esse"
    },
    {
      "error_id": "ullamco Ut sunt dolore adipisicing",
      "field": "cupidatat proident officia magna nulla",
      "message": "dolor",
      "parameter": "qui ea Lorem est sit"
    },
    {
      "error_id": "Lorem exercitation",
      "field": "elit",
      "message": "aliqua deserunt",
      "parameter": "aliquip eu laboris incididunt"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "do"
    },
    {
      "message": "sint"
    },
    {
      "message": "enim cillum minim sunt"
    },
    {
      "message": "culpa aliquip dolor occaecat"
    }
  ]
}

DELETE

/v3/marketing/contacts

**This endpoint can be used to delete one or more contacts**. The query parameter `ids` must set to a comma-separated list of contact IDs for bulk contact deletion. The query parameter `delete_all_contacts` must be set to `"true"` to delete **all** contacts. You must set either `ids` or `delete

Query Parameter Name	Example
`delete_all_contacts`	`dolore fugiat eu id`
`ids`	`sed culpa nisi`

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": "enim aliqua exercitation anim sunt"
    }
  ]
}

GET

/v3/marketing/contacts

**This endpoint will return up to 50 of the most recent contacts uploaded or attached to a list**. This list will then be sorted by email address. The full contact count is also returned. Please note that pagination of the contacts has been deprecated. Twilio SendGrid recommends exporting your

Request Payload

Response Payload

{
  "_metadata": {
    "self": "in anim irure fugiat"
  },
  "contact_count": -65225169,
  "result": [
    {
      "_metadata": {
        "self": "elit"
      },
      "address_line_1": "labore do minim",
      "address_line_2": "ipsum proident dolore",
      "alternate_emails": [
        "consequat",
        "commodo sed ullamco exercitation sit",
        "cillum",
        "Ut quis"
      ],
      "city": "officia",
      "country": "voluptate pariatur consectetur incididunt quis",
      "created_at": "adipisicing dolor eu consectetur",
      "custom_fields": {},
      "email": "veniam nisi sit ad tempor",
      "facebook": "qui ex in",
      "first_name": "dolor id in consectetur Duis",
      "id": "laboris minim",
      "last_name": "veniam anim et",
      "line": "amet Duis veniam culpa dolore",
      "list_ids": [
        "consequat incididunt mollit laborum",
        "deserunt",
        "nulla eiusmod in incididunt",
        "dolore aliquip magna"
      ],
      "phone_number": "consequat eu",
      "postal_code": "laborum",
      "segment_ids": [
        "adipisicing",
        "culpa laborum dolore",
        "commodo sint",
        "sed qui quis ea"
      ],
      "state_province_region": "do nisi dolore",
      "unique_name": "pariatur consectetur ut laborum",
      "updated_at": "voluptate est",
      "whatsapp": "laboris nulla fugiat"
    },
    {
      "_metadata": {
        "self": "deserunt exercitation labore cillum"
      },
      "address_line_1": "dolore",
      "address_line_2": "ex",
      "alternate_emails": [
        "in dolore",
        "est labore dolore",
        "labore exercitation",
        "voluptate ipsum laborum",
        "proident et mollit"
      ],
      "city": "velit",
      "country": "non irure Excepteur",
      "created_at": "ut aliquip aliqua",
      "custom_fields": {},
      "email": "consequat",
      "facebook": "occaecat id labore",
      "first_name": "minim voluptate",
      "id": "ex",
      "last_name": "Excepteur",
      "line": "dolore veniam elit Ut ipsum",
      "list_ids": [
        "nisi exercitation",
        "laborum",
        "aute labore"
      ],
      "phone_number": "elit eiusmod minim qui",
      "postal_code": "velit",
      "segment_ids": [
        "in",
        "Lorem minim ut",
        "sint ea nulla dolore cillum"
      ],
      "state_province_region": "quis eiusmod do cupidatat",
      "unique_name": "labore in Ut ut",
      "updated_at": "elit",
      "whatsapp": "consequat esse aute in"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "aute tempor",
      "field": "et amet culpa",
      "message": "ullamco",
      "parameter": "reprehenderit eu proident"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{}

{
  "errors": [
    {
      "message": "nisi aute commodo dolore"
    },
    {
      "message": "est qui"
    },
    {
      "message": "aliqua"
    },
    {
      "message": "laboris est velit eiusmod"
    }
  ]
}

GET

/v3/marketing/contacts/count

**This endpoint returns the total number of contacts you have stored.** Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data.

Request Payload

Response Payload

{
  "billable_breakdown": {
    "breakdown": {},
    "total": 35783042
  },
  "billable_count": 71797471,
  "contact_count": -10305430
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "irure elit qui mollit"
    }
  ]
}

POST

/v3/marketing/contacts/exports

**Use this endpoint to export lists or segments of contacts**. If you would just like to have a link to the exported list sent to your email set the `notifications.email` option to `true` in the `POST` payload. If you would like to download the list, take the `id` that is returned and use the "Ex

Request Payload

{
  "file_type": "csv",
  "list_ids": [
    "6f3ad989-be04-f591-4901-334b9534033c",
    "a6f64042-7633-c3e3-ea08-81ca747571a1"
  ],
  "max_file_size": 10711843,
  "notifications": {
    "email": true
  },
  "segment_ids": [
    "dolor deserunt sint qui"
  ]
}

Response Payload

{
  "_metadata": {
    "count": -46333578.051639624,
    "next": "https://LHNELejjdSwKTccQOm.khukFGt,T3jWDmw4NkW0idDxhT",
    "prev": "https://rLbefTyFMO.kkkvPO7QiXLEEiVX-AO.UDLIrnGWTUuJoGzG7zk",
    "self": "http://RiLiiinSRKNSpKiERYrcbzwMuyFM.bhelNF1NftZV2gddDdu+W8GsO"
  },
  "id": "qui"
}

{
  "errors": [
    {
      "error_id": "et aliquip reprehenderit pariatur irure",
      "field": "amet deserunt nostrud",
      "message": "id",
      "parameter": "deserunt sit sed"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "consequat laborum nisi dolor adipisicing"
    },
    {
      "message": "anim velit mollit culpa nisi"
    },
    {
      "message": "id sunt"
    },
    {
      "message": "proident"
    }
  ]
}

GET

/v3/marketing/contacts/exports

**Use this endpoint to retrieve details of all current exported jobs**. It will return an array of objects, each of which records an export job in flight or recently completed. Each object's `export_type` field will tell you which kind of export it is and its `status` field will indicate what st

Request Payload

Response Payload

{
  "_metadata": {
    "next": "ut sit occaecat",
    "prev": "sit eu consequat exercitation quis",
    "self": "est Lorem"
  },
  "result": [
    {
      "_metadata": {
        "next": "dolore ipsum velit anim ea",
        "prev": "dolor nulla",
        "self": "exercitation veniam"
      },
      "completed_at": "sed qui",
      "created_at": "anim",
      "expires_at": "in dolore",
      "export_type": "ut commodo sed nisi",
      "id": "labore dolore et ex",
      "lists": [
        {
          "ID": "laborum ex mollit et",
          "Name": "in occaecat do dolor mollit"
        },
        {
          "ID": "sint",
          "Name": "culpa pariatur non eu"
        },
        {
          "ID": "culpa tempor",
          "Name": "proident quis in laborum"
        },
        {
          "ID": "cupidatat non ullamco",
          "Name": "cupidatat aliqua mollit eiusmod Lorem"
        },
        {
          "ID": "ut quis enim ut",
          "Name": "Duis consectetur aliqua occaecat velit"
        }
      ],
      "segments": [
        {
          "ID": "fugiat",
          "Name": "et"
        }
      ],
      "status": "do",
      "urls": [
        "commodo"
      ],
      "user_id": "in Ut dolore officia minim"
    },
    {
      "_metadata": {
        "next": "do",
        "prev": "deserunt",
        "self": "eu cillum laboris aliqua ut"
      },
      "completed_at": "enim sed ea",
      "created_at": "laborum labore minim culpa",
      "expires_at": "minim ut",
      "export_type": "nulla amet",
      "id": "anim consequat qui enim",
      "lists": [
        {
          "ID": "velit occaecat irure dolore enim",
          "Name": "fugiat aliquip eiusmod non ut"
        },
        {
          "ID": "deserunt consectetur",
          "Name": "adipisicing veniam pariatur aliquip"
        },
        {
          "ID": "qui",
          "Name": "nulla ex"
        }
      ],
      "segments": [
        {
          "ID": "eu commodo laborum qui",
          "Name": "do laboris consequat in"
        },
        {
          "ID": "sit cupidatat veniam aute culpa",
          "Name": "dolor sunt exercitation consequat adipisicing"
        },
        {
          "ID": "elit tempor dolore laboris adipisicing",
          "Name": "consectetur nostrud ex elit eiusmod"
        }
      ],
      "status": "Ut commodo eiusmod",
      "urls": [
        "exercitation Ut ea et est",
        "ipsum dolore qui est pariatur",
        "voluptate"
      ],
      "user_id": "officia nisi"
    }
  ]
}

{
  "errors": [
    {
      "": "ad sint dolore",
      "error_id": "quis",
      "message": "in nisi"
    },
    {
      "": "amet veniam labore",
      "error_id": "laborum officia",
      "message": "deserunt velit dolor esse"
    },
    {
      "": "aliqua proident cupidatat esse",
      "error_id": "deserunt",
      "message": "velit sit ut"
    },
    {
      "": "mollit dolor incididunt sed et",
      "error_id": "proident",
      "message": "enim"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "dolore ad minim exercitation velit"
    },
    {
      "message": "minim enim cupidatat aliqua reprehenderit"
    },
    {
      "message": "elit incididunt aute magna"
    },
    {
      "message": "sunt id esse sit"
    }
  ]
}

GET

/v3/marketing/contacts/{id}

**This endpoint returns the full details and all fields for the specified contact**. The "Get Contacts by Emails" endpoint can be used to get the ID of a contact. Twilio SendGrid recommends exporting your contacts regularly as a backup to avoid issues or lost data.

Request Payload

Response Payload

{
  "_metadata": {
    "self": "sunt"
  },
  "address_line_1": "dolor veniam et qui dolor",
  "address_line_2": "do mollit eu sed culpa",
  "alternate_emails": [
    "ex",
    "Ut ipsum",
    "dolore in tempor minim"
  ],
  "city": "ut magna anim consequat",
  "country": "Lorem pariatur",
  "created_at": "ipsum",
  "custom_fields": {},
  "email": "nulla sed",
  "facebook": "ea",
  "first_name": "dolor sunt occaecat Duis",
  "id": "ut sint cupidatat culpa nulla",
  "last_name": "tempor do nisi et",
  "line": "pariatur do reprehenderit ipsum",
  "list_ids": [
    "ad nulla qui esse",
    "in tempor magna",
    "ad voluptate",
    "in aute et",
    "consequat aliqua"
  ],
  "phone_number": "commodo in voluptate deserunt culpa",
  "postal_code": "minim qui ut",
  "segment_ids": [
    "deserunt",
    "dolore cupidatat ad non pariatur",
    "nostrud nisi do",
    "reprehenderit dolor"
  ],
  "state_province_region": "elit amet",
  "unique_name": "ut elit eiusmod et do",
  "updated_at": "eiusmod dolore ut commodo dolor",
  "whatsapp": "ad in"
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "errors": [
    {
      "message": "in consequat Duis"
    }
  ]
}

POST

/v3/marketing/contacts/search

**Use this endpoint to locate contacts**. The request body's `query` field accepts valid [SGQL](https://sendgrid.com/docs/for-developers/sending-email/segmentation-query-language/) for searching for a contact. Because contact emails are stored in lower case, using SGQL to search by email address

Request Payload

{
  "query": "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')"
}

Response Payload

{
  "_metadata": {
    "self": "adipisicing"
  },
  "contact_count": -20025415.658953622,
  "result": [
    {
      "_metadata": {
        "self": "dolore ullamco incididunt sunt"
      },
      "address_line_1": "esse Ut Excepteur commodo dolore",
      "address_line_2": "dolore labore minim esse",
      "alternate_emails": [
        "Excepteur voluptate dolor commodo"
      ],
      "city": "enim ut sunt tempor nisi",
      "country": "id nostrud quis laborum",
      "created_at": "Excepteur ea",
      "custom_fields": {},
      "email": "fugiat nulla",
      "facebook": "in ut",
      "first_name": "eiusmod",
      "id": "officia aliquip laborum irure",
      "last_name": "sunt",
      "line": "laborum labore",
      "list_ids": [
        "ut fugiat amet",
        "qui adipisicing irure commodo",
        "esse dolore",
        "Excepteur anim est consectetur ipsum",
        "elit"
      ],
      "phone_number": "Lorem cillum minim eu",
      "postal_code": "in elit ut proident",
      "segment_ids": [
        "pariatur dolore",
        "Ut in",
        "et amet sit nulla"
      ],
      "state_province_region": "fugiat",
      "unique_name": "amet tempor elit",
      "updated_at": "voluptate",
      "whatsapp": "ut esse"
    },
    {
      "_metadata": {
        "self": "Excepteur culpa ut"
      },
      "address_line_1": "occaecat ad ullamco eiusmod",
      "address_line_2": "ad fugiat voluptate anim",
      "alternate_emails": [
        "in nulla",
        "Ut nisi",
        "ut adipisicing proident cillum velit",
        "Lorem"
      ],
      "city": "aute",
      "country": "culpa nulla voluptate",
      "created_at": "magna velit",
      "custom_fields": {},
      "email": "Lorem",
      "facebook": "proident sunt adipisicing",
      "first_name": "nostrud ad Lorem aliqua",
      "id": "sed Ut eiusmod ut",
      "last_name": "pariatur reprehenderit dolor consequat",
      "line": "aliqua nulla in",
      "list_ids": [
        "reprehenderit ex ipsum non Duis"
      ],
      "phone_number": "tempor pariatur dolore reprehenderit mollit",
      "postal_code": "adipisicing voluptate sit et anim",
      "segment_ids": [
        "sunt",
        "eiusmod dolore",
        "tempor"
      ],
      "state_province_region": "in sed dolor do nulla",
      "unique_name": "nulla laboris",
      "updated_at": "consectetur proident",
      "whatsapp": "ullamco sint"
    },
    {
      "_metadata": {
        "self": "Duis amet eiusmod"
      },
      "address_line_1": "dolore laborum elit fugiat",
      "address_line_2": "cupidatat proident exercitation",
      "alternate_emails": [
        "aliquip Lorem",
        "sit consequat pariatur",
        "magna aute nulla"
      ],
      "city": "sunt",
      "country": "ut",
      "created_at": "ex velit anim eiusmod",
      "custom_fields": {},
      "email": "dolore in quis dolor veniam",
      "facebook": "dolore",
      "first_name": "reprehenderit occaecat qui irure dolor",
      "id": "laboris aliquip ut cupidatat",
      "last_name": "Duis pariatur qui anim",
      "line": "esse exercitation magna",
      "list_ids": [
        "occaecat reprehenderit dolore",
        "ut reprehenderit",
        "aute anim qui cupidatat",
        "incididunt laboris consequat velit consectetur"
      ],
      "phone_number": "commodo",
      "postal_code": "minim dolore",
      "segment_ids": [
        "irure incididunt dolore",
        "qui dolor",
        "ullamco aliquip nisi",
        "ullamco consequat eu"
      ],
      "state_province_region": "nisi",
      "unique_name": "et exercitation commodo sint",
      "updated_at": "ullamco Excepteur",
      "whatsapp": "dolor incididunt"
    }
  ]
}

{
  "errors": [
    {
      "field": "enim",
      "message": "nulla amet"
    }
  ]
}

{
  "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": "cupidatat dolor"
    },
    {
      "message": "non consectetur sint nostrud"
    },
    {
      "message": "id mollit deserunt"
    },
    {
      "message": "laborum et eiusmod eu consectetur"
    }
  ]
}

PUT

/v3/marketing/contacts/imports

**This endpoint allows a CSV upload containing up to one million contacts or 5GB of data, whichever is smaller.** Imports take place asynchronously: the endpoint returns a URL (`upload_uri`) and HTTP headers (`upload_headers`) which can subsequently be used to `PUT` a file of contacts to be impor

Request Payload

{
  "field_mappings": [
    null,
    "qui ullamco"
  ],
  "file_type": "csv",
  "list_ids": [
    "Lorem non et",
    "dolor ullamco"
  ]
}

Response Payload

{
  "job_id": "consequat",
  "upload_headers": [
    {
      "header": "ullamco sint Ut consectetur",
      "value": "in fugiat nulla occaecat ipsum"
    },
    {
      "header": "adipisicing",
      "value": "Lorem"
    },
    {
      "header": "quis culpa nisi dolore",
      "value": "ea consectetur anim"
    }
  ],
  "upload_uri": "non cupidatat esse sit"
}

{
  "errors": [
    {
      "error_id": "tempor sit",
      "field": "velit ullamco quis officia non",
      "message": "magna quis labore",
      "parameter": "pariatur commodo voluptate amet tempor"
    },
    {
      "error_id": "in",
      "field": "non consectetur proident commodo laboris",
      "message": "consectetur pariatur",
      "parameter": "commodo non cupidatat culpa adipisicing"
    },
    {
      "error_id": "ut",
      "field": "eiusmod ullamco pariatur sint",
      "message": "ex adipisicing culpa aute occaecat",
      "parameter": "consectetur irure magna est"
    },
    {
      "error_id": "nulla ut cupidatat amet quis",
      "field": "et occaecat esse commodo",
      "message": "adipisicing Lorem ad dolor culpa",
      "parameter": "ut"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "enim",
      "field": "ipsum dolore Lorem officia Duis",
      "message": "commodo consequat velit",
      "parameter": "ad velit"
    },
    {
      "error_id": "magna Lorem culpa Duis",
      "field": "ullamco",
      "message": "quis commodo",
      "parameter": "dolor dolor culpa"
    },
    {
      "error_id": "occaecat dolor",
      "field": "eu",
      "message": "quis aliqua qui exercitation dolore",
      "parameter": "consequat enim exercitation aute pariatur"
    },
    {
      "error_id": "elit tempor dolor labore",
      "field": "Lorem dolor aliquip",
      "message": "id",
      "parameter": "reprehenderit"
    }
  ]
}

{
  "errors": [
    {
      "message": "aute ut pariatur laborum amet"
    }
  ]
}

GET

/v3/marketing/contacts/imports/{id}

**This endpoint can be used to check the status of a contact import job**. Use the `job_id` from the "Import Contacts," "Add or Update a Contact," or "Delete Contacts" endpoints as the `id` in the path parameter. If there is an error with your `PUT` request, download the `errors_url` file and op

Request Payload

Response Payload

{
  "finished_at": "Excepteur dolor eiusmod minim",
  "id": "nulla",
  "job_type": "fugiat in ut",
  "results": {
    "created_count": -5717127.706759989,
    "deleted_count": -19010273.784144,
    "errored_count": 94945760.32032362,
    "errors_url": "ut",
    "requested_count": -56653542.0038746,
    "updated_count": -40228628.80206466
  },
  "started_at": "qui",
  "status": "laborum"
}

{
  "errors": {
    "error_id": "elit proident",
    "field": "do",
    "message": "consequat id reprehenderit",
    "parameter": "cillum dolore commodo"
  }
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "ad"
    },
    {
      "message": "qui cupidatat"
    }
  ]
}

GET

/v3/marketing/contacts/exports/{id}

**This endpoint can be used to check the status of a contact export job**. To use this call, you will need the `id` from the "Export Contacts" call. If you would like to download a list, take the `id` that is returned from the "Export Contacts" endpoint and make an API request here to get the `u

Request Payload

Response Payload

{
  "_metadata": {
    "count": -89398641.03965119,
    "next": "http://NL.kjimTqA2erUHMDtjrvR8sImPpskRUhW-.SprY9AJxHAx2u-TsEX08qjGqyJCzBbwxj",
    "prev": "http://ZqzvgbYxsuJoGAAbood.knyoGHZkerLMfe0-z8wvqoZlOWm5QFXW9KGOFlB9eTF",
    "self": "https://ouWdG.droiX.nILQ.4ZJAOBsNOPD-R1m3bsDi"
  },
  "completed_at": "eiusmod in in sed",
  "contact_count": -83375256,
  "created_at": "in",
  "expires_at": "enim in ad laboris",
  "id": "ut",
  "message": "in dolor esse ut",
  "status": "failure",
  "updated_at": "in consequat",
  "urls": [
    "enim ipsum officia",
    "consectetur adipisicing in sunt",
    "nulla ut do ex elit"
  ]
}

{
  "errors": [
    {
      "error_id": "Excepteur eu ea",
      "field": "nostrud ut ipsum",
      "message": "ipsum sint Ut",
      "parameter": "dolore culpa dolore tempor ullamco"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "exercitation in"
    },
    {
      "message": "ipsum amet"
    },
    {
      "message": "incididunt adipisicing proident sunt"
    }
  ]
}

POST

/v3/marketing/contacts/batch

**This endpoint is used to retrieve a set of contacts identified by their IDs.** This can be more efficient endpoint to get contacts than making a series of individual `GET` requests to the "Get a Contact by ID" endpoint. You can supply up to 100 IDs. Pass them into the `ids` field in your reques

Request Payload

{
  "ids": [
    "1234",
    "1235"
  ]
}

Response Payload

{
  "result": [
    {
      "_metadata": {
        "self": "irure"
      },
      "address_line_1": "ipsum",
      "address_line_2": "qui eiusmod laborum in",
      "alternate_emails": [
        "ipsum cillum incididunt fugiat occaecat",
        "dolore aliquip aute Excepteur culpa"
      ],
      "city": "esse ipsum sit",
      "country": "incididunt consectetur",
      "created_at": "nulla",
      "custom_fields": {},
      "email": "tempor",
      "facebook": "dolore",
      "first_name": "id veniam",
      "id": "sint consequat",
      "last_name": "eu incididunt",
      "line": "sed fugiat et reprehenderit",
      "list_ids": [
        "pariatur",
        "eu elit aliqua",
        "mollit in",
        "ipsum Ut",
        "irure ut"
      ],
      "phone_number": "adipisicing sint",
      "postal_code": "incididunt ut anim aute nisi",
      "segment_ids": [
        "enim ut qui",
        "esse cupidatat magna",
        "reprehenderit dolore"
      ],
      "state_province_region": "ut dolor Excepteur dolore laboris",
      "unique_name": "fugiat commodo",
      "updated_at": "in ad occaecat",
      "whatsapp": "in elit occaecat id"
    },
    {
      "_metadata": {
        "self": "ipsum ea amet id"
      },
      "address_line_1": "reprehenderit ipsum",
      "address_line_2": "labore enim anim pariatur Ut",
      "alternate_emails": [
        "ipsum nulla cillum",
        "officia Duis",
        "in"
      ],
      "city": "qui ut sint ea laboris",
      "country": "adipisicing id labore consectetur",
      "created_at": "laboris cillum ex ut est",
      "custom_fields": {},
      "email": "minim esse",
      "facebook": "nostrud",
      "first_name": "cillum eiusmod id",
      "id": "dolor Lorem ut dolore",
      "last_name": "quis sit in",
      "line": "ea consectetur labore Ut",
      "list_ids": [
        "ad nulla cillum est laborum",
        "aliquip"
      ],
      "phone_number": "eiusmod cupidatat labore",
      "postal_code": "sint officia",
      "segment_ids": [
        "dolor occaecat ea ut sunt",
        "eiusmod sint",
        "dolore incididunt velit laboris",
        "est dolor",
        "dolor reprehenderit proident aliqua"
      ],
      "state_province_region": "nisi elit in nostrud aliqua",
      "unique_name": "est tempor ex",
      "updated_at": "eiusmod deserunt ut ullamco ut",
      "whatsapp": "in deserunt et"
    },
    {
      "_metadata": {
        "self": "velit ex"
      },
      "address_line_1": "esse ut in",
      "address_line_2": "quis",
      "alternate_emails": [
        "amet nisi",
        "veniam voluptate enim dolore ad",
        "veniam"
      ],
      "city": "incididunt",
      "country": "proident Excepteur est",
      "created_at": "in culpa",
      "custom_fields": {},
      "email": "Excepteur laborum elit commodo",
      "facebook": "consectetur quis eu eiusmod voluptate",
      "first_name": "nostrud consequat qui",
      "id": "ut qui labore cupidatat",
      "last_name": "anim laborum consectetur",
      "line": "in nulla sed incididunt aliqua",
      "list_ids": [
        "veniam ut nulla in consectetur",
        "deserunt et irure voluptate cillum",
        "magna",
        "mollit do"
      ],
      "phone_number": "enim",
      "postal_code": "dolore sunt tempor aliqua ut",
      "segment_ids": [
        "sint non aliquip",
        "aute reprehenderit",
        "ipsum incididunt sunt"
      ],
      "state_province_region": "enim culpa occaecat",
      "unique_name": "cupidatat dolore",
      "updated_at": "culpa",
      "whatsapp": "nulla esse"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{}

{
  "errors": [
    {
      "message": "tempor"
    }
  ]
}

POST

/v3/marketing/contacts/search/emails

**This endpoint allows you to retrieve up to 100 contacts matching the searched `email` address(es), including any `alternate_emails`.** Email addresses are unique to a contact, meaning this endpoint can treat an email address as a primary key to search by. The contact object associated with the

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": "culpa qui aliquip consequat ullamco"
    },
    {
      "message": "mollit"
    }
  ]
}

Segmenting Contacts V2 - Beta(5 operations)

POST

/v3/marketing/segments/2.0

**The Segmentation V2 API is currently in private beta. If you'd like to be added to the beta, please fill out this [form]({https://docs.google.com/forms/d/e/1FAIpQLSd5zwC9dRk8lAp1oTWjdGc-aSY69flW_7wnutvKBhpUluSnfQ/viewform)** Segment `name` has to be unique. A user can not create a new segment wi

Request Payload

{
  "name": "Ut dolore vol",
  "parent_list_ids": [
    "fugiat amet Duis",
    "ea ipsum minim esse",
    "incididunt in cillum sunt magna",
    "veniam",
    "ullamco aliquip dolor ut sed"
  ],
  "query_dsl": "Excepteur dolor"
}

Response Payload

{
  "contacts_count": 72031377,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "Lorem",
  "id": "1df98d15-4c89-96ab-4358-7b65a53799e4",
  "name": "in labore irure fugiat",
  "next_sample_update": "do ex",
  "parent_list_ids": [
    "laboris eu"
  ],
  "query_dsl": "nisi commodo",
  "query_version": "laborum eu proident",
  "sample_updated_at": "anim et exercitation",
  "status": {
    "error_message": "laborum culpa",
    "query_validation": "ea nulla non anim"
  },
  "updated_at": "sint incididunt"
}

{
  "errors": [
    {
      "field": "ipsum aliqua veniam dolore",
      "message": "dolore ex"
    },
    {
      "field": "cupidatat Ut",
      "message": "est"
    },
    {
      "field": "officia ullamco",
      "message": "dolore sunt"
    },
    {
      "field": "nulla officia nisi magna minim",
      "message": "irure Lorem aute"
    }
  ]
}

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": "deserunt",
      "message": "et velit incididunt commodo aute"
    },
    {
      "field": "laboris",
      "message": "et nisi sit"
    },
    {
      "field": "in veniam in",
      "message": "dolore cupidatat et minim"
    },
    {
      "field": "pariatur Excepteur ullamco in",
      "message": "laboris reprehenderit Duis"
    },
    {
      "field": "anim non",
      "message": "proident officia"
    }
  ]
}

GET

/v3/marketing/segments/2.0

**The Segmentation V2 API is currently in private beta. If you'd like to be added to the beta, please fill out this [form]({https://docs.google.com/forms/d/e/1FAIpQLSd5zwC9dRk8lAp1oTWjdGc-aSY69flW_7wnutvKBhpUluSnfQ/viewform)** The query param `parent_list_ids` is treated as a filter. Any match wi

Query Parameter Name	Example
`parent_list_ids`	`ad incididunt magna aliquip`
`no_parent_list_id`	`false`

Request Payload

Response Payload

{
  "_metadata": {
    "count": 78250234,
    "next": "http://IHnkWHEkkXjwaIFFuZvLsHDO.twbqhC48-LgAElWFZZMRwPUUOc.IQoPp2OOeG.AM8oRDLbR,b8btK7O-O",
    "prev": "http://BZXbPSGTdccbdcMZIzEtjyWtiVyHkjr.xjhenBOQOo,zQV4IEcNq.x",
    "self": "https://IYlGjmqfHdVaIQSaaBCeSR.ubRJoZ1rcyh.ELbZ+UTrcBkBkib-ae8vubvQjdMG2IYszfCpp"
  },
  "contacts_count": 14513676,
  "created_at": "eu id dolor",
  "id": "66e96d0f-8854-08cc-aa01-392c021fa9e6",
  "name": "laboris exercitation Excepteur pariatur ut",
  "next_sample_update": "officia quis consequat",
  "parent_list_ids": [
    "laborum ex sunt voluptate dolor"
  ],
  "query_version": "magna Ut",
  "sample_updated_at": "Lorem aliqua sit incididunt",
  "status": {
    "error_message": "in aute eu",
    "query_validation": "ut ea dolore"
  },
  "updated_at": "commodo et"
}

{
  "errors": [
    {
      "field": "sint do anim sed",
      "message": "veniam labore laboris fugiat exercitation"
    },
    {
      "field": "enim et dolor eiusmod",
      "message": "dolore sed quis cillum ullamco"
    },
    {
      "field": "pariatur ea minim ut sunt",
      "message": "consectetur ad in veniam labore"
    },
    {
      "field": "et reprehenderit cillum anim",
      "message": "in Duis"
    }
  ]
}

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "errors": [
    {
      "field": "voluptate proident",
      "message": "in"
    }
  ]
}

PATCH

/v3/marketing/segments/2.0/{segment_id}

Request Payload

{
  "name": "ut",
  "query_dsl": "consectetur pariatur exercitation ut ipsum"
}

Response Payload

{
  "contacts_count": -91565371,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "cillum ea ullamco",
  "id": "2da49865-8ca5-6b69-fbbf-5ff8e8948abb",
  "name": "ut sunt elit",
  "next_sample_update": "nulla commodo irure quis fugiat",
  "parent_list_ids": [
    "enim sit mollit veniam",
    "qui anim adipisicing amet in",
    "proident Excepteur",
    "deserunt ex"
  ],
  "query_dsl": "dolore ea",
  "query_version": "eiusmod dolor ut",
  "sample_updated_at": "laborum",
  "status": {
    "error_message": "ea reprehenderit",
    "query_validation": "sint cupidatat"
  },
  "updated_at": "voluptate tempor fugiat officia"
}

{
  "errors": [
    {
      "field": "laboris irure eu reprehenderit ullamco",
      "message": "nulla eu amet culpa non"
    },
    {
      "field": "nostrud sit fugiat minim magna",
      "message": "reprehenderit do ipsum non"
    }
  ]
}

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "errors": [
    {
      "field": "occaecat magna cupidatat sint labore",
      "message": "labore eiusmod sunt id ex"
    },
    {
      "field": "mollit esse ad",
      "message": "sed in velit ullamco"
    },
    {
      "field": "cillum ut",
      "message": "magna ut dolore sit officia"
    },
    {
      "field": "anim sint tempor aliqua",
      "message": "eu in officia ullamco esse"
    },
    {
      "field": "tempor",
      "message": "cillum ex magna nulla"
    }
  ]
}

GET

/v3/marketing/segments/2.0/{segment_id}

Query Parameter Name	Example
`contacts_sample`	`true`

Request Payload

Response Payload

{
  "contacts_count": -34195020,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "sunt ipsum et ad",
  "id": "1f01f314-5582-7807-d5a8-ca0ab935a5a1",
  "name": "nisi dolor",
  "next_sample_update": "pariatur laboris fugiat aute laborum",
  "parent_list_ids": [
    "culpa anim quis",
    "Ut commodo mollit ad"
  ],
  "query_dsl": "et in",
  "query_version": "quis dolore",
  "sample_updated_at": "culpa eu pariatur",
  "status": {
    "error_message": "ea",
    "query_validation": "sed Lorem ea non"
  },
  "updated_at": "dolore tempor"
}

{
  "errors": [
    {
      "field": "enim quis ad in",
      "message": "ullamco ex laboris officia cillum"
    },
    {
      "field": "do laboris",
      "message": "dolor"
    }
  ]
}

{
  "errors": [
    {
      "field": "velit qui deserunt enim",
      "message": "irure et sint aliquip"
    },
    {
      "field": "aute sit quis aliquip in",
      "message": "magna ipsum consectetur Excepteur aute"
    },
    {
      "field": "consectetur sint eu nulla",
      "message": "dolore qui"
    },
    {
      "field": "quis sunt sit adipisicing",
      "message": "sit"
    },
    {
      "field": "eiusmod incididunt",
      "message": "deserunt"
    }
  ]
}

DELETE

/v3/marketing/segments/2.0/{segment_id}

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "errors": [
    {
      "field": "eu",
      "message": "sint non"
    }
  ]
}

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "errors": [
    {
      "field": "et",
      "message": "nostrud occaecat irure minim id"
    }
  ]
}

Senders

POST

/v3/marketing/senders

**This endpoint allows you to create a new sender identity.** *You may create up to 100 unique sender identities.* Sender identities are required to be verified before use. If your domain has been authenticated, a new sender identity will auto verify on creation. Otherwise an email will be sent t

Header Name	Example
`on-behalf-of`	`"dolore sunt est labore"`

Request Payload

{
  "nickname": "Example Orders",
  "from": {
    "email": "orders@example.com",
    "name": "Example Orders"
  },
  "reply_to": {
    "email": "support@example.com",
    "name": "Example Support"
  },
  "address": "1234 Fake St.",
  "address_2": "",
  "city": "San Francisco",
  "state": "CA",
  "zip": "94105",
  "country": "United States"
}

Response Payload

{
  "id": 1,
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States",
  "verified": true,
  "updated_at": 1449872165,
  "created_at": 1449872165,
  "locked": false
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "Ut in voluptate"
    }
  ]
}

Lists(7 operations)

POST

/v3/marketing/lists

**This endpoint creates a new contacts list.** Once you create a list, you can use the UI to [trigger an automation](https://sendgrid.com/docs/ui/sending-email/getting-started-with-automation/#create-an-automation) every time you add a new contact to the list. A link to the newly created object i

Request Payload

{
  "name": "list-name"
}

Response Payload

{
  "id": "ca7a3796-e8a8-4029-9ccb-df8937940562",
  "name": "list-name",
  "contact_count": 0,
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/lists/ca7a3796-e8a8-4029-9ccb-df8937940562"
  }
}

{
  "errors": [
    {
      "error_id": "Duis in non sunt magna",
      "field": "ullamco ipsum ut do",
      "message": "do qui",
      "parameter": "in tempor"
    },
    {
      "error_id": "Duis esse veniam",
      "field": "in enim ad",
      "message": "consectetur ut",
      "parameter": "et Lorem sit"
    },
    {
      "error_id": "est",
      "field": "voluptate velit",
      "message": "officia cupidatat dolore",
      "parameter": "adipisicing magna aute in in"
    },
    {
      "error_id": "ad Excepteur",
      "field": "aliqua fugiat",
      "message": "et minim aliquip",
      "parameter": "exercitation et"
    }
  ]
}

GET

/v3/marketing/lists

**This endpoint returns an array of all of your contact lists.**

Query Parameter Name	Example
`page_size`	`851.3405943957175`
`page_token`	`sint eu magna`

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="
  }
}

GET

/v3/marketing/lists/{id}/contacts/count

**This endpoint returns the number of contacts on a specific list.**

Request Payload

Response Payload

{
  "contact_count": 0,
  "billable_count:": 0
}

{}

GET

/v3/marketing/lists/{id}

**This endpoint returns data about a specific list.** Setting the optional parameter `contact_sample=true` returns the `contact_sample` in the response body. Up to fifty of the most recent contacts uploaded or attached to a list will be returned, sorted alphabetically, by email address. The full

Query Parameter Name	Example
`contact_sample`	`false`

Request Payload

Response Payload

{
  "contact_count": 2,
  "contact_sample": {
    "id": "c3445f88-5c69-4237-86e6-9ec9de958050",
    "list_ids": [
      "199abb98-0af3-4a8d-b371-6811ff85d062"
    ],
    "created_at": "2620-06-16T17:03:54.867Z",
    "updated_at": "4780-12-06T06:51:30.024Z"
  },
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/lists/199abb98-0af3-4a8d-b371-6811ff85d062"
  },
  "id": "199abb98-0af3-4a8d-b371-6811ff85d062",
  "name": "list-name"
}

[
  {
    "error_id": "laboris proident pariatur ea",
    "field": "proident veniam consequat mollit ea",
    "message": "Duis ut",
    "parameter": "aute officia in velit nostrud"
  },
  {
    "error_id": "in minim officia Excepteur",
    "field": "veniam ut pariatur aliqua est",
    "message": "est labore voluptate occaecat",
    "parameter": "ad nulla"
  }
]

PATCH

/v3/marketing/lists/{id}

**This endpoint updates the name of a list.**

Request Payload

{
  "name": "updated-list-name"
}

Response Payload

{
  "id": "abc12312-x3y4-1234-abcd-123qwe456rty",
  "name": "updated-list-name",
  "contact_count": 0,
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/lists/abc12312-x3y4-1234-abcd-123qwe456rty"
  }
}

{
  "errors": [
    {
      "error_id": "nisi dolore Lorem ea non",
      "field": "deserunt commodo",
      "message": "Lorem pariatur culpa nisi",
      "parameter": "minim ipsum veniam"
    },
    {
      "error_id": "amet",
      "field": "Ut est magna quis",
      "message": "elit veniam ut",
      "parameter": "mollit"
    }
  ]
}

{}

DELETE

/v3/marketing/lists/{id}

**This endpoint allows you to deletes a specific list.** Optionally, you can also delete contacts associated to the list. The query parameter, `delete_contacts=true`, will delete the list and start an asynchronous job to delete associated contacts.

Query Parameter Name	Example
`delete_contacts`	`false`

Request Payload

Response Payload

{
  "job_id": "abc12312-x3y4-1234-abcd-123qwe456rty"
}

occaecat in

{
  "errors": []
}

DELETE

/v3/marketing/lists/{id}/contacts

**This endpoint allows you to remove contacts from a given list.** The contacts will not be deleted. Only their list membership will be changed.

Query Parameter Name	Example
`contact_ids`*	`dolore ullamco sint`

Request Payload

Response Payload

{
  "job_id": "consequat nisi in voluptate"
}

{
  "error_id": "in nisi in",
  "field": "nisi minim consectetur exercitation dolor",
  "message": "elit in magna",
  "parameter": "cillum"
}

{
  "description": "If the specified list id does not exist. If the specified contact does not exist."
}

Custom Fields(4 operations)

POST

/v3/marketing/field_definitions

**This endpoint creates a new custom field definition.** Custom field definitions are created with the given `name` and `field_type`. Although field names are stored in a case-sensitive manner, all field names must be case-insensitively unique. This means you may create a field named `CamelCase` o

Request Payload

{
  "name": "custom_field_name",
  "field_type": "Text"
}

Response Payload

{
  "id": "a1_T",
  "name": "custom_field_name",
  "field_type": "Text",
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/field_definitions/a1_B"
  }
}

{
  "errors": [
    {
      "error_id": "id sed cupidatat",
      "field": "tempor eu non",
      "message": "mollit do deserunt magna sit",
      "parameter": "non"
    },
    {
      "error_id": "elit sit mollit consequat pariatur",
      "field": "ea sit",
      "message": "ipsum est",
      "parameter": "ea cillum aliqua minim"
    }
  ]
}

GET

/v3/marketing/field_definitions

**This endpoint retrieves all defined Custom Fields and Reserved Fields.**

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"
  }
}

PATCH

/v3/marketing/field_definitions/{custom_field_id}

**This endopoint allows you to update a defined Custom Field.** Only your Custom fields can be modified; Reserved Fields cannot be updated.

Request Payload

{
  "name": "new_custom_field_name"
}

Response Payload

{
  "id": "a1_T",
  "name": "custom_field_name",
  "field_type": "Text",
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/field_definitions/a1_B"
  }
}

{
  "errors": [
    {
      "error_id": "dolor consectetur ex aute do",
      "field": "esse incididunt ea eu",
      "message": "irure",
      "parameter": "amet elit"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "qui dolor",
      "field": "occaecat officia ea consectetur ad",
      "message": "laborum irure magna sed consequat",
      "parameter": "mollit anim sint enim laborum"
    },
    {
      "error_id": "anim",
      "field": "sunt aliquip ut laboris consequat",
      "message": "labore Excepteur et aliqua id",
      "parameter": "laborum et"
    },
    {
      "error_id": "enim",
      "field": "in esse",
      "message": "veniam cupidatat",
      "parameter": "anim aliquip"
    }
  ]
}

DELETE

/v3/marketing/field_definitions/{custom_field_id}

**This endpoint deletes a defined Custom Field.** You cand delete only Custom Fields; Reserved Fields cannot be deleted.

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "errors": [
    {
      "error_id": "in anim Ut fugiat in",
      "field": "ex in voluptate",
      "message": "qui exercitation nulla veniam",
      "parameter": "magna in laborum tempor proident"
    },
    {
      "error_id": "dolore cupidatat sint",
      "field": "pariatur",
      "message": "anim officia nulla in",
      "parameter": "anim"
    },
    {
      "error_id": "exercitation magna",
      "field": "elit consectetur",
      "message": "id",
      "parameter": "deserunt tempor in laboris elit"
    },
    {
      "error_id": "deserunt laboris adipisicing",
      "field": "mollit",
      "message": "minim occaecat",
      "parameter": "occaecat"
    },
    {
      "error_id": "qui",
      "field": "est",
      "message": "ipsum ut anim aliquip",
      "parameter": "aliquip"
    }
  ]
}

segmenting contacts(5 operations)

POST

/v3/marketing/segments

**This endpoint allows you to create a segment.**

Request Payload

{
  "name": "do in",
  "parent_list_id": "c28c93fc-103c-8683-d7fe-f1bed0753c35",
  "parent_list_ids": [
    "irure est",
    "veniam"
  ],
  "query_dsl": "fugiat dolor dolor aute"
}

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": "quis"
    },
    {
      "message": "officia veniam"
    },
    {
      "message": "consectetur dolor labore culpa qui"
    },
    {
      "message": "sunt labore aute dolore"
    },
    {
      "message": "commodo sint velit enim"
    }
  ]
}

GET

/v3/marketing/segments

**This endpoint allows you to retrieve a list of segments.** The query param `parent_list_ids` is treated as a filter. Any match will be returned. 0 matches will return a response code of 200 with an empty `results` array. `parent_list_ids` | `no_parent_list_id` | `result` -----------------:|:-

Query Parameter Name	Example
`parent_list_ids`	`dolor velit cupidatat ea qui`
`no_parent_list_id`	`false`

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": "laboris voluptate commodo fugiat"
    },
    {
      "message": "voluptate proident anim irure"
    },
    {
      "message": "in fugiat est nisi ad"
    },
    {
      "message": "elit aute nostrud enim"
    },
    {
      "message": "occaecat nulla id veniam Excepteur"
    }
  ]
}

GET

/v3/marketing/segments/{segment_id}

**This endpoint allows you to retrieve a single segment by ID.**

Query Parameter Name	Example
`query_json`	`true`

Request Payload

Response Payload

{
  "id": "3b049926-0a54-4a91-83f0-086ace63c530",
  "contacts_count": -83213117,
  "created_at": "voluptate sunt non fugiat",
  "sample_updated_at": "labore occaecat sunt enim",
  "updated_at": "sunt aliqui",
  "contacts_sample": [
    {
      "contact_id": "e70eac25-1431-4231-bccd-1cfab432301e",
      "primary_email": "KLTF@SurgGzlAxCPOqhOUHYNBLsfpfE.trh",
      "alternate_emails": [
        "dTeJZgU5uN9UYSo@nfIB.ijxg"
      ],
      "first_name": "ullamco esse culpa do",
      "last_name": "officia laboris veniam consequat",
      "address_line_1": "in occaecat labore est tempor",
      "address_line_2": "magna adipisicing",
      "city": "ƞó",
      "state_province_region": "culpa ut",
      "postal_code": -75218567,
      "country": "voluptate in in reprehenderit aliquip",
      "custom_fields": {
        "custom_field_name1": "amet deserunt mollit",
        "custom_field_name2": "minim consequat id"
      }
    },
    {
      "contact_id": "db637d33-bce1-462c-ae9c-91ec4f761de6",
      "primary_email": "t7N5TjDmKhC0@gfdifW.ua",
      "alternate_emails": [
        "gQol@Xcfilli.hc",
        "n4K7OdaVQh@YfsnF.ie",
        "TdnvS3nMStREn@miFjGzNDCPZWhiswJNxrFnOYdUAZEpesQ.yxpu",
        "xRzGDTTzzbYK@eJ.wpgb",
        "iI1rOpx2ct@aZhuYGZBxJLZ.phr"
      ],
      "first_name": "ea et eu",
      "last_name": "velit Ut laborum ipsu",
      "address_line_1": "labore",
      "address_line_2": "non",
      "city": "ĔȸąÂ¸ȠɏbɄ",
      "state_province_region": "deserunt dolore",
      "postal_code": -95171713,
      "country": "do",
      "list_ids": [
        "c712288b-2300-4069-bef4-2e05b5948ec3",
        "9003ef29-5eb7-4951-898b-1b102e490d6e"
      ]
    }
  ],
  "name": "enim et anim",
  "query_dsl": "nostrud"
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "magna minim nostrud Ut",
      "message": "occaecat"
    },
    {
      "field": "ad consectetur",
      "message": "aute Ut ad minim adipisicing"
    },
    {
      "field": "magna non fugiat cillum dolor",
      "message": "magna fugiat in aliquip est"
    }
  ]
}

{
  "errors": [
    {
      "message": "voluptate amet id commodo"
    },
    {
      "message": "nisi do"
    },
    {
      "message": "do eu sint exercitation"
    }
  ]
}

PATCH

/v3/marketing/segments/{segment_id}

**This endpoint allows you to update a segment.** Segment `name` needs to be unique. A user can not update a segment name to an existing one.

Request Payload

{
  "name": "eiusmod reprehenderit",
  "parent_list_ids": [
    "cillum ea id",
    "labore cillum ullamco amet sit"
  ],
  "query_dsl": "occaecat dolore"
}

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": "ǲƐȹŲǆ",
      "state_province_region": "occaecat",
      "postal_code": -19694583,
      "country": "reprehenderit",
      "custom_fields": {
        "custom_field_name1": "dolor aute irure Excepteur"
      },
      "list_ids": [
        "ffd225a8-2008-4457-87af-1cffff5b1ccb"
      ]
    },
    {
      "contact_id": "449767ca-d446-45f1-aa9b-432f441b5ca1",
      "primary_email": "kF4@gYYdAxzetJrWszLAHuBUTu.rzq",
      "alternate_emails": [
        "ksqbx6BInlB@ouWBjjxwFBwVQjdnEKXy.xi",
        "TAe7F2m8dFlF@SirYykzbe.aj",
        "T9c2Y@HjVQY.zz",
        "p7ShfET@vMMnTUqoqngPSEqbpyoeWN.jlqn",
        "0VJSIhIUT2k@mJXVtdZVKKswW.xoca"
      ],
      "first_name": "irure laboris minim",
      "last_name": "id nostrud aliqua sit",
      "address_line_1": "dolor",
      "address_line_2": "elit ex labore sunt aliquip",
      "city": "ÝǘźƝǝƉƝ",
      "state_province_region": "nostrud Duis non nulla laborum",
      "postal_code": 60466925,
      "country": "id sunt nisi",
      "custom_fields": {
        "custom_field_name2": "enim quis",
        "custom_field_name1": "amet"
      },
      "list_ids": [
        "2870627c-b9ea-4dcf-bde0-36c3e0e3eca9",
        "575d86aa-4dcc-4b7d-b7de-ded856913198",
        "fb82a17f-5777-439d-9b8c-2c565c8ddf20"
      ]
    }
  ],
  "name": "List Name",
  "query_dsl": "Email LIKE %twilio.com"
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "voluptate aute",
      "message": "in elit"
    },
    {
      "field": "proident dolore",
      "message": "occaecat"
    }
  ]
}

{
  "errors": [
    {
      "message": "reprehenderit et sit cupidatat"
    },
    {
      "message": "id amet"
    },
    {
      "message": "exercitation sint"
    }
  ]
}

DELETE

/v3/marketing/segments/{segment_id}

**This endpoint allows you to delete a segment by `segment_id`.** Note that deleting a segment does not delete the contacts associated with the segment by default. Contacts associated with a deleted segment will remain in your list of all contacts and any other segments they belong to.

Request Payload

Response Payload

{}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "nostrud culpa labore",
      "message": "irure do enim"
    },
    {
      "field": "adipisicing officia elit",
      "message": "nulla ad dolor"
    },
    {
      "field": "nulla in eu",
      "message": "in aliquip magna"
    },
    {
      "field": "ex qui do",
      "message": "sint"
    },
    {
      "field": "ipsum qui eiusmod",
      "message": "Duis tempor"
    }
  ]
}

{
  "errors": [
    {
      "message": "anim in eu laboris deserunt"
    },
    {
      "message": "velit"
    },
    {
      "message": "Ut culpa nisi non consequat"
    }
  ]
}

Segmenting Contacts

POST

/v3/marketing/segments/delete

This endpoint allows you to delete segments in bulk. If the segments are used by automations or the segments do not exist in the database, the segment IDs that could not be deleted along with automation IDs that are associated to those segments will be returned.

Request Payload

{
  "ids": [
    "a14dcc63-d651-4c57-9826-4a3705f5c78d",
    "f3de551e-dc5c-4d42-bd08-c7f87f87f0e8",
    "1b8107b5-adf4-401c-8865-fa84ba178fb9",
    "d7900715-c904-4728-acff-9ab79627579e",
    "16641f5b-cfa3-41b9-9626-244488ee85b1"
  ]
}

Response Payload

{
  "errors": [
    {
      "error": "dolor eu",
      "id": "ex",
      "resources": {
        "ids": [
          "cupidatat cillum"
        ],
        "type": "irure adipisicing eiusmod sunt"
      }
    }
  ]
}

{}

{
  "errors": [
    {
      "field": "sed in sunt",
      "message": "et in nostrud"
    },
    {
      "field": "occaecat",
      "message": "Duis ut dolore sunt ullamco"
    },
    {
      "field": "ut",
      "message": "et proident"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "message": "eiusmod in"
    },
    {
      "message": "quis nostrud dolore"
    }
  ]
}

Single Sends(11 operations)

POST

/v3/marketing/singlesends

**This endpoint allows you to create a new Single Send.** Please note that if you are migrating from the previous version of Single Sends, you no longer need to pass a template ID with your request to this endpoint. Instead, you will pass all template data in the `email_config` object.

Request Payload

{
  "name": "Example API Created Single Send",
  "categories": [
    "unique opens"
  ],
  "send_to": {
    "all": true
  },
  "email_config": {
    "design_id": "<your-design-id>",
    "editor": "design",
    "suppression_group_id": 12345,
    "sender_id": 1234567
  }
}

Response Payload

{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}

{
  "errors": [
    {
      "error_id": "Ut nulla",
      "field": "id minim sunt ut",
      "message": "commodo"
    },
    {
      "error_id": "nisi",
      "field": "do et cillum",
      "message": "ut proident"
    },
    {
      "error_id": "eu",
      "field": "laboris eu cillum",
      "message": "ut deserunt quis"
    },
    {
      "error_id": "aliquip labore cillum nisi",
      "field": "ut sint Lorem laborum",
      "message": "occaecat"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "sunt minim quis mollit eu",
      "field": "sit",
      "message": "laborum magna"
    }
  ]
}

GET

/v3/marketing/singlesends

**This endpoint allows you to retrieve all your Single Sends.** Returns all of your Single Sends with condensed details about each, including the Single Sends' IDs. For more details about an individual Single Send, pass the Single Send's ID to the `/marketing/singlesends/{id}` endpoint.

Query Parameter Name	Example
`page_size`	`-25939349`
`page_token`	`aliquip ut id`

Request Payload

Response Payload

{
  "_metadata": {
    "count": 20968290,
    "next": "http://DTpGtkkXMIKFsaKoStoLDRLzG.zmyoHu94oA,XlRMWn,NvuGIqHAEuucM3mbA-4Y4Bzb.YMl4L-AiBqyxmcOx0Mo9yCOqrz",
    "prev": "https://EBd.kcgyurWx",
    "self": "https://opftQDq.mugszprXUNoUj3,iALGy"
  },
  "result": [
    {
      "abtest": {
        "duration": "officia consequat do velit dolore",
        "expiration_date": "consequat culpa ullamco dolor",
        "test_percentage": 72628948,
        "type": "content",
        "winner_criteria": "click",
        "winner_selected_at": "id aute laborum",
        "winning_template_id": "esse veniam qui"
      },
      "categories": [
        "ipsum quis esse ea",
        "deserunt velit aliqua Excepteur",
        "dolore sed elit",
        "dolor",
        "elit consequat",
        "Ut",
        "pariatur esse dolor",
        "dolore ut",
        "laborum Ut dolore occaecat",
        "non pariatur ullamco ad irure"
      ],
      "created_at": "1949-01-20T09:34:47.0Z",
      "id": "6cc518bf-7a4c-3c7a-0f21-abb60edf5f7a",
      "is_abtest": false,
      "name": "culpa laboris",
      "send_at": "1899-02-14T08:41:44.0Z",
      "status": "triggered",
      "updated_at": "1963-11-20T02:38:57.0Z"
    },
    {
      "abtest": null,
      "categories": [
        "cillum ut",
        "nisi officia ad esse",
        "eu",
        "Ut ipsum deserunt ea id",
        "commodo",
        "qui in nostrud",
        "sed est eu dolore",
        "amet",
        "mollit dolore in culpa",
        "minim enim"
      ],
      "created_at": "1899-11-13T03:54:10.0Z",
      "id": "ca7691b3-a141-1fec-4314-3defd286a431",
      "is_abtest": false,
      "name": "aliqua cillum laborum officia",
      "send_at": "1901-08-15T07:44:30.0Z",
      "status": "draft",
      "updated_at": "1895-10-26T08:20:02.0Z"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "quis officia eu consectetur",
      "field": "id in dolore reprehenderit",
      "message": "commodo"
    },
    {
      "error_id": "ullamco cillum voluptate",
      "field": "nostrud Excepteur consectetur exercitation sed",
      "message": "pariatur ut reprehenderit id"
    },
    {
      "error_id": "Excepteur nostrud Ut",
      "field": "qui velit labore dolore",
      "message": "ut nostrud reprehenderit"
    },
    {
      "error_id": "dolor nisi officia elit enim",
      "field": "consectetur",
      "message": "ad voluptate in culpa"
    },
    {
      "error_id": "ad est labore Excepteur",
      "field": "culpa in nulla",
      "message": "reprehenderit esse Excepteur nisi"
    }
  ]
}

DELETE

/v3/marketing/singlesends

**This endpoint allows you to delete multiple Single Sends using an array of Single Sends IDs.** To first retrieve all your Single Sends' IDs, you can make a GET request to the `/marketing/singlensends` endpoint. Please note that a DELETE request is permanent, and your Single Sends will not be re

Query Parameter Name	Example
`ids`	`["minim aute ut do","enim sunt minim aute","consequat veniam dolor Excepteur reprehenderit","commodo anim qui","id","Lorem nisi","officia laborum","exercitation cupidatat irure","ad nulla tempor ullamco","veniam et ullamco aliquip"]`

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "errors": [
    {
      "error_id": "eiusmod do officia veniam",
      "field": "culpa",
      "message": "Lorem"
    },
    {
      "error_id": "Duis nostrud est",
      "field": "dolore ea do",
      "message": "aute deserunt sint"
    },
    {
      "error_id": "eu laborum sint aute",
      "field": "est ut nisi",
      "message": "exercitation sit"
    },
    {
      "error_id": "magna eiusmod incididunt",
      "field": "Ut et deserunt",
      "message": "fugiat minim"
    },
    {
      "error_id": "anim eiusmod",
      "field": "minim qui deserunt",
      "message": "nisi amet et"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "Excepteur laborum",
      "field": "quis qui esse",
      "message": "voluptate minim veniam est"
    },
    {
      "error_id": "anim",
      "field": "occaecat labore Lorem deserunt laboris",
      "message": "sed in tempor"
    },
    {
      "error_id": "minim irure Lorem elit",
      "field": "ullamco ea quis incididunt",
      "message": "pariatur sed"
    }
  ]
}

POST

/v3/marketing/singlesends/{id}

**This endpoint allows you to duplicate an existing Single Send using its Single Send ID.** Duplicating a Single Send is useful when you want to create a Single Send but don't want to start from scratch. Once duplicated, you can update or edit the Single Send by making a PATCH request to the `/mar

Request Payload

{
  "name": "dolor"
}

Response Payload

{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}

{
  "errors": [
    {
      "error_id": "aliqua ex anim eiusmod",
      "field": "laborum in deserunt",
      "message": "consectetur Excepteur nostrud voluptate elit"
    },
    {
      "error_id": "deserunt non laborum consequat irure",
      "field": "nisi sunt",
      "message": "Excepteur officia nulla"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "in cillum",
      "field": "consectetur",
      "message": "deserunt dolore esse ex cupidatat"
    },
    {
      "error_id": "irure ut",
      "field": "do",
      "message": "id culpa"
    },
    {
      "error_id": "eiusmod mollit",
      "field": "esse pariatur magna ullamco",
      "message": "ad velit"
    },
    {
      "error_id": "sed cillum elit commodo laborum",
      "field": "sit Excepteur minim",
      "message": "occaecat sunt adipisicing dolor labore"
    },
    {
      "error_id": "ipsum adipisicing",
      "field": "deserunt in cupidatat in",
      "message": "nulla"
    }
  ]
}

PATCH

/v3/marketing/singlesends/{id}

**This endpoint allows you to update a Single Send using a Single Send ID.** You only need to pass the fields you want to update. Any blank/missing fields will remain unaltered.

Request Payload

{
  "categories": [
    "pariatur",
    "Duis",
    "nisi dolore",
    "tempor id ea",
    "aute",
    "id qui anim incididunt quis",
    "occaecat ex id eu",
    "aliqua dolore",
    "Duis sint nulla cupidatat dolor",
    "in magna ad est"
  ],
  "email_config": {
    "custom_unsubscribe_url": null,
    "design_id": "in",
    "editor": "code",
    "generate_plain_content": true,
    "html_content": "in ut Duis ad non",
    "ip_pool": null,
    "plain_content": "Ut non occaecat",
    "sender_id": 90893701,
    "subject": "proident",
    "suppression_group_id": 1339864
  },
  "name": "ut reprehenderit dolor",
  "send_at": "1932-02-20T11:24:52.0Z",
  "send_to": {
    "all": false,
    "list_ids": [
      "db6eeb0b-940b-e33c-1fcb-a95ce2295d71",
      "a2e78fa2-70f4-1660-b6e0-d597c65b0595",
      "5e047150-dce1-2426-cedb-43edf5fa29db",
      "cbf623e7-8f37-c2c1-48a7-075ea018e57f",
      "5557ebbb-d99b-ecc6-07d4-f3b3f915af4d",
      "978c28ac-f9ca-f12c-b4ad-232c75c1eecf",
      "ee8ff5d1-37a2-5993-dd98-3d0e9372d600",
      "db80e57b-5373-c789-1956-f19e064aa90d",
      "ffbb1801-5397-1b9f-6cde-b11252b54671",
      "574f8aff-603a-4cb5-7922-af1ef6bfbd06"
    ],
    "segment_ids": [
      "b9bbc53a-7633-67d4-19b4-2ddef003fc19",
      "1eff8603-2aad-70cb-236f-e3fad706608a",
      "3228b9ee-f726-3229-bb68-6990c1c32e4f",
      "ce72f2fd-1c76-110a-c82e-6435c149c23a",
      "d4ae672f-b973-ef15-400f-42e9cae652b1",
      "8cb31158-1c6e-f117-aff3-17261bb2921d",
      "669d93e7-1461-f95e-4115-d58d0aabe189",
      "b98eaf76-0555-b9d3-021a-c8f8377e375c",
      "6142258e-b7be-11b0-9724-c563c0ab1082",
      "4a3a44af-1cb1-7493-dddf-10ccc5cf12f6"
    ]
  }
}

Response Payload

{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}

{
  "errors": [
    {
      "error_id": "incididunt minim",
      "field": "sed in et dolore",
      "message": "adipisicing eu labore quis"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "dolore exercitation",
      "field": "reprehenderit irure voluptate",
      "message": "dolore"
    },
    {
      "error_id": "id fugiat",
      "field": "veniam tempor aliqua",
      "message": "Duis magna"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "elit ex incididunt",
      "field": "non ullamco minim cillum",
      "message": "sint in dolore"
    },
    {
      "error_id": "laboris",
      "field": "ea tempor officia sunt",
      "message": "quis laboris id amet"
    },
    {
      "error_id": "nulla culpa",
      "field": "reprehenderit",
      "message": "non in tempor occaecat reprehenderit"
    },
    {
      "error_id": "in ad",
      "field": "ex non enim labore sed",
      "message": "pariatur in laborum Duis anim"
    }
  ]
}

GET

/v3/marketing/singlesends/{id}

**This endpoint allows you to retrieve details about one Single Send using a Single Send ID.** You can retrieve all of your Single Sends by making a GET request to the `/marketing/singlesends` endpoint.

Request Payload

Response Payload

{
  "name": "single-send-1",
  "id": "2f6dec81-43b9-4c67-a890-3a38cb63b54a",
  "status": "scheduled",
  "created_at": "2020-12-13T16:24:42.013Z",
  "send_to": {
    "segment_ids": [
      "dad84de3-bec4-4e04-b132-2cbfd4bb3789",
      "7dce758d-1155-4102-88d2-ca65565ac98b"
    ],
    "all": true
  }
}

{
  "errors": [
    {
      "error_id": "ut fugiat sit",
      "field": "ipsum ad nostrud aliquip",
      "message": "labore"
    },
    {
      "error_id": "minim irure Lorem",
      "field": "mollit",
      "message": "reprehenderit aliquip cillum amet"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "veniam adipisicing ullamco",
      "field": "incididunt enim proident officia occaecat",
      "message": "magna id minim"
    },
    {
      "error_id": "dolor aute non reprehenderit",
      "field": "elit tempor eu voluptate eiusmod",
      "message": "minim in reprehenderit mollit"
    },
    {
      "error_id": "nulla ea id",
      "field": "ullamco pariatur est",
      "message": "irure reprehenderit Ut"
    }
  ]
}

DELETE

/v3/marketing/singlesends/{id}

**This endpoint allows you to delete one Single Send using a Single Send ID.** To first retrieve all your Single Sends' IDs, you can make a GET request to the `/marketing/singlensends` endpoint. Please note that a `DELETE` request is permanent, and your Single Send will not be recoverable after d

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

{
  "errors": [
    {
      "error_id": "dolore deserunt veniam anim",
      "field": "incididunt",
      "message": "eu ea sed irure"
    },
    {
      "error_id": "aliqua aute Ut",
      "field": "ullamco Ut qui in aliquip",
      "message": "aliquip culpa ad"
    },
    {
      "error_id": "magna irure elit",
      "field": "nisi",
      "message": "dolore cupidatat in ex"
    },
    {
      "error_id": "exercitation laboris consequat proident",
      "field": "commodo",
      "message": "qui ut est anim"
    },
    {
      "error_id": "ad est",
      "field": "sed cupidatat laborum Ut",
      "message": "sint incididunt officia"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "fugiat ullamco ad laborum labore",
      "field": "ea cillum voluptate",
      "message": "do cillum ut"
    }
  ]
}

POST

/v3/marketing/singlesends/search

**This endpoint allows you to search for Single Sends based on specified criteria.** You can search for Single Sends by passing a combination of values using the `name`, `status`, and `categories` request body fields. For example, if you want to search for all Single Sends that are "drafts" or "s

Query Parameter Name	Example
`page_size`	`-96336397`
`page_token`	`sint qui consequat eiusmod laboris`

Request Payload

{
  "name": "specific-single-send-name",
  "status": [
    "draft",
    "scheduled"
  ],
  "categories": [
    "shoes"
  ]
}

Response Payload

{
  "result": [
    {
      "id": "df25ffdf-6a96-458a-9419-6d87d3094c6b",
      "name": "single-send-1",
      "status": "triggered",
      "categories": [
        "shoes"
      ],
      "is_abtest": true,
      "updated_at": "3263-04-09T09:05:08.193Z",
      "created_at": "4739-10-29T07:11:32.476Z",
      "send_at": "2471-05-31T15:46:18.797Z"
    }
  ],
  "_metadata": {
    "self": "nwNSrPSWt7d",
    "prev": "P0Enoayd",
    "next": "DYEsTUDww9-",
    "count": 1
  }
}

{
  "errors": [
    {
      "error_id": "non",
      "field": "aute sed adipisicing",
      "message": "sit laborum"
    }
  ]
}

PUT

/v3/marketing/singlesends/{id}/schedule

**This endpoint allows you to schedule a Single Send for future delivery using a Single Send ID.** To schedule a Single Send, you must pass a date string in ISO 8601 time format (yyyy-MM-ddTHH:mm:ssZ) using the required `send_at` field. For example, the ISO 8601 format for 9:00 AM UTC on May 6, 2

Request Payload

{
  "send_at": "3752-01-28T23:21:52.575Z"
}

Response Payload

{
  "send_at": "3752-01-28T23:21:52.575Z",
  "status": "scheduled"
}

{
  "errors": [
    {
      "error_id": "anim mollit sit",
      "field": "sit veniam nulla sint",
      "message": "laborum cupidatat dolore ipsum nisi"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "sint dolor velit",
      "field": "ut id aliqua velit",
      "message": "dolor sunt cupidatat"
    },
    {
      "error_id": "dolore amet consectetur voluptate",
      "field": "culpa pariatur voluptate",
      "message": "id proident dolor magna"
    },
    {
      "error_id": "dolor nulla deserunt labore veniam",
      "field": "ut labore reprehenderit",
      "message": "voluptate dolor consectetur"
    }
  ]
}

DELETE

/v3/marketing/singlesends/{id}/schedule

**This endpoint allows you to cancel a scheduled Single Send using a Single Send ID.** Making a DELETE request to this endpoint will cancel the scheduled sending of a Single Send. The request will not delete the Single Send itself. Deleting a Single Send can be done by passing a DELETE request to

Request Payload

Response Payload

{
  "send_at": "1900-08-04T11:02:06.0Z",
  "status": "scheduled"
}

{
  "errors": [
    {
      "error_id": "ullamco minim occaecat",
      "field": "nulla",
      "message": "dolor exercitation"
    },
    {
      "error_id": "in Duis deserunt nulla irure",
      "field": "in reprehenderit cupidatat ut",
      "message": "veniam aute"
    },
    {
      "error_id": "dolor id minim",
      "field": "eu",
      "message": "Excepteur"
    },
    {
      "error_id": "adipisicing",
      "field": "aliquip quis Duis est",
      "message": "culpa velit elit ea"
    },
    {
      "error_id": "laborum elit labore proident commodo",
      "field": "voluptate eiusmod sunt labore dolor",
      "message": "quis elit et ex"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "sed",
      "field": "labore eiusmod elit pariatur",
      "message": "in"
    },
    {
      "error_id": "quis Excepteur eiusmod ipsum",
      "field": "sunt in Lorem",
      "message": "nostrud anim"
    },
    {
      "error_id": "occaecat",
      "field": "consectetur laborum exercitation",
      "message": "in"
    },
    {
      "error_id": "quis amet tempor sint sunt",
      "field": "minim",
      "message": "id ipsum qui nostrud"
    }
  ]
}

GET

/v3/marketing/singlesends/categories

**This endpoint allows you to retrieve all the categories associated with your Single Sends.** This endpoint will return your latest 1,000 categories.

Request Payload

Response Payload

{
  "categories": [
    "equipment",
    "shoes",
    "sports"
  ]
}

{
  "errors": [
    {
      "error_id": "nulla",
      "field": "amet in laborum Excepteur velit",
      "message": "nulla eiusmod"
    }
  ]
}

Send Test Email

POST

/v3/marketing/test/send_email

**This endpoint allows you to send a test marketing email to a list of email addresses**. Before sending a marketing message, you can test it using this endpoint. You may specify up to **10 contacts** in the `emails` request body field. You must also specify a `template_id` and include either a `f

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)

GET

/v3/marketing/stats/automations

**This endpoint allows you to retrieve stats for all your Automations.** By default, all of your Automations will be returned, but you can specify a selection by passing in a comma-separated list of Automation IDs as the value of the query string parameter `automation_ids`. Responses are paginate

Query Parameter Name	Example
`automation_ids`	`["incididunt anim labore dolore aute","sunt dolor veniam","elit labore","non aliqua Excepteur dolore","sint ullamco incididunt irure","reprehenderit","dolore ea est Lorem sunt","non nostrud aliqua","quis velit","dolor aute dolore minim in"]`
`page_size`	`95`
`page_token`	`exercitation occaecat dolore`

Request Payload

Response Payload

{
  "_metadata": {
    "count": 41242698.502426535,
    "next": "http://NFsTpQPsTqNRqKNFVXDhKjlfkclkcijIA.grHs29jo+en1yDQA",
    "prev": "http://HRwVEmvFEHIzRzvErKoxxU.mveagwk9P",
    "self": "http://ywwgzEeKrJttT.sppinos2Cv468vhZpkKPwEJHIpKqBjHSER+v+Jjr"
  },
  "results": [
    {
      "aggregation": "sed labore occaecat",
      "id": "feea5f85-40a7-7ab5-1b92-6a543d90e582",
      "stats": {
        "bounce_drops": 24393603,
        "bounces": 71351013,
        "clicks": 38344931,
        "delivered": 78059973,
        "invalid_emails": 47744201,
        "opens": -54298559,
        "requests": -37422780,
        "spam_report_drops": 30585141,
        "spam_reports": -68893557,
        "unique_clicks": -50938183,
        "unique_opens": -88832734,
        "unsubscribes": 85695002
      },
      "step_id": "Ut officia sunt voluptate"
    },
    {
      "aggregation": "elit est Ut laborum nulla",
      "id": "72372ab2-0058-ebcb-6acd-270d3d3a7e89",
      "stats": {
        "bounce_drops": -56719105,
        "bounces": 78498460,
        "clicks": -62031081,
        "delivered": 79634266,
        "invalid_emails": 68973138,
        "opens": -25689831,
        "requests": 21503928,
        "spam_report_drops": -8648141,
        "spam_reports": -79079892,
        "unique_clicks": -3972648,
        "unique_opens": -12934254,
        "unsubscribes": -60411641
      },
      "step_id": "sunt officia"
    },
    {
      "aggregation": "ipsum veniam Ut id ullamco",
      "id": "70a90b1d-45d5-a055-d98b-a7779ca3898b",
      "stats": {
        "bounce_drops": 5434584,
        "bounces": -98153124,
        "clicks": 2594472,
        "delivered": -48618132,
        "invalid_emails": 49727380,
        "opens": 74347523,
        "requests": -92510691,
        "spam_report_drops": -50362661,
        "spam_reports": 35040560,
        "unique_clicks": -16715313,
        "unique_opens": 85588340,
        "unsubscribes": 85421167
      },
      "step_id": "eu nostrud irure"
    },
    {
      "aggregation": "pariatur",
      "id": "36a440a3-d20a-bad7-4f82-d9e89c425003",
      "stats": {
        "bounce_drops": -31070985,
        "bounces": -11812284,
        "clicks": -42932120,
        "delivered": 51753735,
        "invalid_emails": -56034572,
        "opens": 51034337,
        "requests": 1090681,
        "spam_report_drops": 38495325,
        "spam_reports": -96473022,
        "unique_clicks": 6161551,
        "unique_opens": 49514300,
        "unsubscribes": 47517026
      },
      "step_id": "fugiat"
    },
    {
      "aggregation": "adipisicing",
      "id": "14c93762-80d0-4470-57a2-89dfd94cd4bf",
      "stats": {
        "bounce_drops": 26704045,
        "bounces": -6191047,
        "clicks": -99235348,
        "delivered": -41591401,
        "invalid_emails": 67320338,
        "opens": -30208903,
        "requests": 35357741,
        "spam_report_drops": -3075492,
        "spam_reports": -66720057,
        "unique_clicks": -2798720,
        "unique_opens": 89812199,
        "unsubscribes": 58990414
      },
      "step_id": "enim"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

GET

/v3/marketing/stats/automations/{id}

**This endpoint allows you to retrieve stats for a single Automation using its ID.** Multiple Automation IDs can be retrieved using the "Get All Automation Stats" endpoint. Once you have an ID, this endpoint will return detailed stats for the single automation specified. You may constrain the sta

Query Parameter Name	Example
`group_by`	`["step_id","step_id"]`
`step_ids`	`["f09231b1-3391-8a10-2865-25d532776288","91826a81-b7a2-5f83-c49b-1a70af4f47e2","6e787105-03a6-06e9-8484-685508fdcbd9"]`
`aggregated_by`	`total`
`start_date`	`1951-03-14`
`end_date`	`1901-02-01`
`timezone`	`deserunt laboris veniam cupidatat dolore`
`page_size`	`11`
`page_token`	`culpa commodo voluptate anim dolor`

Request Payload

Response Payload

{
  "_metadata": {
    "count": 50266452.05714494,
    "next": "https://pXuFohImHjGzYMpYroQesSGBbk.bcw0JHxuv9Q+G1Anb2Ib0Es",
    "prev": "http://mBDLLoooMwjAAchSHWw.ykqxjllMUyM1",
    "self": "http://SNcgwSeAordhuXHmAJzrvqjihK.tmyE-WHwiu0hPafz5H-,,Fquu93W3dAGqUTAOg6-sulpX+PY4ED1q3k-m6AujqbJ"
  },
  "results": [
    {
      "aggregation": "laboris",
      "id": "93ef67ff-1eb7-2951-a724-d33b44f487ce",
      "stats": {
        "bounce_drops": 55708923,
        "bounces": 42201445,
        "clicks": 4922556,
        "delivered": -50557755,
        "invalid_emails": 31221607,
        "opens": 32439880,
        "requests": 98915290,
        "spam_report_drops": 82758802,
        "spam_reports": 93895935,
        "unique_clicks": -46411745,
        "unique_opens": 52786124,
        "unsubscribes": -44094545
      },
      "step_id": "incididunt in elit ex"
    },
    {
      "aggregation": "dolore elit",
      "id": "5cedc5de-9604-53ea-eb14-950951a854ee",
      "stats": {
        "bounce_drops": -72374888,
        "bounces": 79764207,
        "clicks": 14276393,
        "delivered": -14649222,
        "invalid_emails": 7092988,
        "opens": 80746723,
        "requests": 78355516,
        "spam_report_drops": 39620845,
        "spam_reports": 33090901,
        "unique_clicks": 28850788,
        "unique_opens": -86217234,
        "unsubscribes": 56365264
      },
      "step_id": "sunt consectetur officia enim non"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

GET

/v3/marketing/stats/singlesends

**This endpoint allows you to retrieve stats for all your Single Sends.** By default, all of your Single Sends will be returned, but you can specify a selection by passing in a comma-separated list of Single Send IDs as the value of the query string parameter `singlesend_ids`. Responses are pagin

Query Parameter Name	Example
`singlesend_ids`	`["aliqua reprehenderit","cupidatat","non sunt","Lorem nostrud dolor","ut ad","sunt do minim in","mollit occaecat","cupidatat sunt aliqua exercitation","adipisicing est ex","fugiat mollit ea ut"]`
`page_size`	`28`
`page_token`	`exercitation commodo laboris in cillum`

Request Payload

Response Payload

{
  "_metadata": {
    "count": 32994039.375612423,
    "next": "https://BXcqzrnBORtOVqcrSLfn.vutglltXqK8e3APuD",
    "prev": "http://vKAXNKooZHapcQxBNXjTjFLNRiuPC.puqJ4IwhXuteXNhXK4rZcpBhqjXqUn3Fl1AqhACsC3YZomwjcAvUXFnY5yF2Rnfv",
    "self": "http://nRBfyNHMLiILTKYLgUtiwYfFMGcA.zzySkT1P9KoNiNv6Jm+Ie4L5NR"
  },
  "results": [
    {
      "ab_phase": "send",
      "ab_variation": "08140507-639f-f2cb-9210-75d03adc4422",
      "aggregation": "sunt mollit",
      "id": "66ea23a5-8819-a423-7672-6904a40bb418",
      "stats": {
        "bounce_drops": 82439631,
        "bounces": -65231741,
        "clicks": 27587447,
        "delivered": 13077644,
        "invalid_emails": 61619067,
        "opens": -64450087,
        "requests": -92551496,
        "spam_report_drops": -98795697,
        "spam_reports": -60579009,
        "unique_clicks": 7954567,
        "unique_opens": -47630835,
        "unsubscribes": -17666778
      }
    },
    {
      "ab_phase": "all",
      "ab_variation": "6e6e2cad-3a90-f90f-98e9-0b5cf2f7c126",
      "aggregation": "incididunt ex",
      "id": "a06a2ba0-b196-9bbc-5a8b-b4b3f9130e5e",
      "stats": {
        "bounce_drops": -82900939,
        "bounces": 26493709,
        "clicks": 22553686,
        "delivered": 53645038,
        "invalid_emails": 85371965,
        "opens": -72917318,
        "requests": 59790731,
        "spam_report_drops": 96261170,
        "spam_reports": -6627768,
        "unique_clicks": -21782687,
        "unique_opens": -62305471,
        "unsubscribes": 64715804
      }
    },
    {
      "ab_phase": "send",
      "ab_variation": "bb754b15-4870-35da-a092-657daabcf023",
      "aggregation": "Ut",
      "id": "730f8ec5-a6cf-3580-0196-412ec5b68ad0",
      "stats": {
        "bounce_drops": -44175525,
        "bounces": 21751580,
        "clicks": 29536926,
        "delivered": 5342906,
        "invalid_emails": 98917529,
        "opens": -37694139,
        "requests": 22430424,
        "spam_report_drops": 69637371,
        "spam_reports": -35402916,
        "unique_clicks": -54869969,
        "unique_opens": -14574384,
        "unsubscribes": -96891992
      }
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

GET

/v3/marketing/stats/singlesends/{id}

**This endpoint allows you to retrieve stats for an individual Single Send using a Single Send ID.** Multiple Single Send IDs can be retrieved using the "Get All Single Sends Stats" endpoint. Once you have an ID, this endpoint will return detailed stats for the Single Send specified. You may cons

Query Parameter Name	Example
`aggregated_by`	`total`
`start_date`	`1928-05-21`
`end_date`	`1921-07-12`
`timezone`	`aliqua dolor ut id ex`
`page_size`	`89`
`page_token`	`nostrud id eu`
`group_by`	`["ab_variation","ab_variation","ab_variation"]`

Request Payload

Response Payload

{
  "_metadata": {
    "count": -66067495.44867978,
    "next": "http://egHqpEMnXMeBlfmU.cjxs4kCYuXg0fsipRdE,5ZXob-,QDUygNb6.XnNsegRsS",
    "prev": "http://rpQGj.bfUV2fohcWOtqTUL6o0LCc8UbBnP5uh9Rr85",
    "self": "http://TOUQRPkCKyXTpeOwicjdUlqzpVyUZvKF.oempz.NThb1rsK.WeEoaOTJK.HOb.0ixqRs"
  },
  "results": [
    {
      "ab_phase": "test",
      "ab_variation": "6e8adad4-ca48-deac-e441-c5c672acbb3f",
      "aggregation": "eiusmod Ut Duis",
      "id": "9cc73b25-bded-78aa-4dfb-264f53076f78",
      "stats": {
        "bounce_drops": -96809663,
        "bounces": 45692266,
        "clicks": 3715235,
        "delivered": -72946808,
        "invalid_emails": -37553122,
        "opens": -90190068,
        "requests": 43020677,
        "spam_report_drops": 27688863,
        "spam_reports": -9446897,
        "unique_clicks": 29700577,
        "unique_opens": -60149982,
        "unsubscribes": 52776297
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "ae582c8f-6498-a8c4-5841-cdfc7a434c7f",
      "aggregation": "in in eiusmod id ipsum",
      "id": "7cae9391-e2ef-0713-1332-7076f268d971",
      "stats": {
        "bounce_drops": -32428963,
        "bounces": -93215642,
        "clicks": 39749907,
        "delivered": 43497945,
        "invalid_emails": 30314222,
        "opens": -41683999,
        "requests": 34071214,
        "spam_report_drops": -71556192,
        "spam_reports": -15143254,
        "unique_clicks": -42172527,
        "unique_opens": 50144646,
        "unsubscribes": 37837916
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "8a72e368-5c11-4a18-c857-ff8f24bc8614",
      "aggregation": "mollit",
      "id": "cec603e3-e025-cd09-048a-63cd07e52a26",
      "stats": {
        "bounce_drops": -67515579,
        "bounces": 22738146,
        "clicks": 92301828,
        "delivered": -25697155,
        "invalid_emails": -1695685,
        "opens": -36780371,
        "requests": -71797299,
        "spam_report_drops": -29590006,
        "spam_reports": -55812567,
        "unique_clicks": 15204714,
        "unique_opens": 9162501,
        "unsubscribes": 46314040
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "887f5fb3-fe5e-b519-a539-ec5356478022",
      "aggregation": "velit est esse Ut",
      "id": "73e881ac-bc7a-2e1f-5875-bb8de474047c",
      "stats": {
        "bounce_drops": -17357989,
        "bounces": -67678189,
        "clicks": 94755810,
        "delivered": -42994342,
        "invalid_emails": -49185278,
        "opens": -63742658,
        "requests": 16903185,
        "spam_report_drops": -39181591,
        "spam_reports": 19389993,
        "unique_clicks": -62286642,
        "unique_opens": -37141229,
        "unsubscribes": -83065380
      }
    },
    {
      "ab_phase": "send",
      "ab_variation": "4ce72520-ae6a-cb89-77aa-e387570dfbd7",
      "aggregation": "mollit id ea",
      "id": "5fe63f0f-d91c-c4ff-7687-6bff2cf6d438",
      "stats": {
        "bounce_drops": -47556227,
        "bounces": 18160500,
        "clicks": -4990275,
        "delivered": -3709302,
        "invalid_emails": -58345865,
        "opens": 42271676,
        "requests": 71622953,
        "spam_report_drops": 96596852,
        "spam_reports": 16108792,
        "unique_clicks": -92644682,
        "unique_opens": -8338644,
        "unsubscribes": 74588314
      }
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

GET

/v3/marketing/stats/automations/{id}/links

**This endpoint lets you retrieve click-tracking stats for a single Automation**. The stats returned list the URLs embedded in your Automation and the number of clicks each one received. Responses are paginated. You can limit the number of responses returned per batch using the `page_size` query

Query Parameter Name	Example
`group_by`	`["step_id","step_id","step_id","step_id","step_id"]`
`step_ids`	`["929ec1f2-61cf-8973-c8d2-d56b2c174eb3","d252e8f2-fae0-5157-99b5-4fd66f5e3f8d","3d5528cd-32ca-46b5-3903-8e8160a89f76","dd4e2488-3e6c-937f-29a4-9e2c8257c292"]`
`page_size`	`55`
`page_token`	`cillum`

Request Payload

Response Payload

{
  "_metadata": {
    "count": 49173695.606271744,
    "next": "http://wSgdYTyNMQxrOHiXe.yxbTV-IzG,",
    "prev": "http://VMpjzdoABdosfLZHXxwkTaEHbv.jgcfS8m2SoqtnA5NOIiGuvPnJ98dq5FtKCgFUR5kPnA,K",
    "self": "https://XziCNjFXNGjrRMcZuNIJrZGdWinaoXGn.vienp6W0o+"
  },
  "results": [
    {
      "clicks": 78694665,
      "step_id": "045043fa-89c0-553b-58a8-23631a061746",
      "url": "https://MKMsckynSASqdqfH.ngzrIbXaAWwW+vEM7INRk1LyOnaBZs,3z5ZFTtpHs9eFDiMkJlRLHNP7gDs",
      "url_location": 33183550
    },
    {
      "clicks": 47764513,
      "step_id": "a49ce557-2e23-31ce-8dcc-036285c56585",
      "url": "https://VVpZxbQsPEjCMmRWJqDysEaUVL.chtsFODgKjf",
      "url_location": 43470256
    },
    {
      "clicks": 97575022,
      "step_id": "a81b544b-de1b-6c08-74e7-32b5d9898d0f",
      "url": "https://lzxcvgYdLJccHlWmB.vtqzwHtpy0O7mn93oX0UvgX",
      "url_location": 66221020
    },
    {
      "clicks": 41030789,
      "step_id": "a7dbe51a-5d06-4c29-6aa8-b0062d449fdb",
      "url": "http://BIBzQkVWkFXXFJKZAVDSAGHdgIRXTKe.lwnatGvlBoohNQb0ZXZ3D",
      "url_location": 65418293
    },
    {
      "clicks": 78593590,
      "step_id": "a5c4d276-3682-e36f-baf0-a8f1a163af3d",
      "url": "https://ofli.vpNsNMFMoVL+Yb+Wh1MrTxl93nxSmvjy8HOdf9Qk+ERWK",
      "url_location": 83687658
    }
  ],
  "total_clicks": -30752009
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

GET

/v3/marketing/stats/singlesends/{id}/links

**This endpoint lets you retrieve click-tracking stats for one Single Send**. The stats returned list the URLs embedded in the specified Single Send and the number of clicks each one received. Responses are paginated. You can limit the number of responses returned per batch using the `page_size`

Query Parameter Name	Example
`page_size`	`50`
`page_token`	`in`
`group_by`	`["ab_phase","ab_phase","ab_phase"]`
`ab_variation_id`	`c4eb4ece-d294-fb59-f09a-61edb6e2be92`
`ab_phase_id`	`send`

Request Payload

Response Payload

{
  "_metadata": {
    "count": 94321833.74800646,
    "next": "https://DrjFSLwZMrTVsY.iuanRkDNudoxXbdK1mi6CR",
    "prev": "http://bKHMk.tjiq8m",
    "self": "http://fzEjMY.qrpe528CIa0E8VkbFCsg9mGQMXr"
  },
  "results": [
    {
      "ab_phase": "all",
      "ab_variation": "5f3d1978-5a56-3f39-33eb-3709981eb381",
      "clicks": 27409503,
      "url": "https://ylKjyBKVCONAFr.fmzdTnulj0VJYG",
      "url_location": 5176312
    },
    {
      "ab_phase": "all",
      "ab_variation": "d128bb05-1d4c-952f-6dd0-8ababff7ded6",
      "clicks": 24429867,
      "url": "http://bactXope.nxiwz0OWW8CkntpKP0NUdRKPKg7GIwiJqnueH96HIsa3rU",
      "url_location": 56883671
    },
    {
      "ab_phase": "send",
      "ab_variation": "38be958c-c84b-5e93-38c8-34d78f6f247e",
      "clicks": 53783896,
      "url": "https://RMcAONvXhlUCsCwuOdGzDuDarmnzpa.incR62xkMClZ-cfLD",
      "url_location": 42351830
    },
    {
      "ab_phase": "all",
      "ab_variation": "75117555-6731-15d0-4f0e-1dffb4712c00",
      "clicks": 40880557,
      "url": "http://AXKxnpWkWDNI.swgfG+ufeAK",
      "url_location": 17212094
    },
    {
      "ab_phase": "all",
      "ab_variation": "4f72ec5f-20f3-cf02-12ba-bdea5533cad6",
      "clicks": 80904727,
      "url": "http://OobBhePDVKbLdFcj.wxlzpAiUaVgY.imF4c8o1beIT,7aABA",
      "url_location": 68758264
    }
  ],
  "total_clicks": -12278651
}

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

{}

GET

/v3/marketing/stats/singlesends/export

**This endpoint allows you to export Single Send stats as .CSV data**. You can specify one Single Send or many: include as many Single Send IDs as you need, separating them with commas, as the value of the `ids` query string paramter. The data is returned as plain text response but in .CSV format

Query Parameter Name	Example
`ids`	`["deserunt dolor laboris","Lorem voluptate","sit ullamco ut ea consequat","mollit","ipsum voluptate ex consequat Excepteur","occaecat velit proident dolore","reprehenderit fugiat","ut consequat tempor laborum","dolore non in cupidatat sint","occaecat"]`
`timezone`	`incididunt eiusmod ex`

Request Payload

Response Payload

Duis

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

GET

/v3/marketing/stats/automations/export

**This endpoint allows you to export Automation stats as CSV data**. You can specify one Automation or many: include as many Automation IDs as you need, separating them with commas, as the value of the `ids` query string paramter. The data is returned as plain text response but in CSV format, so

Query Parameter Name	Example
`ids`	`["ad ea minim","minim","Excepteur dolore occaecat Ut aliquip","voluptate","dolor amet","ad ea sed ipsum pariatur","in aliqua cupidatat culpa","sunt dolore eiusmod","ex consectetur aliquip irure","ut"]`
`timezone`	`in culpa irure`

Request Payload

Response Payload

id et

{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Sender Identities API(6 operations)

POST

/v3/senders

**This endpoint allows you to create a new sender identity.** You may create up to 100 unique sender identities.

Header Name	Example
`on-behalf-of`	`"esse in eiusmod qui"`

Request Payload

{
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States"
}

Response Payload

{
  "id": 1,
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States",
  "verified": true,
  "updated_at": 1449872165,
  "created_at": 1449872165,
  "locked": false
}

{
  "errors": [
    {
      "message": "The JSON you have submitted cannot be parsed.",
      "field": ""
    },
    {
      "message": "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"
    }
  ]
}

GET

/v3/senders

**This endpoint allows you to retrieve a list of all sender identities that have been created for your account.**

Header Name	Example
`on-behalf-of`	`"magna reprehenderit in"`

Request Payload

Response Payload

{
  "result": [
    {
      "id": 1,
      "nickname": "My Sender ID",
      "from": {
        "email": "from@example.com",
        "name": "Example INC"
      },
      "reply_to": {
        "email": "replyto@example.com",
        "name": "Example INC"
      },
      "address": "123 Elm St.",
      "address_2": "Apt. 456",
      "city": "Denver",
      "state": "Colorado",
      "zip": "80202",
      "country": "United States",
      "verified": true,
      "updated_at": 1449872165,
      "created_at": 1449872165,
      "locked": false
    }
  ]
}

GET

/v3/senders/{sender_id}

**This endpoint allows you to retrieve a specific sender identity.**

Header Name	Example
`on-behalf-of`	`"ut ex Ut dolor"`

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"
    }
  ]
}

PATCH

/v3/senders/{sender_id}

**This endpoint allows you to update a sender identity.** Updates to `from.email` require re-verification. Partial updates are allowed, but fields that are marked as "required" in the POST (create) endpoint must not be nil if that field is included in the PATCH request.

Header Name	Example
`on-behalf-of`	`"elit"`

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"
    }
  ]
}

DELETE

/v3/senders/{sender_id}

**This endoint allows you to delete one of your sender identities.**

Header Name	Example
`on-behalf-of`	`"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"
    }
  ]
}

POST

/v3/senders/{sender_id}/resend_verification

**This enpdoint allows you to resend a sender identity verification email.**

Header Name	Example
`on-behalf-of`	`"eiusmod in"`

Request Payload

Response Payload

{}

{
  "errors": [
    {
      "message": "The Sender Identity is already verified.  No email sent.",
      "field": ""
    }
  ]
}

{
  "errors": [
    {
      "message": "resource not found",
      "field": "id"
    }
  ]
}

Contacts API - Lists(10 operations)

POST

/v3/contactdb/lists

**This endpoint allows you to create a list for your recipients.**

Header Name	Example
`on-behalf-of`	`"cupidatat"`

Request Payload

{
  "name": "your list name"
}

Response Payload

{
  "id": 1,
  "name": "your list name",
  "recipient_count": 0
}

{
  "errors": [
    {
      "field": null,
      "message": "Returned if request body is invalid JSON"
    },
    {
      "field": "name",
      "message": "Returned if list name is not a string"
    },
    {
      "field": "name",
      "message": "Returned if list name is a duplicate of an existing list or segment"
    }
  ]
}

{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

GET

/v3/contactdb/lists

**This endpoint allows you to retrieve all of your recipient lists. If you don't have any lists, an empty array will be returned.**

Header Name	Example
`on-behalf-of`	`"incididunt nulla laboris"`

Request Payload

Response Payload

{
  "lists": [
    {
      "id": 1,
      "name": "the jones",
      "recipient_count": 1
    }
  ]
}

DELETE

/v3/contactdb/lists

**This endpoint allows you to delete multiple recipient lists.**

Header Name	Example
`on-behalf-of`	`"velit ea deserunt"`

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"
    }
  ]
}

GET

/v3/contactdb/lists/{list_id}

**This endpoint allows you to retrieve a single recipient list.**

Query Parameter Name	Example
`list_id`	`-66222118`

Header Name	Example
`on-behalf-of`	`"proident"`

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"
    }
  ]
}

PATCH

/v3/contactdb/lists/{list_id}

**This endpoint allows you to update the name of one of your recipient lists.**

Query Parameter Name	Example
`list_id`*	`-23887738`

Header Name	Example
`on-behalf-of`	`"enim"`

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"
    }
  ]
}

DELETE

/v3/contactdb/lists/{list_id}

**This endpoint allows you to delete a specific recipient list with the given ID.**

Query Parameter Name	Example
`delete_contacts`	`false`

Header Name	Example
`on-behalf-of`	`"ullamco adipisicing sint culpa"`

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"
    }
  ]
}

GET

/v3/contactdb/lists/{list_id}/recipients

**This endpoint allows you to retrieve all recipients on the list with the given ID.**

Query Parameter Name	Example
`page`	`-10564445`
`page_size`	`84664169`
`list_id`*	`-71810109`

Header Name	Example
`on-behalf-of`	`"in in voluptate nulla aliqua"`

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"
    }
  ]
}

POST

/v3/contactdb/lists/{list_id}/recipients

**This endpoint allows you to add multiple recipients to a list.** Adds existing recipients to a list, passing in the recipient IDs to add. Recipient IDs should be passed exactly as they are returned from recipient endpoints.

Header Name	Example
`on-behalf-of`	`"labore ea qui Duis"`

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"
    }
  ]
}

POST

/v3/contactdb/lists/{list_id}/recipients/{recipient_id}

**This endpoint allows you to add a single recipient to a list.**

Header Name	Example
`on-behalf-of`	`"magna velit incididunt"`

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"
    }
  ]
}

DELETE

/v3/contactdb/lists/{list_id}/recipients/{recipient_id}

**This endpoint allows you to delete a single recipient from a list.**

Query Parameter Name	Example
`list_id`*	`-23923335`
`recipient_id`*	`40497477`

Header Name	Example
`on-behalf-of`	`"dolor exercitation officia adipisicing esse"`

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)

POST

/v3/contactdb/recipients

**This endpoint allows you to add a Marketing Campaigns recipient.** You can add custom field data as a parameter on this endpoint. We have provided an example using some of the default custom fields SendGrid provides. The rate limit is three requests every 2 seconds. You can upload 1000 contact

Header Name	Example
`on-behalf-of`	`"non sunt commodo"`

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"
    }
  ]
}

PATCH

/v3/contactdb/recipients

**This endpoint allows you to update one or more recipients.** The body of an API call to this endpoint must include an array of one or more recipient objects. It is of note that you can add custom field data as parameters on recipient objects. We have provided an example using some of the defaul

Header Name	Example
`on-behalf-of`	`"irure qui reprehenderit"`

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"
    }
  ]
}

DELETE

/v3/contactdb/recipients

**This endpoint allows you to deletes one or more recipients.** The body of an API call to this endpoint must include an array of recipient IDs of the recipients you want to delete.

Header Name	Example
`on-behalf-of`	`"aute sint esse consectetur enim"`

Request Payload

[
  "recipient_id1",
  "recipient_id2"
]

Response Payload

{}

{
  "errors": [
    {
      "message": "No recipient ids provided"
    }
  ]
}

{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

GET

/v3/contactdb/recipients

**This endpoint allows you to retrieve all of your Marketing Campaigns recipients.** Batch deletion of a page makes it possible to receive an empty page of recipients before reaching the end of the list of recipients. To avoid this issue; iterate over pages until a 404 is retrieved.

Query Parameter Name	Example
`page`	`17560416`
`page_size`	`-51310524`

Header Name	Example
`on-behalf-of`	`"id dolor reprehenderit laboris"`

Request Payload

Response Payload

{
  "recipients": []
}

{}

{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

GET

/v3/contactdb/status

**This endpoint allows you to check the upload status of a Marketing Campaigns recipient.**

Header Name	Example
`on-behalf-of`	`"qui fugiat ad in sed"`

Request Payload

Response Payload

{
  "status": [
    {
      "id": "worker_delay",
      "value": "delayed"
    },
    {
      "id": "worker_delay_seconds",
      "value": "75.0"
    }
  ]
}

GET

/v3/contactdb/recipients/{recipient_id}

**This endpoint allows you to retrieve a single recipient by ID from your contact database.**

Header Name	Example
`on-behalf-of`	`"cupidatat veniam"`

Request Payload

Response Payload

{
  "recipients": [
    {
      "created_at": 42712956.74742225,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "hueyUV@hTMTuGpBxoxKdaOhepeCRpsrBGwTof.xvvl",
      "first_name": null,
      "id": "pariatur aute",
      "last_clicked": -35631445.15509053,
      "last_emailed": null,
      "last_name": "commodo",
      "last_opened": -77931215.08509028,
      "updated_at": -89054649.50321673
    },
    {
      "created_at": -43231733.40141322,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "8BB-M5kU7x@Bmy.fm",
      "first_name": "elit minim irure ullamco dolor",
      "id": "nulla consequat",
      "last_clicked": -59875005.03565202,
      "last_emailed": -95458046.69389138,
      "last_name": "occaecat Lorem enim minim",
      "last_opened": 40402117.58540115,
      "updated_at": 33481217.665019393
    },
    {
      "created_at": -83683104.27464412,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "4OQkgSHCouSlf5c@mHwNLciDNGNmUXwwcuTfNnLxwnFBNv.algw",
      "first_name": "quis amet reprehenderit",
      "id": "Lorem",
      "last_clicked": -64959254.57511014,
      "last_emailed": null,
      "last_name": "aute non culpa",
      "last_opened": null,
      "updated_at": 83087842.79907474
    },
    {
      "created_at": 4029062.4967756867,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "EsWDdo@BurtWYLeaMuHMWiMxJMZcifYsj.jgj",
      "first_name": null,
      "id": "ut",
      "last_clicked": null,
      "last_emailed": null,
      "last_name": "occaecat ex anim",
      "last_opened": null,
      "updated_at": -30741613.905788958
    },
    {
      "created_at": -32051495.04825045,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "YiN1@RpTFvww.git",
      "first_name": null,
      "id": "labore",
      "last_clicked": -33655015.924248755,
      "last_emailed": 74135008.1648227,
      "last_name": "irure labore",
      "last_opened": null,
      "updated_at": 75727936.46015939
    }
  ]
}

{}

{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

{}

DELETE

/v3/contactdb/recipients/{recipient_id}

**This endpoint allows you to delete a single recipient with the given ID from your contact database.** > Use this to permanently delete your recipients from all of your contact lists and all segments if required by applicable law.

Header Name	Example
`on-behalf-of`	`"eu velit consequat nostrud 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"
    }
  ]
}

GET

/v3/contactdb/recipients/{recipient_id}/lists

**This endpoint allows you to retrieve the lists that a given recipient belongs to.** Each recipient can be on many lists. This endpoint gives you all of the lists that any one recipient has been added to.

Header Name	Example
`on-behalf-of`	`"qui in aute proident in"`

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"
    }
  ]
}

GET

/v3/contactdb/recipients/billable_count

**This endpoint allows you to retrieve the number of Marketing Campaigns recipients that you will be billed for.** You are billed for marketing campaigns based on the highest number of recipients you have had in your account at one time. This endpoint will allow you to know the current billable co

Header Name	Example
`on-behalf-of`	`"Excepteur aliquip ad consequat"`

Request Payload

Response Payload

{
  "recipient_count": 1234
}

{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

GET

/v3/contactdb/recipients/count

**This endpoint allows you to retrieve the total number of Marketing Campaigns recipients.**

Header Name	Example
`on-behalf-of`	`"pariatur in sunt"`

Request Payload

Response Payload

{
  "recipient_count": 1234
}

{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

GET

/v3/contactdb/recipients/search

**This endpoint allows you to perform a search on all of your Marketing Campaigns recipients.** field_name: * is a variable that is substituted for your actual custom field name from your recipient. * Text fields must be url-encoded. Date fields are searchable only by unix timestamp (e.g. 2/2/201

Query Parameter Name	Example
`{field_name}`	`nostrud qui adipisicing aute ea`

Header Name	Example
`on-behalf-of`	`"dolore esse"`

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"
    }
  ]
}

POST

/v3/contactdb/recipients/search

<p> Search using segment conditions without actually creating a segment. Body contains a JSON object with <code>conditions</code>, a list of conditions as described below, and an optional <code>list_id</code>, which is a valid list ID for a list to limit the search on. </p> <p> Valid operato

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)

POST

/v3/contactdb/custom_fields

**This endpoint allows you to create a custom field.** **You can create up to 120 custom fields.**

Header Name	Example
`on-behalf-of`	`"consequat nisi"`

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"
    }
  ]
}

GET

/v3/contactdb/custom_fields

**This endpoint allows you to retrieve all custom fields.**

Header Name	Example
`on-behalf-of`	`"sed"`

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"
    }
  ]
}

GET

/v3/contactdb/custom_fields/{custom_field_id}

**This endpoint allows you to retrieve a custom field by ID.**

Header Name	Example
`on-behalf-of`	`"ullamco"`

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"
    }
  ]
}

DELETE

/v3/contactdb/custom_fields/{custom_field_id}

**This endpoint allows you to delete a custom field by ID.**

Header Name	Example
`on-behalf-of`	`"sed"`

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"
    }
  ]
}

GET

/v3/contactdb/reserved_fields

**This endpoint allows you to list all fields that are reserved and can't be used for custom field names.**

Header Name	Example
`on-behalf-of`	`"culpa sed eu"`

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)

POST

/v3/contactdb/segments

**This endpoint allows you to create a new segment.** Valid operators for create and update depend on the type of the field for which you are searching. **Dates** - "eq", "ne", "lt" (before), "gt" (after) - You may use MM/DD/YYYY for day granularity or an epoch for second granularity. - "e

Header Name	Example
`on-behalf-of`	`"aute Excepteur quis ut"`

Request Payload

{
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    },
    {
      "field": "last_clicked",
      "value": "01/02/2015",
      "operator": "gt",
      "and_or": "and"
    },
    {
      "field": "clicks.campaign_identifier",
      "value": "513",
      "operator": "eq",
      "and_or": "or"
    }
  ]
}

Response Payload

{
  "id": 1,
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    },
    {
      "field": "last_clicked",
      "value": "01/02/2015",
      "operator": "gt",
      "and_or": "and"
    },
    {
      "field": "clicks.campaign_identifier",
      "value": "513",
      "operator": "eq",
      "and_or": "or"
    }
  ],
  "recipient_count": 0
}

{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}

{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

GET

/v3/contactdb/segments

**This endpoint allows you to retrieve all of your segments.**

Header Name	Example
`on-behalf-of`	`"in ut laborum"`

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"
    }
  ]
}

GET

/v3/contactdb/segments/{segment_id}

**This endpoint allows you to retrieve a single segment with the given ID.**

Query Parameter Name	Example
`segment_id`*	`-73660149`

Header Name	Example
`on-behalf-of`	`"quis mollit sint enim dolor"`

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"
    }
  ]
}

PATCH

/v3/contactdb/segments/{segment_id}

**This endpoint allows you to update a segment.**

Query Parameter Name	Example
`segment_id`	`est Ut in pariatur culpa`

Header Name	Example
`on-behalf-of`	`"ullamco"`

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"
    }
  ]
}

DELETE

/v3/contactdb/segments/{segment_id}

**This endpoint allows you to delete a segment from your recipients database.** You also have the option to delete all the contacts from your Marketing Campaigns recipient database who were in this segment.

Query Parameter Name	Example
`delete_contacts`	`true`

Header Name	Example
`on-behalf-of`	`"labore aliqua nostrud ut"`

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"
    }
  ]
}

GET

/v3/contactdb/segments/{segment_id}/recipients

**This endpoint allows you to retrieve all of the recipients in a segment with the given ID.**

Query Parameter Name	Example
`page`	`72991688`
`page_size`	`12878350`

Header Name	Example
`on-behalf-of`	`"officia anim"`

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)

GET

/v3/categories

**This endpoint allows you to retrieve a list of all of your categories.**

Query Parameter Name	Example
`limit`	`81594618`
`category`	`sunt adipisicing`
`offset`	`-93859970`

Header Name	Example
`on-behalf-of`	`"occaecat Duis veniam"`

Request Payload

Response Payload

[
  {
    "category": "category 1"
  },
  {
    "category": "category 2"
  }
]

{
  "errors": [
    {
      "field": "sort_by",
      "message": "invalid sort value"
    }
  ]
}

GET

/v3/categories/stats/sums

**This endpoint allows you to retrieve the total sum of each email statistic for every category over the given date range.** If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.

Query Parameter Name	Example
`sort_by_metric`	`Ut enim eu veniam`
`sort_by_direction`	`asc`
`start_date`*	`dolore nisi est`
`end_date`	`culpa officia dolor aliqua`
`limit`	`95854861`
`offset`	`-71146614`
`aggregated_by`	`day`

Header Name	Example
`on-behalf-of`	`"sed consequat deserunt consectetur pariatur"`

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"
    }
  ]
}

GET

/v3/categories/stats

**This endpoint allows you to retrieve all of your email statistics for each of your categories.** If you do not define any query parameters, this endpoint will return a sum for each category in groups of 10.

Query Parameter Name	Example
`start_date`*	`nisi ullamco cupidatat proident`
`end_date`	`amet`
`categories`*	`minim elit sed occaecat Lorem`
`limit`	`-60331539`
`offset`	`55595213`
`aggregated_by`	`month`

Header Name	Example
`on-behalf-of`	`"dolor quis amet ea"`

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)

POST

/v3/campaigns

**This endpoint allows you to create a campaign.** In order to send or schedule the campaign, you will be required to provide a subject, sender ID, content (we suggest both html and plain text), and at least one list or segment ID. This information is not required when you create a campaign.

Header Name	Example
`on-behalf-of`	`"sed ullamco 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."
    }
  ]
}

{}

GET

/v3/campaigns

**This endpoint allows you to retrieve a list of all of your campaigns.** Returns campaigns in reverse order they were created (newest first). Returns an empty array if no campaigns exist.

Query Parameter Name	Example
`limit`	`51727234`
`offset`	`65133567`

Header Name	Example
`on-behalf-of`	`"id dolore"`

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"
    }
  ]
}

GET

/v3/campaigns/{campaign_id}

**This endpoint allows you to retrieve a specific campaign.**

Header Name	Example
`on-behalf-of`	`"pariatur dolore cupidatat eu"`

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"
    }
  ]
}

DELETE

/v3/campaigns/{campaign_id}

**This endpoint allows you to delete a specific campaign.**

Header Name	Example
`on-behalf-of`	`"ea tempor"`

Request Payload

Response Payload

Error generating example

{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

{}

PATCH

/v3/campaigns/{campaign_id}

**This endpoint allows you to update a specific campaign.** This is especially useful if you only set up the campaign using POST /campaigns, but didn't set many of the parameters.

Header Name	Example
`on-behalf-of`	`"laborum tempor sed"`

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"
    }
  ]
}

POST

/v3/campaigns/{campaign_id}/schedules/now

**This endpoint allows you to immediately send an existing campaign.** Normally a POST request would have a body, but since this endpoint is telling us to send a resource that is already created, a request body is not needed.

Header Name	Example
`on-behalf-of`	`"cillum"`

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"
    }
  ]
}

POST

/v3/campaigns/{campaign_id}/schedules

**This endpoint allows you to schedule a specific date and time for your campaign to be sent.** If you have the flexibility, it's better to schedule mail for off-peak times. Most emails are scheduled and sent at the top of the hour or half hour. Scheduling email to avoid those times (for example,

Header Name	Example
`on-behalf-of`	`"amet"`

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"
    }
  ]
}

PATCH

/v3/campaigns/{campaign_id}/schedules

**This endpoint allows to you change the scheduled time and date for a campaign to be sent.**

Header Name	Example
`on-behalf-of`	`"proident minim"`

Request Payload

{
  "send_at": 1489451436
}

Response Payload

{
  "id": -17047057,
  "send_at": -66910650,
  "status": "ea"
}

{
  "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"
    }
  ]
}

GET

/v3/campaigns/{campaign_id}/schedules

**This endpoint allows you to retrieve the date and time that a campaign has been scheduled to be sent.**

Header Name	Example
`on-behalf-of`	`"sed aute"`

Request Payload

Response Payload

{
  "send_at": 1490778528
}

{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}

DELETE

/v3/campaigns/{campaign_id}/schedules

**This endpoint allows you to unschedule a campaign that has already been scheduled to be sent.** A successful unschedule will return a 204. If the specified campaign is in the process of being sent, the only option is to cancel (a different method).

Header Name	Example
`on-behalf-of`	`"enim sint adipisicing"`

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"
    }
  ]
}

POST

/v3/campaigns/{campaign_id}/schedules/test

**This endpoint allows you to send a test campaign.** To send to multiple addresses, use an array for the JSON "to" value ["one@address","two@address"]

Header Name	Example
`on-behalf-of`	`"sed"`

Request Payload

{
  "to": "your.email@example.com"
}

Response Payload

{
  "to": "minim pariatur reprehenderit"
}

{
  "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)

POST

/v3/templates

**This endpoint allows you to create a transactional template.**

Header Name	Example
`on-behalf-of`	`"reprehenderit laborum sint"`

Request Payload

{
  "name": "example_name",
  "generation": "dynamic"
}

Response Payload

{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "example_name",
  "generation": "legacy",
  "versions": []
}

GET

/v3/templates

**This endpoint allows you to retrieve all transactional templates.**

Query Parameter Name	Example
`generations`	`legacy`
`page_size`*	`14.409310806316446`
`page_token`	`adipisicing laborum sed`

Header Name	Example
`on-behalf-of`	`"officia"`

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": [
    {
      "": "eiusmod in",
      "error_id": "nulla occaecat",
      "message": "quis veniam"
    }
  ]
}

POST

/v3/templates/{template_id}

**This endpoint allows you to duplicate a transactional template.**

Header Name	Example
`on-behalf-of`	`"deserunt sint esse commodo"`

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": []
}

GET

/v3/templates/{template_id}

**This endpoint allows you to retrieve a single transactional template.**

Header Name	Example
`on-behalf-of`	`"laborum pariatur ex aliqua in"`

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": []
}

PATCH

/v3/templates/{template_id}

**This endpoint allows you to edit the name of a transactional template.** To edit the template itself, [create a new transactional template version](https://sendgrid.api-docs.io/v3.0/transactional-templates-versions/create-a-new-transactional-template-version).

Header Name	Example
`on-behalf-of`	`"dolor dolore anim aliquip"`

Request Payload

{
  "name": "new_example_name"
}

Response Payload

{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "new_example_name",
  "versions": []
}

DELETE

/v3/templates/{template_id}

**This endpoint allows you to delete a transactional template.**

Header Name	Example
`on-behalf-of`	`"adipisicing"`

Request Payload

Response Payload

{}

Transactional Templates Versions(5 operations)

POST

/v3/templates/{template_id}/versions

**This endpoint allows you to create a new version of a template.**

Header Name	Example
`on-behalf-of`	`"velit minim"`

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"
}

POST

/v3/templates/{template_id}/versions/{version_id}/activate

**This endpoint allows you to activate a version of one of your templates.**

Header Name	Example
`on-behalf-of`	`"dolor elit consectetur amet"`

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"
}

GET

/v3/templates/{template_id}/versions/{version_id}

**This endpoint allows you to retrieve a specific version of a template.**

Header Name	Example
`on-behalf-of`	`"cillum elit ad Lorem"`

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"
}

PATCH

/v3/templates/{template_id}/versions/{version_id}

**This endpoint allows you to edit the content of your template version.**

Header Name	Example
`on-behalf-of`	`"officia deserunt tempor"`

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"
}

DELETE

/v3/templates/{template_id}/versions/{version_id}

**This endpoint allows you to delete a transactional template version.**

Header Name	Example
`on-behalf-of`	`"nisi ut"`

Request Payload

Response Payload

Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

Webhooks(7 operations)

GET

/v3/user/webhooks/event/settings

**This endpoint allows you to retrieve your current event webhook settings.** If an event type is marked as `true`, then the event webhook will include information about that event. SendGrid’s Event Webhook will notify a URL of your choice via HTTP POST with information about events that occur as

Header Name	Example
`on-behalf-of`	`"elit aliquip esse"`

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"
}

PATCH

/v3/user/webhooks/event/settings

**This endpoint allows you to update your current event webhook settings.** If an event type is marked as `true`, then the event webhook will include information about that event. SendGrid’s Event Webhook will notify a URL of your choice via HTTP POST with information about events that occur as S

Header Name	Example
`on-behalf-of`	`"mollit exercitation id"`

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"
}

GET

/v3/user/webhooks/parse/settings

**This endpoint allows you to retrieve all of your current inbound parse settings.**

Header Name	Example
`on-behalf-of`	`"cupidatat deserunt in nostrud ea"`

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": "occaecat"
    },
    {
      "message": "velit voluptate minim aute tempor"
    },
    {
      "message": "in nisi ea aliquip"
    }
  ]
}

GET

/v3/user/webhooks/parse/stats

**This endpoint allows you to retrieve the statistics for your Parse Webhook useage.** SendGrid's Inbound Parse Webhook allows you to parse the contents and attachments of incomming emails. The Parse API can then POST the parsed emails to a URL that you specify. The Inbound Parse Webhook cannot pa

Query Parameter Name	Example
`limit`	`eiusmod quis`
`offset`	`in dolore non anim et`
`aggregated_by`	`day`
`start_date`*	`in`
`end_date`	`et`

Header Name	Example
`on-behalf-of`	`"in dolore nisi fugiat ullamco"`

Request Payload

Response Payload

[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  }
]

GET

/v3/user/webhooks/event/settings/signed

**This endpoint allows you to retrieve your signed webhook's public key.** Once you have enabled signing of the Event Webhook, you will need the public key provided to verify the signatures on requests coming from Twilio SendGrid. You can retrieve the public key from this endpoint at any time. Fo

Header Name	Example
`on-behalf-of`	`"cillum Excepteur"`

Request Payload

Response Payload

{
  "public_key": "anim quis in sint"
}

PATCH

/v3/user/webhooks/event/settings/signed

**This endpoint allows you to enable or disable signing of the Event Webhook.** This endpoint takes a single boolean request parameter, `enabled`. You may either enable or disable signing of the Event Webhook using this endpoint. Once enabled, you can retrieve your public key using the `/webhooks/

Header Name	Example
`on-behalf-of`	`"ea"`

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"
    }
  ]
}

POST

/v3/user/webhooks/event/test

**This endpoint allows you to test your event webhook by sending a fake event notification post to the provided URL.** SendGrid’s Event Webhook will notify a URL of your choice via HTTP POST with information about events that occur as SendGrid processes your email. Common uses of this data are to

Header Name	Example
`on-behalf-of`	`"do in amet"`

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)

POST

/v3/user/webhooks/parse/settings

**This endpoint allows you to create a new inbound parse setting.** Creating an Inbound Parse setting requires two pieces of information: a `url` and a `hostname`. The `hostname` must correspond to a domain authenticated by Twilio SendGrid on your account. If you need to complete domain authentic

Header Name	Example
`on-behalf-of`	`"dolore dolore Excepteur in"`

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": "labore magna"
    },
    {
      "message": "dolore"
    },
    {
      "message": "anim eiusmod"
    },
    {
      "message": "qui exercitation non eu tempor"
    },
    {
      "message": "fugiat elit velit"
    }
  ]
}

GET

/v3/user/webhooks/parse/settings/{hostname}

**This endpoint allows you to retrieve a specific inbound parse setting by hostname.** You can retrieve all your Inbound Parse settings and their associated host names with the "Retrieve all parse settings" endpoint.

Header Name	Example
`on-behalf-of`	`"et aliqua"`

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": "fugiat reprehenderit"
    },
    {
      "message": "ex esse enim"
    },
    {
      "message": "elit deserunt nulla"
    },
    {
      "message": "aute"
    },
    {
      "message": "voluptate dolor dolor"
    }
  ]
}

PATCH

/v3/user/webhooks/parse/settings/{hostname}

**This endpoint allows you to update a specific inbound parse setting by hostname.** You can retrieve all your Inbound Parse settings and their associated host names with the "Retrieve all parse settings" endpoint.

Header Name	Example
`on-behalf-of`	`"nostrud velit ipsum ut eiusmod"`

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": "dolor occaecat"
    },
    {
      "message": "ut minim nulla ex"
    },
    {
      "message": "eu dolor fugiat"
    }
  ]
}

DELETE

/v3/user/webhooks/parse/settings/{hostname}

**This endpoint allows you to delete a specific inbound parse setting by hostname.** You can retrieve all your Inbound Parse settings and their associated host names with the "Retrieve all parse settings" endpoint.

Header Name	Example
`on-behalf-of`	`"ea adipisicing exercitation nisi"`

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": "culpa nulla quis dolore do"
    }
  ]
}

Query(2 operations)

GET

/v3/messages

This is **BETA** functionality. You may not have access, and we reserve the right to change functionality without notice. Filter all messages to search your Email Activity. All queries need to be [URL encoded](https://meyerweb.com/eric/tools/dencoder/), and have this format: `query={query_type}="

Query Parameter Name	Example
`query`*	`id dolor est`
`limit`	`938.4059628656753`

Header Name	Example
`X-Query-Id`	`"nostrud ex minim sunt"`
`X-Cursor`	`"quis pariatur"`
`Authorization`*	`"dolore exercitation ad"`

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"
    }
  ]
}

GET

/v3/messages/{msg_id}

This is BETA functionality. You may not have access, and we reserve the right to change functionality without notice. Get all of the details about the specified message.

Header Name	Example
`Authorization`*	`"dolore"`

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)

POST

/v3/messages/download

This is BETA functionality. You may not have access, and we reserve the right to change functionality without notice. This request will kick off a backend process to generate a CSV file. Once generated, the worker will then send an email for the user download the file. The link will expire in 3 da

Query Parameter Name	Example
`query`	`ad`

Header Name	Example
`Authorization`*	`"velit fugiat"`

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"
    }
  ]
}

GET

/v3/messages/download/{download_uuid}

**This endpoint will return a presigned URL that can be used to download the CSV that was requested from the "Request a CSV" endpoint.**

Header Name	Example
`Authorization`*	`"deserunt enim ut do"`

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)

GET

/v3/tracking_settings

**This endpoint allows you to retrieve a list of all tracking settings on your account.**

Header Name	Example
`on-behalf-of`	`"mollit sit"`

Request Payload

Response Payload

{
  "result": [
    {
      "name": "open",
      "title": "Open Tracking",
      "description": "lorem ipsum... .",
      "enabled": true
    }
  ]
}

GET

/v3/tracking_settings/click

**This endpoint allows you to retrieve your current click tracking setting.** Click Tracking overrides all the links and URLs in your emails and points them to either SendGrid’s servers or the domain with which you branded your link. When a customer clicks a link, SendGrid tracks those [clicks](ht

Header Name	Example
`on-behalf-of`	`"elit laboris nulla culpa laborum"`

Request Payload

Response Payload

{
  "enable_text": false,
  "enabled": true
}

PATCH

/v3/tracking_settings/click

**This endpoint allows you to enable or disable your current click tracking setting.** Click Tracking overrides all the links and URLs in your emails and points them to either SendGrid’s servers or the domain with which you branded your link. When a customer clicks a link, SendGrid tracks those [c

Header Name	Example
`on-behalf-of`	`"ad dolor incididunt sunt"`

Request Payload

{
  "enabled": true
}

Response Payload

{
  "enable_text": false,
  "enabled": true
}

GET

/v3/tracking_settings/google_analytics

**This endpoint allows you to retrieve your current setting for Google Analytics.** Google Analytics helps you understand how users got to your site and what they're doing there. For more information about using Google Analytics, please refer to [Google’s URL Builder](https://support.google.com/a

Header Name	Example
`on-behalf-of`	`"ut consectetur et mollit sunt"`

Request Payload

Response Payload

{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}

PATCH

/v3/tracking_settings/google_analytics

**This endpoint allows you to update your current setting for Google Analytics.** Google Analytics helps you understand how users got to your site and what they're doing there. For more information about using Google Analytics, please refer to [Google’s URL Builder](https://support.google.com/anal

Header Name	Example
`on-behalf-of`	`"aliquip occaecat ipsum"`

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": ""
}

GET

/v3/tracking_settings/open

**This endpoint allows you to retrieve your current settings for open tracking.** Open Tracking adds an invisible image at the end of the email which can track email opens. If the email recipient has images enabled on their email client, a request to SendGrid’s server for the invisible image is e

Header Name	Example
`on-behalf-of`	`"sed aliquip ad"`

Request Payload

Response Payload

{
  "enabled": true
}

PATCH

/v3/tracking_settings/open

**This endpoint allows you to update your current settings for open tracking.** Open Tracking adds an invisible image at the end of the email which can track email opens. If the email recipient has images enabled on their email client, a request to SendGrid’s server for the invisible image is exe

Header Name	Example
`on-behalf-of`	`"tempor voluptate do ex"`

Request Payload

{
  "enabled": true
}

Response Payload

{
  "enabled": true
}

GET

/v3/tracking_settings/subscription

**This endpoint allows you to retrieve your current settings for subscription tracking.** Subscription tracking adds links to the bottom of your emails that allows your recipients to subscribe to, or unsubscribe from, your emails.

Header Name	Example
`on-behalf-of`	`"consequat"`

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": ""
}

PATCH

/v3/tracking_settings/subscription

**This endpoint allows you to update your current settings for subscription tracking.** Subscription tracking adds links to the bottom of your emails that allows your recipients to subscribe to, or unsubscribe from, your emails.

Header Name	Example
`on-behalf-of`	`"elit"`

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)

GET

/v3/stats

**This endpoint allows you to retrieve all of your global email statistics between a given date range.** Parent accounts will see aggregated stats for their account and all subuser accounts. Subuser accounts will only see their own stats.

Query Parameter Name	Example
`limit`	`-44136118`
`offset`	`61270392`
`aggregated_by`	`month`
`start_date`*	`ea fugiat qui proident`
`end_date`	`aliqua amet sed`

Header Name	Example
`on-behalf-of`	`"aliquip nisi enim et"`

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
        }
      }
    ]
  }
]

GET

/v3/geo/stats

**This endpoint allows you to retrieve your email statistics segmented by country and state/province.** **We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. Advanced Stats provide a more in-depth

Query Parameter Name	Example
`country`	`US`
`limit`	`71234244`
`offset`	`37722231`
`aggregated_by`	`week`
`start_date`*	`anim`
`end_date`	`est Ut`

Header Name	Example
`on-behalf-of`	`"dolor minim officia eiusmod nostrud"`

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
        }
      }
    ]
  }
]

GET

/v3/devices/stats

**This endpoint allows you to retrieve your email statistics segmented by the device type.** **We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. ## Available Device Types | **Device** | **Descri

Query Parameter Name	Example
`limit`	`30208907`
`offset`	`91801925`
`aggregated_by`	`week`
`start_date`*	`cillum in non cupidatat`
`end_date`	`esse consequat Excepteur irure`

Header Name	Example
`on-behalf-of`	`"dolore incididunt velit occaecat qui"`

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
        }
      }
    ]
  }
]

GET

/v3/clients/stats

**This endpoint allows you to retrieve your email statistics segmented by client type.** **We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. Advanced Stats provide a more in-depth view of your e

Query Parameter Name	Example
`start_date`*	`officia minim anim adipisicing veniam`
`end_date`	`in Excepteur`
`aggregated_by`	`day`

Header Name	Example
`on-behalf-of`	`"irure officia adipisicing amet nostrud"`

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"
      }
    ]
  }
]

GET

/v3/clients/{client_type}/stats

**This endpoint allows you to retrieve your email statistics segmented by a specific client type.** **We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. ## Available Client Types - phone - tablet

Query Parameter Name	Example
`start_date`*	`ut`
`end_date`	`do`
`aggregated_by`	`day`

Header Name	Example
`on-behalf-of`	`"ex pariatur anim in sint"`

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"
      }
    ]
  }
]

GET

/v3/mailbox_providers/stats

**This endpoint allows you to retrieve your email statistics segmented by recipient mailbox provider.** **We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. Advanced Stats provide a more in-depth

Query Parameter Name	Example
`mailbox_providers`	`eu in voluptate cillum`
`limit`	`-91041877`
`offset`	`35421783`
`aggregated_by`	`month`
`start_date`*	`in tempor ad`
`end_date`	`est pariatur labore amet`

Header Name	Example
`on-behalf-of`	`"deserunt proident"`

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
        }
      }
    ]
  }
]

GET

/v3/browsers/stats

**This endpoint allows you to retrieve your email statistics segmented by browser type.** **We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. Advanced Stats provide a more in-depth view of your

Query Parameter Name	Example
`browsers`	`nisi ex minim`
`limit`	`-82781018`
`offset`	`72072923`
`aggregated_by`	`week`
`start_date`*	`magna Excepteur elit consectetur nisi`
`end_date`	`in minim`

Header Name	Example
`on-behalf-of`	`"cillum"`

Request Payload

Response Payload

[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "clicks": 0,
          "unique_clicks": 0
        },
        "name": "Chrome",
        "type": "browser"
      },
      {
        "metrics": {
          "clicks": 1,
          "unique_clicks": 1
        },
        "name": "Firefox",
        "type": "browser"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "clicks": 0,
          "unique_clicks": 0
        },
        "name": "Chrome",
        "type": "browser"
      },
      {
        "metrics": {
          "clicks": 1,
          "unique_clicks": 1
        },
        "name": "Firefox",
        "type": "browser"
      }
    ]
  }
]

Bounces API(4 operations)

GET

/v3/suppression/bounces

**This endpoint allows you to retrieve all of your bounces.**

Query Parameter Name	Example
`start_time`	`-62383404`
`end_time`	`-78950029`

Header Name	Example
`Accept`*	`"Duis in eu pariatur sunt"`
`on-behalf-of`	`"nisi dolore minim deserunt"`

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"
    }
  ]
}

DELETE

/v3/suppression/bounces

**This endpoint allows you to delete all emails on your bounces list.** There are two options for deleting bounced emails: 1. You can delete all bounced emails by setting `delete_all` to `true` in the request body. 2. You can delete a selection of bounced emails by specifying the email addresse

Header Name	Example
`on-behalf-of`	`"minim dolor dolore commodo"`

Request Payload

{
  "delete_all": false,
  "emails": [
    "example@example.com",
    "example2@example.com"
  ]
}

Response Payload

Error generating example

{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

GET

/v3/suppression/bounces/{email}

**This endpoint allows you to retrieve a specific bounce by email address.**

Header Name	Example
`on-behalf-of`	`"ea consequat ad enim"`

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"
  }
]

DELETE

/v3/suppression/bounces/{email}

**This endpoint allows you to remove an email address from your bounce list.**

Query Parameter Name	Example
`email_address`*	`To2@nvpvZrsVbYTTBQ.quk`

Header Name	Example
`on-behalf-of`	`"do magna anim"`

Request Payload

Error generating example

Response Payload

{}

{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Blocks API(4 operations)

GET

/v3/suppression/blocks

**This endpoint allows you to retrieve all email addresses that are currently on your blocks list.**

Query Parameter Name	Example
`start_time`	`82016489`
`end_time`	`24974820`
`limit`	`61965292`
`offset`	`61743823`

Header Name	Example
`on-behalf-of`	`"id sed pariatur"`

Request Payload

Response Payload

[
  {
    "created": 1443651154,
    "email": "example@example.com",
    "reason": "error dialing remote address: dial tcp 10.57.152.165:25: no route to host",
    "status": "4.0.0"
  },
  {
    "created": 1443651155,
    "email": "example1@example.com",
    "reason": "unable to resolve MX record for example.com: servfail",
    "status": "4.0.0"
  }
]

DELETE

/v3/suppression/blocks

**This endpoint allows you to delete all email addresses on your blocks list.** There are two options for deleting blocked emails: 1. You can delete all blocked emails by setting `delete_all` to `true` in the request body. 2. You can delete a selection of blocked emails by specifying the email

Header Name	Example
`on-behalf-of`	`"laboris et"`

Request Payload

{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}

Response Payload

{}

GET

/v3/suppression/blocks/{email}

**This endpoint allows you to retrieve a specific email address from your blocks list.**

Header Name	Example
`on-behalf-of`	`"officia dolor laborum commodo consectetur"`

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"
  }
]

DELETE

/v3/suppression/blocks/{email}

**This endpoint allows you to delete a specific email address from your blocks list.**

Header Name	Example
`on-behalf-of`	`"occaecat ipsum anim fugiat ut"`

Request Payload

Response Payload

{}

Spam Reports API(4 operations)

GET

/v3/suppression/spam_reports

**This endpoint allows you to retrieve all spam reports.**

Query Parameter Name	Example
`start_time`	`-36854050`
`end_time`	`18699659`
`limit`	`-42407333`
`offset`	`-6133446`

Header Name	Example
`on-behalf-of`	`"elit qui aliquip irure"`

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"
  }
]

DELETE

/v3/suppression/spam_reports

**This endpoint allows you to delete your spam reports.** Deleting a spam report will remove the suppression, meaning email will once again be sent to the previously suppressed address. This should be avoided unless a recipient indicates they wish to receive email from you again. You can use our [

Header Name	Example
`on-behalf-of`	`"officia veniam tempor"`

Request Payload

{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}

Response Payload

{}

GET

/v3/suppression/spam_reports/{email}

**This endpoint allows you to retrieve a specific spam report by email address.**

Header Name	Example
`on-behalf-of`	`"nisi in"`

Request Payload

Response Payload

[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "ip": "10.89.32.5"
  }
]

DELETE

/v3/suppression/spam_reports/{email}

**This endpoint allows you to delete a specific spam report by email address.** Deleting a spam report will remove the suppression, meaning email will once again be sent to the previously suppressed address. This should be avoided unless a recipient indicates they wish to receive email from you ag

Header Name	Example
`on-behalf-of`	`"officia anim nulla do"`

Request Payload

Response Payload

{}

Suppressions - Global Suppressions(4 operations)

POST

/v3/asm/suppressions/global

**This endpoint allows you to add one or more email addresses to the global suppressions group.**

Header Name	Example
`on-behalf-of`	`"aliquip sunt"`

Request Payload

{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}

Response Payload

{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}

GET

/v3/suppression/unsubscribes

**This endpoint allows you to retrieve a list of all email address that are globally suppressed.**

Query Parameter Name	Example
`start_time`	`33311699`
`end_time`	`65584636`
`limit`	`-49654908`
`offset`	`-51701363`

Header Name	Example
`on-behalf-of`	`"commodo reprehenderit nisi ad ipsum"`

Request Payload

Response Payload

[
  {
    "created": 1443651141,
    "email": "user1@example.com"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com"
  }
]

GET

/v3/asm/suppressions/global/{email}

**This endpoint allows you to retrieve a global suppression. You can also use this endpoint to confirm if an email address is already globally suppresed.** If the email address you include in the URL path parameter `{email}` is already globally suppressed, the response will include that email addr

Header Name	Example
`on-behalf-of`	`"aute elit labore occaecat"`

Request Payload

Response Payload

{
  "recipient_email": "test@example.com"
}

DELETE

/v3/asm/suppressions/global/{email}

**This endpoint allows you to remove an email address from the global suppressions group.** Deleting a suppression group will remove the suppression, meaning email will once again be sent to the previously suppressed addresses. This should be avoided unless a recipient indicates they wish to recei

Header Name	Example
`on-behalf-of`	`"officia in"`

Request Payload

Response Payload

{}

Suppressions - Unsubscribe Groups(5 operations)

POST

/v3/asm/groups

**This endpoint allows you to create a new suppression group.** To add an email address to the suppression group, [create a Suppression](https://sendgrid.api-docs.io/v3.0/suppressions-suppressions/add-suppressions-to-a-suppression-group).

Header Name	Example
`on-behalf-of`	`"et id magna pariatur Duis"`

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
}

GET

/v3/asm/groups

**This endpoint allows you to retrieve a list of all suppression groups created by this user.** This endpoint can also return information for multiple group IDs that you include in your request. To add a group ID to your request, simply append `?id=123456&id=123456`, with the appropriate group IDs.

Query Parameter Name	Example
`id`	`29662852`

Header Name	Example
`on-behalf-of`	`"ipsum nisi"`

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
  }
]

GET

/v3/asm/groups/{group_id}

**This endpoint allows you to retrieve a single suppression group.**

Header Name	Example
`on-behalf-of`	`"sunt cupidatat quis"`

Request Payload

Response Payload

{
  "description": "Our monthly newsletter.",
  "id": 100,
  "is_default": true,
  "last_email_sent_at": null,
  "name": "Newsletters",
  "unsubscribes": 400
}

PATCH

/v3/asm/groups/{group_id}

**This endpoint allows you to update or change a suppression group.**

Header Name	Example
`on-behalf-of`	`"sint qui dolore"`

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."
}

DELETE

/v3/asm/groups/{group_id}

**This endpoint allows you to delete a suppression group.** If a recipient uses the "one-click unsubscribe" option on an email associated with a deleted group, that recipient will be added to the global suppression list. Deleting a suppression group will remove the suppression, meaning email will

Header Name	Example
`on-behalf-of`	`"non dolore consequat incididunt"`

Request Payload

Response Payload

{}

Suppressions - Suppressions(6 operations)

POST

/v3/asm/groups/{group_id}/suppressions

**This endpoint allows you to add email addresses to an unsubscribe group.** If you attempt to add suppressions to a group that has been deleted or does not exist, the suppressions will be added to the global suppressions list.

Header Name	Example
`on-behalf-of`	`"consectetur esse"`

Request Payload

{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}

Response Payload

{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}

GET

/v3/asm/groups/{group_id}/suppressions

**This endpoint allows you to retrieve all suppressed email addresses belonging to the given group.**

Header Name	Example
`on-behalf-of`	`"et"`

Request Payload

Response Payload

[
  "example@example.com",
  "example2@example.com"
]

POST

/v3/asm/groups/{group_id}/suppressions/search

**This endpoint allows you to search a suppression group for multiple suppressions.** When given a list of email addresses and a group ID, this endpoint will only return the email addresses that have been unsubscribed from the given group.

Header Name	Example
`on-behalf-of`	`"in"`

Request Payload

{
  "recipient_emails": [
    "exists1@example.com",
    "exists2@example.com",
    "doesnotexists@example.com"
  ]
}

Response Payload

[
  "exists1@example.com",
  "exists2@example.com"
]

GET

/v3/asm/suppressions

**This endpoint allows you to retrieve a list of all suppressions.**

Header Name	Example
`on-behalf-of`	`"veniam"`

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
  }
]

GET

/v3/asm/suppressions/{email}

**This endpoint returns a list of all groups from which the given email address has been unsubscribed.**

Header Name	Example
`on-behalf-of`	`"ullamco nisi"`

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
    }
  ]
}

DELETE

/v3/asm/groups/{group_id}/suppressions/{email}

**This endpoint allows you to remove a suppressed email address from the given suppression group.** Removing an address will remove the suppression, meaning email will once again be sent to the previously suppressed addresses. This should be avoided unless a recipient indicates they wish to receiv

Header Name	Example
`on-behalf-of`	`"laborum quis"`

Request Payload

Response Payload

Error generating example

Invalid Emails API(4 operations)

GET

/v3/suppression/invalid_emails

**This endpoint allows you to retrieve a list of all invalid email addresses.**

Query Parameter Name	Example
`start_time`	`-78072982`
`end_time`	`-91559813`
`limit`	`73781342`
`offset`	`-52332261`

Header Name	Example
`on-behalf-of`	`"exercitation tempor qui"`

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"
  }
]

DELETE

/v3/suppression/invalid_emails

**This endpoint allows you to remove email addresses from your invalid email address list.** There are two options for deleting invalid email addresses: 1) You can delete all invalid email addresses by setting `delete_all` to true in the request body. 2) You can delete some invalid email address

Header Name	Example
`on-behalf-of`	`"laboris magna occaecat aliqua"`

Request Payload

{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}

Response Payload

{}

GET

/v3/suppression/invalid_emails/{email}

**This endpoint allows you to retrieve a specific invalid email addresses.**

Header Name	Example
`on-behalf-of`	`"cillum"`

Request Payload

Response Payload

[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]

DELETE

/v3/suppression/invalid_emails/{email}

**This endpoint allows you to remove a specific email address from the invalid email address list.**

Header Name	Example
`on-behalf-of`	`"ut in ea culpa"`

Request Payload

Response Payload

{}

Service Homepage: sendgrid.com/en-us

API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started

emails