Sendgrid V3 Mock Server

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

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

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

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

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

Mail Send

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": "ex aliquip enim"
    },
    {
      "message": "in esse ex sit"
    },
    {
      "message": "id"
    },
    {
      "message": "nisi est"
    }
  ]
}

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`	`"ipsum consectetur ex nostrud"`

Request Payload

Response Payload

{
  "batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi"
}

{
  "errors": [
    {
      "field": "Lorem sed",
      "help": {},
      "message": "elit esse sint"
    },
    {
      "field": "laboris consequat ex qui aliqua",
      "help": {},
      "message": "est non velit"
    },
    {
      "field": "dolore consequat in qui ut",
      "help": {},
      "message": "ex commodo fugiat pariatur"
    }
  ],
  "id": "velit in elit commodo quis"
}

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

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

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

{
  "errors": [
    {
      "message": "dolore adipisicing sunt consequat ipsum"
    },
    {
      "message": "aliqua laboris veniam magna cillum"
    }
  ]
}

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`	`"dolor id sit in"`

Request Payload

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

Response Payload

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

{
  "errors": [
    {
      "field": "ad",
      "help": {},
      "message": "ut consequat id"
    },
    {
      "field": "Ut dolor",
      "help": {},
      "message": "ullamco laboris"
    },
    {
      "field": "cillum proident",
      "help": {},
      "message": "qui enim ut officia"
    },
    {
      "field": "anim",
      "help": {},
      "message": "consequat ex"
    },
    {
      "field": "fugiat dolore nostrud veniam",
      "help": {},
      "message": "consectetur culpa incididunt esse"
    }
  ],
  "id": "elit et ea tempor labore"
}

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

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

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

{
  "errors": [
    {
      "message": "esse id"
    }
  ]
}

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`	`"cupidatat labore"`

Request Payload

Response Payload

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

{
  "errors": [
    {
      "field": "minim est dolore sit",
      "help": {},
      "message": "Excepteur nostrud voluptate"
    },
    {
      "field": "velit",
      "help": {},
      "message": "ipsum incididunt"
    },
    {
      "field": "veniam ex do tempor",
      "help": {},
      "message": "reprehenderit esse"
    },
    {
      "field": "veniam",
      "help": {},
      "message": "irure adipisicing"
    },
    {
      "field": "nisi tempor",
      "help": {},
      "message": "Lorem adipisicing"
    }
  ],
  "id": "nulla aliquip"
}

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

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

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

{
  "errors": [
    {
      "message": "laborum nulla elit do"
    }
  ]
}

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`	`"proident est incididunt occaecat Duis"`

Request Payload

Response Payload

{
  "batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi"
}

{
  "errors": [
    {
      "field": "tempor incididunt",
      "help": {},
      "message": "irure aute adipisicing quis aliqua"
    },
    {
      "field": "non eiusmod elit cillum et",
      "help": {},
      "message": "ipsum do Duis tempor"
    },
    {
      "field": "mollit ex proident in sed",
      "help": {},
      "message": "in labore voluptate dolor"
    },
    {
      "field": "incididunt irure exercitation",
      "help": {},
      "message": "non"
    },
    {
      "field": "enim consectetur in",
      "help": {},
      "message": "dolore proident ad"
    }
  ],
  "id": "eu"
}

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

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

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

{
  "errors": [
    {
      "message": "anim dolore qui labore Lorem"
    },
    {
      "message": "labore aute"
    },
    {
      "message": "magna dolor consectetur aliqua"
    },
    {
      "message": "enim consequat sed minim esse"
    }
  ]
}

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`	`"voluptate in"`

Request Payload

Response Payload

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

{
  "errors": [
    {
      "field": "labore",
      "help": {},
      "message": "reprehenderit adipisicing in"
    },
    {
      "field": "reprehenderit non enim",
      "help": {},
      "message": "dolore tempor non cillum irure"
    },
    {
      "field": "velit laborum",
      "help": {},
      "message": "dolor"
    },
    {
      "field": "veniam eiusmod",
      "help": {},
      "message": "esse incididunt irure ullamco mollit"
    },
    {
      "field": "amet labore non cupidatat est",
      "help": {},
      "message": "irure sit dolor proident Lorem"
    }
  ],
  "id": "anim"
}

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

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

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

{
  "errors": [
    {
      "message": "ipsum eu velit fugiat"
    },
    {
      "message": "ut"
    },
    {
      "message": "anim"
    },
    {
      "message": "sed nisi Duis pariatur cillum"
    }
  ]
}

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`	`"nostrud"`

Request Payload

{
  "status": "pause"
}

Response Payload

Error generating example

{
  "errors": [
    {
      "field": "fugiat anim aliqua in Duis",
      "help": {},
      "message": "velit laboris cillum voluptate sit"
    },
    {
      "field": "deserunt",
      "help": {},
      "message": "laborum"
    },
    {
      "field": "elit aliqua",
      "help": {},
      "message": "amet ex eu in"
    },
    {
      "field": "dolor voluptate",
      "help": {},
      "message": "ad exercitation"
    },
    {
      "field": "consequat nisi",
      "help": {},
      "message": "ipsum magna eu occaecat dolor"
    }
  ],
  "id": "non eiusmod consequat proident id"
}

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

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

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

{
  "errors": [
    {
      "message": "veniam anim Lorem sit aute"
    },
    {
      "message": "veniam"
    },
    {
      "message": "eu fugiat"
    },
    {
      "message": "do deserunt nulla Excepteur"
    }
  ]
}

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`	`"deserunt ad laborum dolore enim"`

Request Payload

Response Payload

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

{
  "errors": [
    {
      "field": "nisi",
      "help": {},
      "message": "deserunt Excepteur proident aute"
    },
    {
      "field": "minim voluptate ex enim",
      "help": {},
      "message": "laboris nisi dolor"
    },
    {
      "field": "aute adipisicing in",
      "help": {},
      "message": "veniam irure"
    },
    {
      "field": "Lorem",
      "help": {},
      "message": "in ut veniam"
    },
    {
      "field": "aute",
      "help": {},
      "message": "tempor elit"
    }
  ],
  "id": "ut voluptate officia"
}

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

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

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

{
  "errors": [
    {
      "message": "ea aliqua ex"
    },
    {
      "message": "in"
    },
    {
      "message": "elit"
    }
  ]
}

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`	`"in non cillum cupidatat ipsum"`

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": "ut labore irure id sit"
    },
    {
      "message": "sint"
    },
    {
      "message": "minim"
    }
  ]
}

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`	`-17625666`

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

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": "cupidatat Ut"
    },
    {
      "message": "incididunt pariatur amet consectetur elit"
    },
    {
      "message": "aliquip est nulla laborum"
    }
  ]
}

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`	`"enim exercitation"`

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": "Lorem do eu irure"
    },
    {
      "message": "sit est"
    },
    {
      "message": "nisi nostrud incididunt ut"
    },
    {
      "message": "aliquip incididunt fugiat"
    }
  ]
}

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`	`"ut amet sed id"`

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

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`	`"cupidatat exercitation enim commodo eu"`

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": "voluptate"
    },
    {
      "message": "aliquip adipisicing mollit sint 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`	`"mollit nisi"`

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": "eu enim"
    },
    {
      "message": "nisi consequat"
    },
    {
      "message": "sint"
    },
    {
      "message": "voluptate sunt ut"
    },
    {
      "message": "cupidatat esse ea proident"
    }
  ]
}

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`	`"dolor consequat cupidatat id"`

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": "laboris eiusmod"
    },
    {
      "message": "tempor dolore nisi sed esse"
    }
  ]
}

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`	`"adipisicing laborum ad"`

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": "in dolore est id ut"
    },
    {
      "message": "elit Excepteur in consequat aliquip"
    },
    {
      "message": "dolore"
    },
    {
      "message": "et dolore"
    },
    {
      "message": "ipsum occaecat non id esse"
    }
  ]
}

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`	`"Excepteur officia do sit eiusmod"`

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": "in veniam"
    },
    {
      "message": "eu aute Duis tempor"
    },
    {
      "message": "elit anim"
    },
    {
      "message": "occaecat ut nulla labore ut"
    },
    {
      "message": "magna dolore ad in"
    }
  ]
}

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`	`"ex ut irure ad"`

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": "Lorem id"
    },
    {
      "message": "mollit do"
    }
  ]
}

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`	`"Lorem"`

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": "adipisicing esse"
    },
    {
      "message": "do minim ullamco"
    },
    {
      "message": "sint elit"
    }
  ]
}

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`	`"irure anim deserunt"`

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": "cupidatat"
    },
    {
      "message": "exercitation laborum tempor sunt nostrud"
    },
    {
      "message": "cupidatat ad tempor laborum"
    }
  ]
}

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`	`-66181731`

Header Name	Example
`on-behalf-of`	`"ut nisi Duis aliqua"`

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": "amet esse"
    },
    {
      "message": "ut adipisicing consectetur cillum proident"
    },
    {
      "message": "ex"
    },
    {
      "message": "ad proident"
    }
  ]
}

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`	`"ullamco ea"`

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`	`"enim ut occaecat"`

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": "enim",
    "field": null,
    "message": "irure laboris ullamco qui pariatur"
  }
]

[
  {
    "error_id": "dolor aliqua id",
    "field": "reprehenderit ipsum esse",
    "message": "id Lorem"
  },
  {
    "error_id": "in eiusmod Excepteur ea",
    "field": null,
    "message": "in laborum voluptate"
  },
  {
    "error_id": "culpa dolore nulla",
    "field": null,
    "message": "nisi id minim consectetur sunt"
  },
  {
    "error_id": "ex aliquip",
    "field": "ut quis",
    "message": "qui Excepteur"
  },
  {
    "error_id": "incididunt enim ipsum cillum laborum",
    "field": null,
    "message": "aute laboris eiusmod dolore"
  }
]

[
  {
    "error_id": "in magna",
    "field": null,
    "message": "labore proident"
  },
  {
    "error_id": "id",
    "field": null,
    "message": "deserunt"
  },
  {
    "error_id": "eiusmod occaecat irure Lorem dolor",
    "field": null,
    "message": "ea dolor ad Ut"
  }
]

[
  {
    "error_id": "anim aute id incididunt aliquip",
    "field": "incididunt Excepteur Lorem enim",
    "message": "ea commodo non laboris"
  },
  {
    "error_id": "ex",
    "field": null,
    "message": "quis magna exercitation"
  },
  {
    "error_id": "aliqua cillum sint",
    "field": "incididunt ex",
    "message": "pariatur Duis"
  }
]

[
  {
    "error_id": "anim ut Duis",
    "field": null,
    "message": "enim aliqua ex nulla"
  }
]

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": "reprehenderit laboris dolor",
    "field": "nisi enim",
    "message": "sed ut nulla"
  }
]

[
  {
    "error_id": "officia labore",
    "field": "ea velit enim veniam",
    "message": "Ut minim"
  }
]

[
  {
    "error_id": "sunt",
    "field": null,
    "message": "nostrud et"
  },
  {
    "error_id": "mollit officia do",
    "field": "proident commodo est",
    "message": "tempor"
  }
]

[
  {
    "error_id": "dolor est",
    "field": null,
    "message": "consectetur"
  }
]

[
  {
    "error_id": "qui ipsum",
    "field": "ad",
    "message": "do culpa"
  },
  {
    "error_id": "ut esse cupidatat Ut",
    "field": "amet reprehenderit",
    "message": "proident aliqua eiusmod"
  },
  {
    "error_id": "deserunt exercitation ad Lorem sit",
    "field": "elit ad ullamco nostrud",
    "message": "veniam commodo magna est"
  }
]

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": "in consequat tempor",
    "field": "fugiat",
    "message": "velit consectetur ea aliqua in"
  },
  {
    "error_id": "et Excepteur do pariatur ea",
    "field": null,
    "message": "sed quis labore incididunt"
  },
  {
    "error_id": "amet dolor voluptate reprehenderit",
    "field": "culpa pariatur",
    "message": "ad tempor fugiat in amet"
  },
  {
    "error_id": "ad culpa dolore Lorem",
    "field": "ea amet adipisicing veniam aliqua",
    "message": "tempor do est"
  }
]

[
  {
    "error_id": "Duis nostrud",
    "field": null,
    "message": "Duis sit"
  },
  {
    "error_id": "ea occaecat ullamco commodo veniam",
    "field": null,
    "message": "nulla id consequat aliqua"
  },
  {
    "error_id": "dolor nostrud sint",
    "field": null,
    "message": "Lorem sint"
  },
  {
    "error_id": "minim fugiat aliqua",
    "field": null,
    "message": "Duis"
  },
  {
    "error_id": "sunt",
    "field": "adipisicing",
    "message": "exercitation cupidatat fugiat occaecat quis"
  }
]

[
  {
    "error_id": "voluptate in reprehenderit exercitation ut",
    "field": "ut",
    "message": "laborum sunt mollit"
  },
  {
    "error_id": "tempor",
    "field": "veniam et",
    "message": "minim Excepteur Lorem cillum"
  }
]

[
  {
    "error_id": "sunt",
    "field": "sunt veniam",
    "message": "est commodo anim"
  },
  {
    "error_id": "aute ut quis in",
    "field": null,
    "message": "fugiat in"
  },
  {
    "error_id": "consectetur",
    "field": "dolore consectetur deserunt enim ea",
    "message": "labore sunt adipisicing elit"
  }
]

[
  {
    "error_id": "occaecat minim est sed Excepteur",
    "field": "do laborum consequat consectetur",
    "message": "id"
  },
  {
    "error_id": "aute",
    "field": "aliqua non exercitation dolor",
    "message": "ut consequat incididunt ipsum"
  }
]

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": "ullamco cillum sit",
    "field": null,
    "message": "exercitation do in"
  },
  {
    "error_id": "aliquip labore ullamco Duis elit",
    "field": null,
    "message": "et"
  },
  {
    "error_id": "pariatur occaecat",
    "field": null,
    "message": "aute"
  },
  {
    "error_id": "nostrud ut qui voluptate ut",
    "field": null,
    "message": "ea incididunt labore ut elit"
  },
  {
    "error_id": "adipisicing elit",
    "field": "aute",
    "message": "in mollit quis amet"
  }
]

[
  {
    "error_id": "Excepteur cillum sit tempor eiusmod",
    "field": null,
    "message": "irure labore in et ea"
  }
]

[
  {
    "error_id": "Excepteur aliqua laboris",
    "field": null,
    "message": "minim sit"
  },
  {
    "error_id": "minim",
    "field": "esse exercitation do",
    "message": "ad"
  },
  {
    "error_id": "fugiat in dolor",
    "field": null,
    "message": "Lorem laborum"
  },
  {
    "error_id": "aute cupidatat mollit incididunt veniam",
    "field": "nulla occaecat consectetur qui dolore",
    "message": "quis in exercitation"
  },
  {
    "error_id": "nulla exercitation Lorem",
    "field": "eu ut tempor nisi commodo",
    "message": "dolore consectetur"
  }
]

[
  {
    "error_id": "veniam in Lorem",
    "field": null,
    "message": "non consectetur"
  },
  {
    "error_id": "aute anim Lorem",
    "field": null,
    "message": "sint minim non proident adipisicing"
  }
]

[
  {
    "error_id": "nulla in consectetur incididunt in",
    "field": "qui magna",
    "message": "proident dolore est ullamco"
  },
  {
    "error_id": "aliqua ut nostrud tempor",
    "field": null,
    "message": "in adipisicing ad esse fugiat"
  }
]

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 cillum in labore",
    "field": null,
    "message": "voluptate est dolor culpa"
  }
]

[
  {
    "error_id": "eiusmod ad magna dolor",
    "field": "Lorem proident",
    "message": "ut"
  }
]

[
  {
    "error_id": "ad in aute minim",
    "field": "qui elit nulla laborum occaecat",
    "message": "magna in ullamco nisi occaecat"
  },
  {
    "error_id": "in qui culpa",
    "field": null,
    "message": "id Lorem"
  },
  {
    "error_id": "reprehenderit dolor cupidatat qui in",
    "field": null,
    "message": "ut velit Lorem"
  },
  {
    "error_id": "aute esse proident in",
    "field": "dolor commodo aute aliquip sit",
    "message": "ut ut"
  }
]

[
  {
    "error_id": "nisi dolor",
    "field": null,
    "message": "pariatur consectetur commodo anim elit"
  },
  {
    "error_id": "laborum dolor id ut",
    "field": null,
    "message": "fugiat laboris exercitation"
  },
  {
    "error_id": "eiusmod mollit aliqua",
    "field": null,
    "message": "do commodo cillum eiusmod"
  },
  {
    "error_id": "ut in reprehenderit id",
    "field": "eu",
    "message": "ut qui eu amet aute"
  }
]

[
  {
    "error_id": "sit proident Ut",
    "field": "consectetur do esse sunt est",
    "message": "officia veniam id in mollit"
  },
  {
    "error_id": "enim",
    "field": "sed",
    "message": "est eu"
  },
  {
    "error_id": "ipsum est veniam",
    "field": null,
    "message": "enim"
  }
]

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": "irure mollit",
    "field": null,
    "message": "do"
  },
  {
    "error_id": "pariatur sunt dolore non ex",
    "field": "quis sit dolore in consectetur",
    "message": "sint tempor"
  },
  {
    "error_id": "laboris",
    "field": null,
    "message": "tempor commodo Lorem"
  },
  {
    "error_id": "voluptate sit",
    "field": "sed est mollit veniam anim",
    "message": "sed dolor"
  },
  {
    "error_id": "dolor exercitation aliquip",
    "field": null,
    "message": "est elit nulla eiusmod incididunt"
  }
]

[
  {
    "error_id": "aute Duis nisi do adipisicing",
    "field": "cillum sed tempor dolor sit",
    "message": "eu est tempor ad"
  },
  {
    "error_id": "sint culpa",
    "field": "pariatur tempor dolor",
    "message": "velit cillum"
  },
  {
    "error_id": "minim voluptate veniam",
    "field": null,
    "message": "pariatur sint enim"
  },
  {
    "error_id": "incididunt",
    "field": "veniam id dolor",
    "message": "culpa id in"
  }
]

[
  {
    "error_id": "sunt",
    "field": null,
    "message": "ut laborum"
  },
  {
    "error_id": "fugiat",
    "field": "aliqua non commodo",
    "message": "sunt"
  }
]

[
  {
    "error_id": "cillum",
    "field": null,
    "message": "consectetur"
  },
  {
    "error_id": "irure id veniam amet",
    "field": "sit",
    "message": "elit incididunt"
  },
  {
    "error_id": "ex esse",
    "field": "Ut dolor laborum in ea",
    "message": "magna pariatur"
  },
  {
    "error_id": "proident",
    "field": null,
    "message": "nisi sit ut aliquip"
  },
  {
    "error_id": "ipsum amet sunt deserunt",
    "field": "consequat ut do anim in",
    "message": "veniam"
  }
]

[
  {
    "error_id": "eu deserunt quis nisi nostrud",
    "field": null,
    "message": "in do sunt non"
  },
  {
    "error_id": "sed in est culpa laboris",
    "field": "Duis do quis fugiat reprehenderit",
    "message": "elit sint sed"
  },
  {
    "error_id": "ipsum enim laborum consequat dolor",
    "field": "esse ea incididunt Ut ex",
    "message": "deserunt do amet"
  }
]

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": "in tempor id",
    "field": null,
    "message": "ut velit cupidatat nostrud"
  },
  {
    "error_id": "nisi laborum",
    "field": null,
    "message": "laboris"
  },
  {
    "error_id": "ut nisi",
    "field": null,
    "message": "nisi Duis"
  },
  {
    "error_id": "culpa anim in ut",
    "field": null,
    "message": "consectetur mollit ut consequat Duis"
  },
  {
    "error_id": "et ipsum sit",
    "field": "mollit",
    "message": "sit aute sed ullamco"
  }
]

[
  {
    "error_id": "aliquip aliqua nulla mollit",
    "field": null,
    "message": "aute ex dolore sint"
  },
  {
    "error_id": "tempor irure",
    "field": null,
    "message": "nulla deserunt nisi"
  },
  {
    "error_id": "pariatur commodo",
    "field": null,
    "message": "tempor commodo proident cillum sunt"
  },
  {
    "error_id": "quis qui",
    "field": "deserunt qui",
    "message": "non dolor voluptate reprehenderit"
  }
]

[
  {
    "error_id": "anim laborum nulla",
    "field": "consectetur ipsum",
    "message": "deserunt Excepteur nulla fugiat"
  },
  {
    "error_id": "deserunt aliquip reprehenderit non pariatur",
    "field": null,
    "message": "quis Excepteur nisi sunt"
  }
]

[
  {
    "error_id": "veniam",
    "field": null,
    "message": "cupidatat incididunt velit culpa"
  },
  {
    "error_id": "sed pariatur Duis dolor",
    "field": null,
    "message": "quis nulla sit Excepteur"
  },
  {
    "error_id": "laboris quis culpa tempor",
    "field": null,
    "message": "do nisi quis"
  },
  {
    "error_id": "ex",
    "field": null,
    "message": "laboris"
  },
  {
    "error_id": "velit ut",
    "field": null,
    "message": "aute sed"
  }
]

[
  {
    "error_id": "ipsum reprehenderit aliquip qui dolor",
    "field": null,
    "message": "ea in ipsum Ut"
  },
  {
    "error_id": "tempor ipsum",
    "field": "cillum ad deserunt",
    "message": "nulla cupidatat irure"
  },
  {
    "error_id": "occaecat",
    "field": null,
    "message": "in"
  },
  {
    "error_id": "do aute mollit nulla tempor",
    "field": null,
    "message": "exercitation in cillum"
  }
]

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": "ea eu anim nisi",
    "field": null,
    "message": "ut laborum culpa"
  },
  {
    "error_id": "in nulla commodo amet in",
    "field": "aute",
    "message": "sunt nostrud"
  },
  {
    "error_id": "id sint",
    "field": null,
    "message": "commodo cillum ipsum Ut pariatur"
  },
  {
    "error_id": "ullamco mollit ut",
    "field": "dolore sit",
    "message": "Duis officia"
  }
]

[
  {
    "error_id": "labore Duis cillum",
    "field": null,
    "message": "sit dolore ad"
  },
  {
    "error_id": "nostrud irure pariatur",
    "field": "dolore occaecat ad cupidatat",
    "message": "nisi enim anim"
  }
]

[
  {
    "error_id": "occaecat culpa sunt voluptate",
    "field": "laborum in velit cupidatat",
    "message": "ut consequat in eu esse"
  },
  {
    "error_id": "dolore labore magna proident et",
    "field": null,
    "message": "esse et magna fugiat ex"
  },
  {
    "error_id": "pariatur exercitation fugiat",
    "field": null,
    "message": "Excepteur in id"
  }
]

[
  {
    "error_id": "consectetur adipisicing",
    "field": "voluptate aute magna commodo Excepteur",
    "message": "ea consequat et proident"
  },
  {
    "error_id": "esse exercitation",
    "field": "dolore sunt",
    "message": "dolor sed nulla"
  },
  {
    "error_id": "nulla nostrud",
    "field": "cillum Lorem aute ullamco",
    "message": "labore occaecat cupidatat"
  }
]

[
  {
    "error_id": "est laboris id ex",
    "field": "tempor Duis Lorem",
    "message": "cupidatat non"
  },
  {
    "error_id": "laborum cillum esse",
    "field": null,
    "message": "sit"
  },
  {
    "error_id": "nulla",
    "field": "non ullamco eiusmod ea",
    "message": "dolor fugiat nisi labore eu"
  }
]

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`	`false`

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": "voluptate labore commodo",
    "field": null,
    "message": "laborum voluptate fugiat laboris"
  }
]

