Update Broadcast Voice | SchoolSet

curl -X PATCH https://app.schoolset.io/app/api/v1/broadcast/voice/update/id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "status": "success",
  "message": "Voice update record successfully updated.",
  "data": {
    "id": 42,
    "academic_year": {
      "id": 2024,
      "title": "2023-2024 Academic Year"
    },
    "type": {
      "id": 3,
      "title": "Emergency Alert",
      "sys_name": "emergency_alert"
    },
    "method": {
      "id": 2,
      "sys_name": "voice_call"
    },
    "status": {
      "id": 1,
      "title": "Sent",
      "sys_name": "sent"
    },
    "from": {},
    "to": [
      {
        "id": 101,
        "type": "parent",
        "data": {
          "id": 501,
          "name": "Jane Doe",
          "email": "jane.doe@example.com",
          "cell_phone": "+15551234567"
        },
        "status": {
          "id": 1,
          "title": "Delivered",
          "sys_name": "delivered"
        },
        "grade_ids": [
          9,
          10
        ]
      }
    ],
    "sent_date": "2024-06-15T09:30:00-04:00",
    "subject": "School Closure Notification",
    "message": "This is an automated message to inform you that school will be closed tomorrow due to severe weather conditions.",
    "voice": {},
    "attributes": {
      "message": {},
      "document_template_recipients": [
        {}
      ],
      "form": {}
    },
    "form": {
      "id": 7
    },
    "statuses": [
      {}
    ],
    "attachments": [
      {
        "id": 12,
        "file_hash": "a1b2c3d4e5f67890",
        "file_name": "closure_notice.pdf",
        "file_original_name": "School_Closure_Notice.pdf",
        "file_mime_type": "application/pdf",
        "caption": "Official school closure notice",
        "url": "https://app.schoolset.io/files/closure_notice.pdf",
        "file_size": 204800,
        "created_by": "admin_user",
        "created_at": "2024-06-14T15:00:00Z",
        "updated_at": "2024-06-14T15:00:00Z",
        "related_to": "broadcast",
        "model_name": "voice_update",
        "model_id": 42
      }
    ]
  }
}

Updates the selected voice 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.

academic_year_iddouble or nullOptional

academic year 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.

voicestring or nullOptional

voice value.

attributesstring or nullOptional

Must be a valid JSON string.

Response

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

statusenum

Allowed values:

messagestring

dataobject