Update Broadcast Email | SchoolSet

curl -X PATCH https://app.schoolset.io/app/api/v1/broadcast/email/update/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "document_template_recipients": [
    {
      "document_template_id": 12,
      "recipient_id": 45,
      "recipient_type": "parent",
      "member_id": 78,
      "member_type": "staff"
    }
  ]
}'

{
  "status": "success",
  "message": "Email update record successfully updated.",
  "data": {
    "id": 1024,
    "academic_year": {
      "id": 2023,
      "title": "2023-2024 Academic Year"
    },
    "type": {
      "id": 3,
      "title": "Newsletter",
      "sys_name": "newsletter"
    },
    "method": {
      "id": 2,
      "sys_name": "email"
    },
    "status": {
      "id": 1,
      "title": "Sent",
      "sys_name": "sent"
    },
    "from": {},
    "to": [
      {
        "id": 501,
        "type": "parent",
        "data": {
          "id": 501,
          "name": "Jane Doe",
          "email": "jane.doe@example.com",
          "cell_phone": "+15551234567"
        },
        "status": {
          "id": 1,
          "title": "Active",
          "sys_name": "active"
        },
        "grade_ids": [
          9,
          10
        ]
      }
    ],
    "sent_date": "2024-06-15T09:30:00-04:00",
    "subject": "Upcoming School Events and Updates",
    "message": "Dear Parents, please find the latest updates and events for the upcoming month.",
    "voice": {},
    "attributes": {
      "message": {},
      "document_template_recipients": [
        {}
      ],
      "form": {}
    },
    "form": {
      "id": 17
    },
    "statuses": [
      {}
    ],
    "attachments": [
      {
        "id": 301,
        "file_hash": "a1b2c3d4e5f67890",
        "file_name": "school_calendar.pdf",
        "file_original_name": "2024_school_calendar.pdf",
        "file_mime_type": "application/pdf",
        "caption": "2024 School Calendar",
        "url": "https://app.schoolset.io/files/2024_school_calendar.pdf",
        "file_size": 204800,
        "created_by": "admin_user",
        "created_at": "2024-05-01T12:00:00Z",
        "updated_at": "2024-05-10T15:30:00Z",
        "related_to": "broadcast_email",
        "model_name": "email_update",
        "model_id": 1024
      }
    ]
  }
}

Updates the selected email update record.

Authentication

AuthorizationBearer

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

Path parameters

idstringRequired

Request

This endpoint expects an object.

document_template_recipientslist of objectsRequired

document template recipients list.

academic_year_iddouble or nullOptional

academic year ID identifier.

form_idinteger or nullOptional

form ID identifier.

recipients_idlist of objectsOptional

recipients ID identifier.

sent_datestring or nullOptional

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

subjectstring or nullOptional

subject value.

messagestring or nullOptional

message value.

attributesstring or nullOptional

Must be a valid JSON string.

attachments_idobjectOptional

attachments ID file upload or file reference.

Response

Successful PATCH response for /api/v1/broadcast/email/update/{id}.

statusenum

Allowed values:

messagestring

dataobject