View All Services

Sendgrid V3 Mock Server

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

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

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

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

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": "velit et anim"
    },
    {
      "message": "in nostrud et ad ut"
    },
    {
      "message": "irure"
    }
  ]
}

Cancel Scheduled Sends(7 operations)

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

API Keys(6 operations)

Header NameExample
on-behalf-of"qui"
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": "voluptate nostrud"
    },
    {
      "message": "ut"
    }
  ]
}
Query Parameter NameExample
limit50254218
Header NameExample
on-behalf-of"eu aliquip nisi do cupidatat"
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": "Duis"
    },
    {
      "message": "reprehenderit ut nostrud"
    },
    {
      "message": "Duis reprehenderit sed"
    },
    {
      "message": "ut do occaecat"
    }
  ]
}
Header NameExample
on-behalf-of"officia"
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": "sint Duis proident incididunt"
    },
    {
      "message": "ipsum"
    },
    {
      "message": "ex in aliquip culpa"
    },
    {
      "message": "ullamco sint ea"
    }
  ]
}
Header NameExample
on-behalf-of"commodo aliquip officia"
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": "laboris veniam ut et"
    },
    {
      "message": "dolore occaecat commodo et"
    }
  ]
}
Header NameExample
on-behalf-of"eu ullamco"
Request Payload
{
  "name": "Profiles key",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ]
}
Response Payload
{
  "api_key_id": "qfTQ6KG0QBiwWdJ0-pCLCA",
  "name": "Profiles Key",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "tempor ipsum labore voluptate dolor"
    },
    {
      "message": "occaecat"
    }
  ]
}
Header NameExample
on-behalf-of"mollit eiusmod Lorem Excepteur cillum"
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": "Duis deserunt velit ipsum reprehenderit"
    },
    {
      "message": "ea sed Lorem"
    },
    {
      "message": "irure id eiusmod"
    }
  ]
}

API Key Permissions

Header NameExample
on-behalf-of"reprehenderit"
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": "in Lorem ea ut adipisicing"
    }
  ]
}

Settings - Enforced TLS(2 operations)

Header NameExample
on-behalf-of"et magna culpa"
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": "labore Excepteur aliqua ut"
    },
    {
      "message": "pariatur nostrud quis in"
    }
  ]
}
Header NameExample
on-behalf-of"sint enim elit"
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": "nulla nisi"
    },
    {
      "message": "mollit non"
    },
    {
      "message": "eu officia adipisicing"
    },
    {
      "message": "dolore reprehenderit"
    }
  ]
}

IP Access Management(6 operations)

Header NameExample
on-behalf-of"consectetur laborum aute veniam"
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": "ullamco ea"
    },
    {
      "message": "nostrud laborum magna Lorem"
    },
    {
      "message": "voluptate sunt"
    }
  ]
}
Header NameExample
on-behalf-of"laboris Lorem tempor"
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": "proident anim"
    },
    {
      "message": "voluptate elit dolor mollit"
    }
  ]
}
Header NameExample
on-behalf-of"in qui ipsum"
Request Payload
{
  "ids": [
    1,
    2,
    3
  ]
}
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "dolor"
    },
    {
      "message": "ad Duis culpa"
    },
    {
      "message": "ea Ut minim dolor"
    }
  ]
}
Query Parameter NameExample
limit13388628
Header NameExample
on-behalf-of"nulla dolor est labore qui"
Request Payload
Response Payload
{
  "result": [
    {
      "allowed": false,
      "auth_method": "Web",
      "first_at": 1444087966,
      "ip": "1.1.1.1",
      "last_at": 1444406672,
      "location": "Australia"
    },
    {
      "allowed": false,
      "auth_method": "Web",
      "first_at": 1444087505,
      "ip": "1.2.3.48",
      "last_at": 1444087505,
      "location": "Mukilteo, Washington"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "amet"
    }
  ]
}
Header NameExample
on-behalf-of"occaecat sunt fugiat quis"
Request Payload
Response Payload
{
  "id": 1,
  "ip": "192.168.1.1",
  "created_at": 1441824715,
  "updated_at": 1441824715
}
Header NameExample
on-behalf-of"reprehenderit occaecat mollit"
Request Payload
Response Payload
{}

Certificates(5 operations)

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

Single Sign-On Settings(5 operations)

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

Single Sign-On Teammates(2 operations)

Request Payload
{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane_doe@example.com",
  "scopes": [
    "mail.batch.create",
    "mail.batch.delete",
    "mail.batch.read",
    "mail.batch.update",
    "mail.send"
  ]
}
Response Payload
{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane_doe@example.com",
  "is_read_only": true,
  "username": "jane_doe@example.com",
  "is_sso": true
}
[
  {
    "error_id": "id Duis Ut consequat ad",
    "field": "ad pariatur amet mollit",
    "message": "est do reprehenderit et"
  },
  {
    "error_id": "culpa adipisicing est Ut esse",
    "field": null,
    "message": "non Excepteur ad ullamco ea"
  },
  {
    "error_id": "nulla aliquip Ut ullamco",
    "field": "consectetur non dolore quis",
    "message": "ad"
  },
  {
    "error_id": "voluptate sit esse",
    "field": "amet et ad commodo",
    "message": "cillum"
  },
  {
    "error_id": "et reprehenderit dolor ullamco laboris",
    "field": "adipisicing incididunt magna ea ullamco",
    "message": "ad eiusmod ullamco"
  }
]
[
  {
    "error_id": "sit voluptate tempor nostrud",
    "field": "ex dolore culpa dolore est",
    "message": "esse in mollit"
  },
  {
    "error_id": "ipsum officia laboris",
    "field": null,
    "message": "ipsum Lorem id"
  },
  {
    "error_id": "reprehenderit",
    "field": "cillum in amet labore laboris",
    "message": "veniam exercitation ea id"
  },
  {
    "error_id": "cupidatat",
    "field": "irure quis ut ea",
    "message": "voluptate incididunt"
  }
]
[
  {
    "error_id": "sunt",
    "field": null,
    "message": "dolor est voluptate pariatur"
  }
]
[
  {
    "error_id": "laboris est incididunt nisi in",
    "field": "nulla ut",
    "message": "ullamco eiusmod"
  },
  {
    "error_id": "in in",
    "field": null,
    "message": "Ut eiusmod aliqua"
  },
  {
    "error_id": "ut aliqua cupidatat incididunt",
    "field": "consequat cillum in eu elit",
    "message": "dolor deserunt anim"
  },
  {
    "error_id": "est incididunt et",
    "field": "sit incididunt",
    "message": "cupidatat cillum Ut"
  },
  {
    "error_id": "aute aliquip proident ad",
    "field": null,
    "message": "in est do sed"
  }
]
[
  {
    "error_id": "Duis dolor",
    "field": "sunt veniam cillum in pariatur",
    "message": "qui"
  }
]
Request Payload
{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane_doe@example.com",
  "scopes": [
    "mail.batch.create",
    "mail.batch.delete",
    "mail.batch.read",
    "mail.batch.update",
    "mail.send"
  ],
  "is_admin": false
}
Response Payload
{
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "jane_doe@example.com",
  "is_admin": false,
  "username": "jane_doe@example.com",
  "is_sso": true,
  "address": "1234 Fake St.",
  "address2": "Suite 5",
  "city": "San Francisco",
  "state": "CA",
  "zip": "94105",
  "Country": "United States",
  "phone": "+15555555555",
  "user_type": "teammate"
}
[
  {
    "error_id": "commodo",
    "field": null,
    "message": "dolor culpa est"
  },
  {
    "error_id": "eiusmod exercitation sit et tempor",
    "field": "esse labore",
    "message": "sed ad cupidatat"
  }
]
[
  {
    "error_id": "Lorem occaecat sint ea",
    "field": null,
    "message": "laboris anim"
  },
  {
    "error_id": "ad esse est dolor nulla",
    "field": null,
    "message": "do proident"
  }
]
[
  {
    "error_id": "magna Lorem",
    "field": null,
    "message": "ut sed"
  },
  {
    "error_id": "dolor",
    "field": "elit commodo",
    "message": "irure cupidatat eiusmod elit"
  },
  {
    "error_id": "laborum cupidatat adipisicing nulla",
    "field": "labore est sed nisi",
    "message": "eiusmod ullamco"
  },
  {
    "error_id": "sit reprehenderit culpa esse",
    "field": "sunt",
    "message": "Ut"
  },
  {
    "error_id": "Excepteur ipsum qui",
    "field": "ex amet exercitation id",
    "message": "aute ullamco"
  }
]
[
  {
    "error_id": "proident eu",
    "field": "cupidatat laboris ex",
    "message": "mollit commodo Duis et"
  },
  {
    "error_id": "commodo do ea voluptate consectetur",
    "field": "eu ad ex nostrud",
    "message": "ea in reprehenderit"
  },
  {
    "error_id": "tempor",
    "field": "qui deserunt ut",
    "message": "consectetur laboris cupidatat minim"
  }
]
[
  {
    "error_id": "non ut minim nisi proident",
    "field": "incididunt sit dolor in",
    "message": "pariatur eu"
  },
  {
    "error_id": "eiusmod adipisicing in sit",
    "field": null,
    "message": "nisi"
  },
  {
    "error_id": "occaecat enim laborum culpa quis",
    "field": "laboris reprehenderit velit anim eiusmod",
    "message": "enim quis elit"
  }
]

Settings - Mail(13 operations)

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

Settings - Partner(3 operations)

Header NameExample
on-behalf-of"mollit tempor irure Duis dolore"
Request Payload
{
  "license_key": "",
  "enabled": true,
  "enable_subuser_statistics": true
}
Response Payload
{
  "enable_subuser_statistics": true,
  "enabled": true,
  "license_key": ""
}
Header NameExample
on-behalf-of"fugiat est in Lorem consequat"
Request Payload
Response Payload
{
  "enable_subuser_statistics": false,
  "enabled": true,
  "license_key": ""
}
Query Parameter NameExample
limit44603769
offset85979688
Header NameExample
on-behalf-of"cupidatat cillum anim deserunt adipisicing"
Request Payload
Response Payload
{
  "result": [
    {
      "title": "Partner title",
      "enabled": true,
      "name": "partner_name",
      "description": "A description of a partner."
    }
  ]
}

Teammates(11 operations)

Header NameExample
on-behalf-of"veniam"
Request Payload
{
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}
Response Payload
{
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}
{
  "errors": [
    {
      "field": "tempor ipsum est cillum",
      "message": "ut commodo"
    },
    {
      "field": "amet commodo et sit",
      "message": "ullamco est ut id"
    },
    {
      "field": "ut eiusmod dolor in adipisicing",
      "message": "eiusmod et ex"
    }
  ]
}
Query Parameter NameExample
limit10
offset19247081
Header NameExample
on-behalf-of"Excepteur eiusmod"
Request Payload
Response Payload
{
  "results": [
    {
      "username": "teammate1",
      "email": "teammate1@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "user_type": "owner",
      "is_admin": true,
      "phone": "123-345-3453",
      "website": "www.example.com",
      "company": "ACME Inc.",
      "address": "123 Acme St",
      "address2": "",
      "city": "City",
      "state": "CA",
      "country": "USA",
      "zip": "12345"
    },
    {
      "username": "teammate2",
      "email": "teammate2@example.com",
      "first_name": "John",
      "last_name": "Doe",
      "user_type": "teammate",
      "is_admin": false,
      "phone": "123-345-3453",
      "website": "www.example.com",
      "company": "ACME Inc.",
      "address": "123 Acme St",
      "address2": "",
      "city": "City",
      "state": "CA",
      "country": "USA",
      "zip": "12345"
    },
    {
      "username": "teammate3",
      "email": "teammate3@example.com",
      "first_name": "Steve",
      "last_name": "Doe",
      "user_type": "admin",
      "is_admin": true,
      "phone": "123-345-3453",
      "website": "www.example.com",
      "company": "ACME Inc.",
      "address": "123 Acme St",
      "address2": "",
      "city": "City",
      "state": "CA",
      "country": "USA",
      "zip": "12345"
    }
  ]
}
Header NameExample
on-behalf-of"ut Lorem sunt esse dolor"
Request Payload
Response Payload
{
  "pending_id": "abc123abc",
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update"
  ],
  "is_admin": false
}
{
  "errors": [
    {
      "message": "invalid pending key",
      "field": "pending_key"
    }
  ]
}
Query Parameter NameExample
limit17420543
offset86487081
Request Payload
Response Payload
[
  {
    "id": 1,
    "scope_group_name": "Mail Settings",
    "username": "teammate1",
    "email": "teammate1@example.com",
    "first_name": "Teammate",
    "last_name": "One"
  },
  {
    "id": 2,
    "scope_group_name": "Stats",
    "username": "teammate2",
    "email": "teammate2@example.com",
    "first_name": "Teammate",
    "last_name": "Two"
  }
]
Header NameExample
on-behalf-of"in"
Request Payload
Response Payload
{
  "result": [
    {
      "email": "user1@example.com",
      "scopes": [
        "user.profile.read",
        "user.profile.edit"
      ],
      "is_admin": false,
      "pending_id": "abcd123abc",
      "expiration_date": 1456424263
    },
    {
      "email": "user2@example.com",
      "scopes": [],
      "is_admin": true,
      "pending_id": "bcde234bcd",
      "expiration_date": 1456424263
    }
  ]
}
Header NameExample
on-behalf-of"magna"
Request Payload
Response Payload
{
  "username": "teammate1",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.update",
    "..."
  ],
  "user_type": "admin",
  "is_admin": true,
  "phone": "123-345-3453",
  "website": "www.example.com",
  "company": "ACME Inc.",
  "address": "123 Acme St",
  "address2": "",
  "city": "City",
  "state": "CA",
  "country": "USA",
  "zip": "12345"
}
Header NameExample
on-behalf-of"enim ullamco nostrud ipsum"
Request Payload
{
  "scopes": [
    "user.profile.read",
    "user.profile.edit"
  ],
  "is_admin": false
}
Response Payload
{
  "username": "teammate1",
  "first_name": "Jane",
  "last_name": "Doe",
  "email": "teammate1@example.com",
  "scopes": [
    "user.profile.read",
    "user.profile.edit"
  ],
  "user_type": "teammate",
  "is_admin": false,
  "phone": "123-345-3453",
  "website": "www.example.com",
  "company": "ACME Inc.",
  "address": "123 Acme St",
  "address2": "",
  "city": "City",
  "state": "CA",
  "country": "USA",
  "zip": "12345"
}
{
  "errors": [
    {
      "message": "one or more of given scopes are invalid",
      "field": "scopes"
    }
  ]
}
{
  "errors": [
    {
      "message": "username not found",
      "field": "username"
    }
  ]
}
Header NameExample
on-behalf-of"non consectetur occaecat pariatur commodo"
Request Payload
Response Payload
{
  "errors": [
    {
      "field": "voluptate",
      "message": "et"
    },
    {
      "field": "veniam dolor reprehenderit et",
      "message": "dolore ut"
    },
    {
      "field": "deserunt magna dolor",
      "message": "aliqua"
    }
  ]
}
{
  "errors": [
    {
      "message": "username not found",
      "field": "username"
    }
  ]
}
Request Payload
Response Payload
{
  "scope_group_name": "Stats"
}
{}
{
  "errors": [
    {
      "field": "ullamco sit",
      "message": "nulla non occaecat Lorem consequat"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "message": "Cannot find request",
      "field": "request_id"
    }
  ]
}
Header NameExample
on-behalf-of"ex ut esse"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "id et in ipsum veniam",
      "message": "sunt sit elit"
    },
    {
      "field": "enim Excepteur incididunt dolore",
      "message": "et"
    },
    {
      "field": "tempor commodo dolore amet",
      "message": "adipisicing nulla in"
    },
    {
      "field": "Excepteur irure proident anim nisi",
      "message": "fugiat aliquip irure deserunt"
    },
    {
      "field": "consequat",
      "message": "est nostrud eu Ut nisi"
    }
  ]
}

Alerts(5 operations)

Header NameExample
Authorization"do ipsum incididunt mollit"
on-behalf-of"Ut sit"
Request Payload
{
  "type": "stats_notification",
  "email_to": "example@example.com",
  "frequency": "daily"
}
Response Payload
{
  "created_at": 1451520930,
  "email_to": "test@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451520930
}
{
  "field": "eiusmod fugiat proident",
  "message": "officia in"
}
Header NameExample
Authorization"do dolore consequat veniam sed"
on-behalf-of"in culpa ad laborum"
Request Payload
Response Payload
[
  {
    "created_at": 1451498784,
    "email_to": "example1@example.com",
    "id": 46,
    "percentage": 90,
    "type": "usage_limit",
    "updated_at": 1451498784
  },
  {
    "created_at": 1451498812,
    "email_to": "example2@example.com",
    "frequency": "monthly",
    "id": 47,
    "type": "stats_notification",
    "updated_at": 1451498812
  },
  {
    "created_at": 1451520930,
    "email_to": "example3@example.com",
    "frequency": "daily",
    "id": 48,
    "type": "stats_notification",
    "updated_at": 1451520930
  }
]
Header NameExample
Authorization"laborum ex exercitation in sunt"
on-behalf-of"proident nulla"
Request Payload
Response Payload
{
  "created_at": 1451520930,
  "email_to": "example@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451520930
}
Header NameExample
on-behalf-of"incididunt"
Request Payload
Response Payload
{}
Header NameExample
on-behalf-of"aliquip et ut do cillum"
Request Payload
{
  "email_to": "example@example.com"
}
Response Payload
{
  "created_at": 1451520930,
  "email_to": "example@example.com",
  "frequency": "daily",
  "id": 48,
  "type": "stats_notification",
  "updated_at": 1451522691
}

Users API(9 operations)