[
  {
    "error_id": "minim magna aliquip enim",
    "field": "ut dolore ipsum",
    "message": "eiusmod"
  },
  {
    "error_id": "sint Lorem nostrud",
    "field": "velit",
    "message": "non elit sed occaecat"
  },
  {
    "error_id": "aute",
    "field": "mollit nostrud aute sit veniam",
    "message": "incididunt dolore est aliqua"
  },
  {
    "error_id": "Lorem minim ut",
    "field": "Duis anim in",
    "message": "eu"
  }
]

[
  {
    "error_id": "ex aliquip minim",
    "field": "consequat eiusmod",
    "message": "ad occaecat exercitation voluptate"
  },
  {
    "error_id": "amet labore eu",
    "field": "ad voluptate id irure",
    "message": "sint qui ut ea"
  }
]

[
  {
    "error_id": "dolore ut",
    "field": "aliquip dolore proident aliqua",
    "message": "nisi in"
  }
]

[
  {
    "error_id": "eu",
    "field": "culpa elit nostrud in velit",
    "message": "anim laborum nulla minim"
  },
  {
    "error_id": "aliqua",
    "field": null,
    "message": "incididunt nostrud non"
  }
]

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": "est ea sunt sint reprehenderit",
    "field": null,
    "message": "ad"
  },
  {
    "error_id": "sed non id irure ex",
    "field": null,
    "message": "tempor sed"
  },
  {
    "error_id": "enim dolore in Ut",
    "field": "nulla",
    "message": "dolor laboris ea dolor sunt"
  },
  {
    "error_id": "dolore culpa dolore incididunt",
    "field": null,
    "message": "proident"
  },
  {
    "error_id": "aute officia",
    "field": null,
    "message": "est dolor"
  }
]

[
  {
    "error_id": "culpa sit",
    "field": null,
    "message": "dolore minim ipsum culpa aliquip"
  },
  {
    "error_id": "cillum ut qui",
    "field": null,
    "message": "exercitation anim dolore dolor aliqua"
  },
  {
    "error_id": "minim",
    "field": null,
    "message": "est Duis"
  }
]

[
  {
    "error_id": "dolor sint do exercitation",
    "field": null,
    "message": "ad mollit"
  },
  {
    "error_id": "nostrud voluptate dolore elit sint",
    "field": "dolor magna",
    "message": "ullamco laborum sit dolor"
  },
  {
    "error_id": "voluptate aute",
    "field": "cillum reprehenderit",
    "message": "dolor sed ipsum ex dolor"
  },
  {
    "error_id": "minim in dolore adipisicing",
    "field": null,
    "message": "non nostrud dolore"
  }
]

[
  {
    "error_id": "cillum tempor id",
    "field": "ut irure",
    "message": "ullamco incididunt"
  },
  {
    "error_id": "mollit fugiat dolor nulla eu",
    "field": null,
    "message": "minim Lorem deserunt"
  },
  {
    "error_id": "ipsum eiusmod",
    "field": null,
    "message": "mollit pariatur eu esse amet"
  }
]

[
  {
    "error_id": "dolor",
    "field": null,
    "message": "Lorem dolore enim"
  },
  {
    "error_id": "commodo incididunt Excepteur Duis Lorem",
    "field": null,
    "message": "veniam"
  },
  {
    "error_id": "exercitation est",
    "field": null,
    "message": "reprehenderit mollit sed proident"
  },
  {
    "error_id": "dolor qui adipisicing",
    "field": null,
    "message": "enim eu voluptate sunt deserunt"
  }
]

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": "qui anim dolor in",
    "field": "aliquip",
    "message": "mollit ut dolor"
  },
  {
    "error_id": "consequat et sunt commodo labore",
    "field": null,
    "message": "labore officia consequat"
  },
  {
    "error_id": "incididunt dolor",
    "field": "exercitation tempor fugiat deserunt aliqua",
    "message": "deserunt officia anim nostrud laborum"
  }
]

[
  {
    "error_id": "ad commodo non",
    "field": null,
    "message": "dolor laboris Excepteur aliqua"
  },
  {
    "error_id": "do nulla et Duis dolor",
    "field": null,
    "message": "ipsum"
  }
]

[
  {
    "error_id": "nisi officia",
    "field": "cupidatat anim",
    "message": "laborum ullamco"
  },
  {
    "error_id": "magna amet ullamco quis",
    "field": "ullamco nostrud minim eu",
    "message": "quis dolor dolore officia non"
  },
  {
    "error_id": "adipisicing ex deserunt qui",
    "field": null,
    "message": "velit sint"
  },
  {
    "error_id": "magna mollit exercitation amet",
    "field": null,
    "message": "laboris reprehenderit"
  },
  {
    "error_id": "exercitation consequat reprehenderit laboris incididunt",
    "field": null,
    "message": "do aliquip dolor ad"
  }
]

[
  {
    "error_id": "laborum",
    "field": null,
    "message": "minim"
  },
  {
    "error_id": "ipsum",
    "field": null,
    "message": "do"
  },
  {
    "error_id": "id incididunt dolore enim",
    "field": null,
    "message": "occaecat sed eu sint cupidatat"
  },
  {
    "error_id": "voluptate deserunt",
    "field": null,
    "message": "aute"
  },
  {
    "error_id": "aliquip",
    "field": null,
    "message": "qui aliquip"
  }
]

[
  {
    "error_id": "voluptate aute magna Ut",
    "field": "nulla dolore",
    "message": "Excepteur in laborum cillum"
  },
  {
    "error_id": "commodo",
    "field": null,
    "message": "consectetur sunt officia anim"
  },
  {
    "error_id": "dolor incididunt reprehenderit Lorem",
    "field": "sit",
    "message": "minim Duis Ut"
  }
]

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": "nostrud Excepteur",
    "field": null,
    "message": "laboris voluptate ipsum minim non"
  },
  {
    "error_id": "aute in nostrud laborum",
    "field": "cillum",
    "message": "enim in Excepteur consectetur"
  },
  {
    "error_id": "in ullamco laboris occaecat irure",
    "field": "sed",
    "message": "sunt"
  }
]

[
  {
    "error_id": "nulla dolor",
    "field": "consequat amet exercitation cillum qui",
    "message": "fugiat aute"
  },
  {
    "error_id": "voluptate deserunt mollit cupidatat",
    "field": null,
    "message": "anim et quis commodo nulla"
  }
]

[
  {
    "error_id": "sit deserunt labore",
    "field": null,
    "message": "veniam"
  },
  {
    "error_id": "laboris proident Ut exercitation adipisicing",
    "field": null,
    "message": "ipsum voluptate"
  },
  {
    "error_id": "minim dolore Lorem ipsum",
    "field": "ex anim Lorem",
    "message": "laborum sit Lorem in"
  },
  {
    "error_id": "esse Excepteur incididunt enim",
    "field": "culpa magna eu",
    "message": "irure dolor"
  },
  {
    "error_id": "Duis",
    "field": null,
    "message": "dolor aute magna nulla Lorem"
  }
]

[
  {
    "error_id": "cupidatat nisi",
    "field": null,
    "message": "fugiat ad id sunt laborum"
  }
]

[
  {
    "error_id": "ipsum non fugiat magna dolor",
    "field": null,
    "message": "aliqua nostrud incididunt ut"
  }
]

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`	`11148285`
`offset`	`42942097`

Header Name	Example
`on-behalf-of`	`"consequat Excepteur enim"`

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",
      "field": null,
      "message": "magna in quis",
      "parameter": "sit voluptate ut"
    },
    {
      "error_id": "sed veniam non reprehenderit",
      "field": "incididunt",
      "message": "quis ea ullamco ut",
      "parameter": "aliquip Duis"
    },
    {
      "error_id": "in ea velit fugiat magna",
      "field": null,
      "message": "proident minim voluptate tempor",
      "parameter": "est enim minim"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "consequat",
      "field": null,
      "message": "et ullamco minim",
      "parameter": "elit"
    },
    {
      "error_id": "ipsum magna",
      "field": "in",
      "message": "do dolor nulla",
      "parameter": "sit magna"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "enim cupidatat nostrud velit",
      "field": "sed",
      "message": "adipisicing cupidatat officia eiusmod",
      "parameter": "aliquip adipisicing"
    },
    {
      "error_id": "amet irure",
      "field": "Excepteur laborum exercitation",
      "message": "incididunt tempor anim veniam",
      "parameter": "mollit in eu"
    },
    {
      "error_id": "velit",
      "field": null,
      "message": "eu",
      "parameter": "in ex deserunt"
    },
    {
      "error_id": "dolor aliquip velit",
      "field": "id",
      "message": "dolore ullamco ad cupidatat sint",
      "parameter": "Duis ad in pariatur in"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "sed ullamco",
      "field": null,
      "message": "Lorem",
      "parameter": "deserunt exercitation laborum nisi"
    },
    {
      "error_id": "minim",
      "field": "non nulla dolore tempor sint",
      "message": "elit do veniam ut",
      "parameter": "adipisicing quis ea"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ut",
      "field": "ea",
      "message": "et ea velit",
      "parameter": "eiusmod amet nulla laboris"
    },
    {
      "error_id": "quis sit in",
      "field": null,
      "message": "dolore non ad ipsum in",
      "parameter": "voluptate Excepteur"
    },
    {
      "error_id": "esse laborum",
      "field": null,
      "message": "ipsum commodo",
      "parameter": "irure reprehenderit Lorem officia"
    }
  ]
}

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`	`"magna officia ipsum"`

Request Payload

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

Response Payload

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

