Terms and Conditions

Endpoints for retrieving and managing Terms and Conditions (T&C).

T&C are split into public access (read-only) and admin management (create, update, delete).


List Active Terms (Public)

GET /api/v1/terms-and-conditions/active

Get the currently active terms and conditions.

Authentication

Not required (public endpoint).

Response

{
  "success": true,
  "data": {
    "id": 1,
    "title": "Batchmates Terms v1.0",
    "content": "These are the terms and conditions...",
    "version": "1.0",
    "effective_date": "2026-01-01",
    "status": "active",
    "created_at": "2026-01-01T00:00:00.000000Z",
    "updated_at": "2026-01-01T00:00:00.000000Z"
  }
}

Create Terms (Admin)

POST /api/v1/terms-and-conditions

Create a new version of terms and conditions.

Authentication

Required (Admin).

Request Body

  • Name
    title
    Type
    string
    Description
    The title of the terms and conditions
  • Name
    content
    Type
    string
    Description
    Full text of the terms and conditions
  • Name
    version
    Type
    string
    Description
    Version number (default: 1.0)
  • Name
    effective_date
    Type
    string
    Description
    Effective date of these terms
  • Name
    status
    Type
    string
    Description
    active | draft (default: draft)

Response

{
  "success": true,
  "data": {
    "id": 2,
    "title": "Batchmates Terms v1.1",
    "content": "Updated terms and conditions...",
    "version": "1.1",
    "effective_date": "2026-02-01",
    "status": "draft",
    "created_at": "2026-01-30T00:00:00.000000Z",
    "updated_at": "2026-01-30T00:00:00.000000Z"
  },
  "message": "Terms and Conditions created successfully"
}

Update Terms (Admin)

PUT /api/v1/terms-and-conditions/{id}

Update an existing T&C entry.

Authentication

Required (Admin).

Path Parameters

  • Name
    id
    Type
    integer
    Description
    Terms and Conditions ID

Request Body

  • Name
    title
    Type
    string
    Description
    Updated title
  • Name
    content
    Type
    string
    Description
    Updated content
  • Name
    version
    Type
    string
    Description
    Updated version number
  • Name
    effective_date
    Type
    string
    Description
    Updated effective date
  • Name
    status
    Type
    string
    Description
    active | draft

Response

{
  "success": true,
  "data": {
    "id": 2,
    "title": "Updated Terms v1.1",
    "content": "Updated terms and conditions...",
    "version": "1.1",
    "effective_date": "2026-02-01",
    "status": "active",
    "created_at": "2026-01-30T00:00:00.000000Z",
    "updated_at": "2026-01-31T00:00:00.000000Z"
  },
  "message": "Terms and Conditions updated successfully"
}

Delete Terms (Admin)

DELETE /api/v1/terms-and-conditions/{id}

Delete a specific T&C entry.

Authentication Required (Admin).

Path Parameters

  • Name
    id
    Type
    integer
    Description
    Terms and Conditions ID

Response

{
  "success": true,
  "message": "Terms and Conditions deleted successfully"
}

Was this page helpful?