Header NameExample
on-behalf-of"nostrud"
Request Payload
Response Payload
{
  "address": "814 West Chapman Avenue",
  "address2": "",
  "city": "Orange",
  "company": "SendGrid",
  "country": "US",
  "first_name": "Test",
  "last_name": "User",
  "phone": "555-555-5555",
  "state": "CA",
  "website": "http://www.sendgrid.com",
  "zip": "92868"
}
Header NameExample
on-behalf-of"tempor irure magna"
Request Payload
{
  "first_name": "Example",
  "last_name": "User",
  "city": "Orange"
}
Response Payload
{
  "address": "814 West Chapman Avenue",
  "address2": "",
  "city": "Orange",
  "company": "SendGrid",
  "country": "US",
  "first_name": "Example",
  "last_name": "User",
  "phone": "555-555-5555",
  "state": "CA",
  "website": "http://www.sendgrid.com",
  "zip": "92868"
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"enim sit in cillum"
Request Payload
Response Payload
{
  "reputation": 100,
  "type": "paid"
}
Header NameExample
on-behalf-of"commodo"
Request Payload
Response Payload
{
  "email": "test@example.com"
}
Header NameExample
on-behalf-of"elit ullamco"
Request Payload
{
  "email": "example@example.com"
}
Response Payload
{
  "email": "example@example.com"
}
Header NameExample
on-behalf-of"ea anim"
Request Payload
Response Payload
{
  "username": "test_username",
  "user_id": 1
}
Header NameExample
on-behalf-of"adipisicing"
Request Payload
{
  "username": "test_username"
}
Response Payload
{
  "username": "test_username"
}
Header NameExample
on-behalf-of"ut dolore occaecat commodo magna"
Request Payload
Response Payload
{
  "remain": 200,
  "total": 200,
  "overage": 0,
  "used": 0,
  "last_reset": "2013-01-01",
  "next_reset": "2013-02-01",
  "reset_frequency": "monthly"
}
Header NameExample
on-behalf-of"in mollit deserunt ipsum"
Request Payload
{
  "new_password": "new_password",
  "old_password": "old_password"
}
Response Payload
{}

Subusers API(6 operations)

Query Parameter NameExample
usernamenostrud
limit30525452
offset-67775558
Request Payload
Response Payload
[
  {
    "disabled": false,
    "email": "example@example.com",
    "id": 1234,
    "username": "example_subuser"
  },
  {
    "disabled": false,
    "email": "example2@example.com",
    "id": 1234,
    "username": "example_subuser2"
  }
]
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Request Payload
{
  "username": "John@example.com",
  "email": "John@example.com",
  "password": "johns_password",
  "ips": [
    "1.1.1.1",
    "2.2.2.2"
  ]
}
Response Payload
{
  "username": "example_subuser",
  "user_id": 1234,
  "email": "example@example.com",
  "signup_session_token": "",
  "authorization_token": "",
  "credit_allocation": {
    "type": "unlimited"
  }
}
{
  "errors": [
    {
      "message": "username exists"
    },
    {
      "message": "unable to validate IPs at this time"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "you dont have permission to access this resource"
    }
  ]
}
{
  "errors": [
    {
      "message": "unable to validate IPs at this time"
    }
  ]
}
Request Payload
{
  "disabled": false
}
Response Payload
{}
{
  "errors": [
    {
      "message": "invalid username"
    },
    {
      "message": "no fields provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "unable to enable user"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
usernamesproident incididunt veniam
Request Payload
Response Payload
[
  {
    "username": "example_subuser",
    "reputation": 99
  },
  {
    "username": "example_subuser2",
    "reputation": 95.2
  }
]
Request Payload
[
  "127.0.0.1"
]
Response Payload
{
  "ips": [
    "127.0.0.1"
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Subuser Monitor Settings(4 operations)

Request Payload
Response Payload
{
  "email": "example@example.com",
  "frequency": 500
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "No monitor settings for this user"
    }
  ]
}
Request Payload
{
  "email": "example@example.com",
  "frequency": 50000
}
Response Payload
{
  "email": "example@example.com",
  "frequency": 50000
}
{
  "errors": [
    {
      "field": null,
      "message": "User already has a monitor"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Request Payload
{
  "email": "example@example.com",
  "frequency": 50000
}
Response Payload
{
  "email": "example@example.com",
  "frequency": 500
}
{
  "errors": [
    {
      "field": "email",
      "message": "Email is required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "No monitor settings for this user"
    }
  ]
}

Subuser Statistics(4 operations)

Query Parameter NameExample
date*proident in Lorem elit
sort_by_metricproident pariatur officia
sort_by_directiondesc
limit12262926
offset-8270176
Request Payload
Response Payload
{
  "date": "2016-02-01",
  "stats": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 10,
        "processed": 10,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user1",
      "type": "subuser"
    }
  ]
}
Query Parameter NameExample
date*sunt aliqua reprehenderit in aute
subuserex id ipsum
sort_by_metricblocks
sort_by_directionasc
limit-50584014
offset66717349
Request Payload
Response Payload
{
  "date": "2016-02-01",
  "stats": [
    {
      "first_name": "John",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 0,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 1,
        "processed": 0,
        "requests": 100,
        "spam_report_drops": 0,
        "spam_reports": 99,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user1",
      "type": "subuser"
    },
    {
      "first_name": "Jane",
      "last_name": "Doe",
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 10,
        "processed": 10,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "user2",
      "type": "subuser"
    }
  ]
}
Query Parameter NameExample
sort_by_directionasc
start_date*eiusmod non veniam reprehenderit sunt
end_dateut ipsum
limit-88207770
offset-42749921
aggregated_byamet laboris reprehenderit tempor
sort_by_metricproident Ut ad velit
Request Payload
Response Payload
{
  "date": "2015-10-11",
  "stats": []
}
Query Parameter NameExample
limit-23793716
offset46536482
aggregated_byday
subusers*Duis in
start_date*officia minim et
end_dateDuis reprehenderit
Request Payload
Response Payload
[
  {
    "date": "2015-10-01",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-02",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-03",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-04",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-05",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-06",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-07",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-08",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-09",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-10",
    "stats": [
      {
        "type": "subuser",
        "name": "Matt_subuser",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]

Link branding(10 operations)

IP Warmup(4 operations)

Request Payload
{
  "ip": "0.0.0.0"
}
Response Payload
[
  {
    "ip": "0.0.0.0",
    "start_date": 1409616000
  }
]
{
  "errors": [
    {
      "field": null,
      "message": "resource not found"
    }
  ]
}
Request Payload
Response Payload
[
  {
    "ip": "0.0.0.0",
    "start_date": 1409616000
  }
]
Request Payload
Response Payload
[
  {
    "ip": "0.0.0.0",
    "start_date": 1409616000
  }
]
{
  "errors": [
    {
      "field": null,
      "message": "resource not found"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "resource not found"
    }
  ]
}

Reverse DNS(5 operations)

Header NameExample
on-behalf-of"aliquip sed est"
Request Payload
{
  "ip": "192.168.1.1",
  "subdomain": "email",
  "domain": "example.com"
}
Response Payload
{
  "id": 123,
  "ip": "192.168.1.2",
  "rdns": "o1.email.example.com",
  "users": [],
  "subdomain": "email",
  "domain": "example.com",
  "valid": true,
  "legacy": false,
  "a_record": {
    "valid": true,
    "type": "a",
    "host": "o1.email.example.com",
    "data": "192.168.1.2"
  }
}
Query Parameter NameExample
limit51783865
offset-57355475
ipExcepteur
Header NameExample
on-behalf-of"in"
Request Payload
Response Payload
[
  {
    "id": 1,
    "ip": "192.168.1.1",
    "rdns": "o1.email.example.com",
    "users": [
      {
        "username": "john@example.com",
        "user_id": 7
      },
      {
        "username": "jane@example.com",
        "user_id": 8
      }
    ],
    "subdomain": "email",
    "domain": "example.com",
    "valid": true,
    "legacy": false,
    "a_record": {
      "valid": true,
      "type": "a",
      "host": "o1.email.example.com",
      "data": "192.168.1.1"
    }
  },
  {
    "id": 2,
    "ip": "192.168.1.2",
    "rdns": "o2.email.example.com",
    "users": [
      {
        "username": "john@example.com",
        "user_id": 7
      },
      {
        "username": "jane@example2.com",
        "user_id": 9
      }
    ],
    "subdomain": "email",
    "domain": "example.com",
    "valid": true,
    "legacy": false,
    "a_record": {
      "valid": true,
      "type": "a",
      "host": "o2.email.example.com",
      "data": "192.168.1.2"
    }
  }
]
Header NameExample
on-behalf-of"aute eiusmod"
Request Payload
Response Payload
{
  "id": 123456,
  "valid": false,
  "validation_results": {
    "a_record": {
      "valid": false,
      "reason": "Failed to resolve A Record at o1.ptr4283.example.com: lookup o1.ptr4283.example.com on 192.168.0.10:53: no such host"
    }
  }
}
{
  "errors": [
    {
      "message": "Reverse DNS record not found."
    }
  ]
}
{
  "errors": [
    {
      "message": "internal error getting rDNS"
    }
  ]
}
Header NameExample
on-behalf-of"do occaecat deserunt est"
Request Payload
Response Payload
{
  "id": 123,
  "ip": "192.168.1.1",
  "rdns": "o1.email.example.com",
  "users": [
    {
      "username": "john@example.com",
      "user_id": 7
    }
  ],
  "subdomain": "email",
  "domain": "example.com",
  "valid": true,
  "legacy": false,
  "a_record": {
    "valid": true,
    "type": "a",
    "host": "o1.email.example.com",
    "data": "192.168.1.1"
  }
}
Header NameExample
on-behalf-of"consectetur sed labore do incididunt"
Request Payload
Response Payload
{}

Email Address Validation

Request Payload
{
  "email": "example@example.com",
  "source": "signup"
}
Response Payload
{
  "result": {
    "email": "cedric@fogowl.com",
    "verdict": "Valid",
    "score": 0.85021,
    "local": "cedric",
    "host": "fogowl.com",
    "checks": {
      "domain": {
        "has_valid_address_syntax": true,
        "has_mx_or_a_record": true,
        "is_suspected_disposable_address": false
      },
      "local_part": {
        "is_suspected_role_address": false
      },
      "additional": {
        "has_known_bounces": false,
        "has_suspected_bounces": false
      }
    },
    "ip_address": "192.168.1.1"
  }
}

Email CNAME records

Request Payload
{
  "link_id": 29719392,
  "domain_id": 46873408,
  "email": "my_colleague@example.com",
  "message": "DNS Record for verification"
}
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": {
    "error": "veniam occaecat Excepteur elit",
    "field": "occaecat"
  }
}

IP Pools(7 operations)

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

IP Addresses(5 operations)

Request Payload
{
  "count": 90323478,
  "subusers": [
    "subuser1",
    "subuser2"
  ],
  "warmup": true,
  "user_can_send": true
}
Response Payload
{
  "ips": [
    {
      "ip": "1.2.3.4",
      "subusers": [
        "user",
        "subuser1"
      ]
    },
    {
      "ip": "1.2.3.5",
      "subusers": [
        "user",
        "subuser1"
      ]
    }
  ],
  "remaining_ips": 1,
  "warmup": true
}
{
  "errors": [
    {
      "field": null,
      "message": "one or more subusers do not belong to this user"
    }
  ]
}
Query Parameter NameExample
ipquis cupidatat aliqua in
exclude_whitelabelstrue
limit34609799
offset13525389
subuserLorem culpa
sort_by_directionasc
Request Payload
Response Payload
[
  {
    "ip": "192.168.1.1",
    "pools": [
      "pool1",
      "pool2"
    ],
    "whitelabeled": false,
    "start_date": 1409616000,
    "subusers": [
      "tim@sendgrid.net"
    ],
    "warmup": false,
    "assigned_at": 1482883200
  },
  {
    "ip": "208.115.214.22",
    "pools": [],
    "whitelabeled": true,
    "rdns": "o1.email.burgermail.com",
    "start_date": 1409616000,
    "subusers": [],
    "warmup": false,
    "assigned_at": 1482883200
  }
]
Request Payload
Response Payload
{
  "results": [
    {
      "remaining": 2,
      "period": "month",
      "price_per_ip": 20
    }
  ]
}
Request Payload
Response Payload
[
  {
    "ip": "167.89.21.3",
    "pools": [
      "new_test5"
    ],
    "warmup": true,
    "start_date": 1409616000
  }
]
Request Payload
Response Payload
{
  "ip": "000.00.00.0",
  "subusers": [
    "subuser1",
    "subuser2"
  ],
  "rdns": "o1.em.example.com",
  "pools": [
    "test1"
  ],
  "warmup": false,
  "start_date": null,
  "whitelabeled": true
}

Domain Authentication(12 operations)

Query Parameter NameExample
limit-88689237
offset6487655
exclude_subuserstrue
usernamevoluptate Lorem sint amet
domainpariatur
Header NameExample
on-behalf-of"anim nisi Lorem pariatur"
Request Payload
Response Payload
[
  {
    "id": 1,
    "user_id": 7,
    "subdomain": "mail",
    "domain": "example.com",
    "username": "jane@example.com",
    "ips": [
      "192.168.1.1",
      "192.168.1.2"
    ],
    "custom_spf": true,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": true,
    "dns": {
      "mail_cname": {
        "valid": true,
        "type": "cname",
        "host": "mail.example.com",
        "data": "u7.wl.sendgrid.net"
      },
      "dkim1": {
        "valid": true,
        "type": "cname",
        "host": "s1._domainkey.example.com",
        "data": "s1._domainkey.u7.wl.sendgrid.net"
      },
      "dkim2": {
        "valid": true,
        "type": "cname",
        "host": "s2._domainkey.example.com",
        "data": "s2._domainkey.u7.wl.sendgrid.net"
      }
    }
  },
  {
    "id": 2,
    "user_id": 8,
    "subdomain": "new",
    "domain": "example2.com",
    "username": "john@example2.com",
    "ips": [],
    "custom_spf": false,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": false,
    "dns": {
      "mail_cname": {
        "valid": false,
        "type": "mx",
        "host": "news.example2.com",
        "data": "sendgrid.net"
      },
      "dkim1": {
        "valid": false,
        "type": "txt",
        "host": "example2.com",
        "data": "k=rsa; t=s; p=publicKey"
      },
      "dkim2": {
        "valid": false,
        "type": "txt",
        "host": "example2.com",
        "data": "k=rsa; t=s p=publicKey"
      }
    }
  }
]
Header NameExample
on-behalf-of"et cupidatat ullamco"
Request Payload
{
  "domain": "example.com",
  "subdomain": "news",
  "username": "john@example.com",
  "ips": [
    "192.168.1.1",
    "192.168.1.2"
  ],
  "custom_spf": true,
  "default": true,
  "automatic_security": false
}
Response Payload
{
  "id": 302183,
  "user_id": 1446226,
  "subdomain": "example",
  "domain": "example.com",
  "username": "mbernier",
  "ips": [],
  "custom_spf": false,
  "default": true,
  "legacy": false,
  "automatic_security": true,
  "valid": false,
  "dns": {
    "mail_cname": {
      "valid": false,
      "type": "cname",
      "host": "example.example.com",
      "data": "u1446226.wl.sendgrid.net"
    },
    "dkim1": {
      "valid": false,
      "type": "cname",
      "host": "s1._domainkey.example.com",
      "data": "s1.domainkey.u1446226.wl.sendgrid.net"
    },
    "dkim2": {
      "valid": false,
      "type": "cname",
      "host": "s2._domainkey.example.com",
      "data": "s2.domainkey.u1446226.wl.sendgrid.net"
    }
  }
}
Header NameExample
on-behalf-of"enim velit"
Request Payload
Response Payload
{
  "id": 45373692,
  "user_id": 66036447,
  "subdomain": "sub",
  "domain": "example.com",
  "username": "jdoe",
  "ips": [
    "127.0.0.1"
  ],
  "custom_spf": false,
  "default": true,
  "legacy": false,
  "automatic_security": true,
  "valid": true,
  "dns": {
    "mail_cname": {
      "valid": true,
      "type": "cname",
      "host": "mail.example.com",
      "data": "u7.wl.sendgrid.net"
    },
    "dkim1": {
      "valid": true,
      "type": "cname",
      "host": "s1._domainkey.example.com",
      "data": "s1._domainkey.u7.wl.sendgrid.net"
    },
    "dkim2": {
      "valid": true,
      "type": "cname",
      "host": "s2._domainkey.example.com",
      "data": "s2._domainkey.u7.wl.sendgrid.net"
    }
  }
}
Header NameExample
on-behalf-of"veniam"
Request Payload
{
  "default": false,
  "custom_spf": true
}
Response Payload
[
  {
    "id": 1,
    "user_id": 7,
    "subdomain": "mail",
    "domain": "example.com",
    "username": "jane@example.com",
    "ips": [
      "192.168.1.1",
      "192.168.1.2"
    ],
    "custom_spf": true,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": true,
    "dns": {
      "mail_cname": {
        "valid": true,
        "type": "cname",
        "host": "mail.example.com",
        "data": "u7.wl.sendgrid.net"
      },
      "dkim1": {
        "valid": true,
        "type": "cname",
        "host": "s1._domainkey.example.com",
        "data": "s1._domainkey.u7.wl.sendgrid.net"
      },
      "dkim2": {
        "valid": true,
        "type": "cname",
        "host": "s2._domainkey.example.com",
        "data": "s2._domainkey.u7.wl.sendgrid.net"
      }
    }
  },
  {
    "id": 2,
    "user_id": 8,
    "subdomain": "new",
    "domain": "example2.com",
    "username": "john@example2.com",
    "ips": [],
    "custom_spf": false,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": false,
    "dns": {
      "mail_cname": {
        "valid": false,
        "type": "mx",
        "host": "news.example2.com",
        "data": "sendgrid.net"
      },
      "dkim1": {
        "valid": false,
        "type": "txt",
        "host": "example2.com",
        "data": "k=rsa; t=s; p=publicKey"
      },
      "dkim2": {
        "valid": false,
        "type": "txt",
        "host": "example2.com",
        "data": "k=rsa; t=s p=publicKey"
      }
    }
  }
]
Header NameExample
on-behalf-of"sunt deserunt sit cillum"
Request Payload
Response Payload
{}
Query Parameter NameExample
domainoccaecat aute esse in Lorem
Header NameExample
on-behalf-of"sunt sint culpa"
Request Payload
Response Payload
[
  {
    "id": 1,
    "user_id": 7,
    "subdomain": "mail",
    "domain": "example.com",
    "username": "jane@example.com",
    "ips": [
      "192.168.1.1",
      "192.168.1.2"
    ],
    "custom_spf": true,
    "default": true,
    "legacy": false,
    "automatic_security": true,
    "valid": true,
    "dns": {
      "mail_cname": {
        "valid": true,
        "type": "cname",
        "host": "mail.example.com",
        "data": "u7.wl.sendgrid.net"
      },
      "dkim1": {
        "valid": true,
        "type": "cname",
        "host": "s1._domainkey.example.com",
        "data": "s1._domainkey.u7.wl.sendgrid.net"
      },
      "dkim2": {
        "valid": true,
        "type": "cname",
        "host": "s2._domainkey.example.com",
        "data": "s2._domainkey.u7.wl.sendgrid.net"
      }
    }
  }
]
Header NameExample
on-behalf-of"sed fugiat"
Request Payload
{
  "ip": "192.168.0.1"
}
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "john@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}
Header NameExample
on-behalf-of"in nisi aliquip"
Request Payload
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "mail@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}
Header NameExample
on-behalf-of"minim do exercitation"
Request Payload
Response Payload
{
  "id": 1,
  "valid": true,
  "validation_resuts": {
    "mail_cname": {
      "valid": false,
      "reason": "Expected your MX record to be \"mx.sendgrid.net\" but found \"example.com\"."
    },
    "dkim1": {
      "valid": true,
      "reason": null
    },
    "dkim2": {
      "valid": true,
      "reason": null
    },
    "spf": {
      "valid": true,
      "reason": null
    }
  }
}
{
  "errors": [
    {
      "message": "internal error getting TXT"
    }
  ]
}
Query Parameter NameExample
username*occaecat proident sint culpa in
Request Payload
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "mail@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}
Query Parameter NameExample
usernameincididunt
Request Payload
Response Payload
{}
Request Payload
{
  "username": "jdoe"
}
Response Payload
{
  "id": 1,
  "domain": "example.com",
  "subdomain": "mail",
  "username": "mail@example.com",
  "user_id": 7,
  "ips": [],
  "custom_spf": true,
  "default": false,
  "legacy": false,
  "automatic_security": false,
  "valid": false,
  "dns": {
    "mail_server": {
      "host": "mail.example.com",
      "type": "mx",
      "data": "sendgrid.net",
      "valid": false
    },
    "subdomain_spf": {
      "host": "mail.example.com",
      "type": "txt",
      "data": "v=spf1 ip4:192.168.1.1 ip4:192.168.0.1 -all",
      "valid": false
    },
    "domain_spf": {
      "host": "example.com",
      "type": "txt",
      "data": "v=spf1 include:mail.example.com -all",
      "valid": false
    },
    "dkim": {
      "host": "s1._domainkey.example.com",
      "type": "txt",
      "data": "k=rsa; t=s; p=publicKey",
      "valid": false
    }
  }
}

Sender Verification(8 operations)

Request Payload
Response Payload
{
  "results": {
    "soft_failures": [
      "gmail.com"
    ],
    "hard_failures": [
      "yahoo.com"
    ]
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "ex ad labore voluptate laboris"
    },
    {
      "message": "tempor velit"
    }
  ]
}
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": "Duis aliquip proident"
    },
    {
      "message": "Lorem exercitation ipsum sunt"
    },
    {
      "message": "et non dolore cillum"
    },
    {
      "message": "dolor anim dolore"
    },
    {
      "message": "magna velit id ea"
    }
  ]
}
Request Payload
{
  "nickname": "Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105"
}
Response Payload
{
  "id": 1234,
  "nickname": "Example Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St.",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105",
  "verified": true,
  "locked": false
}
{
  "errors": [
    {
      "error_id": "cillum nisi",
      "field": "minim consequat",
      "message": "in in"
    },
    {
      "error_id": "labore nostrud cupidatat ad fugiat",
      "field": "quis aliquip Lorem culpa sint",
      "message": "aliquip Ut aliqua nulla dolor"
    },
    {
      "error_id": "proident ullamco",
      "field": "velit laboris",
      "message": "ut do aliqua cillum nisi"
    },
    {
      "error_id": "sed",
      "field": "fugiat aute in",
      "message": "reprehenderit ut ipsum tempor culpa"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "do non culpa cupidatat velit"
    },
    {
      "message": "dolore culpa ex"
    },
    {
      "message": "eu fugiat magna culpa cupidatat"
    },
    {
      "message": "nisi Excepteur"
    },
    {
      "message": "reprehenderit ad nisi ut"
    }
  ]
}
Query Parameter NameExample
limit-4411508.390263125
lastSeenID-16240579.97259584
id-84016275
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": "exercitation"
    },
    {
      "message": "Lorem do ex pariatur in"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ad",
      "message": "incididunt enim cupidatat proident"
    },
    {
      "error_id": "officia in esse magna",
      "message": "ad reprehenderit ut anim dolor"
    }
  ]
}
{
  "errors": [
    {
      "message": "Excepteur dolor aute"
    },
    {
      "message": "commodo"
    }
  ]
}
Request Payload
{
  "nickname": "Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105"
}
Response Payload
{
  "id": 1234,
  "nickname": "Example Orders",
  "from_email": "orders@example.com",
  "from_name": "Example Orders",
  "reply_to": "orders@example.com",
  "reply_to_name": "Example Orders",
  "address": "1234 Fake St.",
  "address2": "PO Box 1234",
  "state": "CA",
  "city": "San Francisco",
  "country": "USA",
  "zip": "94105",
  "verified": true,
  "locked": false
}
{
  "errors": [
    {
      "error_id": "sunt qui in",
      "field": "elit reprehenderit mollit",
      "message": "ad"
    },
    {
      "error_id": "consectetur dolore exercitation",
      "field": "Excepteur irure do exercitation",
      "message": "commodo fugiat mollit dolore"
    },
    {
      "error_id": "quis ut laboris",
      "field": "laboris enim",
      "message": "Excepteur est velit occaecat in"
    },
    {
      "error_id": "in aliquip nulla ut Excepteur",
      "field": "id",
      "message": "dolore dolor"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "aute voluptate eu",
      "message": "Excepteur sunt adipisicing"
    },
    {
      "error_id": "officia Excepteur",
      "message": "ut reprehenderit commodo anim nisi"
    },
    {
      "error_id": "proident",
      "message": "consectetur in cupidatat Duis"
    },
    {
      "error_id": "commodo aute",
      "message": "voluptate"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "magna laborum Excepteur do et",
      "message": "eiusmod voluptate non commodo"
    },
    {
      "error_id": "officia culpa tempor qui",
      "message": "quis veniam ad"
    },
    {
      "error_id": "nostrud et ut dolore",
      "message": "deserunt occaecat do tempor"
    },
    {
      "error_id": "dolore non commodo",
      "message": "Ut in consectetur"
    }
  ]
}
{
  "errors": [
    {
      "message": "laborum nostrud elit sint"
    },
    {
      "message": "pariatur"
    },
    {
      "message": "do"
    },
    {
      "message": "fugiat proident Excepteur in velit"
    },
    {
      "message": "est proident laborum consequat"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "elit pariatur",
      "message": "labore deserunt in aliquip"
    },
    {
      "error_id": "nostrud",
      "message": "labore do magna"
    },
    {
      "error_id": "dolore aliqua amet proident",
      "message": "sint Ut dolore adipisicing aliquip"
    },
    {
      "error_id": "Lorem",
      "message": "ut culpa"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "nisi laborum",
      "message": "nisi ex"
    }
  ]
}
{
  "errors": [
    {
      "message": "amet ea nulla"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "error_id": "velit Ut",
      "message": "qui"
    },
    {
      "error_id": "aliqua Excepteur anim velit",
      "message": "enim"
    },
    {
      "error_id": "velit veniam",
      "message": "in ad tempor in"
    },
    {
      "error_id": "occaecat deserunt ad",
      "message": "aliqua officia"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "culpa ut veniam dolor ex",
      "message": "eu"
    },
    {
      "error_id": "in laboris ea",
      "message": "laborum aliqua irure Lorem"
    },
    {
      "error_id": "ipsum deserunt",
      "message": "esse cupidatat reprehenderit minim pariatur"
    }
  ]
}
{
  "errors": [
    {
      "message": "in culpa sint sunt deserunt"
    },
    {
      "message": "Ut occaecat qui"
    }
  ]
}

Designs API(9 operations)

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

Contacts(13 operations)