{
  "errors": [
    {
      "error_id": "ad reprehenderit qui labore sint",
      "field": null,
      "message": "aute esse",
      "parameter": "exercitation qui fugiat"
    },
    {
      "error_id": "eiusmod in dolor",
      "field": "reprehenderit voluptate ullamco sed",
      "message": "qui veniam",
      "parameter": "Ut"
    },
    {
      "error_id": "in ex elit exercitation",
      "field": null,
      "message": "id incididunt enim velit",
      "parameter": "amet"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "exercitation mollit sint deserunt et",
      "field": "anim dolor ullamco fugiat dolore",
      "message": "proident incididunt",
      "parameter": "dolor deserunt qui cupidatat"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "eiusmod do anim laborum",
      "field": null,
      "message": "anim sed occaecat non commodo",
      "parameter": "anim laborum elit"
    },
    {
      "error_id": "consectetur irure",
      "field": "exercitation do dolor est incididunt",
      "message": "magna Excepteur consequat occaecat aute",
      "parameter": "cillum"
    },
    {
      "error_id": "adipisicing in ea proident",
      "field": "Excepteur elit",
      "message": "exercitation aliquip cillum",
      "parameter": "magna nulla laborum occaecat ullamco"
    },
    {
      "error_id": "eu",
      "field": null,
      "message": "ullamco ut",
      "parameter": "in aliquip sint magna"
    },
    {
      "error_id": "consequat consectetur magna deserunt laboris",
      "field": "ad",
      "message": "laborum do exercitation in voluptate",
      "parameter": "culpa proident veniam"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "consectetur sunt ut",
      "field": null,
      "message": "et est ullamco",
      "parameter": "sit laboris magna incididunt"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "in proident commodo",
      "field": null,
      "message": "sunt non Excepteur enim Duis",
      "parameter": "elit"
    },
    {
      "error_id": "amet adipisicing ullamco",
      "field": "anim",
      "message": "ut occaecat Lorem Ut qui",
      "parameter": "mollit eiusmod"
    },
    {
      "error_id": "quis consectetur in exercitation",
      "field": "proident deserunt ut Excepteur",
      "message": "proident minim",
      "parameter": "quis laboris nostrud qui cupidatat"
    }
  ]
}

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`	`"occaecat sed in deserunt quis"`

Request Payload

Response Payload

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

{
  "errors": [
    {
      "error_id": "ullamco",
      "field": null,
      "message": "aute nisi magna",
      "parameter": "consectetur nisi aute"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "Excepteur",
      "field": null,
      "message": "laborum",
      "parameter": "esse in"
    },
    {
      "error_id": "dolore quis",
      "field": "sint laborum id reprehenderit esse",
      "message": "cillum ex sed reprehenderit",
      "parameter": "fugiat"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "nisi",
      "field": null,
      "message": "fugiat",
      "parameter": "sed ut laborum ut"
    },
    {
      "error_id": "sunt amet esse incididunt",
      "field": "occaecat qui",
      "message": "voluptate dolore consequat officia ut",
      "parameter": "deserunt amet"
    },
    {
      "error_id": "sunt in do non sint",
      "field": "minim nisi Ut in incididunt",
      "message": "culpa sed sint consectetur velit",
      "parameter": "pariatur est fugiat sunt"
    },
    {
      "error_id": "esse ex",
      "field": null,
      "message": "sint",
      "parameter": "ad amet"
    },
    {
      "error_id": "velit enim",
      "field": null,
      "message": "tempor et cillum esse ad",
      "parameter": "Lorem aliqua tempor"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ut nisi enim",
      "field": "nostrud ut et culpa esse",
      "message": "in magna ut",
      "parameter": "in consequat incididunt dolor"
    },
    {
      "error_id": "consectetur pariatur amet officia aliquip",
      "field": "do officia dolore",
      "message": "officia enim consequat anim commodo",
      "parameter": "laborum elit ex aute tempor"
    },
    {
      "error_id": "commodo fugiat",
      "field": "laboris irure in pariatur anim",
      "message": "adipisicing",
      "parameter": "cupidatat mollit"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "laboris elit anim aliqua",
      "field": null,
      "message": "ullamco ad incididunt laborum",
      "parameter": "fugiat nostrud incididunt elit"
    }
  ]
}

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`	`"Excepteur cillum in ea"`

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": "ex Duis ullamco",
      "field": "exercitation aliquip",
      "message": "sed in",
      "parameter": "cupidatat"
    },
    {
      "error_id": "ullamco Lorem ea nisi pariatur",
      "field": null,
      "message": "Duis irure",
      "parameter": "voluptate"
    },
    {
      "error_id": "aute",
      "field": null,
      "message": "id nostrud in adipisicing ut",
      "parameter": "labore aliqua"
    },
    {
      "error_id": "ut",
      "field": null,
      "message": "fugiat eu",
      "parameter": "ad Duis do labore ut"
    },
    {
      "error_id": "est in",
      "field": null,
      "message": "dolore occaecat",
      "parameter": "qui in cillum aliqua esse"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "anim magna nostrud",
      "field": null,
      "message": "elit dolore quis cupidatat",
      "parameter": "fugiat quis"
    },
    {
      "error_id": "consectetur",
      "field": "qui sunt fugiat velit",
      "message": "eiusmod tempor cupidatat elit anim",
      "parameter": "laboris in sit"
    },
    {
      "error_id": "tempor adipisicing in",
      "field": "Excepteur et ullamco ea anim",
      "message": "Duis",
      "parameter": "consequat dolor anim"
    },
    {
      "error_id": "in sed ea",
      "field": null,
      "message": "ullamco do",
      "parameter": "laboris"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "mollit et sed reprehenderit",
      "field": null,
      "message": "dolor qui",
      "parameter": "voluptate anim magna irure"
    },
    {
      "error_id": "ut consectetur incididunt dolore dolore",
      "field": null,
      "message": "ex dolore eiusmod velit aliqua",
      "parameter": "ut"
    },
    {
      "error_id": "velit aliqua",
      "field": "ea tempor",
      "message": "irure est ut",
      "parameter": "in consectetur labore commodo id"
    },
    {
      "error_id": "magna non",
      "field": null,
      "message": "nulla",
      "parameter": "reprehenderit elit dolore Duis"
    },
    {
      "error_id": "aliquip",
      "field": "eiusmod fugiat",
      "message": "consectetur",
      "parameter": "cupidatat voluptate Lorem aliquip dolor"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "irure exercitation sunt eiusmod",
      "field": null,
      "message": "in minim veniam nulla",
      "parameter": "ipsum nisi elit adipisicing"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "id commodo irure",
      "field": "nostrud cillum",
      "message": "occaecat",
      "parameter": "minim Duis eiusmod in"
    },
    {
      "error_id": "aliquip",
      "field": "id ut",
      "message": "cillum exercitation in Duis",
      "parameter": "qui dolor"
    },
    {
      "error_id": "reprehenderit dolor",
      "field": null,
      "message": "laboris anim deserunt",
      "parameter": "incididunt id"
    }
  ]
}

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`	`"eu irure"`

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": "pariatur non",
      "field": null,
      "message": "ad enim irure voluptate",
      "parameter": "quis et veniam aliqua"
    },
    {
      "error_id": "in irure",
      "field": "do et Lorem laboris",
      "message": "in",
      "parameter": "laboris culpa exercitation Ut non"
    },
    {
      "error_id": "qui eiusmod",
      "field": "commodo",
      "message": "non sint ut est velit",
      "parameter": "esse labore ex ad"
    },
    {
      "error_id": "eu veniam consequat Ut esse",
      "field": "culpa esse nostrud",
      "message": "cillum commodo",
      "parameter": "quis ad commodo eiusmod"
    },
    {
      "error_id": "minim dolore",
      "field": "sed",
      "message": "in nostrud qui ex pariatur",
      "parameter": "ex Duis minim proident non"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ut",
      "field": null,
      "message": "eiusmod laboris cillum",
      "parameter": "et cupidatat"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "qui Lorem quis in",
      "field": "Duis",
      "message": "ipsum amet",
      "parameter": "adipisicing ut dolor Excepteur cillum"
    },
    {
      "error_id": "anim ullamco enim in in",
      "field": "in",
      "message": "tempor exercitation labore",
      "parameter": "enim"
    },
    {
      "error_id": "in Ut",
      "field": null,
      "message": "laboris occaecat ea et enim",
      "parameter": "in"
    },
    {
      "error_id": "eiusmod voluptate officia",
      "field": null,
      "message": "magna in in do dolore",
      "parameter": "enim"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "labore ea",
      "field": "dolor consequat",
      "message": "non",
      "parameter": "est nisi laborum ut ut"
    },
    {
      "error_id": "nulla commodo magna",
      "field": "consectetur ex",
      "message": "nostrud sint Ut aliqua Excepteur",
      "parameter": "reprehenderit"
    },
    {
      "error_id": "aute Duis Lorem Excepteur anim",
      "field": "Ut aute commodo veniam",
      "message": "do",
      "parameter": "ipsum minim"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ut",
      "field": "aute officia non",
      "message": "esse laboris cupidatat nisi nulla",
      "parameter": "Ut ad in"
    },
    {
      "error_id": "esse",
      "field": null,
      "message": "commodo velit dolore",
      "parameter": "id"
    },
    {
      "error_id": "laboris qui",
      "field": "in cupidatat",
      "message": "enim",
      "parameter": "sit"
    },
    {
      "error_id": "ea nulla",
      "field": null,
      "message": "consequat",
      "parameter": "in sint deserunt ex"
    }
  ]
}

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`	`"ad deserunt"`

Request Payload

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

Response Payload

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

{
  "errors": [
    {
      "error_id": "elit",
      "field": null,
      "message": "pariatur consequat",
      "parameter": "labore incididunt laborum reprehenderit"
    },
    {
      "error_id": "cillum et",
      "field": "sint",
      "message": "aute aliqua nisi do dolor",
      "parameter": "est"
    },
    {
      "error_id": "adipisicing proident ex",
      "field": null,
      "message": "incididunt amet sed in dolore",
      "parameter": "consectetur veniam Ut"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "deserunt consequat ea voluptate nostrud",
      "field": null,
      "message": "anim pariatur aute",
      "parameter": "officia non"
    },
    {
      "error_id": "dolor officia",
      "field": "in",
      "message": "qui Excepteur non",
      "parameter": "ex incididunt eu"
    },
    {
      "error_id": "qui incididunt adipisicing elit dolor",
      "field": null,
      "message": "esse culpa exercitation adipisicing id",
      "parameter": "sunt"
    },
    {
      "error_id": "ex",
      "field": null,
      "message": "ea non eu consequat pariatur",
      "parameter": "ut velit pariatur incididunt"
    },
    {
      "error_id": "mollit veniam",
      "field": "ullamco",
      "message": "velit eiusmod reprehenderit consequat qui",
      "parameter": "Duis consectetur laboris Ut est"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "labore",
      "field": null,
      "message": "consectetur occaecat",
      "parameter": "incididunt do consequat"
    },
    {
      "error_id": "deserunt dolore consequat",
      "field": null,
      "message": "nisi pariatur",
      "parameter": "proident deserunt amet culpa"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "non consectetur minim Ut cupidatat",
      "field": null,
      "message": "quis id cillum",
      "parameter": "cupidatat sed exercitation laboris"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "Lorem aliquip",
      "field": "Duis ut ut Lorem",
      "message": "eiusmod dolor",
      "parameter": "ea nostrud sunt qui"
    },
    {
      "error_id": "sit laborum et ut",
      "field": null,
      "message": "velit laboris officia sint ex",
      "parameter": "nisi Lorem"
    },
    {
      "error_id": "sunt nulla sint",
      "field": "voluptate laboris officia ad Duis",
      "message": "esse cupidatat labore quis",
      "parameter": "in ullamco commodo dolore nostrud"
    },
    {
      "error_id": "veniam dolore",
      "field": null,
      "message": "incididunt in",
      "parameter": "proident ea in velit id"
    },
    {
      "error_id": "laborum ullamco minim consequat sunt",
      "field": null,
      "message": "commodo deserunt",
      "parameter": "officia ipsum"
    }
  ]
}

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`	`"incididunt officia labore proident sunt"`

Request Payload

Response Payload

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

{
  "errors": [
    {
      "error_id": "sit dolore",
      "field": null,
      "message": "qui ut",
      "parameter": "dolore"
    },
    {
      "error_id": "exercitation",
      "field": null,
      "message": "deserunt ad et",
      "parameter": "aliquip"
    },
    {
      "error_id": "occaecat dolor et",
      "field": "esse ea",
      "message": "adipisicing sed nulla",
      "parameter": "occaecat est anim"
    },
    {
      "error_id": "consectetur esse",
      "field": null,
      "message": "dolor",
      "parameter": "officia eiusmod"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "sed",
      "field": null,
      "message": "Duis culpa enim dolore",
      "parameter": "ea"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "voluptate dolor deserunt quis fugiat",
      "field": null,
      "message": "ut",
      "parameter": "dolore amet ut Lorem"
    },
    {
      "error_id": "adipisicing voluptate esse culpa qui",
      "field": "et aute",
      "message": "dolore",
      "parameter": "ut"
    },
    {
      "error_id": "nulla anim",
      "field": "quis qui ut fugiat magna",
      "message": "proident esse officia sed",
      "parameter": "exercitation"
    },
    {
      "error_id": "ex",
      "field": "cupidatat",
      "message": "ut Excepteur",
      "parameter": "nulla dolore laboris dolor"
    },
    {
      "error_id": "enim ullamco dolore minim",
      "field": "aute veniam sunt ut sed",
      "message": "dolore Ut in amet",
      "parameter": "ipsum"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "do nostrud enim",
      "field": "dolor aute ipsum est in",
      "message": "veniam",
      "parameter": "dolore id"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ut et aliqua sit",
      "field": null,
      "message": "commodo dolor",
      "parameter": "veniam amet ad"
    },
    {
      "error_id": "Ut",
      "field": "dolore non proident sunt",
      "message": "do ut consectetur sed occaecat",
      "parameter": "in aliquip mollit"
    }
  ]
}

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`	`"eiusmod ullamco ex laborum amet"`

Request Payload

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

Response Payload

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

{
  "errors": [
    {
      "error_id": "cillum dolor",
      "field": null,
      "message": "in eiusmod est",
      "parameter": "laborum culpa qui eu exercitation"
    },
    {
      "error_id": "nisi consectetur velit",
      "field": null,
      "message": "ea in dolore",
      "parameter": "sint proident"
    },
    {
      "error_id": "ullamco minim cillum",
      "field": "sit in",
      "message": "do occaecat adipisicing sunt est",
      "parameter": "dolor"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "aliquip officia laboris",
      "field": "tempor et voluptate dolor quis",
      "message": "ea do",
      "parameter": "quis"
    },
    {
      "error_id": "amet dolore irure anim culpa",
      "field": null,
      "message": "mollit",
      "parameter": "dolore minim ex"
    },
    {
      "error_id": "ullamco mollit",
      "field": "ea aute sed ipsum quis",
      "message": "occaecat laboris reprehenderit aliqua nisi",
      "parameter": "aliqua aute commodo"
    },
    {
      "error_id": "Duis dolore irure sint",
      "field": "sint fugiat deserunt officia eu",
      "message": "ad labore do ex",
      "parameter": "pariatur aliquip dolore dolore laborum"
    },
    {
      "error_id": "aute do culpa labore",
      "field": "dolore sint laboris eiusmod",
      "message": "nulla veniam in",
      "parameter": "proident incididunt"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "quis velit ad nulla exercitation",
      "field": "non",
      "message": "amet et occaecat anim culpa",
      "parameter": "quis culpa"
    },
    {
      "error_id": "consequat",
      "field": null,
      "message": "culpa in anim sit commodo",
      "parameter": "laboris enim non"
    },
    {
      "error_id": "incididunt ea non",
      "field": "proident",
      "message": "consectetur sunt reprehenderit quis",
      "parameter": "dolor ex"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "officia",
      "field": null,
      "message": "in proident dolore occaecat",
      "parameter": "Duis non nisi"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "nisi nulla laboris id",
      "field": null,
      "message": "labore in exercitation laborum laboris",
      "parameter": "reprehenderit commodo in"
    },
    {
      "error_id": "ut commodo exercitation",
      "field": null,
      "message": "consectetur dolor anim",
      "parameter": "deserunt magna et quis ea"
    },
    {
      "error_id": "quis cillum amet cupidatat ipsum",
      "field": null,
      "message": "commodo",
      "parameter": "dolore"
    },
    {
      "error_id": "anim enim",
      "field": "irure do in velit",
      "message": "Duis Excepteur exercitation dolor in",
      "parameter": "aliquip cillum incididunt"
    },
    {
      "error_id": "consectetur",
      "field": "Lorem aliqua ut dolore",
      "message": "pariatur",
      "parameter": "non"
    }
  ]
}

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`	`"nulla magna dolor officia"`

Request Payload

Response Payload

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

{
  "errors": [
    {
      "error_id": "proident velit officia",
      "field": "minim quis",
      "message": "ut in commodo pariatur",
      "parameter": "officia quis"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "consectetur ea nisi laboris elit",
      "field": "non in voluptate sunt occaecat",
      "message": "ex est",
      "parameter": "officia ex proident"
    },
    {
      "error_id": "eu esse ut deserunt",
      "field": "esse aute Ut",
      "message": "officia",
      "parameter": "mollit ullamco amet"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "laborum exercitation esse",
      "field": "quis voluptate exercitation",
      "message": "id",
      "parameter": "ipsum ut"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "culpa do sed",
      "field": "qui Lorem sit culpa",
      "message": "id",
      "parameter": "dolore veniam"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "eu ullamco ipsum",
      "field": null,
      "message": "irure exercitation eiusmod",
      "parameter": "laboris"
    },
    {
      "error_id": "consequat",
      "field": "culpa aute in dolore",
      "message": "aute fugiat mollit sed ex",
      "parameter": "ea officia cupidatat velit quis"
    },
    {
      "error_id": "minim tempor culpa irure eiusmod",
      "field": null,
      "message": "consectetur eu",
      "parameter": "irure amet esse Lorem"
    },
    {
      "error_id": "fugiat exercitation",
      "field": null,
      "message": "minim dolore esse aliquip",
      "parameter": "irure et ex ut"
    }
  ]
}

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`	`"labore velit amet"`

Request Payload

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

Response Payload

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

{
  "errors": [
    {
      "error_id": "ullamco nostrud in",
      "field": null,
      "message": "sint",
      "parameter": "aliquip proident ea"
    },
    {
      "error_id": "dolor",
      "field": "ad pariatur elit",
      "message": "fugiat et",
      "parameter": "irure aliquip mollit"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ea non velit dolor",
      "field": "in ut commodo qui",
      "message": "Lorem",
      "parameter": "Ut eu"
    },
    {
      "error_id": "Lorem",
      "field": null,
      "message": "ex irure dolore",
      "parameter": "eiusmod aute minim in"
    },
    {
      "error_id": "dolore et incididunt tempor",
      "field": null,
      "message": "nostrud",
      "parameter": "officia"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "esse in labore",
      "field": "do",
      "message": "nulla",
      "parameter": "dolore"
    },
    {
      "error_id": "mollit ex",
      "field": "ad esse ea sint",
      "message": "quis",
      "parameter": "in laborum"
    },
    {
      "error_id": "dolor tempor in dolor adipisicing",
      "field": "cupidatat",
      "message": "mollit elit",
      "parameter": "id"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "laboris",
      "field": null,
      "message": "voluptate deserunt",
      "parameter": "ullamco"
    },
    {
      "error_id": "culpa do in",
      "field": "cillum deserunt",
      "message": "nisi Duis ex dolore dolor",
      "parameter": "exercitation"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "id",
      "field": "laboris dolore aute",
      "message": "esse nisi do in",
      "parameter": "Duis deserunt sunt"
    },
    {
      "error_id": "veniam",
      "field": null,
      "message": "irure ipsum labore tempor",
      "parameter": "Excepteur dolor"
    },
    {
      "error_id": "quis deserunt nulla",
      "field": "fugiat consequat",
      "message": "quis ut dolor in",
      "parameter": "et in consequat aute"
    },
    {
      "error_id": "sit aliquip",
      "field": "mollit sint officia",
      "message": "mollit sunt aliqua Ut aute",
      "parameter": "consequat ut ut"
    }
  ]
}

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`	`"Duis exercitation occaecat et ea"`

Request Payload

Response Payload

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

{
  "errors": [
    {
      "error_id": "laboris proident ex",
      "field": null,
      "message": "cupidatat aute",
      "parameter": "aute"
    },
    {
      "error_id": "labore sit",
      "field": "minim ut cillum ipsum mollit",
      "message": "Excepteur",
      "parameter": "esse non qui exercitation"
    },
    {
      "error_id": "ut",
      "field": null,
      "message": "cupidatat",
      "parameter": "Duis mollit pariatur id Ut"
    },
    {
      "error_id": "fugiat dolore ut ad nulla",
      "field": null,
      "message": "sunt laboris id sint",
      "parameter": "dolore Ut"
    },
    {
      "error_id": "culpa consectetur",
      "field": null,
      "message": "exercitation sunt proident laborum occaecat",
      "parameter": "fugiat anim"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "fugiat voluptate eu Ut",
      "field": "labore elit anim",
      "message": "laborum",
      "parameter": "veniam"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "aliqua tempor culpa",
      "field": "ut nostrud cupidatat pariatur",
      "message": "aliquip proident incididunt officia",
      "parameter": "exercitation sint in"
    },
    {
      "error_id": "id esse laborum",
      "field": null,
      "message": "consectetur dolor amet est",
      "parameter": "dolor"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "Ut Duis ex",
      "field": null,
      "message": "exercitation ipsum ut Duis",
      "parameter": "cillum in nostrud"
    },
    {
      "error_id": "reprehenderit",
      "field": null,
      "message": "cillum elit nulla ea voluptate",
      "parameter": "dolor est"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "consectetur",
      "field": "pariatur Ut nulla",
      "message": "Excepteur aliqua pariatur sed",
      "parameter": "cupidatat irure"
    },
    {
      "error_id": "Lorem tempor sed qui fugiat",
      "field": null,
      "message": "Lorem nulla",
      "parameter": "minim exercitation dolor officia id"
    },
    {
      "error_id": "dolor",
      "field": null,
      "message": "Lorem",
      "parameter": "dolore in"
    },
    {
      "error_id": "mollit nulla tempor",
      "field": null,
      "message": "quis aliquip Duis id",
      "parameter": "irure consectetur et labore"
    },
    {
      "error_id": "tempor consectetur proident aliquip",
      "field": null,
      "message": "dolor dolore adipisicing elit Excepteur",
      "parameter": "dolore id ut Excepteur labore"
    }
  ]
}

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`	`"adipisicing ullamco nisi"`

Request Payload

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

Response Payload

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

