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": "esse occaecat aliquip Lorem"
    },
    {
      "message": "ad do id"
    },
    {
      "message": "Excepteur"
    }
  ]
}

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

Request Payload

Response Payload

{
  "batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi"
}

{
  "errors": [
    {
      "message": "officia amet anim qui",
      "field": "occaecat",
      "help": {}
    },
    {
      "message": "cupidatat officia",
      "field": "dolore do reprehenderit",
      "help": {}
    }
  ],
  "id": "voluptate"
}

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

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

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

{
  "errors": [
    {
      "message": "eiusmod deserunt officia dolor labore"
    }
  ]
}

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

Request Payload

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

Response Payload

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

{
  "errors": [
    {
      "message": "dolore sunt officia irure",
      "field": "Lorem commodo non dolore",
      "help": {}
    },
    {
      "message": "occaecat et ea",
      "field": "commodo minim qui laborum",
      "help": {}
    },
    {
      "message": "sint",
      "field": "occaecat",
      "help": {}
    }
  ],
  "id": "nostrud pariatur ad in"
}

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

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

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

{
  "errors": [
    {
      "message": "et exercitation proident"
    },
    {
      "message": "ea nisi"
    },
    {
      "message": "incididunt"
    }
  ]
}

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

Request Payload

Response Payload

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

{
  "errors": [
    {
      "message": "in",
      "field": "irure",
      "help": {}
    }
  ],
  "id": "minim Lorem laborum ipsum"
}

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

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

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

{
  "errors": [
    {
      "message": "ad nostrud minim anim"
    }
  ]
}

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`	`"exercitation voluptate cillum deserunt aliqua"`

Request Payload

Response Payload

{
  "batch_id": "HkJ5yLYULb7Rj8GKSx7u025ouWVlMgAi"
}

{
  "errors": [
    {
      "message": "ut ullamco amet dolore",
      "field": "nulla exercitation",
      "help": {}
    },
    {
      "message": "dolore anim ullamco aliqua",
      "field": "in et",
      "help": {}
    },
    {
      "message": "aliqua adipisicing reprehenderit eiusmod aute",
      "field": "ad veniam",
      "help": {}
    }
  ],
  "id": "exercitation"
}

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

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

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

{
  "errors": [
    {
      "message": "fugiat"
    },
    {
      "message": "Ut"
    },
    {
      "message": "magna"
    }
  ]
}

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`	`"consequat aute irure incididunt ea"`

Request Payload

Response Payload

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

{
  "errors": [
    {
      "message": "amet voluptate dolor dolor in",
      "field": "Ut Duis sed",
      "help": {}
    },
    {
      "message": "sunt",
      "field": "dolore Ut tempor mollit",
      "help": {}
    },
    {
      "message": "quis",
      "field": "anim amet",
      "help": {}
    }
  ],
  "id": "minim dolore exercitation"
}

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

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

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

{
  "errors": [
    {
      "message": "sint officia elit dolore exercitation"
    },
    {
      "message": "velit fugiat sint et in"
    },
    {
      "message": "cillum ad"
    },
    {
      "message": "aute sit"
    },
    {
      "message": "velit tempor sed"
    }
  ]
}

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

Request Payload

{
  "status": "pause"
}

Response Payload

Error generating example

{
  "errors": [
    {
      "message": "nostrud non fugiat adipisicing",
      "field": "voluptate fugiat ut cillum aliqua",
      "help": {}
    },
    {
      "message": "magna laboris amet",
      "field": "anim ut pariatur mollit nulla",
      "help": {}
    },
    {
      "message": "tempor consectetur ex proident et",
      "field": "sit consequat labore",
      "help": {}
    },
    {
      "message": "aliqua aute",
      "field": "in qui adipisicing in",
      "help": {}
    }
  ],
  "id": "ullamco et veniam"
}

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

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

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

{
  "errors": [
    {
      "message": "est culpa enim nisi"
    }
  ]
}

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

Request Payload

Response Payload

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

{
  "errors": [
    {
      "message": "id sint dolore Lorem pariatur",
      "field": "ipsum magna dolor dolor",
      "help": {}
    },
    {
      "message": "magna aliquip",
      "field": "ex",
      "help": {}
    },
    {
      "message": "enim adipisicing elit est",
      "field": "tempor",
      "help": {}
    },
    {
      "message": "incididunt nisi",
      "field": "labore aliqua",
      "help": {}
    }
  ],
  "id": "ut labore aliquip nisi occaecat"
}

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

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

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

{
  "errors": [
    {
      "message": "in ea Duis nostrud"
    },
    {
      "message": "dolor culpa aliquip"
    },
    {
      "message": "aliqua ut cupidatat exercitation"
    }
  ]
}

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`	`"sed laborum aute in"`

Request Payload

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

Response Payload

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

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

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

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

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

{
  "errors": [
    {
      "message": "occaecat consequat"
    },
    {
      "message": "consequat do nulla labore"
    }
  ]
}

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

Header Name	Example
`on-behalf-of`	`"eiusmod ullamco culpa deserunt velit"`

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": "ut sed"
    },
    {
      "message": "aute"
    },
    {
      "message": "exercitation incididunt ipsum"
    },
    {
      "message": "proident"
    },
    {
      "message": "voluptate nostrud qui"
    }
  ]
}

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

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

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`	`"consectetur Duis in commodo reprehenderit"`

Request Payload

{
  "name": "A New Hope"
}

Response Payload

{
  "api_key_id": "qfTQ6KG0QBiwWdJ0-pCLCA",
  "name": "A New Hope"
}

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

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

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

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

{
  "errors": [
    {
      "message": "voluptate incididunt consequat minim ad"
    },
    {
      "message": "laborum Lorem Excepteur amet sint"
    },
    {
      "message": "aliquip ut"
    },
    {
      "message": "culpa Excepteur nostrud"
    },
    {
      "message": "nisi"
    }
  ]
}

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

Request Payload

{
  "name": "Profiles key",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ]
}

Response Payload

{
  "api_key_id": "qfTQ6KG0QBiwWdJ0-pCLCA",
  "name": "Profiles Key",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ]
}

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

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

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

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

{
  "errors": [
    {
      "message": "dolore"
    },
    {
      "message": "ea veniam sit"
    },
    {
      "message": "labore culpa est"
    },
    {
      "message": "Lorem tempor 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`	`"ea labore occaecat"`

Request Payload

Response Payload

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

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

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

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

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

{
  "errors": [
    {
      "message": "eiusmod"
    },
    {
      "message": "exercitation ut"
    },
    {
      "message": "Excepteur non"
    },
    {
      "message": "mollit"
    },
    {
      "message": "Lorem aliquip amet"
    }
  ]
}

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

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": "consequat est commodo"
    },
    {
      "message": "sunt ea nisi ullamco"
    },
    {
      "message": "consectetur ea reprehenderit dolore proident"
    },
    {
      "message": "officia Duis"
    }
  ]
}

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

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": "dolor do in Duis laborum"
    },
    {
      "message": "velit consectetur"
    },
    {
      "message": "in occaecat aliqua"
    },
    {
      "message": "Duis tempor amet cupidatat"
    },
    {
      "message": "ipsum nostrud"
    }
  ]
}

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

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": "do adipisicing in cillum enim"
    },
    {
      "message": "in magna enim"
    },
    {
      "message": "anim"
    },
    {
      "message": "ea Lorem"
    },
    {
      "message": "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`	`"dolore enim nulla"`

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": "occaecat"
    },
    {
      "message": "aliquip ut ullamco"
    },
    {
      "message": "proident et"
    }
  ]
}

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

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

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

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": "quis Ut Duis cupidatat"
    },
    {
      "message": "Lorem id occaecat sint officia"
    },
    {
      "message": "Ut est incididunt"
    },
    {
      "message": "non deserunt dolor velit sint"
    },
    {
      "message": "nisi aliquip irure enim esse"
    }
  ]
}

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

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

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": "veniam id consectetur"
    },
    {
      "message": "dolor"
    },
    {
      "message": "labore eu mollit"
    },
    {
      "message": "amet dolor in"
    }
  ]
}

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

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

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

[
  {
    "message": "ut exercitation",
    "field": null,
    "error_id": "magna nisi"
  },
  {
    "message": "ad enim Excepteur qui cupidatat",
    "field": null,
    "error_id": "et anim"
  },
  {
    "message": "fugiat voluptate id aliqua sint",
    "field": "aute deserunt voluptate dolor pariatur",
    "error_id": "dolor dolor enim do incididunt"
  }
]

[
  {
    "message": "in velit et id",
    "field": null,
    "error_id": "non exercitation aliqua ad laborum"
  },
  {
    "message": "aliqua cillum sit ullamco",
    "field": "esse irure Duis enim nisi",
    "error_id": "non sit sunt Excepteur proident"
  },
  {
    "message": "occaecat deserunt do dolor",
    "field": null,
    "error_id": "culpa laboris ipsum eu ut"
  },
  {
    "message": "consectetur quis non",
    "field": "ut",
    "error_id": "ea"
  },
  {
    "message": "id amet",
    "field": "esse",
    "error_id": "fugiat dolore Duis enim consequat"
  }
]

[
  {
    "message": "dolor consectetur",
    "field": null,
    "error_id": "laborum fugiat id ullamco"
  },
  {
    "message": "ad veniam proident",
    "field": null,
    "error_id": "esse incididunt"
  },
  {
    "message": "nostrud",
    "field": null,
    "error_id": "commodo"
  },
  {
    "message": "dolor",
    "field": "ea cillum id",
    "error_id": "Excepteur aute veniam fugiat dolore"
  }
]

[
  {
    "message": "ut cillum Duis",
    "field": null,
    "error_id": "deserunt magna"
  },
  {
    "message": "in velit",
    "field": "est do",
    "error_id": "minim consequat sunt fugiat dolor"
  },
  {
    "message": "id ut adipisicing anim",
    "field": "non",
    "error_id": "enim ullamco esse velit"
  }
]

[
  {
    "message": "occaecat commodo Excepteur id dolor",
    "field": "laborum ea exercitation esse",
    "error_id": "proident est dolore sed Ut"
  },
  {
    "message": "est",
    "field": "Ut",
    "error_id": "eu in labore ex"
  },
  {
    "message": "eu non",
    "field": "ipsum",
    "error_id": "ipsum mollit ad"
  }
]

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

[
  {
    "message": "ut laboris commodo",
    "field": null,
    "error_id": "est sunt eiusmod"
  }
]

[
  {
    "message": "minim",
    "field": null,
    "error_id": "proident consequat ullamco id"
  },
  {
    "message": "ut Lorem",
    "field": "veniam",
    "error_id": "amet"
  },
  {
    "message": "consequat ex enim aliqua tempor",
    "field": null,
    "error_id": "incididunt pariatur dolor laborum in"
  },
  {
    "message": "cupidatat exercitation reprehenderit",
    "field": null,
    "error_id": "nulla est sint"
  }
]

[
  {
    "message": "est cupidatat",
    "field": "cillum officia ex",
    "error_id": "pariatur dolore cupidatat ut ea"
  },
  {
    "message": "deserunt Ut aute ex",
    "field": null,
    "error_id": "cillum"
  }
]

[
  {
    "message": "irure in velit",
    "field": null,
    "error_id": "sed ipsum culpa dolor pariatur"
  }
]

[
  {
    "message": "eiusmod tempor Duis",
    "field": "non ad ea exercitation ipsum",
    "error_id": "pariatur"
  },
  {
    "message": "reprehenderit cupidatat exercitation est",
    "field": null,
    "error_id": "enim"
  }
]

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

[
  {
    "message": "ut",
    "field": null,
    "error_id": "quis"
  },
  {
    "message": "est veniam",
    "field": null,
    "error_id": "laborum tempor dolor cillum veniam"
  }
]

[
  {
    "message": "ut dolor veniam aute minim",
    "field": "reprehenderit in",
    "error_id": "velit"
  },
  {
    "message": "sunt",
    "field": null,
    "error_id": "consequat dolor"
  },
  {
    "message": "dolor anim laborum",
    "field": null,
    "error_id": "reprehenderit in"
  },
  {
    "message": "pariatur incididunt velit",
    "field": null,
    "error_id": "id incididunt reprehenderit"
  },
  {
    "message": "minim",
    "field": null,
    "error_id": "aliquip sunt dolor est"
  }
]

[
  {
    "message": "exercitation",
    "field": "do cupidatat non ad",
    "error_id": "sed nisi"
  }
]

[
  {
    "message": "sint ea eiusmod nostrud reprehenderit",
    "field": "qui id labore",
    "error_id": "mollit magna consequat commodo"
  },
  {
    "message": "in Ut Lorem culpa",
    "field": "reprehenderit officia fugiat",
    "error_id": "esse et aliqua"
  },
  {
    "message": "exercitation mollit reprehenderit nostrud",
    "field": "nulla adipisicing et",
    "error_id": "dolore"
  },
  {
    "message": "labore esse dolore",
    "field": "nostrud do aute",
    "error_id": "fugiat ullamco culpa qui"
  }
]

[
  {
    "message": "aliqua deserunt ipsum consectetur",
    "field": null,
    "error_id": "Duis esse magna do officia"
  },
  {
    "message": "mollit occaecat in incididunt amet",
    "field": null,
    "error_id": "dolore aute cillum exercitation fugiat"
  },
  {
    "message": "nulla",
    "field": null,
    "error_id": "proident consectetur"
  },
  {
    "message": "quis",
    "field": null,
    "error_id": "adipisicing magna nostrud est"
  }
]

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

[
  {
    "message": "pariatur aute fugiat et",
    "field": null,
    "error_id": "in"
  }
]

[
  {
    "message": "nulla in sit",
    "field": "irure aliquip fugiat proident exercitation",
    "error_id": "cillum Ut quis consectetur"
  },
  {
    "message": "fugiat laboris minim labore",
    "field": "commodo est reprehenderit",
    "error_id": "enim in sit commodo"
  },
  {
    "message": "mollit voluptate occaecat ad",
    "field": null,
    "error_id": "sint elit amet laboris minim"
  }
]

[
  {
    "message": "cupidatat ad",
    "field": "exercitation ullamco labore anim laboris",
    "error_id": "incididunt cillum ad labore sint"
  },
  {
    "message": "dolor",
    "field": "non in culpa sit laborum",
    "error_id": "dolor voluptate est Excepteur"
  },
  {
    "message": "veniam",
    "field": "cillum eu voluptate Excepteur enim",
    "error_id": "dolor"
  },
  {
    "message": "id cupidatat aute",
    "field": "et qui cupidatat irure laboris",
    "error_id": "tempor ea labore et"
  }
]

[
  {
    "message": "consequat sed ad",
    "field": "fugiat ea labore",
    "error_id": "irure"
  },
  {
    "message": "non aute pariatur",
    "field": null,
    "error_id": "non deserunt ad ut in"
  },
  {
    "message": "proident officia in sint",
    "field": null,
    "error_id": "et nulla"
  },
  {
    "message": "ad in",
    "field": "deserunt proident pariatur dolor Ut",
    "error_id": "dolor anim eu amet"
  },
  {
    "message": "eiusmod",
    "field": null,
    "error_id": "adipisicing eiusmod nulla in"
  }
]

[
  {
    "message": "dolor",
    "field": "proident cillum ut officia",
    "error_id": "id cupidatat culpa"
  }
]

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

[
  {
    "message": "aute nisi",
    "field": "in eiusmod occaecat nisi exercitation",
    "error_id": "pariatur dolore eu"
  },
  {
    "message": "minim Lorem quis magna eiusmod",
    "field": "enim",
    "error_id": "mollit ad"
  },
  {
    "message": "sunt in fugiat laboris nisi",
    "field": null,
    "error_id": "non reprehenderit"
  },
  {
    "message": "id sed ut nostrud",
    "field": "pariatur adipisicing in magna",
    "error_id": "ut dolor"
  },
  {
    "message": "sed",
    "field": null,
    "error_id": "magna"
  }
]

[
  {
    "message": "aliquip",
    "field": null,
    "error_id": "adipisicing quis culpa veniam"
  },
  {
    "message": "officia",
    "field": "nostrud enim in",
    "error_id": "quis Lorem reprehenderit velit deserunt"
  },
  {
    "message": "irure dolore eu",
    "field": "ut non proident in",
    "error_id": "Lorem dolor officia"
  },
  {
    "message": "officia",
    "field": null,
    "error_id": "pariatur aliqua"
  },
  {
    "message": "commodo deserunt",
    "field": null,
    "error_id": "exercitation"
  }
]

[
  {
    "message": "qui commodo",
    "field": "aute",
    "error_id": "ad"
  },
  {
    "message": "laborum",
    "field": "dolore labore",
    "error_id": "sunt"
  },
  {
    "message": "ad ex",
    "field": "incididunt sed exercitation ut et",
    "error_id": "est aliquip quis nisi incididunt"
  }
]

[
  {
    "message": "dolore eu enim",
    "field": null,
    "error_id": "Excepteur"
  },
  {
    "message": "sunt incididunt ut Duis ex",
    "field": "cillum dolor minim",
    "error_id": "reprehenderit do"
  },
  {
    "message": "Ut qui",
    "field": "tempor ea deserunt elit aliqua",
    "error_id": "sunt"
  },
  {
    "message": "dolor consectetur aliquip",
    "field": null,
    "error_id": "velit"
  }
]

[
  {
    "message": "tempor do commodo veniam",
    "field": null,
    "error_id": "ex aliquip nulla irure"
  },
  {
    "message": "tempor",
    "field": null,
    "error_id": "ipsum pariatur"
  }
]

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
}

[
  {
    "message": "commodo",
    "field": null,
    "error_id": "culpa adipisicing amet reprehenderit"
  },
  {
    "message": "officia nulla",
    "field": "deserunt aliqua qui aliquip ut",
    "error_id": "nulla est"
  },
  {
    "message": "voluptate mollit nulla in",
    "field": null,
    "error_id": "nulla"
  },
  {
    "message": "est",
    "field": "adipisicing dolore in dolore tempor",
    "error_id": "sunt"
  }
]

[
  {
    "message": "anim eiusmod mollit",
    "field": "Duis sit dolore",
    "error_id": "aute irure id cupidatat"
  },
  {
    "message": "enim",
    "field": null,
    "error_id": "est reprehenderit occaecat"
  }
]

[
  {
    "message": "adipisicing Duis ex",
    "field": "proident deserunt",
    "error_id": "ut aute"
  }
]

[
  {
    "message": "proident deserunt in",
    "field": null,
    "error_id": "veniam"
  },
  {
    "message": "aliqua quis",
    "field": null,
    "error_id": "ea reprehenderit elit culpa"
  }
]

[
  {
    "message": "elit commodo eiusmod",
    "field": "sit deserunt tempor",
    "error_id": "est occaecat"
  }
]

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`	`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": 1621288520,
    "completed_integration": true,
    "id": "b0b98502-9408-4b24-9e3d-31ed7cb15312",
    "single_signon_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312",
    "audience_url": "https://api.sendgrid.com/v3/public/sso/saml/response/id/b0b98502-9408-4b24-9e3d-31ed7cb15312"
  }
]

[
  {
    "message": "reprehenderit esse",
    "field": null,
    "error_id": "tempor commodo id cupidatat"
  }
]

[
  {
    "message": "incididunt",
    "field": "dolore ut qui",
    "error_id": "non Excepteur sit dolore est"
  },
  {
    "message": "culpa anim in",
    "field": null,
    "error_id": "non consequat Ut proident aute"
  },
  {
    "message": "Excepteur quis aute",
    "field": "labore",
    "error_id": "dolore"
  },
  {
    "message": "id sint ut",
    "field": null,
    "error_id": "Ut voluptate ea ut pariatur"
  },
  {
    "message": "nulla aliquip",
    "field": "velit aliquip",
    "error_id": "commodo veniam qui dolore elit"
  }
]

[
  {
    "message": "Ut aliqua nulla amet",
    "field": null,
    "error_id": "magna ut sunt ad"
  },
  {
    "message": "aliqua Lorem ut",
    "field": null,
    "error_id": "non"
  }
]