Request Payload
{
  "contacts": [
    {
      "address_line_1": "sed ut",
      "address_line_2": "veli",
      "alternate_emails": [
        "quis id irure officia consequat",
        "non nulla",
        "nulla do minim sunt",
        "ut Duis quis",
        "reprehend"
      ],
      "city": "minim",
      "country": "velit",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "occaecat magna amet reprehenderit ipsum",
      "first_name": "Lorem proident",
      "last_name": "eiusmod ut ad officia id",
      "postal_code": "nulla magna eu reprehenderit",
      "state_province_region": "irure aute el"
    },
    {
      "address_line_1": "labore Lorem sint dolore adipisicing",
      "address_line_2": "aliquip Excepteur",
      "alternate_emails": [
        "dolore Excepteur dolor tempor laboris",
        "dolore aliquip magna exercitation",
        "velit",
        "Ut non elit exercitation cupidatat",
        "ut"
      ],
      "city": "amet",
      "country": "sunt labore",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "magna mol",
      "first_name": "non esse",
      "last_name": "conse",
      "postal_code": "elit",
      "state_province_region": "reprehenderit esse anim "
    },
    {
      "address_line_1": "Excepteur ea ut ullamco",
      "address_line_2": "deserunt",
      "alternate_emails": [
        "veniam sed pariatur magna do",
        "veniam quis reprehenderit minim",
        "labore occaecat eiusmod ut commodo",
        "nostrud aliquip sint",
        "culpa sit eiusmod voluptate aliquip"
      ],
      "city": "l",
      "country": "adipisicing Ut dolor laborum",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "velit",
      "first_name": "nisi amet reprehende",
      "last_name": "sint veni",
      "postal_code": "aliqua commodo nostrud",
      "state_province_region": "vo"
    },
    {
      "address_line_1": "sit anim elit",
      "address_line_2": "ut et",
      "alternate_emails": [
        "laboris in non irure ut",
        "in aliquip minim irure",
        "deserunt commodo par",
        "nulla cupidatat",
        "nulla nisi id pariatur ad"
      ],
      "city": "cupidatat ut",
      "country": "enim id consectetur",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "",
      "first_name": "Lorem magna exercitation ad",
      "last_name": "proident exercitat",
      "postal_code": "id enim aute",
      "state_province_region": "commodo fugiat quis pariatur ut"
    },
    {
      "address_line_1": "velit",
      "address_line_2": "Excepteur in officia",
      "alternate_emails": [
        "amet laborum",
        "ullamco dolore nisi aute",
        "do eu",
        "non amet",
        "proident"
      ],
      "city": "sunt sed consectetur dolore nisi",
      "country": "laboris c",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "sunt pariatur in mollit occaecat",
      "first_name": "laboris al",
      "last_name": "mollit nostrud",
      "postal_code": "mollit do aute sit minim",
      "state_province_region": "qui amet irure mollit dolor"
    },
    {
      "address_line_1": "enim proident ad amet",
      "address_line_2": "sunt laboris",
      "alternate_emails": [
        "mollit",
        "labore Excepteur elit",
        "dolor dolore",
        "cupidatat Lorem laboris sint occaecat",
        "aute"
      ],
      "city": "minim",
      "country": "nisi",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "sed",
      "first_name": "cillum dolore fugiat reprehend",
      "last_name": "aute ut ex",
      "postal_code": "id commodo incididunt",
      "state_province_region": "ut do"
    },
    {
      "address_line_1": "ipsum elit",
      "address_line_2": "commodo incididunt",
      "alternate_emails": [
        "velit nostrud ipsum Excepteur aliquip",
        "deserunt veniam mollit",
        "pariatur ex magna proident",
        "sit labore proident",
        "aliquip sed non ut"
      ],
      "city": "sed Duis proident nostrud",
      "country": "in esse enim nost",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "ad eu",
      "first_name": "",
      "last_name": "in magna cillum quis",
      "postal_code": "laborum consectetur est",
      "state_province_region": "ex"
    },
    {
      "address_line_1": "irure",
      "address_line_2": "velit voluptate sint",
      "alternate_emails": [
        "dolor ex deserunt",
        "Duis officia irure",
        "aliqua proident nulla",
        "incididunt dolore do",
        "est non"
      ],
      "city": "officia labore",
      "country": "nostrud",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "mollit ad dolor",
      "first_name": "",
      "last_name": "enim",
      "postal_code": "consectetur occaecat enim minim",
      "state_province_region": "quis et"
    },
    {
      "address_line_1": "aute aliquip",
      "address_line_2": "anim nisi esse in est",
      "alternate_emails": [
        "sed qui deserunt tempor",
        "ex tempor elit et aute",
        "dolor minim dolore quis ea",
        "est qui cillum magna",
        "eu ullamco et dolor"
      ],
      "city": "repre",
      "country": "irure commodo enim Ut pariatur",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "eiusmod eu pariatur nostrud",
      "first_name": "sunt",
      "last_name": "qui et aute u",
      "postal_code": "commodo dolor aliqua",
      "state_province_region": "offi"
    },
    {
      "address_line_1": "laborum venia",
      "address_line_2": "in ad aliquip ea",
      "alternate_emails": [
        "in culpa proident amet",
        "commodo esse Excepteur nulla ut",
        "elit eiusmod occaecat enim Excepteur",
        "incididunt culpa ipsum",
        "exercitation"
      ],
      "city": "ut nisi enim",
      "country": "oc",
      "custom_fields": {
        "e2": "Coffee is a beverage that puts one to sleep when not drank.",
        "w1": "2002-10-02T15:00:00Z",
        "w33": 9.5
      },
      "email": "in in nulla eu fugiat",
      "first_name": "nostrud",
      "last_name": "Ut incididu",
      "postal_code": "in cillum sit eu Lorem",
      "state_province_region": "officia cillum velit"
    }
  ],
  "list_ids": [
    "5380bf09-9102-9205-9a80-350e4cc9f1c7"
  ]
}
Response Payload
{
  "job_id": "consectetur tempor"
}
{
  "errors": [
    {
      "error_id": "irure Duis",
      "field": "dolor dolor",
      "message": "irure cupidatat",
      "parameter": "irure Duis nostrud ipsum in"
    },
    {
      "error_id": "occaecat irure",
      "field": "cillum do et aute",
      "message": "ut ut mollit exercitation",
      "parameter": "in magna cillum consectetur fugiat"
    },
    {
      "error_id": "aute",
      "field": "aliqua incididunt laboris culpa ipsum",
      "message": "esse magna commodo dolore aliquip",
      "parameter": "Duis laboris occaecat eu"
    },
    {
      "error_id": "anim enim reprehenderit",
      "field": "et in aliqua in",
      "message": "sunt sint tempor",
      "parameter": "eiusmod fugiat"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "exercitation ut nisi magna deserunt"
    },
    {
      "message": "commodo ad veniam"
    },
    {
      "message": "nisi incididunt in dolore"
    },
    {
      "message": "reprehenderit"
    },
    {
      "message": "qui voluptate dolor sint ad"
    }
  ]
}
Query Parameter NameExample
delete_all_contactsnulla irure ea sint
idsfugiat ut consequat sed
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": "culpa aute sed ipsum cupidatat"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "self": "non pariatur amet reprehenderit dolore"
  },
  "contact_count": 40006442,
  "result": [
    {
      "_metadata": {
        "self": "elit occaecat non dolor"
      },
      "address_line_1": "eu cupidatat irure anim magna",
      "address_line_2": "adipisicing id sunt culpa",
      "alternate_emails": [
        "nulla",
        "fugiat Excepteur consequat",
        "aute",
        "et sunt labore",
        "ex"
      ],
      "city": "non",
      "country": "exercitation ipsum magna dolore occaecat",
      "created_at": "Ut dolore cillum ad cupidatat",
      "custom_fields": {},
      "email": "officia enim veniam ad",
      "facebook": "ex eu dolore laborum",
      "first_name": "dolore",
      "id": "nisi nulla amet dolore laboris",
      "last_name": "Duis",
      "line": "dolore occaecat Lorem velit",
      "list_ids": [
        "id dolore",
        "tempor exercitation Lorem",
        "tempor proident adipisicing",
        "Excepteur velit ex",
        "dolore magna quis non in"
      ],
      "phone_number": "in",
      "postal_code": "consectetur laboris",
      "segment_ids": [
        "voluptate exercitation",
        "aute in nisi minim aliqua",
        "velit in",
        "reprehenderit veniam eu"
      ],
      "state_province_region": "aute qui",
      "unique_name": "esse",
      "updated_at": "incididunt ut",
      "whatsapp": "voluptate pariatur"
    },
    {
      "_metadata": {
        "self": "laboris sit ea non proident"
      },
      "address_line_1": "cillum dolore consectetur quis eu",
      "address_line_2": "non in labore sit",
      "alternate_emails": [
        "qui aliquip nulla eu est"
      ],
      "city": "eu",
      "country": "enim magna mollit",
      "created_at": "consequat magna cupidatat ipsum",
      "custom_fields": {},
      "email": "officia Duis",
      "facebook": "eu consequat",
      "first_name": "nostrud dolore eu",
      "id": "mollit exercitation laboris veniam",
      "last_name": "eu sint consectetur id ullamco",
      "line": "ut sint nostrud eiusmod non",
      "list_ids": [
        "in",
        "cillum aliqua Excepteur dolor commodo",
        "dolor exercitation elit",
        "quis ipsum amet mollit"
      ],
      "phone_number": "anim ex Excepteur id",
      "postal_code": "anim aliqua",
      "segment_ids": [
        "ullamco dolore"
      ],
      "state_province_region": "voluptate eu Lorem et do",
      "unique_name": "ipsum eu nisi incididunt",
      "updated_at": "pariatur cillum",
      "whatsapp": "et magna"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "occaecat eiusmod voluptate magna ut",
      "field": "anim sint deserunt eu",
      "message": "cillum ea eu",
      "parameter": "in nisi in dolor"
    },
    {
      "error_id": "Excepteur occaecat adipisicing et incididunt",
      "field": "reprehenderit laborum elit id sunt",
      "message": "ex",
      "parameter": "Excepteur velit ipsum do"
    },
    {
      "error_id": "voluptate proident eiusmod in sunt",
      "field": "ad",
      "message": "culpa ut Duis ipsum",
      "parameter": "officia tempor do dolore"
    },
    {
      "error_id": "adipisicing ipsum",
      "field": "dolore do consectetur",
      "message": "proident qui laborum",
      "parameter": "in occaecat velit cillum qui"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "veniam qui in sunt"
    },
    {
      "message": "dolore elit"
    },
    {
      "message": "proident elit reprehenderit mollit"
    },
    {
      "message": "ex aliqua et ad"
    },
    {
      "message": "Excepteur commodo"
    }
  ]
}
Request Payload
Response Payload
{
  "billable_breakdown": {
    "breakdown": {},
    "total": 53921431
  },
  "billable_count": 27092480,
  "contact_count": 44027363
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "in est ullamco"
    }
  ]
}
Request Payload
{
  "file_type": "csv",
  "list_ids": [
    "83cae508-0f32-5b98-3934-ce2f27c00b1b",
    "0f3b995b-73a1-39ab-019d-b601ee03e2d4",
    "01cc1f81-79d8-10c6-ec3a-92260e04d6d2",
    "2654a0e9-c7e1-286b-0c78-302559aa0f41",
    "7ecf51e4-0349-c7e6-1919-8b8369aa33e2"
  ],
  "max_file_size": 3415214,
  "notifications": {
    "email": true
  },
  "segment_ids": [
    "cillum proident magna"
  ]
}
Response Payload
{
  "_metadata": {
    "count": -85682633.72444975,
    "next": "https://UukxlYQgKrSFiHukmxhiNdlRFxkZL.tktbrfSpT.Dvx-QlWKECZ62-OAICsRTzG7XsZ",
    "prev": "http://iiWJRHD.hmoeqvRguVCcsEdHtQkBWe4n5GWgfcIZx4",
    "self": "http://cgZHFCcQMhonOekNwLwRKSBFvC.klhHbTqQQikuKo.D0FD9.xMN"
  },
  "id": "culpa esse"
}
{
  "errors": [
    {
      "error_id": "occaecat mollit",
      "field": "laboris do occaecat",
      "message": "ea eu deserunt",
      "parameter": "ea dolor ullamco exercitation"
    },
    {
      "error_id": "ut aliquip",
      "field": "aliquip eu adipisicing nisi reprehenderit",
      "message": "eiusmod eu est reprehenderit",
      "parameter": "sint eiusmod"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "laboris sed elit cillum"
    },
    {
      "message": "tempor elit laboris"
    },
    {
      "message": "ullamco minim qui in"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "next": "in magna veniam ipsum aliquip",
    "prev": "cupidatat voluptate dolor",
    "self": "adipisicing cupidatat dolore laboris"
  },
  "result": [
    {
      "_metadata": {
        "next": "laboris quis",
        "prev": "sint id ut non",
        "self": "dolor esse nisi elit et"
      },
      "completed_at": "irure",
      "created_at": "Excepteur sunt cupidatat",
      "expires_at": "in velit Excepteur commodo",
      "export_type": "Excepteur dolore sed",
      "id": "exercitation incididunt minim",
      "lists": [
        {
          "ID": "anim occaecat Duis in",
          "Name": "tempor sed adipisicing officia"
        },
        {
          "ID": "pariatur",
          "Name": "laboris"
        },
        {
          "ID": "labore ex velit est dolor",
          "Name": "do dolore esse aute"
        }
      ],
      "segments": [
        {
          "ID": "in aliquip dolor minim",
          "Name": "deserunt veniam ullamco"
        },
        {
          "ID": "Ut aliqua",
          "Name": "in velit adipisicing Excepteur"
        },
        {
          "ID": "ad laborum sunt proident",
          "Name": "Duis"
        },
        {
          "ID": "labore in anim",
          "Name": "Lorem proident fugiat sint consectetur"
        }
      ],
      "status": "in ex",
      "urls": [
        "cupidatat"
      ],
      "user_id": "reprehenderit elit cillum sit eiusmod"
    },
    {
      "_metadata": {
        "next": "qui culpa",
        "prev": "incididunt",
        "self": "veniam nulla do sint"
      },
      "completed_at": "in ad nostrud",
      "created_at": "veniam",
      "expires_at": "do sint dolor irure consectetur",
      "export_type": "in magna",
      "id": "proident dolore",
      "lists": [
        {
          "ID": "commodo labore consectetur nisi",
          "Name": "nostrud quis"
        },
        {
          "ID": "dolor commodo anim ipsum aliquip",
          "Name": "commodo veniam"
        },
        {
          "ID": "ullamco eu laborum anim aliqua",
          "Name": "aliquip magna Ut"
        },
        {
          "ID": "mollit ut nulla",
          "Name": "commodo aliquip veniam in pariatur"
        }
      ],
      "segments": [
        {
          "ID": "incididunt veniam dolore Lorem sint",
          "Name": "est proident incididunt quis"
        }
      ],
      "status": "do non ea voluptate",
      "urls": [
        "in minim fugiat officia cillum",
        "ut",
        "mollit dolor reprehenderit"
      ],
      "user_id": "anim id ut cillum"
    },
    {
      "_metadata": {
        "next": "culpa sit",
        "prev": "Ut ea cupidatat dolore nulla",
        "self": "nulla Duis"
      },
      "completed_at": "pariatur exercitation ex dolore sed",
      "created_at": "anim quis magna do laboris",
      "expires_at": "nisi aliquip adipisicing in tempor",
      "export_type": "sed adipisicing commodo proident amet",
      "id": "ut reprehenderit nulla",
      "lists": [
        {
          "ID": "deserunt",
          "Name": "ut"
        },
        {
          "ID": "Ut",
          "Name": "aliquip deserunt ullamco"
        }
      ],
      "segments": [
        {
          "ID": "nulla",
          "Name": "aliqua velit sint"
        },
        {
          "ID": "ut consequat incididunt commodo",
          "Name": "ad sint laboris id pariatur"
        },
        {
          "ID": "ut",
          "Name": "voluptate"
        },
        {
          "ID": "dolore in id anim ipsum",
          "Name": "in occaecat"
        }
      ],
      "status": "in Ut ut labore sunt",
      "urls": [
        "Ut nulla",
        "dolor",
        "non Lorem quis aliqua deserunt"
      ],
      "user_id": "consectetur"
    },
    {
      "_metadata": {
        "next": "ut et fugiat sed",
        "prev": "laborum dolor",
        "self": "adipisicing"
      },
      "completed_at": "pariatur occaecat ut",
      "created_at": "irure",
      "expires_at": "ullamco laborum",
      "export_type": "exercitation veniam",
      "id": "ad do est",
      "lists": [
        {
          "ID": "magna Excepteur non sed",
          "Name": "eiusmod non adipisicing velit"
        },
        {
          "ID": "laborum dolore Lorem id quis",
          "Name": "mollit sit Lorem anim"
        }
      ],
      "segments": [
        {
          "ID": "Duis Ut occaecat sit",
          "Name": "commodo adipisicing"
        },
        {
          "ID": "elit ullamco qui eiusmod Lorem",
          "Name": "dolore Excepteur amet reprehenderit"
        }
      ],
      "status": "Ut enim laborum Duis",
      "urls": [
        "exercitation culpa"
      ],
      "user_id": "pariatur anim consequat"
    }
  ]
}
{
  "errors": [
    {
      "": "in sunt ut",
      "error_id": "anim sed quis et",
      "message": "aliquip nisi do irure sunt"
    },
    {
      "": "sunt culpa magna anim",
      "error_id": "sit ut",
      "message": "sint nisi in tempor"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "velit est cillum Lorem veniam"
    },
    {
      "message": "deserunt"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "self": "cillum est proident"
  },
  "address_line_1": "nisi dolore ad",
  "address_line_2": "commodo irure occaecat minim",
  "alternate_emails": [
    "deserunt exercitation tempor",
    "sed quis",
    "qui adipisicing id",
    "culpa adipisicing officia Excepteur sunt"
  ],
  "city": "dolore minim voluptate",
  "country": "laborum commodo deserunt veniam",
  "created_at": "dolore est non quis",
  "custom_fields": {},
  "email": "fugiat aliquip",
  "facebook": "quis in cupidatat aliquip",
  "first_name": "adipisicing sunt do",
  "id": "Lorem",
  "last_name": "ad sint ipsum",
  "line": "sed sit",
  "list_ids": [
    "reprehenderit",
    "minim ut consequat et in",
    "tempor",
    "magna et ullamco",
    "esse ad"
  ],
  "phone_number": "do magna",
  "postal_code": "labore pariatur consequat",
  "segment_ids": [
    "do sunt aliquip"
  ],
  "state_province_region": "consectetur mollit",
  "unique_name": "sint enim consequat exercitation",
  "updated_at": "consequat ex ullamco enim Duis",
  "whatsapp": "sed do veniam officia"
}
{
  "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": "sunt ex"
    },
    {
      "message": "anim"
    }
  ]
}
Request Payload
{
  "query": "email LIKE 'ENTER_COMPLETE_OR_PARTIAL_EMAIL_ADDRESS_HERE%' AND CONTAINS(list_ids, 'YOUR_LIST_IDs')"
}
Response Payload
{
  "_metadata": {
    "self": "in in magna do enim"
  },
  "contact_count": -47621685.44969212,
  "result": [
    {
      "_metadata": {
        "self": "officia aliqua"
      },
      "address_line_1": "minim esse anim",
      "address_line_2": "aliquip minim ea",
      "alternate_emails": [
        "est"
      ],
      "city": "laboris labore",
      "country": "ea nostrud",
      "created_at": "cillum consequat laboris est",
      "custom_fields": {},
      "email": "ipsum occaecat laboris",
      "facebook": "adipisicing nisi Lorem aute non",
      "first_name": "culpa",
      "id": "velit cupidatat",
      "last_name": "irure dolore ipsum ut cillum",
      "line": "aliqua ut elit Excepteur",
      "list_ids": [
        "consequat incididunt et in",
        "eiusmod consectetur nulla pariatur",
        "officia incididunt enim",
        "eu nulla tempor"
      ],
      "phone_number": "culpa",
      "postal_code": "Ut minim est nisi",
      "segment_ids": [
        "ea minim fugiat",
        "id laborum sint pariatur",
        "deserunt proident ullamco dolore consequat",
        "id in reprehenderit"
      ],
      "state_province_region": "cillum pariatur elit",
      "unique_name": "minim reprehenderit",
      "updated_at": "irure",
      "whatsapp": "labore aliquip magna"
    },
    {
      "_metadata": {
        "self": "laborum labore dolore Excepteur"
      },
      "address_line_1": "reprehenderit",
      "address_line_2": "sint",
      "alternate_emails": [
        "laborum ea aliqua irure dolor",
        "tempor do eu"
      ],
      "city": "occaecat irure commodo nostrud",
      "country": "ut",
      "created_at": "sit ad id",
      "custom_fields": {},
      "email": "Duis officia",
      "facebook": "nulla dolore",
      "first_name": "commodo",
      "id": "mollit ut elit",
      "last_name": "Lorem laborum nisi qui cupidatat",
      "line": "irure dolor consectetur",
      "list_ids": [
        "eiusmod"
      ],
      "phone_number": "qui",
      "postal_code": "labore ut adipisicing",
      "segment_ids": [
        "dolore dolore officia",
        "dolore consectetur Ut ad Excepteur",
        "ea non et nulla esse",
        "incididunt sint"
      ],
      "state_province_region": "occaecat",
      "unique_name": "dolore",
      "updated_at": "voluptate aliqua id",
      "whatsapp": "aliquip laboris non sit sint"
    },
    {
      "_metadata": {
        "self": "nisi dolore id magna tempor"
      },
      "address_line_1": "veniam qui",
      "address_line_2": "sed ullamco",
      "alternate_emails": [
        "irure est pariatur",
        "laboris",
        "labore cillum cupidatat in"
      ],
      "city": "magna velit amet in",
      "country": "ut nulla id",
      "created_at": "dolor quis proident pariatur fugiat",
      "custom_fields": {},
      "email": "sed",
      "facebook": "ullamco magna ipsum deserunt",
      "first_name": "laborum qui sit reprehenderit",
      "id": "eu est commodo",
      "last_name": "adipisicing incididunt",
      "line": "sed Ut qui adipisicing",
      "list_ids": [
        "exercitation mollit",
        "do elit dolor anim",
        "adipisicing in ut",
        "laboris dolor"
      ],
      "phone_number": "consequat quis fugiat dolor",
      "postal_code": "consectetur sunt ut dolore minim",
      "segment_ids": [
        "culpa in",
        "velit do anim amet nisi",
        "ea pariatur Ut",
        "cillum aliquip consequat sed deserunt",
        "id"
      ],
      "state_province_region": "qui ut",
      "unique_name": "ex in sint nostrud",
      "updated_at": "occaecat ut exercitation",
      "whatsapp": "Excepteur fugiat"
    }
  ]
}
{
  "errors": [
    {
      "field": "aute ut aliquip deserunt",
      "message": "et cillum non ad sint"
    }
  ]
}
{
  "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": "mollit exercitation enim ex officia"
    },
    {
      "message": "dolor esse do"
    },
    {
      "message": "ad sit sint"
    },
    {
      "message": "irure laboris commodo culpa"
    },
    {
      "message": "cupidatat nulla nisi ut pariatur"
    }
  ]
}
Request Payload
{
  "field_mappings": [
    "dolor sint",
    null,
    null
  ],
  "file_type": "csv",
  "list_ids": [
    "dolor reprehenderit qui dolor do"
  ]
}
Response Payload
{
  "job_id": "aute Ut tempor",
  "upload_headers": [
    {
      "header": "ullamco deserunt",
      "value": "in commodo est Lorem velit"
    },
    {
      "header": "aliqua",
      "value": "voluptate qui sed"
    },
    {
      "header": "laborum et",
      "value": "in dolor consectetur consequat irure"
    },
    {
      "header": "ea dolor",
      "value": "labore aute sed"
    },
    {
      "header": "incididunt",
      "value": "nostrud"
    }
  ],
  "upload_uri": "cillum do"
}
{
  "errors": [
    {
      "error_id": "eiusmod laboris",
      "field": "et",
      "message": "proident",
      "parameter": "in aliquip"
    },
    {
      "error_id": "dolor",
      "field": "velit",
      "message": "ea esse",
      "parameter": "mollit ex veniam Ut in"
    },
    {
      "error_id": "id pariatur in ex",
      "field": "ut aute incididunt dolor id",
      "message": "cillum occaecat irure est ut",
      "parameter": "consectetur"
    },
    {
      "error_id": "minim occaecat amet",
      "field": "esse in sunt",
      "message": "occaecat in anim sit",
      "parameter": "Ut non"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "aute adipisicing reprehenderit tempor consectetur",
      "field": "est consequat Duis",
      "message": "occaecat Excepteur cupidatat ea",
      "parameter": "do officia mollit adipisicing"
    },
    {
      "error_id": "sit dolor ad consectetur",
      "field": "Duis ipsum dolor labore sit",
      "message": "veniam pariatur cillum velit minim",
      "parameter": "eiusmod"
    },
    {
      "error_id": "Ut cillum fugiat aliquip",
      "field": "tempor eiusmod minim Ut sit",
      "message": "tempor",
      "parameter": "amet velit enim eu"
    }
  ]
}
{
  "errors": [
    {
      "message": "cupidatat nulla magna ea adipisicing"
    }
  ]
}
Request Payload
Response Payload
{
  "finished_at": "Excepteur",
  "id": "ex quis voluptate",
  "job_type": "aliqua",
  "results": {
    "created_count": 50470040.4338803,
    "deleted_count": -31640155.585360706,
    "errored_count": -51195566.47866763,
    "errors_url": "nostrud",
    "requested_count": -78938815.61821505,
    "updated_count": -69264364.50146544
  },
  "started_at": "irure in veniam",
  "status": "ea"
}
{
  "errors": {
    "error_id": "incididunt ut",
    "field": "do in qui",
    "message": "voluptate in proident quis",
    "parameter": "occaecat proident"
  }
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "anim pariatur consectetur ex"
    },
    {
      "message": "nostrud aliqua pariatur qui commodo"
    },
    {
      "message": "veniam exercitation dolor id mollit"
    }
  ]
}
Request Payload
Response Payload
{
  "_metadata": {
    "count": 74355264.46184474,
    "next": "https://Y.hvwd-U5zewWqsc7dkU,-qB",
    "prev": "http://nMEmFCJYmhVPLMjES.mrdbJ4HZqLQhwYuVCT3sKfw2",
    "self": "https://soylZrSLlRnvZANYiNgJsFMFrTySpqzqW.mltlwcFQ+D785kcztwwczlkR7KiqfhJ31BAnkwgqre1OICVKKJoFRnAr8j-US"
  },
  "completed_at": "laboris aliquip",
  "contact_count": 56303210,
  "created_at": "dolor ipsum veniam exercitation",
  "expires_at": "id labore sit do cillum",
  "id": "quis aliqua Ut eiusmod",
  "message": "laborum veniam Duis",
  "status": "failure",
  "updated_at": "ipsum occaecat Lorem fugiat",
  "urls": [
    "laboris velit ut",
    "amet in officia sed Duis",
    "consectetur",
    "aliquip",
    "culpa magna"
  ]
}
{
  "errors": [
    {
      "error_id": "incididunt magna ex dolore culpa",
      "field": "tempor minim ullamco irure commodo",
      "message": "mollit",
      "parameter": "tempor quis est"
    },
    {
      "error_id": "sint laborum",
      "field": "in Ut nostrud",
      "message": "pariatur occaecat cillum enim",
      "parameter": "ea elit commodo veniam nostrud"
    },
    {
      "error_id": "Lorem aliqua culpa voluptate",
      "field": "fugiat",
      "message": "dolore mollit pariatur consequat",
      "parameter": "velit consectetur anim in irure"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "fugiat eu incididunt culpa velit"
    }
  ]
}
Request Payload
{
  "ids": [
    "1234",
    "1235"
  ]
}
Response Payload
{
  "result": [
    {
      "_metadata": {
        "self": "consectetur"
      },
      "address_line_1": "ipsum exercitation",
      "address_line_2": "in consectetur",
      "alternate_emails": [
        "laborum",
        "consequat dolor eiusmod Duis cillum",
        "sit magna"
      ],
      "city": "eiusmod aliquip in sed",
      "country": "culpa sed veniam magna incididunt",
      "created_at": "amet Lorem sint aliquip",
      "custom_fields": {},
      "email": "officia",
      "facebook": "incididunt",
      "first_name": "et",
      "id": "laborum enim",
      "last_name": "incididunt velit esse",
      "line": "nisi Ut",
      "list_ids": [
        "non reprehenderit ad aliqua aliquip",
        "labore eiusmod ut",
        "irure dolor"
      ],
      "phone_number": "cillum velit anim aliquip minim",
      "postal_code": "ipsum reprehenderit sunt tempor laboris",
      "segment_ids": [
        "do Ut minim Lorem",
        "eiusmod proident Ut",
        "Ut",
        "qui occaecat",
        "pariatur cillum Ut in"
      ],
      "state_province_region": "quis",
      "unique_name": "consequat commodo proident aliquip ut",
      "updated_at": "velit pariatur dolore aliquip",
      "whatsapp": "commodo sunt ullamco elit officia"
    },
    {
      "_metadata": {
        "self": "pariatur in"
      },
      "address_line_1": "do Ut cillum est dolore",
      "address_line_2": "laboris culpa non",
      "alternate_emails": [
        "ad",
        "eu id consectetur Duis",
        "proident commodo nostrud"
      ],
      "city": "anim fugiat Duis in consequat",
      "country": "laborum et cillum",
      "created_at": "tempor ad cillum",
      "custom_fields": {},
      "email": "anim sed consequat",
      "facebook": "enim tempor",
      "first_name": "nostrud aliqua minim magna ex",
      "id": "dolor",
      "last_name": "exercitation dolor deserunt Ut ut",
      "line": "enim et incididunt",
      "list_ids": [
        "labore do sit sint eu",
        "ea exercitation"
      ],
      "phone_number": "ex adipisicing Lorem ut",
      "postal_code": "mollit amet occaecat dolor",
      "segment_ids": [
        "ut magna",
        "elit"
      ],
      "state_province_region": "nisi in eiusmod esse",
      "unique_name": "ipsum irure ut",
      "updated_at": "minim in tempor",
      "whatsapp": "laboris do reprehenderit"
    },
    {
      "_metadata": {
        "self": "ea ut culpa sint eu"
      },
      "address_line_1": "Duis adipisicing",
      "address_line_2": "eiusmod Excepteur fugiat ut",
      "alternate_emails": [
        "dolor",
        "fugiat culpa elit eu",
        "mollit proident do",
        "in"
      ],
      "city": "Excepteur nostrud in consequat est",
      "country": "laboris deserunt occaecat",
      "created_at": "nulla Excepteur sed",
      "custom_fields": {},
      "email": "ea ipsum irure officia",
      "facebook": "reprehenderit enim exercitation ullamco mollit",
      "first_name": "amet",
      "id": "aliquip dolore",
      "last_name": "dolor",
      "line": "dolore ullamco minim Excepteur sit",
      "list_ids": [
        "ut culpa do",
        "mollit do veniam eiusmod",
        "deserunt"
      ],
      "phone_number": "irure Duis aute sint",
      "postal_code": "non Ut occaecat elit aliquip",
      "segment_ids": [
        "in",
        "dolore irure officia Lorem esse",
        "minim",
        "minim cillum",
        "elit aliquip occaecat laboris"
      ],
      "state_province_region": "velit",
      "unique_name": "fugiat aliqua exercitation reprehenderit eiusmod",
      "updated_at": "enim dolor",
      "whatsapp": "elit fugiat ut cupidatat"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
{
  "errors": [
    {
      "message": "laboris eu occaecat pariatur"
    },
    {
      "message": "ut elit aliquip"
    },
    {
      "message": "mollit"
    },
    {
      "message": "do id sunt quis Excepteur"
    },
    {
      "message": "labore cillum consequat pariatur"
    }
  ]
}
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": "nostrud ipsum ex"
    },
    {
      "message": "aliquip"
    },
    {
      "message": "proident non sunt sed commodo"
    },
    {
      "message": "veniam dolor"
    }
  ]
}

Segmenting Contacts V2 - Beta(5 operations)

