Update an attendance marking type

POST

https://ssuccessv2.com/app/api/v1/attendance/marking-type/update/:id

POST

/app/api/v1/attendance/marking-type/update/:id

$ curl -X POST https://ssuccessv2.com/app/api/v1/attendance/marking-type/update/8 \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Excused",
>   "category": "neutral",
>   "color": "#64748B",
>   "description": "Absence approved by the school",
>   "ask_for_permission": true,
>   "allow_note": true,
>   "require_note": false,
>   "icon": "info",
>   "active": true
> }'

1 {
2   "status": "success",
3   "message": "Updated successfully.",
4   "data": {
5     "id": 8,
6     "name": "Excused",
7     "active": true,
8     "description": "Absence approved by the school",
9     "category": "neutral",
10     "color": "#64748B",
11     "icon": "info",
12     "ask_for_permission": true,
13     "allow_note": true,
14     "require_note": false
15   }
16 }

Updates a global attendance marking type. Requires edit-attendance permission and edit-settings permission.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired

Request

This endpoint expects an object.

namestringRequired<=255 characters

categoryenumRequired

Allowed values:

colorstringRequired<=7 characters

descriptionstring or nullOptional

ask_for_permissionbooleanOptional

allow_notebooleanOptional

require_notebooleanOptional

iconstring or nullOptional<=255 characters

activebooleanOptional

Response

Marking type updated.

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error