Skip to content

Commit 4c0b488

Browse files
author
github-actions
committed
Update REST API documentation Tue Aug 19 06:05:33 UTC 2025
1 parent 5399934 commit 4c0b488

File tree

1 file changed

+308
-0
lines changed

1 file changed

+308
-0
lines changed

‎restapi.json‎

Lines changed: 308 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1233,6 +1233,263 @@
12331233
}
12341234
}
12351235
},
1236+
"/api/v2/bounces/regex": {
1237+
"get": {
1238+
"tags": [
1239+
"bounces"
1240+
],
1241+
"summary": "Gets a list of all bounce regex rules.",
1242+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all bounce regex rules.",
1243+
"operationId": "6449bb00e5412ff3d0bf9731a49fd172",
1244+
"parameters": [
1245+
{
1246+
"name": "php-auth-pw",
1247+
"in": "header",
1248+
"description": "Session key obtained from login",
1249+
"required": true,
1250+
"schema": {
1251+
"type": "string"
1252+
}
1253+
}
1254+
],
1255+
"responses": {
1256+
"200": {
1257+
"description": "Success",
1258+
"content": {
1259+
"application/json": {
1260+
"schema": {
1261+
"type": "array",
1262+
"items": {
1263+
"$ref": "#/components/schemas/BounceRegex"
1264+
}
1265+
}
1266+
}
1267+
}
1268+
},
1269+
"403": {
1270+
"description": "Failure",
1271+
"content": {
1272+
"application/json": {
1273+
"schema": {
1274+
"$ref": "#/components/schemas/UnauthorizedResponse"
1275+
}
1276+
}
1277+
}
1278+
}
1279+
}
1280+
},
1281+
"post": {
1282+
"tags": [
1283+
"bounces"
1284+
],
1285+
"summary": "Create or update a bounce regex",
1286+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Creates a new bounce regex or updates an existing one (matched by regex hash).",
1287+
"operationId": "91f09d8583ea3629b39c328464961dd8",
1288+
"parameters": [
1289+
{
1290+
"name": "php-auth-pw",
1291+
"in": "header",
1292+
"description": "Session key obtained from login",
1293+
"required": true,
1294+
"schema": {
1295+
"type": "string"
1296+
}
1297+
}
1298+
],
1299+
"requestBody": {
1300+
"description": "Create or update a bounce regex rule.",
1301+
"required": true,
1302+
"content": {
1303+
"application/json": {
1304+
"schema": {
1305+
"required": [
1306+
"regex"
1307+
],
1308+
"properties": {
1309+
"regex": {
1310+
"type": "string",
1311+
"example": "/mailbox is full/i"
1312+
},
1313+
"action": {
1314+
"type": "string",
1315+
"example": "delete",
1316+
"nullable": true
1317+
},
1318+
"list_order": {
1319+
"type": "integer",
1320+
"example": 0,
1321+
"nullable": true
1322+
},
1323+
"admin": {
1324+
"type": "integer",
1325+
"example": 1,
1326+
"nullable": true
1327+
},
1328+
"comment": {
1329+
"type": "string",
1330+
"example": "Auto-generated",
1331+
"nullable": true
1332+
},
1333+
"status": {
1334+
"type": "string",
1335+
"example": "active",
1336+
"nullable": true
1337+
}
1338+
},
1339+
"type": "object"
1340+
}
1341+
}
1342+
}
1343+
},
1344+
"responses": {
1345+
"201": {
1346+
"description": "Success",
1347+
"content": {
1348+
"application/json": {
1349+
"schema": {
1350+
"$ref": "#/components/schemas/BounceRegex"
1351+
}
1352+
}
1353+
}
1354+
},
1355+
"403": {
1356+
"description": "Failure",
1357+
"content": {
1358+
"application/json": {
1359+
"schema": {
1360+
"$ref": "#/components/schemas/UnauthorizedResponse"
1361+
}
1362+
}
1363+
}
1364+
},
1365+
"422": {
1366+
"description": "Failure",
1367+
"content": {
1368+
"application/json": {
1369+
"schema": {
1370+
"$ref": "#/components/schemas/ValidationErrorResponse"
1371+
}
1372+
}
1373+
}
1374+
}
1375+
}
1376+
}
1377+
},
1378+
"/api/v2/bounces/regex/{regexHash}": {
1379+
"get": {
1380+
"tags": [
1381+
"bounces"
1382+
],
1383+
"summary": "Get a bounce regex by its hash",
1384+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a bounce regex by its hash.",
1385+
"operationId": "be73154c156c45440b3b3f47513d8e86",
1386+
"parameters": [
1387+
{
1388+
"name": "php-auth-pw",
1389+
"in": "header",
1390+
"description": "Session key obtained from login",
1391+
"required": true,
1392+
"schema": {
1393+
"type": "string"
1394+
}
1395+
},
1396+
{
1397+
"name": "regexHash",
1398+
"in": "path",
1399+
"description": "Regex hash",
1400+
"required": true,
1401+
"schema": {
1402+
"type": "string"
1403+
}
1404+
}
1405+
],
1406+
"responses": {
1407+
"200": {
1408+
"description": "Success",
1409+
"content": {
1410+
"application/json": {
1411+
"schema": {
1412+
"$ref": "#/components/schemas/BounceRegex"
1413+
}
1414+
}
1415+
}
1416+
},
1417+
"403": {
1418+
"description": "Failure",
1419+
"content": {
1420+
"application/json": {
1421+
"schema": {
1422+
"$ref": "#/components/schemas/UnauthorizedResponse"
1423+
}
1424+
}
1425+
}
1426+
},
1427+
"404": {
1428+
"description": "Failure",
1429+
"content": {
1430+
"application/json": {
1431+
"schema": {
1432+
"$ref": "#/components/schemas/NotFoundErrorResponse"
1433+
}
1434+
}
1435+
}
1436+
}
1437+
}
1438+
},
1439+
"delete": {
1440+
"tags": [
1441+
"bounces"
1442+
],
1443+
"summary": "Delete a bounce regex by its hash",
1444+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete a bounce regex by its hash.",
1445+
"operationId": "47b3de553732c5de46647709a42d2ced",
1446+
"parameters": [
1447+
{
1448+
"name": "php-auth-pw",
1449+
"in": "header",
1450+
"description": "Session key obtained from login",
1451+
"required": true,
1452+
"schema": {
1453+
"type": "string"
1454+
}
1455+
},
1456+
{
1457+
"name": "regexHash",
1458+
"in": "path",
1459+
"description": "Regex hash",
1460+
"required": true,
1461+
"schema": {
1462+
"type": "string"
1463+
}
1464+
}
1465+
],
1466+
"responses": {
1467+
"204": {
1468+
"description": "Success"
1469+
},
1470+
"403": {
1471+
"description": "Failure",
1472+
"content": {
1473+
"application/json": {
1474+
"schema": {
1475+
"$ref": "#/components/schemas/UnauthorizedResponse"
1476+
}
1477+
}
1478+
}
1479+
},
1480+
"404": {
1481+
"description": "Failure",
1482+
"content": {
1483+
"application/json": {
1484+
"schema": {
1485+
"$ref": "#/components/schemas/NotFoundErrorResponse"
1486+
}
1487+
}
1488+
}
1489+
}
1490+
}
1491+
}
1492+
},
12361493
"/api/v2/campaigns": {
12371494
"get": {
12381495
"tags": [
@@ -5860,6 +6117,53 @@
58606117
},
58616118
"type": "object"
58626119
},
6120+
"BounceRegex": {
6121+
"properties": {
6122+
"id": {
6123+
"type": "integer",
6124+
"example": 10
6125+
},
6126+
"regex": {
6127+
"type": "string",
6128+
"example": "/mailbox is full/i"
6129+
},
6130+
"regex_hash": {
6131+
"type": "string",
6132+
"example": "d41d8cd98f00b204e9800998ecf8427e"
6133+
},
6134+
"action": {
6135+
"type": "string",
6136+
"example": "delete",
6137+
"nullable": true
6138+
},
6139+
"list_order": {
6140+
"type": "integer",
6141+
"example": 0,
6142+
"nullable": true
6143+
},
6144+
"admin_id": {
6145+
"type": "integer",
6146+
"example": 1,
6147+
"nullable": true
6148+
},
6149+
"comment": {
6150+
"type": "string",
6151+
"example": "Auto-generated rule",
6152+
"nullable": true
6153+
},
6154+
"status": {
6155+
"type": "string",
6156+
"example": "active",
6157+
"nullable": true
6158+
},
6159+
"count": {
6160+
"type": "integer",
6161+
"example": 5,
6162+
"nullable": true
6163+
}
6164+
},
6165+
"type": "object"
6166+
},
58636167
"CampaignStatistics": {
58646168
"properties": {
58656169
"campaign_id": {
@@ -6482,6 +6786,10 @@
64826786
"name": "sessions",
64836787
"description": "sessions"
64846788
},
6789+
{
6790+
"name": "bounces",
6791+
"description": "bounces"
6792+
},
64856793
{
64866794
"name": "campaigns",
64876795
"description": "campaigns"

0 commit comments

Comments
 (0)