Request Payload
{
  "name": "in dolore labore non",
  "parent_list_ids": [
    "mollit",
    "fugiat tempor voluptate ea",
    "cillum ea",
    "minim ut",
    "ex et in"
  ],
  "query_dsl": "exercitation"
}
Response Payload
{
  "contacts_count": 47437091,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "eiusmod est culpa Ut",
  "id": "d33c86cd-b605-87e3-9f27-213f37b1734f",
  "name": "commodo ",
  "next_sample_update": "commodo",
  "parent_list_ids": [
    "dolore eu laboris",
    "elit ex commodo non nostrud",
    "exercitation in"
  ],
  "query_dsl": "culpa irure consectetur occaecat consequat",
  "query_version": "eiusmod",
  "sample_updated_at": "eiusmod",
  "status": {
    "error_message": "ipsum aute quis in voluptate",
    "query_validation": "voluptate id est laborum"
  },
  "updated_at": "in sint quis"
}
{
  "errors": [
    {
      "field": "elit sunt labore nisi irure",
      "message": "aliqua dolore Ut aute"
    },
    {
      "field": "dolore irure",
      "message": "veniam sint ex non"
    },
    {
      "field": "culpa reprehenderit aliqua magna Ut",
      "message": "labore eiusmod"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "id officia anim",
      "message": "dolore"
    },
    {
      "field": "qui et quis nostrud",
      "message": "culpa nisi"
    },
    {
      "field": "voluptate non ullamco",
      "message": "cupidatat consectetur nulla Ut"
    }
  ]
}
Query Parameter NameExample
parent_list_idslabore eu
no_parent_list_idtrue
Request Payload
Response Payload
{
  "_metadata": {
    "count": 75323900,
    "next": "https://bwsrvlxtjV.ieoneAm-yWnyd4vGs5aNWwBU-",
    "prev": "http://mbENQjZwxiZCGoIfUXcMbDrtUs.cfgttYFki+JW2IPVGDIEPGmXL0ow",
    "self": "http://nLxZNVYxIVIQhHkIqsapV.msjdm5B-chIvub"
  },
  "contacts_count": 84022794,
  "created_at": "officia dolor occaecat",
  "id": "7f78cc69-a618-195f-9fd1-fbc0ed479c80",
  "name": "dolor",
  "next_sample_update": "minim laboris enim nostrud",
  "parent_list_ids": [
    "in mollit",
    "deserunt dolor",
    "veniam"
  ],
  "query_version": "cillum",
  "sample_updated_at": "exercitation commodo",
  "status": {
    "error_message": "nostrud ullamco",
    "query_validation": "mollit ea voluptate reprehenderit"
  },
  "updated_at": "ipsum sunt"
}
{
  "errors": [
    {
      "field": "eiusmod laborum esse consectetur et",
      "message": "ipsum sint"
    },
    {
      "field": "fugiat consectetur",
      "message": "nulla ex eu"
    },
    {
      "field": "deserunt",
      "message": "enim nostrud Lorem incididunt"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "nulla cillum",
      "message": "aliquip Lorem enim aliqua"
    },
    {
      "field": "est",
      "message": "eiusmod cillum nostrud"
    },
    {
      "field": "pariatur tempor in esse proident",
      "message": "dolore esse proident"
    },
    {
      "field": "cupidatat ut",
      "message": "sed ea"
    }
  ]
}
Request Payload
{
  "name": "a",
  "query_dsl": "incididunt ex sint"
}
Response Payload
{
  "contacts_count": 73459922,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "dolore",
  "id": "6f4b8f7c-c4ee-2534-4365-4e6438bf1016",
  "name": "adipisicing est do mollit nostrud",
  "next_sample_update": "fugiat deserunt",
  "parent_list_ids": [
    "ea labore culpa laborum",
    "magna adipisicing",
    "ut qui sunt"
  ],
  "query_dsl": "pariatur ex non",
  "query_version": "ipsum proident id",
  "sample_updated_at": "consectetur ut nulla fugiat quis",
  "status": {
    "error_message": "adipisicing deserunt et",
    "query_validation": "occaecat magna veniam culpa elit"
  },
  "updated_at": "ad pariatur"
}
{
  "errors": [
    {
      "field": "laborum",
      "message": "eiusmod"
    },
    {
      "field": "sed pariatur minim",
      "message": "quis incididunt ut"
    },
    {
      "field": "ipsum",
      "message": "aliquip"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "veniam eu pariatur ut sunt",
      "message": "nostrud minim Ut"
    },
    {
      "field": "non sunt",
      "message": "ea tempor in"
    },
    {
      "field": "sit aliquip consectetur Ut elit",
      "message": "sit ullamco non sed id"
    },
    {
      "field": "voluptate consequat cupidatat",
      "message": "do"
    }
  ]
}
Query Parameter NameExample
contacts_sampletrue
Request Payload
Response Payload
{
  "contacts_count": -16495272,
  "contacts_sample": [
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    },
    {
      "address_line_1": "street address / P.O. box / CompanyName / c/o",
      "address_line_2": "apartment, suite, unit, building, floor etc",
      "alternate_emails": [
        "abcd@yahoo.com",
        "abcd@hotmail.com"
      ],
      "city": "Redwood City",
      "country": "USA",
      "custom_fields": {
        "custom_field_name1": "custom_field_value1",
        "custom_field_name2": "custom_field_value2"
      },
      "email": "abcd@gmail.com",
      "first_name": "Ab",
      "id": "47d23ab0-d895-4359-a0d1-ffc7a6fc7e70",
      "last_name": "Cd",
      "postal_code": 94063,
      "state_province_region": "CA"
    }
  ],
  "created_at": "labore dolor ipsum Excepteur sed",
  "id": "bc33868e-d304-a67b-9626-d4654f9e0d53",
  "name": "sunt",
  "next_sample_update": "in aute occaecat nisi dolor",
  "parent_list_ids": [
    "pariatur culpa labore irure eu",
    "commodo tempor laborum",
    "Ut ut commodo aliquip",
    "tempor",
    "amet dolore pariatur velit"
  ],
  "query_dsl": "officia id",
  "query_version": "enim",
  "sample_updated_at": "et in",
  "status": {
    "error_message": "in",
    "query_validation": "consectetur eu"
  },
  "updated_at": "deserunt incididunt veniam ex ullamco"
}
{
  "errors": [
    {
      "field": "magna",
      "message": "nisi aliqua"
    }
  ]
}
{
  "errors": [
    {
      "field": "deserunt elit dolore enim est",
      "message": "sed commodo incididunt aliquip occaecat"
    },
    {
      "field": "laboris",
      "message": "adipisicing Excepteur Duis"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "est mollit eiusmod aliquip",
      "message": "nisi Ut consequat"
    },
    {
      "field": "Excepteur",
      "message": "nulla voluptate ut culpa eu"
    },
    {
      "field": "consequat",
      "message": "nisi"
    },
    {
      "field": "enim Lorem ut",
      "message": "sunt pariatur minim"
    },
    {
      "field": "et tempor enim sint",
      "message": "Duis dolore id consequat"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "field": "sunt eu anim id",
      "message": "sit sed"
    },
    {
      "field": "ut aute Excepteur minim laboris",
      "message": "consectetur reprehenderit cupidatat"
    },
    {
      "field": "amet dolor consectetur Ut",
      "message": "in adipisicing officia dolore sit"
    },
    {
      "field": "deserunt non laboris quis",
      "message": "enim tempor sit"
    },
    {
      "field": "quis irure",
      "message": "voluptate sint proident ad"
    }
  ]
}

Senders

Header NameExample
on-behalf-of"eu fugiat labore et aliquip"
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": "enim"
    },
    {
      "message": "in ut dolore sint in"
    },
    {
      "message": "veniam irure proident do cillum"
    },
    {
      "message": "minim ut"
    },
    {
      "message": "mollit aliqua nulla Excepteur labore"
    }
  ]
}

Lists(7 operations)

Request Payload
{
  "name": "list-name"
}
Response Payload
{
  "id": "ca7a3796-e8a8-4029-9ccb-df8937940562",
  "name": "list-name",
  "contact_count": 0,
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/lists/ca7a3796-e8a8-4029-9ccb-df8937940562"
  }
}
{
  "errors": [
    {
      "error_id": "occaecat",
      "field": "deserunt dolor dolore ipsum",
      "message": "consequat in eu",
      "parameter": "laborum velit"
    },
    {
      "error_id": "in",
      "field": "tempor nostrud elit fugiat Excepteur",
      "message": "reprehenderit Lorem est",
      "parameter": "Ut commodo dolore ad"
    },
    {
      "error_id": "aliqua culpa",
      "field": "Duis deserunt",
      "message": "ea ipsum",
      "parameter": "ex occaecat"
    },
    {
      "error_id": "dolor laboris dolore deserunt aute",
      "field": "cillum proident et aliqua veniam",
      "message": "velit",
      "parameter": "veniam amet dolore cupidatat"
    }
  ]
}
Query Parameter NameExample
page_size912.270200365313
page_tokenqui laboris cupidatat in
Request Payload
Response Payload
{
  "result": [
    {
      "id": "abc12312-x3y4-1234-abcd-123qwe456rty",
      "name": "list-name",
      "contact_count": 0,
      "_metadata": {
        "self": "https://api.sendgrid.com/v3/marketing/lists/abc12312-x3y4-1234-abcd-123qwe456rty"
      }
    }
  ],
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/lists?page_size=100&page_token="
  }
}
Request Payload
Response Payload
{
  "contact_count": 0,
  "billable_count:": 0
}
{}
Query Parameter NameExample
contact_sampletrue
Request Payload
Response Payload
{
  "contact_count": 2,
  "contact_sample": {
    "id": "c3445f88-5c69-4237-86e6-9ec9de958050",
    "list_ids": [
      "199abb98-0af3-4a8d-b371-6811ff85d062"
    ],
    "created_at": "2620-06-16T17:03:54.867Z",
    "updated_at": "4780-12-06T06:51:30.024Z"
  },
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/lists/199abb98-0af3-4a8d-b371-6811ff85d062"
  },
  "id": "199abb98-0af3-4a8d-b371-6811ff85d062",
  "name": "list-name"
}
[
  {
    "error_id": "in enim et dolore Excepteur",
    "field": "adipisicing irure reprehenderit",
    "message": "mollit quis tempor",
    "parameter": "commodo ut"
  },
  {
    "error_id": "sunt sint eiusmod minim commodo",
    "field": "ex",
    "message": "esse ex anim",
    "parameter": "commodo pariatur"
  },
  {
    "error_id": "et",
    "field": "pariatur in ea nostrud",
    "message": "Ut Duis dolor Lorem nisi",
    "parameter": "Lorem dolore dolor in"
  },
  {
    "error_id": "laborum in magna ut",
    "field": "anim Ut nisi",
    "message": "enim nulla laboris cupidatat",
    "parameter": "do qui"
  },
  {
    "error_id": "et in eiusmod",
    "field": "laboris elit",
    "message": "sit dolore officia",
    "parameter": "adipisicing qui Lorem"
  }
]
Request Payload
{
  "name": "updated-list-name"
}
Response Payload
{
  "id": "abc12312-x3y4-1234-abcd-123qwe456rty",
  "name": "updated-list-name",
  "contact_count": 0,
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/lists/abc12312-x3y4-1234-abcd-123qwe456rty"
  }
}
{
  "errors": [
    {
      "error_id": "adipisicing sunt",
      "field": "exercitation voluptate nulla",
      "message": "minim nostrud do sunt dolor",
      "parameter": "eiusmod fugiat in dolore"
    },
    {
      "error_id": "veniam qui",
      "field": "veniam Duis",
      "message": "laborum",
      "parameter": "cupidatat enim Lorem"
    },
    {
      "error_id": "enim minim",
      "field": "sit",
      "message": "nisi dolor elit",
      "parameter": "Lorem"
    }
  ]
}
{}
Query Parameter NameExample
delete_contactsfalse
Request Payload
Response Payload
{
  "job_id": "abc12312-x3y4-1234-abcd-123qwe456rty"
}
officia
{
  "errors": []
}
Query Parameter NameExample
contact_ids*cillum Duis
Request Payload
Response Payload
{
  "job_id": "nostrud fugiat"
}
{
  "error_id": "amet",
  "field": "nostrud anim id labore",
  "message": "Lorem",
  "parameter": "laborum Lorem sint labore ad"
}
{
  "description": "If the specified list id does not exist. If the specified contact does not exist."
}

Custom Fields(4 operations)

Request Payload
{
  "name": "custom_field_name",
  "field_type": "Text"
}
Response Payload
{
  "id": "a1_T",
  "name": "custom_field_name",
  "field_type": "Text",
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/field_definitions/a1_B"
  }
}
{
  "errors": [
    {
      "error_id": "in qui Lorem aute commodo",
      "field": "et",
      "message": "laborum Ut",
      "parameter": "do ullamco pariatur ipsum"
    },
    {
      "error_id": "in mollit Ut",
      "field": "sit",
      "message": "sunt in do consectetur",
      "parameter": "amet reprehenderit fugiat eiusmod"
    }
  ]
}
Request Payload
Response Payload
{
  "custom_fields": [
    {
      "id": "w1",
      "name": "num_orders",
      "field_type": "Number"
    },
    {
      "id": "w2",
      "name": "dob",
      "field_type": "Date"
    }
  ],
  "reserved_fields": [
    {
      "id": "_rf0_T",
      "name": "first_name",
      "field_type": "Text"
    },
    {
      "id": "_rf1_T",
      "name": "last_name",
      "field_type": "Text"
    },
    {
      "id": "_rf2_T",
      "name": "email",
      "field_type": "Text"
    },
    {
      "id": "_rf3_T",
      "name": "alternate_emails",
      "field_type": "Text"
    },
    {
      "id": "_rf4_T",
      "name": "address_line_1",
      "field_type": "Text"
    },
    {
      "id": "_rf5_T",
      "name": "address_line_2",
      "field_type": "Text"
    },
    {
      "id": "_rf6_T",
      "name": "city",
      "field_type": "Text"
    },
    {
      "id": "_rf7_T",
      "name": "state_province_region",
      "field_type": "Text"
    },
    {
      "id": "_rf8_T",
      "name": "postal_code",
      "field_type": "Text"
    },
    {
      "id": "_rf9_T",
      "name": "country",
      "field_type": "Text"
    },
    {
      "id": "_rf10_T",
      "name": "phone_number",
      "field_type": "Text"
    },
    {
      "id": "_rf11_T",
      "name": "whatsapp",
      "field_type": "Text"
    },
    {
      "id": "_rf12_T",
      "name": "line",
      "field_type": "Text"
    },
    {
      "id": "_rf13_T",
      "name": "facebook",
      "field_type": "Text"
    },
    {
      "id": "_rf14_T",
      "name": "unique_name",
      "field_type": "Text"
    },
    {
      "id": "_rf15_T",
      "name": "email_domains",
      "field_type": "Text",
      "read_only": true
    },
    {
      "id": "_rf16_D",
      "name": "last_clicked",
      "field_type": "Date",
      "read_only": true
    },
    {
      "id": "_rf17_D",
      "name": "last_opened",
      "field_type": "Date",
      "read_only": true
    },
    {
      "id": "_rf18_D",
      "name": "last_emailed",
      "field_type": "Date",
      "read_only": true
    },
    {
      "id": "_rf19_T",
      "name": "singlesend_id",
      "field_type": "Text",
      "read_only": true
    },
    {
      "id": "_rf20_T",
      "name": "automation_id",
      "field_type": "Text",
      "read_only": true
    },
    {
      "id": "_rf21_D",
      "name": "created_at",
      "field_type": "Date",
      "read_only": true
    },
    {
      "id": "_rf22_D",
      "name": "updated_at",
      "field_type": "Date",
      "read_only": true
    },
    {
      "id": "_rf23_T",
      "name": "contact_id",
      "field_type": "Text",
      "read_only": true
    }
  ],
  "_metadata": {
    "self": "https://example.com/marketing/field_definitions"
  }
}
Request Payload
{
  "name": "new_custom_field_name"
}
Response Payload
{
  "id": "a1_T",
  "name": "custom_field_name",
  "field_type": "Text",
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/marketing/field_definitions/a1_B"
  }
}
{
  "errors": [
    {
      "error_id": "veniam",
      "field": "proident enim",
      "message": "officia sed reprehenderit aliqua irure",
      "parameter": "Lorem consequat"
    },
    {
      "error_id": "labore Lorem Ut",
      "field": "occaecat",
      "message": "ut dolore",
      "parameter": "dolore consequat et"
    },
    {
      "error_id": "elit ipsum laboris adipisicing in",
      "field": "id sit in",
      "message": "aute officia reprehenderit Excepteur",
      "parameter": "in id anim sunt"
    },
    {
      "error_id": "officia commodo ex",
      "field": "voluptate",
      "message": "Excepteur elit",
      "parameter": "Duis ex magna sit"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "minim dolore enim sint Ut",
      "field": "voluptate cupidatat aliquip ut quis",
      "message": "irure",
      "parameter": "cupidatat"
    },
    {
      "error_id": "exercitation esse dolore eiusmod",
      "field": "do",
      "message": "Excepteur velit",
      "parameter": "proident sunt"
    },
    {
      "error_id": "ex in occaecat tempor",
      "field": "ipsum aliqua velit laborum nulla",
      "message": "sit laborum proident ut",
      "parameter": "cupidatat mollit adipisicing velit"
    },
    {
      "error_id": "veniam ea nostrud commodo",
      "field": "do",
      "message": "tempor et adipisicing",
      "parameter": "exercitation id dolore"
    },
    {
      "error_id": "Lorem anim nulla",
      "field": "do",
      "message": "veniam irure commodo",
      "parameter": "reprehenderit tempor cillum ad"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "nulla sit",
      "field": "magna officia Lorem cupidatat consequat",
      "message": "dolor sit Lorem",
      "parameter": "consectetur"
    },
    {
      "error_id": "nisi",
      "field": "occaecat reprehenderit Lorem",
      "message": "fugiat esse ex qui",
      "parameter": "laboris adipisicing sint"
    },
    {
      "error_id": "officia ipsum Excepteur dolore",
      "field": "cillum in",
      "message": "cupidatat minim",
      "parameter": "Excepteur voluptate fugiat adipisicing"
    }
  ]
}

segmenting contacts(5 operations)

Request Payload
{
  "name": "in ullamco",
  "parent_list_id": "34fcce44-737a-585a-1078-ff076ce054f2",
  "parent_list_ids": [
    "incididunt tempor",
    "dolore nostrud officia",
    "sunt pariatur ea Duis officia"
  ],
  "query_dsl": "culpa et"
}
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": "laboris reprehenderit in ea"
    },
    {
      "message": "nisi pariatur tempor sunt cupidatat"
    },
    {
      "message": "eu et commodo eiusmod"
    },
    {
      "message": "aute"
    }
  ]
}
Query Parameter NameExample
parent_list_idsea eiusmod reprehenderit voluptate
no_parent_list_idtrue
Request Payload
Response Payload
{
  "results": [
    {
      "id": "12099613-91e5-4d09-a900-df7626325288",
      "contacts_count": 78434802,
      "created_at": "2921-01-27T19:33:36.479Z",
      "sample_updated_at": "4685-11-26T07:05:04.660Z",
      "updated_at": "2883-07-10T13:13:37.697Z"
    },
    {
      "id": "60c37015-3734-4c8e-b293-68cfa2ae4fa5",
      "contacts_count": 34177253,
      "created_at": "2575-07-26T23:17:20.984Z",
      "sample_updated_at": "3074-09-04T09:49:58.127Z",
      "updated_at": "5116-10-15T07:37:40.838Z",
      "parent_list_id": "fd38af3d-3f69-4947-8dca-5fa967e7be82",
      "name": "amet"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "id"
    },
    {
      "message": "adipisicing"
    },
    {
      "message": "proident enim"
    },
    {
      "message": "incididunt Duis Lorem est"
    },
    {
      "message": "occaecat amet dolore dolor magna"
    }
  ]
}
Query Parameter NameExample
query_jsontrue
Request Payload
Response Payload
{
  "id": "3b049926-0a54-4a91-83f0-086ace63c530",
  "contacts_count": -83213117,
  "created_at": "voluptate sunt non fugiat",
  "sample_updated_at": "labore occaecat sunt enim",
  "updated_at": "sunt aliqui",
  "contacts_sample": [
    {
      "contact_id": "e70eac25-1431-4231-bccd-1cfab432301e",
      "primary_email": "KLTF@SurgGzlAxCPOqhOUHYNBLsfpfE.trh",
      "alternate_emails": [
        "dTeJZgU5uN9UYSo@nfIB.ijxg"
      ],
      "first_name": "ullamco esse culpa do",
      "last_name": "officia laboris veniam consequat",
      "address_line_1": "in occaecat labore est tempor",
      "address_line_2": "magna adipisicing",
      "city": "ƞó",
      "state_province_region": "culpa ut",
      "postal_code": -75218567,
      "country": "voluptate in in reprehenderit aliquip",
      "custom_fields": {
        "custom_field_name1": "amet deserunt mollit",
        "custom_field_name2": "minim consequat id"
      }
    },
    {
      "contact_id": "db637d33-bce1-462c-ae9c-91ec4f761de6",
      "primary_email": "t7N5TjDmKhC0@gfdifW.ua",
      "alternate_emails": [
        "gQol@Xcfilli.hc",
        "n4K7OdaVQh@YfsnF.ie",
        "TdnvS3nMStREn@miFjGzNDCPZWhiswJNxrFnOYdUAZEpesQ.yxpu",
        "xRzGDTTzzbYK@eJ.wpgb",
        "iI1rOpx2ct@aZhuYGZBxJLZ.phr"
      ],
      "first_name": "ea et eu",
      "last_name": "velit Ut laborum ipsu",
      "address_line_1": "labore",
      "address_line_2": "non",
      "city": "ĔȸąŸÂ¸ȠɏbɄ",
      "state_province_region": "deserunt dolore",
      "postal_code": -95171713,
      "country": "do",
      "list_ids": [
        "c712288b-2300-4069-bef4-2e05b5948ec3",
        "9003ef29-5eb7-4951-898b-1b102e490d6e"
      ]
    }
  ],
  "name": "enim et anim",
  "query_dsl": "nostrud"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "ea",
      "message": "consequat sint"
    }
  ]
}
{
  "errors": [
    {
      "message": "in nostrud sit"
    },
    {
      "message": "ad qui sit ipsum"
    },
    {
      "message": "dolore voluptate ut sint ipsum"
    }
  ]
}
Request Payload
{
  "name": "proident incididunt",
  "parent_list_ids": [
    "ut tempor amet enim dolore",
    "dolor quis veniam",
    "labore in in"
  ],
  "query_dsl": "dolor ullamco officia in"
}
Response Payload
{
  "id": "5fff6250-b766-4959-a183-2e1fa565c4ce",
  "contacts_count": -35493018,
  "created_at": "2014-12-23T17:18:52.907Z",
  "sample_updated_at": "2146-04-13T16:46:32.328Z",
  "updated_at": "4389-06-21T16:59:51.403Z",
  "contacts_sample": [
    {
      "contact_id": "4cff9fdf-1bee-44f7-95dc-a101f9ed3cfe",
      "primary_email": "exmS@KIzibBSmaUUHQa.uvv",
      "alternate_emails": [
        "qXP-RD97fLl@oEDaUynqnNRHJHdoJAWVGXwvI.qlv",
        "W0ngFWmR@WcQuSbPFVPZvLrjCFadfimFi.eqf",
        "mYBC0ea5UxFI@qwO.jh",
        "Nhf1OmY@KCSjTQsXYpbKrBUsQFHrnLuY.oef"
      ],
      "first_name": "consequat nulla in",
      "last_name": "irure nostrud elit eu",
      "address_line_1": "deserunt cillum aliqua nostrud ullamco",
      "address_line_2": "sint",
      "city": "ŷ(ç",
      "state_province_region": "minim",
      "postal_code": 62721676,
      "country": "consectetur quis voluptate",
      "list_ids": [
        "f9d5987d-7a01-4a66-b77e-1f08a392304b",
        "b4e3b028-01d4-428b-9ef5-24bcd90fa02c",
        "fedab84f-9aa5-449d-99e2-7b1361f8ee61"
      ]
    },
    {
      "contact_id": "093a66b8-bca8-4d8a-b32a-091d939c1928",
      "primary_email": "atNeYGC4nbF42@VOCUWuGaYr.ystm",
      "alternate_emails": [
        "Zs6vnQbMU@XTamDsXEGJWBMMEacOc.hitv",
        "Epl@ySBrQCFJZnjggkAYLu.ppta"
      ],
      "first_name": "est",
      "last_name": "in",
      "address_line_1": "culpa eu eiusmod sint",
      "address_line_2": "sed velit sint",
      "city": "BĊJ",
      "state_province_region": "Lorem Ut aliqua elit",
      "postal_code": 33736880,
      "country": "in laboris Excepteur consequat",
      "custom_fields": {
        "custom_field_name2": "culpa Excepteur",
        "custom_field_name1": "esse magna Ut"
      }
    },
    {
      "contact_id": "08939f9c-2c87-4639-bd07-16d41f90a5eb",
      "primary_email": "Jx660QHClqRrC@SavQvcdRpJlLqepwoEUCm.ar",
      "alternate_emails": [
        "S8u@ZVGjHsXdSWtlhhad.ximc",
        "GA1MN72v3uA@MPDvMUmTYjwFCsEaGnFnvVzJVqUTl.ehws"
      ],
      "first_name": "sed eu veli",
      "last_name": "aliqua sit culpa",
      "address_line_1": "occaecat aute enim",
      "address_line_2": "ipsum quis in",
      "city": "ɌſĕĝȤ¶Ǖ",
      "state_province_region": "ut nisi sed esse",
      "postal_code": -66445052,
      "country": "occaecat veniam"
    },
    {
      "contact_id": "0667ed97-7b7b-44aa-a115-0301067660d7",
      "primary_email": "AnoFtJq@IolRDmfj.njt",
      "alternate_emails": [
        "F5WhHCA3oL6Ix@wOKzwIsvHbFi.mrlc"
      ],
      "first_name": "do mollit velit",
      "last_name": "voluptate dolor",
      "address_line_1": "et incididunt",
      "address_line_2": "veniam quis non exercitation Duis",
      "city": "DzƐȹŲdž",
      "state_province_region": "occaecat",
      "postal_code": -19694583,
      "country": "reprehenderit",
      "custom_fields": {
        "custom_field_name1": "dolor aute irure Excepteur"
      },
      "list_ids": [
        "ffd225a8-2008-4457-87af-1cffff5b1ccb"
      ]
    },
    {
      "contact_id": "449767ca-d446-45f1-aa9b-432f441b5ca1",
      "primary_email": "kF4@gYYdAxzetJrWszLAHuBUTu.rzq",
      "alternate_emails": [
        "ksqbx6BInlB@ouWBjjxwFBwVQjdnEKXy.xi",
        "TAe7F2m8dFlF@SirYykzbe.aj",
        "T9c2Y@HjVQY.zz",
        "p7ShfET@vMMnTUqoqngPSEqbpyoeWN.jlqn",
        "0VJSIhIUT2k@mJXVtdZVKKswW.xoca"
      ],
      "first_name": "irure laboris minim",
      "last_name": "id nostrud aliqua sit",
      "address_line_1": "dolor",
      "address_line_2": "elit ex labore sunt aliquip",
      "city": "ÝǘźƝǝƉ‘Ɲ",
      "state_province_region": "nostrud Duis non nulla laborum",
      "postal_code": 60466925,
      "country": "id sunt nisi",
      "custom_fields": {
        "custom_field_name2": "enim quis",
        "custom_field_name1": "amet"
      },
      "list_ids": [
        "2870627c-b9ea-4dcf-bde0-36c3e0e3eca9",
        "575d86aa-4dcc-4b7d-b7de-ded856913198",
        "fb82a17f-5777-439d-9b8c-2c565c8ddf20"
      ]
    }
  ],
  "name": "List Name",
  "query_dsl": "Email LIKE %twilio.com"
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "ut",
      "message": "voluptate irure"
    },
    {
      "field": "nisi mollit",
      "message": "officia adipisicing ut qui Lorem"
    },
    {
      "field": "do occaecat exercitation qui aliqua",
      "message": "dolor reprehenderit elit laboris est"
    },
    {
      "field": "amet",
      "message": "aute pariatur ex"
    }
  ]
}
{
  "errors": [
    {
      "message": "ut occaecat"
    },
    {
      "message": "dolor reprehenderit esse cupidatat"
    },
    {
      "message": "ad cillum laborum fugiat exercitation"
    },
    {
      "message": "Ut consequat adipisicing enim dolor"
    }
  ]
}
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "sint eu dolore",
      "message": "occaecat est dolore laboris"
    }
  ]
}
{
  "errors": [
    {
      "message": "commodo minim"
    }
  ]
}

Segmenting Contacts

Request Payload
{
  "ids": [
    "a14dcc63-d651-4c57-9826-4a3705f5c78d",
    "f3de551e-dc5c-4d42-bd08-c7f87f87f0e8",
    "1b8107b5-adf4-401c-8865-fa84ba178fb9",
    "d7900715-c904-4728-acff-9ab79627579e",
    "16641f5b-cfa3-41b9-9626-244488ee85b1"
  ]
}
Response Payload
{
  "errors": [
    {
      "error": "ullamco enim occaecat ad",
      "id": "non deserunt mollit labore officia",
      "resources": {
        "ids": [
          "eiusmod ea reprehenderit aute"
        ],
        "type": "deserunt occaecat sunt"
      }
    },
    {
      "error": "fugiat nostrud id culpa",
      "id": "id aliquip quis voluptate fugiat",
      "resources": {
        "ids": [
          "in voluptate id sit dolor",
          "consequat qui Duis"
        ],
        "type": "sint velit in"
      }
    }
  ]
}
{}
{
  "errors": [
    {
      "field": "occaecat culpa nisi",
      "message": "dolore"
    },
    {
      "field": "adipisicing dolor laboris",
      "message": "sint aute"
    },
    {
      "field": "dolor magna",
      "message": "ad consequat esse consectetur id"
    },
    {
      "field": "ipsum in voluptate eu",
      "message": "in"
    },
    {
      "field": "cupidatat nulla sunt",
      "message": "quis"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "pariatur quis sed"
    },
    {
      "message": "anim et ut adipisicing"
    },
    {
      "message": "aliqua"
    },
    {
      "message": "officia"
    },
    {
      "message": "quis est"
    }
  ]
}

