Rebranding API Documentation

Theme and white-label rebranding endpoints for customizing the Octeth interface appearance, logos, and product branding.

Create a Theme

POST /api.php

API Usage Notes

• Authentication required: Admin API Key
• Legacy endpoint access via /api.php only (no v1 REST alias configured)

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: theme.create
SessionID	String	No	Session ID obtained from admin login
APIKey	String	No	Admin API key for authentication
Template	String	Yes	Template code (must match an installed template)
ThemeName	String	Yes	Name for the new theme
ProductName	String	No	Custom product name for white-label branding
ThemeSettings	String	No	Theme CSS settings in format: tag````value\ntag````value (newline-separated)

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "theme.create",
    "SessionID": "admin-session-id",
    "Template": "weefive",
    "ThemeName": "My Custom Theme",
    "ProductName": "My Email Platform",
    "ThemeSettings": "primary-color||||#0066cc\nbackground-color||||#ffffff"
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "ThemeID": 123
}

Error Response

{
  "Success": false,
  "ErrorCode": [1, 2, 3]
}

Error Codes

0: Success
1: Missing template parameter
2: Missing theme name parameter
3: Invalid template code (template not found or not installed)

Get a Theme

POST /api.php

API Usage Notes

• Authentication required: Admin API Key
• Legacy endpoint access via /api.php only (no v1 REST alias configured)

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: theme.get
SessionID	String	No	Session ID obtained from admin login
APIKey	String	No	Admin API key for authentication
ThemeID	Integer	Yes	ID of the theme to retrieve

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "theme.get",
    "SessionID": "admin-session-id",
    "ThemeID": 123
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "Theme": {
    "ThemeID": 123,
    "Template": "weefive",
    "ThemeName": "My Custom Theme",
    "ProductName": "My Email Platform",
    "LogoData": "",
    "LogoType": "",
    "LogoSize": 0,
    "LogoFileName": "",
    "ThemeSettings": "primary-color||||#0066cc\nbackground-color||||#ffffff"
  }
}

Error Response

{
  "Success": false,
  "ErrorCode": [1, 2]
}

Error Codes

0: Success
1: Missing theme ID parameter
2: Theme not found

Update a Theme

POST /api.php

API Usage Notes

• Authentication required: Admin API Key
• Legacy endpoint access via /api.php only (no v1 REST alias configured)

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: theme.update
SessionID	String	No	Session ID obtained from admin login
APIKey	String	No	Admin API key for authentication
ThemeID	Integer	Yes	ID of the theme to update
Template	String	No	New template code (must match an installed template)
ThemeName	String	No	New theme name
ProductName	String	No	New product name for white-label branding
LogoData	String	No	Base64-encoded logo image data
LogoType	String	No	Logo MIME type (e.g., "image/png", "image/jpeg")
LogoSize	Integer	No	Logo file size in bytes
LogoFileName	String	No	Original logo filename
ThemeSettings	String	No	Theme CSS settings in format: tag````value\ntag````value (newline-separated)

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "theme.update",
    "SessionID": "admin-session-id",
    "ThemeID": 123,
    "ThemeName": "Updated Theme Name",
    "ProductName": "Updated Product Name",
    "ThemeSettings": "primary-color||||#ff6600\nbackground-color||||#f5f5f5"
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "ErrorText": ""
}

Error Response

{
  "Success": false,
  "ErrorCode": [3, 4, 5]
}

Error Codes

0: Success
3: Invalid template code (template not found or not installed)
4: Missing theme ID parameter
5: Theme not found

Get All Themes

POST /api.php

API Usage Notes

• Authentication required: Admin API Key
• Legacy endpoint access via /api.php only (no v1 REST alias configured)

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: themes.get
SessionID	String	No	Session ID obtained from admin login
APIKey	String	No	Admin API key for authentication

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "themes.get",
    "SessionID": "admin-session-id"
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0,
  "Themes": [
    {
      "ThemeID": 1,
      "Template": "weefive",
      "ThemeName": "Default Theme",
      "ProductName": "Octeth",
      "ThemeSettings": "primary-color||||#0066cc\nbackground-color||||#ffffff"
    },
    {
      "ThemeID": 123,
      "Template": "weefive",
      "ThemeName": "My Custom Theme",
      "ProductName": "My Email Platform",
      "ThemeSettings": "primary-color||||#ff6600\nbackground-color||||#f5f5f5"
    }
  ]
}

Error Response

{
  "Success": false,
  "ErrorCode": []
}

Error Codes

0: Success

Delete Themes

POST /api.php

API Usage Notes

• Authentication required: Admin API Key
• Legacy endpoint access via /api.php only (no v1 REST alias configured)

Deletes one or more themes. The system prevents deletion of the default theme and the last remaining theme to ensure at least one theme is always available.

Request Body Parameters:

Parameter	Type	Required	Description
Command	String	Yes	API command: theme.delete
SessionID	String	No	Session ID obtained from admin login
APIKey	String	No	Admin API key for authentication
Themes	String	Yes	Comma-separated list of theme IDs to delete

Example Request

curl -X POST https://example.com/api.php \
  -H "Content-Type: application/json" \
  -d '{
    "Command": "theme.delete",
    "SessionID": "admin-session-id",
    "Themes": "123,456"
  }'

Success Response

{
  "Success": true,
  "ErrorCode": 0
}

Error Response

{
  "Success": false,
  "ErrorCode": [1, 2]
}

Error Codes

0: Success
1: Missing themes parameter (theme IDs required)
2: Cannot delete the last remaining theme (at least one theme must exist)