[
  {
    "message": "dolor minim aliqua",
    "field": null,
    "error_id": "veniam"
  },
  {
    "message": "dolor",
    "field": null,
    "error_id": "sunt eu"
  }
]

[
  {
    "message": "nulla",
    "field": "ex nisi culpa ipsum",
    "error_id": "ut fugiat et"
  },
  {
    "message": "in do",
    "field": "ut",
    "error_id": "labore"
  }
]

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

[
  {
    "message": "eu fugiat minim elit qui",
    "field": null,
    "error_id": "nostrud esse ullamco"
  },
  {
    "message": "ad",
    "field": "id tempor ut veniam",
    "error_id": "dolore pariatur"
  },
  {
    "message": "in ex pariatur sunt",
    "field": null,
    "error_id": "in commodo"
  }
]

[
  {
    "message": "Duis quis minim",
    "field": null,
    "error_id": "irure"
  },
  {
    "message": "dolor aute consequat",
    "field": "non",
    "error_id": "aute"
  },
  {
    "message": "sit voluptate",
    "field": null,
    "error_id": "ut velit sit Duis"
  }
]

[
  {
    "message": "sunt occaecat officia",
    "field": "non dolor labore",
    "error_id": "adipisicing sint eu laborum"
  }
]

[
  {
    "message": "magna consectetur ut deserunt in",
    "field": null,
    "error_id": "id incididunt"
  }
]

[
  {
    "message": "in sunt",
    "field": null,
    "error_id": "magna incididunt mollit"
  },
  {
    "message": "sint reprehenderit",
    "field": "sed esse ullamco consequat ex",
    "error_id": "aliquip Excepteur"
  },
  {
    "message": "magna",
    "field": "anim quis",
    "error_id": "elit aliquip ullamco"
  }
]

PATCH

/v3/sso/integrations/{id}

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

Query Parameter Name	Example
`si`	`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"
}

[
  {
    "message": "voluptate commodo Lorem dolore",
    "field": "velit cillum nulla",
    "error_id": "incididunt elit est ex"
  }
]

[
  {
    "message": "consequat incididunt ad sunt",
    "field": "tempor",
    "error_id": "eiusmod do"
  },
  {
    "message": "magna quis",
    "field": "ex",
    "error_id": "in exercitation occaecat adipisicing culpa"
  }
]

[
  {
    "message": "aute",
    "field": "ea dolore in",
    "error_id": "culpa esse in"
  },
  {
    "message": "exercitation anim in",
    "field": null,
    "error_id": "occaecat deserunt laborum ad"
  }
]

[
  {
    "message": "quis sit ullamco qui",
    "field": null,
    "error_id": "in do"
  }
]

[
  {
    "message": "et consectetur",
    "field": "Excepteur exercitation quis pariatur",
    "error_id": "dolor ut"
  }
]

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.

[
  {
    "message": "sit velit",
    "field": null,
    "error_id": "nostrud reprehenderit dolor"
  },
  {
    "message": "ut pariatur",
    "field": "ea cillum aliquip quis",
    "error_id": "magna qui ut aute"
  },
  {
    "message": "culpa reprehenderit",
    "field": null,
    "error_id": "magna irure"
  },
  {
    "message": "in Duis consectetur dolor",
    "field": null,
    "error_id": "quis"
  },
  {
    "message": "officia nulla et sit",
    "field": null,
    "error_id": "anim fugiat ut"
  }
]

[
  {
    "message": "Ut amet reprehenderit adipisicing do",
    "field": "officia aliquip incididunt",
    "error_id": "sed ad"
  },
  {
    "message": "ipsum occaecat pariatur tempor",
    "field": "et dolore anim adipisicing",
    "error_id": "nisi consequat ipsum do velit"
  },
  {
    "message": "in dolore dolore cillum",
    "field": "dolor et pariatur minim veniam",
    "error_id": "laboris"
  },
  {
    "message": "et Ut pariatur",
    "field": null,
    "error_id": "ipsum ad ut"
  },
  {
    "message": "nulla",
    "field": "Duis do minim ipsum",
    "error_id": "id irure sit ex"
  }
]

[
  {
    "message": "eiusmod occaecat voluptate consequat ex",
    "field": "sit consequat",
    "error_id": "dolor dolore in amet"
  },
  {
    "message": "aute Duis aliquip eiusmod",
    "field": "non",
    "error_id": "tempor mollit consequat incididunt sint"
  },
  {
    "message": "in aliqua",
    "field": null,
    "error_id": "quis"
  },
  {
    "message": "cupidatat elit in consectetur",
    "field": "exercitation aliqua quis",
    "error_id": "occaecat officia exercitation cillum cupidatat"
  }
]

[
  {
    "message": "adipisicing aute voluptate",
    "field": "eu",
    "error_id": "eu elit"
  },
  {
    "message": "voluptate proident",
    "field": "velit",
    "error_id": "dolore cillum"
  }
]

[
  {
    "message": "eiusmod ut Duis commodo",
    "field": "eu",
    "error_id": "est consectetur in enim"
  },
  {
    "message": "do nulla culpa",
    "field": "eu ipsum pariatur magna",
    "error_id": "fugiat Ut"
  },
  {
    "message": "dolor",
    "field": null,
    "error_id": "non amet"
  }
]

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
}

[
  {
    "message": "ut incididunt aute",
    "field": null,
    "error_id": "dolor officia"
  },
  {
    "message": "nulla et occaecat dolore",
    "field": null,
    "error_id": "Duis ex proident ullamco"
  },
  {
    "message": "in elit consequat non",
    "field": "cillum dolor",
    "error_id": "sit in commodo aute anim"
  },
  {
    "message": "ad proident nostrud irure dolore",
    "field": "in",
    "error_id": "anim tempor"
  },
  {
    "message": "aliqua",
    "field": null,
    "error_id": "dolore nostrud nisi non"
  }
]

[
  {
    "message": "voluptate sit laborum in",
    "field": "id sit",
    "error_id": "sint"
  },
  {
    "message": "ipsum in voluptate magna mollit",
    "field": null,
    "error_id": "commodo"
  },
  {
    "message": "ea ut laboris reprehenderit dolor",
    "field": null,
    "error_id": "velit nulla sit eiusmod"
  },
  {
    "message": "sint dolore eu ea reprehenderit",
    "field": null,
    "error_id": "ex consectetur sunt"
  }
]

[
  {
    "message": "fugiat",
    "field": null,
    "error_id": "ut ad dolore velit eiusmod"
  },
  {
    "message": "esse laboris cillum dolore adipisicing",
    "field": "consectetur aliquip sit laborum",
    "error_id": "reprehenderit sunt aute deserunt ex"
  }
]

[
  {
    "message": "dolore ut ut id ipsum",
    "field": "qui sint minim mollit veniam",
    "error_id": "laboris nulla irure"
  },
  {
    "message": "ea qui voluptate Ut id",
    "field": null,
    "error_id": "magna proident laborum"
  },
  {
    "message": "et eiusmod enim",
    "field": "ea incididunt",
    "error_id": "est"
  },
  {
    "message": "dolor eu Ut qui occaecat",
    "field": "pariatur",
    "error_id": "cupidatat"
  }
]

[
  {
    "message": "do irure",
    "field": "labore tempor incididunt",
    "error_id": "Lorem anim"
  },
  {
    "message": "sint nisi pariatur Excepteur",
    "field": null,
    "error_id": "consectetur veniam tempor proident in"
  },
  {
    "message": "amet ad pariatur",
    "field": "labore et voluptate velit",
    "error_id": "tempor sed in"
  },
  {
    "message": "officia non",
    "field": "in in officia sed magna",
    "error_id": "voluptate Excepteur adipisicing"
  },
  {
    "message": "reprehenderit",
    "field": "ut dolor Excepteur sunt",
    "error_id": "mollit ut dolor laboris dolore"
  }
]

PATCH

/v3/sso/teammates/{username}

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

Request Payload

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

Response Payload

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

[
  {
    "message": "laboris minim et sunt",
    "field": null,
    "error_id": "deserunt"
  },
  {
    "message": "adipisicing id minim sit quis",
    "field": null,
    "error_id": "irure"
  },
  {
    "message": "in qui",
    "field": "ullamco officia reprehenderit",
    "error_id": "ut incididunt ea mollit"
  },
  {
    "message": "mollit",
    "field": "amet anim elit magna",
    "error_id": "eu in laboris do aliqua"
  }
]

[
  {
    "message": "ad sint culpa laborum incididunt",
    "field": null,
    "error_id": "est ex sit dolor"
  },
  {
    "message": "ex Ut et cupidatat",
    "field": "dolore irure laboris aute",
    "error_id": "tempor ea"
  },
  {
    "message": "id",
    "field": "deserunt commodo in",
    "error_id": "occaecat dolore nostrud anim"
  },
  {
    "message": "in in anim commodo sed",
    "field": "in dolor",
    "error_id": "proident dolor cupidatat amet Lorem"
  }
]

[
  {
    "message": "labore",
    "field": null,
    "error_id": "consequat Lorem"
  },
  {
    "message": "mollit adipisicing dolor ullamco commodo",
    "field": "esse irure sed est",
    "error_id": "dolore"
  }
]

[
  {
    "message": "ullamco laborum nostrud pariatur",
    "field": null,
    "error_id": "elit"
  }
]

[
  {
    "message": "dolor consectetur amet",
    "field": "mollit aliqua ad commodo",
    "error_id": "nostrud"
  }
]

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`	`77988835`
`offset`	`21539034`

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

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": "fugiat",
      "field": null,
      "message": "exercitation",
      "parameter": "consequat"
    },
    {
      "error_id": "officia",
      "field": null,
      "message": "deserunt",
      "parameter": "sed deserunt"
    },
    {
      "error_id": "mollit",
      "field": "mollit deserunt et",
      "message": "dolor voluptate",
      "parameter": "do sed adipisicing"
    },
    {
      "error_id": "cupidatat velit sit proident",
      "field": "tempor proident cillum culpa nulla",
      "message": "elit in nostrud id",
      "parameter": "amet dolor"
    },
    {
      "error_id": "ut esse",
      "field": null,
      "message": "incididunt",
      "parameter": "aliqua voluptate sint pariatur"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "irure Ut sint adipisicing ea",
      "field": null,
      "message": "laborum cillum dolor",
      "parameter": "irure dolor proident"
    },
    {
      "error_id": "dolore",
      "field": "Lorem irure",
      "message": "pariatur dolor velit sint sit",
      "parameter": "deserunt aliquip magna"
    },
    {
      "error_id": "labore",
      "field": "sit laborum et",
      "message": "sunt",
      "parameter": "dolore mollit in et Duis"
    },
    {
      "error_id": "anim",
      "field": null,
      "message": "nisi est enim ad",
      "parameter": "reprehenderit officia"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "aute",
      "field": null,
      "message": "culpa aliqua non elit",
      "parameter": "laborum anim non incididunt esse"
    },
    {
      "error_id": "cillum laboris",
      "field": null,
      "message": "ipsum fugiat",
      "parameter": "anim laboris dolore"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "exercitation elit officia reprehenderit",
      "field": null,
      "message": "eu fugiat sunt in",
      "parameter": "culpa ipsum Ut laboris"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ut enim",
      "field": "exercitation ea aliqua et Excepteur",
      "message": "velit in tempor",
      "parameter": "Duis Excepteur anim"
    },
    {
      "error_id": "officia aliquip qui",
      "field": "in eu consectetur consequat Ut",
      "message": "proident",
      "parameter": "amet"
    }
  ]
}

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

Request Payload

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

Response Payload

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

{
  "errors": [
    {
      "error_id": "anim aliqua velit",
      "field": "commodo magna labore consectetur",
      "message": "labore sed Ut eiusmod cillum",
      "parameter": "dolor reprehenderit proident ad"
    },
    {
      "error_id": "est sunt sed",
      "field": null,
      "message": "in enim Ut ad laboris",
      "parameter": "Ut incididunt reprehenderit aute dolore"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "officia dolor laborum",
      "field": "qui Duis sit",
      "message": "laborum",
      "parameter": "velit pariatur nulla"
    },
    {
      "error_id": "cillum mollit elit aliqua consectetur",
      "field": "elit dolore officia ullamco minim",
      "message": "deserunt ut qui",
      "parameter": "in dolor esse nostrud"
    },
    {
      "error_id": "est",
      "field": null,
      "message": "in esse amet voluptate",
      "parameter": "eu irure aliqua"
    },
    {
      "error_id": "ad culpa irure",
      "field": "nisi",
      "message": "exercitation fugiat adipisicing voluptate ullamco",
      "parameter": "Duis anim tempor ad"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "esse",
      "field": null,
      "message": "irure ad non aliqua",
      "parameter": "cillum"
    },
    {
      "error_id": "pariatur deserunt",
      "field": null,
      "message": "eiusmod ut",
      "parameter": "nostrud anim sit"
    },
    {
      "error_id": "magna ullamco dolor ad",
      "field": "amet in cupidatat officia ullamco",
      "message": "aute",
      "parameter": "nostrud eiusmod in amet ex"
    },
    {
      "error_id": "qui id",
      "field": null,
      "message": "irure Lorem sint",
      "parameter": "cupidatat nulla aliqua"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "aute sed",
      "field": null,
      "message": "consectetur mollit labore",
      "parameter": "minim dolore"
    },
    {
      "error_id": "occaecat ipsum aute",
      "field": "nulla tempor occaecat",
      "message": "dolore ut",
      "parameter": "nostrud dolore ut amet"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "nisi",
      "field": "esse labore",
      "message": "in deserunt fugiat dolor ut",
      "parameter": "consectetur minim"
    },
    {
      "error_id": "sunt consectetur aliqua deserunt",
      "field": "amet in",
      "message": "pariatur fugiat non",
      "parameter": "Excepteur amet sit deserunt"
    },
    {
      "error_id": "ullamco eu ipsum",
      "field": null,
      "message": "in cupidatat est",
      "parameter": "Duis quis"
    },
    {
      "error_id": "ullamco sunt magna",
      "field": null,
      "message": "ullamco ex non exercitation voluptate",
      "parameter": "occaecat do tempor in"
    },
    {
      "error_id": "adipisicing nisi",
      "field": null,
      "message": "Excepteur",
      "parameter": "ad consequat"
    }
  ]
}

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

Request Payload

Response Payload

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

{
  "errors": [
    {
      "error_id": "in irure anim elit",
      "field": "adipisicing eu",
      "message": "ea",
      "parameter": "Excepteur nulla"
    },
    {
      "error_id": "Ut magna reprehenderit non ex",
      "field": "dolore veniam deserunt",
      "message": "veniam voluptate in",
      "parameter": "cupidatat dolor ex"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "amet magna dolore",
      "field": null,
      "message": "culpa",
      "parameter": "id anim tempor Excepteur dolor"
    },
    {
      "error_id": "mollit cillum",
      "field": null,
      "message": "ullamco ipsum Excepteur",
      "parameter": "dolore"
    },
    {
      "error_id": "sed ipsum",
      "field": null,
      "message": "non voluptate sint adipisicing",
      "parameter": "nisi laboris aliqua"
    },
    {
      "error_id": "magna incididunt Duis",
      "field": null,
      "message": "irure",
      "parameter": "incididunt officia laboris nisi ullamco"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "velit eiusmod",
      "field": null,
      "message": "ea culpa dolor aliqua",
      "parameter": "tempor adipisicing deserunt"
    },
    {
      "error_id": "elit adipisicing laboris nisi irure",
      "field": "fugiat in",
      "message": "nulla eu ipsum",
      "parameter": "dolore Duis"
    },
    {
      "error_id": "consectetur ipsum",
      "field": "nulla non sint id",
      "message": "sit dolor",
      "parameter": "in elit ea"
    },
    {
      "error_id": "amet ullamco eu",
      "field": "cupidatat ut irure minim ex",
      "message": "voluptate esse",
      "parameter": "aute Excepteur"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "in ad nulla exercitation",
      "field": "exercitation Duis in ut",
      "message": "minim sit",
      "parameter": "ad fugiat"
    },
    {
      "error_id": "et",
      "field": null,
      "message": "elit id Excepteur nulla sit",
      "parameter": "in dolor elit sunt anim"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "reprehenderit dolor",
      "field": null,
      "message": "in ipsum Duis",
      "parameter": "ad in"
    }
  ]
}

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

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": "velit eiusmod culpa",
      "field": "anim minim dolor",
      "message": "anim deserunt",
      "parameter": "aliqua dolor sunt"
    },
    {
      "error_id": "Duis",
      "field": "ut in fugiat quis",
      "message": "reprehenderit",
      "parameter": "cupidatat"
    },
    {
      "error_id": "voluptate ad",
      "field": null,
      "message": "commodo ut aliquip",
      "parameter": "quis amet ut cupidatat"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "culpa nulla dolore",
      "field": "pariatur fugiat non consectetur Lorem",
      "message": "anim officia adipisicing",
      "parameter": "aliquip"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "nostrud sed aliquip",
      "field": null,
      "message": "aute eu irure",
      "parameter": "nostrud in"
    },
    {
      "error_id": "sed laboris Lorem Ut",
      "field": null,
      "message": "Lorem adipisicing",
      "parameter": "dolore dolor cillum"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "laboris ullamco Duis sunt",
      "field": "in dolor",
      "message": "nostrud ut elit sit",
      "parameter": "commodo"
    },
    {
      "error_id": "nostrud magna aliquip quis in",
      "field": "nostrud labore do dolor culpa",
      "message": "commodo non",
      "parameter": "qui"
    },
    {
      "error_id": "ex veniam sit",
      "field": "Lorem Excepteur",
      "message": "ad",
      "parameter": "anim ex exercitation laborum labore"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "commodo",
      "field": null,
      "message": "ut sunt ea amet",
      "parameter": "cillum"
    },
    {
      "error_id": "ea velit adipisicing officia Duis",
      "field": null,
      "message": "aliqua ex",
      "parameter": "amet eu ea"
    },
    {
      "error_id": "irure",
      "field": null,
      "message": "Duis",
      "parameter": "quis"
    },
    {
      "error_id": "pariatur adipisicing laboris Ut dolore",
      "field": null,
      "message": "proident",
      "parameter": "sit"
    }
  ]
}

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

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": "nisi",
      "field": null,
      "message": "commodo officia tempor cillum Excepteur",
      "parameter": "deserunt incididunt ut aliquip"
    },
    {
      "error_id": "Ut non",
      "field": null,
      "message": "non aute et",
      "parameter": "et enim exercitation ullamco"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ut laborum veniam",
      "field": "irure ex Ut ea",
      "message": "minim reprehenderit proident id ex",
      "parameter": "officia ut"
    },
    {
      "error_id": "cillum non",
      "field": null,
      "message": "in cillum esse consectetur",
      "parameter": "est"
    },
    {
      "error_id": "exercitation enim esse",
      "field": "Duis",
      "message": "laboris",
      "parameter": "deserunt mollit ea"
    },
    {
      "error_id": "elit",
      "field": null,
      "message": "aliqua dolor dolore ullamco",
      "parameter": "et Lorem do commodo"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "minim",
      "field": "consequat et",
      "message": "cupidatat reprehenderit incididunt",
      "parameter": "non ullamco quis"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "culpa nostrud do",
      "field": null,
      "message": "Lorem tempor cupidatat",
      "parameter": "in laborum sit"
    },
    {
      "error_id": "fugiat eu",
      "field": "aliqua Ut nulla dolore",
      "message": "in sed adipisicing nostrud dolor",
      "parameter": "adipisicing laborum occaecat minim irure"
    },
    {
      "error_id": "sit ipsum",
      "field": "anim deserunt proident",
      "message": "et ullamco reprehenderit sunt Excepteur",
      "parameter": "dolore"
    },
    {
      "error_id": "enim nisi ut ea",
      "field": null,
      "message": "qui cupidatat sit in quis",
      "parameter": "est sed"
    },
    {
      "error_id": "deserunt ullamco consectetur",
      "field": "cupidatat",
      "message": "culpa magna Ut occaecat eu",
      "parameter": "cupidatat anim ea id"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "dolor cupidatat sunt voluptate",
      "field": "fugiat laborum exercitation magna velit",
      "message": "laborum consequat in",
      "parameter": "sunt sed Ut pariatur"
    },
    {
      "error_id": "fugiat",
      "field": null,
      "message": "aute",
      "parameter": "magna nostrud"
    }
  ]
}

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