{
  "errors": [
    {
      "error_id": "labore cupidatat amet sunt ullamco",
      "field": "in sint Ut",
      "message": "aliquip nulla sit",
      "parameter": "aliqua non irure"
    },
    {
      "error_id": "eu deserunt esse occaecat amet",
      "field": null,
      "message": "elit",
      "parameter": "in aliquip cupidatat eu commodo"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "consectetur in pariatur Lorem",
      "field": "do elit in sed",
      "message": "id Ut magna commodo",
      "parameter": "Duis veniam laboris consequat"
    },
    {
      "error_id": "quis tempor Duis laboris",
      "field": "voluptate est minim sunt ea",
      "message": "ipsum velit amet enim Duis",
      "parameter": "veniam sunt"
    },
    {
      "error_id": "sed laborum mollit",
      "field": "eu est",
      "message": "fugiat",
      "parameter": "et"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "cupidatat ut voluptate consequat",
      "field": null,
      "message": "proident",
      "parameter": "ex"
    },
    {
      "error_id": "deserunt eu",
      "field": null,
      "message": "elit",
      "parameter": "incididunt ea Lorem"
    },
    {
      "error_id": "esse ut voluptate",
      "field": null,
      "message": "dolor aliquip eiusmod",
      "parameter": "et nisi ipsum eiusmod"
    },
    {
      "error_id": "dolor",
      "field": null,
      "message": "amet exercitation labore qui",
      "parameter": "adipisicing quis aliqua anim consequat"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "cillum ipsum aliquip",
      "field": null,
      "message": "laborum",
      "parameter": "elit aliquip amet veniam"
    },
    {
      "error_id": "ut",
      "field": null,
      "message": "nostrud cillum reprehenderit ex dolor",
      "parameter": "ea culpa Lorem magna ad"
    },
    {
      "error_id": "amet labore",
      "field": "et",
      "message": "commodo",
      "parameter": "irure laborum nostrud"
    },
    {
      "error_id": "labore sit esse in",
      "field": "elit occaecat sint et",
      "message": "exercitation sint id",
      "parameter": "consectetur culpa amet exercitation pariatur"
    },
    {
      "error_id": "nisi dolore nostrud esse",
      "field": null,
      "message": "nisi sint commodo",
      "parameter": "Excepteur"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "in Duis",
      "field": null,
      "message": "exercitation veniam qui minim laboris",
      "parameter": "amet culpa"
    },
    {
      "error_id": "irure ex",
      "field": "est sed",
      "message": "reprehenderit sit ullamco velit aute",
      "parameter": "non magna"
    },
    {
      "error_id": "Lorem",
      "field": "labore deserunt reprehenderit",
      "message": "enim",
      "parameter": "consectetur veniam Lorem in officia"
    }
  ]
}

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`	`"Duis"`

Request Payload

Response Payload

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

{
  "errors": [
    {
      "error_id": "aute ex laboris",
      "field": "esse consequat adipisicing nulla",
      "message": "culpa Ut irure",
      "parameter": "velit"
    },
    {
      "error_id": "occaecat voluptate",
      "field": "laboris reprehenderit non eu sed",
      "message": "non ea est velit",
      "parameter": "enim minim anim dolor"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ad Duis",
      "field": "magna cupidatat eu",
      "message": "sit reprehenderit ipsum pariatur",
      "parameter": "occaecat"
    },
    {
      "error_id": "ullamco",
      "field": "dolore fugiat reprehenderit velit",
      "message": "velit consectetur sit pariatur",
      "parameter": "consequat ex nostrud consectetur"
    },
    {
      "error_id": "laborum officia",
      "field": "ipsum voluptate Excepteur dolore officia",
      "message": "sit",
      "parameter": "aute Ut dolore ut"
    },
    {
      "error_id": "proident",
      "field": "in amet non",
      "message": "fugiat",
      "parameter": "sint sed aute exercitation nulla"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "officia ipsum",
      "field": null,
      "message": "consequat",
      "parameter": "minim"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "et tempor",
      "field": null,
      "message": "dolore elit",
      "parameter": "officia et velit amet labore"
    },
    {
      "error_id": "ad",
      "field": null,
      "message": "aliqua officia",
      "parameter": "aute proident dolor"
    },
    {
      "error_id": "incididunt consectetur est sunt veniam",
      "field": null,
      "message": "aliquip cupidatat velit ipsum aliqua",
      "parameter": "reprehenderit magna"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "velit sunt consectetur",
      "field": "occaecat eiusmod amet",
      "message": "cupidatat voluptate magna in veniam",
      "parameter": "exercitation proident"
    },
    {
      "error_id": "ea magna",
      "field": null,
      "message": "sunt mollit veniam voluptate",
      "parameter": "reprehenderit amet"
    },
    {
      "error_id": "ad laboris",
      "field": null,
      "message": "nulla minim veniam in dolor",
      "parameter": "cupidatat exercitation"
    },
    {
      "error_id": "dolore",
      "field": "cupidatat in commodo velit",
      "message": "enim",
      "parameter": "sed reprehenderit ut"
    }
  ]
}

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`	`"ut voluptate consectetur"`

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`	`"ad occaecat id"`

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`	`-5723325`
`offset`	`-50022412`

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

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`	`"laborum sit consectetur"`

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": "cupidatat est",
      "message": "ex"
    },
    {
      "field": "reprehenderit veniam",
      "message": "pariatur"
    },
    {
      "field": "nisi irure",
      "message": "aliquip fugiat ipsum sit nostrud"
    },
    {
      "field": "pariatur Lorem culpa voluptate",
      "message": "amet"
    }
  ]
}

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`	`119`
`offset`	`59830428`

Header Name	Example
`on-behalf-of`	`"dolore est ipsum commodo"`

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`	`"dolore et occaecat nostrud incididunt"`

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`	`-27413534`
`offset`	`-77735195`

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`	`"ea aliqua"`

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`	`"pariatur culpa mollit anim ex"`

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`	`"quis laborum consectetur"`

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`	`"consequat"`

Request Payload

Response Payload

{
  "errors": [
    {
      "field": "laborum Duis minim deserunt non",
      "message": "officia Excepteur Lorem"
    },
    {
      "field": "nisi ut",
      "message": "eiusmod ad pariatur cupidatat tempor"
    },
    {
      "field": "Lorem ea",
      "message": "reprehenderit consectetur ad"
    },
    {
      "field": "est deserunt commodo tempor Duis",
      "message": "consectetur fugiat aliquip nisi"
    },
    {
      "field": "Duis laborum reprehenderit ex",
      "message": "et ipsum labore anim ea"
    }
  ]
}

{
  "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": "sunt velit minim consequat in",
      "message": "reprehenderit consectetur"
    },
    {
      "field": "ex proident",
      "message": "voluptate"
    },
    {
      "field": "ullamco voluptate in et",
      "message": "ut"
    }
  ]
}

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`	`"ut id fugiat in"`

Request Payload

Response Payload

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

{
  "errors": [
    {
      "field": "sint in ullamco cillum",
      "message": "elit ut aliqua"
    },
    {
      "field": "magna cupidatat",
      "message": "in reprehenderit"
    },
    {
      "field": "esse aliqua ea mollit in",
      "message": "esse nulla laborum ut"
    },
    {
      "field": "sed culpa in",
      "message": "in ut labore et"
    }
  ]
}

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`	`"dolore"`
`on-behalf-of`	`"proident in cillum Excepteur consequat"`

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": "sed mollit cupidatat",
  "message": "nulla Excepteur do qui"
}

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`	`"sit"`
`on-behalf-of`	`"exercitation ut dolore eu"`

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`	`"voluptate"`
`on-behalf-of`	`"esse enim sint anim aute"`

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`	`"aute sit aliqua adipisicing est"`

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`	`"aute aliqua sunt veniam"`

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`	`"ad"`

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`	`"laborum"`

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`	`"consectetur quis ex"`

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`	`"ipsum"`

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`	`"est incididunt nisi"`

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 exercitation"`

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`	`"adipisicing mollit Duis tempor"`

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`	`"irure deserunt"`

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`	`"aliqua irure"`

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`	`dolore id eu culpa ex`
`limit`	`-48677325`
`offset`	`-35065912`

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`	`nisi voluptate Duis`

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`*	`mollit laborum Lorem qui`
`sort_by_metric`	`dolor aute`
`sort_by_direction`	`desc`
`limit`	`-68692769`
`offset`	`92114584`

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`*	`ullamco ut voluptate eu`
`subuser`	`tempor`
`sort_by_metric`	`bounces`
`sort_by_direction`	`asc`
`limit`	`-98491550`
`offset`	`-18122205`

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`	`asc`
`start_date`*	`do occaecat consectetur quis`
`end_date`	`Lorem in ullamco eiusmod`
`limit`	`-40595513`
`offset`	`762433`
`aggregated_by`	`dolore exercitation`
`sort_by_metric`	`ad velit irure`

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`	`-7272147`
`offset`	`68344692`
`aggregated_by`	`week`
`subusers`*	`in occaecat laborum`
`start_date`*	`dolor fugiat tempor`
`end_date`	`aliquip`

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`	`"id dolor amet reprehenderit sed"`

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`	`-79979892`

Header Name	Example
`on-behalf-of`	`"voluptate ipsum sed nisi"`

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`	`"mollit"`

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`	`"consectetur sit mollit consequat"`

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`	`"mollit pariatur dolore"`

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`	`"commodo occaecat nulla enim"`

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`	`consequat eiusmod veniam`

Header Name	Example
`on-behalf-of`	`"velit dolor dolor ipsum dolore"`

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`*	`nostrud et`

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`*	`amet adipisicing aute 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`	`"dolor in"`

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`	`9936599`
`offset`	`-46087064`
`ip`	`ut tempor Duis`

Header Name	Example
`on-behalf-of`	`"elit labore 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`	`"adipisicing commodo occaecat"`

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`	`"occaecat eiusmod aliqua"`

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 pariatur 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": "non",
    "field": "sunt ad id"
  }
}

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 velit`
`exclude_whitelabels`	`true`
`limit`	`68067153`
`offset`	`85549894`
`subuser`	`incididunt esse ut do`
`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`	`-42121325`
`offset`	`93875715`
`exclude_subusers`	`true`
`username`	`adipisicing nostrud nulla`
`domain`	`Excepteur enim in`

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

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`	`"exercitation pariatur magna"`

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`	`"non"`

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`	`"est dolor in reprehenderit"`

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`	`"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`	`fugiat`

Header Name	Example
`on-behalf-of`	`"aliqua Duis"`

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`	`"voluptate"`

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`	`"sunt dolor"`

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`	`"irure"`

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 exercitation nulla laborum`

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`	`proident ut sit non ipsum`

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": "elit"
    },
    {
      "message": "esse sit ut nulla"
    },
    {
      "message": "laborum consectetur veniam nostrud aute"
    },
    {
      "message": "est ut"
    },
    {
      "message": "pariatur ullamco dolor esse"
    }
  ]
}

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

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": "officia consequat laborum elit fugiat",
      "field": "ut elit",
      "message": "consequat ut aute irure in"
    }
  ]
}

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

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

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

{
  "errors": [
    {
      "message": "Excepteur pariatur ad"
    },
    {
      "message": "nulla eu cupidatat nostrud reprehenderit"
    },
    {
      "message": "ut nulla"
    }
  ]
}

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`	`60016532.56054294`
`lastSeenID`	`-44139167.39310859`
`id`	`-40640146`

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": "cillum sit"
    }
  ]
}

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": "qui in fugiat consequat in",
      "message": "ut"
    }
  ]
}

{
  "errors": [
    {
      "message": "ullamco"
    },
    {
      "message": "veniam"
    }
  ]
}

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": "enim",
      "field": "amet",
      "message": "ea velit"
    },
    {
      "error_id": "aliqua nostrud ut aliquip",
      "field": "do Lorem pariatur anim",
      "message": "ex do est Duis"
    },
    {
      "error_id": "aliqua",
      "field": "laboris magna proident ipsum",
      "message": "ullamco in"
    },
    {
      "error_id": "consectetur cillum nisi id consequat",
      "field": "Excepteur sunt dolor aliqua",
      "message": "laboris eiusmod sed sint Lorem"
    }
  ]
}

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

{
  "errors": [
    {
      "error_id": "deserunt minim et",
      "message": "consectetur laboris officia anim"
    },
    {
      "error_id": "dolore labore magna mollit",
      "message": "officia"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "consectetur Excepteur",
      "message": "consequat ut laboris in adipisicing"
    },
    {
      "error_id": "sint",
      "message": "ex"
    }
  ]
}

{
  "errors": [
    {
      "message": "enim dolore"
    },
    {
      "message": "aliquip elit"
    },
    {
      "message": "ullamco voluptate"
    }
  ]
}

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": "qui",
      "message": "laborum amet"
    },
    {
      "error_id": "laboris do labore in Ut",
      "message": "Excepteur Lorem aute"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "nisi do ad elit",
      "message": "non anim aliquip Ut voluptate"
    },
    {
      "error_id": "dolore sint",
      "message": "non laboris est"
    },
    {
      "error_id": "tempor elit in eu Excepteur",
      "message": "eiusmod"
    },
    {
      "error_id": "ipsum ut",
      "message": "dolore"
    },
    {
      "error_id": "tempor non sint sit",
      "message": "sed nostrud in"
    }
  ]
}

{
  "errors": [
    {
      "message": "voluptate"
    },
    {
      "message": "sit sed amet"
    },
    {
      "message": "id culpa aliqua exercitation"
    },
    {
      "message": "do magna"
    }
  ]
}

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": "amet Duis quis dolore labore",
      "message": "nulla enim magna Duis"
    },
    {
      "error_id": "enim et est esse ut",
      "message": "proident exercitation cillum et sit"
    },
    {
      "error_id": "id consectetur sed exercitation culpa",
      "message": "mollit reprehenderit in"
    },
    {
      "error_id": "dolor consequat nisi aliquip sit",
      "message": "quis occaecat est veniam elit"
    }
  ]
}

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

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

{
  "errors": [
    {
      "error_id": "deserunt mollit consectetur",
      "message": "aliqua incididunt reprehenderit"
    },
    {
      "error_id": "in",
      "message": "consequat ipsum"
    },
    {
      "error_id": "dolore eu dolor",
      "message": "dolore"
    },
    {
      "error_id": "irure esse nisi dolore Lorem",
      "message": "eu et cupidatat ex anim"
    }
  ]
}

{
  "errors": [
    {
      "message": "laboris aute nostrud"
    },
    {
      "message": "tempor amet adipisicing dolor"
    }
  ]
}

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": "velit labore",
  "field": "occaecat",
  "message": "sunt mollit"
}

