Create Batch

Creates a new message batch. Effectively queues the messages to be sent.

post

Body

application/json

subjectstringOptional

bodystringOptional

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: application/json
Accept: */*
Content-Length: 184

{
  "category": {
    "id": "text"
  },
  "subject": "text",
  "body": "text",
  "contacts": [
    {
      "id": "text",
      "email": "text"
    }
  ],
  "account": {
    "id": "text"
  },
  "buyer": {
    "id": "text",
    "externalIds": {
      "erpCustomerId": "text"
    }
  }
}

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-01-08T06:31:30.827Z",
      "by": {}
    },
    "updated": {
      "at": "2026-01-08T06:31:30.827Z",
      "by": {}
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "category": {
    "id": "text",
    "audit": {
      "created": {},
      "updated": {},
      "published": {},
      "unpublished": {},
      "deleted": {}
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "description": "text",
    "optOutAllowed": true,
    "status": "text",
    "name": "text",
    "note": "text",
    "deleteAllowed": true,
    "icon": "text",
    "statistics": {
      "month": {
        "bounced": 1,
        "complained": 1,
        "discarded": 1,
        "failed": 1,
        "sent": 1,
        "total": 1
      },
      "today": {
        "bounced": 1,
        "complained": 1,
        "discarded": 1,
        "failed": 1,
        "sent": 1,
        "total": 1
      },
      "week": {
        "bounced": 1,
        "complained": 1,
        "discarded": 1,
        "failed": 1,
        "sent": 1,
        "total": 1
      }
    },
    "lastUsed": "2026-01-08T06:31:30.827Z"
  },
  "account": {
    "id": "text",
    "audit": {
      "created": {
        "at": "2026-01-08T06:31:30.827Z",
        "by": {}
      },
      "updated": {
        "at": "2026-01-08T06:31:30.827Z",
        "by": {}
      }
    },
    "$meta": {
      "omitted": [
        "text"
      ]
    },
    "icon": "text",
    "externalIds": {
      "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
    },
    "externalId": "text",
    "externalName": "text",
    "type": "text",
    "status": "text",
    "serviceLevel": "text",
    "address": {
      "addressLine1": "text",
      "addressLine2": "text",
      "postCode": "text",
      "city": "text",
      "state": "text",
      "country": "text"
    },
    "technicalSupportEmail": "text",
    "website": "text",
    "description": "text",
    "name": "text",
    "groups": [
      {
        "id": "text",
        "name": "text",
        "description": "text",
        "logo": "text",
        "isDefault": true
      }
    ],
    "eligibility": {
      "client": true,
      "partner": true
    }
  },
  "subject": "text",
  "body": "text",
  "attachments": [
    {
      "id": "text",
      "href": "text",
      "name": "text",
      "fileName": "text",
      "fileSize": 1,
      "contentType": "text"
    }
  ]
}