User

User profile and account management

Get user profile

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication. Get your key from the dashboard.

Responses

200

User profile

application/json

successbooleanOptionalExample: true

401

Authentication required or invalid

application/json

get

/user/profile

HTTPcURLJavaScriptPython

GET /api/v2/user/profile HTTP/1.1
Host: bulkmail.shop
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "id": 1,
    "name": "John Doe",
    "email": "[email protected]",
    "balance": 150.5,
    "created_at": "2026-03-03T20:07:34.518Z"
  }
}

Update user profile

put

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication. Get your key from the dashboard.

Body

application/json

namestringOptional

emailstring · emailOptional

Responses

200

Profile updated

application/json

successbooleanOptionalExample: true

messagestringOptionalExample: Profile updated successfully

401

Authentication required or invalid

application/json

422

Validation failed

application/json

put

/user/profile

HTTPcURLJavaScriptPython

PUT /api/v2/user/profile HTTP/1.1
Host: bulkmail.shop
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 40

{
  "name": "text",
  "email": "[email protected]"
}

{
  "success": true,
  "message": "Profile updated successfully"
}

Change password

post

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication. Get your key from the dashboard.

Body

application/json

current_passwordstringRequired

new_passwordstring · min: 8Required

new_password_confirmationstringRequired

Responses

200

Password changed

No content

401

Authentication required or invalid

application/json

422

Validation failed

application/json

post

/user/password

HTTPcURLJavaScriptPython

POST /api/v2/user/password HTTP/1.1
Host: bulkmail.shop
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "current_password": "text",
  "new_password": "text",
  "new_password_confirmation": "text"
}

No content

Get dashboard statistics

get

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication. Get your key from the dashboard.

Responses

200

Dashboard data

application/json

successbooleanOptionalExample: true

401

Authentication required or invalid

application/json

get

/user/dashboard

HTTPcURLJavaScriptPython

GET /api/v2/user/dashboard HTTP/1.1
Host: bulkmail.shop
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "balance": 1,
    "total_orders": 1,
    "total_spent": 1,
    "pending_orders": 1,
    "recent_orders": [
      {
        "id": 1,
        "order_number": "ORD-20240101-001",
        "product_name": "text",
        "quantity": 1,
        "unit_price": 1,
        "total_amount": 1,
        "status": "pending",
        "created_at": "2026-03-03T20:07:34.518Z"
      }
    ],
    "recent_transactions": [
      {
        "id": 1,
        "type": "deposit",
        "amount": 1,
        "balance_after": 1,
        "description": "text",
        "created_at": "2026-03-03T20:07:34.518Z"
      }
    ]
  }
}