{
  "errors": [
    {
      "error_id": "commodo",
      "field": "culpa ipsum",
      "message": "enim dolor Lorem in"
    },
    {
      "error_id": "mollit",
      "field": "veniam voluptate irure tempor",
      "message": "laborum ad in"
    },
    {
      "error_id": "proident fugiat",
      "field": "in sit in Duis pariatur",
      "message": "ut"
    }
  ]
}

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": "ut proident Ut dolore dolore",
      "field": "adipisicing esse dolor cupidatat",
      "message": "dolor"
    },
    {
      "error_id": "anim Excepteur",
      "field": "cillum ad proident",
      "message": "anim cupidatat Duis dolore"
    },
    {
      "error_id": "eiusmod veniam sunt culpa deserunt",
      "field": "incididunt id commodo",
      "message": "consectetur"
    },
    {
      "error_id": "voluptate",
      "field": "dolor",
      "message": "laboris fugiat irure ad elit"
    },
    {
      "error_id": "id",
      "field": "do ad in velit",
      "message": "sunt ex consectetur tempor"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "nulla dolore tempor ullamco",
      "field": "amet esse sint",
      "message": "dolor"
    },
    {
      "error_id": "et ipsum nisi",
      "field": "enim consequat laboris",
      "message": "ipsum"
    },
    {
      "error_id": "ut eu exercitation",
      "field": "cupidatat laboris aliqua nisi do",
      "message": "ut"
    },
    {
      "error_id": "mollit commodo ullamco do pariatur",
      "field": "et incididunt aute quis do",
      "message": "labore deserunt Lorem"
    }
  ]
}

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": "Excepteur deserunt minim",
      "field": "incididunt cillum sunt Excepteur sit",
      "message": "id consequat ut"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "adipisicing",
      "field": "incididunt",
      "message": "est ut pariatur ut sunt"
    },
    {
      "error_id": "laborum veniam Duis officia",
      "field": "esse aliqua nostrud sunt ullamco",
      "message": "culpa"
    }
  ]
}

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": "proident amet voluptate aliqua reprehenderit",
      "field": "nisi consectetur do ea cillum",
      "message": "aute Ut cupidatat dolor"
    },
    {
      "error_id": "cillum in ad",
      "field": "nisi voluptate amet cupidatat deserunt",
      "message": "aliqua Ut ut tempor non"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ex eu Lorem amet",
      "field": "dolore dolore commodo sed",
      "message": "consectetur deserunt"
    },
    {
      "error_id": "dolor magna deserunt",
      "field": "dolor cupidatat",
      "message": "non irure enim"
    },
    {
      "error_id": "dolore",
      "field": "in",
      "message": "anim sint in"
    },
    {
      "error_id": "ad Excepteur ipsum dolor minim",
      "field": "elit id ad",
      "message": "dolore quis et"
    },
    {
      "error_id": "fugiat exercitation sunt",
      "field": "ea officia",
      "message": "ea velit nostrud"
    }
  ]
}

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": "Ut",
      "field": "mollit sint nulla in",
      "message": "proident"
    },
    {
      "error_id": "aliqua aute velit",
      "field": "dolor",
      "message": "occaecat ut fugiat"
    },
    {
      "error_id": "Duis nostrud sit in",
      "field": "in et voluptate",
      "message": "tempor id cupidatat"
    }
  ]
}

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`	`28620504`
`page_token`	`ipsum sit mollit qui id`
`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": "adipisicing aliquip sed proident",
      "field": "exercitation velit",
      "message": "pariatur Duis"
    },
    {
      "error_id": "nisi voluptate occaecat fugiat veniam",
      "field": "culpa",
      "message": "amet laboris velit"
    },
    {
      "error_id": "cupidatat",
      "field": "officia nostrud consectetur qui quis",
      "message": "Ut"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "labore exercitation commodo",
      "field": "fugiat",
      "message": "irure anim elit est"
    },
    {
      "error_id": "labore",
      "field": "mollit dolor aliquip commodo",
      "message": "dolor"
    },
    {
      "error_id": "consequat dolor nostrud incididunt",
      "field": "pariatur exercitation",
      "message": "commodo culpa id ut in"
    },
    {
      "error_id": "consequat dolor sed",
      "field": "aliquip dolore",
      "message": "enim eiusmod"
    },
    {
      "error_id": "laborum",
      "field": "deserunt aute ipsum veniam",
      "message": "mollit laborum tempor eiusmod esse"
    }
  ]
}

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": "velit occaecat",
      "field": "cupidatat nisi",
      "message": "non irure ullamco"
    },
    {
      "error_id": "deserunt Lorem officia ad proident",
      "field": "quis",
      "message": "aliqua"
    },
    {
      "error_id": "labore voluptate ipsum",
      "field": "incididunt commodo consequat minim",
      "message": "tempor deserunt in sed"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "proident tempor eiusmod",
      "field": "culpa dolore ex",
      "message": "proident in laboris"
    },
    {
      "error_id": "sint in",
      "field": "Ut et",
      "message": "irure consectetur nulla eu exercitation"
    },
    {
      "error_id": "deserunt esse dolor",
      "field": "Duis occaecat laboris",
      "message": "do nisi ea dolore"
    },
    {
      "error_id": "eiusmod",
      "field": "incididunt voluptate quis laborum sed",
      "message": "consequat nulla"
    },
    {
      "error_id": "minim",
      "field": "fugiat tempor",
      "message": "amet sunt qui non dolor"
    }
  ]
}

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`	`5874810`
`page_token`	`aute minim aliquip occaecat sed`
`summary`	`true`

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": "nisi cupidatat",
      "address_line_2": "in",
      "alternate_emails": [
        "dolor",
        "elit enim sint",
        "non enim labore in irure",
        "sit",
        "deserunt velit consequat"
      ],
      "city": "cupidatat laborum",
      "country": "velit Duis in qui 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": "cillum aliquip",
      "first_name": "",
      "last_name": "Lorem",
      "postal_code": "in ullamco ea esse",
      "state_province_region": "fugiat ullamco velit pariatur"
    },
    {
      "address_line_1": "ea amet Ut",
      "address_line_2": "et esse adipisicing non",
      "alternate_emails": [
        "culpa in Lorem sunt sed",
        "ut fugiat",
        "eiusmod",
        "incididunt",
        "exercitation occaecat aliqua nostrud"
      ],
      "city": "eu aliquip sed voluptate",
      "country": "minim irure",
      "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 incididunt",
      "first_name": "incididunt",
      "last_name": "sint e",
      "postal_code": "sit",
      "state_province_region": "ut ex Excepteur ut"
    },
    {
      "address_line_1": "quis pariatur i",
      "address_line_2": "cillum",
      "alternate_emails": [
        "enim in mollit velit",
        "dolore",
        "cupidatat Lorem",
        "consectetur sunt ea veniam in",
        "sed quis nulla"
      ],
      "city": "consectetur sit",
      "country": "velit proident",
      "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": "officia consequat labore sed eiusmod",
      "first_name": "irure veniam sit",
      "last_name": "in laborum ut incididunt",
      "postal_code": "culpa sit dolore sed",
      "state_province_region": "eiusmod iru"
    },
    {
      "address_line_1": "ame",
      "address_line_2": "aute est nisi dolore",
      "alternate_emails": [
        "",
        "sunt exercitation v",
        "culpa adipisicing tempor Excepteur ea",
        "ullamco",
        "culpa Lorem elit deserunt nostrud"
      ],
      "city": "commodo do in",
      "country": "ut",
      "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": "voluptate",
      "first_name": "Excepteur velit veniam irure",
      "last_name": "voluptate consequat",
      "postal_code": "dolore laborum reprehenderit est",
      "state_province_region": "deserunt quis ex"
    },
    {
      "address_line_1": "commodo in",
      "address_line_2": "dolore aliquip laborum pariatur ",
      "alternate_emails": [
        "aute velit Duis commodo deserunt",
        "laboris laborum",
        "in cillum eu",
        "dolore enim",
        "elit est"
      ],
      "city": "proident eiu",
      "country": "cillum aute",
      "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": "mollit sed dolore",
      "first_name": "do irure labore aute anim",
      "last_name": "quis",
      "postal_code": "laborum dolor et",
      "state_province_region": "laborum eu culpa deserunt aliqua"
    },
    {
      "address_line_1": "Excepteur",
      "address_line_2": "in ut adipisicing aliquip",
      "alternate_emails": [
        "veniam qui laboris mollit ex",
        "in voluptate laborum esse",
        "aliqua eu in reprehenderit",
        "ut",
        "nulla et tempor consectetur cupidatat"
      ],
      "city": "elit laborum mollit sed",
      "country": "ea",
      "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": "ipsum pariatur aliquip est nulla",
      "first_name": "ullamco est dolore",
      "last_name": "consectetur",
      "postal_code": "pariatur in nisi aute exercitation",
      "state_province_region": "commodo"
    },
    {
      "address_line_1": "non ullamco laboris",
      "address_line_2": "in ",
      "alternate_emails": [
        "ipsum ex elit dolore",
        "sed quis",
        "sint",
        "cupidatat",
        "proident"
      ],
      "city": "cupidatat tempor i",
      "country": "proident nulla reprehenderit consecte",
      "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": "elit dolor",
      "first_name": "do esse anim velit veniam",
      "last_name": "nostrud",
      "postal_code": "nisi ut",
      "state_province_region": "ut ullamco"
    },
    {
      "address_line_1": "ut",
      "address_line_2": "ut voluptate id incididunt",
      "alternate_emails": [
        "dolor anim fugiat ad",
        "ea",
        "reprehenderit aliquip amet sit laborum",
        "esse",
        "ipsum incididunt"
      ],
      "city": "enim",
      "country": "v",
      "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": "nostrud",
      "first_name": "ut esse qui",
      "last_name": "ut ut est magna",
      "postal_code": "laborum mollit ut Ut Excepteur",
      "state_province_region": "in"
    },
    {
      "address_line_1": "sint commodo nisi velit elit",
      "address_line_2": "deserunt minim",
      "alternate_emails": [
        "sed cillum est",
        "do cillum nostrud",
        "dolore qui incididunt",
        "Duis mollit reprehenderit",
        "ullamco in"
      ],
      "city": "Excepte",
      "country": "minim qui anim voluptate",
      "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": "id",
      "first_name": "",
      "last_name": "in m",
      "postal_code": "magna",
      "state_province_region": "nisi"
    },
    {
      "address_line_1": "in ea Lorem",
      "address_line_2": "cillum ex",
      "alternate_emails": [
        "consectetur",
        "occaecat exercitation",
        "enim laborum velit sunt in",
        "ex tempor nostrud eiusmod ipsum",
        "tempor velit"
      ],
      "city": "eu aliquip proident",
      "country": "magna reprehen",
      "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": "est qui irure incididunt quis",
      "first_name": "incididunt",
      "last_name": "ut ",
      "postal_code": "dolore in",
      "state_province_region": "Excepteur nostr"
    }
  ],
  "list_ids": [
    "a710a733-cd94-7e2c-a9fc-f825b72a866f",
    "4d9bb52b-87ea-a271-b5d8-912619bbf1a8"
  ]
}

Response Payload

{
  "job_id": "id nisi"
}

{
  "errors": [
    {
      "error_id": "dolore",
      "field": "ipsum ullamco reprehenderit",
      "message": "minim",
      "parameter": "cillum laborum anim ea"
    },
    {
      "error_id": "ut et",
      "field": "eu",
      "message": "non qui aliquip minim adipisicing",
      "parameter": "incididunt qui id"
    }
  ]
}

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

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

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

{
  "errors": [
    {
      "message": "pariatur minim"
    },
    {
      "message": "commodo"
    },
    {
      "message": "dolore elit Ut ut aute"
    }
  ]
}

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`	`eiusmod`
`ids`	`irure ullamco labore eiusmod`

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": "eu in in esse Ut"
    }
  ]
}

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

{
  "errors": [
    {
      "error_id": "consectetur eiusmod ullamco laborum magna",
      "field": "fugiat id dolor",
      "message": "Excepteur qui dolore",
      "parameter": "elit in"
    },
    {
      "error_id": "ea Excepteur dolor incididunt",
      "field": "tempor veniam adipisicing in exercitation",
      "message": "nostrud quis aute laboris",
      "parameter": "exercitation deserunt anim magna nostrud"
    },
    {
      "error_id": "in eu qui ut officia",
      "field": "in",
      "message": "minim proident",
      "parameter": "anim magna ipsum ut"
    },
    {
      "error_id": "eu ex deserunt cillum magna",
      "field": "Duis",
      "message": "velit dolor tempor",
      "parameter": "exercitation veniam"
    },
    {
      "error_id": "tempor ea aute officia veniam",
      "field": "Excepteur anim laboris occaecat commodo",
      "message": "sed occaecat exercitation reprehenderit aliqua",
      "parameter": "proident incididunt dolor magna Duis"
    }
  ]
}

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

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

{}

{
  "errors": [
    {
      "message": "velit incididunt"
    },
    {
      "message": "ea"
    },
    {
      "message": "ut"
    }
  ]
}

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": 87971672
  },
  "billable_count": 78000179,
  "contact_count": 67793446
}

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

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

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

{
  "errors": [
    {
      "message": "in minim dolor"
    },
    {
      "message": "Duis voluptate ad"
    },
    {
      "message": "commodo"
    },
    {
      "message": "in fugiat"
    }
  ]
}

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": "json",
  "list_ids": [
    "cd2dbb21-129b-efc8-a2a4-adb6d1c68bd1",
    "8d379dcc-68d1-1445-9656-4417e440ef5e",
    "b76ee29b-1d64-4d8a-12e3-fce11eab7a8a",
    "1e9f03e8-4389-a39c-35ec-f62ef72c06b1"
  ],
  "max_file_size": 16797326,
  "notifications": {
    "email": true
  },
  "segment_ids": [
    "voluptate nisi dolor ad cillum",
    "sed tempor id occaecat in",
    "voluptate nisi Ut nulla"
  ]
}

Response Payload

{
  "_metadata": {
    "count": -41274166.42510826,
    "next": "http://pnxYMqQposWXzNJtIBtgjoARaXt.zxjvaAKfJ+4BUfkXiCl3XUy1,6y.+4emKF-yePIBNFyapg1BUwsB",
    "prev": "http://KEUBUqZkzJATkdPKzmDYTkWxgHhI.xdajczFmIB+4SJidxID7lbuCLTjjF3",
    "self": "http://pBWnOxwaKOJQgvUuEsLnedHTlwWME.bluyHJir79NR7ZyWrDRZxCjCSIZxBq"
  },
  "id": "et"
}

{
  "errors": [
    {
      "error_id": "fugiat",
      "field": "exercitation ex magna dolor id",
      "message": "minim",
      "parameter": "dolore et nisi"
    },
    {
      "error_id": "ad",
      "field": "aute adipisicing veniam ullamco",
      "message": "quis",
      "parameter": "in"
    },
    {
      "error_id": "tempor dolor",
      "field": "dolor adipisicing cupidatat magna",
      "message": "laborum dolore minim nisi in",
      "parameter": "ea"
    },
    {
      "error_id": "ullamco officia ipsum",
      "field": "magna",
      "message": "aute exercitation ut cillum adipisicing",
      "parameter": "consequat"
    },
    {
      "error_id": "nulla mollit cupidatat",
      "field": "laboris",
      "message": "dolore ex fugiat",
      "parameter": "veniam cupidatat irure"
    }
  ]
}

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

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

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

{
  "errors": [
    {
      "message": "occaecat ea proident commodo"
    },
    {
      "message": "Ut"
    }
  ]
}

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

{
  "errors": [
    {
      "": "mollit aliquip in fugiat ut",
      "error_id": "in qui cillum",
      "message": "labore commodo"
    },
    {
      "": "quis Ut in ipsum sed",
      "error_id": "dolor fugiat anim",
      "message": "reprehenderit irure voluptate"
    },
    {
      "": "sit aliqua esse",
      "error_id": "laborum tempor cillum ea Excepteur",
      "message": "culpa do Lorem"
    },
    {
      "": "dolor nulla dolore",
      "error_id": "minim aliqua veniam aute amet",
      "message": "veniam in dolor amet voluptate"
    },
    {
      "": "anim Ut mollit",
      "error_id": "Lorem",
      "message": "dolore tempor eu fugiat nulla"
    }
  ]
}

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

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

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

{
  "errors": [
    {
      "message": "consequat ullamco Duis dolore ea"
    },
    {
      "message": "ea aliqua est dolore"
    },
    {
      "message": "do in"
    }
  ]
}

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": "laborum enim mollit qui"
  },
  "address_line_1": "in exercitation ex nisi",
  "address_line_2": "tempor irure sit incididunt",
  "alternate_emails": [
    "magna mollit"
  ],
  "city": "aliqua ut proident",
  "country": "veniam minim Duis",
  "created_at": "consectetur ut exercitation",
  "custom_fields": {},
  "email": "fugiat irure amet exercitation",
  "facebook": "proident id incididunt minim Lorem",
  "first_name": "aliquip occaecat dolore",
  "id": "irure adipisicing",
  "last_name": "deserunt",
  "line": "est cupidatat nulla eiusmod",
  "list_ids": [
    "aliquip enim commodo et reprehenderit",
    "cupidatat aliqua commodo sunt nostrud",
    "sunt deserunt",
    "eu Duis elit aute"
  ],
  "phone_number": "eiusmod aliqua dolor occaecat anim",
  "postal_code": "officia ea qui dolor",
  "segment_ids": [
    "consectetur",
    "pariatur sit dolor dolore",
    "ipsum officia esse",
    "ex velit proident ullamco quis",
    "eu consequat laborum"
  ],
  "state_province_region": "aliqua dolore Duis est pariatur",
  "unique_name": "cupidatat quis magna nulla",
  "updated_at": "nostrud Duis in incididunt",
  "whatsapp": "cillum magna exercitation"
}

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

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

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

{
  "errors": [
    {
      "message": "qui quis"
    },
    {
      "message": "labore culpa nulla cupidatat ea"
    }
  ]
}

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

{
  "errors": [
    {
      "field": "in",
      "message": "nulla veniam"
    },
    {
      "field": "ad tempor",
      "message": "Duis pariatur aliqua"
    }
  ]
}

{
  "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": "sit in laboris Duis"
    },
    {
      "message": "sed do ut ullamco Ut"
    }
  ]
}

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,
    "laboris amet",
    null,
    "nulla culpa commodo ex enim",
    null
  ],
  "file_type": "csv",
  "list_ids": [
    "consequat",
    "cupidatat consectetur quis"
  ]
}

Response Payload

{
  "job_id": "Lorem ut non consequat ullamco",
  "upload_headers": [
    {
      "header": "consectetur qui sint",
      "value": "cupidatat"
    },
    {
      "header": "enim",
      "value": "eu nisi occaecat do"
    },
    {
      "header": "proident ut sit",
      "value": "qui"
    },
    {
      "header": "voluptate qui incididunt",
      "value": "ad cillum do"
    },
    {
      "header": "quis",
      "value": "tempor enim sint eiusmod"
    }
  ],
  "upload_uri": "sunt officia elit sit"
}

{
  "errors": [
    {
      "error_id": "nostrud irure",
      "field": "do",
      "message": "eiusmod incididunt ipsum consequat officia",
      "parameter": "veniam do voluptate labore"
    }
  ]
}

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

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

{
  "errors": [
    {
      "error_id": "tempor occaecat commodo minim dolor",
      "field": "eu in est pariatur",
      "message": "fugiat in nostrud ullamco id",
      "parameter": "et"
    },
    {
      "error_id": "pariatur deserunt",
      "field": "sunt Lorem ipsum",
      "message": "Duis",
      "parameter": "ullamco dolore nulla est ut"
    }
  ]
}

{
  "errors": [
    {
      "message": "irure sed enim culpa"
    },
    {
      "message": "qui non minim"
    },
    {
      "message": "labore laboris in"
    },
    {
      "message": "in ad aliquip nulla"
    },
    {
      "message": "est"
    }
  ]
}

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": "laborum exercitation",
  "id": "ut deserunt aute in",
  "job_type": "dolore nulla exercitation",
  "results": {
    "created_count": -90618472.14231533,
    "deleted_count": -33048825.96157723,
    "errored_count": 64041974.46101004,
    "errors_url": "nostrud tempor ut",
    "requested_count": 24985875.07783699,
    "updated_count": 22655154.673909366
  },
  "started_at": "ipsum",
  "status": "cillum ipsum sint non occaecat"
}

{
  "errors": {
    "error_id": "reprehenderit in quis",
    "field": "Lorem id ipsum",
    "message": "ullamco ut id",
    "parameter": "est minim aute qui ea"
  }
}

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

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

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

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

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": 47553705.22964218,
    "next": "https://FrqNzlJjBEFWpumxqSPdRg.wzpvC,UET+SUxEsRe,XkVh8unZ,HpPDAg9OPlQNhrAfSc4D4hW",
    "prev": "http://LUBnjiJvjAQOSVUheeQXEZqS.ewMhFcvYhupexADYl2-PpHP7MYoGXQiJWZorPZG2agFn",
    "self": "https://kvwP.lcjzJxq+w8k3Z,iFa0qss0QG6fO6rcTQFtudSnCNv9"
  },
  "completed_at": "dolor incididunt",
  "contact_count": 60010401,
  "created_at": "sunt velit",
  "expires_at": "velit culpa",
  "id": "esse commodo adipisicing pariatur non",
  "message": "pariatur labore nulla dolor amet",
  "status": "pending",
  "updated_at": "irure magna",
  "urls": [
    "reprehenderit adipisicing qui"
  ]
}

{
  "errors": [
    {
      "error_id": "ea esse quis",
      "field": "ut cupidatat irure",
      "message": "ad ea",
      "parameter": "in do anim ex"
    },
    {
      "error_id": "nostrud deserunt non fugiat ipsum",
      "field": "in",
      "message": "voluptate quis nisi Ut consectetur",
      "parameter": "qui exercitation proident ex in"
    },
    {
      "error_id": "occaecat dolore aute aliquip ullamco",
      "field": "elit laborum cillum do",
      "message": "sint aliquip nostrud non dolore",
      "parameter": "occaecat non magna pariatur"
    }
  ]
}

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

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

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

{
  "errors": [
    {
      "message": "sit proident sint"
    },
    {
      "message": "minim voluptate"
    },
    {
      "message": "esse laboris occaecat reprehenderit"
    }
  ]
}

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

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

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

{}

{
  "errors": [
    {
      "message": "consequat cupidatat commodo et do"
    },
    {
      "message": "non ipsum reprehenderit adipisicing in"
    },
    {
      "message": "minim veniam ut Lorem"
    }
  ]
}

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": "Duis tempor ullamco culpa cillum"
    },
    {
      "message": "id"
    },
    {
      "message": "adipisicing dolor nulla non"
    },
    {
      "message": "nostrud elit qui do"
    },
    {
      "message": "Ut qui in veniam"
    }
  ]
}

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": "sed do",
  "parent_list_ids": [
    "ea labore proident eiusmod",
    "mollit dolor consequat cupidatat minim"
  ],
  "query_dsl": "sunt officia eiusmod"
}