Single Sends(11 operations)

Request Payload
{
  "name": "Example API Created Single Send",
  "categories": [
    "unique opens"
  ],
  "send_to": {
    "all": true
  },
  "email_config": {
    "design_id": "<your-design-id>",
    "editor": "design",
    "suppression_group_id": 12345,
    "sender_id": 1234567
  }
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "error_id": "est dolore Lorem ea occaecat",
      "field": "laborum deserunt",
      "message": "culpa velit"
    },
    {
      "error_id": "elit mollit consectetur aliqua",
      "field": "sed culpa ea dolor minim",
      "message": "id"
    },
    {
      "error_id": "in fugiat pariatur nisi in",
      "field": "consectetur Excepteur",
      "message": "ea commodo in dolore"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "Duis aliqua do",
      "field": "ut esse",
      "message": "qui nisi quis minim"
    },
    {
      "error_id": "ullamco culpa laborum",
      "field": "ex anim Duis",
      "message": "anim nostrud"
    }
  ]
}
Query Parameter NameExample
page_size-37274084
page_tokenExcepteur
Request Payload
Response Payload
{
  "_metadata": {
    "count": 19428821,
    "next": "http://cYYHHceqxlBOBDKeGXwlAPsBAw.cxlgwCV55sMU0wJYbKZvkdim3N6uVFNKvCMdq67tIq0Hv6+FAT,J26PDnhYMOHJ5XnQS",
    "prev": "http://XOAqlEJWRzJafg.qngrr8P7mTu3ONInzYSxLOYHXkkWXm",
    "self": "https://YIpjwvzmTFhZilFqycaNcfxyuGj.ylcIDGjyNWeiMAGP2xsV"
  },
  "result": [
    {
      "abtest": {
        "duration": "non ea laborum minim",
        "expiration_date": "elit ipsum eu pariatur",
        "test_percentage": -7416794,
        "type": "content",
        "winner_criteria": "manual",
        "winner_selected_at": null,
        "winning_template_id": "voluptate aute quis"
      },
      "categories": [
        "dolor sint",
        "nostrud",
        "dolore",
        "cillum in magna",
        "cillum nostrud",
        "voluptate reprehenderit elit Ut",
        "ad aliqua ullamco ipsum do",
        "sed ipsum Duis aliqua laboris",
        "commodo in irure mollit exercitation",
        "nostrud esse aliqua aliquip mollit"
      ],
      "created_at": "1951-02-22T14:15:38.0Z",
      "id": "9a91770e-3dd2-54ff-9c9e-bfb37ace548b",
      "is_abtest": false,
      "name": "sed labore dolor incididunt",
      "send_at": "1894-04-15T01:25:46.0Z",
      "status": "scheduled",
      "updated_at": "1921-04-24T12:27:52.0Z"
    },
    {
      "abtest": {
        "duration": "dolore cupidatat consequat enim",
        "expiration_date": null,
        "test_percentage": 92195511,
        "type": "subject",
        "winner_criteria": "click",
        "winner_selected_at": "pariatur incididunt",
        "winning_template_id": "ex"
      },
      "categories": [
        "dolor",
        "ut pariatur",
        "velit Ut Lorem est do",
        "magna",
        "est Lorem magna adipisicing dolore",
        "sint in ipsum ut",
        "labore",
        "consectetur aliquip",
        "Lorem sed",
        "aliqua qui tempor ipsum exercitation"
      ],
      "created_at": "1959-01-06T22:56:18.0Z",
      "id": "380f9f85-1e49-a8bc-6363-25e6e2d7fd0c",
      "is_abtest": true,
      "name": "culpa nostrud Duis laboris",
      "send_at": "1962-10-10T09:27:29.0Z",
      "status": "draft",
      "updated_at": "1914-07-11T11:21:17.0Z"
    },
    {
      "abtest": {
        "duration": "adipisicing aliquip",
        "expiration_date": null,
        "test_percentage": 55946270,
        "type": "subject",
        "winner_criteria": "open",
        "winner_selected_at": null,
        "winning_template_id": "fugiat nulla ea adipisicing"
      },
      "categories": [
        "adipisicing consectetur",
        "mollit",
        "ad",
        "consequat et dolore eu minim",
        "veniam in amet",
        "nulla ullamco minim",
        "non cillum ea veniam quis",
        "amet",
        "culpa minim est Excepteur",
        "in quis dolore"
      ],
      "created_at": "1895-08-07T10:56:21.0Z",
      "id": "ca4fc343-6842-96d2-ab6b-dfe6dd897e6e",
      "is_abtest": true,
      "name": "aute eiusmod esse sint",
      "send_at": "1899-03-11T05:32:59.0Z",
      "status": "scheduled",
      "updated_at": "1909-07-10T01:07:05.0Z"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "dolor",
      "field": "ad deserunt",
      "message": "ea magna aliquip occaecat"
    },
    {
      "error_id": "mollit magna",
      "field": "culpa minim est",
      "message": "laborum id"
    },
    {
      "error_id": "labore aliquip irure do culpa",
      "field": "magna",
      "message": "culpa irure esse"
    },
    {
      "error_id": "aliquip sint cillum",
      "field": "Duis sit amet ipsum anim",
      "message": "Lorem"
    },
    {
      "error_id": "aute quis fugiat ex ea",
      "field": "voluptate dolore",
      "message": "dolor laboris est"
    }
  ]
}
Query Parameter NameExample
ids["enim","commodo aliquip voluptate dolore tempor","sint","reprehenderit enim esse et ut","pariatur ut","dolore officia sit","consectetur incididunt reprehenderit","nulla nostrud","anim id","reprehenderit aliqua"]
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "nisi ea",
      "field": "sunt",
      "message": "sit Ut ullamco in Duis"
    },
    {
      "error_id": "mollit proident",
      "field": "magna dolore ea esse proident",
      "message": "nisi"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "aliquip ut dolore eiusmod nisi",
      "field": "enim irure eu magna velit",
      "message": "sed"
    },
    {
      "error_id": "ut irure enim aliqua est",
      "field": "elit culpa",
      "message": "magna reprehenderit"
    },
    {
      "error_id": "laborum aliquip",
      "field": "voluptate elit veniam qui occaecat",
      "message": "in nostrud mollit in"
    },
    {
      "error_id": "nostrud dolore",
      "field": "ipsum occaecat",
      "message": "in do"
    }
  ]
}
Request Payload
{
  "name": "sed "
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "error_id": "Ut",
      "field": "proident",
      "message": "sed sint deserunt aliquip"
    },
    {
      "error_id": "eiusmod ut",
      "field": "in esse Duis quis",
      "message": "dolore adipisicing"
    },
    {
      "error_id": "dolore",
      "field": "laboris nostrud consequat",
      "message": "sed ipsum eiusmod dolor"
    },
    {
      "error_id": "ut",
      "field": "non",
      "message": "ipsum cillum eu exercitation"
    },
    {
      "error_id": "fugiat officia in do",
      "field": "aliqua irure tempor ea ut",
      "message": "ipsum laborum consectetur"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ut ut reprehenderit",
      "field": "dolor",
      "message": "minim voluptate est in deserunt"
    },
    {
      "error_id": "dolore nostrud Ut dolor",
      "field": "mollit",
      "message": "adipisicing deserunt"
    },
    {
      "error_id": "non esse Lorem",
      "field": "tempor",
      "message": "Excepteur culpa tempor anim pariatur"
    },
    {
      "error_id": "aute ad",
      "field": "ad anim occaecat aute in",
      "message": "ad"
    },
    {
      "error_id": "Duis ullamco nisi",
      "field": "ut consequat deserunt Lorem Excepteur",
      "message": "laborum proident"
    }
  ]
}
Request Payload
{
  "categories": [
    "do",
    "consectetur in nostrud deserunt id",
    "officia nostrud aliqua nulla dolore",
    "fugiat aute",
    "tempor",
    "mollit dolore laborum proident",
    "reprehenderit sit labore veniam sed",
    "adipisicing ea consectetur",
    "incididunt",
    "sed in cupidatat esse culpa"
  ],
  "email_config": {
    "custom_unsubscribe_url": null,
    "design_id": "consectetur Duis velit cillum",
    "editor": "code",
    "generate_plain_content": true,
    "html_content": "laborum dolor quis enim exercitation",
    "ip_pool": null,
    "plain_content": "voluptate elit laborum do",
    "sender_id": 33199719,
    "subject": "do deserunt",
    "suppression_group_id": null
  },
  "name": "anim dolor ullamco proident",
  "send_at": "1930-08-19T19:34:45.0Z",
  "send_to": {
    "all": false,
    "list_ids": [
      "11744469-8c28-f7fd-a0fc-19d8121f6f6b",
      "73919a9c-f701-c8b0-7488-eedf7997c40d",
      "5bc93af8-c420-b6c2-fb3b-dde42bc2e1b5",
      "0ffb6317-6fe3-43d9-08f7-3ff728fa54b1",
      "3856583b-2511-f3f8-6cf9-b9be976d559c",
      "842a7a08-0451-d85d-d1f3-72785e6e079a",
      "c3b79418-afa8-dea8-1a82-6cffdf25c176",
      "40a0ff88-c06e-24d1-1351-22cbdf733cb8",
      "8a3eedee-e5ed-0951-ba67-51babaef29e7",
      "ed58efce-8407-5632-994b-8da80908cea3"
    ],
    "segment_ids": [
      "766bb205-1298-36ba-b38b-2bb2e8c0ec8d",
      "c91df02a-dd1d-83aa-5c6f-29bcd77fd5a6",
      "ec32ef74-018f-37d1-3a07-cb955666c576",
      "4c0a59ea-9e0f-d6bb-f8e7-911643ab9d51",
      "aead25be-99bc-2b11-4569-1945f12a6188",
      "6dbab8de-4e9b-0131-52f5-a1044d33d53e",
      "4791cbd5-e59f-a523-396e-92c4d7189594",
      "092a73b1-380c-400b-8b76-183413b80e6f",
      "81888ed4-9af5-a768-790b-bc113d4a9117",
      "c60a1e62-6d4b-782a-9ac2-b2b27396a51e"
    ]
  }
}
Response Payload
{
  "name": "Example API Created Single Send",
  "id": "27c21bbf-a12c-440b-b8bf-c526975328ca",
  "status": "scheduled",
  "created_at": "2020-05-18T17:28:27.272Z",
  "send_at": "2020-06-16T00:19:55.106Z",
  "categories": [
    "unique opens"
  ],
  "email_config": {
    "subject": "",
    "html_content": "",
    "plain_content": "",
    "generate_plain_content": true,
    "editor": "code",
    "suppression_group_id": null,
    "custom_unsubscribe_url": null,
    "sender_id": null,
    "ip_pool": null
  },
  "send_to": {
    "list_ids": [
      "f2fe66a1-43f3-4e3a-87b1-c6a600d805f0"
    ]
  }
}
{
  "errors": [
    {
      "error_id": "deserunt anim Excepteur",
      "field": "in veniam ea esse",
      "message": "consequat aliqua"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "ex amet dolor",
      "field": "ut enim",
      "message": "consequat irure"
    },
    {
      "error_id": "sit dolor sed",
      "field": "consequat tempor minim mollit",
      "message": "ullamco adipisicing in ad"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "laborum",
      "field": "cillum ea ut in",
      "message": "dolore dolor"
    },
    {
      "error_id": "Lorem sit id",
      "field": "eiusmod",
      "message": "amet"
    },
    {
      "error_id": "occaecat laborum",
      "field": "esse voluptate in",
      "message": "Excepteur et exercitation deserunt dolor"
    },
    {
      "error_id": "Ut in",
      "field": "in dolor sit velit",
      "message": "Excepteur magna et occaecat"
    },
    {
      "error_id": "do dolor",
      "field": "velit ad voluptate anim",
      "message": "laboris pariatur sed"
    }
  ]
}
Request Payload
Response Payload
{
  "name": "single-send-1",
  "id": "2f6dec81-43b9-4c67-a890-3a38cb63b54a",
  "status": "scheduled",
  "created_at": "2020-12-13T16:24:42.013Z",
  "send_to": {
    "segment_ids": [
      "dad84de3-bec4-4e04-b132-2cbfd4bb3789",
      "7dce758d-1155-4102-88d2-ca65565ac98b"
    ],
    "all": true
  }
}
{
  "errors": [
    {
      "error_id": "ea",
      "field": "qui",
      "message": "Duis in occaecat Excepteur incididunt"
    },
    {
      "error_id": "laboris ad consequat mollit",
      "field": "eu esse elit minim aliqua",
      "message": "ea dolore fugiat commodo"
    },
    {
      "error_id": "laboris veniam minim sint est",
      "field": "labore commodo dolore ullamco",
      "message": "sed qui ut proident amet"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "pariatur deserunt nostrud",
      "field": "dolor incididunt aute",
      "message": "do esse"
    },
    {
      "error_id": "ex veniam amet",
      "field": "sint ad velit",
      "message": "esse ipsum ex"
    },
    {
      "error_id": "officia elit irure aliqua",
      "field": "anim mollit",
      "message": "sed officia adipisicing esse cillum"
    },
    {
      "error_id": "in velit reprehenderit adipisicing",
      "field": "Excepteur veniam proident sed ipsum",
      "message": "anim ut in"
    }
  ]
}
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
{
  "errors": [
    {
      "error_id": "occaecat deserunt aliqua dolor nulla",
      "field": "ad qui ipsum ea consequat",
      "message": "deserunt"
    },
    {
      "error_id": "quis",
      "field": "ut",
      "message": "exercitation ut ipsum"
    },
    {
      "error_id": "aute cillum deserunt magna dolore",
      "field": "consectetur voluptate non aute dolor",
      "message": "incididunt"
    },
    {
      "error_id": "aliqua cupidatat in ad",
      "field": "magna ad occaecat officia enim",
      "message": "laborum id"
    },
    {
      "error_id": "dolore",
      "field": "velit nulla esse in",
      "message": "labore amet"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "adipisicing sed culpa eu",
      "field": "occaecat fugiat pariatur",
      "message": "qui"
    }
  ]
}
Query Parameter NameExample
page_size-32840082
page_tokenirure labore dolor
Request Payload
{
  "name": "specific-single-send-name",
  "status": [
    "draft",
    "scheduled"
  ],
  "categories": [
    "shoes"
  ]
}
Response Payload
{
  "result": [
    {
      "id": "df25ffdf-6a96-458a-9419-6d87d3094c6b",
      "name": "single-send-1",
      "status": "triggered",
      "categories": [
        "shoes"
      ],
      "is_abtest": true,
      "updated_at": "3263-04-09T09:05:08.193Z",
      "created_at": "4739-10-29T07:11:32.476Z",
      "send_at": "2471-05-31T15:46:18.797Z"
    }
  ],
  "_metadata": {
    "self": "nwNSrPSWt7d",
    "prev": "P0Enoayd",
    "next": "DYEsTUDww9-",
    "count": 1
  }
}
{
  "errors": [
    {
      "error_id": "amet et minim",
      "field": "enim ut",
      "message": "minim veniam"
    },
    {
      "error_id": "ea quis enim",
      "field": "quis occaecat",
      "message": "velit nisi"
    },
    {
      "error_id": "aute dolore consequat ad",
      "field": "ut proident",
      "message": "pariatur"
    },
    {
      "error_id": "deserunt pariatur",
      "field": "ut incididunt tempor ipsum",
      "message": "Duis proident adipisicing ad"
    }
  ]
}
Request Payload
{
  "send_at": "3752-01-28T23:21:52.575Z"
}
Response Payload
{
  "send_at": "3752-01-28T23:21:52.575Z",
  "status": "scheduled"
}
{
  "errors": [
    {
      "error_id": "officia irure voluptate",
      "field": "qui aute veniam",
      "message": "minim"
    },
    {
      "error_id": "labore laboris consequat enim",
      "field": "consequat",
      "message": "fugiat do minim"
    },
    {
      "error_id": "Ut laboris nostrud",
      "field": "est irure quis reprehenderit",
      "message": "do"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "sint ut occaecat",
      "field": "laborum commodo",
      "message": "nisi ut cupidatat aliqua"
    },
    {
      "error_id": "sed eiusmod",
      "field": "occaecat",
      "message": "id enim"
    }
  ]
}
Request Payload
Response Payload
{
  "send_at": "1903-07-30T10:18:27.0Z",
  "status": "triggered"
}
{
  "errors": [
    {
      "error_id": "elit consectetur",
      "field": "et sed nulla",
      "message": "voluptate"
    }
  ]
}
{
  "errors": [
    {
      "error_id": "aliqua",
      "field": "ullamco culpa laboris",
      "message": "ad id tempor exercitation"
    },
    {
      "error_id": "mollit aliquip sint ea eu",
      "field": "ad",
      "message": "eiusmod dolore enim laborum"
    }
  ]
}
Request Payload
Response Payload
{
  "categories": [
    "equipment",
    "shoes",
    "sports"
  ]
}
{
  "errors": [
    {
      "error_id": "ad sit nisi aliquip irure",
      "field": "fugiat",
      "message": "cillum dolor sint Ut est"
    },
    {
      "error_id": "qui deserunt velit",
      "field": "exercitation qui non tempor",
      "message": "Duis in"
    },
    {
      "error_id": "qui enim",
      "field": "aute aliqua sit",
      "message": "Duis"
    }
  ]
}

Send Test Email

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

Marketing Campaigns Stats(8 operations)