Request Payload

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

Response Payload

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

{
  "errors": [
    {
      "error_id": "sint",
      "field": "anim commodo dolor officia do",
      "message": "officia pariatur ut consequat",
      "parameter": "aliquip consectetur minim occaecat"
    },
    {
      "error_id": "eiusmod dolor culpa",
      "field": null,
      "message": "adipisicing Ut ut",
      "parameter": "labore nostrud"
    },
    {
      "error_id": "est Lorem eu ullamco cupidatat",
      "field": "dolore dolor",
      "message": "Duis",
      "parameter": "culpa ut"
    },
    {
      "error_id": "adipisicing cupidatat",
      "field": null,
      "message": "enim",
      "parameter": "esse consectetur deserunt"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "in non",
      "field": "Lorem incididunt ullamco",
      "message": "commodo",
      "parameter": "qui aute"
    },
    {
      "error_id": "id voluptate",
      "field": "enim in est",
      "message": "id sunt",
      "parameter": "nisi aliquip commodo in dolore"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "fugiat in veniam enim",
      "field": null,
      "message": "consequat officia non",
      "parameter": "ex enim aliquip cupidatat"
    },
    {
      "error_id": "dolor exercitation anim in",
      "field": null,
      "message": "mollit reprehenderit sed eu nisi",
      "parameter": "Lorem dolore"
    },
    {
      "error_id": "nisi culpa qui veniam",
      "field": null,
      "message": "voluptate occaecat ut magna",
      "parameter": "cillum"
    },
    {
      "error_id": "adipisicing nostrud in",
      "field": "dolor mollit nisi",
      "message": "incididunt Lorem aute dolore aliqua",
      "parameter": "est"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ipsum nostrud Ut nisi",
      "field": null,
      "message": "non tempor ex nisi",
      "parameter": "sed dolore dolor"
    },
    {
      "error_id": "cillum ea tempor",
      "field": null,
      "message": "fugiat nulla",
      "parameter": "consectetur velit voluptate id proident"
    },
    {
      "error_id": "nisi amet deserunt ea veniam",
      "field": "Lorem",
      "message": "sit",
      "parameter": "mollit ullamco"
    },
    {
      "error_id": "pariatur nostrud incididunt laborum",
      "field": "in in esse anim et",
      "message": "occaecat est officia",
      "parameter": "in ullamco dolor qui consectetur"
    },
    {
      "error_id": "Excepteur dolor nisi",
      "field": null,
      "message": "reprehenderit labore",
      "parameter": "reprehenderit Ut cillum"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "in non",
      "field": "proident amet",
      "message": "in nostrud cillum",
      "parameter": "dolore"
    },
    {
      "error_id": "commodo",
      "field": "reprehenderit",
      "message": "tempor consectetur consequat reprehenderit in",
      "parameter": "sint laborum in esse"
    },
    {
      "error_id": "id Excepteur nisi qui ullamco",
      "field": "voluptate incididunt pariatur amet exercitation",
      "message": "veniam in incididunt labore in",
      "parameter": "non ea elit commodo fugiat"
    },
    {
      "error_id": "non minim veniam cupidatat in",
      "field": "adipisicing nostrud mollit sunt labore",
      "message": "sunt",
      "parameter": "sed"
    },
    {
      "error_id": "amet do",
      "field": "veniam ex",
      "message": "nisi cillum in aliqua",
      "parameter": "dolore voluptate irure"
    }
  ]
}

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

Request Payload

Response Payload

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

{
  "errors": [
    {
      "error_id": "adipisicing reprehenderit commodo",
      "field": "sit",
      "message": "ex",
      "parameter": "nisi occaecat pariatur adipisicing"
    },
    {
      "error_id": "officia",
      "field": "cillum in incididunt sit dolore",
      "message": "minim",
      "parameter": "cillum cupidatat est nostrud"
    },
    {
      "error_id": "magna ut in quis id",
      "field": null,
      "message": "qui veniam",
      "parameter": "cupidatat"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ad mollit Lorem",
      "field": "ut est",
      "message": "ullamco eu in tempor do",
      "parameter": "anim"
    },
    {
      "error_id": "nostrud veniam voluptate in dolor",
      "field": "nulla ullamco sed exercitation",
      "message": "nostrud magna",
      "parameter": "sit labore voluptate esse Excepteur"
    },
    {
      "error_id": "veniam Ut et culpa esse",
      "field": "minim Lorem eu Duis",
      "message": "nostrud",
      "parameter": "tempor irure officia"
    },
    {
      "error_id": "ut dolore sit qui dolore",
      "field": "irure dolor do",
      "message": "adipisicing",
      "parameter": "in enim cupidatat"
    },
    {
      "error_id": "velit qui",
      "field": "Ut anim elit",
      "message": "anim ut qui Excepteur nostrud",
      "parameter": "exercitation tempor"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "qui",
      "field": null,
      "message": "dolore sint ut non eu",
      "parameter": "ex adipisicing"
    },
    {
      "error_id": "ad voluptate ea eu",
      "field": "occaecat laborum eu",
      "message": "veniam in est",
      "parameter": "ullamco irure sed pariatur"
    },
    {
      "error_id": "fugiat nostrud Excepteur labore aute",
      "field": "consectetur veniam",
      "message": "consectetur in do",
      "parameter": "esse labore"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "magna nisi sunt",
      "field": "cupidatat amet commodo",
      "message": "amet",
      "parameter": "cillum mollit dolor"
    },
    {
      "error_id": "ullamco ut",
      "field": "elit ea dolore",
      "message": "enim",
      "parameter": "velit"
    },
    {
      "error_id": "proident",
      "field": "consectetur",
      "message": "dolore incididunt et eiusmod in",
      "parameter": "et ad ipsum"
    },
    {
      "error_id": "aute proident velit",
      "field": "ipsum velit",
      "message": "aliqua",
      "parameter": "occaecat dolore"
    },
    {
      "error_id": "occaecat ex aliqua ipsum Ut",
      "field": null,
      "message": "et Excepteur",
      "parameter": "reprehenderit exercitation laborum"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "do Lorem in tempor",
      "field": null,
      "message": "officia est dolor amet",
      "parameter": "esse Excepteur reprehenderit ut sunt"
    },
    {
      "error_id": "enim pariatur id irure ex",
      "field": "esse mollit",
      "message": "Excepteur",
      "parameter": "magna pariatur consequat dolore"
    },
    {
      "error_id": "in elit",
      "field": "ut cillum",
      "message": "magna elit",
      "parameter": "fugiat"
    }
  ]
}

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`	`"ipsum ullamco proident deserunt eu"`

Request Payload

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

Response Payload

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

{
  "errors": [
    {
      "error_id": "ad eiusmod",
      "field": "mollit et exercitation reprehenderit",
      "message": "non cupidatat",
      "parameter": "quis magna irure"
    },
    {
      "error_id": "officia in pariatur",
      "field": null,
      "message": "proident occaecat eiusmod in officia",
      "parameter": "nisi ut dolore est exercitation"
    },
    {
      "error_id": "consectetur",
      "field": "quis voluptate tempor sed in",
      "message": "proident nulla reprehenderit cillum",
      "parameter": "cillum voluptate"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "Lorem ea magna est",
      "field": null,
      "message": "culpa",
      "parameter": "Lorem aliquip"
    },
    {
      "error_id": "Duis Excepteur est aliqua",
      "field": null,
      "message": "Duis nulla sint laborum labore",
      "parameter": "est"
    },
    {
      "error_id": "fugiat eiusmod qui non ut",
      "field": null,
      "message": "eu et mollit esse",
      "parameter": "dolor ut in"
    },
    {
      "error_id": "adipisicing nostrud incididunt qui labore",
      "field": null,
      "message": "sunt",
      "parameter": "culpa laboris aute ullamco commodo"
    },
    {
      "error_id": "nulla in adipisicing",
      "field": "eiusmod non reprehenderit",
      "message": "id minim",
      "parameter": "minim qui veniam ex"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "mollit ipsum",
      "field": "qui eu",
      "message": "dolore amet cupidatat ut",
      "parameter": "veniam et aliqua non ullamco"
    },
    {
      "error_id": "dolor esse qui",
      "field": "ullamco Duis elit ad",
      "message": "dolor nostrud veniam in Lorem",
      "parameter": "labore tempor do Duis dolor"
    },
    {
      "error_id": "est",
      "field": null,
      "message": "deserunt veniam ut eiusmod in",
      "parameter": "magna et in"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ut Excepteur qui occaecat veniam",
      "field": null,
      "message": "consequat sint nulla",
      "parameter": "quis"
    },
    {
      "error_id": "occaecat",
      "field": "veniam nulla sed deserunt",
      "message": "dolore reprehenderit in",
      "parameter": "sed deserunt est ea"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "consequat magna laboris pariatur do",
      "field": "occaecat nostrud",
      "message": "esse eu deserunt",
      "parameter": "mollit nostrud"
    },
    {
      "error_id": "enim",
      "field": "ut laboris",
      "message": "culpa",
      "parameter": "sit sed proident Ut"
    },
    {
      "error_id": "aliquip et Excepteur in fugiat",
      "field": "ullamco",
      "message": "nulla aliqua",
      "parameter": "sunt dolor ullamco"
    },
    {
      "error_id": "Ut",
      "field": null,
      "message": "aliquip",
      "parameter": "laborum mollit aute"
    },
    {
      "error_id": "amet sint incididunt",
      "field": null,
      "message": "cillum labore consequat in sed",
      "parameter": "est voluptate"
    }
  ]
}

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

Request Payload

Response Payload

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

{
  "errors": [
    {
      "error_id": "sed ut exercitation consectetur",
      "field": null,
      "message": "nisi",
      "parameter": "magna irure"
    },
    {
      "error_id": "culpa quis ad",
      "field": "occaecat et ex",
      "message": "Excepteur aliquip consequat deserunt",
      "parameter": "occaecat esse nisi qui nostrud"
    },
    {
      "error_id": "enim",
      "field": null,
      "message": "quis voluptate consequat",
      "parameter": "ipsum labore"
    },
    {
      "error_id": "aliquip",
      "field": "Excepteur voluptate proident ullamco",
      "message": "fugiat ut Ut",
      "parameter": "nisi"
    },
    {
      "error_id": "irure in consequat",
      "field": "nostrud tempor in laboris",
      "message": "Duis cupidatat in",
      "parameter": "consectetur dolor incididunt"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ad nisi dolor Ut labore",
      "field": null,
      "message": "ut laboris officia ut",
      "parameter": "nulla sint voluptate deserunt exercitation"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "esse eiusmod cillum anim nisi",
      "field": "Excepteur velit",
      "message": "adipisicing dolor ad aliquip",
      "parameter": "ad dolore ut aliquip"
    },
    {
      "error_id": "ea adipisicing",
      "field": "consectetur laborum minim Ut",
      "message": "sit dolor do ea laborum",
      "parameter": "commodo do"
    },
    {
      "error_id": "magna nisi ut ut est",
      "field": null,
      "message": "elit mollit enim",
      "parameter": "veniam"
    },
    {
      "error_id": "mollit sunt",
      "field": null,
      "message": "reprehenderit occaecat",
      "parameter": "aliqua cupidatat aute dolore"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "reprehenderit ad",
      "field": "adipisicing",
      "message": "reprehenderit ea ex",
      "parameter": "sit ipsum laboris"
    },
    {
      "error_id": "adipisicing",
      "field": "ea veniam proident",
      "message": "ut dolor eu",
      "parameter": "consequat occaecat Lorem do"
    },
    {
      "error_id": "dolor labore Ut",
      "field": "labore tempor et",
      "message": "dolor exercitation deserunt",
      "parameter": "nisi voluptate adipisicing"
    },
    {
      "error_id": "laborum sed ullamco",
      "field": null,
      "message": "in",
      "parameter": "dolor in ex irure Duis"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "eu dolor",
      "field": null,
      "message": "do elit",
      "parameter": "pariatur ut ullamco mollit"
    },
    {
      "error_id": "incididunt anim",
      "field": "culpa quis minim laborum aute",
      "message": "commodo",
      "parameter": "est dolore"
    },
    {
      "error_id": "anim",
      "field": "esse",
      "message": "exercitation velit mollit",
      "parameter": "exercitation commodo"
    },
    {
      "error_id": "elit Duis",
      "field": "deserunt ipsum mollit sint Excepteur",
      "message": "ea cupidatat",
      "parameter": "cillum aliquip exercitation Excepteur veniam"
    }
  ]
}

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

Request Payload

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

Response Payload

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

{
  "errors": [
    {
      "error_id": "dolore in proident",
      "field": null,
      "message": "Duis enim in pariatur",
      "parameter": "do magna nisi in pariatur"
    },
    {
      "error_id": "enim consequat sunt incididunt do",
      "field": null,
      "message": "non ex pariatur",
      "parameter": "esse qui minim Ut dolor"
    },
    {
      "error_id": "dolore sit",
      "field": "sunt sed mollit",
      "message": "non in commodo",
      "parameter": "ut"
    },
    {
      "error_id": "amet velit",
      "field": null,
      "message": "dolore Excepteur labore nisi",
      "parameter": "voluptate ea veniam labore"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "cillum Lorem esse quis",
      "field": null,
      "message": "tempor nulla incididunt exercitation",
      "parameter": "ullamco do cillum quis"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "Duis Ut ut eiusmod voluptate",
      "field": "Lorem Ut",
      "message": "tempor ipsum est ut",
      "parameter": "cupidatat cillum do"
    },
    {
      "error_id": "esse consectetur",
      "field": null,
      "message": "aliqua sint consequat consectetur elit",
      "parameter": "id dolore veniam sed"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "pariatur do",
      "field": "ipsum labore culpa",
      "message": "consectetur",
      "parameter": "voluptate enim Duis dolor incididunt"
    },
    {
      "error_id": "exercitation",
      "field": null,
      "message": "Ut tempor",
      "parameter": "cupidatat"
    },
    {
      "error_id": "ullamco minim reprehenderit Excepteur fugiat",
      "field": "et eiusmod",
      "message": "Excepteur",
      "parameter": "ullamco dolore do tempor"
    },
    {
      "error_id": "elit pariatur nisi mollit",
      "field": "amet officia ad minim",
      "message": "ipsum Ut",
      "parameter": "do"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "id esse",
      "field": "Ut dolore nostrud consequat",
      "message": "ad dolore veniam Lorem ex",
      "parameter": "Ut"
    },
    {
      "error_id": "aliquip elit labore sed",
      "field": null,
      "message": "Duis enim",
      "parameter": "do dolor occaecat Lorem"
    },
    {
      "error_id": "exercitation",
      "field": null,
      "message": "reprehenderit",
      "parameter": "occaecat dolore aliqua non"
    }
  ]
}

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

Request Payload

Response Payload

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

{
  "errors": [
    {
      "error_id": "sed et",
      "field": null,
      "message": "in eu nisi qui",
      "parameter": "est sunt ut incididunt elit"
    },
    {
      "error_id": "incididunt quis",
      "field": null,
      "message": "aliqua occaecat ut sed qui",
      "parameter": "exercitation sint consequat consectetur eu"
    },
    {
      "error_id": "laborum tempor aliquip incididunt consequat",
      "field": null,
      "message": "id aliqua",
      "parameter": "et mollit in"
    },
    {
      "error_id": "ut eu Excepteur",
      "field": "qui",
      "message": "Ut",
      "parameter": "nulla aute elit aliquip"
    },
    {
      "error_id": "nostrud nulla",
      "field": null,
      "message": "ullamco",
      "parameter": "reprehenderit amet eu"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "aute do irure",
      "field": "est",
      "message": "do adipisicing dolor",
      "parameter": "ullamco velit ea non"
    },
    {
      "error_id": "amet aliqua",
      "field": null,
      "message": "tempor",
      "parameter": "aliquip qui"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "laboris commodo",
      "field": null,
      "message": "nisi ut et",
      "parameter": "Ut"
    },
    {
      "error_id": "Ut non velit",
      "field": null,
      "message": "sit id nulla commodo",
      "parameter": "ut voluptate"
    },
    {
      "error_id": "quis",
      "field": null,
      "message": "officia",
      "parameter": "labore sed"
    },
    {
      "error_id": "nostrud in laboris sint pariatur",
      "field": null,
      "message": "ipsum",
      "parameter": "id commodo est"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "cupidatat Ut enim deserunt",
      "field": "commodo eu ullamco",
      "message": "et in laboris aliqua eu",
      "parameter": "Ut Lorem ut"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "amet consequat officia elit",
      "field": null,
      "message": "nostrud Excepteur sint ut enim",
      "parameter": "velit officia ad eiusmod"
    },
    {
      "error_id": "ex ea qui dolore",
      "field": "aliqua veniam",
      "message": "Ut",
      "parameter": "reprehenderit laboris enim proident"
    },
    {
      "error_id": "reprehenderit dolore",
      "field": "esse adipisicing sed ut nisi",
      "message": "mollit minim",
      "parameter": "sed Duis"
    }
  ]
}

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

Request Payload

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

Response Payload

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

{
  "errors": [
    {
      "error_id": "voluptate ea",
      "field": "aliqua",
      "message": "ut ad",
      "parameter": "aliquip nisi sunt"
    },
    {
      "error_id": "anim qui officia",
      "field": null,
      "message": "id anim nostrud",
      "parameter": "minim"
    },
    {
      "error_id": "est",
      "field": "irure cillum veniam exercitation Excepteur",
      "message": "in anim in dolore quis",
      "parameter": "eiusmod esse exercitation tempor"
    },
    {
      "error_id": "dolore proident fugiat aliquip",
      "field": "nisi",
      "message": "cillum amet exercitation Ut culpa",
      "parameter": "ad irure tempor esse"
    },
    {
      "error_id": "pariatur dolor ut",
      "field": "consectetur cupidatat in sint",
      "message": "elit occaecat",
      "parameter": "ut"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "laborum commodo aute ipsum irure",
      "field": null,
      "message": "Excepteur",
      "parameter": "enim veniam Lorem magna tempor"
    },
    {
      "error_id": "incididunt tempor",
      "field": null,
      "message": "aliquip eiusmod",
      "parameter": "cupidatat dolor Ut eu"
    },
    {
      "error_id": "labore",
      "field": "do deserunt officia dolore",
      "message": "minim",
      "parameter": "aute anim nisi dolore sint"
    },
    {
      "error_id": "Ut",
      "field": "dolor est aliquip cillum",
      "message": "reprehenderit eu et",
      "parameter": "cillum"
    },
    {
      "error_id": "pariatur proident irure est consequat",
      "field": "ad Excepteur id nisi",
      "message": "amet exercitation",
      "parameter": "voluptate aute"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "in sit exercitation non",
      "field": "culpa officia dolore",
      "message": "adipisicing incididunt labore ut Duis",
      "parameter": "do commodo anim"
    },
    {
      "error_id": "in ut aliquip",
      "field": null,
      "message": "ipsum",
      "parameter": "voluptate dolor sit aliqua"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "dolor non dolor",
      "field": "minim non pariatur",
      "message": "velit Duis ut dolore",
      "parameter": "adipisicing dolore et"
    },
    {
      "error_id": "amet Excepteur id mollit",
      "field": "in ipsum aliqua amet sint",
      "message": "laboris reprehenderit",
      "parameter": "aliquip nisi"
    },
    {
      "error_id": "sunt sit esse nulla",
      "field": null,
      "message": "aliquip",
      "parameter": "exercitation occaecat amet"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "Lorem Excepteur quis culpa",
      "field": "ipsum",
      "message": "anim labore nostrud",
      "parameter": "tempor cillum labore ea reprehenderit"
    }
  ]
}

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

Request Payload

Response Payload

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

{
  "errors": [
    {
      "error_id": "ea Ut non dolore amet",
      "field": null,
      "message": "nisi",
      "parameter": "quis nisi mollit cillum"
    },
    {
      "error_id": "veniam dolore ea id officia",
      "field": "cupidatat laborum enim",
      "message": "dolor dolor",
      "parameter": "irure"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "est non officia laboris mollit",
      "field": "Lorem incididunt laborum in",
      "message": "consectetur dolor tempor in nostrud",
      "parameter": "aliquip"
    },
    {
      "error_id": "tempor Lorem ea occaecat",
      "field": "Duis eu",
      "message": "officia",
      "parameter": "qui aliqua nulla"
    },
    {
      "error_id": "quis nostrud minim",
      "field": null,
      "message": "velit aute ex",
      "parameter": "in in occaecat deserunt voluptate"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "eiusmod pariatur culpa qui",
      "field": "commodo mollit adipisicing aute",
      "message": "ex aliqua sunt esse sed",
      "parameter": "sit"
    },
    {
      "error_id": "Ut",
      "field": null,
      "message": "elit",
      "parameter": "proident anim eu incididunt"
    },
    {
      "error_id": "anim",
      "field": null,
      "message": "dolore et irure sint",
      "parameter": "magna consectetur labore adipisicing nulla"
    },
    {
      "error_id": "dolore",
      "field": null,
      "message": "ipsum exercitation proident veniam sunt",
      "parameter": "dolor anim consectetur velit ullamco"
    },
    {
      "error_id": "consectetur incididunt elit",
      "field": "quis dolor in proident",
      "message": "adipisicing",
      "parameter": "ex"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "ea reprehenderit mollit",
      "field": "eiusmod",
      "message": "non",
      "parameter": "ad"
    },
    {
      "error_id": "dolor proident ex in ad",
      "field": null,
      "message": "anim irure occaecat",
      "parameter": "ut veniam velit Duis in"
    },
    {
      "error_id": "dolor",
      "field": null,
      "message": "dolor consectetur officia ea",
      "parameter": "consectetur labore proident deserunt id"
    },
    {
      "error_id": "elit",
      "field": null,
      "message": "enim dolore in Lorem",
      "parameter": "proident veniam mollit"
    },
    {
      "error_id": "ex consequat aute",
      "field": null,
      "message": "fugiat",
      "parameter": "ex do occaecat"
    }
  ]
}

{
  "errors": [
    {
      "error_id": "nisi mollit",
      "field": "id commodo sed reprehenderit",
      "message": "nisi exercitation",
      "parameter": "anim ut quis"
    },
    {
      "error_id": "ex anim reprehenderit",
      "field": "aute id aliqua",
      "message": "esse laborum",
      "parameter": "irure non in"
    }
  ]
}

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

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`	`"dolore ipsum incididunt eiusmod ullamco"`

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`	`-36550433`
`offset`	`-73691123`

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

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

Request Payload

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

Response Payload

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

{
  "errors": [
    {
      "message": "eiusmod minim",
      "field": "adipisicing ut quis tempor"
    },
    {
      "message": "do occaecat Ut est",
      "field": "dolor"
    },
    {
      "message": "ipsum",
      "field": "anim"
    },
    {
      "message": "proident nulla amet",
      "field": "velit sint occaecat ut"
    }
  ]
}

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`	`80`
`offset`	`72400854`

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

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

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`	`33631393`
`offset`	`-16777931`

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`	`"laborum reprehenderit ipsum ea"`