Response Payload

{
  "contacts_count": 76181902,
  "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": "pariatur",
  "id": "d1a0fa73-243d-34d0-ae93-92c3f9264d3c",
  "name": "anim nul",
  "next_sample_update": "aliquip in eu sint",
  "parent_list_ids": [
    "aute Duis",
    "laborum",
    "Lorem qui tempor anim",
    "ipsum dolore"
  ],
  "query_dsl": "exercitation",
  "query_version": "velit laboris",
  "sample_updated_at": "dolore officia ut nulla Duis",
  "status": {
    "error_message": "consectetur",
    "query_validation": "commodo elit irure id"
  },
  "updated_at": "aliqua cillum nostrud labore"
}

{
  "errors": [
    {
      "field": "ipsum pariatur aute",
      "message": "nulla"
    },
    {
      "field": "cillum",
      "message": "anim"
    },
    {
      "field": "labore dolor incididunt",
      "message": "ipsum veniam"
    },
    {
      "field": "officia proident laboris aliquip",
      "message": "veniam minim sint"
    }
  ]
}

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": "elit id do exercitation",
      "message": "est do consequat"
    },
    {
      "field": "nisi in eu Ut",
      "message": "laborum ea officia"
    },
    {
      "field": "eu",
      "message": "sit est nulla"
    },
    {
      "field": "ad pariatur minim reprehenderit proident",
      "message": "pariatur laborum 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`	`elit minim nulla ullamco`
`no_parent_list_id`	`true`

Request Payload

Response Payload

{
  "_metadata": {
    "count": 20678469,
    "next": "https://RVS.oujrZtUpxBmoigC50ZU0VX0u0",
    "prev": "https://XykJYPRdwQpEBEzUT.vdqltm+HQZe",
    "self": "http://UvBcRyICcKvbiYqsayrKyuUoteQWIy.qwXrEB5IGYZo-jDreJyPRxlT4PyF0Eodv.x76"
  },
  "contacts_count": -63819883,
  "created_at": "officia amet incididunt",
  "id": "1f7b8ff2-a93e-c095-4271-5ba044a9f91a",
  "name": "ad in",
  "next_sample_update": "magna sed amet aute",
  "parent_list_ids": [
    "velit",
    "deserunt amet"
  ],
  "query_version": "commodo consectetur velit eu",
  "sample_updated_at": "laborum Lorem ex",
  "status": {
    "error_message": "reprehenderit nulla",
    "query_validation": "Duis velit"
  },
  "updated_at": "anim"
}

{
  "errors": [
    {
      "field": "ex ut ut in",
      "message": "pariatur sed quis"
    },
    {
      "field": "aliquip adipisicing elit aute voluptate",
      "message": "nostrud eu officia"
    },
    {
      "field": "ad ex aliqua adipisicing mollit",
      "message": "dolor dolor ex nulla"
    },
    {
      "field": "ut cupidatat culpa adipisicing",
      "message": "non"
    },
    {
      "field": "Ut occaecat mollit",
      "message": "officia incididunt"
    }
  ]
}

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

{
  "errors": [
    {
      "field": "nulla aute",
      "message": "do"
    },
    {
      "field": "nisi incididunt voluptate veniam",
      "message": "do sint"
    },
    {
      "field": "dolor est magna incididunt",
      "message": "enim non Lorem"
    },
    {
      "field": "consequat in nisi",
      "message": "officia sunt"
    }
  ]
}

PATCH

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

Request Payload

{
  "name": "mollit consequat",
  "query_dsl": "commodo amet in dolor cillum"
}

Response Payload

{
  "contacts_count": -85308801,
  "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"
    }
  ],
  "created_at": "aliquip ex eiusmod",
  "id": "dfb14ef6-71cb-00cd-22b3-385d61300d7b",
  "name": "ad",
  "next_sample_update": "non",
  "parent_list_ids": [
    "ex in aliqua tempor in"
  ],
  "query_dsl": "tempor fugiat consequat adipisicing eiusmod",
  "query_version": "tempor ut",
  "sample_updated_at": "consectetur in labore reprehenderit",
  "status": {
    "error_message": "officia ipsum reprehenderit",
    "query_validation": "velit est mollit"
  },
  "updated_at": "adipisicing"
}

{
  "errors": [
    {
      "field": "Excepteur in",
      "message": "non"
    },
    {
      "field": "velit",
      "message": "eiusmod sunt ipsum nulla"
    },
    {
      "field": "qui mollit voluptate deserunt Lorem",
      "message": "nisi amet quis enim"
    }
  ]
}

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

{
  "errors": [
    {
      "field": "fugiat",
      "message": "amet aute Duis"
    },
    {
      "field": "consequat in qui adipisicing",
      "message": "reprehenderit velit"
    }
  ]
}

GET

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

Query Parameter Name	Example
`contacts_sample`	`false`

Request Payload

Response Payload

{
  "contacts_count": 64103305,
  "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": "non ad dolor consectetur",
  "id": "f5668a2f-6299-728a-92c5-dfb9710e422b",
  "name": "nulla",
  "next_sample_update": "dolore Excepteur irure velit officia",
  "parent_list_ids": [
    "minim enim",
    "sit sunt in et"
  ],
  "query_dsl": "consectetur culpa",
  "query_version": "pariatur",
  "sample_updated_at": "reprehenderit",
  "status": {
    "error_message": "elit occaecat voluptate",
    "query_validation": "enim cupidatat dolore culpa"
  },
  "updated_at": "sint laboris dolor fugiat quis"
}

{
  "errors": [
    {
      "field": "nostrud esse cupidatat dolore",
      "message": "Excepteur esse"
    },
    {
      "field": "anim",
      "message": "exercitation consectetur in consequat"
    }
  ]
}

{
  "errors": [
    {
      "field": "ea irure exercitation sunt",
      "message": "dolor deserunt veniam do consectetur"
    },
    {
      "field": "id non",
      "message": "adipisicing eiusmod sint ad"
    },
    {
      "field": "tempor",
      "message": "commodo laborum cupidatat dolor dolore"
    },
    {
      "field": "non",
      "message": "in"
    }
  ]
}

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": "Lorem eiusmod in adipisicing enim",
      "message": "velit occaecat"
    },
    {
      "field": "eu",
      "message": "ut officia eu dolor nisi"
    },
    {
      "field": "mollit culpa non ut sint",
      "message": "ipsum ex"
    },
    {
      "field": "Ut sunt",
      "message": "voluptate ullamco labore"
    }
  ]
}

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

{
  "errors": [
    {
      "field": "cillum in sint dolore aute",
      "message": "Ut ut Excepteur 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 nostrud"`

Request Payload

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

Response Payload

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

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

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

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

{
  "errors": [
    {
      "message": "in aliquip Ut adipisicing aliqua"
    }
  ]
}

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": "id",
      "field": "enim laborum aliquip velit",
      "message": "sed consectetur",
      "parameter": "cillum"
    },
    {
      "error_id": "pariatur",
      "field": "non",
      "message": "occaecat pariatur minim qui",
      "parameter": "laborum"
    },
    {
      "error_id": "cupidatat ad do",
      "field": "ut qui proident",
      "message": "consectetur ut dolore veniam amet",
      "parameter": "Excepteur non"
    }
  ]
}

GET

/v3/marketing/lists

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

Query Parameter Name	Example
`page_size`	`998.3199583244914`
`page_token`	`nulla dolore sint`

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": "Excepteur reprehenderit",
    "field": "nulla ex consectetur commodo",
    "message": "anim amet culpa laboris in",
    "parameter": "nostrud id"
  },
  {
    "error_id": "aliquip ipsum Duis cupidatat",
    "field": "nostrud reprehenderit incididunt ex nulla",
    "message": "ut",
    "parameter": "consequat sit ipsum"
  }
]

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": "ut officia ex labore enim",
      "field": "proident",
      "message": "ullamco incididunt reprehenderit Ut",
      "parameter": "minim nisi adipisicing id Ut"
    },
    {
      "error_id": "do",
      "field": "ex do in laboris",
      "message": "Duis deserunt est velit aliquip",
      "parameter": "aliquip Duis"
    },
    {
      "error_id": "id Excepteur",
      "field": "elit sunt quis",
      "message": "Ut culpa veniam ullamco",
      "parameter": "officia incididunt"
    },
    {
      "error_id": "qui in Ut enim",
      "field": "culpa",
      "message": "in",
      "parameter": "minim dolor eiusmod magna 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"
}

minim dolor Duis non officia

{
  "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`*	`ex labore`

Request Payload

Response Payload

{
  "job_id": "laborum nulla velit"
}

{
  "error_id": "est voluptate",
  "field": "in",
  "message": "occaecat mollit veniam",
  "parameter": "et"
}

{
  "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": "Excepteur",
      "field": "reprehenderit",
      "message": "pariatur culpa nostrud reprehenderit",
      "parameter": "amet"
    },
    {
      "error_id": "Duis magna elit",
      "field": "veniam",
      "message": "laboris amet qui Ut",
      "parameter": "exercitation"
    },
    {
      "error_id": "officia incididunt qui",
      "field": "quis ut pariatur laboris",
      "message": "incididunt commodo",
      "parameter": "enim in eiusmod"
    }
  ]
}

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": "Lorem voluptate elit",
      "field": "in dolor",
      "message": "amet consequat tempor",
      "parameter": "laborum"
    },
    {
      "error_id": "nostrud sit reprehenderit id Ut",
      "field": "occaecat",
      "message": "laboris",
      "parameter": "sint laboris magna dolor"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "nostrud amet ea deserunt",
      "field": "non cupidatat aute fugiat est",
      "message": "do ut anim incididunt ea",
      "parameter": "cillum esse deserunt officia consectetur"
    }
  ]
}

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": "Lorem ut",
      "field": "et dolor",
      "message": "esse nisi in dolore in",
      "parameter": "et minim Lorem adipisicing"
    },
    {
      "error_id": "Duis tempor",
      "field": "nulla aliqua esse commodo",
      "message": "enim ex nisi",
      "parameter": "irure qui"
    },
    {
      "error_id": "nostrud sed magna ea est",
      "field": "quis esse Excepteur dolore",
      "message": "pariatur adipisicing nisi",
      "parameter": "quis"
    },
    {
      "error_id": "reprehenderit esse nostrud laborum",
      "field": "non quis consectetur sed nisi",
      "message": "non ex dolore",
      "parameter": "amet occaecat officia"
    }
  ]
}

segmenting contacts(5 operations)

POST

/v3/marketing/segments

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

Request Payload

{
  "name": "in",
  "parent_list_id": "642b4bcf-dc22-d142-afdc-ff52793a710d",
  "parent_list_ids": [
    "voluptate qui",
    "fugiat eiusmod tempor nulla ipsum",
    "Ut"
  ],
  "query_dsl": "pariatur cillum occaecat est"
}

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": "in pariatur"
    }
  ]
}

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`	`est velit irure exercitation nostrud`
`no_parent_list_id`	`true`

Request Payload

Response Payload

{
  "results": [
    {
      "id": "12099613-91e5-4d09-a900-df7626325288",
      "contacts_count": 78434802,
      "created_at": "2921-01-27T19:33:36.479Z",
      "sample_updated_at": "4685-11-26T07:05:04.660Z",
      "updated_at": "2883-07-10T13:13:37.697Z"
    },
    {
      "id": "60c37015-3734-4c8e-b293-68cfa2ae4fa5",
      "contacts_count": 34177253,
      "created_at": "2575-07-26T23:17:20.984Z",
      "sample_updated_at": "3074-09-04T09:49:58.127Z",
      "updated_at": "5116-10-15T07:37:40.838Z",
      "parent_list_id": "fd38af3d-3f69-4947-8dca-5fa967e7be82",
      "name": "amet"
    }
  ]
}

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

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

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

{
  "errors": [
    {
      "message": "est nostrud magna dolore nisi"
    },
    {
      "message": "non dolor sit do voluptate"
    },
    {
      "message": "aliquip"
    }
  ]
}

GET

/v3/marketing/segments/{segment_id}

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

Query Parameter Name	Example
`query_json`	`false`

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": "Ut",
      "message": "ullamco aliquip voluptate"
    },
    {
      "field": "tempor deserunt sint mollit in",
      "message": "ex"
    },
    {
      "field": "cupidatat",
      "message": "nostrud esse"
    }
  ]
}

{
  "errors": [
    {
      "message": "ut"
    },
    {
      "message": "pariatur mollit cillum eiusmod Excepteur"
    },
    {
      "message": "ipsum in enim eiusmod ad"
    }
  ]
}

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": "sed",
  "parent_list_ids": [
    "labore in",
    "nostrud ut"
  ],
  "query_dsl": "cupidatat quis elit"
}

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": "mollit tempor veniam quis",
      "message": "dolor officia ex qui"
    },
    {
      "field": "nostrud aute esse consectetur",
      "message": "in tempor anim laboris"
    }
  ]
}

{
  "errors": [
    {
      "message": "sit culpa commodo"
    },
    {
      "message": "ea"
    },
    {
      "message": "ut"
    }
  ]
}

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": "Ut nostrud Lorem",
      "message": "eiusmod quis velit laborum"
    },
    {
      "field": "anim",
      "message": "ut reprehenderit ipsum qui in"
    },
    {
      "field": "amet sed Duis",
      "message": "deserunt"
    }
  ]
}

{
  "errors": [
    {
      "message": "et quis"
    },
    {
      "message": "amet sunt et"
    }
  ]
}

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": "reprehenderit laboris",
      "id": "reprehenderit eiusmod",
      "resources": {
        "ids": [
          "voluptate irure ipsum mollit velit",
          "commodo reprehenderit aliqua",
          "aliquip proident est sed",
          "id labore ipsum"
        ],
        "type": "reprehenderit minim culpa nisi"
      }
    },
    {
      "error": "dolor ad",
      "id": "sunt",
      "resources": {
        "ids": [
          "dolor exercitation deserunt",
          "id amet"
        ],
        "type": "non sit sint laborum"
      }
    },
    {
      "error": "nisi minim dolore",
      "id": "id aliqua anim dolore amet",
      "resources": {
        "ids": [
          "ea do dolore",
          "commodo proident sit amet ex",
          "deserunt in",
          "ut pariatur ea"
        ],
        "type": "sint magna est cupidatat dolor"
      }
    }
  ]
}

{}

{
  "errors": [
    {
      "field": "veniam sit in",
      "message": "dolor veniam proident"
    },
    {
      "field": "sunt Excepteur aliquip quis ad",
      "message": "irure"
    },
    {
      "field": "aliquip pariatur magna incididunt occaecat",
      "message": "aute irure culpa"
    }
  ]
}

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

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

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

{
  "errors": [
    {
      "message": "laborum adipisicing occaecat Ut"
    }
  ]
}

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": "non",
      "field": "id Lorem",
      "message": "id est"
    },
    {
      "error_id": "voluptate nostrud",
      "field": "laboris nostrud",
      "message": "velit magna et dolore sed"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "et",
      "field": "culpa ipsum",
      "message": "Ut id sint in"
    }
  ]
}

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`	`-64863307`
`page_token`	`Ut magna dolor culpa`

Request Payload

Response Payload

{
  "_metadata": {
    "count": 11725525,
    "next": "https://jv.szxqh30y3",
    "prev": "http://Je.ctarYDR0EuqVqiQaKvamlgVHetYqzJHo.,5SnBKCY6.32wIGQv5SHEsy,.ksNCT-bKOb",
    "self": "https://Hw.vxyuGbeRpvqMJvs"
  },
  "result": [
    {
      "abtest": {
        "duration": "in",
        "expiration_date": "voluptate minim tempor",
        "test_percentage": -98457147,
        "type": "content",
        "winner_criteria": "open",
        "winner_selected_at": "dolore reprehenderit consequat laborum",
        "winning_template_id": "aute nostrud"
      },
      "categories": [
        "sunt officia anim",
        "proident",
        "laborum nisi ad",
        "magna voluptate est dolor ad",
        "dolor Excepteur",
        "Ut incididunt",
        "ad sed laborum do",
        "do ex ad",
        "veniam non in",
        "sunt quis"
      ],
      "created_at": "1947-05-20T13:28:06.0Z",
      "id": "6c9ab6aa-ffaf-eb8c-f6c4-e9838e52df9f",
      "is_abtest": false,
      "name": "ipsum",
      "send_at": "1896-10-02T14:30:17.0Z",
      "status": "scheduled",
      "updated_at": "1935-01-07T08:57:29.0Z"
    },
    {
      "abtest": null,
      "categories": [
        "Ut pariatur consequat",
        "officia minim nulla in tempor",
        "anim",
        "cillum consequat ullamco Lorem",
        "ex occaecat enim incididunt",
        "anim reprehenderit Duis veniam dolore",
        "eu ut culpa",
        "officia in",
        "proident anim qui voluptate dolore",
        "sed mollit nisi et"
      ],
      "created_at": "1960-07-02T20:06:39.0Z",
      "id": "1dd7c1e0-cdc5-31a0-20ca-66a5a7165577",
      "is_abtest": false,
      "name": "laboris",
      "send_at": "1950-07-17T19:48:26.0Z",
      "status": "scheduled",
      "updated_at": "1938-12-03T04:41:45.0Z"
    },
    {
      "abtest": {
        "duration": "in culpa voluptate",
        "expiration_date": "dolor cupidatat",
        "test_percentage": 63812225,
        "type": "content",
        "winner_criteria": "click",
        "winner_selected_at": "consequat ut eiusmod enim id",
        "winning_template_id": "consectetur voluptate commodo irure"
      },
      "categories": [
        "mollit",
        "Lorem in",
        "elit anim laborum deserunt",
        "dolore qui ut pariatur",
        "adipisicing esse sit",
        "deserunt laboris veniam aliqua",
        "consectetur ullamco quis amet minim",
        "pariatur cillum Ut ea",
        "consectetur ipsum",
        "voluptate sit do"
      ],
      "created_at": "1919-06-24T06:44:52.0Z",
      "id": "d3976d6b-6ebd-395e-e049-7eafaad635c2",
      "is_abtest": false,
      "name": "sint",
      "send_at": "1926-04-28T14:03:48.0Z",
      "status": "scheduled",
      "updated_at": "1926-03-31T19:53:50.0Z"
    },
    {
      "abtest": null,
      "categories": [
        "reprehenderit Ut consequat dolor",
        "est sint",
        "occaecat Lorem",
        "ullamco pariatur",
        "enim",
        "ullamco pariatur dolore eiusmod",
        "enim dolore ex",
        "nisi minim",
        "ullamco irure",
        "ullamco ea"
      ],
      "created_at": "1963-07-16T10:04:08.0Z",
      "id": "13001990-4a9e-6feb-f567-e49bc6f97654",
      "is_abtest": false,
      "name": "quis",
      "send_at": "1968-07-08T16:54:49.0Z",
      "status": "triggered",
      "updated_at": "1940-03-06T05:16:42.0Z"
    },
    {
      "abtest": null,
      "categories": [
        "deserunt magna ea irure",
        "est sed exercitation in",
        "ut irure et",
        "dolore",
        "sed occaecat",
        "ad dolore exercitation sint",
        "cupidatat Ut ad dolore",
        "do est",
        "mollit ipsum",
        "cupidatat irure eiusmod amet"
      ],
      "created_at": "1928-01-19T22:02:56.0Z",
      "id": "01aaf787-0e9d-ab8d-12ff-ab0b13d01ea1",
      "is_abtest": false,
      "name": "sit dolor mollit incididunt",
      "send_at": "1939-08-06T02:25:57.0Z",
      "status": "draft",
      "updated_at": "1932-10-19T16:18:25.0Z"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "non mollit minim",
      "field": "ipsum cillum dolore ea",
      "message": "mollit in"
    },
    {
      "error_id": "dolor eu in deserunt",
      "field": "in laboris mollit laborum dolor",
      "message": "veniam aliquip officia"
    }
  ]
}

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 laborum dolor ut pariatur","dolore nisi nulla","eu","ad","magna","velit incididunt anim","ullamco eu quis","fugiat","exercitation Excepteur sit","anim nisi culpa est"]`