Query Parameter NameExample
automation_ids["minim occaecat laboris eiusmod sit","officia anim irure dolore labore","in","cillum in in sint mollit","in velit laborum","cupidatat","deserunt","exercitation officia eu","in officia","deserunt proident ad"]
page_size52
page_tokenlaboris ex
Request Payload
Response Payload
{
  "_metadata": {
    "count": 84866634.62684083,
    "next": "http://YloAWBMNccZHKGFdVNWrptNTSPiv.dtmfCPP+e6gq,Dyi6QtkUZilHPcj2wD2yD+yosHmIFKSt.mDCs",
    "prev": "http://ODKJXzSLfMMprAUe.nadRzHVRMz.c3ERIQSlvle.NRhMhYvNGHDdYWRMXN",
    "self": "https://XEwjAMnZXyTdgR.yqfGnW.1FoM9iaxl8P1KDKJqcpaixmjE7vMr9B3x1Y0tdtze1.+cP6ZHiBl2WZXnD3dc4XgrMOKG+Qvy+"
  },
  "results": [
    {
      "aggregation": "adipisicing sit",
      "id": "42831375-a854-00e2-8f7a-5a59365fd528",
      "stats": {
        "bounce_drops": 43173563,
        "bounces": -11414049,
        "clicks": 60810615,
        "delivered": 68906079,
        "invalid_emails": 38687578,
        "opens": 45117636,
        "requests": -4987158,
        "spam_report_drops": 720841,
        "spam_reports": -9496938,
        "unique_clicks": -80233934,
        "unique_opens": -81666458,
        "unsubscribes": -68222972
      },
      "step_id": "elit"
    },
    {
      "aggregation": "elit",
      "id": "2a27cd80-da07-f141-e38c-fa1726c87c29",
      "stats": {
        "bounce_drops": -5106917,
        "bounces": -79382082,
        "clicks": 79693259,
        "delivered": -90577986,
        "invalid_emails": 74996548,
        "opens": -91215185,
        "requests": 24385722,
        "spam_report_drops": 27718001,
        "spam_reports": 44700611,
        "unique_clicks": -98980472,
        "unique_opens": 37412312,
        "unsubscribes": -14338666
      },
      "step_id": "fugiat"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
group_by["step_id","step_id","step_id"]
step_ids["f23f566f-7a38-9a4f-2fa0-4bb5abcce911"]
aggregated_bytotal
start_date1968-04-18
end_date1909-06-18
timezonevelit ea
page_size99
page_tokenlaborum eiusmod esse
Request Payload
Response Payload
{
  "_metadata": {
    "count": 74717271.2193195,
    "next": "http://jHXZxRCsxmAvoenkIqJADx.pvlVrNPZ8hiy5CpclR8oBqB8MvgFRD8GVQ6HES-Pq9i0fkezIoLv8xWsVmFIhFeJb",
    "prev": "https://qViSQJOejwcTndT.sgLsPy4hhED-GpwnYKiRTXXkwgO,e",
    "self": "https://vgPmPoXWCYzBr.yehK-dETKQ5sobSz6SAPUi7yX"
  },
  "results": [
    {
      "aggregation": "in tempor",
      "id": "f9830d27-5337-e04a-9d83-f725a819376f",
      "stats": {
        "bounce_drops": -32682681,
        "bounces": 99061794,
        "clicks": 56418667,
        "delivered": -94101473,
        "invalid_emails": -18617591,
        "opens": 4447506,
        "requests": -97131445,
        "spam_report_drops": 11536241,
        "spam_reports": -16567328,
        "unique_clicks": 56244758,
        "unique_opens": -42316010,
        "unsubscribes": -8244992
      },
      "step_id": "incididunt ea qui Lorem pariatur"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
singlesend_ids["sint","laborum","dolore veniam sit","labore exercitation ut nulla aute","ipsum cupidatat eu occaecat enim","minim consectetur nostrud nulla","dolore in incididunt","veniam Excepteur ex Lorem ut","quis in esse","in ex proident magna laborum"]
page_size15
page_tokenlabore in anim ad
Request Payload
Response Payload
{
  "_metadata": {
    "count": 18887330.718064547,
    "next": "https://liXQsNgMucRxfQF.lsfJcbnB8UC0ge.xOAIcSIWCYIIYkiTJ84XA6kqX94EYat7zI+j-QS.nFT4+HAhxHw6",
    "prev": "http://HiLxSHYOYluG.jnotg55v7.5bBOEuk8jgEAw4WFfVttdbNCYp7.c4f41ivL+8vr8usBHmFy8C9Cin-xNd9eE",
    "self": "http://uVHUbetetrdBMIQ.kldlIi2LYAgJX2bHnraNJBuD"
  },
  "results": [
    {
      "ab_phase": "send",
      "ab_variation": "a57905f1-b318-efd0-65c2-5bcd1623f117",
      "aggregation": "aliquip sint minim incididunt et",
      "id": "7cd57e82-5415-c27b-3258-503541208866",
      "stats": {
        "bounce_drops": 24952168,
        "bounces": -63895506,
        "clicks": 5999952,
        "delivered": 15664416,
        "invalid_emails": 60871551,
        "opens": -98639886,
        "requests": 39993441,
        "spam_report_drops": -48877717,
        "spam_reports": -33834561,
        "unique_clicks": 13897098,
        "unique_opens": 69661763,
        "unsubscribes": 3611703
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "2e2db856-2823-8926-2823-fd52e9c1b3dc",
      "aggregation": "nostrud consequat",
      "id": "91bc7d96-174d-0f1c-6480-0a9fa08a5b80",
      "stats": {
        "bounce_drops": -81375453,
        "bounces": -96670308,
        "clicks": 82677674,
        "delivered": -50703959,
        "invalid_emails": -46734558,
        "opens": 61442988,
        "requests": -92849767,
        "spam_report_drops": -79352192,
        "spam_reports": 3026332,
        "unique_clicks": -15116979,
        "unique_opens": -21994959,
        "unsubscribes": 66666695
      }
    },
    {
      "ab_phase": "all",
      "ab_variation": "12162d94-b207-0216-8189-1a2f918bf794",
      "aggregation": "mollit laborum esse",
      "id": "211c8ce0-ee4c-0227-88f9-471ab6a3982f",
      "stats": {
        "bounce_drops": -25713877,
        "bounces": -86938065,
        "clicks": -77921434,
        "delivered": 20463461,
        "invalid_emails": 55907804,
        "opens": 63535990,
        "requests": 45935289,
        "spam_report_drops": -70762007,
        "spam_reports": -81458509,
        "unique_clicks": 97742124,
        "unique_opens": -4741274,
        "unsubscribes": 83314549
      }
    },
    {
      "ab_phase": "send",
      "ab_variation": "80f27de7-5509-8f71-f0e5-d36847ed13d8",
      "aggregation": "ipsum",
      "id": "816f9e89-d63a-dc6e-f804-23d60d349477",
      "stats": {
        "bounce_drops": -55399348,
        "bounces": 15493112,
        "clicks": -68108356,
        "delivered": -64671097,
        "invalid_emails": 11445821,
        "opens": 18204336,
        "requests": -62378665,
        "spam_report_drops": -88606366,
        "spam_reports": 26743832,
        "unique_clicks": -21150308,
        "unique_opens": -35067425,
        "unsubscribes": -17310038
      }
    },
    {
      "ab_phase": "all",
      "ab_variation": "2cb85138-4ecc-553f-01d6-17ba1fb4fd97",
      "aggregation": "officia sed minim",
      "id": "0f0a7924-dd7a-ddaf-9f4e-e1be94686592",
      "stats": {
        "bounce_drops": 86445212,
        "bounces": -16504622,
        "clicks": -26248435,
        "delivered": 67864845,
        "invalid_emails": 5497171,
        "opens": -52012148,
        "requests": -25863221,
        "spam_report_drops": 26452774,
        "spam_reports": -62854390,
        "unique_clicks": 54508407,
        "unique_opens": -75069953,
        "unsubscribes": -38774143
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
aggregated_bytotal
start_date1964-02-28
end_date1896-05-26
timezoneconsequat
page_size32
page_tokenaliquip tempor dolor
group_by["ab_phase","ab_variation"]
Request Payload
Response Payload
{
  "_metadata": {
    "count": -31044640.994799882,
    "next": "http://eYjgyTh.yxwWLZQFL-NNKtlXbZhGh.pXuPTpHMrwFD4AGCQna9f3",
    "prev": "http://YEtIYlDXtEZyqaSqnaNwZegepCCB.jkb+OvlPjXNIWwDqr1ty",
    "self": "http://EfRYwBRJSAisrZWhkwpBpbfPDpwHXw.nxdddDoIp.oHomPs1REAit4W6p7AaNX,GcKJfemqq0IWpAwd7ctvQXDzSZdhq.QbvB"
  },
  "results": [
    {
      "ab_phase": "send",
      "ab_variation": "148b39f6-ac2a-4b35-5c14-768d67c8dcdd",
      "aggregation": "in tempor fugiat elit cillum",
      "id": "842a6343-e0df-521f-68ae-84383f57158a",
      "stats": {
        "bounce_drops": 61157059,
        "bounces": 4407830,
        "clicks": -62420023,
        "delivered": 21953015,
        "invalid_emails": 87998948,
        "opens": -43933149,
        "requests": -22155408,
        "spam_report_drops": 3614488,
        "spam_reports": -41567906,
        "unique_clicks": 52953149,
        "unique_opens": -74155411,
        "unsubscribes": -7028709
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "0f1d2b1f-1ed9-6bb0-2cdc-04e5a158abae",
      "aggregation": "id",
      "id": "24949884-eab0-e730-f5c3-6e3795ea2e6f",
      "stats": {
        "bounce_drops": 19039061,
        "bounces": 36470181,
        "clicks": 29601779,
        "delivered": 8260381,
        "invalid_emails": 50361441,
        "opens": -73492207,
        "requests": -60751466,
        "spam_report_drops": -95277522,
        "spam_reports": -73973249,
        "unique_clicks": 51919601,
        "unique_opens": -45049104,
        "unsubscribes": 17671158
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "79aa615b-7c9c-47f9-8340-c7099ba5381c",
      "aggregation": "esse",
      "id": "8249cb70-fea9-5d26-3f6b-c4a1aa3490de",
      "stats": {
        "bounce_drops": -38599951,
        "bounces": -56537512,
        "clicks": -72402350,
        "delivered": -43697230,
        "invalid_emails": -38994905,
        "opens": 73079726,
        "requests": 82939756,
        "spam_report_drops": 93105382,
        "spam_reports": 86808442,
        "unique_clicks": -48828475,
        "unique_opens": -72453629,
        "unsubscribes": -4269621
      }
    },
    {
      "ab_phase": "test",
      "ab_variation": "ab13dd68-5441-22d6-f579-29ac127aa1e2",
      "aggregation": "pariatur nulla esse irure proident",
      "id": "90858aba-99cb-3052-d7b7-58d5d8dcd038",
      "stats": {
        "bounce_drops": -97152720,
        "bounces": -83623514,
        "clicks": 72473855,
        "delivered": -16416058,
        "invalid_emails": 43459654,
        "opens": -93497585,
        "requests": 34749793,
        "spam_report_drops": -83073147,
        "spam_reports": 16103200,
        "unique_clicks": 52457720,
        "unique_opens": 12251826,
        "unsubscribes": 49473619
      }
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
group_by["step_id","step_id","step_id"]
step_ids["295e9f76-4852-8f26-cf41-cad8f50dd761","e2f1efc0-b061-4e4d-c5a0-45c99320c6fb","c1a793c5-cee2-3e7c-8110-1b99d01c4219","56090729-da98-2a23-303f-1b2023ce4fa0","862e9a62-a115-430b-79da-c74b8896e4c8"]
page_size95
page_tokenin adipisicing
Request Payload
Response Payload
{
  "_metadata": {
    "count": 53511920.34758118,
    "next": "https://mYBSNCeZLxjhhrRAFOi.husyOJ,-6Unug-DU03pNK8eZLKGk7ko5mdGUQcNWCQjdQaUDB+AlLJbPluqC",
    "prev": "http://isaQzefTV.qafzshAysL19IaV4DNnI1EQWwwjKIrBiE-gfd2gRemGNB,FMKOZeSzQKIMIq7,BrG28f",
    "self": "https://POsWPdRYrdjYszto.hofBXRI-YFmpu"
  },
  "results": [
    {
      "clicks": 36499137,
      "step_id": "afba94c4-44af-7185-708f-32983ed60d85",
      "url": "https://ZrNdVMEPzmYRadO.fjvdCJ,Ca-4HfNg8w,jbV",
      "url_location": 93127885
    },
    {
      "clicks": 41492684,
      "step_id": "bc17c6d5-3b98-776f-a26b-e95daec2284b",
      "url": "http://ZUkpqwxbWeFmYJAqOlCcDlyB.ckPlH,x9w-RooHNex25R0a0QOs2Bi1ojpk4QXM.JcHtk4v+By,4bz9PTiilOiJKe2cfnIQG5dPc-B",
      "url_location": 28648474
    },
    {
      "clicks": 51308778,
      "step_id": "c867b6e4-f31a-0a2b-8746-790a7e553a6d",
      "url": "http://Fo.xqEf",
      "url_location": 9995321
    },
    {
      "clicks": 32072697,
      "step_id": "a090155d-ad16-ff84-b93d-b800cf11a47e",
      "url": "https://wnrMkaAQkYsHMGDccNEmzsWcrpZ.mrRG-W",
      "url_location": 97352806
    }
  ],
  "total_clicks": 10756689
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Query Parameter NameExample
page_size65
page_tokennon nulla deserunt et
group_by["ab_phase","ab_variation","ab_phase","ab_phase","ab_phase"]
ab_variation_id340e25ca-5021-edec-7240-a656e278dca5
ab_phase_idtest
Request Payload
Response Payload
{
  "_metadata": {
    "count": -52034894.48697041,
    "next": "http://WcDUszsvlegZRzxzsPgxtRaOBwTNbdaM.jfdgQYBfTyBcczI7QMAUt2zsP-cdqgcXOU3NAozwtuFDZDi5Pj5I4ALW-aQ1Bn",
    "prev": "https://Eux.zhtqXg5Ud9ZK1RKObAnyPlAeRoJd59MtjekCPZfmr4vw.pFQ6",
    "self": "http://XBsJMsygBXhUNwnTOWqoeYWSjxhGuqZZW.myiaEzwwJCaYs.cxJPGpw6I5k.B1nV"
  },
  "results": [
    {
      "ab_phase": "test",
      "ab_variation": "7d5d7437-aa45-fcd6-f419-a7c7088a1fca",
      "clicks": 7872512,
      "url": "http://SvMwCvCVbHyFpy.jtvwOjSfXbUV",
      "url_location": 79442797
    },
    {
      "ab_phase": "all",
      "ab_variation": "c02d931e-1fb6-6909-6bf2-1f8a5d5f5b43",
      "clicks": 48431385,
      "url": "http://gowdlNxdp.xrjMOwiTLjjO,QrILI,EV5J-0GwcIt+MOtnZSTGmVHmwLpcAiF,Ssouz3QIVfIe",
      "url_location": 76477030
    }
  ],
  "total_clicks": -64426729
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{}
Query Parameter NameExample
ids["consectetur","non","esse Ut cupidatat in","sint consectetur laboris","exercitation quis","laborum elit Lorem","nisi sunt","commodo ipsum","ullamco anim in","id"]
timezoneipsum ullamco dolore
Request Payload
Response Payload
mollit Lorem
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.
Query Parameter NameExample
ids["laborum Ut Lorem incididunt elit","sed dolore ut commodo do","dolore labore","est consequat nisi officia","magna incididunt ea","officia consectetur","sed sunt dolore fugiat","dolore minim","dolor ea","anim"]
timezonein
Request Payload
Response Payload
dolor Excepteur
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}

Sender Identities API(6 operations)

Header NameExample
on-behalf-of"adipisicing in"
Request Payload
{
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States"
}
Response Payload
{
  "id": 1,
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States",
  "verified": true,
  "updated_at": 1449872165,
  "created_at": 1449872165,
  "locked": false
}
{
  "errors": [
    {
      "message": "The JSON you have submitted cannot be parsed.",
      "field": ""
    },
    {
      "message": "You've reached your limit of 100 sender identities. Please delete one or more and try again.",
      "field": ""
    },
    {
      "message": "nickname is required.",
      "field": "nickname"
    },
    {
      "message": "You already have a sender identity with the same nickname.",
      "field": "nickname"
    },
    {
      "message": "from_name is required.",
      "field": "from_name"
    },
    {
      "message": "from_email is required.",
      "field": "from_email"
    },
    {
      "message": "From email is not a valid email address.",
      "field": "from_email"
    },
    {
      "message": "reply_to is required.",
      "field": "reply_to"
    },
    {
      "message": "Reply to email is not a valid email address.",
      "field": "reply_to"
    },
    {
      "message": "address is required.",
      "field": "address"
    },
    {
      "message": "city is required.",
      "field": "city"
    },
    {
      "message": "country is required.",
      "field": "country"
    }
  ]
}
Header NameExample
on-behalf-of"non eu dolor"
Request Payload
Response Payload
{
  "result": [
    {
      "id": 1,
      "nickname": "My Sender ID",
      "from": {
        "email": "from@example.com",
        "name": "Example INC"
      },
      "reply_to": {
        "email": "replyto@example.com",
        "name": "Example INC"
      },
      "address": "123 Elm St.",
      "address_2": "Apt. 456",
      "city": "Denver",
      "state": "Colorado",
      "zip": "80202",
      "country": "United States",
      "verified": true,
      "updated_at": 1449872165,
      "created_at": 1449872165,
      "locked": false
    }
  ]
}
Header NameExample
on-behalf-of"quis nulla ut esse fugiat"
Request Payload
Response Payload
{
  "id": 1,
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States",
  "verified": true,
  "updated_at": 1449872165,
  "created_at": 1449872165,
  "locked": false
}
{
  "errors": [
    {
      "message": "resource not found",
      "field": "id"
    }
  ]
}
Header NameExample
on-behalf-of"culpa do in anim"
Request Payload
{
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States"
}
Response Payload
{
  "id": 1,
  "nickname": "My Sender ID",
  "from": {
    "email": "from@example.com",
    "name": "Example INC"
  },
  "reply_to": {
    "email": "replyto@example.com",
    "name": "Example INC"
  },
  "address": "123 Elm St.",
  "address_2": "Apt. 456",
  "city": "Denver",
  "state": "Colorado",
  "zip": "80202",
  "country": "United States",
  "verified": true,
  "updated_at": 1449872165,
  "created_at": 1449872165,
  "locked": false
}
{
  "errors": [
    {
      "message": "The JSON you have submitted cannot be parsed.",
      "field": ""
    },
    {
      "message": "nickname is required.",
      "field": "nickname"
    },
    {
      "message": "You already have a sender identity with the same nickname.",
      "field": "nickname"
    },
    {
      "message": "from_name is required.",
      "field": "from_name"
    },
    {
      "message": "from_email is required.",
      "field": "from_email"
    },
    {
      "message": "From email is not a valid email address.",
      "field": "from_email"
    },
    {
      "message": "reply_to is required.",
      "field": "reply_to"
    },
    {
      "message": "Reply to email is not a valid email address.",
      "field": "reply_to"
    },
    {
      "message": "address is required.",
      "field": "address"
    },
    {
      "message": "city is required.",
      "field": "city"
    },
    {
      "message": "country is required.",
      "field": "country"
    }
  ]
}
{
  "errors": [
    {
      "message": "You may only update a sender identity when it is unlocked.",
      "field": "locked"
    }
  ]
}
{
  "errors": [
    {
      "message": "resource not found",
      "field": "id"
    }
  ]
}
Header NameExample
on-behalf-of"aute culpa nulla eu"
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "message": "You may only delete a sender identity when it is unlocked.",
      "field": "locked"
    }
  ]
}
{
  "errors": [
    {
      "message": "resource not found",
      "field": "id"
    }
  ]
}
Header NameExample
on-behalf-of"eu nulla dolore"
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "message": "The Sender Identity is already verified.  No email sent.",
      "field": ""
    }
  ]
}
{
  "errors": [
    {
      "message": "resource not found",
      "field": "id"
    }
  ]
}

Contacts API - Lists(10 operations)

Header NameExample
on-behalf-of"esse"
Request Payload
{
  "name": "your list name"
}
Response Payload
{
  "id": 1,
  "name": "your list name",
  "recipient_count": 0
}
{
  "errors": [
    {
      "field": null,
      "message": "Returned if request body is invalid JSON"
    },
    {
      "field": "name",
      "message": "Returned if list name is not a string"
    },
    {
      "field": "name",
      "message": "Returned if list name is a duplicate of an existing list or segment"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"et laboris"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1,
      "name": "the jones",
      "recipient_count": 1
    }
  ]
}
Header NameExample
on-behalf-of"dolore elit quis"
Request Payload
[
  1,
  2,
  3,
  4
]
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "list id was invalid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
list_id27753539
Header NameExample
on-behalf-of"exercitation laboris do"
Request Payload
Response Payload
{
  "id": 1,
  "name": "listname",
  "recipient_count": 0
}
{
  "errors": [
    {
      "message": "invalid id"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "List ID does not exist"
    }
  ]
}
Query Parameter NameExample
list_id*21446848
Header NameExample
on-behalf-of"fugiat minim ex ullamco"
Request Payload
{
  "name": "newlistname"
}
Response Payload
{
  "id": 1234,
  "name": "2016 iPhone Users",
  "recipient_count": 0
}
{
  "errors": [
    {
      "message": "invalid id"
    }
  ]
}
{
  "errors": [
    {
      "message": "List ID does not exist"
    }
  ]
}
Query Parameter NameExample
delete_contactstrue
Header NameExample
on-behalf-of"esse exercitation minim laboris culpa"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "delete_contacts",
      "message": "delete_contacts not a bool"
    },
    {
      "field": "list_id",
      "message": "Returned if list_id is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "List not found: 5"
    }
  ]
}
Query Parameter NameExample
page-44282132
page_size41033943
list_id*5591165
Header NameExample
on-behalf-of"do"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 1433348344,
      "custom_fields": [
        {
          "id": 6234,
          "name": "age",
          "type": "number",
          "value": null
        },
        {
          "id": 6233,
          "name": "country",
          "type": "text",
          "value": null
        },
        {
          "id": 6235,
          "name": "fname",
          "type": "text",
          "value": "Example"
        },
        {
          "id": 6239,
          "name": "lname",
          "type": "text",
          "value": "User"
        },
        {
          "id": 6240,
          "name": "lname",
          "type": "text",
          "value": null
        }
      ],
      "email": "example@example.com",
      "first_name": "Example",
      "id": "ZGVWfyZWsuYmFpbmVzQHNlbmRmCmLkLmNv==",
      "last_clicked": 1438616117,
      "last_emailed": 1438613272,
      "last_name": "User",
      "last_opened": 1438616109,
      "updated_at": 1438616119
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id is not a valid integer"
    },
    {
      "field": "page",
      "message": "Returned if page is not a valid integer"
    },
    {
      "field": "page",
      "message": "Returned if page is less than 1"
    },
    {
      "field": "page_size",
      "message": "Returned if page_size is not a valid integer"
    },
    {
      "field": "page_size",
      "message": "Returned if page_size is less than 1 or greater than 1000"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id is invalid"
    }
  ]
}
Header NameExample
on-behalf-of"ad"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "list_id",
      "message": "list_id is invalid"
    },
    {
      "field": "recipient_id",
      "message": "no valid recipients were provided"
    },
    {
      "field": null,
      "message": "no recipients were added"
    },
    {
      "field": null,
      "message": "request body is invalid JSON"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "list_id does not exist"
    },
    {
      "field": "recipient_id",
      "message": "recipient_id does not exist"
    }
  ]
}
Header NameExample
on-behalf-of"est et"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id is invalid"
    },
    {
      "field": "recipient_id",
      "message": "Returned if recipient_id is invalid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id does not exist"
    },
    {
      "field": "recipient_id",
      "message": "Returned if recipient_id does not exist"
    }
  ]
}
Query Parameter NameExample
list_id*20646295
recipient_id*-61766149
Header NameExample
on-behalf-of"ut"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id is invalid"
    },
    {
      "field": "recipient_id",
      "message": "no valid recipients were provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "list_id",
      "message": "Returned if list_id does not exist"
    },
    {
      "field": "recipient_id",
      "message": "Returned if recipient_id does not exist"
    }
  ]
}

Contacts API - Recipients(12 operations)

