SendBatchMessagesResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/swift/json-schema/swift-send-batch-messages-response-schema.json",
  "title": "SendBatchMessagesResponse",
  "description": "Response for a batch messages upload. This contains, for each message identified by its sender_reference, a code describing the upload result.\nIf the upload is successful, the result code will be 201, and a message_cloud_reference will be present.\nIf the upload is unsuccessful, the result code will be reflect the actual issue kind (400, 500...), there will be an error_message property present, and no message_cloud_reference.",
  "x-generated": "2026-11-05",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/swift-messaging-api-openapi.yml#/components/schemas/SendBatchMessagesResponse",
  "type": "array",
  "items": {
    "$ref": "#/$defs/SingleMessageUploadResult"
  },
  "$defs": {
    "SingleMessageUploadResult": {
      "title": "SingleMessageUploadResult",
      "type": "object",
      "additionalProperties": true,
      "required": [
        "sender_reference",
        "result"
      ],
      "properties": {
        "sender_reference": {
          "description": "The sent message sender_reference, used to correlate this result with a sent message",
          "type": "string",
          "maxLength": 70
        },
        "result": {
          "description": "The result code for a particular message upload. Considered as successful if the value is 201. When unsuccessful, the value can be any client or server error status code (400, 403, 500...)",
          "type": "integer",
          "format": "int32"
        },
        "message_cloud_reference": {
          "description": "The unique Alliance Cloud assigned identifier for this sent message. Will only be present for a successful result.",
          "type": "string",
          "format": "uuid"
        },
        "error_message": {
          "description": "An error message describing the cause of the unsuccessful result for this sent message. Will only be present for an unsuccessful result.",
          "type": "string"
        }
      },
      "description": "The detailed result for a message upload that was part of a batch upload request."
    }
  }
}