Create Broadcast Email | SchoolSet

curl -X POST https://app.schoolset.io/app/api/v1/broadcast/email/create \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "academic_year_id": 2024,
  "recipients_id": [
    {
      "type": "student",
      "id": 12345,
      "grade_ids": [
        10,
        11
      ]
    }
  ],
  "sent_date": "2026-05-06T17:42:52-04:00",
  "subject": "Upcoming Parent-Teacher Conference",
  "message": "Dear Parents, please be reminded of the upcoming parent-teacher conference scheduled for next week. Kindly confirm your attendance.",
  "document_template_recipients": [
    {
      "document_template_id": 5,
      "recipient_id": 12345,
      "recipient_type": "parent",
      "member_id": 67890,
      "member_type": "family"
    }
  ]
}'

{
  "status": "success",
  "message": "Broadcast email created successfully.",
  "data": {
    "id": 98765,
    "academic_year": {
      "id": 2024,
      "title": "2024-2025 Academic Year"
    },
    "type": {
      "id": 2,
      "title": "Email Broadcast",
      "sys_name": "email_broadcast"
    },
    "method": {
      "id": 1,
      "sys_name": "email"
    },
    "status": {
      "id": 3,
      "title": "Scheduled",
      "sys_name": "scheduled"
    },
    "from": {},
    "to": [
      {
        "id": 12345,
        "type": "parent",
        "data": {
          "id": 12345,
          "name": "Jane Doe",
          "email": "jane.doe@example.com",
          "cell_phone": "+15551234567"
        },
        "status": {
          "id": 1,
          "title": "Active",
          "sys_name": "active"
        },
        "grade_ids": [
          10,
          11
        ]
      }
    ],
    "sent_date": "2026-05-06T17:42:52-04:00",
    "subject": "Upcoming Parent-Teacher Conference",
    "message": "Dear Parents, please be reminded of the upcoming parent-teacher conference scheduled for next week. Kindly confirm your attendance.",
    "voice": {},
    "attributes": {
      "message": {},
      "document_template_recipients": [
        {}
      ],
      "form": {}
    },
    "form": {
      "id": 17
    },
    "statuses": [
      {}
    ],
    "attachments": [
      {
        "id": 101,
        "file_hash": "a1b2c3d4e5f67890",
        "file_name": "conference_agenda.pdf",
        "file_original_name": "Parent_Teacher_Conference_Agenda.pdf",
        "file_mime_type": "application/pdf",
        "caption": "Conference Agenda",
        "url": "https://app.schoolset.io/uploads/conference_agenda.pdf",
        "file_size": 204800,
        "created_by": "admin_user",
        "created_at": "2024-04-20T09:15:00Z",
        "updated_at": "2024-04-20T09:15:00Z",
        "related_to": "broadcast_email",
        "model_name": "BroadcastEmail",
        "model_id": 98765
      }
    ]
  }
}

Creates email create data from submitted details.

Authentication

AuthorizationBearer

You can retrieve your token by visiting your dashboard and clicking Generate API token.

Request

This endpoint expects an object.

academic_year_iddoubleRequired

academic year ID identifier.

recipients_idlist of objectsRequired

recipients ID identifier.

sent_datestringRequired

Must be a valid date. Must be a valid date in the format Y-m-d\TH:i:sP.

subjectstringRequired

subject value.

messagestringRequired

message value.

document_template_recipientslist of objectsRequired

document template recipients list.

broadcast_method_iddouble or nullOptional

broadcast method ID identifier.

form_idinteger or nullOptional

form ID identifier.

attachments_idobjectOptional

attachments ID file upload or file reference.

attributesstring or nullOptional

Must be a valid JSON string.

contractstring or nullOptional

Must be a valid JSON string.

include_previous_years_balanceboolean or nullOptional

include previous years balance flag.

previous_years_balance_typeenum or nullOptional

previous years balance type option.

Allowed values:

Response

Successful POST response for /api/v1/broadcast/email/create.

statusenum

Allowed values:

messagestring

dataobject