Initiate a Letter Action

Designing

POST

/letters/{letter_id}/actions

To initiate an action on a Letter send a POST request to /letters/{letter_id}/actions.
In the JSON body to the request, set the type attribute to on of the supported action types:

Action	Details	Additionally Required Permission	Note	Who
`PROCESS`	Processes the Letter immediately.	`process:letter`	Optional	Reviewer
`APPROVE`	Approves the Letter.	`process:letter`	Optional	Reviewer
`REJECT`	Rejects the Letter.	`process:letter`	Required	Reviewer
`REVISE`	Requests a revision for the Letter.	`process:letter`	Required	Reviewer
`RESUBMIT`	Resubmits the Letter after revision.	`create:letter`	Optional	Applicant
`CANCEL`	Cancels the Letter.	`create:letter`	Optional	Applicant

The type attribute set in the request body will specify the action that will be taken on the Letter. Some actions will require additional attributes to be set as well.

Request

Path Params

Body Params application/json

{
    "action": "RESUBMIT",
    "subject": "Dispen Lomba Basket",
    "beginDate": "2026-01-12T07:33:46.897Z",
    "endDate": "2026-01-12T07:33:46.897Z",
    "attachment": "https://murky-widow.biz.id/",
    "reason": "Buat lomba",
    "recipientIds": [
        "c30473ac4baf4e5cfecb4f9d",
        "ef46a9ce8fb5bacdfc9ec49a"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://sims.sman1samarinda.sch.id/api/letters/c0d6fa82d0c90de6496fd980/actions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "action": "RESUBMIT",
    "subject": "Dispen Lomba Basket",
    "beginDate": "2026-01-12T07:33:46.897Z",
    "endDate": "2026-01-12T07:33:46.897Z",
    "attachment": "https://murky-widow.biz.id/",
    "reason": "Buat lomba",
    "recipientIds": [
        "c30473ac4baf4e5cfecb4f9d",
        "ef46a9ce8fb5bacdfc9ec49a"
    ]
}'

Responses

🟢200OK

application/json

Body

Example

{
    "success": true,
    "message": "OK.",
    "meta": {
        "page": 9,
        "limit": 5,
        "total": 8830
    },
    "errors": [
        {
            "code": "042",
            "field": "email",
            "message": "Email invalid"
        }
    ],
    "result": {
        "id": "68f44fb8040041adaee70c93",
        "applicant": {
            "id": "4a9bb1e7a8b58f8bc55b0a92",
            "name": "Saraswati Farhunnisa",
            "email": "Ajimin14@yahoo.com",
            "image": "https://avatars.githubusercontent.com/u/3693880"
        },
        "reviewer": null,
        "subject": "Judul Dispensasi",
        "letterType": "DISPENSATION",
        "status": "PENDING",
        "beginDate": "2026-01-12T07:35:36.616Z",
        "endDate": "2026-01-12T07:35:36.616Z",
        "attachment": "https://via.placeholder.com/347x216/4fa57c/adcdb7.jpeg",
        "reason": "Lomba",
        "recipients": [
            {
                "id": "7e10cbdf1c8cdb1aea9aca2f",
                "name": "Hartati Fara",
                "email": "Kezia_Tarihoran@yahoo.com",
                "image": "https://avatars.githubusercontent.com/u/86660607"
            },
            {
                "id": "bfd6fa0c2c1a9e333696a78d",
                "name": "Jefri Jefri Oktavian",
                "email": "Jayeng.Kusuma@yahoo.co.id",
                "image": "https://avatars.githubusercontent.com/u/43132757"
            },
            {
                "id": "94edab92ba61a3dcf5b22cd1",
                "name": "Wani Wani Suartini",
                "email": "Kemal45@gmail.co.id",
                "image": "https://avatars.githubusercontent.com/u/50676525"
            }
        ],
        "isPrinted": true,
        "letterNumber": "2570116359423895",
        "letterDate": "2026-01-12T07:35:36.620Z",
        "letterResult": "https://via.placeholder.com/518x1319/eb6ee6/b17f83.gif",
        "createdAt": "2026-01-12T07:35:36.620Z",
        "updatedAt": "2026-01-12T07:35:36.620Z"
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error

Modified at 2026-01-15 10:20:29

List Recipients

Create a Presigned URL