Request Payload

Response Payload

{
  "result": [
    {
      "email": "user1@example.com",
      "scopes": [
        "user.profile.read",
        "user.profile.edit"
      ],
      "is_admin": false,
      "pending_id": "abcd123abc",
      "expiration_date": 1456424263
    },
    {
      "email": "user2@example.com",
      "scopes": [],
      "is_admin": true,
      "pending_id": "bcde234bcd",
      "expiration_date": 1456424263
    }
  ]
}

GET

/v3/teammates/{username}

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

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

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`	`"amet pariatur quis deserunt"`

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`	`"incididunt officia sed ea"`

Request Payload

Response Payload

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

{
  "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": [
    {
      "message": "tempor veniam velit et",
      "field": "commodo laboris cupidatat eu"
    },
    {
      "message": "Excepteur eu aute",
      "field": "laborum cupidatat labore"
    },
    {
      "message": "proident occaecat",
      "field": "sit dolor"
    },
    {
      "message": "voluptate dolor aute",
      "field": "nostrud in dolore Lorem id"
    },
    {
      "message": "Duis",
      "field": "sed tempor in ea"
    }
  ]
}

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

Request Payload

Response Payload

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

{
  "errors": [
    {
      "message": "do",
      "field": "aliqua sint qui sit"
    },
    {
      "message": "laborum culpa dolore",
      "field": "nisi sed amet"
    }
  ]
}

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`	`"incididunt"`
`on-behalf-of`	`"Lorem ea"`

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": "sunt anim cupidatat",
  "message": "Duis pariatur aliqua"
}

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`	`"ut ea Ut esse"`
`on-behalf-of`	`"reprehenderit"`

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`	`"labore sunt sit"`
`on-behalf-of`	`"sed laborum Excepteur officia"`

Request Payload

Response Payload

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

DELETE

/v3/alerts/{alert_id}

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

Header Name	Example
`on-behalf-of`	`"elit non adipisicing"`

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

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

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

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

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`	`"amet consequat exercitation Lorem"`

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

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

Request Payload

Response Payload

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

PUT

/v3/user/username

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

Header Name	Example
`on-behalf-of`	`"ipsum sed cupidatat aliquip do"`

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

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`	`"nisi veniam"`

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`	`est culpa`
`limit`	`-99306384`
`offset`	`98573756`

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

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`*	`deserunt ut sit minim`
`sort_by_metric`	`dolor`
`sort_by_direction`	`asc`
`limit`	`-75460434`
`offset`	`-89179280`

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`*	`id aliquip`
`subuser`	`consequat officia`
`sort_by_metric`	`unique_opens`
`sort_by_direction`	`desc`
`limit`	`-77249701`
`offset`	`46483490`

Request Payload

Response Payload

{
  "date": "2016-02-01",
  "stats": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 0,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 1,
        "processed": 0,
        "requests": 100,
        "spam_report_drops": 0,
        "spam_reports": 99,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user1",
      "type": "subuser"
    },
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 10,
        "processed": 10,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user2",
      "type": "subuser"
    }
  ]
}

GET

/v3/subusers/stats/sums

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

Query Parameter Name	Example
`sort_by_direction`	`desc`
`start_date`*	`occaecat tempor ad irure ut`
`end_date`	`consequat ullamco laborum enim cupidatat`
`limit`	`-59420610`
`offset`	`-39336462`
`aggregated_by`	`laborum mollit ullamco`
`sort_by_metric`	`exercitation`

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`	`98403229`
`offset`	`-16918299`
`aggregated_by`	`month`
`subusers`*	`anim magna reprehenderit minim`
`start_date`*	`dolor laborum ut`
`end_date`	`officia`

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

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

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

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

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

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

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

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`	`sit non labore`

Header Name	Example
`on-behalf-of`	`"ex amet id et 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"
    }
  }
}

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`*	`esse Duis est Lorem Ut`

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`*	`occaecat in id consequat et`

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`	`"commodo aliquip ut fugiat Ut"`

Request Payload

{
  "ip": "192.168.1.1",
  "subdomain": "email",
  "domain": "example.com"
}

Response Payload

{
  "id": 123,
  "ip": "192.168.1.2",
  "rdns": "o1.email.example.com",
  "users": [],
  "subdomain": "email",
  "domain": "example.com",
  "valid": true,
  "legacy": false,
  "a_record": {
    "valid": true,
    "type": "a",
    "host": "o1.email.example.com",
    "data": "192.168.1.2"
  }
}

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`	`90365301`
`offset`	`36761143`
`ip`	`ad exercitation Ut id nisi`

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

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`	`"eu culpa dolor nostrud"`

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

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

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": "exercitation Duis irure aute dolor",
    "field": "occaecat cupidatat sit dolor"
  }
}

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`	`esse tempor id consequat nulla`
`exclude_whitelabels`	`false`
`limit`	`41259`
`offset`	`-74113230`
`subuser`	`esse ea dolore`
`sort_by_direction`	`desc`

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`	`-93010078`
`offset`	`-62792868`
`exclude_subusers`	`true`
`username`	`est Lorem culpa ullamco in`
`domain`	`aute tempor magna`

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

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

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

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

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`	`"do commodo 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`	`adipisicing`

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

Request Payload

Response Payload

[
  {
    "id": 1,
    "user_id": 7,
    "subdomain": "mail",
    "domain": "example.com",
    "username": "jane@example.com",
    "ips": [
      "192.168.1.1",
      "192.168.1.2"
    ],
    "custom_spf": true,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": true,
    "dns": {
      "mail_cname": {
        "valid": true,
        "type": "cname",
        "host": "mail.example.com",
        "data": "u7.wl.sendgrid.net"
      },
      "dkim1": {
        "valid": true,
        "type": "cname",
        "host": "s1._domainkey.example.com",
        "data": "s1._domainkey.u7.wl.sendgrid.net"
      },
      "dkim2": {
        "valid": true,
        "type": "cname",
        "host": "s2._domainkey.example.com",
        "data": "s2._domainkey.u7.wl.sendgrid.net"
      }
    }
  }
]

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

Request Payload

{
  "ip": "192.168.0.1"
}

Response Payload

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

DELETE

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

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

Header Name	Example
`on-behalf-of`	`"in ea 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`	`"veniam Duis in"`

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`*	`in Duis nulla Ut`

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`	`adipisicing occaecat cillum`

Request Payload

Response Payload

{}

POST

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

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

Request Payload

{
  "username": "jdoe"
}

Response Payload

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

Sender Verification(8 operations)

GET

/v3/verified_senders/domains

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

Request Payload

Response Payload

{
  "results": {
    "soft_failures": [
      "gmail.com"
    ],
    "hard_failures": [
      "yahoo.com"
    ]
  }
}

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

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

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

{
  "errors": [
    {
      "message": "nulla dolor eiusmod dolor in"
    }
  ]
}

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": "sit consequat dolore Ut ut"
    },
    {
      "message": "elit deserunt consectetur"
    }
  ]
}

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": [
    {
      "field": "sit incididunt",
      "message": "cupidatat sunt eu exercitation",
      "error_id": "adipisicing exercitation"
    },
    {
      "field": "proident velit",
      "message": "id",
      "error_id": "minim et quis"
    },
    {
      "field": "id deserunt",
      "message": "reprehenderit esse magna tempor proident",
      "error_id": "nostrud"
    },
    {
      "field": "consectetur Lorem",
      "message": "in deserunt anim",
      "error_id": "labore dolor"
    }
  ]
}

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

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

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

{
  "errors": [
    {
      "message": "sunt ut in dolor"
    }
  ]
}

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`	`65287290.41774005`
`lastSeenID`	`-62573685.58435972`
`id`	`-70245317`

Request Payload

Response Payload

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

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

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

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

{
  "errors": [
    {
      "message": "ut est consequat esse"
    },
    {
      "message": "dolor sit amet labore quis"
    },
    {
      "message": "do proident Excepteur"
    }
  ]
}

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": [
    {
      "message": "tempor in",
      "error_id": "minim velit ex adipisicing tempor"
    },
    {
      "message": "enim deserunt velit",
      "error_id": "amet ad aliquip sed incididunt"
    },
    {
      "message": "aliqua nulla elit",
      "error_id": "mollit ex nisi"
    },
    {
      "message": "fugiat",
      "error_id": "reprehenderit anim adipisicing cupidatat velit"
    }
  ]
}

{
  "errors": [
    {
      "message": "dolor magna fugiat"
    },
    {
      "message": "et consequat enim in"
    },
    {
      "message": "pariatur cillum deserunt 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": [
    {
      "field": "velit",
      "message": "et culpa adipisicing",
      "error_id": "velit amet Duis cupidatat"
    },
    {
      "field": "aliquip tempor qui Ut",
      "message": "aliqua incididunt",
      "error_id": "deserunt irure sint consectetur"
    },
    {
      "field": "ut",
      "message": "deserunt occaecat",
      "error_id": "aute officia"
    },
    {
      "field": "deserunt fugiat esse",
      "message": "eu sunt",
      "error_id": "Lorem minim ipsum ullamco"
    }
  ]
}

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

{
  "errors": [
    {
      "message": "amet adipisicing ullamco enim dolor",
      "error_id": "veniam laboris"
    },
    {
      "message": "deserunt",
      "error_id": "et sunt"
    }
  ]
}

{
  "errors": [
    {
      "message": "adipisicing deserunt voluptate magna laborum",
      "error_id": "in do amet ut exercitation"
    },
    {
      "message": "dolore et",
      "error_id": "sint dolor ut exercitation"
    },
    {
      "message": "Excepteur dolor minim Ut tempor",
      "error_id": "mollit"
    }
  ]
}

{
  "errors": [
    {
      "message": "reprehenderit enim qui voluptate"
    },
    {
      "message": "reprehenderit cupidatat Excepteur anim ut"
    },
    {
      "message": "do"
    }
  ]
}

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": [
    {
      "message": "laborum et",
      "error_id": "ut qui labore cupidatat"
    },
    {
      "message": "anim ut",
      "error_id": "exercitation velit culpa"
    },
    {
      "message": "ut sint id ex ea",
      "error_id": "veniam dolor do"
    },
    {
      "message": "ad Excepteur",
      "error_id": "Duis et dolore mollit"
    }
  ]
}

{
  "errors": [
    {
      "message": "nisi laboris ea cupidatat",
      "error_id": "ut anim est"
    },
    {
      "message": "officia id",
      "error_id": "magna dolore Ut est"
    }
  ]
}

{
  "errors": [
    {
      "message": "dolore qui"
    },
    {
      "message": "aliquip Ut Excepteur"
    },
    {
      "message": "dolore enim"
    }
  ]
}

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": [
    {
      "message": "elit esse cillum incididunt",
      "error_id": "ea et elit fugiat"
    },
    {
      "message": "proident sunt deserunt fugiat",
      "error_id": "incididunt est"
    }
  ]
}

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

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

{
  "errors": [
    {
      "message": "eiusmod",
      "error_id": "veniam aliquip"
    },
    {
      "message": "ex Duis do",
      "error_id": "do anim sit in"
    },
    {
      "message": "anim officia velit ut",
      "error_id": "id Ut ullamco consequat ad"
    }
  ]
}

{
  "errors": [
    {
      "message": "enim commodo laborum culpa"
    },
    {
      "message": "non enim in commodo"
    },
    {
      "message": "consequat cillum est id nostrud"
    },
    {
      "message": "labore elit eu"
    }
  ]
}

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

{
  "message": "dolor nisi proident sit",
  "field": "Excepteur ullamco",
  "error_id": "non dolor id elit ipsum"
}

{
  "errors": [
    {
      "message": "est veniam do velit",
      "field": "amet",
      "error_id": "consequat irure nulla"
    },
    {
      "message": "ad cupidatat",
      "field": "quis enim",
      "error_id": "ullamco ad laboris irure do"
    },
    {
      "message": "Duis labore voluptate exercitation commodo",
      "field": "culpa mollit et Excepteur nostrud",
      "error_id": "ut esse"
    }
  ]
}

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": [
    {
      "message": "est dolore minim dolore",
      "field": "aliquip sed pariatur",
      "error_id": "quis"
    },
    {
      "message": "Duis laboris",
      "field": "dolor elit ad in Excepteur",
      "error_id": "ipsum"
    },
    {
      "message": "ipsum eu et",
      "field": "ipsum cillum sunt cupidatat ut",
      "error_id": "Ut proident dolor occaecat reprehenderit"
    },
    {
      "message": "labore dolore in exercitation",
      "field": "pariatur",
      "error_id": "dolore"
    }
  ]
}

{
  "errors": [
    {
      "message": "fugiat eiusmod culpa sint ex",
      "field": "consequat commodo",
      "error_id": "minim incididunt"
    },
    {
      "message": "nostrud",
      "field": "non dolore dolor ipsum",
      "error_id": "esse eiusmod in ipsum"
    },
    {
      "message": "adipisicing id sunt",
      "field": "elit aute est Ut in",
      "error_id": "ex Duis"
    },
    {
      "message": "consectetur adipisicing ea magna qui",
      "field": "dolor dolore fugiat dolore",
      "error_id": "qui quis proident officia ut"
    }
  ]
}

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": [
    {
      "message": "do aliquip consectetur",
      "field": "exercitation est ex Duis",
      "error_id": "est dolore non Ut velit"
    }
  ]
}

{
  "errors": [
    {
      "message": "ea laboris",
      "field": "esse ea",
      "error_id": "pariatur eu cupidatat non"
    },
    {
      "message": "pariatur laborum esse occaecat",
      "field": "in ad labore exercitation",
      "error_id": "eu Duis nulla voluptate dolore"
    },
    {
      "message": "pariatur et in",
      "field": "aliqua nostrud do consequat velit",
      "error_id": "ipsum"
    },
    {
      "message": "ea Lorem non sint",
      "field": "minim",
      "error_id": "enim aute Lorem"
    },
    {
      "message": "in",
      "field": "veniam elit aliquip do nulla",
      "error_id": "eu aliquip ad"
    }
  ]
}

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": [
    {
      "message": "in ut",
      "field": "ex nisi aliqua",
      "error_id": "laborum officia culpa"
    },
    {
      "message": "sit sunt",
      "field": "elit consectetur officia commodo dolor",
      "error_id": "minim"
    }
  ]
}

{
  "errors": [
    {
      "message": "laboris sit quis culpa fugiat",
      "field": "mollit enim",
      "error_id": "id labore sed"
    },
    {
      "message": "elit in",
      "field": "sint ullamco nisi non ipsum",
      "error_id": "non ipsum ullamco eu fugiat"
    }
  ]
}

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": [
    {
      "message": "tempor reprehenderit Duis",
      "field": "sed",
      "error_id": "anim"
    },
    {
      "message": "minim nulla laborum elit",
      "field": "magna ad nulla minim ipsum",
      "error_id": "cillum do"
    },
    {
      "message": "adipisicing culpa occaecat",
      "field": "ipsum quis ad sit enim",
      "error_id": "id sed ad pariatur"
    },
    {
      "message": "nisi veniam et",
      "field": "ad dolore occaecat eiusmod",
      "error_id": "velit reprehenderit magna proident"
    },
    {
      "message": "ut",
      "field": "reprehenderit deserunt magna",
      "error_id": "amet ut aute"
    }
  ]
}

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`	`22106275`
`page_token`	`amet nostrud minim laboris`
`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": [
    {
      "message": "dolor",
      "field": "dolore consectetur qui cillum fugiat",
      "error_id": "esse elit"
    },
    {
      "message": "occaecat minim consectetur dolore dolor",
      "field": "fugiat minim",
      "error_id": "aliquip minim mollit"
    },
    {
      "message": "laboris labore exercitation",
      "field": "adipisicing nulla",
      "error_id": "deserunt velit ut"
    },
    {
      "message": "cillum in labore pariatur",
      "field": "dolor pariatur sed",
      "error_id": "exercitation velit qui ipsum"
    },
    {
      "message": "ut dolor minim",
      "field": "occaecat commodo nulla cupidatat in",
      "error_id": "consectetur amet dolor"
    }
  ]
}

{
  "errors": [
    {
      "message": "fugiat",
      "field": "magna",
      "error_id": "amet adipisicing"
    },
    {
      "message": "ea in fugiat proident",
      "field": "in ipsum",
      "error_id": "ad"
    }
  ]
}

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": [
    {
      "message": "amet nisi dolore Duis",
      "field": "in eu consequat aliqua minim",
      "error_id": "enim laborum dolor"
    },
    {
      "message": "aliquip",
      "field": "quis eu in dolore irure",
      "error_id": "non irure Lorem ipsum"
    },
    {
      "message": "nulla consequat labore nisi",
      "field": "sint",
      "error_id": "ipsum"
    },
    {
      "message": "occaecat",
      "field": "minim cupidatat consequat",
      "error_id": "consequat"
    }
  ]
}

{
  "errors": [
    {
      "message": "cupidatat aliqua in non reprehenderit",
      "field": "eu",
      "error_id": "Lorem"
    },
    {
      "message": "aute incididunt dolor Lorem",
      "field": "quis",
      "error_id": "aute laborum"
    }
  ]
}

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`	`9170648`
`page_token`	`qui minim enim`
`summary`	`false`

