Create a Letter

To create a new Letter.

A Letter will be created using the provided information. The response body will contain a JSON object with a key called result. The value will be an object containing the standard attributes for your new Letter. The response code will be 201 if the Letter was successfully created.

Request

Body Params application/json

Example

{
    "subject": "Judul Dispensasi",
    "letterType": "DISPENSATION",
    "beginDate": "2026-01-11T11:29:17.109Z",
    "endDate": "2026-01-11T11:29:17.109Z",
    "attachment": "https://via.placeholder.com/949x1596/cef321/1dbdef.png",
    "reason": "Lomba",
    "isPrinted": true,
    "recipientIds": [
        "cfda7ddb6baf9a95eb1a1e60",
        "eff5cf0fa1fd49a0df12d0ca"
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

Body

Example

{
    "success": true,
    "message": "OK.",
    "meta": {},
    "errors": [],
    "result": {
        "id": "68f44fb8040041adaee70c93",
        "applicant": {
            "id": "43c40e3dbe713f5bbafcfe25",
            "name": "Nurul Nurul Melinda",
            "email": "Lembah.Zulkarnain17@yahoo.com",
            "image": "https://avatars.githubusercontent.com/u/59223175"
        },
        "reviewer": {
            "id": "0817ccdeadc40aebcfb564b2",
            "name": "Eka Handayani",
            "email": "Unjani.Anandya@gmail.com",
            "image": "https://avatars.githubusercontent.com/u/95957417"
        },
        "subject": "Judul Dispensasi",
        "letterType": "DISPENSATION",
        "status": "PENDING",
        "beginDate": "2026-01-11T23:35:00.688Z",
        "endDate": "2026-01-11T23:35:00.689Z",
        "attachment": "https://via.placeholder.com/1828x1424/feb8ab/1cc255.png",
        "reason": "Lomba",
        "recipients": [
            {
                "id": "59e4784f3042aaabb9ba7af5",
                "name": "Napitupulu Ikhsan",
                "email": "Manah97@yahoo.co.id",
                "image": "https://avatars.githubusercontent.com/u/65944893"
            },
            {
                "id": "bab4da242678ecc76bf96def",
                "name": "Pangestu Lasmono",
                "email": "Hendra.Nasyidah77@gmail.co.id",
                "image": "https://avatars.githubusercontent.com/u/6810856"
            }
        ],
        "isPrinted": true,
        "letterNumber": "8974394322300649",
        "letterDate": "2026-01-11T23:35:00.690Z",
        "letterResult": "https://via.placeholder.com/329x745/de5d8a/56fb52.gif",
        "createdAt": "2026-01-11T23:35:00.690Z",
        "updatedAt": "2026-01-11T23:35:00.690Z",
        "history": [
            {
                "status": "PENDING",
                "actor": {
                    "id": "f3f8a2acaef20da3ced0a378",
                    "name": "Widiastuti Betania",
                    "email": "Karen52@gmail.co.id",
                    "image": "https://avatars.githubusercontent.com/u/40565649"
                },
                "note": "dolore anim",
                "attachment": "http://ICSyYRcUxswYlDvKWExBVztuM.tjaydV128JJso-dFaqO9wXsThLFsnrSfd3XcmYw3MY6MeBo0iApkY3zkp-E",
                "timestamp": "1768174500"
            },
            {
                "status": "APPROVED",
                "actor": {
                    "id": "77dec9c6551f124adefefdb7",
                    "name": "Simbolon Hari",
                    "email": "Harsana83@yahoo.com",
                    "image": "https://avatars.githubusercontent.com/u/84887150"
                },
                "note": "consectetur commodo",
                "attachment": null,
                "timestamp": "1768174500"
            },
            {
                "status": "REVISION",
                "actor": {
                    "id": "e2350de6dae4fde02583dcbc",
                    "name": "Putra Ajiono",
                    "email": "Lintang67@yahoo.com",
                    "image": "https://avatars.githubusercontent.com/u/46090002"
                },
                "note": "in in anim sint",
                "attachment": null,
                "timestamp": "1768174500"
            }
        ]
    }
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🔴500Server Error