Request Payload

Response Payload

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

{
  "errors": [
    {
      "error_id": "ut",
      "field": "do sint",
      "message": "labore et officia"
    },
    {
      "error_id": "anim officia",
      "field": "dolore laborum exercitation nostrud veniam",
      "message": "eiusmod esse mollit et pariatur"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "dolore veniam consequat anim voluptate",
      "field": "laborum Excepteur amet in eu",
      "message": "in do dolor nisi"
    },
    {
      "error_id": "deserunt eu dolor esse consequat",
      "field": "eu ut pariatur mollit",
      "message": "dolor"
    },
    {
      "error_id": "commodo velit",
      "field": "quis",
      "message": "Duis"
    }
  ]
}

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": "dolore quis"
}

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 dolore in nostrud in",
      "field": "ullamco anim magna",
      "message": "labore nostrud"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "do nisi quis nulla",
      "field": "voluptate velit officia",
      "message": "cillum incididunt enim ut est"
    },
    {
      "error_id": "sit nisi Duis",
      "field": "dolor commodo sit",
      "message": "velit"
    }
  ]
}

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": [
    "quis velit ullamco ex",
    "minim magna et nulla",
    "labore",
    "adipisicing officia",
    "pariatur occaecat cupidatat mollit Excepteur",
    "Duis sit tempor",
    "et nisi aliqua eiusmod reprehenderit",
    "sint dolor",
    "enim nostrud est proident",
    "laborum do ullamco in"
  ],
  "email_config": {
    "custom_unsubscribe_url": "http://pKrEzVONtVSnrvaRVfZqtUO.vxnuOEJqo7nTKK6lcL1Tuw8.ZJa,s",
    "design_id": "magna dolor",
    "editor": "design",
    "generate_plain_content": true,
    "html_content": "fugiat aliquip deserunt",
    "ip_pool": null,
    "plain_content": "sit in dolore et",
    "sender_id": -72831044,
    "subject": "ut commodo occaecat deserunt",
    "suppression_group_id": 30687930
  },
  "name": "Duis aute incididunt exercita",
  "send_at": "1903-01-04T06:24:18.0Z",
  "send_to": {
    "all": false,
    "list_ids": [
      "d22de31f-cd95-d502-df1f-eb21a415141f",
      "34771216-3d6e-9fd8-f7e3-fcb05644b505",
      "bc1d4c2b-67f7-487c-ed93-c84b454bee32",
      "eb6ab23e-68e3-96f5-0e8d-83c8e92a7382",
      "31d743ae-64f9-4839-dcb2-a45523edd7a8",
      "78e57a98-b099-fe69-c501-a46846b4184d",
      "d071ef1e-e079-3fad-c4b8-5aefe9b22ff1",
      "9d35caa5-7384-79fd-cfb0-5822b33af386",
      "aeecc640-6ec7-b659-a2bb-6fbbcb479cab",
      "dc1cf7b4-a02f-adbc-bc87-72bd1629abf6"
    ],
    "segment_ids": [
      "ceca412f-b8fa-f263-97b9-3d77212f3193",
      "259b866e-d1c1-1de4-d33b-7e6b550a3daf",
      "3d3a6c54-20f2-f223-97a5-97eb96377908",
      "68173f8e-2ed6-d6fe-af59-4f2905033596",
      "f309a69f-b476-0128-2a95-e7a856aaad16",
      "a932594a-1596-92f4-6a46-8b90fc9ec297",
      "3077695f-ab49-33fc-fdf2-63df46025704",
      "4a054203-4c93-fad8-1580-b4a1f9f9fb0a",
      "4e77d90d-24df-7e13-e20a-c00055594933",
      "deddd115-4094-c2e8-92c5-24310d72e883"
    ]
  }
}

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": "fugiat Lorem",
      "field": "minim",
      "message": "sed ipsum cupidatat est deserunt"
    },
    {
      "error_id": "esse aliqua",
      "field": "officia dolore ipsum",
      "message": "in est occaecat dolor aliqua"
    },
    {
      "error_id": "commodo Ut",
      "field": "esse ad do ullamco",
      "message": "dolor qui"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "non laborum sit",
      "field": "minim velit dolore et nisi",
      "message": "elit mollit Excepteur tempor"
    },
    {
      "error_id": "ullamco aliquip in pariatur",
      "field": "anim dolor mollit",
      "message": "dolor ea sunt"
    },
    {
      "error_id": "exercitation est laborum nulla anim",
      "field": "amet cillum nisi dolor ex",
      "message": "adipisicing pariatur ad"
    },
    {
      "error_id": "id eu aliquip est dolore",
      "field": "nulla tempor magna",
      "message": "sint ut et amet cillum"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "et",
      "field": "sint dolor laborum reprehenderit qui",
      "message": "labore incididunt dolor minim"
    },
    {
      "error_id": "cupidatat nostrud mollit",
      "field": "do amet ut deserunt",
      "message": "est commodo exercitation"
    }
  ]
}

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": "nulla officia amet laborum tempor",
      "field": "ad veniam quis voluptate",
      "message": "dolor esse"
    },
    {
      "error_id": "eiusmod id Ut in sit",
      "field": "laboris in culpa",
      "message": "ut nostrud"
    },
    {
      "error_id": "fugiat",
      "field": "elit labore",
      "message": "esse"
    },
    {
      "error_id": "aute ullamco tempor enim nulla",
      "field": "consectetur culpa irure Ut quis",
      "message": "in proident eu adipisicing Excepteur"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "do laboris consequat non",
      "field": "consequat elit sit nisi do",
      "message": "Ut laboris Excepteur"
    },
    {
      "error_id": "magna et id ipsum cillum",
      "field": "qui nisi",
      "message": "sed qui est irure cupidatat"
    },
    {
      "error_id": "eu qui aliquip proident",
      "field": "nisi sint",
      "message": "irure aliqua consectetur"
    },
    {
      "error_id": "anim",
      "field": "occaecat velit Duis cillum dolor",
      "message": "in consequat in minim"
    }
  ]
}

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": "irure",
      "field": "sunt Ut ut anim enim",
      "message": "ut Excepteur qui amet cupidatat"
    },
    {
      "error_id": "laborum proident consequat id",
      "field": "Duis velit consectetur nulla",
      "message": "ea ex eu tempor ullamco"
    },
    {
      "error_id": "deserunt do aute ad nostrud",
      "field": "dolor est",
      "message": "velit ut voluptate commodo"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "deserunt dolor proident",
      "field": "sint veniam",
      "message": "nisi sit ut"
    },
    {
      "error_id": "incididunt Lorem magna",
      "field": "quis veniam",
      "message": "occaecat esse ea"
    },
    {
      "error_id": "id",
      "field": "eiusmod elit ad",
      "message": "nulla ad adipisicing commodo Lorem"
    },
    {
      "error_id": "dolore cupidatat ullamco minim",
      "field": "aute sed esse commodo",
      "message": "anim"
    }
  ]
}

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`	`58536593`
`page_token`	`esse pariatur enim Duis adipisicing`

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": "sit aute ex voluptate",
      "field": "ex incididunt dolor in",
      "message": "elit est non ea ullamco"
    },
    {
      "error_id": "ex ea magna",
      "field": "dolore ea",
      "message": "ea in qui"
    },
    {
      "error_id": "adipisicing nulla ex",
      "field": "magna quis deserunt ex aute",
      "message": "anim veniam"
    },
    {
      "error_id": "ea minim",
      "field": "pariatur amet elit cupidatat tempor",
      "message": "aliqua culpa Excepteur"
    },
    {
      "error_id": "minim reprehenderit laborum",
      "field": "ut occaecat nostrud",
      "message": "dolore"
    }
  ]
}

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": "dolor",
      "field": "fugiat aliqua pariatur",
      "message": "reprehenderit nulla enim"
    },
    {
      "error_id": "anim velit aliqua in pariatur",
      "field": "cupidatat",
      "message": "officia ullamco in et non"
    },
    {
      "error_id": "ea non",
      "field": "cupidatat dolor eiusmod amet culpa",
      "message": "eu Lorem in"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ex occaecat laborum ipsum",
      "field": "incididunt nostrud ex aute elit",
      "message": "minim tempor"
    },
    {
      "error_id": "magna consequat",
      "field": "adipisicing tempor",
      "message": "aliquip adipisicing"
    },
    {
      "error_id": "aute enim cillum consectetur labore",
      "field": "aute ut aliquip mollit nisi",
      "message": "ad laboris Ut proident"
    },
    {
      "error_id": "ad consectetur pariatur laborum",
      "field": "veniam Duis in",
      "message": "aliqua amet officia sunt"
    },
    {
      "error_id": "non deserunt nisi dolor veniam",
      "field": "ut elit fugiat",
      "message": "dolor in reprehenderit dolore"
    }
  ]
}

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": "1909-09-29T02:51:16.0Z",
  "status": "scheduled"
}

{
  "errors": [
    {
      "error_id": "in tempor ullamco Duis aute",
      "field": "ipsum dolore",
      "message": "consectetur mollit in"
    },
    {
      "error_id": "sint ea laboris reprehenderit irure",
      "field": "reprehenderit quis do",
      "message": "nisi consectetur"
    },
    {
      "error_id": "exercitation velit commodo",
      "field": "pariatur esse",
      "message": "id Excepteur consequat veniam"
    },
    {
      "error_id": "aliqua",
      "field": "dolore aliquip in nulla",
      "message": "dolore ex aliquip dolore"
    },
    {
      "error_id": "sed pariatur",
      "field": "et ipsum Ut",
      "message": "sed anim amet"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ut tempor",
      "field": "fugiat",
      "message": "deserunt proident dolore"
    },
    {
      "error_id": "do in sunt aliquip aute",
      "field": "sit sed sint commodo",
      "message": "cillum mollit do"
    },
    {
      "error_id": "aliqua",
      "field": "in Lorem exercitation voluptate",
      "message": "nostrud eu amet nisi"
    }
  ]
}

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": "et",
      "field": "nulla est sunt non irure",
      "message": "labore esse ex consequat nisi"
    }
  ]
}

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`	`["in","consequat exercitation","in","laboris irure cillum ut","cupidatat","nulla","fugiat est reprehenderit dolore enim","culpa","velit in in","commodo quis et tempor"]`
`page_size`	`56`
`page_token`	`laboris proident sit reprehenderit`

Request Payload

Response Payload

{
  "_metadata": {
    "count": 65788417.84228566,
    "next": "https://UOdp.qilhw.hSEOAY.mcprejILJNYqFpQz3sFqjDRKAIF3GNh7Y8wgCF",
    "prev": "http://YQVRMsEYDPoqj.ghfEnXVKEYNfT,pm6z8,7oRbAErU+FGR-zxgNKidofSWXk",
    "self": "https://tBcPAJNPVeasWSOi.iozhmAl7RWqoJb15RaQnZjp76qt3JJxP1VORwZ4Iz-ivnlFuurug-zELACBgqMPIzwqXpVTJowhaUQ"
  },
  "results": [
    {
      "aggregation": "culpa proident sint",
      "id": "6bb9cc90-ba9b-f837-0b0d-4f56048ae46f",
      "stats": {
        "bounce_drops": -93216824,
        "bounces": -67728186,
        "clicks": 95180246,
        "delivered": -5287417,
        "invalid_emails": 53946406,
        "opens": 72343645,
        "requests": -65801855,
        "spam_report_drops": -26514968,
        "spam_reports": -43481702,
        "unique_clicks": 45493905,
        "unique_opens": 76777055,
        "unsubscribes": -1364394
      },
      "step_id": "amet"
    }
  ]
}

{
  "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_id"]`
`step_ids`	`["268be849-75b9-2d6d-506d-840ff771bd56","f5ef7639-086f-00e3-c361-05c798bca385","0fda83db-34c7-fff4-6c7d-065c94a7d230"]`
`aggregated_by`	`total`
`start_date`	`1908-02-06`
`end_date`	`1893-08-13`
`timezone`	`laboris enim Lorem`
`page_size`	`32`
`page_token`	`anim in esse magna sed`

Request Payload

Response Payload

{
  "_metadata": {
    "count": 67677347.3953999,
    "next": "http://FdKTaSj.ruvdWNc-X1fe6OSDV.4p6QU",
    "prev": "https://US.jtaDx,prj,1FXxNRAO7uxZGE-Xi2sZvNXqr",
    "self": "https://znqsvUEyLAtjVDBMIUKsdiIkdlucNfl.caybXe3eY6e+DPNgEfi-YBHoJ57hh7Kd2ihJvQ.AX7-p+gN1uslY2UTdykasNF7O+scnqpJ"
  },
  "results": [
    {
      "aggregation": "ad enim non sint dolore",
      "id": "8bfbf7ca-5b1a-dab8-e2db-7d3eb05e0b38",
      "stats": {
        "bounce_drops": 16333670,
        "bounces": 78700547,
        "clicks": -40583462,
        "delivered": 61182962,
        "invalid_emails": -61293395,
        "opens": 10093342,
        "requests": -12151461,
        "spam_report_drops": 44009001,
        "spam_reports": 97409063,
        "unique_clicks": -67393341,
        "unique_opens": 24285180,
        "unsubscribes": 42702365
      },
      "step_id": "cupidatat Duis eu"
    }
  ]
}

{
  "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`	`["sunt non dolore amet cupidatat","ad nulla in consequat elit","Excepteur dolore sint elit nisi","laborum ullamco id","Excepteur mollit dolor fugiat magna","magna esse Duis","aliquip","ad veniam qui deserunt sit","consequat","consequat in anim"]`
`page_size`	`31`
`page_token`	`id fugiat sunt cupidatat`

Request Payload

Response Payload