Request Payload

Response Payload

{
  "result": [
    {
      "id": "6ad69134-7165-48cb-964a-6c3cf03e8af8",
      "name": "Off Grid Adventures",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/a85b4b202ff28094828f11ff472360caecf67ead2d186b69b45c904b9251aa0b.png",
      "subject": "Welcome to the family!",
      "created_at": "2019-09-10T02:11:34Z",
      "updated_at": "2021-01-11T21:47:52Z",
      "editor": "design",
      "categories": []
    },
    {
      "id": "b0a9c6f7-a9a1-4b52-b0c5-16fc6f4cdb2b",
      "name": "Song Riddle",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/4ef3a39249f3accb8461b03950c071454a745a232508feca89a626b3e7f578d3.png",
      "subject": "Welcome to Song Riddle!",
      "created_at": "2019-09-10T02:12:32Z",
      "updated_at": "2021-01-11T21:46:43Z",
      "editor": "design",
      "categories": []
    },
    {
      "id": "f8d8da76-bcca-4cfe-b809-733887855f57",
      "name": "Ingrid & Anders 1",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/15c97ffa97ee31693581a67526728d096eef00adfbaa34bb030d91034d477da4.png",
      "subject": "Welcome to Ingrid & Anders!",
      "created_at": "2019-09-10T02:10:38Z",
      "updated_at": "2021-01-11T21:45:05Z",
      "editor": "design",
      "categories": []
    },
    {
      "id": "2935a7d0-7f02-4e0f-a570-dc302ce09749",
      "name": "Ingrid & Anders 2",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/7b36a6c0955cab0c350d105114ad248700a685bd11032592cdef85ae26540afc.png",
      "subject": "Check out these exclusive deals!",
      "created_at": "2019-09-10T02:09:31Z",
      "updated_at": "2021-01-11T21:44:08Z",
      "editor": "design",
      "categories": []
    },
    {
      "id": "7826ef14-7ba6-4dbc-91f0-a8c610ebe962",
      "name": "Ingrid & Anders 3",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/6dd8dd73a1a62bd7a76c4313b52d7c749250d49e31b19cce718906655fcbc675.png",
      "subject": "Join our VIP club and save big!",
      "created_at": "2019-09-10T02:08:29Z",
      "updated_at": "2021-01-11T21:41:35Z",
      "editor": "design",
      "categories": []
    },
    {
      "id": "41da47e7-d3e2-491b-a83f-f499a4139d6a",
      "name": "Mercado",
      "generate_plain_content": true,
      "thumbnail_url": "//us-east-2-production-thumbnail-bucket.s3.amazonaws.com/9cc87cc7671719712d9d363184995d0ec05103355db300ff03641fe9e205651d.png",
      "subject": "Subject",
      "created_at": "2019-09-10T02:03:06Z",
      "updated_at": "2021-01-11T21:39:23Z",
      "editor": "design",
      "categories": []
    }
  ],
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/designs/pre-builts?page_token=yYzyCxj-iIVgP54t6NjKkunDCKYLLpngo-5vAsfYXz0To34U",
    "count": 6
  }
}

Contacts(13 operations)

PUT

/v3/marketing/contacts

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

Request Payload

{
  "list_ids": [
    "3289b96b-5d83-7632-20f6-5e4ef7dc3c78",
    "6c4ba073-e33b-d4b7-8045-c0ae9be604ca",
    "bf974a4d-8798-4572-40ed-0d72499f1d8b",
    "1ad8349a-9787-f377-54f6-1a5c5db3d651",
    "7f6dcc03-9b6f-ac5d-1709-3b802ec9d36d"
  ],
  "contacts": [
    {
      "address_line_1": "pariatur dolor",
      "address_line_2": "labore incididunt in commodo",
      "alternate_emails": [
        "non ut Lorem magna consequat",
        "consectetur",
        "proident",
        "mollit fugiat consectetur dolore do",
        "sed incididunt"
      ],
      "city": "tempor adipisi",
      "country": "ut",
      "email": "eiusmod",
      "first_name": "l",
      "last_name": "veniam",
      "postal_code": "irure velit aliqua ad",
      "state_province_region": "mollit",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "aliqu",
      "address_line_2": "ullamco est cupidatat culpa elit",
      "alternate_emails": [
        "ut sit dolor",
        "voluptate officia ex",
        "adipisicing",
        "quis",
        "exercitation est sunt"
      ],
      "city": "est sit enim in",
      "country": "anim veniam fugiat exercitation id",
      "email": "cupidatat mollit reprehenderit",
      "first_name": "ex",
      "last_name": "in minim deserunt laboris Duis",
      "postal_code": "nulla culpa Lorem",
      "state_province_region": "exerc",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "Excepteur",
      "address_line_2": "adipisicing",
      "alternate_emails": [
        "eu fugiat ut",
        "reprehenderit ut velit dolore",
        "ex dolor minim ea",
        "exercitation dolore",
        "ea magna veniam quis"
      ],
      "city": "adipisicing dolore eiusmo",
      "country": "tempor nostrud non",
      "email": "exercitation",
      "first_name": "quis",
      "last_name": "deserunt laborum eiusmod d",
      "postal_code": "dolore consectetur",
      "state_province_region": "quis nostrud",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "labore qui amet",
      "address_line_2": "Duis magna exercitation",
      "alternate_emails": [
        "Lorem reprehe",
        "velit",
        "consectetur",
        "nulla adipisicing reprehenderit est",
        "dolor nostrud deserunt tempor consectetur"
      ],
      "city": "qui sunt tempo",
      "country": "laborum",
      "email": "ut",
      "first_name": "qui",
      "last_name": "reprehenderit ad i",
      "postal_code": "ut tempor",
      "state_province_region": "ullamco labore veniam",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "veniam ea",
      "address_line_2": "sed adipisicing voluptate",
      "alternate_emails": [
        "esse",
        "occaecat proident minim cupidatat",
        "culpa veniam nostrud Duis cillum",
        "commodo",
        "adipisicing occaecat"
      ],
      "city": "aute amet ipsum",
      "country": "magna mollit dolore",
      "email": "adipisicing ullamco magna",
      "first_name": "nisi ",
      "last_name": "dolo",
      "postal_code": "et non pariatur in reprehenderit",
      "state_province_region": "sint culpa ex incididunt nu",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "tempor consectetur Ut sit",
      "address_line_2": "esse ullamco",
      "alternate_emails": [
        "in incididunt adipisicing labore",
        "aliquip pariatur cupidatat fugiat veniam",
        "mollit",
        "reprehenderit",
        "deserunt"
      ],
      "city": "qui",
      "country": "dolore vol",
      "email": "aute Duis officia in",
      "first_name": "l",
      "last_name": "ut laborum",
      "postal_code": "ipsum do",
      "state_province_region": "ut sunt",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "t",
      "address_line_2": "adipisicing cupidatat amet",
      "alternate_emails": [
        "sint exercitation",
        "laboris pariatur aliquip ipsum nisi",
        "laborum",
        "ipsum aliqua laborum reprehenderit voluptate",
        "elit consequat"
      ],
      "city": "velit tempor ad occaecat",
      "country": "exercitation",
      "email": "veniam commodo",
      "first_name": "aliquip ut in",
      "last_name": "id dolor pariatur",
      "postal_code": "in fugiat",
      "state_province_region": "in aliqua irure",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "ex",
      "address_line_2": "incididunt",
      "alternate_emails": [
        "ullamco e",
        "deserunt ",
        "Lorem commodo irure ex laborum",
        "enim elit ut aliquip sint",
        "in"
      ],
      "city": "reprehenderit cupidatat sed non",
      "country": "et Duis voluptate amet conse",
      "email": "culpa Excepteur",
      "first_name": "ea",
      "last_name": "consectetur consequat Duis q",
      "postal_code": "dolore velit magna esse dolore",
      "state_province_region": "incididunt mollit",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "laboris conseq",
      "address_line_2": "tempor eiusmod occaecat",
      "alternate_emails": [
        "ullamco",
        "Excepteur culpa tempor",
        "commodo pariatur incididunt mollit",
        "nulla",
        "nostrud sunt"
      ],
      "city": "sint et",
      "country": "nisi aliquip officia",
      "email": "magna",
      "first_name": "id ad",
      "last_name": "Ut cillum mi",
      "postal_code": "veniam",
      "state_province_region": "Ut",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    },
    {
      "address_line_1": "",
      "address_line_2": "do sed eu deserunt",
      "alternate_emails": [
        "cupidatat ut sit consectetur",
        "consectetur Lorem officia laborum esse",
        "aute est",
        "proident",
        "eiusmod in sunt dolore"
      ],
      "city": "sed non anim",
      "country": "amet aliquip do",
      "email": "esse aliquip",
      "first_name": "magna ",
      "last_name": "enim id irur",
      "postal_code": "anim nulla",
      "state_province_region": "in quis deserunt nulla",
      "custom_fields": {
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5,
        "e2": "Coffee is a beverage that puts one to sleep when not drank."
      }
    }
  ]
}

Response Payload

{
  "job_id": "consectetur in Ut occaecat"
}

{
  "errors": [
    {
      "message": "nostrud anim reprehenderit velit dolore",
      "field": "officia irure",
      "error_id": "laborum ullamco",
      "parameter": "in Ut fugiat ex"
    }
  ]
}

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

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

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

{
  "errors": [
    {
      "message": "minim eiusmod nostrud"
    },
    {
      "message": "ea pariatur"
    }
  ]
}

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`	`quis est dolore tempor`
`ids`	`cillum dolore`

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": "laborum"
    },
    {
      "message": "quis sed veniam laboris fugiat"
    },
    {
      "message": "quis ea dolor"
    }
  ]
}

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

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

{
  "errors": [
    {
      "message": "et velit",
      "field": "Lorem",
      "error_id": "exercitation incididunt",
      "parameter": "do laborum ullamco cupidatat"
    }
  ]
}

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

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

{}

{
  "errors": [
    {
      "message": "dolor et ad"
    },
    {
      "message": "occaecat"
    },
    {
      "message": "cupidatat tempor sed cillum"
    }
  ]
}

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

{
  "contact_count": -89790974,
  "billable_count": 12499422,
  "billable_breakdown": {
    "total": -37869970,
    "breakdown": {}
  }
}

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

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

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

{
  "errors": [
    {
      "message": "ex"
    },
    {
      "message": "Excepteur ipsum"
    },
    {
      "message": "adipisicing Ut in ad"
    },
    {
      "message": "culpa adipisicing"
    }
  ]
}

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

{
  "list_ids": [
    "9e2f8c48-6310-4e4a-31d0-5bd28c8156c7",
    "d23898c4-b441-6688-2798-3873db75fb61"
  ],
  "segment_ids": [
    "nostrud ut dolore sunt"
  ],
  "notifications": {
    "email": true
  },
  "file_type": "csv",
  "max_file_size": 87329606
}

Response Payload

{
  "_metadata": {
    "prev": "https://bSiUbkbhgbCoJUKG.zovF0v3EACNdjqTReOHuphJPxV0byPEP1JUuNFJi",
    "self": "http://acTLuOLTxT.yoijpUGNInEGKi-a5GGoB7os9bNdWfCvDhfhMhVvBNQ-ATQkxrNsZnyJoF1oTSqOA.+c5I6wQk",
    "next": "http://nYqmsVptjhfgQOc.spvclyh2kUr-JwFRaYRbtCJ7tUPXrM2f8YtYTY,KJ",
    "count": 99873071.297481
  },
  "id": "tempor dolore ad"
}

{
  "errors": [
    {
      "message": "in labore deserunt do",
      "field": "nulla deserunt in dolore",
      "error_id": "nisi exercitation non est",
      "parameter": "irure exercitation et occaecat sunt"
    },
    {
      "message": "sed aliquip",
      "field": "culpa",
      "error_id": "ipsum eiusmod amet",
      "parameter": "pariatur quis reprehenderit sint"
    },
    {
      "message": "ut",
      "field": "est elit dolor in",
      "error_id": "in sunt adipisicing enim",
      "parameter": "sint in Excepteur"
    },
    {
      "message": "voluptate elit non cillum",
      "field": "culpa incididunt ut amet",
      "error_id": "quis ipsum adipisicing",
      "parameter": "labore dolor exercitation"
    }
  ]
}

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

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

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

{
  "errors": [
    {
      "message": "ullamco consectetur"
    },
    {
      "message": "culpa voluptate amet Lorem pariatur"
    },
    {
      "message": "consequat in esse"
    },
    {
      "message": "aute incididunt fugiat nulla et"
    }
  ]
}

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

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

{
  "errors": [
    {
      "message": "occaecat enim laboris in",
      "": "dolor voluptate in",
      "error_id": "veniam voluptate"
    },
    {
      "message": "amet proident est et aliqua",
      "": "consectetur nostrud",
      "error_id": "esse"
    },
    {
      "message": "culpa id qui enim",
      "": "ipsum in est ullamco",
      "error_id": "ex quis cupidatat"
    },
    {
      "message": "Ut velit",
      "": "culpa exercitation cillum commodo qui",
      "error_id": "in eu dolor nisi culpa"
    }
  ]
}

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

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

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

{
  "errors": [
    {
      "message": "ullamco culpa 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

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

{
  "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": "nostrud et"
    }
  ]
}

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

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

{
  "errors": [
    {
      "field": "tempor fugiat eu ullamco dolor",
      "message": "dolore ad in"
    },
    {
      "field": "elit sint deserunt",
      "message": "magna Ut"
    },
    {
      "field": "Excepteur qui ut sint laboris",
      "message": "ipsum dolore elit est"
    },
    {
      "field": "laboris elit",
      "message": "voluptate ea sint velit"
    }
  ]
}

{
  "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": "incididunt quis sed nostrud deserunt"
    },
    {
      "message": "non nisi est Lorem ipsum"
    },
    {
      "message": "dolor adipisicing anim do tempor"
    }
  ]
}

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

{
  "list_ids": [
    "eu cupidatat",
    "Ut aute deserunt",
    "enim cillum aliqua occaecat nulla"
  ],
  "file_type": "csv",
  "field_mappings": [
    "non eu magna",
    "sit",
    null,
    null,
    null
  ]
}

Response Payload

{
  "job_id": "Excepteur do amet non",
  "upload_uri": "esse ut sint veniam",
  "upload_headers": [
    {
      "header": "elit et incididunt",
      "value": "cillum in esse"
    },
    {
      "header": "sed fugiat",
      "value": "est incididunt Lorem fugiat ex"
    }
  ]
}

{
  "errors": [
    {
      "message": "ea sint dolor",
      "field": "commodo ea",
      "error_id": "veniam consequat Duis",
      "parameter": "ipsum laborum do sint"
    },
    {
      "message": "fugiat laborum sint",
      "field": "ad aliqua ex in",
      "error_id": "sit Ut Duis aliquip",
      "parameter": "sunt ullamco irure magna in"
    },
    {
      "message": "dolore id",
      "field": "voluptate commodo ullamco esse",
      "error_id": "anim enim esse non",
      "parameter": "eu"
    },
    {
      "message": "elit in",
      "field": "reprehenderit sed officia",
      "error_id": "dolore aliqua",
      "parameter": "nostrud deserunt incididunt ut"
    }
  ]
}

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

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

{
  "errors": [
    {
      "message": "proident enim sit id pariatur",
      "field": "Lorem",
      "error_id": "culpa ipsum eiusmod elit sunt",
      "parameter": "adipisicing qui officia et non"
    },
    {
      "message": "dolor",
      "field": "mollit quis tempor Ut",
      "error_id": "in ut adipisicing dolor",
      "parameter": "dolor dolore ea sed"
    },
    {
      "message": "Lorem",
      "field": "ut sint",
      "error_id": "sunt",
      "parameter": "non pariatur minim"
    },
    {
      "message": "ut minim",
      "field": "consequat qui",
      "error_id": "sunt occaecat amet proident commodo",
      "parameter": "irure ipsum mollit"
    }
  ]
}

{
  "errors": [
    {
      "message": "dolor non"
    },
    {
      "message": "exercitation"
    },
    {
      "message": "Excepteur consequat et"
    },
    {
      "message": "anim ut mollit eiusmod"
    },
    {
      "message": "ut labore"
    }
  ]
}

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

{
  "id": "minim veniam Lorem",
  "status": "in",
  "job_type": "cillum",
  "results": {
    "requested_count": 68373397.37555715,
    "created_count": -76222359.22937551,
    "updated_count": 10933953.903939828,
    "deleted_count": -87318336.62225564,
    "errored_count": -39095978.4213567,
    "errors_url": "aute"
  },
  "started_at": "velit sit eu",
  "finished_at": "non proident sit cupidatat nisi"
}

{
  "errors": {
    "message": "ut exercitation non aute anim",
    "field": "dolore commodo aliqua",
    "error_id": "ex ea sit",
    "parameter": "amet"
  }
}

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

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

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

{
  "errors": [
    {
      "message": "laboris Excepteur esse"
    },
    {
      "message": "consequat veniam voluptate Duis"
    }
  ]
}

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

{
  "id": "Excepteur quis nisi occaecat dolore",
  "status": "pending",
  "created_at": "nulla et",
  "updated_at": "anim dolore sed enim",
  "completed_at": "voluptate occaecat dolor nulla fugiat",
  "expires_at": "enim cupidatat elit do dolore",
  "urls": [
    "nostrud cupidatat",
    "incididunt ipsum aliqua voluptate",
    "occaecat est"
  ],
  "message": "fugiat Excepteur in",
  "_metadata": {
    "prev": "https://rDnrTuBeiQOLRP.xhf",
    "self": "http://HKaLJW.xcrfsWkDufHIGha8s.N,ijLCIlFmaS1zCgRRMBZ9teExp3fC1cpggHu-X2Zz",
    "next": "https://aZeaIwRaJ.avozRX1kK-,MRhpg",
    "count": 72650449.1709843
  },
  "contact_count": 31442465
}

{
  "errors": [
    {
      "message": "aliquip proident sunt labore",
      "field": "et aliquip",
      "error_id": "ullamco consectetur",
      "parameter": "aliqua irure"
    },
    {
      "message": "amet culpa",
      "field": "in ut cupidatat",
      "error_id": "nulla incididunt proident",
      "parameter": "mollit"
    },
    {
      "message": "commodo exercitation irure ut",
      "field": "laboris Lorem incididunt cillum",
      "error_id": "nulla",
      "parameter": "nisi occaecat irure"
    },
    {
      "message": "in sed esse magna",
      "field": "est aute id",
      "error_id": "aliquip officia veniam commodo",
      "parameter": "exercitation"
    },
    {
      "message": "incididunt pariatur",
      "field": "laboris cupidatat",
      "error_id": "aliqua est velit",
      "parameter": "laborum"
    }
  ]
}

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

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

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

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

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

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

{}

{
  "errors": [
    {
      "message": "laboris veniam"
    },
    {
      "message": "eiusmod qui velit amet in"
    },
    {
      "message": "mollit cupidatat consequat nulla"
    }
  ]
}

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": "ut do Excepteur sunt nisi"
    }
  ]
}

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": "mollit nisi",
  "parent_list_ids": [
    "tempor eu enim esse sunt"
  ],
  "query_dsl": "cillum nisi"
}

Response Payload

{
  "id": "c4c22347-8c8d-08d0-72e5-0bf701a05b03",
  "name": "aliquip sint ea deserunt irure",
  "query_dsl": "ad",
  "contacts_count": 90902701,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "proident dolor tempor cupidatat",
  "updated_at": "veniam ad magna pariatur voluptate",
  "sample_updated_at": "amet occaecat ea",
  "next_sample_update": "dolor ipsum",
  "parent_list_ids": [
    "ut exercitation quis reprehenderit aute",
    "Lorem"
  ],
  "query_version": "qui cillum",
  "status": {
    "query_validation": "Lorem eiusmod veniam velit et",
    "error_message": "laborum voluptate"
  }
}

{
  "errors": [
    {
      "field": "ullamco Excepteur",
      "message": "mollit eiusmod nisi"
    }
  ]
}

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": "in deserunt",
      "message": "incididunt ut mollit irure"
    },
    {
      "field": "dolor culpa commodo",
      "message": "Lorem"
    },
    {
      "field": "minim ad nisi",
      "message": "enim ullamco"
    }
  ]
}

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`	`sit`
`no_parent_list_id`	`true`

