SendMimeRequestSchema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/infobip/main/json-schema/infobip-34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1-send-mime-request-schema-schema.json",
  "title": "SendMimeRequestSchema",
  "x-generated": "2026-10-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/infobip-channels-api-openapi.yml#/components/schemas/34438aa163eb13a2a06ad96ae98170e41cc2ee8902e8b7655aba73ceb0bb23f1.SendMimeRequestSchema",
  "type": "object",
  "properties": {
    "messageId": {
      "type": "string",
      "description": "The ID that uniquely identifies the message sent to a recipient."
    },
    "bulkId": {
      "type": "string",
      "description": "The ID that uniquely identifies the sent bulk.\nThis filter will enable you to query delivery reports for all the messages using just one request.\nYou will receive a `bulkId` in the response after sending an email request.\nIf you don't set your own `bulkId`, unique ID will be generated by our system and returned in the API response. (Optional Field)\")"
    },
    "from": {
      "type": "string",
      "description": "The email address specified in this field takes precedence over the From header in the MIME message.\nIf you leave this field empty, the From address in the MIME message will be used instead.\nIf you provide both values and they are different, their domains must match at the organizational level; otherwise, the request will be rejected.\n"
    },
    "destinations": {
      "type": "array",
      "description": "A list of recipient email addresses.\n<br/>\nThe email addresses specified in this field takes precedence over the To, CC, and BCC headers in the MIME message.\nOnly the addresses in this list will receive the final email.\nIf you leave this field empty, To, CC, and BCC headers in the MIME message will be used instead.\n<br/>\nNote: Maximum number of recipients per request is 1000 overall including to, cc and bcc field.",
      "items": {
        "type": "string",
        "description": "A list of recipient email addresses.\n<br/>\nThe email addresses specified in this field takes precedence over the To, CC, and BCC headers in the MIME message.\nOnly the addresses in this list will receive the final email.\nIf you leave this field empty, To, CC, and BCC headers in the MIME message will be used instead.\n<br/>\nNote: Maximum number of recipients per request is 1000 overall including to, cc and bcc field.",
        "maximum": 1000
      },
      "maximum": 1000
    },
    "mimeMessage": {
      "type": "string",
      "description": "This field accepts a complete email message serialized in the MIME format, conforming to RFC 5322 and MIME-related standards (RFCs 2045–2047, RFC 2183).\nThe MIME message must be correctly constructed per the following requirements as if it were being sent via traditional SMTP.\nThe entire MIME message (including headers and body) must be `base64-encoded` before being sent.\n<br/><br/>\n\nWhen using this field, these are the requirements:\n<br/>\n**-** The message must consist of a set of header fields, followed by a blank line (CRLF), and then the message body\n<br/>\n**-** All required and optional fields must be properly formatted with header-name, colon, and header-value\n<br/>\n**-** If any MIME part contains non-7-bit-ASCII data (e.g., UTF-8 text, binaries), that part must be encoded\n<br/>\n**-** If your message uses multipart content (attachments, alternative bodies, etc.), each MIME part must contain `Content-Type` header. For encoded parts, include `Content-Transfer-Encoding`. For attachments, include a valid `Content-Disposition`.\n<br/><br/>\nWe also support specifying additional headers in your MIME message, such as `List-Unsubscribe`, `List-Unsubscribe-Post`, `In-Reply-To`, `References` and `Message-ID`.\n"
    },
    "intermediateReport": {
      "type": "boolean",
      "description": "The real-time Intermediate delivery report that will be sent on your callback server."
    },
    "notifyUrl": {
      "type": "string",
      "description": "The URL on your callback server on which the Delivery report will be sent."
    },
    "notifyContentType": {
      "type": "string",
      "description": "Preferred Delivery report content type. Can be `application/json` or `application/xml`."
    },
    "callbackData": {
      "type": "string",
      "description": "Additional client data that will be sent on the notifyUrl.",
      "maximum": 4000,
      "minimum": 0
    },
    "trackingUrl": {
      "type": "string",
      "description": "The URL on your callback server on which the open and click notifications will be sent. See [Tracking Notifications](https://www.infobip.com/docs/email/email-over-api/tracking-notifications) for details."
    },
    "clientPriority": {
      "type": "string",
      "default": "STANDARD",
      "description": "Adds a priority rating to this email message.\nAllowed values are `HIGH`, `STANDARD` and `LOW`.\nMessages with a higher priority value sent by your account are prioritized over messages with a lower priority value sent by your account.\nIf no priority value is provided, messages will be treated with `STANDARD` priority by default.\n"
    },
    "applicationId": {
      "type": "string",
      "description": "Required for application use in a send request for outbound traffic. Returned in notification events."
    },
    "entityId": {
      "type": "string",
      "description": "Required for entity use in a send request for outbound traffic. Returned in notification events."
    }
  },
  "required": [
    "mimeMessage"
  ]
}