Update Broadcast SMS | SchoolSet

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

{
  "status": "success",
  "message": "SMS update record successfully updated.",
  "data": {
    "id": 42,
    "academic_year": {
      "id": 2024,
      "title": "2023-2024 Academic Year"
    },
    "type": {
      "id": 3,
      "title": "Notification",
      "sys_name": "notification"
    },
    "method": {
      "id": 1,
      "sys_name": "sms"
    },
    "status": {
      "id": 2,
      "title": "Sent",
      "sys_name": "sent"
    },
    "from": {},
    "to": [
      {
        "id": 101,
        "type": "student",
        "data": {
          "id": 501,
          "name": "John Doe",
          "email": "john.doe@example.com",
          "cell_phone": "+1234567890"
        },
        "status": {
          "id": 1,
          "title": "Active",
          "sys_name": "active"
        },
        "grade_ids": [
          10,
          11
        ]
      }
    ],
    "sent_date": "2024-06-15T09:30:00-04:00",
    "subject": "Upcoming School Event",
    "message": "Reminder: The school event will take place on June 20th. Please be on time.",
    "voice": {},
    "attributes": {
      "message": {},
      "document_template_recipients": [
        {}
      ],
      "form": {}
    },
    "form": {
      "id": 17
    },
    "statuses": [
      {}
    ],
    "attachments": [
      {
        "id": 5,
        "file_hash": "a1b2c3d4e5f67890",
        "file_name": "event_flyer.pdf",
        "file_original_name": "school_event_flyer.pdf",
        "file_mime_type": "application/pdf",
        "caption": "Event Flyer",
        "url": "https://app.schoolset.io/files/event_flyer.pdf",
        "file_size": 204800,
        "created_by": "admin_user",
        "created_at": "2024-06-01T12:00:00Z",
        "updated_at": "2024-06-10T08:00:00Z",
        "related_to": "broadcast_sms",
        "model_name": "BroadcastSMS",
        "model_id": 42
      }
    ]
  }
}

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

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.

Response

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

statusenum

Allowed values:

messagestring

dataobject