Request Payload

Response Payload

{
  "id": "2342d81f-8c18-54bb-d55e-f0e13175ce2f",
  "name": "in",
  "contacts_count": 7165649,
  "created_at": "sunt laborum cillum do",
  "updated_at": "Excepteur ut dolor aliquip",
  "sample_updated_at": "sit sed",
  "next_sample_update": "dolore magna cillum mollit ex",
  "parent_list_ids": [
    "nulla consectetur",
    "proident dolore in",
    "in quis",
    "quis ea incididunt officia",
    "labore"
  ],
  "query_version": "ut",
  "_metadata": {
    "prev": "https://xaTGEHgvA.rpTGkqBgS5r5nIo3ngYTWV0fDHJdDeGXxQQ3",
    "self": "https://KhgCtvzziUtHiUzpwCPCquXe.cflqrj2pHIkQE2zHUX7QJNIoAPgcG37xYfwEA1ZBzCGZ3giREN",
    "next": "https://aAlgTHcpbO.hkfE.JXuxD70lYIEIY2EFSpY",
    "count": 99939796
  },
  "status": {
    "query_validation": "ut",
    "error_message": "labore sint qui sunt"
  }
}

{
  "errors": [
    {
      "field": "et irure",
      "message": "dolor aute deserunt in"
    }
  ]
}

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

{
  "errors": [
    {
      "field": "in id",
      "message": "qui sit nisi Duis"
    },
    {
      "field": "proident",
      "message": "Excepteur ut"
    }
  ]
}

PATCH

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

Request Payload

{
  "name": "sed sint exercitation",
  "query_dsl": "dolor exercitation anim ea"
}

Response Payload

{
  "id": "20878551-1070-9597-32ea-40ba997c182e",
  "name": "dolore cupidatat irure exercitation",
  "query_dsl": "pariatur nulla incididunt",
  "contacts_count": 10868056,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "esse velit sit",
  "updated_at": "sit in sint veniam",
  "sample_updated_at": "deserunt",
  "next_sample_update": "irure commodo dolore",
  "parent_list_ids": [
    "incididunt ea ut tempor",
    "aute nisi minim Duis",
    "ullamco proident exercitation do"
  ],
  "query_version": "incididunt do",
  "status": {
    "query_validation": "aliqua non elit mollit in",
    "error_message": "reprehenderit enim labore aliquip"
  }
}

{
  "errors": [
    {
      "field": "do occaecat aliqua mollit",
      "message": "do sed ad"
    },
    {
      "field": "consequat qui dolore",
      "message": "ad incididunt occaecat"
    }
  ]
}

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

{
  "errors": [
    {
      "field": "mollit",
      "message": "fugiat"
    },
    {
      "field": "sint cupidatat",
      "message": "et"
    },
    {
      "field": "consectetur",
      "message": "labore"
    },
    {
      "field": "ullamco aute laboris dolor",
      "message": "aute labore nostrud"
    }
  ]
}

GET

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

Query Parameter Name	Example
`contacts_sample`	`true`

Request Payload

Response Payload

{
  "id": "6c6f0248-4b21-6bea-0b07-619a17f40a79",
  "name": "aliquip amet ven",
  "query_dsl": "Duis non",
  "contacts_count": -45558872,
  "contacts_sample": [
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    },
    {
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "email": "abcd@gmail.com",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "first_name": "Ab",
      "last_name": "Cd",
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "city": "Redwood City",
      "state_province_region": "CA",
      "postal_code": 94063,
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      }
    }
  ],
  "created_at": "incididunt elit exercitation in",
  "updated_at": "reprehenderit eu labore velit",
  "sample_updated_at": "cillum",
  "next_sample_update": "ex est",
  "parent_list_ids": [
    "officia",
    "reprehenderit do",
    "fugiat veniam",
    "ut in culpa quis magna",
    "aliqua"
  ],
  "query_version": "anim dolor pariatur",
  "status": {
    "query_validation": "Ut",
    "error_message": "exercitation aliqua"
  }
}

{
  "errors": [
    {
      "field": "ullamco non ut",
      "message": "Duis mollit cillum laborum"
    },
    {
      "field": "dolor reprehenderit",
      "message": "elit sed"
    },
    {
      "field": "laboris",
      "message": "labore et velit"
    },
    {
      "field": "qui",
      "message": "id consectetur ut pariatur cupidatat"
    }
  ]
}

{
  "errors": [
    {
      "field": "sed quis nisi dolor",
      "message": "in eu"
    },
    {
      "field": "anim",
      "message": "laboris ut"
    }
  ]
}

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": "incididunt dolore commodo enim",
      "message": "eiusmod"
    },
    {
      "field": "eu ullamco in nulla",
      "message": "Ut nostrud"
    },
    {
      "field": "in deserunt Excepteur commodo elit",
      "message": "amet"
    },
    {
      "field": "ea veniam dolor",
      "message": "dolor dolore nostrud voluptate"
    }
  ]
}

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

{
  "errors": [
    {
      "field": "nulla mollit labore",
      "message": "reprehenderit laboris"
    },
    {
      "field": "amet et Duis sunt labore",
      "message": "Ut deserunt veniam"
    },
    {
      "field": "sunt",
      "message": "officia culpa"
    }
  ]
}

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

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": "exercitation consequat magna"
    }
  ]
}

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": [
    {
      "message": "aliquip quis veniam dolor do",
      "field": "culpa ea magna laborum",
      "error_id": "do eu",
      "parameter": "culpa ut voluptate fugiat aute"
    },
    {
      "message": "nisi do",
      "field": "in",
      "error_id": "qui laboris Excepteur voluptate non",
      "parameter": "minim"
    },
    {
      "message": "dolor nulla",
      "field": "eu mollit tempor occaecat quis",
      "error_id": "dolor officia",
      "parameter": "amet consequat sit"
    },
    {
      "message": "in",
      "field": "sed ut",
      "error_id": "ut",
      "parameter": "dolore pariatur dolor"
    },
    {
      "message": "cupidatat dolore",
      "field": "labore eu",
      "error_id": "quis Duis dolor Excepteur incididunt",
      "parameter": "ea eu"
    }
  ]
}

GET

/v3/marketing/lists

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

Query Parameter Name	Example
`page_size`	`136.2808223781986`
`page_token`	`est eiusmod aliquip non laboris`

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

Request Payload

Response Payload

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

[
  {
    "message": "nisi veniam",
    "field": "exercitation dolor",
    "error_id": "do",
    "parameter": "et dolore in enim"
  },
  {
    "message": "veniam nostrud velit dolor est",
    "field": "minim ex",
    "error_id": "consequat est sed sint",
    "parameter": "sint consequat cillum"
  },
  {
    "message": "in est reprehenderit",
    "field": "commodo dolor non pariatur laboris",
    "error_id": "nisi et dolor incididunt cillum",
    "parameter": "pariatur laboris adipisicing cillum elit"
  },
  {
    "message": "commodo minim",
    "field": "ad dolore aliquip exercitation",
    "error_id": "sunt",
    "parameter": "ullamco dolore"
  },
  {
    "message": "occaecat sed officia nulla",
    "field": "dolore",
    "error_id": "elit laboris non pariatur commodo",
    "parameter": "nostrud occaecat irure ut"
  }
]

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": [
    {
      "message": "et",
      "field": "in nisi Excepteur consectetur dolore",
      "error_id": "aliquip est Lorem laboris reprehenderit",
      "parameter": "pariatur"
    }
  ]
}

{}

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

adipisicing

{
  "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`*	`reprehenderit do quis proident dolore`

Request Payload

Response Payload

{
  "job_id": "aliquip"
}

{
  "message": "labore",
  "field": "pariatur sit deserunt elit labore",
  "error_id": "ut",
  "parameter": "esse amet anim tempor"
}

{
  "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": [
    {
      "message": "Excepteur laboris mollit et sit",
      "field": "quis exercitation veniam fugiat in",
      "error_id": "culpa",
      "parameter": "commodo minim"
    },
    {
      "message": "aute deserunt adipisicing sunt",
      "field": "in ipsum commodo Duis",
      "error_id": "eu",
      "parameter": "nulla tempor proident"
    }
  ]
}

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": [
    {
      "message": "irure ut proident enim velit",
      "field": "sunt",
      "error_id": "esse laboris consectetur",
      "parameter": "culpa"
    },
    {
      "message": "dolore adipisicing do occaecat cillum",
      "field": "cupidatat dolore aute elit",
      "error_id": "non pariatur in",
      "parameter": "nostrud aute occaecat"
    },
    {
      "message": "in magna amet tempor consequat",
      "field": "laborum pariatur",
      "error_id": "aliquip nisi",
      "parameter": "qui"
    },
    {
      "message": "ad commodo velit consequat mollit",
      "field": "est labore",
      "error_id": "ut consectetur qui",
      "parameter": "fugiat enim Lorem veniam"
    }
  ]
}

{
  "errors": [
    {
      "message": "et adipisicing tempor do ut",
      "field": "dolor adipisicing proident laboris nostrud",
      "error_id": "ullamco velit",
      "parameter": "dolor consectetur ut"
    },
    {
      "message": "proident minim Excepteur",
      "field": "elit voluptate minim id",
      "error_id": "sed",
      "parameter": "in nulla sunt dolor non"
    },
    {
      "message": "dolore dolor sunt ea cillum",
      "field": "culpa laboris ut magna",
      "error_id": "voluptate enim ut qui",
      "parameter": "qui est commodo dolore pariatur"
    },
    {
      "message": "ut veniam",
      "field": "nostrud id et adipisicing",
      "error_id": "anim aliquip reprehenderit ipsum",
      "parameter": "ad est laborum eu proident"
    }
  ]
}

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": [
    {
      "message": "Duis est occaecat dolore quis",
      "field": "consequat",
      "error_id": "minim dolore",
      "parameter": "esse"
    },
    {
      "message": "in minim amet sed qui",
      "field": "dolor ea ipsum ad",
      "error_id": "enim eiusmod laborum",
      "parameter": "dolore"
    },
    {
      "message": "aliqua adipisicing cillum ea Duis",
      "field": "reprehenderit ad sit consequat eiusmod",
      "error_id": "qui",
      "parameter": "qui Lorem ad"
    }
  ]
}

segmenting contacts(5 operations)

POST

/v3/marketing/segments

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

Request Payload

{
  "name": "in ad",
  "parent_list_ids": [
    "reprehenderit Ut sit Excepteur",
    "tempor",
    "aliquip in dolor laborum ut",
    "pariatur"
  ],
  "query_dsl": "nostrud",
  "parent_list_id": "e9be6112-2789-3bb2-8aa8-3992cff8f7af"
}

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": "mollit irure commodo non incididunt"
    },
    {
      "message": "consectetur incididunt et mollit in"
    },
    {
      "message": "veniam anim"
    }
  ]
}

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`	`eu laboris`
`no_parent_list_id`	`false`

Request Payload

Response Payload

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

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

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

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

{
  "errors": [
    {
      "message": "ut mollit aliquip cupidatat"
    }
  ]
}

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": [
    {
      "message": "officia dolor sunt",
      "field": "aute dolore"
    },
    {
      "message": "labore in commodo do in",
      "field": "esse culpa Ut nulla"
    },
    {
      "message": "deserunt esse commodo",
      "field": "sit consequat velit minim"
    },
    {
      "message": "eiusmod fugiat enim in reprehenderit",
      "field": "consectetur sunt"
    },
    {
      "message": "in Lorem dolore",
      "field": "ut"
    }
  ]
}

{
  "errors": [
    {
      "message": "reprehenderit"
    },
    {
      "message": "consectetur consequat deserunt"
    }
  ]
}

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": "amet",
  "parent_list_ids": [
    "culpa",
    "laborum dolore consequat ad"
  ],
  "query_dsl": "Duis ipsum in Lorem et"
}

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": [
    {
      "message": "laborum fugiat mollit",
      "field": "ipsum"
    },
    {
      "message": "magna ullamco dolor",
      "field": "aliqua dolore incididunt commodo ut"
    },
    {
      "message": "ut dolore",
      "field": "consequat"
    },
    {
      "message": "sunt dolor",
      "field": "irure aliquip in consequat"
    },
    {
      "message": "Excepteur",
      "field": "eu Ut"
    }
  ]
}

{
  "errors": [
    {
      "message": "ipsum minim irure officia"
    },
    {
      "message": "laborum ad eiusmod in"
    },
    {
      "message": "esse aute"
    }
  ]
}

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": [
    {
      "message": "nostrud reprehenderit in eu ad",
      "field": "laborum"
    }
  ]
}

{
  "errors": [
    {
      "message": "reprehenderit et est deserunt elit"
    },
    {
      "message": "reprehenderit Excepteur amet exercitation"
    },
    {
      "message": "aliqua qui commodo tempor do"
    }
  ]
}

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": [
    {
      "id": "Ut ipsum sunt",
      "error": "deserunt ut cillum sit sint",
      "resources": {
        "type": "laboris",
        "ids": [
          "ea",
          "consequat enim cupidatat",
          "occaecat",
          "sed id exercitation"
        ]
      }
    },
    {
      "id": "ex irure occaecat",
      "error": "anim",
      "resources": {
        "type": "nostrud nulla ea dolore",
        "ids": [
          "labore"
        ]
      }
    },
    {
      "id": "in sunt dolor eu",
      "error": "do eu ipsum",
      "resources": {
        "type": "dolor in",
        "ids": [
          "ullamco enim eiusmod elit",
          "nulla dolor et id in",
          "elit aliqua tempor magna",
          "dolore sit esse ad in"
        ]
      }
    }
  ]
}

{}

{
  "errors": [
    {
      "field": "nulla",
      "message": "cupidatat deserunt voluptate"
    }
  ]
}

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

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

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

{
  "errors": [
    {
      "message": "in officia"
    },
    {
      "message": "magna"
    },
    {
      "message": "esse sint cillum"
    },
    {
      "message": "proident in"
    },
    {
      "message": "dolor adipisicing pariatur occaecat qui"
    }
  ]
}

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": [
    {
      "field": "veniam quis ea culpa",
      "message": "occaecat sunt",
      "error_id": "occaecat ut"
    },
    {
      "field": "irure pariatur occaecat reprehenderit adipisicing",
      "message": "quis anim nisi veniam",
      "error_id": "Lorem in Excepteur dolore elit"
    },
    {
      "field": "aute",
      "message": "velit est sint et ex",
      "error_id": "ea dolore"
    },
    {
      "field": "Lorem quis consectetur adipisicing",
      "message": "in eu ea irure exercitation",
      "error_id": "eu proident esse in"
    }
  ]
}

{
  "errors": [
    {
      "field": "dolore velit proident anim",
      "message": "anim dolor ex",
      "error_id": "ut sint"
    },
    {
      "field": "magna ex ullamco cupidatat",
      "message": "consectetur velit",
      "error_id": "aute"
    },
    {
      "field": "ea aute anim",
      "message": "ut elit Ut",
      "error_id": "cillum ut in proident"
    }
  ]
}

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`	`-53446734`
`page_token`	`do exercitation sit`

Request Payload

Response Payload

{
  "result": [
    {
      "id": "7a484db2-c58a-39c2-571f-70fe544a85df",
      "name": "exercitation consequat reprehenderit in",
      "abtest": {
        "type": "subject",
        "winner_criteria": "manual",
        "test_percentage": 23185523,
        "duration": "cupidatat Ut deserunt nisi nulla",
        "winning_template_id": "consectetur aute elit pariatur nisi",
        "winner_selected_at": "sint",
        "expiration_date": null
      },
      "status": "scheduled",
      "categories": [
        "Lorem in ea ut",
        "reprehenderit do laborum",
        "fugiat",
        "exercitation ea eu est",
        "exercitation do qui",
        "mollit",
        "do non",
        "sed magna cupidatat eiusmod exercitation",
        "dolor deserunt irure",
        "laborum eu"
      ],
      "send_at": "1915-12-03T01:53:59.0Z",
      "is_abtest": true,
      "updated_at": "1935-06-05T06:55:41.0Z",
      "created_at": "1929-10-12T12:07:04.0Z"
    }
  ],
  "_metadata": {
    "prev": "http://CObpQwviIZtbwyXAHYEry.leesV4d.,UoE3zihOGR6A6ZR711p.tFVrRxjpubVQjox-N",
    "self": "https://shzOxqtmeWTknKU.smZUhQTHxo6uBvdfJU9qc3CV+vqNSCS1QrrpwkW-KlJD85C0i",
    "next": "https://EbPGoecjlEYQzKnAchjlOWjjfZpieR.kcC3cZPZiIT.lKZB6ESD9orGLvrEVyhtKHQcUUGmTQxGNLEebl3R8",
    "count": 57994174
  }
}

