SingleSendsBulkDeleteResponse
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsCancelScheduledSend500Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsCancelScheduledSendResponse
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsCreateNewSingleSend500Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsCreateNewSingleSendResponse
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsDeleteById500Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsDeleteByIdResponse
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsDuplicateSingleSend500Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsDuplicateSingleSendRequest
{
"type": "object",
"properties": {
"name": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "The name of the duplicate Single Send. If you choose to leave the name field blank, your duplicate will be assigned the name of the Single Send it was copied from with the text 'Copy of ' prepended to it. The end of the new Single Send name, including 'Copy of ', will be trimmed if the name exceeds the character limit."
}
}
}
SingleSendsDuplicateSingleSendResponse
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsGetAllCategories500Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsGetAllCategoriesResponse
{
"type": "object",
"properties": {
"categories": {
"type": "array",
"items": {
"type": "string"
},
"maxItems": 1000,
"description": "list of latest one thousand unique categories associated with all Single Sends in ascending order",
"uniqueItems": true
}
}
}
SingleSendsGetAllSinglesends500Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsGetAllSinglesendsResponse
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/singlesend_response_short"
}
},
"_metadata": {
"$ref": "#/components/schemas/_metadata"
}
}
}
SingleSendsGetDetailsById500Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsGetDetailsByIdResponse
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsSchedulePut404Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsSchedulePut500Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsSchedulePutRequest
{
"type": "object",
"example": {
"send_at": "3752-01-28T23:21:52.575Z"
},
"required": [
"send_at"
],
"properties": {
"send_at": {
"enum": [
"now"
],
"type": "string",
"format": "date-time",
"description": "This is the ISO 8601 time at which to send the Single Send; must be in future, or the string \"now\""
}
}
}
SingleSendsSchedulePutResponse
{
"type": "object",
"properties": {
"status": {
"enum": [
"scheduled"
],
"type": "string"
},
"send_at": {
"type": "string",
"format": "date-time",
"description": ""
}
}
}
SingleSendsSearchByCriteria404Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsSearchByCriteriaResponse
{
"type": "object",
"properties": {
"result": {
"type": "array",
"items": {
"$ref": "#/components/schemas/singlesend_response_short"
}
},
"_metadata": {
"$ref": "#/components/schemas/_metadata"
}
}
}
SingleSendsUpdateById404Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsUpdateById500Response
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSendsUpdateByIdResponse
{
"type": "object",
"properties": {
"errors": {
"type": "array",
"items": {
"type": "object",
"properties": {
"field": {
"type": "string"
},
"message": {
"type": "string"
},
"error_id": {
"type": "string"
}
}
}
}
}
}
SingleSignOnSettingsGetAllSsoIntegrationsResponse
{
"type": "array",
"items": {
"$ref": "#/components/schemas/sso-integration"
}
}
SingleSignOnTeammatesEditTeammateRequest
{
"type": "object",
"example": {
"email": "jane_doe@example.com",
"scopes": [
"mail.batch.create",
"mail.batch.delete",
"mail.batch.read",
"mail.batch.update",
"mail.send"
],
"is_admin": false,
"last_name": "Doe",
"first_name": "Jane"
},
"properties": {
"scopes": {
"type": "array",
"items": {
"type": "string"
}
},
"is_admin": {
"type": "boolean"
},
"last_name": {
"type": "string"
},
"first_name": {
"type": "string"
}
}
}
SpamReportsApiDeleteReportsRequest
{
"type": "object",
"example": {
"emails": [
"example1@example.com",
"example2@example.com"
],
"delete_all": false
},
"properties": {
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of specific email addresses that you want to remove from the spam report list."
},
"delete_all": {
"type": "boolean",
"description": "Indicates if you want to delete all email addresses on the spam report list."
}
}
}
SpamReportsApiDeleteReportsResponse
{
"type": "object",
"properties": {}
}
SpamReportsApiDeleteSpecificReportByEmailAddressResponse
{
"type": "object",
"properties": {}
}
StatsGetEmailStatisticsByBrowserResponse
{
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date that the statistics were gathered."
},
"stats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the specific segmentation."
},
"type": {
"type": "string",
"description": "The type of segmentation."
},
"metrics": {
"$ref": "#/components/schemas/advanced_stats_clicks"
}
}
},
"description": "The list of statistics."
}
}
}
}
StatsGetEmailStatisticsByClientTypeResponse
{
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date that the statistics were gathered."
},
"stats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the specific segmentation."
},
"type": {
"type": "string",
"description": "The type of segmentation."
},
"metrics": {
"$ref": "#/components/schemas/advanced_stats_opens"
}
}
},
"description": "The list of statistics."
}
}
}
}
StatsGetEmailStatisticsByCountryAndStateProvinceResponse
{
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date that the statistics were gathered."
},
"stats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the specific segmentation."
},
"type": {
"type": "string",
"description": "The type of segmentation."
},
"metrics": {
"$ref": "#/components/schemas/advanced_stats_clicks_opens"
}
}
},
"description": "The list of statistics."
}
}
}
}
StatsGetEmailStatisticsByDeviceTypeResponse
{
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date that the statistics were gathered."
},
"stats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the specific segmentation."
},
"type": {
"type": "string",
"description": "The type of segmentation."
},
"metrics": {
"$ref": "#/components/schemas/advanced_stats_opens"
}
}
},
"description": "The list of statistics."
}
}
}
}
StatsGetEmailStatisticsByMailboxProviderResponse
{
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date that the statistics were gathered."
},
"stats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the specific segmentation."
},
"type": {
"type": "string",
"description": "The type of segmentation."
},
"metrics": {
"$ref": "#/components/schemas/advanced_stats_mailbox_provider"
}
}
},
"description": "The list of statistics."
}
}
}
}
StatsGetStatsByClientTypeResponse
{
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The date that the statistics were gathered."
},
"stats": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the specific segmentation."
},
"type": {
"type": "string",
"description": "The type of segmentation."
},
"metrics": {
"$ref": "#/components/schemas/advanced_stats_opens"
}
}
},
"description": "The list of statistics."
}
}
}
}
SubuserMonitorSettingsDeleteMonitorSettingsResponse
{
"type": "object",
"properties": {}
}
SubusersApiDeleteSubuserResponse
{
"type": "object",
"properties": {}
}
SubusersApiGetSubuserReputationsResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"reputation",
"username"
],
"properties": {
"username": {
"type": "string",
"description": "The subuser that has this reputation.f"
},
"reputation": {
"type": "number",
"description": "The sender reputation this subuser has attained."
}
}
}
}
SubusersApiUpdateSubuserEnableStateRequest
{
"type": "object",
"example": {
"disabled": false
},
"properties": {
"disabled": {
"type": "boolean",
"description": "Whether or not this subuser is disabled. True means disabled, False means enabled."
}
}
}
SubusersApiUpdateSubuserEnableStateResponse
{
"type": "object",
"properties": {}
}
SubusersApiUpdateSubuserIpsRequest
{
"type": "array",
"items": {
"type": "string",
"format": "ipv4"
},
"example": [
"127.0.0.1"
],
"description": "The IP addresses you would like to assign to the subuser."
}
SubusersApiUpdateSubuserIpsResponse
{
"type": "object",
"properties": {
"ips": {
"type": "array",
"items": {
"type": "string",
"format": "ipv4"
},
"description": "The IP addresses that are assigned to the subuser."
}
}
}
SuppressionsGlobalSuppressionsAddRecipientAddressesResponse
{
"type": "object",
"required": [
"recipient_emails"
],
"properties": {
"recipient_emails": {
"type": "array",
"items": {
"type": "string",
"format": "email"
},
"description": "The email addresses that are globally suppressed"
}
}
}
SuppressionsGlobalSuppressionsGetAllAddressesResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"created",
"email"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"description": "The email address of the recipient who is globally suppressed."
},
"created": {
"type": "integer",
"description": "A Unix timestamp indicating when the recipient was added to the global suppression list."
}
}
}
}
SuppressionsGlobalSuppressionsGetGlobalSuppressionResponse
{
"type": "object",
"title": "Retrieve a Global Suppression response",
"required": [
"recipient_email"
],
"properties": {
"recipient_email": {
"type": "string",
"format": "email",
"description": "The email address that is globally suppressed. This will be an empty object if the email address you included in your call is not globally suppressed."
}
}
}
SuppressionsGlobalSuppressionsRemoveEmailResponse
{
"type": "object",
"example": {},
"properties": {}
}
SuppressionsSuppressionsAddToGroupResponse
{
"type": "object",
"properties": {
"recipient_emails": {
"type": "array",
"items": {
"type": "string",
"format": "email"
},
"description": "The email addresses you added to the unsubscribe group"
}
}
}
SuppressionsSuppressionsGetAllSuppressedEmailsResponse
{
"type": "array",
"items": {
"type": "string",
"format": "email"
},
"description": "The list of email addresses belonging to the given suppression group."
}
SuppressionsSuppressionsGetAllSuppressionsResponse
{
"type": "array",
"items": {
"type": "object",
"required": [
"email",
"group_id",
"group_name",
"created_at"
],
"properties": {
"email": {
"type": "string",
"description": "The email address that was suppressed."
},
"group_id": {
"type": "integer",
"description": "The id of the suppression group that this email address belongs to."
},
"created_at": {
"type": "integer",
"description": "A UNIX timestamp indicating when the suppression was created."
},
"group_name": {
"type": "string",
"description": "The name of the suppression group that this email address belongs to."
}
}
}
}