Create batch

Creates a new message batch with attachments.

post

Creates and queues a batch of raw messages with file attachments. Use multipart/form-data content type to include files.

Body

multipart/form-dataapplication/json

Category.IdstringOptional

SubjectstringOptionalDeprecated

BodystringOptionalDeprecated

Account.IdstringOptional

Buyer.IdstringOptional

Buyer.ExternalIds.ErpCustomerIdstringOptional

Content.Templated.Template.IdstringOptional

Content.Templated.Template.ExternalIdstringOptional

Content.Templated.Template.LanguageCodestringOptional

Content.Templated.TestbooleanOptional

Content.Raw.Category.IdstringOptional

Content.Raw.SubjectstringOptional

Content.Raw.BodystringOptional

Recipients.Account.IdstringOptional

Recipients.Buyer.IdstringOptional

Recipients.Buyer.ExternalIds.ErpCustomerIdstringOptional

Recipients.User.IdstringOptional

Responses

201

Created

application/json

400

Bad Request

application/json

post

/public/v1/notifications/batches

HTTPcURLJavaScriptPython

POST /public/v1/notifications/batches HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: multipart/form-data
Accept: */*
Content-Length: 662

{
  "Category.Id": "text",
  "Account.Id": "text",
  "Buyer.Id": "text",
  "Buyer.ExternalIds.ErpCustomerId": "text",
  "Content.Templated.Template.Id": "text",
  "Content.Templated.Template.ExternalId": "text",
  "Content.Templated.Template.LanguageCode": "text",
  "Content.Templated.Data": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "Content.Templated.Test": true,
  "Content.Raw.Category.Id": "text",
  "Content.Raw.Subject": "text",
  "Content.Raw.Body": "text",
  "Recipients.Account.Id": "text",
  "Recipients.Buyer.Id": "text",
  "Recipients.Buyer.ExternalIds.ErpCustomerId": "text",
  "Recipients.User.Id": "text",
  "Recipients.Contacts": [
    {
      "id": "text",
      "email": "text"
    }
  ],
  "formCollection": [
    {
      "key": "text",
      "value": [
        "text"
      ]
    }
  ]
}

multipart/form-dataapplication/json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-06-11T22:43:47.884Z",
      "by": "[Circular Reference]"
    },
    "updated": {
      "at": "2026-06-11T22:43:47.884Z",
      "by": "[Circular Reference]"
    },
    "completed": {
      "at": "2026-06-11T22:43:47.884Z",
      "by": "[Circular Reference]"
    },
    "processed": {
      "at": "2026-06-11T22:43:47.884Z",
      "by": "[Circular Reference]"
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "revision": 1,
  "account": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "groups": [
      {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "revision": 1,
        "description": "text",
        "account": "[Circular Reference]",
        "modules": [
          "[Circular Reference]"
        ],
        "logo": "text",
        "isDefault": true,
        "users": [
          "[Circular Reference]"
        ],
        "extensions": [
          "[Circular Reference]"
        ],
        "buyers": [
          "[Circular Reference]"
        ]
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    },
    "defaultLanguageCode": "text"
  },
  "attachments": [
    {
      "id": "text",
      "href": "text",
      "name": "text",
      "fileName": "text",
      "fileSize": 1,
      "contentType": "text"
    }
  ],
  "body": "text",
  "category": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]",
      "published": "[Circular Reference]",
      "unpublished": "[Circular Reference]",
      "deleted": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "revision": 1,
    "description": "text",
    "optOutAllowed": true,
    "status": "text",
    "note": "text",
    "deleteAllowed": true,
    "statistics": {
      "month": 1,
      "today": 1,
      "week": 1
    },
    "lastUsed": "2026-06-11T22:43:47.884Z",
    "enabledByDefault": true
  },
  "template": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]",
      "activated": "[Circular Reference]",
      "deleted": "[Circular Reference]",
      "disabled": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "revision": 1,
    "category": {
      "id": "text",
      "name": "text",
      "revision": 1,
      "description": "text",
      "lastUsed": "2026-06-11T22:43:47.884Z"
    },
    "criteria": {
      "accountTypes": [
        "text"
      ],
      "filterCondition": "text",
      "objectType": "text",
      "recipients": {
        "selector": "text"
      }
    },
    "defaultVariant": {
      "id": "text",
      "revision": 1,
      "default": true,
      "languageCode": "text",
      "status": "text"
    },
    "description": "text",
    "lastUsed": "2026-06-11T22:43:47.884Z",
    "owner": {
      "id": "text",
      "audit": {
        "created": "[Circular Reference]",
        "updated": "[Circular Reference]"
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "name": "text",
      "icon": "text",
      "revision": 1,
      "type": "Client",
      "status": "Active",
      "externalIds": {
        "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
      },
      "externalId": "text",
      "externalName": "text",
      "address": {
        "addressLine1": "text",
        "addressLine2": "text",
        "postCode": "text",
        "city": "text",
        "state": "text",
        "country": "text"
      },
      "technicalSupportEmail": "text",
      "website": "text",
      "description": "text",
      "groups": [
        {
          "id": "text",
          "audit": "[Circular Reference]",
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "revision": 1,
          "description": "text",
          "account": "[Circular Reference]",
          "modules": [
            "[Circular Reference]"
          ],
          "logo": "text",
          "isDefault": true,
          "users": [
            "[Circular Reference]"
          ],
          "extensions": [
            "[Circular Reference]"
          ],
          "buyers": [
            "[Circular Reference]"
          ]
        }
      ],
      "eligibility": {
        "client": true,
        "partner": true
      },
      "defaultLanguageCode": "text"
    },
    "statistics": {
      "month": 1,
      "today": 1,
      "week": 1
    },
    "status": "text",
    "variants": [
      {
        "id": "text",
        "revision": 1,
        "default": true,
        "languageCode": "text",
        "status": "text"
      }
    ],
    "externalId": "text"
  },
  "statistics": {
    "bounced": 1,
    "complained": 1,
    "discarded": 1,
    "failed": 1,
    "queued": 1,
    "sent": 1,
    "total": 1
  },
  "subject": "text",
  "status": "text",
  "statusReason": "text",
  "type": "text",
  "payload": "text",
  "sendContext": "text",
  "sourceAccount": {
    "id": "text",
    "audit": {
      "created": "[Circular Reference]",
      "updated": "[Circular Reference]"
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "groups": [
      {
        "id": "text",
        "audit": "[Circular Reference]",
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "name": "text",
        "revision": 1,
        "description": "text",
        "account": "[Circular Reference]",
        "modules": [
          "[Circular Reference]"
        ],
        "logo": "text",
        "isDefault": true,
        "users": [
          "[Circular Reference]"
        ],
        "extensions": [
          "[Circular Reference]"
        ],
        "buyers": [
          "[Circular Reference]"
        ]
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    },
    "defaultLanguageCode": "text"
  }
}