restapi.json

{
 "openapi": "3.0.0",
 "info": {
 "title": "phpList API Documentation",
 "description": "This is the OpenAPI documentation for phpList API.",
 "contact": {
 "email": "tatevik@phplist.com"
 },
 "license": {
 "name": "AGPL-3.0-or-later",
 "url": "https://www.gnu.org/licenses/agpl.txt"
 },
 "version": "1.0.0"
 },
 "servers": [
 {
 "url": "https://www.phplist.com/api/v2",
 "description": "Production server"
 }
 ],
 "paths": {
 "/api/v2/configs": {
 "get": {
 "tags": [
 "configs"
 ],
 "summary": "Gets all configuration items.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns all configuration items.",
 "operationId": "8f8a371403a0e0c77c620357231d2415",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/Config"
 }
 },
 "pagination": {
 "$ref": "#/components/schemas/CursorPagination"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 },
 "post": {
 "tags": [
 "configs"
 ],
 "summary": "Creates a configuration item.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Creates a configuration item.",
 "operationId": "c767f008e7e0f8c093645a263932800f",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Configuration item data",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ConfigRequest"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Config"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "409": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/AlreadyExistsResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/configs/{key}": {
 "get": {
 "tags": [
 "configs"
 ],
 "summary": "Gets a configuration item.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns one configuration item by key.",
 "operationId": "6e300b7f3a1f48551382d63965d42236",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "key",
 "in": "path",
 "description": "Configuration key",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Config"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 },
 "put": {
 "tags": [
 "configs"
 ],
 "summary": "Updates a configuration item.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Updates a configuration item value.",
 "operationId": "240870a0b6dce4847a5adad676c82e45",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "key",
 "in": "path",
 "description": "Configuration key",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Configuration item data",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ConfigUpdateRequest"
 }
 }
 }
 },
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Config"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 },
 "delete": {
 "tags": [
 "configs"
 ],
 "summary": "Deletes a configuration item.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes a configuration item.",
 "operationId": "3b07e5ff518395283f31ec4e1ed2d9d7",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "key",
 "in": "path",
 "description": "Configuration key",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "204": {
 "description": "Success"
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/administrators/attributes": {
 "get": {
 "tags": [
 "admin-attributes"
 ],
 "summary": "Gets a list of all admin attribute definitions.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all admin attribute definitions.",
 "operationId": "68b7d9433a6358436de121484f402e3b",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "after_id",
 "in": "query",
 "description": "Last id (starting from 0)",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 1,
 "minimum": 1
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Number of results per page",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 25,
 "maximum": 100,
 "minimum": 1
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/AdminAttributeDefinition"
 }
 },
 "pagination": {
 "$ref": "#/components/schemas/CursorPagination"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 },
 "post": {
 "tags": [
 "admin-attributes"
 ],
 "summary": "Create an admin attribute definition.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created admin attribute definition.",
 "operationId": "5bee92e632fc1245eba1d29f00558a80",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Pass parameters to create admin attribute.",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/AdminAttributeDefinitionRequest"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/AdminAttributeDefinition"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/administrators/attributes/{definitionId}": {
 "get": {
 "tags": [
 "admin-attributes"
 ],
 "summary": "Gets attribute with specified ID.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a single attribute with specified ID.",
 "operationId": "9e57fc1f6a265beac32eb349f5c730f0",
 "parameters": [
 {
 "name": "definitionId",
 "in": "path",
 "description": "Definition ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/AdminAttributeDefinition"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "message": {
 "type": "string",
 "example": "There is no attribute with that ID."
 }
 },
 "type": "object"
 }
 }
 }
 }
 }
 },
 "put": {
 "tags": [
 "admin-attributes"
 ],
 "summary": "Update an admin attribute definition.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns updated admin attribute definition.",
 "operationId": "f9808a1d30aebafde1426e19dae9e8cf",
 "parameters": [
 {
 "name": "definitionId",
 "in": "path",
 "description": "Definition ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Pass parameters to update admin attribute.",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/AdminAttributeDefinitionRequest"
 }
 }
 }
 },
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/AdminAttributeDefinition"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 },
 "delete": {
 "tags": [
 "admin-attributes"
 ],
 "summary": "Deletes an attribute definition.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes a single admin attribute definition.",
 "operationId": "5e22c902d069355dd7b6ee6fac9309af",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "definitionId",
 "in": "path",
 "description": "Definition ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success"
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/administrators/{adminId}/attributes/{definitionId}": {
 "get": {
 "tags": [
 "admin-attributes"
 ],
 "summary": "Gets admin attribute.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a single attribute.",
 "operationId": "c78ef2b0910f4e150dbcd2a6cd0ea27e",
 "parameters": [
 {
 "name": "definitionId",
 "in": "path",
 "description": "attribute definition id",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "adminId",
 "in": "path",
 "description": "Administrator id",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/AdminAttributeValue"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "message": {
 "type": "string",
 "example": "There is no attribute with that ID."
 }
 },
 "type": "object"
 }
 }
 }
 }
 }
 },
 "post": {
 "tags": [
 "admin-attributes"
 ],
 "summary": "Create/update an admin attribute.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created/updated admin attribute.",
 "operationId": "3cc645e3d26cc49501ad67adda844712",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "definitionId",
 "in": "path",
 "description": "attribute definition id",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "adminId",
 "in": "path",
 "description": "Administrator id",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "requestBody": {
 "description": "Pass parameters to create admin attribute.",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "value": {
 "type": "string",
 "example": "United States"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/AdminAttributeValue"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 },
 "delete": {
 "tags": [
 "admin-attributes"
 ],
 "summary": "Deletes an attribute.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes a single admin attribute.",
 "operationId": "7e8b9cefb17ef3cbb69501820e0d0f6c",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "definitionId",
 "in": "path",
 "description": "attribute definition id",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "adminId",
 "in": "path",
 "description": "Administrator id",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success"
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/administrators/{adminId}/attributes": {
 "get": {
 "tags": [
 "admin-attributes"
 ],
 "summary": "Gets a list of all admin attributes.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all admin attributes.",
 "operationId": "d6a09a4d6f2451e72c2a8b23e2fd1911",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "adminId",
 "in": "path",
 "description": "Administrator id",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "after_id",
 "in": "query",
 "description": "Last id (starting from 0)",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 1,
 "minimum": 1
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Number of results per page",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 25,
 "maximum": 100,
 "minimum": 1
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/AdminAttributeValue"
 }
 },
 "pagination": {
 "$ref": "#/components/schemas/CursorPagination"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/administrators": {
 "get": {
 "tags": [
 "administrators"
 ],
 "summary": "Get Administrators",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Get list of administrators.",
 "operationId": "dfc888f94f2ce46ce7a2ae8e1d55ebbc",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "after_id",
 "in": "query",
 "description": "Last id (starting from 0)",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 1,
 "minimum": 1
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Number of results per page",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 25,
 "maximum": 100,
 "minimum": 1
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/Administrator"
 }
 },
 "pagination": {
 "$ref": "#/components/schemas/CursorPagination"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "400": {
 "description": "Invalid input"
 }
 }
 },
 "post": {
 "tags": [
 "administrators"
 ],
 "summary": "Create Administrator",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Create a new administrator.",
 "operationId": "62e1c82af2ab59be7300fa99f73bc354",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Administrator data",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/CreateAdministratorRequest"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Administrator created successfully",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Administrator"
 }
 }
 }
 },
 "422": {
 "description": "Invalid input"
 }
 }
 }
 },
 "/api/v2/administrators/{adminId}": {
 "get": {
 "tags": [
 "administrators"
 ],
 "summary": "Get Administrator",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Get administrator by ID.",
 "operationId": "71a302c638b746ec7169b15da4ae7c9a",
 "parameters": [
 {
 "name": "adminId",
 "in": "path",
 "description": "Administrator ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Administrator found",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Administrator"
 }
 }
 }
 },
 "404": {
 "description": "Administrator not found"
 }
 }
 },
 "put": {
 "tags": [
 "administrators"
 ],
 "summary": "Update Administrator",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Update an administrator.",
 "operationId": "53023c81474020aca57ac09031e1c49c",
 "parameters": [
 {
 "name": "adminId",
 "in": "path",
 "description": "Administrator ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Administrator update data",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UpdateAdministratorRequest"
 }
 }
 }
 },
 "responses": {
 "200": {
 "description": "Administrator updated successfully",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Administrator"
 }
 }
 }
 },
 "404": {
 "description": "Administrator not found"
 }
 }
 },
 "delete": {
 "tags": [
 "administrators"
 ],
 "summary": "Delete Administrator",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete an administrator.",
 "operationId": "52cdf4ca32e2fe304993bdac19c1bc92",
 "parameters": [
 {
 "name": "adminId",
 "in": "path",
 "description": "Administrator ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "204": {
 "description": "Administrator deleted successfully"
 },
 "404": {
 "description": "Administrator not found"
 }
 }
 }
 },
 "/api/v2/password-reset/request": {
 "post": {
 "tags": [
 "password-reset"
 ],
 "summary": "Request a password reset.",
 "description": "Request a password reset token for an administrator account.",
 "operationId": "7725789cb52ab5de77489011d4c43928",
 "requestBody": {
 "description": "Administrator email",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "required": [
 "email"
 ],
 "properties": {
 "email": {
 "type": "string",
 "format": "email",
 "example": "admin@example.com"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "responses": {
 "204": {
 "description": "Password reset token generated"
 },
 "400": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/BadRequestResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/password-reset/validate": {
 "post": {
 "tags": [
 "password-reset"
 ],
 "summary": "Validate a password reset token.",
 "description": "Validate a password reset token.",
 "operationId": "336b157137fc4c4bd95714810f934ef8",
 "requestBody": {
 "description": "Password reset token",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "required": [
 "token"
 ],
 "properties": {
 "token": {
 "type": "string",
 "example": "a1b2c3d4e5f6"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "valid": {
 "type": "boolean",
 "example": true
 }
 },
 "type": "object"
 }
 }
 }
 },
 "400": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/BadRequestResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/password-reset/reset": {
 "post": {
 "tags": [
 "password-reset"
 ],
 "summary": "Reset password with token.",
 "description": "Reset an administrator password using a token.",
 "operationId": "19b7cbd6a10c9636a579b35028d1b1fc",
 "requestBody": {
 "description": "Password reset information",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "required": [
 "token",
 "newPassword"
 ],
 "properties": {
 "token": {
 "type": "string",
 "example": "a1b2c3d4e5f6"
 },
 "newPassword": {
 "type": "string",
 "format": "password",
 "example": "newSecurePassword123"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "message": {
 "type": "string",
 "example": "Password updated successfully"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "400": {
 "description": "Invalid or expired token",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/BadRequestResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/sessions": {
 "post": {
 "tags": [
 "sessions"
 ],
 "summary": "Log in or create new session.",
 "description": "✅ **Status: Stable** – This method is stable and safe for production use. Given valid login data, this will generate a login token that will be valid for 1 hour.",
 "operationId": "8ecb80a8846ff88c2cc875960f7268c1",
 "requestBody": {
 "description": "Pass session credentials",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "required": [
 "login_name",
 "password"
 ],
 "properties": {
 "login_name": {
 "type": "string",
 "format": "string",
 "example": "admin"
 },
 "password": {
 "type": "string",
 "format": "password",
 "example": "eetIc/Gropvoc1"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "id": {
 "type": "integer",
 "example": 1234
 },
 "key": {
 "type": "string",
 "example": "2cfe100561473c6cdd99c9e2f26fa974"
 },
 "expiry": {
 "type": "string",
 "example": "2017-07-20T18:22:48+00:00"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "400": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/BadRequestResponse"
 }
 }
 }
 },
 "401": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "message": {
 "type": "string",
 "example": "Not authorized."
 }
 },
 "type": "object"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/sessions/{sessionId}": {
 "delete": {
 "tags": [
 "sessions"
 ],
 "summary": "Delete a session.",
 "description": "✅ **Status: Stable** – This method is stable and safe for production use. Delete the session passed as a parameter.",
 "operationId": "a6b4f29398d881badfa190dd11326fc9",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "sessionId",
 "in": "path",
 "description": "Session id (not key as for authentication) obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success"
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/sessions/me": {
 "get": {
 "tags": [
 "sessions"
 ],
 "summary": "Get auth user data.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Get auth user data.",
 "operationId": "17c16a66c3e6fc44535253b7234f3727",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Administrator found",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Administrator"
 }
 }
 }
 },
 "401": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "message": {
 "type": "string",
 "example": "Not authorized."
 }
 },
 "type": "object"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/attachments/download/{id}": {
 "get": {
 "tags": [
 "attachments"
 ],
 "summary": "Download attachment",
 "description": "Download an attachment by ID. `uid` query parameter is required.",
 "operationId": "adf9081332610a149939c162b95e5286",
 "parameters": [
 {
 "name": "id",
 "in": "path",
 "description": "Attachment ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "uid",
 "in": "query",
 "description": "Download token (subscriber email or word \"forwarded\")",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "File stream"
 },
 "403": {
 "description": "Unauthorized"
 },
 "404": {
 "description": "Not found"
 }
 }
 }
 },
 "/api/v2/bounces": {
 "get": {
 "tags": [
 "bounces"
 ],
 "summary": "Gets a list of all bounces.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all bounces.",
 "operationId": "98e6f5ee3a2c8cb61009583a938b22cb",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "after_id",
 "in": "query",
 "description": "Last id (starting from 0)",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 1,
 "minimum": 1
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Number of results per page",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 25,
 "maximum": 100,
 "minimum": 1
 }
 },
 {
 "name": "status",
 "in": "query",
 "description": "Bounce status",
 "required": false,
 "schema": {
 "type": "string",
 "default": "unidentified bounce",
 "maxLength": 100,
 "minLength": 1
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/BounceView"
 }
 },
 "pagination": {
 "$ref": "#/components/schemas/CursorPagination"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/bounces/{bounceId}": {
 "delete": {
 "tags": [
 "bounces"
 ],
 "summary": "Delete a bounce by its id",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete a bounce by its id.",
 "operationId": "52d0665c9ee3e8d0276cfe65e43866f4",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "bounceId",
 "in": "path",
 "description": "Bounce id",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "204": {
 "description": "Success"
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/bounces/by/campaign": {
 "get": {
 "tags": [
 "bounces"
 ],
 "summary": "Gets a list of bounce counts by campaign.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of bounce counts by campaign.",
 "operationId": "a2de96a367d951e9047630b863fbc756",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "type": "array",
 "items": {
 "properties": {
 "message_id": {
 "type": "integer",
 "example": 1
 },
 "subject": {
 "type": "string",
 "example": "System"
 },
 "total_bounces": {
 "type": "integer",
 "example": 3
 }
 },
 "type": "object"
 }
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/bounces/by/subscriber": {
 "get": {
 "tags": [
 "bounces"
 ],
 "summary": "Gets a list of bounce counts by subscriber.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of bounce counts by subscriber.",
 "operationId": "e914619969016f6d3ec3da6b645b5ff3",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "type": "array",
 "items": {
 "properties": {
 "subscriber_id": {
 "type": "integer",
 "example": 1
 },
 "email": {
 "type": "string",
 "example": "example@email.com"
 },
 "confirmed": {
 "type": "boolean",
 "example": true
 },
 "blacklisted": {
 "type": "boolean",
 "example": true
 },
 "total_bounces": {
 "type": "integer",
 "example": 3
 }
 },
 "type": "object"
 }
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/bounces/regex": {
 "get": {
 "tags": [
 "bounces"
 ],
 "summary": "Gets a list of all bounce regex rules.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all bounce regex rules.",
 "operationId": "6449bb00e5412ff3d0bf9731a49fd172",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/BounceRegex"
 }
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 },
 "post": {
 "tags": [
 "bounces"
 ],
 "summary": "Create a bounce regex",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Creates a new bounce regex.",
 "operationId": "97db4cfc72576a22e0bcd6215fd35e51",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Create bounce regex rule",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/BounceRegexRequest"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/BounceRegex"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/bounces/regex/{ruleId}": {
 "get": {
 "tags": [
 "bounces"
 ],
 "summary": "Get a bounce regex by its ID",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a bounce regex by its ID.",
 "operationId": "babc8c57b673d026ea5fc6100320d4a6",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "ruleId",
 "in": "path",
 "description": "Regex ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/BounceRegex"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 },
 "put": {
 "tags": [
 "bounces"
 ],
 "summary": "Update a bounce regex",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Updates an existing one.",
 "operationId": "fefed1a3824116daedc42d65b0117230",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "ruleId",
 "in": "path",
 "description": "regex rule ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "requestBody": {
 "description": "Update a bounce regex rule.",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/BounceRegexRequest"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/BounceRegex"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 },
 "delete": {
 "tags": [
 "bounces"
 ],
 "summary": "Delete a bounce regex by its id",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete a bounce regex by its id.",
 "operationId": "afe7121aa9c6652066ba8ca4e2c07fba",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "ruleId",
 "in": "path",
 "description": "Regex hash",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "204": {
 "description": "Success"
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/campaigns/{messageId}/copy": {
 "post": {
 "tags": [
 "campaigns"
 ],
 "summary": "Copies campaign/message by id.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Copies campaign/message by id into a draft message.",
 "operationId": "858216f8617f37fd5f4d40d4f84632d0",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "messageId",
 "in": "path",
 "description": "message ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Message"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/campaigns/{messageId}/status": {
 "patch": {
 "tags": [
 "campaigns"
 ],
 "summary": "Update campaign status by id.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Updates campaign/message status by id.",
 "operationId": "8b4d780c2f00df2eddca6244cbfc45d8",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "messageId",
 "in": "path",
 "description": "message ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Update message status.",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/MessageMetadataRequest"
 }
 }
 }
 },
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Message"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/campaigns/{messageId}/send": {
 "post": {
 "tags": [
 "campaigns"
 ],
 "summary": "Processes/sends campaign/message by id.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Processes/sends campaign/message by id.",
 "operationId": "8f1cd9b2882cd23e38fb481096e95658",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "messageId",
 "in": "path",
 "description": "message ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Message"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/campaigns/{messageId}/resend": {
 "post": {
 "tags": [
 "campaigns"
 ],
 "summary": "Processes/sends campaign/message by id to lists.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Processes/sends campaign/message by id to specified mailing lists.",
 "operationId": "e83ae5f0557b149d31889770ae75b36b",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "messageId",
 "in": "path",
 "description": "message ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "List ids to send this campaign to.",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ResendMessageToListsRequest"
 }
 }
 }
 },
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Message"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/campaigns/{messageId}/test-send": {
 "post": {
 "tags": [
 "campaigns"
 ],
 "summary": "Processes/sends campaign/message by id to specified subscribers.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Processes/sends campaign/message by id to specified subscribers.",
 "operationId": "6503953d7fcf631b0582053a57d2f2a8",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "messageId",
 "in": "path",
 "description": "message ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Subscribers email to send this campaign to.",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ResendMessageToListsRequest"
 }
 }
 }
 },
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Message"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/campaigns": {
 "get": {
 "tags": [
 "campaigns"
 ],
 "summary": "Gets a list of all campaigns.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all campaigns/messages.",
 "operationId": "ea24d861841d2dbccb639a4d2918aebc",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "after_id",
 "in": "query",
 "description": "Last id (starting from 0)",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 1,
 "minimum": 1
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Number of results per page",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 25,
 "maximum": 100,
 "minimum": 1
 }
 },
 {
 "name": "subject",
 "in": "query",
 "description": "Filter campaigns by subject (partial match)",
 "required": false,
 "schema": {
 "type": "string",
 "maxLength": 50
 }
 },
 {
 "name": "status",
 "in": "query",
 "description": "Filter by one or more comma-separated statuses: draft, prepared, submitted, inprocess, sent, suspended",
 "required": false,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "sort",
 "in": "query",
 "description": "Sort direction by campaign id - desc returns newest campaigns first",
 "required": false,
 "schema": {
 "type": "string",
 "default": "asc",
 "enum": [
 "asc",
 "desc"
 ]
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/Message"
 }
 },
 "pagination": {
 "$ref": "#/components/schemas/CursorPagination"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 },
 "post": {
 "tags": [
 "campaigns"
 ],
 "summary": "Create a message for campaign.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created message.",
 "operationId": "4509477a54e9a738a3ff9ad71f8a7b00",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Create a new message.",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "required": [
 "content",
 "format",
 "metadata",
 "schedule",
 "options"
 ],
 "properties": {
 "template_id": {
 "type": "integer",
 "example": 1
 },
 "content": {
 "$ref": "#/components/schemas/MessageContentRequest"
 },
 "format": {
 "$ref": "#/components/schemas/MessageFormatRequest"
 },
 "metadata": {
 "$ref": "#/components/schemas/MessageMetadataRequest"
 },
 "schedule": {
 "$ref": "#/components/schemas/MessageScheduleRequest"
 },
 "options": {
 "$ref": "#/components/schemas/MessageOptionsRequest"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Message"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/campaigns/{messageId}": {
 "get": {
 "tags": [
 "campaigns"
 ],
 "summary": "Gets a campaign by id.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns campaign/message by id.",
 "operationId": "f1c98ff78ce3d1ce528257de4ce3da07",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "messageId",
 "in": "path",
 "description": "message ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Message"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 },
 "put": {
 "tags": [
 "campaigns"
 ],
 "summary": "Update campaign by id.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Updates campaign/message by id.",
 "operationId": "442ec1af3bc897d7b2daf7d0013ea367",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "messageId",
 "in": "path",
 "description": "message ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Update message.",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "required": [
 "content",
 "format",
 "schedule",
 "options"
 ],
 "properties": {
 "template_id": {
 "type": "integer",
 "example": 1
 },
 "content": {
 "$ref": "#/components/schemas/MessageContentRequest"
 },
 "format": {
 "$ref": "#/components/schemas/MessageFormatRequest"
 },
 "schedule": {
 "$ref": "#/components/schemas/MessageScheduleRequest"
 },
 "options": {
 "$ref": "#/components/schemas/MessageOptionsRequest"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Message"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 },
 "delete": {
 "tags": [
 "campaigns"
 ],
 "summary": "Delete campaign by id.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete campaign/message by id.",
 "operationId": "f13a1efd58d8cfb8bc67807adcec2d8e",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "messageId",
 "in": "path",
 "description": "message ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Message"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/editor-uploads": {
 "get": {
 "tags": [
 "editor-uploads"
 ],
 "summary": "List files in upload directory",
 "description": "Returns a list of files in the requested upload directory.",
 "operationId": "e7e69f1b4695239ad3301bc61de57862",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "directory",
 "in": "query",
 "description": "Upload directory name (e.g., \"uploads\" or \"images\")",
 "required": false,
 "schema": {
 "type": "string",
 "default": "uploads"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "files": {
 "type": "array",
 "items": {
 "properties": {
 "name": {
 "type": "string",
 "example": "image.png"
 },
 "url": {
 "type": "string",
 "example": "https://ex.com/api/v2/editor-uploads/image.png"
 },
 "size": {
 "type": "integer",
 "example": 12345
 },
 "type": {
 "type": "string",
 "example": "file"
 },
 "modified": {
 "type": "integer",
 "example": 1689255600
 }
 },
 "type": "object"
 }
 },
 "directory": {
 "type": "string",
 "example": "uploads"
 },
 "total": {
 "type": "integer",
 "example": 5
 }
 },
 "type": "object"
 }
 }
 }
 },
 "400": {
 "description": "Bad request - invalid directory",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/BadRequestResponse"
 }
 }
 }
 },
 "401": {
 "description": "Unauthorized",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Directory not found",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 },
 "post": {
 "tags": [
 "editor-uploads"
 ],
 "summary": "Upload editor asset",
 "description": "Uploads an editor asset for use in CKEditor.",
 "operationId": "b6cf7a64f5fccb8f0601331579203dc1",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "required": true,
 "content": {
 "multipart/form-data": {
 "schema": {
 "properties": {
 "upload": {
 "description": "Asset file to upload",
 "type": "string",
 "format": "binary"
 },
 "file": {
 "description": "Alternative asset file field name",
 "type": "string",
 "format": "binary"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/EditorUpload"
 }
 }
 }
 },
 "400": {
 "description": "Bad request",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/BadRequestResponse"
 }
 }
 }
 },
 "401": {
 "description": "Unauthorized",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "413": {
 "description": "Payload too large",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/GenericErrorResponse"
 }
 }
 }
 },
 "500": {
 "description": "Storage failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/GenericErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/editor-uploads/{filename}": {
 "get": {
 "tags": [
 "editor-uploads"
 ],
 "summary": "Get uploaded image by name",
 "description": "Returns an uploaded image file by its name.",
 "operationId": "e6468f87da70512337db720c33725084",
 "parameters": [
 {
 "name": "filename",
 "in": "path",
 "description": "Name of the uploaded image file",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/octet-stream": {}
 }
 },
 "404": {
 "description": "File not found",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/email-forward/{messageId}": {
 "post": {
 "tags": [
 "campaigns"
 ],
 "summary": "Forward a message to recipients.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Queues forwarding of a campaign/message to provided recipient emails.",
 "operationId": "c41e27bcaf3409ec2efda8660574850e",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "messageId",
 "in": "path",
 "description": "message ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Forwarding payload",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ForwardMessageRequest"
 }
 }
 }
 },
 "responses": {
 "202": {
 "description": "Accepted",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ForwardResult"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/list-messages/message/{messageId}/lists": {
 "get": {
 "tags": [
 "list-messages"
 ],
 "summary": "Returns a list of subscriber lists associated with a message.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "13859632a920ab15c277632e3a389f91",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "messageId",
 "in": "path",
 "description": "Message ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/SubscriberList"
 }
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Unauthorized",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Message not found",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 },
 "delete": {
 "tags": [
 "list-messages"
 ],
 "summary": "Removes all list associations for a message.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "8ac8602531b6160bfdde282f8f2c4834",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "messageId",
 "in": "path",
 "description": "Message ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "responses": {
 "204": {
 "description": "Success, no content"
 },
 "403": {
 "description": "Unauthorized",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Message not found",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/list-messages/list/{listId}/messages": {
 "get": {
 "tags": [
 "list-messages"
 ],
 "summary": "Returns a list of message IDs associated with a subscriber list.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "9e91d7505c692a51336a4b85fa846a74",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "listId",
 "in": "path",
 "description": "Subscriber List ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/Message"
 }
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Unauthorized",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Subscriber list not found",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/list-messages/message/{messageId}/list/{listId}": {
 "post": {
 "tags": [
 "list-messages"
 ],
 "summary": "Associates a message with a subscriber list.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "3648ea88a78c86a041538105202d1702",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "messageId",
 "in": "path",
 "description": "Message ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "listId",
 "in": "path",
 "description": "Subscriber List ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ListMessage"
 }
 }
 }
 },
 "403": {
 "description": "Unauthorized",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Message or subscriber list not found",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 },
 "delete": {
 "tags": [
 "list-messages"
 ],
 "summary": "Disassociates a message from a subscriber list.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "00b8276ae19641062b5bbba1ef8aa247",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "messageId",
 "in": "path",
 "description": "Message ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "listId",
 "in": "path",
 "description": "Subscriber List ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "responses": {
 "204": {
 "description": "Success, no content"
 },
 "403": {
 "description": "Unauthorized",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Message or subscriber list not found",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/list-messages/message/{messageId}/list/{listId}/check": {
 "get": {
 "tags": [
 "list-messages"
 ],
 "summary": "Checks if a message is associated with a subscriber list.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "c98f2361f7c4b2270c1046570d2d491e",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "messageId",
 "in": "path",
 "description": "Message ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "listId",
 "in": "path",
 "description": "Subscriber List ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "is_associated": {
 "type": "boolean"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Unauthorized",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Message or subscriber list not found",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/templates": {
 "get": {
 "tags": [
 "templates"
 ],
 "summary": "Gets a list of all templates.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all templates.",
 "operationId": "087039999e07f0b831aca77cb1f8bb1c",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "after_id",
 "in": "query",
 "description": "Last id (starting from 0)",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 1,
 "minimum": 1
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Number of results per page",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 25,
 "maximum": 100,
 "minimum": 1
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/Template"
 }
 },
 "pagination": {
 "$ref": "#/components/schemas/CursorPagination"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 },
 "post": {
 "tags": [
 "templates"
 ],
 "summary": "Create a new template.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON response of created template.",
 "operationId": "1b4a0dd67dd9c65cd62ca500b7837a1d",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Pass session credentials",
 "required": true,
 "content": {
 "multipart/form-data": {
 "schema": {
 "$ref": "#/components/schemas/CreateTemplateRequest"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Template"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "409": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/AlreadyExistsResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/templates/defaults": {
 "get": {
 "tags": [
 "templates"
 ],
 "summary": "Gets a list of all default templates.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all available default templates.",
 "operationId": "bd28f733452097eca52a8f72549ffe92",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "type": "array",
 "items": {
 "properties": {
 "key": {
 "type": "string",
 "example": "system"
 },
 "name": {
 "type": "string",
 "example": "System"
 },
 "description": {
 "type": "string",
 "example": "Default system email"
 },
 "file": {
 "type": "string",
 "example": "system.html"
 }
 },
 "type": "object"
 }
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/templates/defaults/{key}": {
 "post": {
 "tags": [
 "templates"
 ],
 "summary": "Creates a template from a default template.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Creates a new template from a default template key.",
 "operationId": "67e657e5c80cc0c88a4cc43a6eb55f99",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "key",
 "in": "path",
 "description": "Default template key",
 "required": true,
 "schema": {
 "type": "string",
 "enum": [
 "system",
 "responsive"
 ]
 }
 }
 ],
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Template"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/templates/{templateId}": {
 "get": {
 "tags": [
 "templates"
 ],
 "summary": "Gets a templateI by id.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns template by id.",
 "operationId": "399ceead91ad931b306c585e3728027a",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "templateId",
 "in": "path",
 "description": "template ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Template"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 },
 "put": {
 "tags": [
 "templates"
 ],
 "summary": "Update template.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON response of updated template.",
 "operationId": "a73b9801869083ca7a9739aed68d1b92",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Pass session credentials",
 "required": true,
 "content": {
 "multipart/form-data": {
 "schema": {
 "$ref": "#/components/schemas/CreateTemplateRequest"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/Template"
 }
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 },
 "delete": {
 "tags": [
 "templates"
 ],
 "summary": "Deletes a template.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes template by id.",
 "operationId": "fde16eb99758ec7a4deb05a597c25178",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "templateId",
 "in": "path",
 "description": "Template ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "204": {
 "description": "Success"
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/analytics/campaigns": {
 "get": {
 "tags": [
 "analytics"
 ],
 "summary": "Gets campaign statistics.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns statistics overview for campaigns.",
 "operationId": "8a10d30d0e428611a077196e18382f1e",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Maximum number of campaigns to return",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 20,
 "minimum": 1
 }
 },
 {
 "name": "after_id",
 "in": "query",
 "description": "Last seen campaign ID for pagination",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 0,
 "minimum": 0
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/CampaignStatistics"
 }
 },
 "pagination": {
 "$ref": "#/components/schemas/CursorPagination"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Unauthorized",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/analytics/view-opens": {
 "get": {
 "tags": [
 "analytics"
 ],
 "summary": "Gets view opens statistics.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns statistics for view opens.",
 "operationId": "37095a7af610f1e0927dd04f772295db",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Maximum number of campaigns to return",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 20,
 "minimum": 1
 }
 },
 {
 "name": "after_id",
 "in": "query",
 "description": "Last seen campaign ID for pagination",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 0,
 "minimum": 0
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/ViewOpensStatistics"
 }
 },
 "pagination": {
 "$ref": "#/components/schemas/CursorPagination"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Unauthorized",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/analytics/domains/top": {
 "get": {
 "tags": [
 "analytics"
 ],
 "summary": "Gets top domains statistics.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns statistics for the top domains with more than 5 subscribers.",
 "operationId": "089df16cf97551967e12b2f3207f2cb3",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Maximum number of domains to return",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 20,
 "minimum": 1
 }
 },
 {
 "name": "min_subscribers",
 "in": "query",
 "description": "Minimum number of subscribers per domain",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 5,
 "minimum": 1
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/TopDomainStats"
 }
 }
 }
 },
 "403": {
 "description": "Unauthorized",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/analytics/domains/confirmation": {
 "get": {
 "tags": [
 "analytics"
 ],
 "summary": "Gets domain confirmation statistics.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns statistics for domains showing confirmation status.",
 "operationId": "8843c53978f1c83a02802678a5af54cd",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Maximum number of domains to return",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 50,
 "maximum": 100,
 "minimum": 1
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/DetailedDomainStats"
 }
 }
 }
 },
 "403": {
 "description": "Unauthorized",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/analytics/local-parts/top": {
 "get": {
 "tags": [
 "analytics"
 ],
 "summary": "Gets top local-parts statistics.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns statistics for the top local-parts of email addresses.",
 "operationId": "d9a575680a590b572c4607909b3cbfb0",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Maximum number of local-parts to return",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 25,
 "maximum": 100,
 "minimum": 1
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/LocalPartsStats"
 }
 }
 }
 },
 "403": {
 "description": "Unauthorized",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/analytics/dashboard/summary": {
 "get": {
 "tags": [
 "analytics"
 ],
 "summary": "Gets dashboard summary statistics.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns dashboard summary statistics.",
 "operationId": "3ecb8b72d02b77df67ccbcb3070c82ec",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "total_subscribers": {
 "properties": {
 "value": {
 "type": "integer",
 "example": 48294
 },
 "change_vs_last_month": {
 "type": "number",
 "format": "float",
 "example": 12.5
 }
 },
 "type": "object"
 },
 "active_campaigns": {
 "properties": {
 "value": {
 "type": "integer",
 "example": 12
 },
 "change_vs_last_month": {
 "type": "number",
 "format": "float",
 "example": 0
 }
 },
 "type": "object"
 },
 "open_rate": {
 "properties": {
 "value": {
 "type": "number",
 "format": "float",
 "example": 12
 },
 "change_vs_last_month": {
 "type": "number",
 "format": "float",
 "example": 0
 }
 },
 "type": "object"
 },
 "bounce_rate": {
 "properties": {
 "value": {
 "type": "number",
 "format": "float",
 "example": 12
 },
 "change_vs_last_month": {
 "type": "number",
 "format": "float",
 "example": 0
 }
 },
 "type": "object"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "401": {
 "description": "Not authenticated",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/analytics/dashboard/recent-campaigns": {
 "get": {
 "tags": [
 "analytics"
 ],
 "summary": "Gets dashboard recent campaigns statistics.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns the most recent campaigns with their performance metrics.",
 "operationId": "c5c93fc6bac24a4f506a5d0ded25bb55",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "type": "array",
 "items": {
 "properties": {
 "name": {
 "type": "string",
 "example": "March Newsletter"
 },
 "status": {
 "type": "string",
 "example": "sent",
 "nullable": true
 },
 "date": {
 "type": "string",
 "format": "date",
 "example": "2026-03-15",
 "nullable": true
 },
 "open_rate": {
 "type": "string",
 "example": "42.50%"
 },
 "click_rate": {
 "type": "string",
 "example": "8.10%"
 }
 },
 "type": "object"
 }
 }
 }
 }
 },
 "401": {
 "description": "Not authenticated",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/analytics/dashboard/performance": {
 "get": {
 "tags": [
 "analytics"
 ],
 "summary": "Gets dashboard campaign performance statistics.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns campaign performance metrics over time.",
 "operationId": "5a81041f89c91c9e6630c14289696769",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "type": "array",
 "items": {
 "properties": {
 "date": {
 "type": "string",
 "format": "date",
 "example": "2026-03-19"
 },
 "opens": {
 "type": "integer",
 "example": 234
 },
 "clicks": {
 "type": "integer",
 "example": 57
 }
 },
 "type": "object"
 }
 }
 }
 }
 },
 "401": {
 "description": "Not authenticated",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/t/open.gif": {
 "get": {
 "tags": [
 "tracking"
 ],
 "summary": "Track user message open",
 "description": "1x1 tracking pixel endpoint that records a message view. Requires `u` (subscriber UID) and `m` (message ID) as query parameters.",
 "operationId": "bc130b3f141501cd88e212b74a9b58c5",
 "parameters": [
 {
 "name": "u",
 "in": "query",
 "description": "Subscriber unique identifier (UID)",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "m",
 "in": "query",
 "description": "Message ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Transparent 1x1 GIF"
 }
 }
 }
 },
 "/api/v2/blacklist/check/{email}": {
 "get": {
 "tags": [
 "blacklist"
 ],
 "summary": "Check if email is blacklisted",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "8f5aba09fc00fd3dc8cc76e65a7daf95",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "email",
 "in": "path",
 "description": "Email address to check",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "blacklisted": {
 "type": "boolean"
 },
 "reason": {
 "type": "string",
 "nullable": true
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/blacklist/add": {
 "post": {
 "tags": [
 "blacklist"
 ],
 "summary": "Adds an email address to the blacklist.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "7f78f4b5d64027dc48350d0fcaa638bb",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Email to blacklist",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "email": {
 "type": "string"
 },
 "reason": {
 "type": "string",
 "nullable": true
 }
 },
 "type": "object"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "success": {
 "type": "boolean"
 },
 "message": {
 "type": "string"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/blacklist/remove/{email}": {
 "delete": {
 "tags": [
 "blacklist"
 ],
 "summary": "Removes an email address from the blacklist.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "38e6653f87e655e0f8f2a64eb9506f73",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "email",
 "in": "path",
 "description": "Email address to remove from blacklist",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "success": {
 "type": "boolean"
 },
 "message": {
 "type": "string"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/blacklist/info/{email}": {
 "get": {
 "tags": [
 "blacklist"
 ],
 "summary": "Gets detailed information about a blacklisted email.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "ad7bb11ee621df03163c16daf9b7d24d",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "email",
 "in": "path",
 "description": "Email address to get information for",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "email": {
 "type": "string"
 },
 "added": {
 "type": "string",
 "format": "date-time",
 "nullable": true
 },
 "reason": {
 "type": "string",
 "nullable": true
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/BadRequestResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/lists/{listId}/subscribers": {
 "get": {
 "tags": [
 "subscriptions"
 ],
 "summary": "Gets a list of all subscribers of a subscriber list.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all subscribers for a subscriber list.",
 "operationId": "a02c94c74a195fd2ad0443d9c32547d8",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "listId",
 "in": "path",
 "description": "List ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "after_id",
 "in": "query",
 "description": "Last id (starting from 0)",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 1,
 "minimum": 1
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Number of results per page",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 25,
 "maximum": 100,
 "minimum": 1
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/Subscriber"
 }
 },
 "pagination": {
 "$ref": "#/components/schemas/CursorPagination"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 },
 "post": {
 "tags": [
 "subscriptions"
 ],
 "summary": "Create subscription",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Subscribe subscriber to a list.",
 "operationId": "2339631c4103a324c9938c05d00c7e31",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "listId",
 "in": "path",
 "description": "List ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Pass session credentials",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/SubscriptionRequest"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/Subscription"
 }
 }
 }
 }
 },
 "400": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/BadRequestResponse"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 },
 "409": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/AlreadyExistsResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 },
 "delete": {
 "tags": [
 "subscriptions"
 ],
 "summary": "Delete subscription",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete subscription.",
 "operationId": "3077470b8b4830d18ff3c14f51a5b06d",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "listId",
 "in": "path",
 "description": "List ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "emails",
 "in": "query",
 "description": "emails of subscribers to delete from list.",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "204": {
 "description": "Success"
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/lists/{listId}/count": {
 "get": {
 "tags": [
 "subscriptions"
 ],
 "summary": "Gets the total number of subscribers of a list",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a count of all subscribers in a given list.",
 "operationId": "8be6d0b47d8fd6570b56c7cb3861e2ec",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "listId",
 "in": "path",
 "description": "List ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "subscribers_count": {
 "type": "integer",
 "example": 42
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/subscribe-pages": {
 "get": {
 "tags": [
 "subscribe-pages"
 ],
 "summary": "Get subscribe pages list",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "1a89921fa5f82ce43daf2ca40dc3f954",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "after_id",
 "in": "query",
 "description": "Last id (starting from 0)",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 1,
 "minimum": 1
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Number of results per page",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 25,
 "maximum": 100,
 "minimum": 1
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/SubscribePage"
 }
 },
 "pagination": {
 "$ref": "#/components/schemas/CursorPagination"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Not Found",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 },
 "post": {
 "tags": [
 "subscribe-pages"
 ],
 "summary": "Create subscribe page",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "314286c5d8ef80c845f5dfd2d671bad3",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "title": {
 "type": "string"
 },
 "active": {
 "type": "boolean",
 "nullable": true
 },
 "data": {
 "type": "array",
 "items": {
 "properties": {
 "key": {
 "type": "string"
 },
 "value": {
 "type": "string"
 }
 },
 "type": "object"
 },
 "nullable": true
 }
 },
 "type": "object"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Created",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/SubscribePage"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "422": {
 "description": "Validation failed",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/subscribe-pages/{id}": {
 "get": {
 "tags": [
 "subscribe-pages"
 ],
 "summary": "Get subscribe page",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "390db83b1de32e07d2d52b310eb0c1ea",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "id",
 "in": "path",
 "description": "Subscribe page ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/SubscribePage"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Not Found",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 },
 "put": {
 "tags": [
 "subscribe-pages"
 ],
 "summary": "Update subscribe page",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "a82a0cbe52063758b55279ce7b96657b",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "id",
 "in": "path",
 "description": "Subscribe page ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "requestBody": {
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "title": {
 "type": "string",
 "nullable": true
 },
 "active": {
 "type": "boolean",
 "nullable": true
 },
 "data": {
 "type": "array",
 "items": {
 "properties": {
 "key": {
 "type": "string"
 },
 "value": {
 "type": "string"
 }
 },
 "type": "object"
 },
 "nullable": true
 }
 },
 "type": "object"
 }
 }
 }
 },
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/SubscribePage"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Not Found",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 },
 "delete": {
 "tags": [
 "subscribe-pages"
 ],
 "summary": "Delete subscribe page",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "2881b5de1d076caa070f2b9a1c8487fe",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "id",
 "in": "path",
 "description": "Subscribe page ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "responses": {
 "204": {
 "description": "No Content"
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Not Found",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/public/subscribe-pages/{pageId}": {
 "get": {
 "tags": [
 "subscribe-pages"
 ],
 "summary": "Get public subscribe page (placeholders replaced with actual values)",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "0ce8d9a7201bd20911aede0e4b62f479",
 "parameters": [
 {
 "name": "pageId",
 "in": "path",
 "description": "Subscribe page ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/SubscribePagePublic"
 }
 }
 }
 },
 "404": {
 "description": "Not Found",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 },
 "post": {
 "tags": [
 "subscribe-pages"
 ],
 "summary": "Create subscription",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.Subscribe subscriber to a list from subscribe page.",
 "operationId": "106ea367d6b2e0925240532f5cf1087c",
 "parameters": [
 {
 "name": "pageId",
 "in": "path",
 "description": "Subscribe page ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "requestBody": {
 "description": "",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/PublicSubscriptionRequest"
 }
 }
 }
 },
 "responses": {
 "204": {
 "description": "Success"
 },
 "400": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/BadRequestResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 },
 "delete": {
 "tags": [
 "subscribe-pages"
 ],
 "summary": "Delete subscription",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.Unsubscribe subscriber from lists of subscribe page.",
 "operationId": "48751c56d39746c6b8dc3f782a9b22e5",
 "parameters": [
 {
 "name": "pageId",
 "in": "path",
 "description": "Subscribe page ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "requestBody": {
 "description": "",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/PublicUnsubscriptionRequest"
 }
 }
 }
 },
 "responses": {
 "204": {
 "description": "Success"
 },
 "400": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/BadRequestResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/attributes": {
 "get": {
 "tags": [
 "subscriber-attributes"
 ],
 "summary": "Gets a list of all subscriber attribute definitions.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all subscriber attribute definitions.",
 "operationId": "32f8f5612d7efb526f1aa56f194d3102",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "after_id",
 "in": "query",
 "description": "Last id (starting from 0)",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 1,
 "minimum": 1
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Number of results per page",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 25,
 "maximum": 100,
 "minimum": 1
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/AttributeDefinition"
 }
 },
 "pagination": {
 "$ref": "#/components/schemas/CursorPagination"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 },
 "post": {
 "tags": [
 "subscriber-attributes"
 ],
 "summary": "Create a subscriber attribute definition.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created subscriber attribute definition.",
 "operationId": "8cf0c6bd315d14348f6fcc7733bdee5e",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Pass parameters to create subscriber attribute.",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/SubscriberAttributeDefinitionRequest"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/AttributeDefinition"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "409": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/AlreadyExistsResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/attributes/{definitionId}": {
 "get": {
 "tags": [
 "subscriber-attributes"
 ],
 "summary": "Gets attribute with specified ID.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a single attribute with specified ID.",
 "operationId": "395c35f21b4e9b58cf674f2d7388fc5d",
 "parameters": [
 {
 "name": "definitionId",
 "in": "path",
 "description": "Definition ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/AttributeDefinition"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "message": {
 "type": "string",
 "example": "There is no attribute with that ID."
 }
 },
 "type": "object"
 }
 }
 }
 }
 }
 },
 "put": {
 "tags": [
 "subscriber-attributes"
 ],
 "summary": "Update a subscriber attribute definition.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns updated subscriber attribute definition.",
 "operationId": "6c4a7b00c41b0f4f93d434ef503bb095",
 "parameters": [
 {
 "name": "definitionId",
 "in": "path",
 "description": "Definition ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Pass parameters to update subscriber attribute.",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/SubscriberAttributeDefinitionRequest"
 }
 }
 }
 },
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/AttributeDefinition"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 },
 "delete": {
 "tags": [
 "subscriber-attributes"
 ],
 "summary": "Deletes an attribute definition.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes a single subscriber attribute definition.",
 "operationId": "762041f6be129fd4436092cf05e4ade3",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "definitionId",
 "in": "path",
 "description": "Definition ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success"
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/subscribers/{subscriberId}/attributes/{definitionId}": {
 "get": {
 "tags": [
 "subscriber-attributes"
 ],
 "summary": "Gets subscriber attribute.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a single attribute.",
 "operationId": "67a8bd1d1ba2fcbe8f7f6e40dff6e310",
 "parameters": [
 {
 "name": "definitionId",
 "in": "path",
 "description": "attribute definition id",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "subscriberId",
 "in": "path",
 "description": "Subscriber id",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/SubscriberAttributeValue"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "message": {
 "type": "string",
 "example": "There is no attribute with that ID."
 }
 },
 "type": "object"
 }
 }
 }
 }
 }
 },
 "post": {
 "tags": [
 "subscriber-attributes"
 ],
 "summary": "Create/update a subscriber attribute value.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created/updated subscriber attribute.",
 "operationId": "556382bb314fde54677216acec2dc57f",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "definitionId",
 "in": "path",
 "description": "attribute definition id",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "subscriberId",
 "in": "path",
 "description": "Subscriber id",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "requestBody": {
 "description": "Pass parameters to create subscriber attribute.",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "value": {
 "type": "string",
 "example": "United States"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/SubscriberAttributeValue"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 },
 "delete": {
 "tags": [
 "subscriber-attributes"
 ],
 "summary": "Deletes an attribute.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes a single subscriber attribute.",
 "operationId": "14e2f0f832da2c5561c43bcbaa133846",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "definitionId",
 "in": "path",
 "description": "attribute definition id",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "subscriberId",
 "in": "path",
 "description": "Subscriber id",
 "required": true,
 "schema": {
 "type": "integer"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success"
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/subscribers/{subscriberId}/attributes": {
 "get": {
 "tags": [
 "subscriber-attributes"
 ],
 "summary": "Gets a list of all subscriber attributes.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all subscriber attributes.",
 "operationId": "60f45d54bafdebc6701d65a3152b2ca9",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "subscriberId",
 "in": "path",
 "description": "Subscriber id",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "after_id",
 "in": "query",
 "description": "Last id (starting from 0)",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 1,
 "minimum": 1
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Number of results per page",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 25,
 "maximum": 100,
 "minimum": 1
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/SubscriberAttributeValue"
 }
 },
 "pagination": {
 "$ref": "#/components/schemas/CursorPagination"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/subscribers": {
 "get": {
 "tags": [
 "subscribers"
 ],
 "summary": "Gets a list of all subscribers.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all subscribers.",
 "operationId": "6e0a4ae724df948b624a52b8349fa9df",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "after_id",
 "in": "query",
 "description": "Last id (starting from 0)",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 1,
 "minimum": 1
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Number of results per page",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 25,
 "maximum": 100,
 "minimum": 1
 }
 },
 {
 "name": "is_confirmed",
 "in": "query",
 "description": "Filter by confirmed status",
 "required": false,
 "schema": {
 "type": "string",
 "enum": [
 "true",
 "false",
 "0",
 "1"
 ],
 "example": "1"
 }
 },
 {
 "name": "is_blacklisted",
 "in": "query",
 "description": "Filter by blacklisted status",
 "required": false,
 "schema": {
 "type": "string",
 "enum": [
 "true",
 "false",
 "0",
 "1"
 ],
 "example": "1"
 }
 },
 {
 "name": "find_column",
 "in": "query",
 "description": "Column to search in (requires find_value)",
 "required": false,
 "schema": {
 "type": "string",
 "enum": [
 "email",
 "foreignKey",
 "uniqueId"
 ],
 "example": "email"
 }
 },
 {
 "name": "find_value",
 "in": "query",
 "description": "Value to search for (requires find_column)",
 "required": false,
 "schema": {
 "type": "string",
 "example": "email@example.com"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/Subscriber"
 }
 },
 "pagination": {
 "$ref": "#/components/schemas/CursorPagination"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 },
 "post": {
 "tags": [
 "subscribers"
 ],
 "summary": "Create a subscriber",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Creates a new subscriber (if there is no subscriber with the given email address yet).",
 "operationId": "d3087676ec410e79550544985ec75409",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Pass session credentials",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/CreateSubscriberRequest"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Subscriber"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "409": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/AlreadyExistsResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/subscribers/{subscriberId}": {
 "get": {
 "tags": [
 "subscribers"
 ],
 "summary": "Get a subscriber",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Get subscriber data by id.",
 "operationId": "130382f8a765154049824c4bb4b7136f",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "subscriberId",
 "in": "path",
 "description": "Subscriber ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Subscriber"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 },
 "put": {
 "tags": [
 "subscribers"
 ],
 "summary": "Update subscriber",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Update subscriber data by id.",
 "operationId": "c7fd02049f53535110b7329281aefa6e",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "subscriberId",
 "in": "path",
 "description": "Subscriber ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Pass session credentials",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UpdateSubscriberRequest"
 }
 }
 }
 },
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Subscriber"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 },
 "delete": {
 "tags": [
 "subscribers"
 ],
 "summary": "Delete subscriber",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete subscriber by id.",
 "operationId": "719f3e26178ac8c7d65bcf2ff9d1d35f",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "subscriberId",
 "in": "path",
 "description": "Subscriber ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "204": {
 "description": "Success"
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/subscribers/{subscriberId}/history": {
 "get": {
 "tags": [
 "subscribers"
 ],
 "summary": "Get subscriber event history",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. ",
 "operationId": "15830d2425a969a7482eefb114234d47",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "subscriberId",
 "in": "path",
 "description": "Subscriber ID",
 "required": true,
 "schema": {
 "type": "integer"
 }
 },
 {
 "name": "after_id",
 "in": "query",
 "description": "Page number (pagination)",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 1
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Max items per page",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 25
 }
 },
 {
 "name": "ip",
 "in": "query",
 "description": "Filter by IP address",
 "required": false,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "date_from",
 "in": "query",
 "description": "Filter by date (format: Y-m-d)",
 "required": false,
 "schema": {
 "type": "string",
 "format": "date"
 }
 },
 {
 "name": "summery",
 "in": "query",
 "description": "Filter by summary text",
 "required": false,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Paginated list of subscriber events",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/SubscriberHistory"
 }
 },
 "pagination": {
 "$ref": "#/components/schemas/CursorPagination"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Unauthorized",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Not Found",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/subscribers/{subscriberId}/reset-bounce-count": {
 "post": {
 "tags": [
 "subscribers"
 ],
 "summary": "Reset bounce count for a subscriber.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "14393ca0927d35d1ede3b8eebd9e0421",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "subscriberId",
 "in": "path",
 "description": "Subscriber ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/Subscriber"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/subscribers/confirm": {
 "get": {
 "tags": [
 "subscribers"
 ],
 "summary": "Confirm a subscriber by uniqueId.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
 "operationId": "1e4d7709f3d02f54a4fe6a183b253140",
 "parameters": [
 {
 "name": "uniqueId",
 "in": "query",
 "description": "Unique identifier for the subscriber confirmation",
 "required": true,
 "schema": {
 "type": "string",
 "example": "e9d8c9b2e6"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Subscriber confirmed",
 "content": {
 "text/html": {}
 }
 },
 "400": {
 "description": "Missing or invalid uniqueId"
 },
 "404": {
 "description": "Subscriber not found"
 }
 }
 }
 },
 "/api/v2/subscribers/export": {
 "post": {
 "tags": [
 "subscribers"
 ],
 "summary": "Export subscribers",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Export subscribers to CSV file.",
 "operationId": "d8ec2cc2a42ae9cb888e38d504a1cab6",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Filter parameters for subscribers to export. ",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ExportSubscriberRequest"
 }
 }
 }
 },
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "text/csv": {
 "schema": {
 "type": "string",
 "format": "binary"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/subscribers/import": {
 "post": {
 "tags": [
 "subscribers"
 ],
 "summary": "Import subscribers",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Import subscribers from CSV file.",
 "operationId": "7cd5d687b3cbe0fd9825996e1d105bcc",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "required": true,
 "content": {
 "multipart/form-data": {
 "schema": {
 "properties": {
 "file": {
 "description": "CSV file with subscribers data",
 "type": "string",
 "format": "binary"
 },
 "list_id": {
 "description": "List id to add imported subscribers to",
 "type": "string",
 "default": null,
 "pattern": "^\\d+$"
 },
 "update_existing": {
 "description": "Weather to update existing subscribers or not",
 "type": "string",
 "default": "0",
 "enum": [
 "0",
 "1"
 ]
 },
 "skip_invalid_emails": {
 "description": "Weather to skip invalid email or add with invalid_ prefix"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "imported": {
 "type": "integer"
 },
 "skipped": {
 "type": "integer"
 },
 "errors": {
 "type": "array",
 "items": {
 "type": "string"
 }
 }
 },
 "type": "object"
 }
 }
 }
 },
 "400": {
 "description": "Bad Request",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/BadRequestResponse"
 }
 }
 }
 },
 "403": {
 "description": "Unauthorized",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/lists": {
 "get": {
 "tags": [
 "lists"
 ],
 "summary": "Gets a list of all subscriber lists.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all subscriber lists.",
 "operationId": "ed0ed404ef48002705009cd8777e6b71",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "after_id",
 "in": "query",
 "description": "Last id (starting from 0)",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 1,
 "minimum": 1
 }
 },
 {
 "name": "limit",
 "in": "query",
 "description": "Number of results per page",
 "required": false,
 "schema": {
 "type": "integer",
 "default": 25,
 "maximum": 100,
 "minimum": 1
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "items": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/SubscriberList"
 }
 },
 "pagination": {
 "$ref": "#/components/schemas/CursorPagination"
 }
 },
 "type": "object"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 },
 "post": {
 "tags": [
 "lists"
 ],
 "summary": "Create a subscriber list.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created list.",
 "operationId": "24609c8dc07b9c58de81b290481884de",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Pass parameters to create a new subscriber list.",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/CreateSubscriberListRequest"
 }
 }
 }
 },
 "responses": {
 "201": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/SubscriberList"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 }
 },
 "/api/v2/lists/{listId}": {
 "get": {
 "tags": [
 "lists"
 ],
 "summary": "Gets a subscriber list.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a single subscriber list with specified ID.",
 "operationId": "6e5f5ac3587ae710a87000c0537b0da4",
 "parameters": [
 {
 "name": "listId",
 "in": "path",
 "description": "List ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/SubscriberList"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "properties": {
 "message": {
 "type": "string",
 "example": "There is no list with that ID."
 }
 },
 "type": "object"
 }
 }
 }
 },
 "405": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 },
 "post": {
 "tags": [
 "lists"
 ],
 "summary": "Update a subscriber list.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns updated list.",
 "operationId": "0f8340a7d0a9f2c1f1bdffc728942d99",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "listId",
 "in": "path",
 "description": "List ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "requestBody": {
 "description": "Pass parameters to create a new subscriber list.",
 "required": true,
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/CreateSubscriberListRequest"
 }
 }
 }
 },
 "responses": {
 "200": {
 "description": "Success",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/SubscriberList"
 }
 }
 }
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "405": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "422": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/ValidationErrorResponse"
 }
 }
 }
 }
 }
 },
 "delete": {
 "tags": [
 "lists"
 ],
 "summary": "Deletes a list.",
 "description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes a single subscriber list.",
 "operationId": "0d1c8c4721c26084c53b90e365a57a27",
 "parameters": [
 {
 "name": "php-auth-pw",
 "in": "header",
 "description": "Session key obtained from login",
 "required": true,
 "schema": {
 "type": "string"
 }
 },
 {
 "name": "listId",
 "in": "path",
 "description": "List ID",
 "required": true,
 "schema": {
 "type": "string"
 }
 }
 ],
 "responses": {
 "200": {
 "description": "Success"
 },
 "403": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 },
 "404": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/NotFoundErrorResponse"
 }
 }
 }
 },
 "405": {
 "description": "Failure",
 "content": {
 "application/json": {
 "schema": {
 "$ref": "#/components/schemas/UnauthorizedResponse"
 }
 }
 }
 }
 }
 }
 }
 },
 "components": {
 "schemas": {
 "ErrorDetails": {
 "type": "object",
 "example": {
 "format.formatOptions[0]": [
 "The value you selected is not a valid choice."
 ],
 "schedule.repeatUntil": [
 "This value is not a valid datetime."
 ],
 "schedule.requeueUntil": [
 "This value is not a valid datetime."
 ]
 },
 "additionalProperties": {
 "type": "array",
 "items": {
 "type": "string"
 }
 }
 },
 "UnauthorizedResponse": {
 "required": [
 "message"
 ],
 "properties": {
 "message": {
 "type": "string",
 "example": "No valid session key was provided as basic auth password."
 }
 },
 "type": "object"
 },
 "ValidationErrorResponse": {
 "required": [
 "message",
 "errors"
 ],
 "properties": {
 "message": {
 "type": "string",
 "example": "Validation failed"
 },
 "errors": {
 "$ref": "#/components/schemas/ErrorDetails"
 }
 },
 "type": "object"
 },
 "BadRequestResponse": {
 "required": [
 "message"
 ],
 "properties": {
 "message": {
 "type": "string",
 "example": "Invalid json format"
 }
 },
 "type": "object"
 },
 "AlreadyExistsResponse": {
 "required": [
 "message"
 ],
 "properties": {
 "message": {
 "type": "string",
 "example": "This resource already exists."
 }
 },
 "type": "object"
 },
 "NotFoundErrorResponse": {
 "required": [
 "message"
 ],
 "properties": {
 "message": {
 "type": "string",
 "example": "There is no entity with that ID."
 }
 },
 "type": "object"
 },
 "GenericErrorResponse": {
 "required": [
 "message"
 ],
 "properties": {
 "message": {
 "type": "string",
 "example": "An unexpected error occurred."
 }
 },
 "type": "object"
 },
 "CursorPagination": {
 "properties": {
 "total": {
 "type": "integer",
 "example": 100
 },
 "limit": {
 "type": "integer",
 "example": 25
 },
 "has_more": {
 "type": "boolean",
 "example": true
 },
 "next_cursor": {
 "type": "integer",
 "example": 129
 }
 },
 "type": "object"
 },
 "ConfigRequest": {
 "required": [
 "key",
 "value"
 ],
 "properties": {
 "key": {
 "type": "string",
 "maxLength": 35,
 "example": "organisation_name"
 },
 "value": {
 "type": "string",
 "example": "Example Organisation"
 },
 "editable": {
 "type": "boolean",
 "example": true
 },
 "type": {
 "type": "string",
 "maxLength": 25,
 "example": "text",
 "nullable": true
 }
 },
 "type": "object"
 },
 "ConfigUpdateRequest": {
 "required": [
 "value"
 ],
 "properties": {
 "value": {
 "type": "string",
 "example": "Example Organisation"
 }
 },
 "type": "object"
 },
 "Config": {
 "properties": {
 "key": {
 "type": "string",
 "example": "organisation_name"
 },
 "value": {
 "type": "string",
 "example": "Example Organisation",
 "nullable": true
 },
 "editable": {
 "type": "boolean",
 "example": true
 },
 "type": {
 "type": "string",
 "example": "text",
 "nullable": true
 }
 },
 "type": "object"
 },
 "AdminAttributeDefinitionRequest": {
 "required": [
 "name"
 ],
 "properties": {
 "name": {
 "type": "string",
 "format": "string",
 "example": "Country"
 },
 "type": {
 "type": "string",
 "enum": [
 "textline",
 "hidden"
 ],
 "example": "hidden",
 "nullable": true
 },
 "order": {
 "type": "number",
 "example": 12
 },
 "default_value": {
 "type": "string",
 "example": "United States"
 },
 "required": {
 "type": "boolean",
 "example": true
 }
 },
 "type": "object"
 },
 "CreateAdministratorRequest": {
 "required": [
 "login_name",
 "password",
 "email",
 "super_user"
 ],
 "properties": {
 "login_name": {
 "type": "string",
 "maxLength": 255,
 "minLength": 3,
 "example": "admin"
 },
 "password": {
 "type": "string",
 "format": "password",
 "maxLength": 255,
 "minLength": 6,
 "example": "StrongP@ssw0rd"
 },
 "email": {
 "type": "string",
 "format": "email",
 "example": "admin@example.com"
 },
 "super_user": {
 "type": "boolean",
 "example": false
 },
 "privileges": {
 "description": "Array of privileges where keys are privilege names and values are booleans",
 "properties": {
 "subscribers": {
 "type": "boolean",
 "example": true
 },
 "campaigns": {
 "type": "boolean",
 "example": false
 },
 "statistics": {
 "type": "boolean",
 "example": true
 },
 "settings": {
 "type": "boolean",
 "example": false
 }
 },
 "type": "object",
 "example": {
 "subscribers": true,
 "campaigns": false,
 "statistics": true,
 "settings": false
 }
 }
 },
 "type": "object"
 },
 "UpdateAdministratorRequest": {
 "properties": {
 "login_name": {
 "type": "string",
 "maxLength": 255,
 "minLength": 3,
 "example": "admin"
 },
 "password": {
 "type": "string",
 "format": "password",
 "maxLength": 255,
 "minLength": 6,
 "example": "StrongP@ssw0rd"
 },
 "email": {
 "type": "string",
 "format": "email",
 "example": "admin@example.com"
 },
 "super_user": {
 "type": "boolean",
 "example": false
 },
 "privileges": {
 "description": "Array of privileges where keys are privilege names and values are booleans",
 "properties": {
 "subscribers": {
 "type": "boolean",
 "example": true
 },
 "campaigns": {
 "type": "boolean",
 "example": false
 },
 "statistics": {
 "type": "boolean",
 "example": true
 },
 "settings": {
 "type": "boolean",
 "example": false
 }
 },
 "type": "object",
 "example": {
 "subscribers": true,
 "campaigns": false,
 "statistics": true,
 "settings": false
 }
 }
 },
 "type": "object"
 },
 "AdminAttributeDefinition": {
 "properties": {
 "id": {
 "type": "integer",
 "example": 1
 },
 "name": {
 "type": "string",
 "example": "Country"
 },
 "type": {
 "type": "string",
 "example": "hidden"
 },
 "list_order": {
 "type": "integer",
 "example": 12
 },
 "default_value": {
 "type": "string",
 "example": "United States"
 },
 "required": {
 "type": "boolean",
 "example": true
 }
 },
 "type": "object"
 },
 "AdminAttributeValue": {
 "properties": {
 "administrator": {
 "$ref": "#/components/schemas/Administrator"
 },
 "definition": {
 "$ref": "#/components/schemas/AdminAttributeDefinition"
 },
 "value": {
 "type": "string",
 "example": "United States"
 }
 },
 "type": "object"
 },
 "Administrator": {
 "properties": {
 "id": {
 "type": "integer",
 "example": 1
 },
 "login_name": {
 "type": "string",
 "example": "admin"
 },
 "email": {
 "type": "string",
 "format": "email",
 "example": "admin@example.com"
 },
 "super_user": {
 "type": "boolean",
 "example": true
 },
 "privileges": {
 "type": "array",
 "items": {
 "type": "string"
 }
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "example": "2025-04-29T12:34:56+00:00"
 }
 },
 "type": "object"
 },
 "BounceRegexRequest": {
 "required": [
 "regex",
 "action",
 "status"
 ],
 "properties": {
 "regex": {
 "type": "string",
 "example": "/mailbox is full/i"
 },
 "action": {
 "type": "string",
 "example": "delete",
 "nullable": false
 },
 "list_order": {
 "type": "integer",
 "example": 0,
 "nullable": true
 },
 "comment": {
 "type": "string",
 "example": "Auto-generated",
 "nullable": true
 },
 "status": {
 "type": "string",
 "example": "active",
 "nullable": false
 }
 },
 "type": "object"
 },
 "CreateTemplateRequest": {
 "required": [
 "title"
 ],
 "properties": {
 "title": {
 "type": "string",
 "example": "Newsletter Template"
 },
 "content": {
 "type": "string",
 "example": "<html><body>[CONTENT]</body></html>",
 "nullable": true
 },
 "text": {
 "type": "string",
 "example": "[CONTENT]"
 },
 "list_order": {
 "type": "integer",
 "example": 10,
 "nullable": true
 },
 "file": {
 "description": "Optional file upload for HTML content",
 "type": "string",
 "format": "binary"
 },
 "check_links": {
 "description": "Check that all links have full URLs",
 "type": "boolean",
 "example": true
 },
 "check_images": {
 "description": "Check that all images have full URLs",
 "type": "boolean",
 "example": false
 },
 "check_external_images": {
 "description": "Check that all external images exist",
 "type": "boolean",
 "example": true
 }
 },
 "type": "object"
 },
 "ForwardMessageRequest": {
 "required": [
 "recipients"
 ],
 "properties": {
 "recipients": {
 "type": "array",
 "items": {
 "type": "string",
 "format": "email"
 },
 "example": [
 "friend1@example.com",
 "friend2@example.com"
 ]
 },
 "uid": {
 "type": "string",
 "example": "fwd-123e4567-e89b-12d3-a456-426614174000",
 "nullable": false
 },
 "note": {
 "type": "string",
 "example": "Thought you might like this.",
 "nullable": true
 },
 "from_name": {
 "type": "string",
 "example": "Alice",
 "nullable": false
 },
 "from_email": {
 "type": "string",
 "format": "email",
 "example": "alice@example.com",
 "nullable": false
 }
 },
 "type": "object"
 },
 "MessageContentRequest": {
 "required": [
 "subject",
 "text",
 "footer"
 ],
 "properties": {
 "subject": {
 "type": "string",
 "example": "Campaign Subject"
 },
 "text": {
 "type": "string",
 "example": "Full text content"
 },
 "footer": {
 "type": "string",
 "example": "Unsubscribe link here"
 }
 },
 "type": "object"
 },
 "MessageFormatRequest": {
 "required": [
 "send_format"
 ],
 "properties": {
 "send_format": {
 "type": "string",
 "enum": [
 "html",
 "text",
 "invite"
 ],
 "example": "html"
 }
 },
 "type": "object"
 },
 "MessageMetadataRequest": {
 "required": [
 "status"
 ],
 "properties": {
 "status": {
 "type": "string",
 "enum": [
 "draft",
 "sent",
 "prepared",
 "submitted",
 "suspended"
 ],
 "example": "draft"
 }
 },
 "type": "object"
 },
 "MessageOptionsRequest": {
 "required": [
 "from_field"
 ],
 "properties": {
 "from_field": {
 "type": "string",
 "example": "info@example.com"
 },
 "to_field": {
 "type": "string",
 "example": "subscriber@example.com"
 },
 "reply_to": {
 "type": "string",
 "example": "reply@example.com"
 },
 "user_selection": {
 "type": "string",
 "example": "all-active-users"
 }
 },
 "type": "object"
 },
 "MessageScheduleRequest": {
 "required": [
 "embargo"
 ],
 "properties": {
 "embargo": {
 "type": "string",
 "format": "date-time",
 "example": "2025-04-17 09:00:00"
 },
 "repeat_interval": {
 "type": "integer",
 "example": "24 hours"
 },
 "repeat_until": {
 "type": "string",
 "format": "date-time",
 "example": "2025-04-30T00:00:00+04:00"
 },
 "requeue_interval": {
 "type": "integer",
 "example": "12 hours"
 },
 "requeue_until": {
 "type": "string",
 "format": "date-time",
 "example": "2025-04-20T00:00:00+04:00"
 }
 },
 "type": "object"
 },
 "ResendMessageToListsRequest": {
 "required": [
 "list_ids"
 ],
 "properties": {
 "list_ids": {
 "description": "Target mailing list IDs.",
 "type": "array",
 "items": {
 "type": "integer",
 "minimum": 1
 },
 "example": [
 1,
 2,
 3
 ]
 }
 },
 "type": "object"
 },
 "TestSendMessageToSubscribersRequest": {
 "required": [
 "emails"
 ],
 "properties": {
 "emails": {
 "description": "Target subscribers emails.",
 "type": "array",
 "items": {
 "type": "string",
 "format": "email"
 },
 "example": [
 "user1@example.com",
 "user2@example.com"
 ]
 }
 },
 "type": "object"
 },
 "UpdateTemplateRequest": {
 "required": [
 "title"
 ],
 "properties": {
 "title": {
 "type": "string",
 "example": "Newsletter Template"
 },
 "content": {
 "type": "string",
 "example": "<html><body>[CONTENT]</body></html>",
 "nullable": true
 },
 "text": {
 "type": "string",
 "example": "[CONTENT]"
 },
 "list_order": {
 "type": "integer",
 "example": 10,
 "nullable": true
 },
 "file": {
 "description": "Optional file upload for HTML content",
 "type": "string",
 "format": "binary"
 },
 "check_links": {
 "description": "Check that all links have full URLs",
 "type": "boolean",
 "example": true
 },
 "check_images": {
 "description": "Check that all images have full URLs",
 "type": "boolean",
 "example": false
 },
 "check_external_images": {
 "description": "Check that all external images exist",
 "type": "boolean",
 "example": true
 }
 },
 "type": "object"
 },
 "BounceView": {
 "properties": {
 "id": {
 "type": "integer",
 "example": 10
 },
 "status": {
 "type": "string",
 "example": "not processed",
 "nullable": true
 },
 "date": {
 "type": "string",
 "example": "2023-01-01T12:00:00Z",
 "nullable": true
 },
 "message_id": {
 "type": "integer",
 "example": 123
 },
 "message_subject": {
 "type": "string",
 "example": "Newsletter",
 "nullable": true
 },
 "subscriber_id": {
 "type": "integer",
 "example": 0,
 "nullable": true
 },
 "subscriber_email": {
 "type": "string",
 "example": "user@example.com",
 "nullable": true
 },
 "comment": {
 "type": "string",
 "example": "Auto-generated rule",
 "nullable": true
 }
 },
 "type": "object"
 },
 "BounceRegex": {
 "properties": {
 "id": {
 "type": "integer",
 "example": 10
 },
 "regex": {
 "type": "string",
 "example": "/mailbox is full/i"
 },
 "regex_hash": {
 "type": "string",
 "example": "d41d8cd98f00b204e9800998ecf8427e"
 },
 "action": {
 "type": "string",
 "example": "delete",
 "nullable": true
 },
 "list_order": {
 "type": "integer",
 "example": 0,
 "nullable": true
 },
 "admin_id": {
 "type": "integer",
 "example": 1,
 "nullable": true
 },
 "comment": {
 "type": "string",
 "example": "Auto-generated rule",
 "nullable": true
 },
 "status": {
 "type": "string",
 "example": "active",
 "nullable": true
 },
 "count": {
 "type": "integer",
 "example": 5,
 "nullable": true
 }
 },
 "type": "object"
 },
 "EditorUpload": {
 "properties": {
 "uploaded": {
 "type": "boolean",
 "example": true
 },
 "file_name": {
 "type": "string",
 "example": "test.png"
 },
 "url": {
 "type": "string",
 "example": "https://ex.com/uploads/test.png"
 },
 "default": {
 "type": "string",
 "example": "https://ex.com/uploads/test.png"
 },
 "mime_type": {
 "type": "string",
 "example": "image/png"
 },
 "size": {
 "type": "integer",
 "example": 123456,
 "nullable": true
 },
 "extension": {
 "type": "string",
 "example": "png"
 }
 },
 "type": "object",
 "nullable": true
 },
 "FileListingEntry": {
 "properties": {
 "name": {
 "type": "string",
 "example": "image.png"
 },
 "url": {
 "type": "string",
 "example": "https://ex.com/api/v2/editor-uploads/image.png"
 },
 "size": {
 "type": "integer",
 "example": 12345
 },
 "type": {
 "type": "string",
 "example": "file"
 },
 "modified": {
 "type": "integer",
 "example": 1689255600
 }
 },
 "type": "object",
 "nullable": true
 },
 "ForwardRecipientResult": {
 "properties": {
 "email": {
 "type": "string",
 "format": "email",
 "example": "friend@example.com"
 },
 "status": {
 "type": "string",
 "example": "sent"
 },
 "reason": {
 "type": "string",
 "example": "precache_failed",
 "nullable": true
 }
 },
 "type": "object"
 },
 "ForwardResult": {
 "properties": {
 "total_requested": {
 "type": "integer",
 "example": 3
 },
 "total_sent": {
 "type": "integer",
 "example": 2
 },
 "total_failed": {
 "type": "integer",
 "example": 1
 },
 "total_already_sent": {
 "type": "integer",
 "example": 0
 },
 "recipients": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/ForwardRecipientResult"
 }
 }
 },
 "type": "object"
 },
 "ListMessage": {
 "properties": {
 "id": {
 "type": "integer",
 "example": 1
 },
 "message": {
 "$ref": "#/components/schemas/Message"
 },
 "subscriber_list": {
 "$ref": "#/components/schemas/SubscriberList"
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "example": "2022-12-01T10:00:00Z"
 },
 "updated_at": {
 "type": "string",
 "format": "date-time",
 "example": "2022-12-01T10:00:00Z"
 }
 },
 "type": "object"
 },
 "Message": {
 "properties": {
 "id": {
 "type": "integer"
 },
 "unique_id": {
 "type": "string",
 "example": "2df6b147-8470-45ed-8e4e-86aa01af400d"
 },
 "template": {
 "oneOf": [
 {
 "$ref": "#/components/schemas/Template"
 }
 ],
 "nullable": true
 },
 "message_content": {
 "properties": {
 "subject": {
 "type": "string",
 "example": "Newsletter"
 },
 "text": {
 "type": "string",
 "example": "Hello World!"
 },
 "text_message": {
 "type": "string"
 },
 "footer": {
 "type": "string",
 "example": "This is a footer"
 }
 },
 "type": "object"
 },
 "message_format": {
 "properties": {
 "html_formated": {
 "type": "boolean"
 },
 "send_format": {
 "type": "string",
 "example": "text",
 "nullable": true
 },
 "as_text": {
 "type": "integer",
 "example": 12
 },
 "as_html": {
 "type": "integer",
 "example": 12
 },
 "as_text_and_html": {
 "type": "integer",
 "example": 12
 },
 "as_pdf": {
 "type": "integer",
 "example": 12
 },
 "as_text_and_pdf": {
 "type": "integer",
 "example": 12
 }
 },
 "type": "object"
 },
 "message_metadata": {
 "properties": {
 "status": {
 "type": "string",
 "example": "sent"
 },
 "processed": {
 "type": "integer",
 "example": 12
 },
 "views": {
 "type": "integer",
 "example": 12
 },
 "bounce_count": {
 "type": "integer"
 },
 "entered": {
 "type": "string",
 "format": "date-time",
 "nullable": true
 },
 "sent": {
 "type": "string",
 "format": "date-time",
 "nullable": true
 },
 "send_start": {
 "type": "string",
 "format": "date-time",
 "nullable": true
 }
 },
 "type": "object"
 },
 "message_schedule": {
 "properties": {
 "repeat_interval": {
 "type": "string",
 "nullable": true
 },
 "repeat_until": {
 "type": "string",
 "format": "date-time",
 "nullable": true
 },
 "requeue_interval": {
 "type": "string",
 "nullable": true
 },
 "requeue_until": {
 "type": "string",
 "format": "date-time",
 "nullable": true
 },
 "embargo": {
 "type": "string",
 "example": "2023-01-01T12:00:00Z",
 "nullable": true
 }
 },
 "type": "object"
 },
 "message_options": {
 "properties": {
 "from_field": {
 "type": "string",
 "example": " My Name <my@email.com>",
 "nullable": true
 },
 "to_field": {
 "type": "string",
 "example": "",
 "nullable": true
 },
 "reply_to": {
 "type": "string",
 "nullable": true
 },
 "user_selection": {
 "type": "string",
 "nullable": true
 }
 },
 "type": "object"
 }
 },
 "type": "object"
 },
 "TemplateImage": {
 "properties": {
 "id": {
 "type": "integer",
 "example": 12
 },
 "template_id": {
 "type": "integer",
 "example": 1
 },
 "mimetype": {
 "type": "string",
 "example": "image/png",
 "nullable": true
 },
 "filename": {
 "type": "string",
 "example": "header.png",
 "nullable": true
 },
 "data": {
 "description": "Base64-encoded image data",
 "type": "string",
 "format": "byte",
 "example": "iVBORw0KGgoAAAANSUhEUgAAA...",
 "nullable": true
 },
 "width": {
 "type": "integer",
 "example": 600,
 "nullable": true
 },
 "height": {
 "type": "integer",
 "example": 200,
 "nullable": true
 }
 },
 "type": "object",
 "nullable": true
 },
 "Template": {
 "properties": {
 "id": {
 "type": "integer",
 "example": 1
 },
 "title": {
 "type": "string",
 "example": "Newsletter"
 },
 "content": {
 "type": "string",
 "example": "Hello World!",
 "nullable": true
 },
 "text": {
 "type": "string",
 "nullable": true
 },
 "list_order": {
 "type": "integer",
 "nullable": true
 },
 "images": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/TemplateImage"
 },
 "nullable": true
 }
 },
 "type": "object",
 "nullable": true
 },
 "DetailedDomainStats": {
 "properties": {
 "domains": {
 "type": "array",
 "items": {
 "properties": {
 "domain": {
 "description": "This bundle provides the REST API for phpList.",
 "type": "string"
 },
 "confirmed": {
 "properties": {
 "count": {
 "type": "integer"
 },
 "percentage": {
 "type": "number",
 "format": "float"
 }
 },
 "type": "object"
 },
 "unconfirmed": {
 "properties": {
 "count": {
 "type": "integer"
 },
 "percentage": {
 "type": "number",
 "format": "float"
 }
 },
 "type": "object"
 },
 "blacklisted": {
 "properties": {
 "count": {
 "type": "integer"
 },
 "percentage": {
 "type": "number",
 "format": "float"
 }
 },
 "type": "object"
 },
 "total": {
 "properties": {
 "count": {
 "type": "integer"
 },
 "percentage": {
 "type": "number",
 "format": "float"
 }
 },
 "type": "object"
 }
 },
 "type": "object"
 }
 },
 "total": {
 "type": "integer"
 }
 },
 "type": "object",
 "nullable": true
 },
 "CampaignStatistics": {
 "properties": {
 "campaign_id": {
 "type": "integer"
 },
 "subject": {
 "type": "string"
 },
 "date_sent": {
 "type": "string",
 "format": "date-time"
 },
 "sent": {
 "type": "integer"
 },
 "bounces": {
 "type": "integer"
 },
 "forwards": {
 "type": "integer"
 },
 "unique_views": {
 "type": "integer"
 },
 "total_clicks": {
 "type": "integer"
 },
 "unique_clicks": {
 "type": "integer"
 }
 },
 "type": "object",
 "nullable": true
 },
 "TopDomainStats": {
 "properties": {
 "domains": {
 "type": "array",
 "items": {
 "properties": {
 "domain": {
 "type": "string"
 },
 "subscribers": {
 "type": "integer"
 }
 },
 "type": "object"
 }
 },
 "total": {
 "type": "integer"
 }
 },
 "type": "object",
 "nullable": true
 },
 "LocalPartsStats": {
 "properties": {
 "local_parts": {
 "type": "array",
 "items": {
 "properties": {
 "local_part": {
 "type": "string"
 },
 "count": {
 "type": "integer"
 },
 "percentage": {
 "type": "number",
 "format": "float"
 }
 },
 "type": "object"
 }
 },
 "total": {
 "type": "integer"
 }
 },
 "type": "object",
 "nullable": true
 },
 "ViewOpensStatistics": {
 "properties": {
 "campaign_id": {
 "type": "integer"
 },
 "subject": {
 "type": "string"
 },
 "sent": {
 "type": "integer"
 },
 "unique_views": {
 "type": "integer"
 },
 "rate": {
 "type": "number",
 "format": "float"
 }
 },
 "type": "object",
 "nullable": true
 },
 "CreateSubscriberListRequest": {
 "required": [
 "name"
 ],
 "properties": {
 "name": {
 "type": "string",
 "format": "string",
 "example": "News"
 },
 "description": {
 "type": "string",
 "example": "News (and some fun stuff)"
 },
 "list_position": {
 "type": "number",
 "example": 12
 },
 "public": {
 "type": "boolean",
 "example": true
 },
 "category": {
 "type": "string",
 "example": "Marketing"
 },
 "subject_prefix": {
 "type": "string",
 "example": "[News]"
 },
 "rss_feed": {
 "type": "string",
 "example": "https://example.com/blog/rss"
 }
 },
 "type": "object"
 },
 "CreateSubscriberRequest": {
 "required": [
 "email"
 ],
 "properties": {
 "email": {
 "type": "string",
 "format": "string",
 "example": "admin@example.com"
 },
 "request_confirmation": {
 "type": "boolean",
 "example": false
 },
 "html_email": {
 "type": "boolean",
 "example": false
 }
 },
 "type": "object"
 },
 "PublicSubscriptionRequest": {
 "required": [
 "email",
 "list_id"
 ],
 "properties": {
 "email": {
 "type": "string",
 "format": "email",
 "example": "lia@example.com"
 },
 "confirm_email": {
 "type": "string",
 "format": "email",
 "example": "lia@example.com"
 },
 "list_id": {
 "type": "integer",
 "example": 1
 },
 "attributes": {
 "type": "object",
 "example": {
 "firstname": "John",
 "lastname": "Grigoryan",
 "country": "Armenia"
 },
 "additionalProperties": true
 }
 },
 "type": "object"
 },
 "PublicUnsubscriptionRequest": {
 "required": [
 "email"
 ],
 "properties": {
 "email": {
 "type": "string",
 "format": "email",
 "example": "lia@example.com"
 }
 },
 "type": "object"
 },
 "SubscriberAttributeDefinitionRequest": {
 "required": [
 "name"
 ],
 "properties": {
 "name": {
 "type": "string",
 "example": "Country"
 },
 "type": {
 "type": "string",
 "enum": [
 "textline",
 "hidden",
 "creditcardno",
 "select",
 "date",
 "checkbox",
 "textarea",
 "radio",
 "checkboxgroup"
 ],
 "example": "checkbox",
 "nullable": true
 },
 "order": {
 "type": "integer",
 "example": 12,
 "nullable": true
 },
 "default_value": {
 "type": "string",
 "example": "United States",
 "nullable": true
 },
 "required": {
 "type": "boolean",
 "example": true
 },
 "options": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/DynamicListAttr"
 },
 "nullable": true
 }
 },
 "type": "object"
 },
 "DynamicListAttr": {
 "required": [
 "name"
 ],
 "properties": {
 "id": {
 "type": "integer",
 "example": 1,
 "nullable": true
 },
 "name": {
 "type": "string",
 "example": "United States"
 },
 "list_order": {
 "type": "integer",
 "example": 10,
 "nullable": true
 }
 },
 "type": "object"
 },
 "ExportSubscriberRequest": {
 "properties": {
 "date_type": {
 "description": "What date needs to be used for filtering (any, signup, changed, changelog, subscribed)",
 "default": "any",
 "enum": [
 "any",
 "signup",
 "changed",
 "changelog",
 "subscribed"
 ]
 },
 "list_id": {
 "description": "List ID from where to export",
 "type": "integer"
 },
 "date_from": {
 "description": "Start date for filtering (format: Y-m-d)",
 "type": "string",
 "format": "date"
 },
 "date_to": {
 "description": "End date for filtering (format: Y-m-d)",
 "type": "string",
 "format": "date"
 },
 "is_confirmed": {
 "description": "Whether subscriber is confirmed (true, false, 1, 0)",
 "type": "boolean",
 "enum": [
 "true",
 "false",
 "1",
 "0",
 true,
 false,
 1,
 0
 ]
 },
 "is_blacklisted": {
 "description": "Whether subscriber is blacklisted (true, false, 1, 0)",
 "type": "boolean",
 "enum": [
 "true",
 "false",
 "1",
 "0",
 true,
 false,
 1,
 0
 ]
 },
 "columns": {
 "description": "Columns to include in the export",
 "type": "array",
 "items": {
 "type": "string"
 },
 "default": [
 "id",
 "email",
 "confirmed",
 "blacklisted",
 "bounceCount",
 "createdAt",
 "updatedAt",
 "uniqueId",
 "htmlEmail",
 "rssFrequency",
 "disabled",
 "extraData",
 "foreignKey"
 ]
 }
 },
 "type": "object"
 },
 "SubscriptionRequest": {
 "required": [
 "emails"
 ],
 "properties": {
 "emails": {
 "type": "array",
 "items": {
 "type": "string",
 "format": "email"
 },
 "example": [
 "test1@example.com",
 "test2@example.com"
 ]
 },
 "autoConfirm": {
 "description": "Whether to automatically confirm subscriptions",
 "type": "boolean",
 "example": true
 }
 },
 "type": "object"
 },
 "UpdateSubscriberRequest": {
 "required": [
 "email"
 ],
 "properties": {
 "email": {
 "type": "string",
 "format": "string",
 "example": "admin@example.com"
 },
 "confirmed": {
 "type": "boolean",
 "example": false
 },
 "blacklisted": {
 "type": "boolean",
 "example": false
 },
 "html_email": {
 "type": "boolean",
 "example": false
 },
 "disabled": {
 "type": "boolean",
 "example": false
 }
 },
 "type": "object"
 },
 "AttributeDefinition": {
 "properties": {
 "id": {
 "type": "integer",
 "example": 1
 },
 "name": {
 "type": "string",
 "example": "Country"
 },
 "type": {
 "type": "string",
 "example": "checkbox",
 "nullable": true
 },
 "list_order": {
 "type": "integer",
 "example": 12
 },
 "default_value": {
 "type": "string",
 "example": "United States"
 },
 "required": {
 "type": "boolean",
 "example": true
 },
 "options": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/DynamicListAttrOption"
 },
 "nullable": true
 }
 },
 "type": "object"
 },
 "DynamicListAttrOption": {
 "properties": {
 "id": {
 "type": "integer",
 "example": 1,
 "nullable": false
 },
 "name": {
 "type": "string",
 "example": "United States"
 },
 "list_order": {
 "type": "integer",
 "example": 1,
 "nullable": false
 }
 },
 "type": "object"
 },
 "SubscribePageData": {
 "properties": {
 "key": {
 "type": "string",
 "example": "button"
 },
 "value": {
 "type": "string",
 "example": "Subscribe to the selected newsletters"
 }
 },
 "type": "object"
 },
 "SubscribePage": {
 "properties": {
 "id": {
 "type": "integer",
 "example": 1
 },
 "title": {
 "type": "string",
 "example": "Subscribe to our newsletter"
 },
 "active": {
 "type": "boolean",
 "example": true
 },
 "owner": {
 "$ref": "#/components/schemas/Administrator"
 },
 "data": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/SubscribePageData"
 }
 }
 },
 "type": "object"
 },
 "SubscribePagePublic": {
 "properties": {
 "id": {
 "type": "integer",
 "example": 1
 },
 "title": {
 "type": "string",
 "example": "Subscribe to our newsletter"
 },
 "data": {
 "properties": {
 "attributes": {
 "type": "array",
 "items": {
 "properties": {
 "id": {
 "type": "integer"
 },
 "name": {
 "type": "string"
 },
 "type": {
 "type": "string"
 },
 "required": {
 "type": "boolean"
 },
 "default_value": {
 "type": "string",
 "nullable": true
 },
 "list_order": {
 "type": "integer"
 },
 "options": {
 "type": "array",
 "items": {
 "type": "object"
 }
 }
 },
 "type": "object"
 }
 },
 "lists": {
 "type": "array",
 "items": {
 "properties": {
 "id": {
 "type": "integer"
 },
 "name": {
 "type": "string"
 },
 "description": {
 "type": "string",
 "nullable": true
 },
 "list_position": {
 "type": "integer"
 }
 },
 "type": "object"
 }
 }
 },
 "type": "object",
 "additionalProperties": {
 "oneOf": [
 {
 "type": "string"
 },
 {
 "type": "integer"
 },
 {
 "type": "boolean"
 },
 {
 "type": "array",
 "items": {
 "type": "object"
 }
 },
 {
 "type": "object"
 }
 ]
 }
 }
 },
 "type": "object"
 },
 "SubscriberAttributeValue": {
 "properties": {
 "subscriber": {
 "$ref": "#/components/schemas/Subscriber"
 },
 "definition": {
 "$ref": "#/components/schemas/AttributeDefinition"
 },
 "value": {
 "type": "string",
 "example": "United States"
 }
 },
 "type": "object"
 },
 "SubscriberHistory": {
 "properties": {
 "id": {
 "type": "integer",
 "example": 1
 },
 "ip": {
 "type": "string",
 "example": "127.0.0.1"
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "example": "2022-12-01T10:00:00Z"
 },
 "summary": {
 "type": "string",
 "example": "Added by admin"
 },
 "detail": {
 "type": "string",
 "example": "Added with add-email on test"
 },
 "system_info": {
 "type": "string",
 "example": "HTTP_USER_AGENT = Mozilla/5.0"
 }
 },
 "type": "object"
 },
 "SubscriberList": {
 "properties": {
 "id": {
 "type": "integer",
 "example": 2
 },
 "name": {
 "type": "string",
 "example": "Newsletter"
 },
 "description": {
 "type": "string",
 "example": "Monthly updates"
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "example": "2022-12-01T10:00:00Z"
 },
 "list_position": {
 "type": "integer",
 "example": 1
 },
 "subject_prefix": {
 "type": "string",
 "example": "[News]"
 },
 "public": {
 "type": "boolean",
 "example": true
 },
 "category": {
 "type": "string",
 "example": "Marketing"
 },
 "rss_feed": {
 "type": "string",
 "example": "https://example.com/blog/rss"
 }
 },
 "type": "object"
 },
 "Subscriber": {
 "properties": {
 "id": {
 "type": "integer",
 "example": 1
 },
 "email": {
 "type": "string",
 "example": "subscriber@example.com"
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "example": "2023-01-01T12:00:00Z"
 },
 "updated_at": {
 "type": "string",
 "format": "date-time",
 "example": "2026-01-01T12:00:00Z"
 },
 "confirmed": {
 "type": "boolean",
 "example": true
 },
 "blacklisted": {
 "type": "boolean",
 "example": false
 },
 "bounce_count": {
 "type": "integer",
 "example": 0
 },
 "unique_id": {
 "type": "string",
 "example": "69f4e92cf50eafca9627f35704f030f4"
 },
 "uuid": {
 "type": "string",
 "example": "69f4e92-cf50eaf-ca9627f-35704f-030f4"
 },
 "html_email": {
 "type": "boolean",
 "example": true
 },
 "disabled": {
 "type": "boolean",
 "example": false
 },
 "subscribed_lists": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/SubscriberList"
 }
 },
 "history": {
 "type": "array",
 "items": {
 "$ref": "#/components/schemas/SubscriberHistory"
 }
 }
 },
 "type": "object"
 },
 "SubscriberOnly": {
 "properties": {
 "id": {
 "type": "integer",
 "example": 1
 },
 "email": {
 "type": "string",
 "example": "subscriber@example.com"
 },
 "created_at": {
 "type": "string",
 "format": "date-time",
 "example": "2023-01-01T12:00:00Z"
 },
 "confirmed": {
 "type": "boolean",
 "example": true
 },
 "blacklisted": {
 "type": "boolean",
 "example": false
 },
 "bounce_count": {
 "type": "integer",
 "example": 0
 },
 "unique_id": {
 "type": "string",
 "example": "69f4e92cf50eafca9627f35704f030f4"
 },
 "html_email": {
 "type": "boolean",
 "example": true
 },
 "disabled": {
 "type": "boolean",
 "example": false
 }
 },
 "type": "object"
 },
 "Subscription": {
 "properties": {
 "subscriber": {
 "$ref": "#/components/schemas/SubscriberOnly"
 },
 "subscriber_list": {
 "$ref": "#/components/schemas/SubscriberList"
 },
 "subscription_date": {
 "type": "string",
 "format": "date-time",
 "example": "2023-01-01T12:00:00Z"
 }
 },
 "type": "object"
 }
 }
 },
 "tags": [
 {
 "name": "configs",
 "description": "configs"
 },
 {
 "name": "admin-attributes",
 "description": "admin-attributes"
 },
 {
 "name": "administrators",
 "description": "administrators"
 },
 {
 "name": "password-reset",
 "description": "password-reset"
 },
 {
 "name": "sessions",
 "description": "sessions"
 },
 {
 "name": "attachments",
 "description": "attachments"
 },
 {
 "name": "bounces",
 "description": "bounces"
 },
 {
 "name": "campaigns",
 "description": "campaigns"
 },
 {
 "name": "editor-uploads",
 "description": "editor-uploads"
 },
 {
 "name": "list-messages",
 "description": "list-messages"
 },
 {
 "name": "templates",
 "description": "templates"
 },
 {
 "name": "analytics",
 "description": "analytics"
 },
 {
 "name": "tracking",
 "description": "tracking"
 },
 {
 "name": "blacklist",
 "description": "blacklist"
 },
 {
 "name": "subscriptions",
 "description": "subscriptions"
 },
 {
 "name": "subscribe-pages",
 "description": "subscribe-pages"
 },
 {
 "name": "subscriber-attributes",
 "description": "subscriber-attributes"
 },
 {
 "name": "subscribers",
 "description": "subscribers"
 },
 {
 "name": "lists",
 "description": "lists"
 }
 ]
}