Header NameExample
on-behalf-of"dolore"
Request Payload
[
  {
    "email": "example@example.com",
    "first_name": "",
    "last_name": "User",
    "age": 25
  },
  {
    "email": "example2@example.com",
    "first_name": "Example",
    "last_name": "User",
    "age": 25
  }
]
Response Payload
{
  "error_count": 1,
  "error_indices": [
    2
  ],
  "new_count": 2,
  "persisted_recipients": [
    "YUBh",
    "bWlsbGVyQG1pbGxlci50ZXN0"
  ],
  "updated_count": 0,
  "errors": [
    {
      "message": "Invalid email.",
      "error_indices": [
        2
      ]
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "Request body is not valid json"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"cupidatat ullamco dolor amet"
Request Payload
[
  {
    "email": "jones@example.com",
    "last_name": "Jones",
    "first_name": "Guy"
  }
]
Response Payload
{
  "error_count": 1,
  "error_indices": [
    2
  ],
  "new_count": 2,
  "persisted_recipients": [
    "YUBh",
    "bWlsbGVyQG1pbGxlci50ZXN0"
  ],
  "updated_count": 0,
  "errors": [
    {
      "message": "Invalid email.",
      "error_indices": [
        2
      ]
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "Request body is not valid json"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"fugiat labore"
Request Payload
[
  "recipient_id1",
  "recipient_id2"
]
Response Payload
{}
{
  "errors": [
    {
      "message": "No recipient ids provided"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
page-14723225
page_size47095741
Header NameExample
on-behalf-of"in"
Request Payload
Response Payload
{
  "recipients": []
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"eiusmod ut ut consequat"
Request Payload
Response Payload
{
  "status": [
    {
      "id": "worker_delay",
      "value": "delayed"
    },
    {
      "id": "worker_delay_seconds",
      "value": "75.0"
    }
  ]
}
Header NameExample
on-behalf-of"deserunt"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": -88246722.27150843,
      "custom_fields": [
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        },
        {
          "name": "first_name",
          "type": "text"
        }
      ],
      "email": "HQiHsSSSs8qVyD@hEIMnlGATmrGxrXIaNHrbAwUUxrybY.qrn",
      "first_name": null,
      "id": "consectetur ipsum in amet deserunt",
      "last_clicked": -94335565.96758951,
      "last_emailed": -10377256.630500093,
      "last_name": "fugiat sit",
      "last_opened": null,
      "updated_at": 80361343.09832045
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"non irure laboris nisi do"
Request Payload
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "recipient not found"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "recipient_id is not valid"
    }
  ]
}
Header NameExample
on-behalf-of"anim sit"
Request Payload
Response Payload
{
  "lists": [
    {
      "id": 1234,
      "name": "Example list",
      "recipient_count": 42
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "recipient ID is invalid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "recipient id not found"
    }
  ]
}
Header NameExample
on-behalf-of"mollit nostrud non aliqua"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"eu exercitation id adipisicing aliqua"
Request Payload
Response Payload
{
  "recipient_count": 1234
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
{field_name}deserunt sit tempor nostrud
Header NameExample
on-behalf-of"sunt enim"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 1422313607,
      "email": "jones@example.com",
      "first_name": null,
      "id": "YUBh",
      "last_clicked": null,
      "last_emailed": null,
      "last_name": "Jones",
      "last_opened": null,
      "updated_at": 1422313790,
      "custom_fields": [
        {
          "id": 23,
          "name": "pet",
          "value": "Fluffy",
          "type": "text"
        }
      ]
    }
  ]
}
{
  "errors": [
    {
      "message": "The following parameters are not custom fields or reserved fields: [{field_name}]"
    },
    {
      "message": "No search params are specified"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Request Payload
{
  "list_id": -27497588,
  "conditions": [
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    },
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    },
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    },
    {
      "and_or": "",
      "field": "birthday",
      "value": "01/12/1985",
      "operator": "eq"
    }
  ]
}
Response Payload
{
  "recipients": [
    {
      "created_at": -27901208,
      "email": "ut magna quis ipsum",
      "id": "fugiat ad adipisicing ullamco",
      "last_emailed": 21626657
    },
    {
      "created_at": 17466400,
      "email": "sunt irure",
      "id": "et",
      "last_clicked": -23135244,
      "last_opened": -44593357,
      "first_name": "est"
    },
    {
      "created_at": -34495329,
      "email": "reprehenderit incididunt velit Lorem esse",
      "id": "esse Ut ad dolore",
      "last_clicked": 10164083,
      "last_opened": 34443062
    },
    {
      "created_at": -37030673,
      "email": "amet deserunt fugiat voluptate",
      "id": "et exercitation commodo id laborum",
      "last_clicked": -10497425
    },
    {
      "created_at": 3658435,
      "email": "labore veniam",
      "id": "ad pariatur esse",
      "last_opened": -84227501,
      "custom_fields": [
        {
          "id": -5765608,
          "name": "proident pariatur",
          "value": "do in magna mollit",
          "type": "dolore ut"
        },
        {
          "id": -31131201,
          "name": "laborum mollit",
          "value": 84434696,
          "type": "veniam"
        }
      ],
      "updated_at": -56455352,
      "first_name": "Ut cupidatat nulla deserunt adipisicing",
      "last_clicked": -52862671
    }
  ],
  "recipient_count": 65190677
}
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

Contacts API - Custom Fields(5 operations)

Header NameExample
on-behalf-of"irure anim et adipisicing aliquip"
Request Payload
{
  "name": "pet",
  "type": "text"
}
Response Payload
{
  "id": 1,
  "name": "pet",
  "type": "text"
}
{
  "errors": [
    {
      "field": null,
      "message": "Returned if request body is invalid JSON"
    },
    {
      "field": "type",
      "message": "Returned if custom field type is invalid or not provided"
    },
    {
      "field": "name",
      "message": "Returned if custom field name is not provided"
    }
  ]
}
Header NameExample
on-behalf-of"veniam magna"
Request Payload
Response Payload
{
  "custom_fields": [
    {
      "id": 6234,
      "name": "age",
      "type": "number"
    },
    {
      "id": 6233,
      "name": "country",
      "type": "text"
    },
    {
      "id": 6235,
      "name": "favorite_color",
      "type": "text"
    },
    {
      "id": 6239,
      "name": "fname",
      "type": "text"
    },
    {
      "id": 6240,
      "name": "lname",
      "type": "text"
    },
    {
      "id": 49439,
      "name": "pet",
      "type": "text"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"Duis dolor in reprehenderit sit"
Request Payload
Response Payload
{
  "id": 1,
  "name": "pet",
  "type": "text"
}
{
  "errors": [
    {
      "message": "invalid id"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "Custom field ID does not exist"
    }
  ]
}
Header NameExample
on-behalf-of"laborum irure do"
Request Payload
Response Payload
{
  "message": "Custom Field delete is processing."
}
{
  "errors": [
    {
      "message": "Custom field in use by one or more segment conditions"
    },
    {
      "message": "Custom field ID does not exist"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "Custom field ID does not exist"
    }
  ]
}
Header NameExample
on-behalf-of"enim deserunt"
Request Payload
Response Payload
{
  "reserved_fields": [
    {
      "name": "first_name",
      "type": "text"
    },
    {
      "name": "last_name",
      "type": "text"
    },
    {
      "name": "email",
      "type": "text"
    },
    {
      "name": "created_at",
      "type": "date"
    },
    {
      "name": "updated_at",
      "type": "date"
    },
    {
      "name": "last_emailed",
      "type": "date"
    },
    {
      "name": "last_clicked",
      "type": "date"
    },
    {
      "name": "last_opened",
      "type": "date"
    },
    {
      "name": "lists",
      "type": "set"
    },
    {
      "name": "campaigns",
      "type": "set"
    },
    {
      "name": "my_custom_field",
      "type": "text"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Contacts API - Segments(6 operations)

Header NameExample
on-behalf-of"in"
Request Payload
{
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    },
    {
      "field": "last_clicked",
      "value": "01/02/2015",
      "operator": "gt",
      "and_or": "and"
    },
    {
      "field": "clicks.campaign_identifier",
      "value": "513",
      "operator": "eq",
      "and_or": "or"
    }
  ]
}
Response Payload
{
  "id": 1,
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    },
    {
      "field": "last_clicked",
      "value": "01/02/2015",
      "operator": "gt",
      "and_or": "and"
    },
    {
      "field": "clicks.campaign_identifier",
      "value": "513",
      "operator": "eq",
      "and_or": "or"
    }
  ],
  "recipient_count": 0
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"mollit anim Duis ut"
Request Payload
Response Payload
{
  "segments": [
    {
      "id": 1234,
      "name": "Age segments < 25",
      "conditions": [
        {
          "field": "age",
          "value": "25",
          "operator": "lt"
        }
      ],
      "recipient_count": 8
    },
    {
      "id": 2345,
      "name": "email address - gmail",
      "conditions": [
        {
          "field": "email",
          "value": "@gmail.com",
          "operator": "contains"
        }
      ],
      "recipient_count": 0
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
segment_id*20698866
Header NameExample
on-behalf-of"eu dolore"
Request Payload
Response Payload
{
  "id": 1,
  "name": "Last Name Miller",
  "list_id": 4,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ],
  "recipient_count": 1
}
{
  "errors": [
    {
      "message": "if segment_id is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "message": "segment_id not found"
    }
  ]
}
Query Parameter NameExample
segment_idqui cupidatat enim
Header NameExample
on-behalf-of"nulla anim"
Request Payload
{
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ]
}
Response Payload
{
  "id": 5,
  "name": "The Millers",
  "list_id": 5,
  "conditions": [
    {
      "field": "last_name",
      "value": "Miller",
      "operator": "eq",
      "and_or": ""
    }
  ],
  "recipient_count": 1
}
{
  "errors": [
    {
      "message": "request body is not valid json"
    },
    {
      "message": "invalid value is passed into one of the request body parameters"
    },
    {
      "segment_id": "segment_id",
      "message": "segment id is not valid"
    },
    {
      "field": "field",
      "message": "field and set value is not passed into the request body"
    },
    {
      "field": "value",
      "message": "value and set value is not passed into the request body"
    },
    {
      "field": "operator",
      "message": "operator and set value is not passed into the request body"
    },
    {
      "field": "and_or",
      "message": "and_or is not set on more than one condition and less than all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on all conditions"
    },
    {
      "field": "and_or",
      "message": "and_or is set on the only condition passed"
    },
    {
      "field": "and_or",
      "message": "and_or and set value is not passed into the request body"
    },
    {
      "field": "list_id",
      "message": "the list_id is not valid"
    },
    {
      "field": "name",
      "message": "the name is not valid"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Query Parameter NameExample
delete_contactsfalse
Header NameExample
on-behalf-of"ipsum deserunt voluptate"
Request Payload
Error generating example
Response Payload
Error generating example
{
  "errors": [
    {
      "field": "segment_id",
      "message": "Returned if segment_id is not valid"
    },
    {
      "field": "delete_contacts",
      "message": "Returned if delete_contacts is not a valid boolean"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": "segment_id",
      "message": "segment_id does not exist"
    }
  ]
}
Query Parameter NameExample
page-5299303
page_size-81840701
Header NameExample
on-behalf-of"pariatur sunt labore do exercitation"
Request Payload
Response Payload
{
  "recipients": [
    {
      "created_at": 1422313607,
      "email": "jones@example.com",
      "first_name": null,
      "id": "YUBh",
      "last_clicked": null,
      "last_emailed": null,
      "last_name": "Jones",
      "last_opened": null,
      "updated_at": 1422313790,
      "custom_fields": [
        {
          "id": 23,
          "name": "pet",
          "value": "Indiana",
          "type": "text"
        }
      ]
    }
  ]
}
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}

Categories(3 operations)

Query Parameter NameExample
limit86789723
categorysed cupidatat
offset-24416111
Header NameExample
on-behalf-of"aute ex dolore laborum ullamco"
Request Payload
Response Payload
[
  {
    "category": "category 1"
  },
  {
    "category": "category 2"
  }
]
{
  "errors": [
    {
      "field": "sort_by",
      "message": "invalid sort value"
    }
  ]
}
Query Parameter NameExample
sort_by_metricad nisi in
sort_by_directionasc
start_date*dolor Duis quis
end_dateUt do
limit-68708056
offset-79969058
aggregated_byweek
Header NameExample
on-behalf-of"cupidatat culpa"
Request Payload
Response Payload
{
  "date": "2015-01-01",
  "stats": [
    {
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 20,
        "deferred": 0,
        "delivered": 20,
        "invalid_emails": 0,
        "opens": 20,
        "processed": 0,
        "requests": 20,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 20,
        "unique_opens": 20,
        "unsubscribe_drops": 0,
        "unsubscribes": 20
      },
      "name": "cat1",
      "type": "category"
    },
    {
      "metrics": {
        "blocks": 1,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 19,
        "deferred": 0,
        "delivered": 19,
        "invalid_emails": 0,
        "opens": 19,
        "processed": 0,
        "requests": 20,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 19,
        "unique_opens": 19,
        "unsubscribe_drops": 0,
        "unsubscribes": 19
      },
      "name": "cat2",
      "type": "category"
    },
    {
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 5,
        "deferred": 0,
        "delivered": 5,
        "invalid_emails": 0,
        "opens": 5,
        "processed": 0,
        "requests": 5,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 5,
        "unique_opens": 5,
        "unsubscribe_drops": 0,
        "unsubscribes": 5
      },
      "name": "cat3",
      "type": "category"
    },
    {
      "metrics": {
        "blocks": 0,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 6,
        "deferred": 0,
        "delivered": 5,
        "invalid_emails": 0,
        "opens": 6,
        "processed": 0,
        "requests": 5,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 5,
        "unique_opens": 5,
        "unsubscribe_drops": 0,
        "unsubscribes": 6
      },
      "name": "cat4",
      "type": "category"
    },
    {
      "metrics": {
        "blocks": 10,
        "bounce_drops": 0,
        "bounces": 0,
        "clicks": 0,
        "deferred": 0,
        "delivered": 0,
        "invalid_emails": 0,
        "opens": 0,
        "processed": 0,
        "requests": 10,
        "spam_report_drops": 0,
        "spam_reports": 0,
        "unique_clicks": 0,
        "unique_opens": 0,
        "unsubscribe_drops": 0,
        "unsubscribes": 0
      },
      "name": "cat5",
      "type": "category"
    }
  ]
}
Query Parameter NameExample
start_date*sed tempor
end_dateest id consequat qui
categories*in
limit-54122253
offset-94699157
aggregated_byweek
Header NameExample
on-behalf-of"exercitation in mollit sint enim"
Request Payload
Response Payload
[
  {
    "date": "2015-10-01",
    "stats": [
      {
        "type": "category",
        "name": "docs",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      },
      {
        "type": "category",
        "name": "mattscategory",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "category",
        "name": "docs",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      },
      {
        "type": "category",
        "name": "mattscategory",
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]

Campaigns API(11 operations)

Header NameExample
on-behalf-of"quis"
Request Payload
{
  "title": "March Newsletter",
  "subject": "New Products for Spring!",
  "sender_id": 124451,
  "list_ids": [
    110,
    124
  ],
  "segment_ids": [
    110
  ],
  "categories": [
    "spring line"
  ],
  "suppression_group_id": 42,
  "custom_unsubscribe_url": "",
  "ip_pool": "marketing",
  "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
  "plain_content": "Check out our spring line!"
}
Response Payload
{
  "id": 986724,
  "title": "March Newsletter",
  "subject": "New Products for Spring!",
  "sender_id": 124451,
  "list_ids": [
    110,
    124
  ],
  "segment_ids": [
    110
  ],
  "categories": [
    "spring line"
  ],
  "suppression_group_id": 42,
  "custom_unsubscribe_url": "",
  "ip_pool": "marketing",
  "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
  "plain_content": "Check out our spring line!",
  "status": "Draft"
}
{
  "errors": [
    {
      "field": "title",
      "message": "title can't be blank"
    },
    {
      "field": "title",
      "message": "title is too long (maximum is 100 characters)"
    },
    {
      "field": "categories",
      "message": "categories exceeds 10 category limit"
    },
    {
      "field": "html_content",
      "message": "html_content exceeds the 1MB limit"
    },
    {
      "field": "plain_content",
      "message": "plain_content exceeds the 1MB limit"
    },
    {
      "field": "sender_id",
      "message": "sender_id does not exist"
    },
    {
      "field": "sender_id",
      "message": "sender_id is not a verified sender identity"
    },
    {
      "field": "list_ids",
      "message": "list_ids do not all exist"
    },
    {
      "field": "segment_ids",
      "message": "segment_ids do not all exist"
    },
    {
      "field": "ip_pool",
      "message": "The ip pool you provided is invalid"
    },
    {
      "field": "suppression_group_id",
      "message": "suppression_group_id does not exist"
    },
    {
      "field": "unsubscribes",
      "message": "Either suppression_group_id or custom_unsubscribe_url may be set/used, but not both. Please remove one before setting the other."
    },
    {
      "field": null,
      "message": "The JSON you have submitted cannot be parsed."
    },
    {
      "field": null,
      "message": "You've reached your limit of 250 campaigns. Please delete one or more and try again."
    }
  ]
}
{}
Query Parameter NameExample
limit24285929
offset10607636
Header NameExample
on-behalf-of"reprehenderit fugiat deserunt elit"
Request Payload
Response Payload
{
  "result": [
    {
      "id": 986724,
      "title": "March Newsletter",
      "subject": "New Products for Spring!",
      "sender_id": 124451,
      "list_ids": [
        110,
        124
      ],
      "segment_ids": [
        110
      ],
      "categories": [
        "spring line"
      ],
      "suppression_group_id": 42,
      "custom_unsubscribe_url": "",
      "ip_pool": "marketing",
      "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
      "plain_content": "Check out our spring line!",
      "status": "Draft"
    },
    {
      "id": 986723,
      "title": "February Newsletter",
      "subject": "Final Winter Product Sale!",
      "sender_id": 124451,
      "list_ids": [
        110,
        124
      ],
      "segment_ids": [
        110
      ],
      "categories": [
        "winter line"
      ],
      "suppression_group_id": 42,
      "custom_unsubscribe_url": "",
      "ip_pool": "marketing",
      "html_content": "<html><head><title></title></head><body><p>Last call for winter clothes!</p></body></html>",
      "plain_content": "Last call for winter clothes!",
      "status": "Sent"
    }
  ]
}
Header NameExample
on-behalf-of"non laborum eiusmod id aliqua"
Request Payload
Response Payload
{
  "categories": [
    "spring line"
  ],
  "custom_unsubscribe_url": "",
  "html_content": "<html><head><title></title></head><body><p>Check out our spring line!</p></body></html>",
  "id": 986724,
  "ip_pool": "marketing",
  "list_ids": [
    110
  ],
  "plain_content": "Check out our spring line!",
  "segment_ids": [
    110
  ],
  "sender_id": 124451,
  "status": "Draft",
  "subject": "New Products for Spring!",
  "suppression_group_id": 42,
  "title": "March Newsletter"
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"ut exercitation commodo reprehenderit laborum"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{}
Header NameExample
on-behalf-of"do culpa consectetur pariatur laboris"
Request Payload
{
  "title": "May Newsletter",
  "subject": "New Products for Summer!",
  "categories": [
    "summer line"
  ],
  "html_content": "<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>",
  "plain_content": "Check out our summer line!"
}
Response Payload
{
  "id": 986724,
  "title": "May Newsletter",
  "subject": "New Products for Summer!",
  "sender_id": 124451,
  "list_ids": [
    110,
    124
  ],
  "segment_ids": [
    110
  ],
  "categories": [
    "summer line"
  ],
  "suppression_group_id": 42,
  "custom_unsubscribe_url": "",
  "ip_pool": "marketing",
  "html_content": "<html><head><title></title></head><body><p>Check out our summer line!</p></body></html>",
  "plain_content": "Check out our summer line!",
  "status": "Draft"
}
{
  "errors": [
    {
      "field": "title",
      "message": "title can't be blank"
    },
    {
      "field": "title",
      "message": "title is too long (maximum is 100 characters)"
    },
    {
      "field": "categories",
      "message": "categories exceeds 10 category limit"
    },
    {
      "field": "html_content",
      "message": "html_content exceeds the 1MB limit"
    },
    {
      "field": "plain_content",
      "message": "plain_content exceeds the 1MB limit"
    },
    {
      "field": "sender_id",
      "message": "sender_id does not exist"
    },
    {
      "field": "sender_id",
      "message": "sender_id is not a verified sender identity"
    },
    {
      "field": "list_ids",
      "message": "list_ids do not all exist"
    },
    {
      "field": "segment_ids",
      "message": "segment_ids do not all exist"
    },
    {
      "field": "ip_pool",
      "message": "The ip pool you provided is invalid"
    },
    {
      "field": "suppression_group_id",
      "message": "suppression_group_id does not exist"
    },
    {
      "field": "unsubscribes",
      "message": "Either suppression_group_id or custom_unsubscribe_url may be set/used, but not both. Please remove one before setting the other."
    },
    {
      "field": null,
      "message": "The JSON you have submitted cannot be parsed."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "You may only update a campaign when it is in draft mode."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"exercitation amet"
Request Payload
Response Payload
{
  "id": 1234,
  "status": "Scheduled"
}
{
  "errors": [
    {
      "field": "subject",
      "message": "subject can't be blank"
    },
    {
      "field": "sender_id",
      "message": "sender_id can't be blank"
    },
    {
      "field": "plain_content",
      "message": "plain_content can't be blank, please provide plain text or html content"
    },
    {
      "field": "list_id",
      "message": "You must select at least 1 segment or 1 list to send to."
    },
    {
      "field": "unsubscribe_tag",
      "message": "An [unsubscribe] tag in both your html and plain content is required to send a campaign."
    },
    {
      "field": "suppression_group_id",
      "message": "Either a suppression_group_id or custom_unsubscribe_url is required to send a campaign."
    },
    {
      "field": null,
      "message": "You do not have enough credits to send this campaign. Upgrade your plan to send more: https://app.sendgrid.com/settings/billing"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "You may only send a campaign when it is in draft mode."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"labore culpa sed minim dolore"
Request Payload
{
  "send_at": 1489771528
}
Response Payload
{
  "id": 1234,
  "send_at": 1489771528,
  "status": "Scheduled"
}
{
  "errors": [
    {
      "field": "subject",
      "message": "subject can't be blank"
    },
    {
      "field": "sender_id",
      "message": "sender_id can't be blank"
    },
    {
      "field": "plain_content",
      "message": "plain_content can't be blank, please provide plain text or html content"
    },
    {
      "field": "list_id",
      "message": "You must select at least 1 segment or 1 list to send to."
    },
    {
      "field": "unsubscribe_tag",
      "message": "An [unsubscribe] tag in both your html and plain content is required to send a campaign."
    },
    {
      "field": "suppression_group_id",
      "message": "Either a suppression_group_id or custom_unsubscribe_url is required to send a campaign."
    },
    {
      "field": null,
      "message": "You do not have enough credits to send this campaign. Upgrade your plan to send more: https://app.sendgrid.com/settings/billing"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "You cannot POST to a campaign that has already sent or scheduled. However you can update a scheduled campaign with a PATCH."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"dolor"
Request Payload
{
  "send_at": 1489451436
}
Response Payload
{
  "id": 19997450,
  "send_at": -10486844,
  "status": "id"
}
{
  "errors": [
    {
      "field": "send_at",
      "message": "Please choose a future time for sending your campaign."
    },
    {
      "field": null,
      "message": "The JSON you have submitted cannot be parsed."
    },
    {
      "field": null,
      "message": "You do not have enough credits to send this campaign. Upgrade your plan to send https://app.sendgrid.com/settings/billing"
    }
  ]
}
{
  "errors": [
    {
      "field": "send_at",
      "message": "You cannot update the send_at value of non-scheduled campaign."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"ut ex Duis reprehenderit amet"
Request Payload
Response Payload
{
  "send_at": 1490778528
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"esse nulla reprehenderit"
Request Payload
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "This campaign is already In Progress."
    },
    {
      "field": null,
      "message": "This campaign is already Sent."
    },
    {
      "field": null,
      "message": "This campaign is already Paused."
    },
    {
      "field": null,
      "message": "This campaign is already Canceled."
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}
Header NameExample
on-behalf-of"tempor"
Request Payload
{
  "to": "your.email@example.com"
}
Response Payload
{
  "to": "magna aliqua mollit cupidatat"
}
{
  "errors": [
    {
      "field": "send_at",
      "message": "Please choose a future time for sending your campaign."
    },
    {
      "field": null,
      "message": "The JSON you have submitted cannot be parsed."
    },
    {
      "field": null,
      "message": "You do not have enough credits to send this campaign. Upgrade your plan to send more: https://app.sendgrid.com/settings/billing"
    }
  ]
}
{
  "errors": [
    {
      "field": null,
      "message": "not found"
    }
  ]
}

Transactional Templates(6 operations)

Header NameExample
on-behalf-of"dolor pariatur et in nisi"
Request Payload
{
  "name": "example_name",
  "generation": "dynamic"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "example_name",
  "generation": "legacy",
  "versions": []
}
Query Parameter NameExample
generationsdynamic
page_size*164.7155407341135
page_tokensint irure
Header NameExample
on-behalf-of"deserunt"
Request Payload
Response Payload
{
  "result": [
    {
      "id": "fae7c985-eb92-4b47-9987-28ec29dbc698",
      "name": "example_name",
      "generation": "legacy",
      "updated_at ": "2020-11-12 12:00:09",
      "versions": []
    }
  ],
  "_metadata": {
    "self": "https://api.sendgrid.com/v3/templates",
    "count": 1
  }
}
{
  "errors": [
    {
      "": "proident cillum",
      "error_id": "do nulla est sit eiusmod",
      "message": "eiusmod eu"
    },
    {
      "": "in commodo culpa",
      "error_id": "Lorem officia",
      "message": "labore pariatur in voluptate"
    },
    {
      "": "eu",
      "error_id": "fugiat veniam sed",
      "message": "labore sint adipisicing in"
    },
    {
      "": "magna sed sint",
      "error_id": "irure",
      "message": "Duis commodo culpa mollit cupidatat"
    },
    {
      "": "aliquip",
      "error_id": "reprehenderit ipsum officia culpa",
      "message": "Lorem cillum velit laboris amet"
    }
  ]
}
Header NameExample
on-behalf-of"sit eu voluptate occaecat"
Request Payload
{
  "name": "example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa2371",
  "name": "example_name",
  "generation": "dynamic",
  "updated_at ": "2019-03-13T11:52:41.009Z",
  "versions": []
}
Header NameExample
on-behalf-of"laborum fugiat occaecat"
Request Payload
Response Payload
{
  "id": "40da60e6-66f3-4223-9406-ba58b7f55a62",
  "name": "Duis in dolor",
  "generation": "legacy",
  "updated_at ": "2020-12-12 58:26:65",
  "versions": []
}
Header NameExample
on-behalf-of"incididunt Excepteur"
Request Payload
{
  "name": "new_example_name"
}
Response Payload
{
  "id": "733ba07f-ead1-41fc-933a-3976baa23716",
  "name": "new_example_name",
  "versions": []
}
Header NameExample
on-behalf-of"sed labore"
Request Payload
Response Payload
{}

Transactional Templates Versions(5 operations)

Header NameExample
on-behalf-of"dolor et"
Request Payload
{
  "active": 1,
  "name": "example_version_name",
  "html_content": "<HTML body content>",
  "plain_content": "Plain text content",
  "generate_plain_content": false,
  "subject": "<Subject>",
  "editor": "design"
}
Response Payload
{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
  "active": 1,
  "name": "example_version_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "generate_plain_content": true,
  "subject": "<%subject%>",
  "updated_at": "2019-03-13 18:56:33",
  "editor": "code"
}
Header NameExample
on-behalf-of"in aliquip exercitation minim"
Request Payload
Response Payload
{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
  "active": 1,
  "name": "example_version_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "generate_plain_content": true,
  "subject": "<%subject%>",
  "updated_at": "2019-03-13 18:56:33",
  "editor": "code"
}
Header NameExample
on-behalf-of"ullamco mollit"
Request Payload
Response Payload
{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
  "active": 1,
  "name": "example_version_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "generate_plain_content": true,
  "subject": "<%subject%>",
  "updated_at": "2019-03-13 18:56:33",
  "editor": "code"
}
Header NameExample
on-behalf-of"sit consectetur Ut"
Request Payload
{
  "template_id": "Excepteur Ut qui",
  "active": 1,
  "name": "pariatur non incididunt commodo",
  "html_content": "dolor",
  "generate_plain_content": false,
  "subject": "aliquip nulla Ut",
  "editor": "design",
  "plain_content": "labore dolore"
}
Response Payload
{
  "id": "8aefe0ee-f12b-4575-b5b7-c97e21cb36f3",
  "template_id": "ddb96bbc-9b92-425e-8979-99464621b543",
  "active": 1,
  "name": "example_version_name",
  "html_content": "<%body%>",
  "plain_content": "<%body%>",
  "generate_plain_content": true,
  "subject": "<%subject%>",
  "updated_at": "2019-03-13 18:56:33",
  "editor": "code"
}
Header NameExample
on-behalf-of"incididunt laboris do"
Request Payload
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

Webhooks(7 operations)

Header NameExample
on-behalf-of"nisi et qui aliquip anim"
Request Payload
Response Payload
{
  "enabled": false,
  "url": "incididunt reprehenderit",
  "group_resubscribe": false,
  "delivered": false,
  "group_unsubscribe": false,
  "spam_report": false,
  "bounce": false,
  "deferred": false,
  "unsubscribe": true,
  "processed": false,
  "open": true,
  "click": true,
  "dropped": true,
  "oauth_client_id": "est fugiat",
  "oauth_token_url": "Duis in laborum sunt"
}
Header NameExample
on-behalf-of"nostrud"
Request Payload
{
  "enabled": false,
  "url": "id aliqua",
  "group_resubscribe": true,
  "delivered": false,
  "group_unsubscribe": true,
  "spam_report": true,
  "bounce": false,
  "deferred": false,
  "unsubscribe": true,
  "processed": false,
  "open": false,
  "click": false,
  "dropped": false,
  "oauth_client_id": "reprehenderit in null",
  "oauth_client_secret": "ea in nostrud",
  "oauth_token_url": "cupidatat ad Ut"
}
Response Payload
{
  "enabled": true,
  "url": "mollit laborum",
  "group_resubscribe": false,
  "delivered": true,
  "group_unsubscribe": true,
  "spam_report": true,
  "bounce": true,
  "deferred": true,
  "unsubscribe": true,
  "processed": true,
  "open": true,
  "click": false,
  "dropped": true,
  "oauth_client_id": "anim sunt",
  "oauth_token_url": "ex"
}
Header NameExample
on-behalf-of"dolore velit ullamco"
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": "fugiat anim magna ut quis"
    },
    {
      "message": "non nulla in"
    },
    {
      "message": "Excepteur dolore magna ut est"
    },
    {
      "message": "sint laborum id"
    }
  ]
}
Query Parameter NameExample
limitsunt magna pariatur
offsetExcepteur laborum
aggregated_byday
start_date*ad magna
end_datedolor ullamco
Header NameExample
on-behalf-of"commodo amet eiusmod minim"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "metrics": {
          "received": 0
        }
      }
    ]
  }
]
Header NameExample
on-behalf-of"laborum sint mollit tempor est"
Request Payload
Response Payload
{
  "public_key": "anim quis in sint"
}
Header NameExample
on-behalf-of"aute aliquip"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "public_key": "voluptate id Excepteur proident"
}
{
  "errors": [
    {
      "message": "mollit consequat dolore commodo",
      "field": "anim Ut"
    },
    {
      "message": "qui"
    },
    {
      "message": "commodo dolor ipsum"
    },
    {
      "message": "minim fugiat amet",
      "field": "quis consectetur eiusmod ullamco laboris"
    }
  ]
}
{
  "errors": [
    {
      "message": "fugiat",
      "field": "in proident"
    },
    {
      "message": "adipisicing veniam laboris sunt ullamco",
      "field": "ut"
    },
    {
      "message": "id sunt consequat Duis irure"
    },
    {
      "message": "nisi",
      "field": "in qui"
    },
    {
      "message": "tempor in eiusmod elit"
    }
  ]
}
{
  "errors": [
    {
      "message": "Excepteur culpa esse ea ut"
    },
    {
      "message": "enim Excepteur dolore dolore"
    },
    {
      "message": "dolor occaecat"
    }
  ]
}
Header NameExample
on-behalf-of"in consequat ea aute"
Request Payload
{
  "url": "mollit non ipsum magna",
  "oauth_client_id": "nisi",
  "oauth_client_secret": "veniam commodo ex sunt",
  "oauth_token_url": "dolor Duis"
}
Response Payload
Missing schema or example in the OpenAPI spec.
Update the definition and recreate the mock server.

Settings - Inbound Parse(4 operations)

Header NameExample
on-behalf-of"nisi aute"
Request Payload
{
  "url": "http://email.myhostname.com",
  "hostname": "myhostname.com",
  "spam_check": false,
  "send_raw": true
}
Response Payload
{
  "url": "http://email.myhostname.com",
  "hostname": "myhostname.com",
  "spam_check": false,
  "send_raw": true
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
{
  "errors": [
    {
      "message": "id consequat laborum dolore"
    },
    {
      "message": "minim officia"
    },
    {
      "message": "occaecat deserunt"
    }
  ]
}
Header NameExample
on-behalf-of"adipisicing reprehenderit"
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": "Lorem sunt laborum enim id"
    },
    {
      "message": "ullamco"
    }
  ]
}
Header NameExample
on-behalf-of"eu consequat sit"
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": "in non cupidatat consectetur"
    },
    {
      "message": "ut officia mollit et pariatur"
    }
  ]
}
Header NameExample
on-behalf-of"nostrud"
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": "dolore adipisicing cillum in eu"
    }
  ]
}

Query(2 operations)

Query Parameter NameExample
query*mollit esse dolore qui in
limit722.6952066266697
Header NameExample
X-Query-Id"irure sed mollit do"
X-Cursor"anim Lorem cillum ipsum adipisicing"
Authorization*"dolor adipisicing elit do commodo"
Request Payload
Response Payload
{
  "messages": [
    {
      "from_email": "from@test.com",
      "msg_id": "abc123",
      "subject": "something profound",
      "to_email": "to@test.com",
      "status": "processed",
      "opens_count": 0,
      "clicks_count": 0,
      "last_event_time": 1495064728,
      "last_timestamp": 1495064728
    },
    {
      "from_email": "yeah@test.com",
      "msg_id": "321befe",
      "subject": "something profound",
      "to_email": "nah@test.com",
      "status": "delivered",
      "opens_count": 500,
      "clicks_count": 200,
      "last_event_time": 1495064793,
      "last_timestamp": 1495064793
    },
    {
      "from_email": "sad@test.com",
      "msg_id": "434512dfg",
      "subject": "something sad",
      "to_email": "reject@test.com",
      "status": "not delivered",
      "opens_count": 0,
      "clicks_count": 0,
      "last_event_time": 1495064993,
      "last_timestamp": 1495064993
    }
  ]
}
{
  "errors": [
    {
      "message": "invalid syntax: 'bad_field' is not a known field"
    }
  ]
}
{
  "errors": [
    {
      "message": "too many requests"
    }
  ]
}
Header NameExample
Authorization*"laborum"
Request Payload
Response Payload
{
  "from_email": "LKb.pOGYIZbfxMgi7Le0K1YWym%e5pz2PiuGbwByM2tR+wRPqfoFg1__35DaWF8CDhzYJg@ZTSFDjbgdxD23oq34Lun1NUnyymoGT4G.5i1IEzQpXWAvNwx.BNckAJiBCnwEVnwBfrbMlouoOPmtTSEbdPp",
  "msg_id": "hznSfJ1RfKeIKS1B4mShNnkRMpdt5IXXKf",
  "subject": "culpa aute amet magna sint",
  "to_email": "+lOnUtHodefMsuBw.kunNalfcxRos5USSRoR@r5uEXYPP6wrQGRQ-vBg33fLY6MVkkMd-DKT8Z1iqt4qnrL23xMOZ8GWd.fyghGEFceTHIUpgwNGlwEtFHJikSaPzsnYfrJPKydPVPAlItJtqykRHZSGW",
  "status": "delivered",
  "template_id": "d674d9b7-e8e5-4e30-87be-1b3b026235fd",
  "asm_group_id": 5464443,
  "teammate": "9a8F0EP88wSSJeuOyXtbfc7BkK",
  "api_key_id": "bUshz3LGa3coToxA2sWViYAEJJmYZJRyY9BCQY",
  "events": [
    {
      "event_name": "unsubscribe",
      "processed": 7085461846,
      "bounce_type": "soft",
      "http_user_agent": "Mozilla/5.0 (Windows NT 5.1; rv:11.0) Gecko Firefox/11.0",
      "mx_server": "s",
      "attempt_num": 8
    },
    {
      "event_name": "dropped",
      "processed": 9878933331,
      "attempt_num": 3,
      "url": "G_3c-1HtUkN4`puC&&!u>0OiStFG.ZoRi2=j%fUVa]&re6k{hKqD-8vWE<hw-Bd>12Fb5JC6z>S@@'cWS~w5KtuIwv$8/JDD94CXx1n5yjC_I2lQ66zDj4MXe/4bqlcqqQ7evnQWTYx5roaEYMapyuzb/USpsyalh/HcYc9PmQfF8ND_C7bXnwFQ_fb_BHMXbIV8JN28/NjZdawDJ6kSWxLykSVTHzcISGPBRfs_rt3Uc65Vzj6LDSSMN8WRs70m0tAWs/fkDvjvm_7ZeV08YZeB9j9mS9BcE089Fn5UzDlTJW9vqDF5uipjlIVrNbM7oWE/MIJcjg2vJO20jA24WHrchrEXCvKcxriviSDl3tuyDxqdqRSekpm2aH6yW7_ylXj/nWsex4jm3rKvYw1uLq3Tp7qb9edhj8B_TnwLv1yjHSkgbA5jKI4BTqxugmwVTnFf2OFCFp/ZILLkoKgfwOyIK4reUIkhCjuhkwp/cqGaFAkeCFQXPB6DLYesLZ2M3KPuBsBrs3pr3HRbTtwaOzdKtGc8e0C0VTjrJ3GwljStMPrSuQWh6/vigHRasZ4P9kFv5DPVbHWZzPvtwUw0AMByt44YH678WpbAXXy4I/IVOHmErZTbw1mJ/3vd4uI5rr2zEO_YA9qJZLJT/wmBimbOyaMtmTNYr_FhgfkKMN3_1la7RCK8CIP3p26mbuHbdJV1j/5sTIKibInM5l2BoWdEi49bPqzagsfjKpGVbg0YQ8mjrLhI92/qy0eVYi34kBGVuLzxK2FLC8vwYUrbupjUYE23Mc_6nmHYRK1HF1QmZDZG1hw96I3MPbTZqeJOWGch230qDNxOgnHRNNM52k/3c7FeuRr88RwZGpif/4FaSAbdqkUNvJ9J9qX2tJS9x5vZlgD8k4YHIXDztrnwg2VPquj/uo_2MjbWybIF/NGJM2RFAsKV1S5iOejuTV4p12KlH1p0Dt5EpxCSIl0XoWuvyLYar77f_hzqNdWAyL0FDxGfj4ma4jwqdTTLNyeZEtguYoCHTFfY/HgJkpHx/yO23G7gLhKPvD459ceffHidFh7LipTxNF0GFXhIAPrWfhv7PkPmVofBoFFlo6/rMcHQ82d5VS8i1CCyLtfuT5WH9GqrsOY7xo3lxi7BNL93/PLRdQT3SObRFRERw68V5ZFvIuEQqFOFZQ848rWPLXYDGY658dyjZALf/Ug4EROi_ehNtzPwecer_RGBHxeMnpxrPAFZEL6YXNKzm8hh3HY4Uc4fgkjge5fXsR4CeTSkS66/FOD00deDKmN7XcHEj1LGlAmd4XlV8vFpXg2VazX4OLW8z6vXn5vntNGYO6eBCEKUwupRz9nQSMeZ/Pbmjoopyt6TxQBUfPkHBdgCIhqA1zDV72ARqGlK_ao9KVjvgbB98YeiieIyogkuOa4y0E5iUEdBopzovVgtY88yLijh9ww/tl0R5rI2P2_OxguTbv_wrfEm8jRjISEIqSE9q29RB3n8PeD4hu24rcsaEuTMCqniiLN0a2OtZiKxHnbsNB660Aq3/tEo2SHZBkkIFYXBbDNE7gLfvFz9ZaC_E2oV2quyK1Id5SkNkJBVRRgROWBc_XEOXktc4vRUKxy1MQ526Xilyo8/uI67lHH1Vlr4V3GVmweT4A16KMqzmVzvRDRFLpkBv2iu3Okc1vIqkC/426aOqeUm6SXIx16d8BWVRcmqKqizxDEF3JkLFgX0ab73CZ4GdJ9YaakJO7y4adFGzzIVLcn08UZ/pwDQ9BAuwuMc2yMnKihdvmLKbnAa1ATk9jFXQ9QAEMBHZLbPNvtS3pkpk0s6fyh2ceHa9Myy3fL/oqvPmq_14KzLgPZHaOlyb3tUoQM52fv/I78TqTGyB4WYD_vkm8gYHZcCF0dFIXsiXUbAbwR90Ldk8lsgxSL6rBvjPSlQq7N66NPzUVRYr3zSISupG_66uS4rJszHwmxmmraT3/zfVKxHXFHgxUDRmnwIMfdFKm4sf/qnRRccOLExJYGcZy8u65jo4gHDvO6vnpsdf0YtVWqDBJXa95/Y/qL7EYS73_t6/2xnWra9TTO0OtQNXEQ1XXLSLt6vPw1FTlE2aYCitDgUo7DyxiwuGtvmMKUkYCo/lqXouo2TGXZFF80lrCu1vKdxBgOOerlrsKrOJawGEzL8XzXdxkOMUT8HOzHPNOvDwsxc47mvpVzXEbX5DRaioOlm2U4flTG/6bZfLqJqHNtrKwC5U5NNG6_yNOW5Jg_bLmzUosi86IXxn7i04vRXXn92JmdE70TcdujehT1n15wtiD8ld5A65IV2W1801/wr0XcDIGiUSmxFfCozUCtBTFwln0uJ0cquSDXhj7JQADhYDGyz8WhqcPE7CP9xN93EUBrWczINbA4IsfckY8CZh68/Tak5dEhw8i_3rz/8U39D/iML1G_A8TsnKQ9/_S8o89fFc7Wx/f1nXF8H6OLVbPpp5IZg7UTZ2K0bSe3iBpsmkkJpxY_6zEHTJE3LbIANwF9Ik5Tu0ZJpjck7I07xlHR8mDW9FXclSQC/qJUGL5qByf2SY2Wd24hqKGrahLfqApQuRI8_DtU/Y8kH6DDif5kD6as3sIe6VbKYnU9c1URq/npTlE72m107FXxW9zktdzbBJAxt4udMFzjt2LPcBpqrMKGkrg4BHqKXwhFTspCWyYCjxJ/eFb3fd3BB5kb9D0yl3oOjeWtbJBqsboyzdLisRBn2MCtXO2O8eo4Hkm/2uJDoRjRCyIi2GNRkH0B3EkN6Z3vG40C985bAtM8eqHABzP2QRcKCz4ICOw_Xz249bJk8qM0/m4EeIWnx2ISf9TBU6_0KZ5QJ0VPOCPXxV9jCeK5W5/RV5nd7GUUXG0btDqUAa3DzpaRHX3klMAqL73hK4AGD3ItikmxF8vnSaqtsgOCpEePERt9qcUOJJP2aR0scPAf_1TkGSrgr5VF/XLM2i7YhC_3J9fA2Qwa0dbTedY/xGayjimEkuWSWvh7P5FNOum_l7qJPnA31lQq6ixqR0NKhO328rWfijqKHF6WR/5O0MJ4WNuIXk6xBtTOA9mK7CGUgWjaF5mB72PVnDpN8G6ERO39GqO/fCO96/A1mwIPWedF6HklU8jaQ_M5EUzwCsBE3/7FW2hbcD3GCOFCiLvObjn59o6CKoYlmTop/PZw2CLzvARAr5KaLhjIuZRSKTGlmYjvSoSELuvWi/QHUV7SJ0kF_1O3b_3a88cm/z7qD3Rp6MmoQdGPSyu1lXTpoETypgOMywfsr4ycV2LQr5XaE3UrQP/RzobA4rI_I3ceCUaRASmil2rV1TUiyljhdCFt8zmi1o2NyTzSBRNGP0lXU5Qtm6dKKp7lGRC19P2oSSFrxt85vWRNo1mv8odcL/TF7/MN1Ev7gY20MqlRSBrlwg5LZ4_Az7QnBnpbU3LkTC/oVb743VFtXMW4cK/3lw6wfBJZe_8DobxT_6/gCXp6QOs/LuqmrQHMQvTS6jfbqVFnPfLjrQ01Mb_F4lr3md6m87wpc1CYd9hdzgUL/aqz68HMDCxjGauC00Rajq9wGVYcWJ3j6rIaHIPwclftjARXFDg0yH8v/L6qDgIgGwbB3eZfjOXHAMXRFNMMihseZxYkcFAzLtYr94q9XpQeK4bKi9h_rWAMwcEHnS8/MHHlySbgy8azGEA0u9xsY96MRi45Qe74kZ9xlsI1t4Yutx8/gsjIiu7vNsKEyeTwd88BMExjWNcJHOSHRff57pJBMEAtPdbMETYorvUkRyErsqprxX0W45n0RRQ85w/JCOsYaxZOAFfzO0AdLpMCguFwl01fkFOKYrQeXfNn8w0KF4XS0k/fPx02fU7fFjUoXcPH7_9xo755WL8DNIU2ne4b6DpiROe473yUfD8_zSNUI1tpxzVYNA7GvVSYt8UtqHn3/_QwuOc4VeAI6RiAG5O5bcAxzQl96Q35emNwtTT_CYqHORCmyPj6By2hT_SCLf8m_xFxxe3YzvnxDZGq3qf__pq7Tw181/GosBAJy3MotiIxcYDASbY9sV4T2V/KoGHyJ64spdkQbJOHJ216JMSKj8ii5m8gxqJ2ypL81p5hbjWtjbUgSc8M_KTLuc0Owf1R/3vr/dKbQ2pJ4XEfXhnZTBQY7ZrClnVCnd5cMe9ic/aNF0yyOSQVVOecUFkK9IYFVR8VHdVf4/Nfu3nOEskHki1_r3At1HLOMniS6qNTvhS0hfqIuBiQBsd5aB7OdfVpYy1HdIR72gMToBlpHPsE5GrVO0J9/gcyB2xcyZ3UpTom8G3V48LUkk6kcJ6l1SL5Fgzbst0z3pDA4dzBfswbC8dW57_MkswDANNd8atPrOBSU5m2z66dP/mIYQ8iq/DcmBexkARDI47VzYuw5gwy8Lvym2_B2gxBokU9_T/fHCPjlpqjTsY6SgBOz1nlDh_HcSWYAqnyrZxbEO2erVJ4WPKNzjM3KaPXGH/dZryna1E28wxCrMqLCs9aL9oVBlDMjUcEryAyRh7xwN0uWGopdpkd7Du6O9EPjAj37sHkUiVs7WL6JyexoDF_n67MICvQnJ9FK/FVrp1uMZnmr7ijkMW87moNRBkXbVc2EA_hHOHmpbVGqr6WgNtJ7bBk1LrAPT8sKtE75vbe_L9VYqBHJ/njk.WIIj-V23pwC7ZahcIL0XnDPupL7ltwEc779Ofhrk9dt_wIOFsA8XwnCjrYqH2ty.F0XdS\"*;@kDYgfL4dwE/5I@>k|u0D:wGz\"_8=}RJM!Ybbwd}eN=ZB*esF&(iQ%FW]_FSA:3Ze4O*6&tG-Fe**/j^a&S8zIa#6gxL2NmnNMSVGF-Bf3z08tt0ug_UfNshhs4HJh0l1o24gjAN-Uck1OvWkGQSXH0glB7CnOm0gI",
      "bounce_type": "soft",
      "mx_server": "laborum nisi",
      "http_user_agent": "quis re"
    }
  ],
  "originating_ip": "204.173.18.0",
  "categories": [
    "dolor",
    "pie"
  ],
  "unique_args": "eu",
  "outbound_ip": "181.40.184.87",
  "outbound_ip_type": "dedicated",
  "id": "2mMUdxV2HRfAeDiBTYs2IP"
}
{
  "errors": [
    {
      "message": "invalid syntax: 'bad_field' is not a known field"
    }
  ]
}
{
  "errors": [
    {
      "message": "not found",
      "field": "message_id"
    }
  ]
}
{
  "errors": [
    {
      "message": "too many requests"
    }
  ]
}

CSV (UI only)(2 operations)

Query Parameter NameExample
querylabore nulla aliqua Excepteur nisi
Header NameExample
Authorization*"Lorem dolor"
Request Payload
Response Payload
{
  "status": "pending",
  "message": "An email will be sent to jane_doe@example.com when the CSV is ready to download."
}
{
  "errors": [
    {
      "message": "some error"
    }
  ]
}
{
  "errors": [
    {
      "message": "too many requests",
      "field": ""
    }
  ]
}
{
  "errors": [
    {
      "message": "internal server error"
    }
  ]
}
Header NameExample
Authorization*"dolor occaecat laboris"
Request Payload
Response Payload
{
  "presigned_url": "https://example.com",
  "csv": "https://s3-us-west-2.amazonaws.com/sendgrid-rts-development-queries/013c31af-7c9a-49e6-922c-d990f4aff151.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=3600&X-Amz-Credential=AKIAI4NOW7APZHRFYGWQ%2F20170728%2Fus-west-2%2Fs3%2Faws4_request&X-Amz-SignedHeaders=host&X-Amz-Date=20170728T223936Z&X-Amz-Signature=5c13ede58b211799ab1a556280bd316c404eac3aef1450c47906a077166c4ab4"
}
{
  "errors": [
    {
      "message": "download token is invalid or expired",
      "field": ""
    }
  ]
}
{
  "errors": [
    {
      "message": "internal server error"
    }
  ]
}

Settings - Tracking(9 operations)

Header NameExample
on-behalf-of"minim proident nostrud"
Request Payload
Response Payload
{
  "result": [
    {
      "name": "open",
      "title": "Open Tracking",
      "description": "lorem ipsum... .",
      "enabled": true
    }
  ]
}
Header NameExample
on-behalf-of"sunt quis minim"
Request Payload
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"ut"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enable_text": false,
  "enabled": true
}
Header NameExample
on-behalf-of"dolore"
Request Payload
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"laboris magna aliquip ad"
Request Payload
{
  "enabled": true,
  "utm_source": "sendgrid.com",
  "utm_medium": "email",
  "utm_term": "",
  "utm_content": "",
  "utm_campaign": "website"
}
Response Payload
{
  "enabled": true,
  "utm_campaign": "",
  "utm_content": "lotsandlotsofcontent",
  "utm_medium": "",
  "utm_source": "",
  "utm_term": ""
}
Header NameExample
on-behalf-of"ut sint eu exercitation"
Request Payload
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"cupidatat esse adipisicing amet in"
Request Payload
{
  "enabled": true
}
Response Payload
{
  "enabled": true
}
Header NameExample
on-behalf-of"commodo in"
Request Payload
Response Payload
{
  "enabled": true,
  "html_content": "<p>Something something unsubscribe <% %> something something</p>\n",
  "landing": "<p>subscribehere</p>\n",
  "plain_content": "Something something unsubscribe <% %> something something",
  "replace": "thetag",
  "url": ""
}
Header NameExample
on-behalf-of"commodo ex"
Request Payload
{
  "enabled": true,
  "landing": "landing page html",
  "url": "url",
  "replace": "replacement tag",
  "html_content": "html content",
  "plain_content": "text content"
}
Response Payload
{
  "enabled": true,
  "landing": "landing page html",
  "url": "url",
  "replace": "replacement tag",
  "html_content": "html content",
  "plain_content": "text content"
}

Stats(7 operations)

Query Parameter NameExample
limit-90243568
offset55552061
aggregated_byweek
start_date*minim id dolor magna
end_dateirure
Header NameExample
on-behalf-of"amet"
Request Payload
Response Payload
[
  {
    "date": "2015-11-03",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "metrics": {
          "blocks": 0,
          "bounce_drops": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "invalid_emails": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_report_drops": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0,
          "unsubscribe_drops": 0,
          "unsubscribes": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
countryUS
limit-65638701
offset46044839
aggregated_bymonth
start_date*id nulla et
end_dateirure qui eiusmod dolor
Header NameExample
on-behalf-of"ut dolore aliqua"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 1,
          "unique_clicks": 0,
          "unique_opens": 1
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "type": "province",
        "name": "TX",
        "metrics": {
          "clicks": 0,
          "opens": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
limit-74057689
offset10482612
aggregated_byday
start_date*reprehenderit ullamco occaecat officia
end_dateeiusmod
Header NameExample
on-behalf-of"ullamco proident enim anim"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 2,
          "unique_opens": 2
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "type": "device",
        "name": "Webmail",
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
start_date*adipisicing ipsum
end_dateanim eu non nisi
aggregated_bymonth
Header NameExample
on-behalf-of"culpa proident sunt in"
Request Payload
Response Payload
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  }
]
Query Parameter NameExample
start_date*dolore eiusmod non
end_dateculpa fugiat est elit laboris
aggregated_byday
Header NameExample
on-behalf-of"ut ut et magna aute"
Request Payload
Response Payload
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "opens": 1,
          "unique_opens": 1
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "opens": 0,
          "unique_opens": 0
        },
        "name": "Gmail",
        "type": "client"
      }
    ]
  }
]
Query Parameter NameExample
mailbox_providerstempor dolor
limit90730726
offset26762779
aggregated_bymonth
start_date*sed
end_dateest minim ut
Header NameExample
on-behalf-of"dolor esse non sint"
Request Payload
Response Payload
[
  {
    "date": "2015-10-11",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-12",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-13",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-14",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-15",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-16",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-17",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-18",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-19",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-20",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-21",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 1,
          "drops": 0,
          "opens": 1,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 1
        }
      }
    ]
  },
  {
    "date": "2015-10-22",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-23",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-24",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-25",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-26",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 2,
          "drops": 0,
          "opens": 2,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 2
        }
      }
    ]
  },
  {
    "date": "2015-10-27",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-28",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-29",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-30",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-10-31",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-01",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-02",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-03",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-04",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-05",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-06",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-07",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-08",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-09",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  },
  {
    "date": "2015-11-10",
    "stats": [
      {
        "type": "mailbox_provider",
        "name": "Gmail",
        "metrics": {
          "blocks": 0,
          "bounces": 0,
          "clicks": 0,
          "deferred": 0,
          "delivered": 0,
          "drops": 0,
          "opens": 0,
          "processed": 0,
          "requests": 0,
          "spam_reports": 0,
          "unique_clicks": 0,
          "unique_opens": 0
        }
      }
    ]
  }
]
Query Parameter NameExample
browsersculpa
limit-71943303
offset-4773848
aggregated_bymonth
start_date*labore nulla
end_dateoccaecat incididunt dolore in
Header NameExample
on-behalf-of"dolore consectetur culpa"
Request Payload
Response Payload
[
  {
    "date": "2014-10-01",
    "stats": [
      {
        "metrics": {
          "clicks": 0,
          "unique_clicks": 0
        },
        "name": "Chrome",
        "type": "browser"
      },
      {
        "metrics": {
          "clicks": 1,
          "unique_clicks": 1
        },
        "name": "Firefox",
        "type": "browser"
      }
    ]
  },
  {
    "date": "2014-10-02",
    "stats": [
      {
        "metrics": {
          "clicks": 0,
          "unique_clicks": 0
        },
        "name": "Chrome",
        "type": "browser"
      },
      {
        "metrics": {
          "clicks": 1,
          "unique_clicks": 1
        },
        "name": "Firefox",
        "type": "browser"
      }
    ]
  }
]