{
  "errors": [
    {
      "field": "irure culpa aliquip",
      "message": "velit ad amet nostrud",
      "error_id": "in non"
    },
    {
      "field": "culpa Excepteur",
      "message": "aliqua officia proident culpa",
      "error_id": "ut"
    },
    {
      "field": "aute enim",
      "message": "aliqua eu elit",
      "error_id": "ex"
    },
    {
      "field": "in mollit aute",
      "message": "labore Ut dolore",
      "error_id": "cupidatat aliqua mollit"
    },
    {
      "field": "aute ullamco incididunt Ut",
      "message": "fugiat ipsum irure",
      "error_id": "ut"
    }
  ]
}

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`	`["nisi irure","cupidatat sunt enim aute","dolore","consequat dolore","anim","aliquip sunt nisi adipisicing tempor","fugiat nostrud dolor","dolore","eu","ipsum eu"]`

Request Payload

Response Payload

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

{
  "errors": [
    {
      "field": "laborum dolor",
      "message": "enim dolor dolore nisi ut",
      "error_id": "id cillum eiusmod laborum dolor"
    },
    {
      "field": "non exercitation",
      "message": "quis amet magna ad aliqua",
      "error_id": "irure aliqua commodo"
    },
    {
      "field": "do ut voluptate eiusmod",
      "message": "dolor nostrud quis amet",
      "error_id": "voluptate aliquip fugiat laboris"
    },
    {
      "field": "dolor amet adipisicing cupidatat",
      "message": "commodo in sed laboris fugiat",
      "error_id": "Lorem"
    },
    {
      "field": "sunt exercitation",
      "message": "dolore eiusmod adipisicing qui dolore",
      "error_id": "ad voluptate"
    }
  ]
}

{
  "errors": [
    {
      "field": "aliquip veniam elit",
      "message": "irure ex in",
      "error_id": "do non quis in"
    },
    {
      "field": "cupidatat",
      "message": "sed dolor proident magna consectetur",
      "error_id": "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": "aute cons"
}

Response Payload

{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}

{
  "errors": [
    {
      "field": "do eiusmod",
      "message": "nulla cupidatat sint laboris occaecat",
      "error_id": "in est ad pariatur"
    },
    {
      "field": "Excepteur est",
      "message": "aliqua dolor",
      "error_id": "aliqua ad culpa in labore"
    },
    {
      "field": "velit cillum",
      "message": "incididunt",
      "error_id": "in amet"
    },
    {
      "field": "velit",
      "message": "pariatur ad reprehenderit labore",
      "error_id": "et consequat"
    }
  ]
}

{
  "errors": [
    {
      "field": "in velit",
      "message": "in Lorem quis",
      "error_id": "dolore dolore"
    },
    {
      "field": "nulla",
      "message": "sunt adipisicing commodo",
      "error_id": "deserunt ut nostrud esse"
    },
    {
      "field": "sint et reprehenderit",
      "message": "laboris Excepteur Duis fugiat",
      "error_id": "reprehenderit in sunt"
    },
    {
      "field": "consectetur aliqua proident magna labore",
      "message": "sint exercitation reprehenderit et",
      "error_id": "sint dolore"
    }
  ]
}

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

{
  "name": "exercitation dolore mollit est",
  "categories": [
    "Duis",
    "ipsum tempor labore dolore",
    "eiusmod",
    "aliquip quis laboris Excepteur ipsum",
    "velit deserunt pariatur",
    "proident magna esse tempor mollit",
    "eu voluptate proident irure enim",
    "nisi officia ut",
    "dolore cupidatat dolor incididunt enim",
    "laborum ad ut"
  ],
  "send_at": "1951-03-12T09:25:32.0Z",
  "send_to": {
    "list_ids": [
      "1caa30ec-78d0-bee4-5ec5-ceadb31db347",
      "4d547c38-3e09-aeb7-3e4d-3222d03b9b30",
      "b3b6e3e0-3e84-5ed9-240f-d3ace8da1177",
      "9189f077-c5e0-0a1c-acd5-866b889ce42b",
      "664e27db-14b6-02dc-0a3d-a6edef68fbe9",
      "610c0e2f-b5e0-a0b7-3671-22b8d24a1c2a",
      "6638c5e7-84c8-051d-09e9-92a3ce52b43e",
      "d54199a8-b7e3-9305-38fc-3fbc5b97ccea",
      "e8d01a85-7522-f0af-7904-5b72f891c8b6",
      "022f3ebc-bebf-7f2e-9ced-69719ee6a1c9"
    ],
    "segment_ids": [
      "e21b44fc-d8aa-1c2e-73d7-3918ee115121",
      "15275768-9d8b-5c50-81db-e7984a24f8b5",
      "140247e3-855c-0850-f7a6-9b1a1ba21f63",
      "cd1e6a6f-dfeb-2ac6-8b65-5f2ab532da9b",
      "63c8d542-b1f6-2c19-d46f-266ed825ae66",
      "d317accc-3b11-8b11-3355-366f0cbeb44e",
      "38937af6-29bf-390b-5e96-a2c895543d36",
      "03a702eb-64c8-1707-db8d-8f85606118cd",
      "358f8181-0823-8959-fd04-2ec1c26fcfae",
      "6909fb6f-62a9-9070-2c9b-59b30f136a07"
    ],
    "all": false
  },
  "email_config": {
    "subject": "in Ut",
    "html_content": "aute sint",
    "plain_content": "aliquip mollit Ut",
    "generate_plain_content": false,
    "design_id": "ullamco adipisicing consequat",
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": "https://IsjnscwHM.vpd3Q8E2HAHJiYwSeYQ9qPb-cvoDmNDz7Agjq7sX3hgiEFtbcG8jacEx7MYfp",
    "sender_id": null,
    "ip_pool": "irure ex deserunt tempor culpa"
  }
}

Response Payload

{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}

{
  "errors": [
    {
      "field": "veniam",
      "message": "dolor culpa sint do cupidatat",
      "error_id": "minim nostrud id sunt aliquip"
    },
    {
      "field": "cillum nostrud fugiat",
      "message": "voluptate",
      "error_id": "fugiat magna adipisicing"
    },
    {
      "field": "qui veniam adipisicing in laborum",
      "message": "labore ut ut laboris",
      "error_id": "cillum consectetur est"
    }
  ]
}

{
  "errors": [
    {
      "field": "Excepteur",
      "message": "amet in consequat irure",
      "error_id": "exercitation irure in ut enim"
    }
  ]
}

{
  "errors": [
    {
      "field": "labore",
      "message": "anim minim elit Duis",
      "error_id": "reprehenderit nulla do"
    }
  ]
}

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": [
    {
      "field": "dolor do ex",
      "message": "est aliqua",
      "error_id": "eu Duis"
    },
    {
      "field": "quis minim ut",
      "message": "aliqua dolor",
      "error_id": "labore"
    },
    {
      "field": "veniam pariatur incididunt",
      "message": "eiusmod ea elit",
      "error_id": "anim"
    },
    {
      "field": "in sit voluptate deserunt tempor",
      "message": "irure id aliquip",
      "error_id": "commodo in"
    }
  ]
}

{
  "errors": [
    {
      "field": "officia ea",
      "message": "esse do irure",
      "error_id": "commodo"
    },
    {
      "field": "nisi enim commodo Duis",
      "message": "laborum consequat amet enim tempor",
      "error_id": "cupidatat eiusmod veniam enim"
    },
    {
      "field": "officia Excepteur ex et culpa",
      "message": "pariatur cupidatat",
      "error_id": "Lorem"
    }
  ]
}

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": [
    {
      "field": "dolore dolore cupidatat anim",
      "message": "eiusmod",
      "error_id": "cupidatat deserunt est Ut"
    },
    {
      "field": "in velit ullamco",
      "message": "ut sit voluptate eiusmod",
      "error_id": "aute sint eiusmod"
    },
    {
      "field": "cillum enim elit irure",
      "message": "ipsum",
      "error_id": "laborum ad aliqua voluptate"
    },
    {
      "field": "qui est quis officia elit",
      "message": "non amet dolor ut",
      "error_id": "aute in veniam"
    }
  ]
}

{
  "errors": [
    {
      "field": "dolor",
      "message": "sit est et labore ex",
      "error_id": "ex eiusmod Ut"
    },
    {
      "field": "in laboris sit",
      "message": "nulla reprehenderit",
      "error_id": "ut"
    },
    {
      "field": "elit Duis",
      "message": "incididunt irure consequat aliquip",
      "error_id": "laboris"
    },
    {
      "field": "cupidatat Duis ad",
      "message": "in dolor magna est fugiat",
      "error_id": "incididunt dolor deserunt"
    }
  ]
}

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`	`81786917`
`page_token`	`esse`

Request Payload

{
  "name": "specific-single-send-name",
  "status": [
    "draft",
    "scheduled"
  ],
  "categories": [
    "shoes"
  ]
}

Response Payload

{
  "result": [
    {
      "id": "df25ffdf-6a96-458a-9419-6d87d3094c6b",
      "name": "single-send-1",
      "status": "triggered",
      "categories": [
        "shoes"
      ],
      "is_abtest": true,
      "updated_at": "3263-04-09T09:05:08.193Z",
      "created_at": "4739-10-29T07:11:32.476Z",
      "send_at": "2471-05-31T15:46:18.797Z"
    }
  ],
  "_metadata": {
    "self": "nwNSrPSWt7d",
    "prev": "P0Enoayd",
    "next": "DYEsTUDww9-",
    "count": 1
  }
}

{
  "errors": [
    {
      "field": "reprehenderit qui incididunt cupidatat",
      "message": "sint proident",
      "error_id": "nisi"
    },
    {
      "field": "mollit incididunt consectetur voluptate",
      "message": "eu commodo labore sunt velit",
      "error_id": "ut adipisicing"
    },
    {
      "field": "et pariatur id Duis aliquip",
      "message": "consequat eu aliquip esse commodo",
      "error_id": "sint culpa"
    }
  ]
}

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": [
    {
      "field": "laborum sit culpa",
      "message": "aute cupidatat in do",
      "error_id": "ea incididunt"
    },
    {
      "field": "adipisicing ad",
      "message": "consectetur id",
      "error_id": "elit aliquip"
    },
    {
      "field": "do",
      "message": "quis id adipisicing",
      "error_id": "Ut pariatur deserunt eu"
    },
    {
      "field": "veniam magna",
      "message": "mollit",
      "error_id": "aliqua"
    },
    {
      "field": "eu ea",
      "message": "magna consectetur proident",
      "error_id": "ad elit pariatur sed"
    }
  ]
}

{
  "errors": [
    {
      "field": "commodo dolor sed",
      "message": "exercitation enim aliqua do",
      "error_id": "ipsum"
    },
    {
      "field": "est velit consequat",
      "message": "ut in",
      "error_id": "esse non qui est voluptate"
    },
    {
      "field": "anim laboris",
      "message": "eu dolor Duis nisi",
      "error_id": "sed do sit proident"
    },
    {
      "field": "aute eu",
      "message": "officia magna in laboris",
      "error_id": "aliquip ullamco reprehenderit laboris"
    }
  ]
}

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": "1966-09-13T16:42:32.0Z",
  "status": "scheduled"
}

{
  "errors": [
    {
      "field": "cillum irure Duis labore dolore",
      "message": "fugiat irure ad et",
      "error_id": "anim dolore dolor commodo in"
    },
    {
      "field": "incididunt mollit minim",
      "message": "exercitation",
      "error_id": "id laboris pariatur laborum"
    },
    {
      "field": "Excepteur",
      "message": "exercitation aute Ut dolore in",
      "error_id": "ad Ut anim minim"
    },
    {
      "field": "ex",
      "message": "dolor dolor nostrud nulla",
      "error_id": "cillum cupidatat aute veniam non"
    }
  ]
}

{
  "errors": [
    {
      "field": "culpa qui",
      "message": "in pariatur",
      "error_id": "sit esse mollit Ut"
    },
    {
      "field": "laboris",
      "message": "consectetur veniam amet do laborum",
      "error_id": "exercitation dolor amet sunt"
    },
    {
      "field": "cupidatat",
      "message": "sed ut anim mollit",
      "error_id": "et aliqua exercitation officia"
    },
    {
      "field": "aute commodo",
      "message": "Excepteur magna tempor do non",
      "error_id": "veniam eiusmod sint ut dolore"
    }
  ]
}

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": [
    {
      "field": "cillum",
      "message": "mollit ut",
      "error_id": "consectetur"
    },
    {
      "field": "mollit do adipisicing",
      "message": "mollit sunt consectetur ullamco",
      "error_id": "cillum amet ex tempor"
    },
    {
      "field": "in do Lorem consequat",
      "message": "incididunt dolore cillum",
      "error_id": "est in ea"
    }
  ]
}

Send Test Email

POST

/v3/marketing/test/send_email

**This endpoint allows you to send a test marketing email to a list of email addresses**. Before sending a marketing message, you can test it using this endpoint. You may specify up to **10 contacts** in the `emails` request body field. You must also specify a `template_id` and include either a `f

Request Payload

{
  "template_id": "f8f77db8-b9fa-4b3c-9ee8-de3d582016b8",
  "version_id_override": "7734f757-8eb8-4d22-b7f0-779a72f32986",
  "sender_id": 6060664,
  "custom_unsubscribe_url": "https://example.com/unsubscribe",
  "suppression_group_id": 21865513,
  "emails": [
    "janedoe@example.com",
    "tiramisu@example.com",
    "bundt@example.com"
  ]
}

Response Payload

{}

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

Marketing Campaigns Stats(8 operations)

GET

/v3/marketing/stats/automations

**This endpoint allows you to retrieve stats for all your Automations.** By default, all of your Automations will be returned, but you can specify a selection by passing in a comma-separated list of Automation IDs as the value of the query string parameter `automation_ids`. Responses are paginate

Query Parameter Name	Example
`automation_ids`	`["incididunt id","Duis et","Ut nisi proident","id Ut ut sed adipisicing","amet nisi est in esse","incididunt dolor enim sunt","aute dolore proident officia","quis dolor dolore do incididunt","minim enim labore","occaecat"]`
`page_size`	`31`
`page_token`	`nostrud aliqua`

Request Payload

Response Payload

{
  "results": [
    {
      "id": "b015832a-22b7-aa4d-8dcd-a81d91befe7c",
      "aggregation": "labore ad Excepteur ex",
      "step_id": "culpa aliqua ex",
      "stats": {
        "bounce_drops": -81378807,
        "bounces": 80683151,
        "clicks": -96339656,
        "delivered": 17323600,
        "invalid_emails": -83739722,
        "opens": 27898434,
        "requests": 27829339,
        "spam_report_drops": -95618558,
        "spam_reports": -38858492,
        "unique_clicks": 72292974,
        "unique_opens": -90338836,
        "unsubscribes": 64977170
      }
    },
    {
      "id": "fd7dc922-b416-15b4-9abb-35e86957461f",
      "aggregation": "officia nostrud ex aute sit",
      "step_id": "elit minim",
      "stats": {
        "bounce_drops": -56374565,
        "bounces": -56231011,
        "clicks": -42529505,
        "delivered": -97688140,
        "invalid_emails": -67407211,
        "opens": 9713026,
        "requests": 49234345,
        "spam_report_drops": -79037663,
        "spam_reports": 71510995,
        "unique_clicks": 34432255,
        "unique_opens": 93420470,
        "unsubscribes": 10540935
      }
    },
    {
      "id": "3ed3cbe0-64db-70a5-7241-07ec937ae01d",
      "aggregation": "sed",
      "step_id": "in ullamco id elit Ut",
      "stats": {
        "bounce_drops": -92053948,
        "bounces": 95512604,
        "clicks": -69535760,
        "delivered": -39917432,
        "invalid_emails": -1326058,
        "opens": 41293991,
        "requests": 34430704,
        "spam_report_drops": 95146844,
        "spam_reports": -58931056,
        "unique_clicks": -96772676,
        "unique_opens": -6235903,
        "unsubscribes": -70289985
      }
    },
    {
      "id": "243b56a7-f958-dd97-086b-dda5567c6479",
      "aggregation": "dolore",
      "step_id": "anim laborum ea",
      "stats": {
        "bounce_drops": 54196677,
        "bounces": -44955016,
        "clicks": -10725881,
        "delivered": -18827669,
        "invalid_emails": -47948853,
        "opens": -84655757,
        "requests": -67850770,
        "spam_report_drops": 48320139,
        "spam_reports": -97186051,
        "unique_clicks": -88046249,
        "unique_opens": 81820700,
        "unsubscribes": 90093544
      }
    }
  ],
  "_metadata": {
    "prev": "http://xlpUlIO.blhhQ6znV0CUt+dSiTiQD0gpPbwuqgcAJAn3nKgnwHYhhj5ke8TngkN",
    "self": "http://BpDTmfkPKWRWnReuZkcpcZbNYWWbjbdt.whnRToYbNFpPpvqFjR-WdB1oqpthrUkoobU5BsO",
    "next": "http://sKt.xoja3xyQm3XRBXYiQu",
    "count": -24514111.027198777
  }
}

{
  "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_id"]`
`step_ids`	`["e4bedd2c-887e-8339-cc62-0a7c0cea71f7","c27c914b-10f1-4f6f-30ba-e1282e5b981f","2630b438-af9c-83f4-5bfb-55f4c75b419a","32a83a16-aba0-0bd3-eb0e-0e22d4b62fa4"]`
`aggregated_by`	`day`
`start_date`	`1967-05-14`
`end_date`	`1962-12-15`
`timezone`	`ea aliqua`
`page_size`	`5`
`page_token`	`Duis eu esse adipisicing Lorem`

Request Payload

Response Payload

{
  "results": [
    {
      "id": "901d0448-8995-e000-4a9c-cf1eb7fbbe33",
      "aggregation": "cupidatat adipisicing eiusmod",
      "step_id": "ut ullamco ut",
      "stats": {
        "bounce_drops": -57313239,
        "bounces": 94593171,
        "clicks": -13233003,
        "delivered": 48597435,
        "invalid_emails": -53363898,
        "opens": -12774183,
        "requests": -5666443,
        "spam_report_drops": -98682259,
        "spam_reports": -938176,
        "unique_clicks": -96955646,
        "unique_opens": 96072329,
        "unsubscribes": -58100348
      }
    },
    {
      "id": "60d9e467-bafc-ecae-1533-43c8f05b705e",
      "aggregation": "incididunt ullamco velit amet consectetur",
      "step_id": "cupidatat ex ullamco reprehenderit",
      "stats": {
        "bounce_drops": 30823886,
        "bounces": 66660752,
        "clicks": 62362975,
        "delivered": -31838601,
        "invalid_emails": -71945245,
        "opens": -6819892,
        "requests": -86480421,
        "spam_report_drops": 16218208,
        "spam_reports": -75926695,
        "unique_clicks": 58520252,
        "unique_opens": 647648,
        "unsubscribes": -48563360
      }
    },
    {
      "id": "c5167426-bc27-362b-dbc3-ccc2f791d91f",
      "aggregation": "dolor eu consectetur ad ipsum",
      "step_id": "consectetur",
      "stats": {
        "bounce_drops": -70765622,
        "bounces": 30400614,
        "clicks": -39822273,
        "delivered": -4111300,
        "invalid_emails": 54893946,
        "opens": 751549,
        "requests": -23156044,
        "spam_report_drops": -26577383,
        "spam_reports": 17793433,
        "unique_clicks": 75933508,
        "unique_opens": 55330603,
        "unsubscribes": -86816068
      }
    },
    {
      "id": "56a1dabf-951e-2ba5-4e4f-1a7ee55e1ff4",
      "aggregation": "ullamco sint reprehenderit mollit laboris",
      "step_id": "Ut eiusmod labore",
      "stats": {
        "bounce_drops": 16632213,
        "bounces": 83374637,
        "clicks": 1032114,
        "delivered": 2728126,
        "invalid_emails": 35182326,
        "opens": 76842757,
        "requests": -3448028,
        "spam_report_drops": 70429570,
        "spam_reports": -67319142,
        "unique_clicks": 72685032,
        "unique_opens": 22438822,
        "unsubscribes": 63698830
      }
    },
    {
      "id": "b4d84e8e-2cc3-3b10-9f68-045d74a454cc",
      "aggregation": "commodo tempor ea sint ex",
      "step_id": "non elit id",
      "stats": {
        "bounce_drops": -58270599,
        "bounces": 89240295,
        "clicks": -2002723,
        "delivered": 14316562,
        "invalid_emails": 96365669,
        "opens": 81821621,
        "requests": -51813527,
        "spam_report_drops": -64515377,
        "spam_reports": 27584236,
        "unique_clicks": -2574898,
        "unique_opens": -92425494,
        "unsubscribes": -7836246
      }
    }
  ],
  "_metadata": {
    "prev": "https://SjgqgvhHJuUjUKTNsGU.oeidklrFEHhUH837QNsvCY3,APJn.USv7jf2r9uKe+kxy2",
    "self": "https://QRLB.qnqhnnwdPnVKnQdYrjukw9RtMB-lfofG4hxHnVrlSYT2nx+tifKG",
    "next": "http://AnWA.ftcyt.,AnETMqZJ-b3VSToVmbCQxXWhFFsOUPjpaD9w,EZKMn89Ry5",
    "count": 39792116.67552498
  }
}

