Skip to content

Commit 2e57ef2

Browse files
author
github-actions
committed
Update openapi.json from REST API workflow 2026-04-27T07:44:02Z
1 parent 3fd4252 commit 2e57ef2

1 file changed

Lines changed: 144 additions & 0 deletions

File tree

openapi.json

Lines changed: 144 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1333,6 +1333,107 @@
13331333
}
13341334
}
13351335
},
1336+
"/api/v2/bounces": {
1337+
"get": {
1338+
"tags": [
1339+
"bounces"
1340+
],
1341+
"summary": "Gets a list of all bounces.",
1342+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all bounces.",
1343+
"operationId": "98e6f5ee3a2c8cb61009583a938b22cb",
1344+
"parameters": [
1345+
{
1346+
"name": "php-auth-pw",
1347+
"in": "header",
1348+
"description": "Session key obtained from login",
1349+
"required": true,
1350+
"schema": {
1351+
"type": "string"
1352+
}
1353+
}
1354+
],
1355+
"responses": {
1356+
"200": {
1357+
"description": "Success",
1358+
"content": {
1359+
"application/json": {
1360+
"schema": {
1361+
"type": "array",
1362+
"items": {
1363+
"$ref": "#/components/schemas/Bounce"
1364+
}
1365+
}
1366+
}
1367+
}
1368+
},
1369+
"403": {
1370+
"description": "Failure",
1371+
"content": {
1372+
"application/json": {
1373+
"schema": {
1374+
"$ref": "#/components/schemas/UnauthorizedResponse"
1375+
}
1376+
}
1377+
}
1378+
}
1379+
}
1380+
}
1381+
},
1382+
"/api/v2/bounces/{bounceId}": {
1383+
"delete": {
1384+
"tags": [
1385+
"bounces"
1386+
],
1387+
"summary": "Delete a bounce by its id",
1388+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete a bounce by its id.",
1389+
"operationId": "52d0665c9ee3e8d0276cfe65e43866f4",
1390+
"parameters": [
1391+
{
1392+
"name": "php-auth-pw",
1393+
"in": "header",
1394+
"description": "Session key obtained from login",
1395+
"required": true,
1396+
"schema": {
1397+
"type": "string"
1398+
}
1399+
},
1400+
{
1401+
"name": "bounceId",
1402+
"in": "path",
1403+
"description": "Bounce id",
1404+
"required": true,
1405+
"schema": {
1406+
"type": "string"
1407+
}
1408+
}
1409+
],
1410+
"responses": {
1411+
"204": {
1412+
"description": "Success"
1413+
},
1414+
"403": {
1415+
"description": "Failure",
1416+
"content": {
1417+
"application/json": {
1418+
"schema": {
1419+
"$ref": "#/components/schemas/UnauthorizedResponse"
1420+
}
1421+
}
1422+
}
1423+
},
1424+
"404": {
1425+
"description": "Failure",
1426+
"content": {
1427+
"application/json": {
1428+
"schema": {
1429+
"$ref": "#/components/schemas/NotFoundErrorResponse"
1430+
}
1431+
}
1432+
}
1433+
}
1434+
}
1435+
}
1436+
},
13361437
"/api/v2/bounces/regex": {
13371438
"get": {
13381439
"tags": [
@@ -7274,6 +7375,49 @@
72747375
},
72757376
"type": "object"
72767377
},
7378+
"Bounce": {
7379+
"properties": {
7380+
"id": {
7381+
"type": "integer",
7382+
"example": 10
7383+
},
7384+
"status": {
7385+
"type": "string",
7386+
"example": "not processed",
7387+
"nullable": true
7388+
},
7389+
"date": {
7390+
"type": "string",
7391+
"example": "2023-01-01T12:00:00Z",
7392+
"nullable": true
7393+
},
7394+
"message_id": {
7395+
"type": "integer",
7396+
"example": 123
7397+
},
7398+
"message_subject": {
7399+
"type": "string",
7400+
"example": "Newsletter",
7401+
"nullable": true
7402+
},
7403+
"subscriber_id": {
7404+
"type": "integer",
7405+
"example": 0,
7406+
"nullable": true
7407+
},
7408+
"subscriber_email": {
7409+
"type": "string",
7410+
"example": "user@example.com",
7411+
"nullable": true
7412+
},
7413+
"comment": {
7414+
"type": "string",
7415+
"example": "Auto-generated rule",
7416+
"nullable": true
7417+
}
7418+
},
7419+
"type": "object"
7420+
},
72777421
"BounceRegex": {
72787422
"properties": {
72797423
"id": {

0 commit comments

Comments
 (0)