Update a PTA event

PATCH

https://ssuccessv2.com/app/api/v1/pta/event/update/:id

PATCH

/app/api/v1/pta/event/update/:id

$ curl -X PATCH https://ssuccessv2.com/app/api/v1/pta/event/update/1842 \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "title": "Fall parent conferences",
>   "start_date": {},
>   "pta_gap_parent_count": 2,
>   "pta_schedule_type_id": 1,
>   "pta_slot_duration_id": 2,
>   "pta_slot_meeting_count": 1,
>   "grade_ids": [
>     7,
>     8
>   ],
>   "class_ids": [
>     42,
>     43
>   ],
>   "staff_member_ids": [
>     118,
>     121
>   ],
>   "parent_type": "both",
>   "exclude_staff_children": false
> }'

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "pta_event_data": {
6       "id": 1842,
7       "title": "Fall parent conferences"
8     },
9     "global_slots": [],
10     "group_slots": [],
11     "family_slots": [],
12     "active_families": [],
13     "not_active_families": []
14   }
15 }

Updates the event configuration and regenerates its slot/family payload. At least one grade, class, or staff member must be selected.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

idintegerRequired

PTA event identifier.

Request

This endpoint expects an object.

titlestringRequired

start_datedatetimeRequired

ISO-8601 datetime with timezone offset.

pta_gap_parent_countintegerRequired

pta_schedule_type_idintegerRequired

pta_slot_duration_idintegerRequired

pta_slot_meeting_countintegerRequired

grade_idslist of integersOptional

class_idslist of integersOptional

staff_member_idslist of integersOptional

parent_typeenum or nullOptional

Allowed values:

exclude_staff_childrenbooleanOptional

Response

Updated event slot and family payload.

statusstring

messagestring

datamap from strings to any

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error