{
  "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`	`["Excepteur dolore nostrud","nulla enim ad","laboris id velit","exercitation","dolor ut nisi mollit","nostrud cupidatat occaecat veniam quis","occaecat","tempor","ad","Duis incididunt"]`
`page_size`	`31`
`page_token`	`consequat`

Request Payload

Response Payload

{
  "results": [
    {
      "id": "a0b642c7-5ea6-48fc-a618-2b0140c86e73",
      "ab_variation": "8dd62770-fbdf-ce5f-8cb1-5b828efc71f1",
      "ab_phase": "test",
      "aggregation": "id esse",
      "stats": {
        "bounce_drops": 22959040,
        "bounces": 70817923,
        "clicks": 9796996,
        "delivered": -34494400,
        "invalid_emails": -42268334,
        "opens": -27855509,
        "requests": 17920673,
        "spam_report_drops": -25057350,
        "spam_reports": 41785395,
        "unique_clicks": -45682843,
        "unique_opens": 60845333,
        "unsubscribes": -12521627
      }
    },
    {
      "id": "c076dbee-ae4c-4e9b-61b9-97a04e929d43",
      "ab_variation": "ec89bcd1-56ee-bd5e-9837-891b9741be94",
      "ab_phase": "send",
      "aggregation": "enim",
      "stats": {
        "bounce_drops": 44398676,
        "bounces": -99133787,
        "clicks": 71314583,
        "delivered": -66333391,
        "invalid_emails": 29468926,
        "opens": -92377913,
        "requests": 87382514,
        "spam_report_drops": -18428885,
        "spam_reports": -27307228,
        "unique_clicks": 19837062,
        "unique_opens": -65422180,
        "unsubscribes": 66374645
      }
    }
  ],
  "_metadata": {
    "prev": "http://LCGZkYCDAgWgisVwtZyxTxu.isosCWjILAJ4UZ0NsIrxPemBcVkzy7blu.,jK,q4-h8.IgZ",
    "self": "http://kkVVfxDAsFxxHiHOzVPRKODda.qqzbxF4PAtsKdRtq0uwOHWKg9Pzx-hImH5OFd",
    "next": "https://RfDecJaitAR.bxsYXpVSL3gdWUOlc4KZFY0q4VuFtMwmn",
    "count": 34205207.090994745
  }
}

{
  "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`	`1930-05-23`
`end_date`	`1959-05-15`
`timezone`	`mollit dolore`
`page_size`	`34`
`page_token`	`pariatur aute cupidatat ut`
`group_by`	`["ab_phase","ab_phase","ab_variation","ab_variation","ab_variation"]`

Request Payload

Response Payload

{
  "results": [
    {
      "id": "8031ff43-89c9-dc1f-1f5d-8316afb15c90",
      "ab_variation": "baf59e12-620d-68c8-33a0-916613b2df51",
      "ab_phase": "all",
      "aggregation": "in fugiat ex",
      "stats": {
        "bounce_drops": -50704471,
        "bounces": -78067710,
        "clicks": 90361615,
        "delivered": -57905725,
        "invalid_emails": -41810643,
        "opens": -1452851,
        "requests": 88484163,
        "spam_report_drops": -97069728,
        "spam_reports": 5401122,
        "unique_clicks": 54088694,
        "unique_opens": -5816216,
        "unsubscribes": 36143639
      }
    },
    {
      "id": "e80b3e28-e48d-c7b5-d761-03032ab779e3",
      "ab_variation": "b3f38e74-d5b0-a756-3302-22c3c586ce1f",
      "ab_phase": "test",
      "aggregation": "cillum",
      "stats": {
        "bounce_drops": -3223114,
        "bounces": -1123615,
        "clicks": 96706605,
        "delivered": -43556957,
        "invalid_emails": 49216773,
        "opens": -46003993,
        "requests": 3466403,
        "spam_report_drops": -36129128,
        "spam_reports": 907357,
        "unique_clicks": -29554330,
        "unique_opens": -68322398,
        "unsubscribes": 16222427
      }
    }
  ],
  "_metadata": {
    "prev": "https://aBNKPWzQSNNUT.oul2Ivy2Whpbea8inNWYSB2uqvVIWeJmQ9hcQpM",
    "self": "https://ppI.xsrndYSuNIcGwYYNf",
    "next": "https://mnrWyXfkyAsRbjgjJtRjtnWTDneeHzQZN.hmpfMbTiXh3XqR1u9SzKjlDtrok.m",
    "count": 8779725.469833806
  }
}

{
  "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_ids`	`["d600aaa9-01e8-0323-3373-f0778036f181","1236b5c1-4dd2-22f4-a0e7-15061f12458e","c45d8375-7313-6052-c5a7-f3834734fe3c","2b09a9f5-6ab7-5a21-8e11-23e0034d0105"]`
`page_size`	`4`
`page_token`	`non consequat veniam Excepteur minim`

Request Payload

Response Payload

{
  "results": [
    {
      "url": "https://orYTzvTwmTjndIVgqVhqLeMtIpwVkmAIr.hmztYZBc0BeOWN",
      "url_location": 64817273,
      "step_id": "73766535-43a6-4b02-9f88-f5eba833da64",
      "clicks": 63006038
    },
    {
      "url": "http://aNXxDSeUyfbXmU.iwbbG7m7U",
      "url_location": 56144538,
      "step_id": "83ae12f8-a608-de89-1cfa-cbc115d0e5d6",
      "clicks": 25034094
    },
    {
      "url": "https://Tw.xtKPTPXo-1,",
      "url_location": 51075373,
      "step_id": "35fb42f3-11b6-32ff-f8e9-7b332723b906",
      "clicks": 19819336
    },
    {
      "url": "https://dAfMnAMUDYFkyeeoCelYEpiaVnlsktAmM.nikK1X4K0TjzBwfDAcpUGErRNxHeEJJ2yGePK",
      "url_location": 77601135,
      "step_id": "60e2c150-16c3-2df0-7613-1f25cd750414",
      "clicks": 44140330
    }
  ],
  "total_clicks": -69921515,
  "_metadata": {
    "prev": "http://VzvO.psviolpEe4Q",
    "self": "http://IUWKbAbgvguQkVQykjCpmsHGKYed.hji75yDca1qu0DSNV-TqYJKsjNDg+GaoCvBSaXLv06-I",
    "next": "http://vO.rmxtefR-kk2NEc6I,oD9zuPkByG6f8Xz2XauTWb1yk1v2BlSTZzwvOn",
    "count": 85668200.23124602
  }
}

{
  "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`	`32`
`page_token`	`qui culpa magna est ut`
`group_by`	`["ab_phase","ab_phase","ab_variation","ab_variation"]`
`ab_variation_id`	`05f5565d-5db8-9c88-c9e4-b19c35e8e5d8`
`ab_phase_id`	`test`

Request Payload

Response Payload

{
  "results": [
    {
      "url": "https://GeQLxrrYKMvOiV.batpjtGvXA9UrrF9ZqRpq1Tlc3Avc6PldXiQ,uLkgAHlacZFzqXxG-",
      "url_location": 9709544,
      "ab_variation": "9e289aa1-63ac-8ad3-1fa1-9c15130d9a33",
      "ab_phase": "all",
      "clicks": 60596472
    },
    {
      "url": "http://vTLuRpSLFD.wrsoZM.pUWnLJeK-g1vHukHlR7KkV87HfhN5yChXI81QxnvixERKvPh",
      "url_location": 56449553,
      "ab_variation": "6f519173-044d-08ee-2663-584f837f67e4",
      "ab_phase": "test",
      "clicks": 62357573
    },
    {
      "url": "https://ldhAGBGZuPHnZmOZEnJnAtjPoYi.kfMoodt8w",
      "url_location": 68019533,
      "ab_variation": "0fb5ec3e-afc7-59fa-7e52-9f44cc866f9d",
      "ab_phase": "test",
      "clicks": 52632012
    },
    {
      "url": "http://JAeStJtPWmmAtQLegvjgieyWWLDzcbX.gqRR8tk0tZKIK9VB,HAFriyhhsNmUY+y4z.",
      "url_location": 59678358,
      "ab_variation": "9d817edf-0eb2-f8dd-274a-19a875d10cdd",
      "ab_phase": "send",
      "clicks": 83130791
    }
  ],
  "_metadata": {
    "prev": "http://iYxCcLnhVxwvMJlIJPqrUlKUcrHCKB.vkwye8YJWQwIXj9Y6jwE",
    "self": "https://emFNwEGtBmGKlBPxk.vlD9CVjnBtT7zdL4zFl9CcEBaYZ06",
    "next": "http://azfPfmwATzLVa.kpPo2OPAG69-ZXEsdfFfqfekkg",
    "count": -27276786.688244224
  },
  "total_clicks": 45584595
}

{
  "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`	`["ut eu","ut mollit","pariatur reprehenderit nulla","ut in dolor enim elit","nulla tempor mollit qui","ut Excepteur","Excepteur nisi","ut","do sed voluptate commodo","reprehenderit deserunt ad velit"]`
`timezone`	`in ullamco laboris nulla`

Request Payload

Response Payload

fugiat laboris

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

GET

/v3/marketing/stats/automations/export

**This endpoint allows you to export Automation stats as CSV data**. You can specify one Automation or many: include as many Automation IDs as you need, separating them with commas, as the value of the `ids` query string paramter. The data is returned as plain text response but in CSV format, so

Query Parameter Name	Example
`ids`	`["ad culpa deserunt esse","eu deserunt ipsum","Ut adipisicing","exercitation adipisicing tempor sed elit","nulla ipsum","aute","dolore Excepteur ea","ex voluptate aliqua Lorem nostrud","mollit dolor laboris voluptate do","pariatur eu elit velit occaecat"]`
`timezone`	`ad aliquip laboris sit`

Request Payload

Response Payload

sunt sed Duis

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

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

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`	`"officia Ut tempor in nisi"`

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

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

Request Payload

Response Payload

{}

{
  "errors": [
    {
      "message": "You may only delete a sender identity when it is unlocked.",
      "field": "locked"
    }
  ]
}

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

POST

/v3/senders/{sender_id}/resend_verification

**This enpdoint allows you to resend a sender identity verification email.**

Header Name	Example
`on-behalf-of`	`"sunt in elit dolor consectetur"`

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

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

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

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

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

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

Header Name	Example
`on-behalf-of`	`"consequat ullamco aliquip cillum incididunt"`

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`	`"labore exercitation Ut sed"`

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`	`-61641625`
`page_size`	`84062922`
`list_id`*	`-54476789`

Header Name	Example
`on-behalf-of`	`"ullamco sed incididunt"`

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

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`	`"commodo Excepteur eiusmod"`

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`*	`-33670716`
`recipient_id`*	`-97393233`

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

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`	`"voluptate aliquip cupidatat qui officia"`

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

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`	`"Ut ullamco mollit et in"`

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`	`43055662`
`page_size`	`-276735`

Header Name	Example
`on-behalf-of`	`"irure et commodo ea minim"`

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

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

Request Payload

Response Payload

{
  "recipients": [
    {
      "id": "occaecat minim",
      "created_at": -32126589.968276158,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "UUkfviqeM9F@ETqDeaKXNfWFUmuIjOPaKoesqxRaQpq.zgpk",
      "first_name": null,
      "last_name": "minim",
      "last_clicked": null,
      "last_emailed": null,
      "last_opened": -79151516.25782698,
      "updated_at": 23431554.21014616
    }
  ]
}

{}

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

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`	`"est mollit cupidatat ullamco"`

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`	`"sit ut veniam deserunt"`

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

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}`	`enim nisi dolor`

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

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

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`	`"adipisicing elit Lorem laboris"`

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`	`"occaecat sit eu aliquip"`

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`	`"reprehenderit aliquip enim veniam"`

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

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

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

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

Header Name	Example
`on-behalf-of`	`"dolor eiusmod Lorem cupidatat Ut"`

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

Header Name	Example
`on-behalf-of`	`"tempor consectetur magna aliqua"`

Request Payload

{
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ]
}

Response Payload

{
  "id": 5,
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ],
  "recipient_count": 1
}

{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "segment_id": "segment_id",
      "message": "segment id is not valid"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}

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

DELETE

/v3/contactdb/segments/{segment_id}

**This endpoint allows you to delete a segment from your recipients database.** You also have the option to delete all the contacts from your Marketing Campaigns recipient database who were in this segment.

Query Parameter Name	Example
`delete_contacts`	`true`

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

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`	`65688357`
`page_size`	`-41846193`

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

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`	`-82488101`
`category`	`in ipsum et`
`offset`	`-37702199`

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

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`	`eu magna proident`
`sort_by_direction`	`desc`
`start_date`*	`aute eu`
`end_date`	`cillum ut sunt consequat`
`limit`	`72472150`
`offset`	`14163243`
`aggregated_by`	`week`

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

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`*	`elit`
`end_date`	`incididunt eu`
`categories`*	`pariatur Ut occaecat do`
`limit`	`-57527655`
`offset`	`15154768`
`aggregated_by`	`week`

Header Name	Example
`on-behalf-of`	`"in dolore non cupidatat dolor"`

Request Payload

Response Payload

[
  {
    "date": "2015-10-01",
    "stats": [
      {
        "type": "category",
        "name": "docs",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      },
      {
        "type": "category",
        "name": "mattscategory",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "category",
        "name": "docs",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      },
      {
        "type": "category",
        "name": "mattscategory",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]

Campaigns API(11 operations)

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

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`	`88773787`
`offset`	`-50235905`

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

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`	`"ut magna"`

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

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

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

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

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

Request Payload

{
  "send_at": 1489451436
}

Response Payload

{
  "id": 44043057,
  "send_at": -2872273,
  "status": "in"
}

{
  "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`	`"sunt occaecat eu"`

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`	`"dolore est aute commodo Excepteur"`

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

Request Payload

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

Response Payload

{
  "to": "adipisicing incididunt ullamco sunt anim"
}

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

Request Payload

{
  "name": "example_name",
  "generation": "dynamic"
}

Response Payload

{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "example_name",
  "generation": "legacy",
  "versions": []
}

GET

/v3/templates

**This endpoint allows you to retrieve all transactional templates.**

Query Parameter Name	Example
`generations`	`legacy`
`page_size`*	`197.9868979691818`
`page_token`	`nostrud eu dolore ipsum anim`

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

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": [
    {
      "": "esse laboris tempor in enim",
      "message": "proident tempor dolor consectetur",
      "error_id": "est velit eiusmod incididunt"
    },
    {
      "": "proident pariatur dolor elit",
      "message": "quis velit eiusmod",
      "error_id": "elit magna"
    },
    {
      "": "dolor dolor do fugiat",
      "message": "Lorem et in",
      "error_id": "nulla aliqua"
    },
    {
      "": "ut in labore",
      "message": "enim Excepteur",
      "error_id": "consequat elit"
    },
    {
      "": "Duis dolor laborum sit",
      "message": "ad proident minim",
      "error_id": "in et"
    }
  ]
}

POST

/v3/templates/{template_id}

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

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

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

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

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`	`"consectetur reprehenderit"`

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

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`	`"eiusmod dolore irure minim ipsum"`

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`	`"laborum incididunt et do pariatur"`

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

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

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

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

Request Payload

{
  "enabled": false,
  "url": "id aliqua",
  "group_resubscribe": true,
  "delivered": false,
  "group_unsubscribe": true,
  "spam_report": true,
  "bounce": false,
  "deferred": false,
  "unsubscribe": true,
  "processed": false,
  "open": false,
  "click": false,
  "dropped": false,
  "oauth_client_id": "reprehenderit in null",
  "oauth_client_secret": "ea in nostrud",
  "oauth_token_url": "cupidatat ad Ut"
}

Response Payload

{
  "enabled": true,
  "url": "mollit laborum",
  "group_resubscribe": false,
  "delivered": true,
  "group_unsubscribe": true,
  "spam_report": true,
  "bounce": true,
  "deferred": true,
  "unsubscribe": true,
  "processed": true,
  "open": true,
  "click": false,
  "dropped": true,
  "oauth_client_id": "anim sunt",
  "oauth_token_url": "ex"
}

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

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": "irure"
    },
    {
      "message": "ut nisi"
    },
    {
      "message": "Duis elit"
    },
    {
      "message": "consectetur laborum id voluptate dolor"
    },
    {
      "message": "dolor non"
    }
  ]
}

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`	`sint do`
`offset`	`ipsum`
`aggregated_by`	`week`
`start_date`*	`in esse laborum cillum`
`end_date`	`in ut officia velit`

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

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

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`	`"nostrud culpa sed nisi"`

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

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

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": "Ut sit nisi officia fugiat"
    },
    {
      "message": "officia cillum veniam"
    }
  ]
}

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

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": "cillum enim Duis"
    },
    {
      "message": "eiusmod irure adipisicing"
    },
    {
      "message": "adipisicing"
    },
    {
      "message": "eiusmod"
    },
    {
      "message": "ut"
    }
  ]
}

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

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": "cupidatat sunt pariatur occaecat nulla"
    }
  ]
}

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

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

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`*	`labore non commodo`
`limit`	`962.230927129188`

Header Name	Example
`X-Query-Id`	`"dolor amet aliquip eu commodo"`
`X-Cursor`	`"incididunt dolore ut laboris"`
`Authorization`*	`"quis incididunt sint officia"`

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`*	`"tempor ipsum quis"`

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`	`reprehenderit ut`

Header Name	Example
`Authorization`*	`"ex consequat in ipsum nostrud"`

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`*	`"ex Excepteur deserunt officia sed"`

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

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`	`"et esse"`

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

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`	`"id deserunt esse cillum"`

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

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`	`"quis do enim 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`	`"et commodo nulla sunt"`

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

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

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`	`57473042`
`offset`	`-22885428`
`aggregated_by`	`week`
`start_date`*	`ut eiusmod cupidatat elit`
`end_date`	`et cupidatat Lorem magna sint`

Header Name	Example
`on-behalf-of`	`"fugiat et eiusmod in"`

Request Payload

Response Payload

[
  {
    "date": "2015-11-03",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]

GET

/v3/geo/stats

**This endpoint allows you to retrieve your email statistics segmented by country and state/province.** **We only store up to 7 days of email activity in our database.** By default, 500 items will be returned per request via the Advanced Stats API endpoints. Advanced Stats provide a more in-depth

Query Parameter Name	Example
`country`	`US`
`limit`	`20388069`
`offset`	`-40108260`
`aggregated_by`	`day`
`start_date`*	`cupidatat pariatur qui velit`
`end_date`	`mollit sunt occaecat consectetur ut`

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

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`	`-2496855`
`offset`	`-88827256`
`aggregated_by`	`day`
`start_date`*	`laboris nisi ullamco irure minim`
`end_date`	`sit`

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

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`*	`mollit ipsum Ut`
`end_date`	`dolore quis cillum`
`aggregated_by`	`week`

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

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`*	`ad`
`end_date`	`voluptate commodo`
`aggregated_by`	`month`

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

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`	`in est Lorem sunt`
`limit`	`4628895`
`offset`	`94976859`
`aggregated_by`	`week`
`start_date`*	`cupidatat`
`end_date`	`culpa ipsum aliquip amet`

Header Name	Example
`on-behalf-of`	`"ipsum enim aute Excepteur"`

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`	`esse`
`limit`	`14079376`
`offset`	`51488480`
`aggregated_by`	`week`
`start_date`*	`cillum reprehenderit`
`end_date`	`ea reprehenderit quis pariatur`

Header Name	Example
`on-behalf-of`	`"magna qui pariatur ex"`

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`	`67329802`
`end_time`	`-59872486`

Header Name	Example
`Accept`*	`"est ut adipisicing"`
`on-behalf-of`	`"consequat in minim enim incididunt"`

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

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`	`"cupidatat nulla adipisicing eu"`

Request Payload

Response Payload

[
  {
    "created": 1443651125,
    "email": "bounce1@test.com",
    "reason": "550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at  https://support.google.com/mail/answer/6596 o186si2389584ioe.63 - gsmtp ",
    "status": "5.1.1"
  }
]

DELETE

/v3/suppression/bounces/{email}

**This endpoint allows you to remove an email address from your bounce list.**

Query Parameter Name	Example
`email_address`*	`aamKJMw-YwHO5R@xCyhsotiMwMFjXbeh.ay`

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

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`	`-41870129`
`end_time`	`-71645198`
`limit`	`76845063`
`offset`	`54423667`

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

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

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

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

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`	`7198446`
`end_time`	`-16571402`
`limit`	`74832326`
`offset`	`20713358`

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

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

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`	`"ex proident enim dolor elit"`

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

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

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`	`-2241525`
`end_time`	`48717913`
`limit`	`-82191686`
`offset`	`-78947075`

Header Name	Example
`on-behalf-of`	`"sit tempor amet consequat"`

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

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`	`"ea nostrud amet 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`	`"elit cupidatat in et ea"`

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

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

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`	`"dolor voluptate non Duis ullamco"`

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

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

Request Payload

Response Payload

{}

Suppressions - Suppressions(6 operations)

POST

/v3/asm/groups/{group_id}/suppressions

**This endpoint allows you to add email addresses to an unsubscribe group.** If you attempt to add suppressions to a group that has been deleted or does not exist, the suppressions will be added to the global suppressions list.

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

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

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`	`"nisi commodo et Lorem"`

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

Request Payload

Response Payload

[
  {
    "email": "test1@example.com",
    "group_id": 1,
    "group_name": "Weekly News",
    "created_at": 1410986704
  },
  {
    "email": "test1@example.com",
    "group_id": 2,
    "group_name": "Daily News",
    "created_at": 1411493671
  },
  {
    "email": "test2@example.com",
    "group_id": 2,
    "group_name": "Daily News",
    "created_at": 1411493671
  }
]

GET

/v3/asm/suppressions/{email}

**This endpoint returns a list of all groups from which the given email address has been unsubscribed.**

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

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

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`	`-43657370`
`end_time`	`85222159`
`limit`	`-33744694`
`offset`	`16652135`

Header Name	Example
`on-behalf-of`	`"nisi aute qui commodo"`

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

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

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`	`"in sed tempor Ut amet"`

Request Payload

Response Payload

{}

Service Homepage: sendgrid.com/en-us

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

emails