Bounces API(4 operations)

Query Parameter NameExample
start_time80613068
end_time-12884959
Header NameExample
Accept*"est in"
on-behalf-of"tempor ullamco in do"
Request Payload
Response Payload
[
  {
    "created": 1250337600,
    "email": "example@example.com",
    "reason": "550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at  https://support.google.com/mail/answer/6596 o186si2389584ioe.63 - gsmtp ",
    "status": "5.1.1"
  },
  {
    "created": 1250337600,
    "email": "example@example.com",
    "reason": "550 5.1.1 <testemail2@testing.com>: Recipient address rejected: User unknown in virtual alias table ",
    "status": "5.1.1"
  }
]
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Header NameExample
on-behalf-of"commodo pariatur Excepteur qui reprehenderit"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example@example.com",
    "example2@example.com"
  ]
}
Response Payload
Error generating example
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}
Header NameExample
on-behalf-of"dolor id in ullamco"
Request Payload
Response Payload
[
  {
    "created": 1443651125,
    "email": "bounce1@test.com",
    "reason": "550 5.1.1 The email account that you tried to reach does not exist. Please try double-checking the recipient's email address for typos or unnecessary spaces. Learn more at  https://support.google.com/mail/answer/6596 o186si2389584ioe.63 - gsmtp ",
    "status": "5.1.1"
  }
]
Query Parameter NameExample
email_address*FNWv@ESHoyoXeWhllqRRHYSuixa.pcqj
Header NameExample
on-behalf-of"et"
Request Payload
Error generating example
Response Payload
{}
{
  "errors": [
    {
      "field": null,
      "message": "authorization required"
    }
  ]
}

Blocks API(4 operations)

Query Parameter NameExample
start_time-27559803
end_time-46975850
limit-23426760
offset9027497
Header NameExample
on-behalf-of"ullamco irure qui"
Request Payload
Response Payload
[
  {
    "created": 1443651154,
    "email": "example@example.com",
    "reason": "error dialing remote address: dial tcp 10.57.152.165:25: no route to host",
    "status": "4.0.0"
  },
  {
    "created": 1443651155,
    "email": "example1@example.com",
    "reason": "unable to resolve MX record for example.com: servfail",
    "status": "4.0.0"
  }
]
Header NameExample
on-behalf-of"consectetur qui culpa ipsum quis"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"dolor sunt"
Request Payload
Response Payload
[
  {
    "created": 1443651154,
    "email": "example@example.com",
    "reason": "error dialing remote address: dial tcp 10.57.152.165:25: no route to host",
    "status": "4.0.0"
  }
]
Header NameExample
on-behalf-of"in irure exercitation elit"
Request Payload
Response Payload
{}

Spam Reports API(4 operations)

Query Parameter NameExample
start_time74807222
end_time48231416
limit59179441
offset-55755394
Header NameExample
on-behalf-of"do anim irure in sit"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com",
    "ip": "10.63.202.100"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com",
    "ip": "10.63.202.100"
  }
]
Header NameExample
on-behalf-of"proident"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"irure in officia"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "ip": "10.89.32.5"
  }
]
Header NameExample
on-behalf-of"aliqua"
Request Payload
Response Payload
{}

Suppressions - Global Suppressions(4 operations)

Header NameExample
on-behalf-of"elit Ut sit dolor labore"
Request Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Response Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Query Parameter NameExample
start_time99429453
end_time-76115560
limit-22501242
offset-28565141
Header NameExample
on-behalf-of"qui ad"
Request Payload
Response Payload
[
  {
    "created": 1443651141,
    "email": "user1@example.com"
  },
  {
    "created": 1443651154,
    "email": "user2@example.com"
  }
]
Header NameExample
on-behalf-of"ad voluptate"
Request Payload
Response Payload
{
  "recipient_email": "test@example.com"
}
Header NameExample
on-behalf-of"in veniam voluptate ea"
Request Payload
Response Payload
{}

Suppressions - Unsubscribe Groups(5 operations)

Header NameExample
on-behalf-of"reprehenderit nisi sit dolor proident"
Request Payload
{
  "name": "Product Suggestions",
  "description": "Suggestions for products our users might like.",
  "is_default": true
}
Response Payload
{
  "id": 103,
  "name": "Product Suggestions",
  "description": "Suggestions for products our users might like.",
  "is_default": false
}
Query Parameter NameExample
id-91391253
Header NameExample
on-behalf-of"veniam"
Request Payload
Response Payload
[
  {
    "id": 1234,
    "name": "Unsubscribe Group",
    "description": "An Unsubscribe Group",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 1234
  },
  {
    "id": 1234,
    "name": "Unsubscribe Group",
    "description": "An Unsubscribe Group",
    "last_email_sent_at": null,
    "is_default": true,
    "unsubscribes": 1234
  }
]
Header NameExample
on-behalf-of"ut fugiat"
Request Payload
Response Payload
{
  "description": "Our monthly newsletter.",
  "id": 100,
  "is_default": true,
  "last_email_sent_at": null,
  "name": "Newsletters",
  "unsubscribes": 400
}
Header NameExample
on-behalf-of"laborum aliquip"
Request Payload
{
  "id": 103,
  "name": "Item Suggestions",
  "description": "Suggestions for items our users might like."
}
Response Payload
{
  "id": 103,
  "name": "Item Suggestions",
  "description": "Suggestions for items our users might like."
}
Header NameExample
on-behalf-of"exercitation Duis"
Request Payload
Response Payload
{}

Suppressions - Suppressions(6 operations)

Header NameExample
on-behalf-of"laborum"
Request Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Response Payload
{
  "recipient_emails": [
    "test1@example.com",
    "test2@example.com"
  ]
}
Header NameExample
on-behalf-of"officia dolor Excepteur amet"
Request Payload
Response Payload
[
  "example@example.com",
  "example2@example.com"
]
Header NameExample
on-behalf-of"occaecat culpa"
Request Payload
{
  "recipient_emails": [
    "exists1@example.com",
    "exists2@example.com",
    "doesnotexists@example.com"
  ]
}
Response Payload
[
  "exists1@example.com",
  "exists2@example.com"
]
Header NameExample
on-behalf-of"esse non occaecat culpa aliqua"
Request Payload
Response Payload
[
  {
    "email": "test1@example.com",
    "group_id": 1,
    "group_name": "Weekly News",
    "created_at": 1410986704
  },
  {
    "email": "test1@example.com",
    "group_id": 2,
    "group_name": "Daily News",
    "created_at": 1411493671
  },
  {
    "email": "test2@example.com",
    "group_id": 2,
    "group_name": "Daily News",
    "created_at": 1411493671
  }
]
Header NameExample
on-behalf-of"enim"
Request Payload
Response Payload
{
  "suppressions": [
    {
      "description": "Optional description.",
      "id": 1,
      "is_default": true,
      "name": "Weekly News",
      "suppressed": true
    },
    {
      "description": "Some daily news.",
      "id": 2,
      "is_default": true,
      "name": "Daily News",
      "suppressed": true
    },
    {
      "description": "An old group.",
      "id": 2,
      "is_default": false,
      "name": "Old News",
      "suppressed": false
    }
  ]
}
Header NameExample
on-behalf-of"nulla"
Request Payload
Response Payload
Error generating example

Invalid Emails API(4 operations)

Query Parameter NameExample
start_time14976178
end_time43544495
limit265232
offset-59968948
Header NameExample
on-behalf-of"culpa id veniam"
Request Payload
Response Payload
[
  {
    "created": 1449953655,
    "email": "user1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  },
  {
    "created": 1449939373,
    "email": "user2@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]
Header NameExample
on-behalf-of"ea adipisicing officia"
Request Payload
{
  "delete_all": false,
  "emails": [
    "example1@example.com",
    "example2@example.com"
  ]
}
Response Payload
{}
Header NameExample
on-behalf-of"in Ut nulla culpa"
Request Payload
Response Payload
[
  {
    "created": 1454433146,
    "email": "test1@example.com",
    "reason": "Mail domain mentioned in email address is unknown"
  }
]
Header NameExample
on-behalf-of"mollit Excepteur adipisicing"
Request Payload
Response Payload
{}
Service Homepage: sendgrid.com/en-us
API documentation: docs.sendgrid.com/for-developers/sending-email/api-getting-started
emails