Create Memo

Create a new memo with optional recipients and workflow approvals

Endpoint

POST /memos

Description

Create a new memo and assign it to optional recipients. The memo enters a pending state and follows the configured approval workflow based on the memo type.

Authentication

Requires Bearer token authentication. Accessible by:

• Employee
• Manager
• HR Manager
• Super Admin

Request Body

memoType · string · required

Type of memo. Must be one of:

• request - Request memo requiring approval
• disciplinary - Disciplinary action memo
• announcement - Company-wide announcement
• general - General purpose memo

title · string · required

Memo title (max 255 characters)

content · string · required

Full memo content

referenceNumber · string

Optional reference number for tracking (max 100 characters)

priority · string

Memo priority level. Must be one of:

• low
• normal (default)
• high
• urgent

recipientIds · array

Array of employee UUIDs who should receive this memo

Response

success · boolean

Indicates if the request was successful

data · object

The created memo object

Show Memo Object

id · string

Unique memo identifier (UUID)

companyId · string

Company UUID

employeeId · string

UUID of the employee who created the memo

memoType · string

Type of memo (request, disciplinary, announcement, general)

title · string

Memo title

content · string

Full memo content

referenceNumber · string

Reference number for tracking

status · string

Current memo status (draft, pending, approved, rejected, archived)

currentStep · integer

Current approval workflow step

priority · string

Priority level (low, normal, high, urgent)

createdAt · string

ISO 8601 timestamp of creation

updatedAt · string

ISO 8601 timestamp of last update

Example Request

{
  "memoType": "request",
  "title": "Request for Additional Resources",
  "content": "We require additional development resources for the Q2 project to meet the deadline.",
  "referenceNumber": "REQ-2024-001",
  "priority": "high",
  "recipientIds": [
    "550e8400-e29b-41d4-a716-446655440001",
    "550e8400-e29b-41d4-a716-446655440002"
  ]
}

Example Response

{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "companyId": "550e8400-e29b-41d4-a716-446655440000",
    "employeeId": "660e8400-e29b-41d4-a716-446655440000",
    "memoType": "request",
    "title": "Request for Additional Resources",
    "content": "We require additional development resources for the Q2 project to meet the deadline.",
    "referenceNumber": "REQ-2024-001",
    "status": "pending",
    "currentStep": 1,
    "priority": "high",
    "createdAt": "2024-03-03T10:30:00Z",
    "updatedAt": "2024-03-03T10:30:00Z"
  }
}

Status Codes

201 · Created

Memo created successfully

400 · Bad Request

Invalid request body or validation error

401 · Unauthorized

Missing or invalid authentication token

500 · Internal Server Error

Server error occurred

Workflow Behavior

When a memo is created with memoType set to request, it automatically enters the approval workflow configured for the company. The memo starts at step 1 with status pending.

Recipients specified in recipientIds will be notified of the memo and can mark it as read. This is separate from the approval workflow.