Privacy Policy

Endpoints for retrieving and managing Privacy Policies.

Privacy Policies are split into public access (read-only) and admin management (create, update, delete).


Get Active Privacy Policy (Public)

GET /api/v1/privacy-policy/active

Get the currently active privacy policy (latest version).

Authentication

Not required (public endpoint).

Response

{
  "success": true,
  "data": {
    "id": 1,
    "title": "Privacy Policy v1.0",
    "content": "This is the content of the privacy policy.",
    "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 Privacy Policy (Admin) POST /api/v1/privacy-policy

Create a new privacy policy entry.

Authentication

Required (Admin).

Request Body

  • Name
    title
    Type
    string
    Description
    Title of the privacy policy
  • Name
    content
    Type
    string
    Description
    Full content of the privacy policy
  • Name
    version
    Type
    string
    Description
    Version number (default: "1.0")
  • Name
    effective_date
    Type
    date
    Description
    Effective date of the policy
  • Name
    status
    Type
    string
    Description
    active | draft (default: draft)

Response

{
  "success": true,
  "data": {
    "id": 2,
    "title": "Privacy Policy v1.1",
    "content": "Updated content of the privacy policy.",
    "version": "1.1",
    "effective_date": "2026-02-01",
    "status": "draft",
    "created_at": "2026-02-01T00:00:00.000000Z",
    "updated_at": "2026-02-01T00:00:00.000000Z"
  },
  "message": "Privacy Policy created successfully"
}

#Update Privacy Policy (Admin) PUT /api/v1/privacy-policy/{privacy_policy}

Update an existing privacy policy.

Authentication

Required (Admin).

Path Parameters

  • Name
    privacy_policy
    Type
    integer
    Description
    Privacy Policy ID

Request Body

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

Response

{
  "success": true,
  "data": {
    "id": 2,
    "title": "Updated Privacy Policy v1.1",
    "content": "Updated content of the privacy policy.",
    "version": "1.1",
    "effective_date": "2026-02-01",
    "status": "active",
    "created_at": "2026-02-01T00:00:00.000000Z",
    "updated_at": "2026-02-02T00:00:00.000000Z"
  },
  "message": "Privacy Policy updated successfully"
}

#Delete Privacy Policy (Admin) DELETE /api/v1/privacy-policy/{privacy_policy}

Delete a specific privacy policy.

Authentication

Required (Admin).

Path Parameters

  • Name
    privacy_policy
    Type
    integer
    Description
    Privacy Policy ID

Response

{
  "success": true,
  "message": "Privacy Policy deleted successfully"
}

Was this page helpful?