{
  "_metadata": {
    "count": 91691008.79752028,
    "next": "http://CGMvpULFCdyDWf.cheAL.8Za1qzoElFM5akfO",
    "prev": "http://FhM.luspe0GqNC.15cRvRV-WF0AjMPH5q,6OR",
    "self": "http://QNPKNACdFFdqoYlaIUnoaJuuRpPPYPg.tnfHDHknXZPIA"
  },
  "results": [
    {
      "ab_phase": "all",
      "ab_variation": "821fe8cb-b423-2214-f538-1d83341b4f19",
      "aggregation": "aute laboris eu ex mollit",
      "id": "48055ac3-5602-558d-2152-9481fb939d4a",
      "stats": {
        "bounce_drops": -40493349,
        "bounces": -23266135,
        "clicks": -49626150,
        "delivered": -92002484,
        "invalid_emails": 57199848,
        "opens": -9410699,
        "requests": -54201782,
        "spam_report_drops": -61648096,
        "spam_reports": -24417867,
        "unique_clicks": -99827569,
        "unique_opens": 85278048,
        "unsubscribes": 71973305
      }
    },
    {
      "ab_phase": "all",
      "ab_variation": "d3b8da1e-26c9-a338-68f5-3af7af52ca7d",
      "aggregation": "ad in tempor irure Duis",
      "id": "d447fc05-2094-3654-3da7-6a5d9f841c53",
      "stats": {
        "bounce_drops": -73021060,
        "bounces": 97307887,
        "clicks": -89238338,
        "delivered": -2479302,
        "invalid_emails": 24753617,
        "opens": 81859614,
        "requests": 30875321,
        "spam_report_drops": -30853055,
        "spam_reports": -37406571,
        "unique_clicks": 22364297,
        "unique_opens": 97415738,
        "unsubscribes": -84963454
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "c8b46cc7-cf8c-a264-33d0-697a7b1e1568",
      "aggregation": "labore",
      "id": "d8952919-ac55-dca5-9f75-4f050e9049e6",
      "stats": {
        "bounce_drops": 861969,
        "bounces": -18598046,
        "clicks": 98824337,
        "delivered": -95836316,
        "invalid_emails": -34795007,
        "opens": 87654440,
        "requests": -8918265,
        "spam_report_drops": 76647649,
        "spam_reports": -5030562,
        "unique_clicks": 16197897,
        "unique_opens": 16953718,
        "unsubscribes": -93053913
      }
    }
  ]
}

{
  "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`	`1914-03-14`
`end_date`	`1946-06-03`
`timezone`	`sit do proident aute`
`page_size`	`64`
`page_token`	`Duis`
`group_by`	`["ab_phase","ab_phase","ab_variation"]`

Request Payload

Response Payload

{
  "_metadata": {
    "count": 59466879.786263496,
    "next": "https://jVZUhOiqPkyJiZKWwscsyRoihP.byofcAWZjN3",
    "prev": "http://bSaaTfpSzxFxPWSWAg.vwmyqWu9-whBas+HM0bqbTnPDZLZqkNpR3CIodvl",
    "self": "http://DqSBgk.jvsqyD6uqCRE6KC+eNSHAh5Z"
  },
  "results": [
    {
      "ab_phase": "send",
      "ab_variation": "53f6ebe6-b78e-d201-f365-ce8dcf4388a3",
      "aggregation": "deserunt officia sunt ad qui",
      "id": "cc1657a0-3d85-ecd5-753b-883d582bf104",
      "stats": {
        "bounce_drops": 7072246,
        "bounces": 96039361,
        "clicks": -89169324,
        "delivered": -67357067,
        "invalid_emails": 56112263,
        "opens": 27797206,
        "requests": 76962126,
        "spam_report_drops": 1706070,
        "spam_reports": -18491911,
        "unique_clicks": 44329913,
        "unique_opens": -33630478,
        "unsubscribes": -23208629
      }
    },
    {
      "ab_phase": "send",
      "ab_variation": "f63ac138-001b-cae7-b292-7756e1ecdbcf",
      "aggregation": "fugiat consectetur est",
      "id": "978a9106-e3ba-8add-14f7-7e423181daff",
      "stats": {
        "bounce_drops": -50283704,
        "bounces": 33689698,
        "clicks": -65651185,
        "delivered": -8527614,
        "invalid_emails": -35491799,
        "opens": 36537732,
        "requests": 41037590,
        "spam_report_drops": 71726627,
        "spam_reports": -9497950,
        "unique_clicks": 17399555,
        "unique_opens": 81546976,
        "unsubscribes": 2944159
      }
    },
    {
      "ab_phase": "all",
      "ab_variation": "ddc8fb31-c842-f5fe-1d8a-cc0cb082ee10",
      "aggregation": "proident do",
      "id": "5312c5b9-7201-5962-3b3e-05d0d77c857c",
      "stats": {
        "bounce_drops": 55221365,
        "bounces": 44334307,
        "clicks": -29040047,
        "delivered": -95123962,
        "invalid_emails": -29707694,
        "opens": 4543706,
        "requests": -39279614,
        "spam_report_drops": 48529684,
        "spam_reports": 48961647,
        "unique_clicks": -94696236,
        "unique_opens": -45865576,
        "unsubscribes": 98235835
      }
    },
    {
      "ab_phase": "all",
      "ab_variation": "119342ca-f3df-04e1-4560-7ef4cf51abae",
      "aggregation": "aute esse ipsum fugiat tempor",
      "id": "f2939abd-2544-7f8c-3385-d7cfc9f6db6f",
      "stats": {
        "bounce_drops": 39961900,
        "bounces": -20696862,
        "clicks": -91662435,
        "delivered": 40473100,
        "invalid_emails": 61748826,
        "opens": 40478845,
        "requests": -6424664,
        "spam_report_drops": -48369610,
        "spam_reports": 42227638,
        "unique_clicks": 71365457,
        "unique_opens": 99070420,
        "unsubscribes": -27087701
      }
    },
    {
      "ab_phase": "all",
      "ab_variation": "6996fefc-5021-ec76-368c-c2ead0f8aa25",
      "aggregation": "et commodo",
      "id": "12f0b95e-a7e6-78ac-605a-423d86a18d1e",
      "stats": {
        "bounce_drops": -41844795,
        "bounces": -75745839,
        "clicks": -26062559,
        "delivered": -72878996,
        "invalid_emails": -81619277,
        "opens": -67940137,
        "requests": 86387106,
        "spam_report_drops": -42794167,
        "spam_reports": 42719199,
        "unique_clicks": -87941982,
        "unique_opens": 43279888,
        "unsubscribes": 16663866
      }
    }
  ]
}

{
  "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`	`["c7e9a148-4e5c-5c0a-6e68-973f4484a3c6","c7b94cba-786f-ed69-cc58-cc4e062663e0"]`
`page_size`	`51`
`page_token`	`sunt`

Request Payload

Response Payload

{
  "_metadata": {
    "count": 23540325.19859244,
    "next": "https://pzFCg.gemQaePtmYAy",
    "prev": "http://CeLqopGAnxXku.fktjtlB7nDIVW1E,slbDTO+OQSAf3xibsF8VAfm.sbNC3d444",
    "self": "http://LbuHD.aloqVpKo.etfc8F1,wlp-v-A2bcDfc12Svf5r"
  },
  "results": [
    {
      "clicks": 9208679,
      "step_id": "f103dc82-7618-9273-59b5-05a9f63ad086",
      "url": "http://DJUGWaY.nrpAKQJ-m+PCunez4+Zv,aiRHc",
      "url_location": 12895644
    }
  ],
  "total_clicks": 53151196
}

{
  "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`	`68`
`page_token`	`id commodo eu`
`group_by`	`["ab_phase","ab_phase"]`
`ab_variation_id`	`5e9a7151-2a85-4420-6a9e-09adaad36197`
`ab_phase_id`	`send`

Request Payload

Response Payload

{
  "_metadata": {
    "count": -18367451.15943609,
    "next": "http://s.amsWgJ+9cRl-mGcXcbVLlTh6F",
    "prev": "https://OqYCoNMESaaJSFFrVOK.jyjplaz2.6YUdCJPkHpW",
    "self": "http://xXXaBtZQqpNMYi.zhDkD,3CosVDijgNfo3p1CA7kJQIL+MUrRfcNAIykvcUh5.L,+dk8VyIU1oG.7w0"
  },
  "results": [
    {
      "ab_phase": "send",
      "ab_variation": "4e9d92f4-bbaa-2072-ce67-29859d088d14",
      "clicks": 41098635,
      "url": "http://oYIwUSCauJhoMjRNnAyNnepkccCPsc.bpxo8bxeeRTthMghp038PEqwseh8rCa6o7l3sKgAKI7ObuhDC",
      "url_location": 72573564
    },
    {
      "ab_phase": "all",
      "ab_variation": "032507d3-b654-6611-adbd-aab2cc24e1aa",
      "clicks": 28319432,
      "url": "http://UOiOFXdEoF.jzgnJvYA2KPto6FBfJ.wT8rFu8QL95WPSXG",
      "url_location": 81653775
    },
    {
      "ab_phase": "test",
      "ab_variation": "f82f8bb1-bd24-f497-ea57-cdf3127470b8",
      "clicks": 56995672,
      "url": "http://KrBZAlaPRMhQO.utvFjAbphtHqALq1Zi2pPgR",
      "url_location": 53678572
    },
    {
      "ab_phase": "test",
      "ab_variation": "2f9f735d-0814-756c-91a1-16fe2bc20c3e",
      "clicks": 70619050,
      "url": "http://KFsLZCUJjoSgD.uycZ9ZdIBF8KuOjKfuTqqqS.UxTofKWGnIAp7",
      "url_location": 15628740
    }
  ],
  "total_clicks": 81505042
}

{
  "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`	`["nulla et","nisi sint velit veniam irure","quis proident ipsum non","dolor culpa","amet Excepteur","laborum est dolore anim in","dolore do et","officia ut","officia","ad nostrud voluptate"]`
`timezone`	`consectetur minim in`

Request Payload

Response Payload

laboris id

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`	`["est","dolore nisi ipsum","nulla id ut esse","ut laborum pariatur magna non","pariatur est veniam in","in","Lorem dolor","adipisicing eu exercitation","ipsum adipisicing","consequat labore"]`
`timezone`	`consequat ut`

Request Payload

Response Payload

ea eiusmod quis

{
  "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`	`"consectetur velit"`

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`	`"cupidatat aliquip sint nostrud ea"`

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`	`"enim deserunt"`

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`	`"exercitation"`

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`	`"consequat cupidatat exercitation quis culpa"`

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`	`"Duis"`

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 occaecat dolor tempor commodo"`

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`	`"dolor elit irure sit"`

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`	`"occaecat minim dolor commodo magna"`

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`	`-7424455`

Header Name	Example
`on-behalf-of`	`"velit dolore veniam incididunt"`

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`*	`-70198894`

Header Name	Example
`on-behalf-of`	`"Duis do dolore esse"`

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`	`"tempor aliqua Ut laboris"`

Request Payload

Error generating example

Response Payload

Error generating example

{
  "errors": [
    {
      "field": "delete_contacts",
      "message": "delete_contacts not a bool"
    },
    {
      "field": "list_id",
      "message": "Returned if list_id is not valid"
    }
  ]
}

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

{
  "errors": [
    {
      "message": "List not found: 5"
    }
  ]
}

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`	`20765581`
`page_size`	`8775219`
`list_id`*	`-30128615`

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

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`	`"sint non"`

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`	`"fugiat sint ex"`

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`*	`10763952`
`recipient_id`*	`-20659614`

Header Name	Example
`on-behalf-of`	`"id sit 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`	`"est"`

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`	`"anim"`

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`	`"ad do"`

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`	`-67830986`
`page_size`	`-28493821`

Header Name	Example
`on-behalf-of`	`"aliquip incididunt Ut"`

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`	`"nulla exercitation commodo"`

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`	`"non minim ut dolore"`

Request Payload

Response Payload

{
  "recipients": [
    {
      "created_at": 24791374.63819176,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "h5Cs1Uaj22gU@rKCJxQyvioIubOGVYGyiXSQhORgsjIqq.aks",
      "first_name": "eiusmod occaecat et",
      "id": "sint veniam do",
      "last_clicked": null,
      "last_emailed": null,
      "last_name": "do voluptate",
      "last_opened": -34721547.575344846,
      "updated_at": -23531.860189557076
    }
  ]
}

{}

{
  "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`	`"velit"`

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`	`"id"`

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`	`"Duis est"`

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`	`"sint"`

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}`	`ut reprehenderit amet laboris`

Header Name	Example
`on-behalf-of`	`"dolor nulla nisi commodo"`

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`	`"labore ex dolore elit"`

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`	`"sunt ad ipsum"`

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`	`"ut sint sed sunt laborum"`

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`	`"fugiat dolore"`

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`	`"irure reprehenderit do"`

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`	`"nostrud fugiat 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`	`"et"`

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`*	`25061758`

Header Name	Example
`on-behalf-of`	`"irure ea ullamco qui"`

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`	`reprehenderit non Lorem`

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

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`	`false`

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

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`	`-11083329`
`page_size`	`61783559`

Header Name	Example
`on-behalf-of`	`"officia Duis"`

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`	`-34578280`
`category`	`do tempor elit enim cillum`
`offset`	`-72719580`

Header Name	Example
`on-behalf-of`	`"eiusmod incididunt aliqua mollit dolor"`

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`	`dolor nisi laboris anim`
`sort_by_direction`	`desc`
`start_date`*	`occaecat`
`end_date`	`enim amet ut exercitation`
`limit`	`-32780477`
`offset`	`-34401637`
`aggregated_by`	`month`

Header Name	Example
`on-behalf-of`	`"non Lorem eiusmod reprehenderit"`

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`*	`Ut tempor sint sit et`
`end_date`	`ipsum do nostrud dolor commodo`
`categories`*	`non`
`limit`	`-72661107`
`offset`	`30343600`
`aggregated_by`	`week`

Header Name	Example
`on-behalf-of`	`"laborum dolor ut minim"`

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`	`"nulla"`

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`	`-14109596`
`offset`	`51490724`

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

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 consequat non ullamco"`

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`	`"pariatur"`

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`	`"culpa aliquip"`

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`	`"eu"`

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`	`"Excepteur tempor aute nisi"`

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 aliquip"`

Request Payload

{
  "send_at": 1489451436
}

Response Payload

{
  "id": 51732350,
  "send_at": -61559708,
  "status": "nostrud ullamco minim"
}

{
  "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`	`"nisi dolor elit"`

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`	`"exercitation ex Duis qui enim"`

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`	`"tempor proident"`

Request Payload

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

Response Payload

{
  "to": "consectetur tempor"
}

{
  "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`	`"aute ex nulla labore"`

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`	`dynamic`
`page_size`*	`197.6777058687672`
`page_token`	`sunt exercitation ullamco qui`

Header Name	Example
`on-behalf-of`	`"dolore adipisicing eu culpa deserunt"`

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": [
    {
      "": "aliquip cillum",
      "error_id": "ex",
      "message": "magna in mollit esse"
    },
    {
      "": "est sed elit occaecat",
      "error_id": "irure culpa",
      "message": "aliquip minim id in Duis"
    },
    {
      "": "amet nisi minim consectetur ut",
      "error_id": "ad officia qui",
      "message": "incididunt nostrud quis ad"
    }
  ]
}

POST

/v3/templates/{template_id}

**This endpoint allows you to duplicate a transactional template.**

Header Name	Example
`on-behalf-of`	`"cupidatat nulla nisi velit"`

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`	`"enim incididunt qui in labore"`

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`	`"culpa aliqua nisi pariatur"`

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`	`"eiusmod ipsum ut nisi"`

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`	`"minim adipisicing est sed sit"`

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`	`"irure mollit amet nulla"`

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`	`"dolor in"`

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`	`"do consequat eu sunt proident"`

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`	`"Excepteur id do nisi"`

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`	`"in Excepteur et exercitation"`

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`	`"dolor in Duis aliquip sed"`

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`	`"dolore do veniam officia reprehenderit"`

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": "commodo incididunt amet"
    }
  ]
}

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`	`ullamco magna non officia amet`
`offset`	`aliquip mollit`
`aggregated_by`	`day`
`start_date`*	`aliqua ad`
`end_date`	`adipisicing laboris`

Header Name	Example
`on-behalf-of`	`"dolor aute ea ut veniam"`

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`	`"amet esse in"`

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`	`"elit adipisicing non commodo ut"`

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`	`"elit"`

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`	`"aliqua Excepteur eiusmod mollit tempor"`

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": "id"
    },
    {
      "message": "dolor culpa aliqua"
    },
    {
      "message": "commodo laboris nostrud"
    },
    {
      "message": "sit labore dolor"
    },
    {
      "message": "nulla"
    }
  ]
}

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`	`"consectetur aliquip dolore ullamco"`

Request Payload

Response Payload

{
  "url": "http://mydomain.com/parse",
  "hostname": "mail.mydomain.com",
  "spam_check": true,
  "send_raw": true
}

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

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

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

{
  "errors": [
    {
      "message": "labore magna"
    }
  ]
}

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`	`"id"`

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": "exercitation dolore aliquip fugiat in"
    },
    {
      "message": "exercitation ex do"
    },
    {
      "message": "commodo sunt do Excepteur"
    },
    {
      "message": "in enim"
    }
  ]
}

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`	`"quis"`

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": "dolor"
    },
    {
      "message": "dolore magna"
    }
  ]
}

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`*	`irure ipsum in deserunt`
`limit`	`955.0986391851724`

Header Name	Example
`X-Query-Id`	`"nulla voluptate laborum Ut"`
`X-Cursor`	`"cillum sint quis do"`
`Authorization`*	`"in tempor"`

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`*	`"id ea nisi"`

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`	`sit reprehenderit in nostrud adipisicing`

Header Name	Example
`Authorization`*	`"ad sint dolore"`

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`*	`"esse ut"`

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`	`"cillum consequat irure"`

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`	`"tempor consectetur amet incididunt"`

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`	`"occaecat esse nulla"`

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`	`"est in"`

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`	`"aute amet non anim qui"`

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`	`"ut ea proident voluptate"`

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`	`"consequat reprehenderit sint amet"`

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`	`"officia aute Ut"`

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`	`"voluptate fugiat ea nostrud 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`	`-93675556`
`offset`	`34484480`
`aggregated_by`	`day`
`start_date`*	`dolor consectetur`
`end_date`	`ex tempor`

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

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`	`CA`
`limit`	`81084956`
`offset`	`-68756982`
`aggregated_by`	`month`
`start_date`*	`minim labore quis dolore`
`end_date`	`voluptate sit`

Header Name	Example
`on-behalf-of`	`"veniam aute eiusmod dolore"`

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`	`-22931743`
`offset`	`5901409`
`aggregated_by`	`week`
`start_date`*	`do`
`end_date`	`enim dolore mollit sed`

Header Name	Example
`on-behalf-of`	`"tempor eu ea id elit"`

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`*	`ut Lorem`
`end_date`	`consectetur elit magna aute`
`aggregated_by`	`day`

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

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`*	`velit Lorem cupidatat est`
`end_date`	`reprehenderit sunt quis ex`
`aggregated_by`	`month`

Header Name	Example
`on-behalf-of`	`"enim et cupidatat aliqua occaecat"`

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`	`consectetur ipsum`
`limit`	`-60288301`
`offset`	`95489481`
`aggregated_by`	`month`
`start_date`*	`laboris aliqua`
`end_date`	`id labore`

Header Name	Example
`on-behalf-of`	`"eiusmod dolore sit velit"`

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`	`reprehenderit dolore`
`limit`	`-44079758`
`offset`	`-21617050`
`aggregated_by`	`day`
`start_date`*	`occaecat nostrud amet culpa aute`
`end_date`	`commodo non`

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

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`	`-2228837`
`end_time`	`35930229`

Header Name	Example
`Accept`*	`"reprehenderit sit cillum"`
`on-behalf-of`	`"est occaecat dolore ut ex"`

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`	`"id enim est"`

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`	`"ex ullamco"`

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`*	`X4s@awUAj.bi`

Header Name	Example
`on-behalf-of`	`"adipisicing velit consectetur culpa"`

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`	`33144892`
`end_time`	`-76480136`
`limit`	`-69720758`
`offset`	`-13194362`

Header Name	Example
`on-behalf-of`	`"ut dolore sit minim id"`

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`	`"nulla irure"`

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`	`"ipsum aliquip Ut nisi ad"`

Request Payload

Response Payload

[
  {
    "created": 1443651154,
    "email": "example@example.com",
    "reason": "error dialing remote address: dial tcp 10.57.152.165:25: no route to host",
    "status": "4.0.0"
  }
]

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`	`"eiusmod est in veniam"`

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`	`-79263883`
`end_time`	`-69252090`
`limit`	`-72762654`
`offset`	`-19555989`

Header Name	Example
`on-behalf-of`	`"mollit reprehenderit magna quis fugiat"`

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`	`"magna qui mollit sunt"`

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`	`"nostrud dolore"`

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`	`"irure"`

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`	`"non est minim dolore"`

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`	`-71265687`
`end_time`	`31636474`
`limit`	`-9008003`
`offset`	`-85355621`

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

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`	`"nostrud sunt"`

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`	`"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`	`"dolor occaecat labore id"`

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`	`-43629463`

Header Name	Example
`on-behalf-of`	`"reprehenderit nulla Ut ipsum dolore"`

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`	`"Duis et sed irure"`

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`	`"officia laborum"`

Request Payload

{
  "id": 103,
  "name": "Item Suggestions",
  "description": "Suggestions for items our users might like."
}

Response Payload

{
  "id": 103,
  "name": "Item Suggestions",
  "description": "Suggestions for items our users might like."
}

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`	`"id reprehenderit ullamco pariatur ex"`

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`	`"cillum Excepteur labore sint"`

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`	`"in minim"`

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`	`"cillum"`

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`	`"in quis"`

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`	`"proident occaecat"`

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`	`"ut cupidatat commodo"`

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`	`68770538`
`end_time`	`-2314346`
`limit`	`-19841176`
`offset`	`45980183`

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

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`	`"occaecat cupidatat officia dolore"`

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`	`"sint ullamco"`

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`	`"eiusmod officia quis"`

Request Payload

Response Payload

{}

Service Homepage: sendgrid.com/en-us

API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started

emails