Skip to content

Commit 65b71af

Browse files
author
github-actions
committed
Update REST API documentation Sat Apr 26 11:44:11 UTC 2025
1 parent 30d6058 commit 65b71af

File tree

1 file changed

+73
-7
lines changed

1 file changed

+73
-7
lines changed

restapi.json

Lines changed: 73 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,66 @@
300300
}
301301
}
302302
}
303+
},
304+
"delete": {
305+
"tags": [
306+
"campaigns"
307+
],
308+
"summary": "Delete campaign by id.",
309+
"description": "Delete campaign/message by id.",
310+
"operationId": "444811ab8b55fbdfb55fb281d02e45ef",
311+
"parameters": [
312+
{
313+
"name": "session",
314+
"in": "header",
315+
"description": "Session ID obtained from authentication",
316+
"required": true,
317+
"schema": {
318+
"type": "string"
319+
}
320+
},
321+
{
322+
"name": "messageId",
323+
"in": "path",
324+
"description": "message ID",
325+
"required": true,
326+
"schema": {
327+
"type": "string"
328+
}
329+
}
330+
],
331+
"responses": {
332+
"200": {
333+
"description": "Success",
334+
"content": {
335+
"application/json": {
336+
"schema": {
337+
"$ref": "#/components/schemas/Message"
338+
}
339+
}
340+
}
341+
},
342+
"403": {
343+
"description": "Failure",
344+
"content": {
345+
"application/json": {
346+
"schema": {
347+
"$ref": "#/components/schemas/UnauthorizedResponse"
348+
}
349+
}
350+
}
351+
},
352+
"404": {
353+
"description": "Failure",
354+
"content": {
355+
"application/json": {
356+
"schema": {
357+
"$ref": "#/components/schemas/NotFoundErrorResponse"
358+
}
359+
}
360+
}
361+
}
362+
}
303363
}
304364
},
305365
"/lists": {
@@ -600,13 +660,7 @@
600660
"content": {
601661
"application/json": {
602662
"schema": {
603-
"properties": {
604-
"message": {
605-
"type": "string",
606-
"example": "There is no session with that ID."
607-
}
608-
},
609-
"type": "object"
663+
"$ref": "#/components/schemas/NotFoundErrorResponse"
610664
}
611665
}
612666
}
@@ -1697,6 +1751,18 @@
16971751
},
16981752
"type": "object"
16991753
},
1754+
"NotFoundErrorResponse": {
1755+
"required": [
1756+
"message"
1757+
],
1758+
"properties": {
1759+
"message": {
1760+
"type": "string",
1761+
"example": "There is no entity with that ID."
1762+
}
1763+
},
1764+
"type": "object"
1765+
},
17001766
"SubscriberList": {
17011767
"properties": {
17021768
"id": {

0 commit comments

Comments
 (0)