Skip to content

Create Case

Overview

Create a new case on the organisation.

Method and endpoint

POST /v1/case

Request Body Schema

CaseCreateSchema

Request Example

{
  "company": "AfriForum",
  "external_ref": "EXT12345",
  "subject": "Service Complaint",
  "category": "Complaint",
  "description": "Member complaint regarding delayed service.",
  "creator_idno": "8001015009087",
  "creator_name": "John",
  "creator_surname": "Doe",
  "creator_cellphone": "0821234567",
  "creator_email": "john.doe@example.com",
  "attachment": [
    {
      "filename": "evidence.pdf",
      "url": "https://example.com/evidence.pdf"
    }
  ]
}

Success Response (201) Schema

Object (implementation specific)

Response Example

{
  "case_id": "CASE12345",
  "status": "CREATED",
  "message": "Case created successfully"
}

Error Responses

  • 400 Validation Exception (Bad Request)