Skip to content

Commit d254c8c

Browse files
author
github-actions
committed
Update REST API documentation Fri Nov 21 07:41:11 UTC 2025
1 parent 7dde0aa commit d254c8c

File tree

1 file changed

+94
-51
lines changed

1 file changed

+94
-51
lines changed

‎restapi.json‎

Lines changed: 94 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -350,14 +350,14 @@
350350
}
351351
}
352352
},
353-
"/api/v2/administrators/attribute-values/{adminId}/{definitionId}": {
353+
"/api/v2/administrators/{adminId}/attributes/{definitionId}": {
354354
"get": {
355355
"tags": [
356356
"admin-attributes"
357357
],
358358
"summary": "Gets admin attribute.",
359359
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a single attribute.",
360-
"operationId": "993bda3c9e739aebc4691af2f2326f6a",
360+
"operationId": "c78ef2b0910f4e150dbcd2a6cd0ea27e",
361361
"parameters": [
362362
{
363363
"name": "definitionId",
@@ -432,7 +432,7 @@
432432
],
433433
"summary": "Create/update an admin attribute.",
434434
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns created/updated admin attribute.",
435-
"operationId": "675aaea8f721e9bb44ad4037a8cf2911",
435+
"operationId": "3cc645e3d26cc49501ad67adda844712",
436436
"parameters": [
437437
{
438438
"name": "php-auth-pw",
@@ -518,7 +518,7 @@
518518
],
519519
"summary": "Deletes an attribute.",
520520
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Deletes a single admin attribute.",
521-
"operationId": "4f76366b588001989ec8040c0335d2a4",
521+
"operationId": "7e8b9cefb17ef3cbb69501820e0d0f6c",
522522
"parameters": [
523523
{
524524
"name": "php-auth-pw",
@@ -575,14 +575,14 @@
575575
}
576576
}
577577
},
578-
"/api/v2/administrators/attribute-values/{adminId}": {
578+
"/api/v2/administrators/{adminId}/attributes": {
579579
"get": {
580580
"tags": [
581581
"admin-attributes"
582582
],
583583
"summary": "Gets a list of all admin attributes.",
584584
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Returns a JSON list of all admin attributes.",
585-
"operationId": "3697baedcd4df34b5b8b78ef0b3238c5",
585+
"operationId": "d6a09a4d6f2451e72c2a8b23e2fd1911",
586586
"parameters": [
587587
{
588588
"name": "php-auth-pw",
@@ -657,6 +657,16 @@
657657
}
658658
}
659659
}
660+
},
661+
"404": {
662+
"description": "Failure",
663+
"content": {
664+
"application/json": {
665+
"schema": {
666+
"$ref": "#/components/schemas/NotFoundErrorResponse"
667+
}
668+
}
669+
}
660670
}
661671
}
662672
}
@@ -776,17 +786,17 @@
776786
}
777787
}
778788
},
779-
"/api/v2/administrators/{administratorId}": {
789+
"/api/v2/administrators/{adminId}": {
780790
"get": {
781791
"tags": [
782792
"administrators"
783793
],
784794
"summary": "Get Administrator",
785795
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Get administrator by ID.",
786-
"operationId": "7b0c7aa05f2c6230af358826c3e6755a",
796+
"operationId": "71a302c638b746ec7169b15da4ae7c9a",
787797
"parameters": [
788798
{
789-
"name": "administratorId",
799+
"name": "adminId",
790800
"in": "path",
791801
"description": "Administrator ID",
792802
"required": true,
@@ -826,10 +836,10 @@
826836
],
827837
"summary": "Update Administrator",
828838
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Update an administrator.",
829-
"operationId": "08cb2e738c87f73709980cb140528918",
839+
"operationId": "53023c81474020aca57ac09031e1c49c",
830840
"parameters": [
831841
{
832-
"name": "administratorId",
842+
"name": "adminId",
833843
"in": "path",
834844
"description": "Administrator ID",
835845
"required": true,
@@ -880,10 +890,10 @@
880890
],
881891
"summary": "Delete Administrator",
882892
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production. Delete an administrator.",
883-
"operationId": "18f8713da580af36ce4b9909a8a1c01e",
893+
"operationId": "52cdf4ca32e2fe304993bdac19c1bc92",
884894
"parameters": [
885895
{
886-
"name": "administratorId",
896+
"name": "adminId",
887897
"in": "path",
888898
"description": "Administrator ID",
889899
"required": true,
@@ -1705,6 +1715,16 @@
17051715
}
17061716
}
17071717
}
1718+
},
1719+
"404": {
1720+
"description": "Failure",
1721+
"content": {
1722+
"application/json": {
1723+
"schema": {
1724+
"$ref": "#/components/schemas/NotFoundErrorResponse"
1725+
}
1726+
}
1727+
}
17081728
}
17091729
}
17101730
},
@@ -1791,6 +1811,16 @@
17911811
}
17921812
}
17931813
},
1814+
"404": {
1815+
"description": "Failure",
1816+
"content": {
1817+
"application/json": {
1818+
"schema": {
1819+
"$ref": "#/components/schemas/NotFoundErrorResponse"
1820+
}
1821+
}
1822+
}
1823+
},
17941824
"422": {
17951825
"description": "Failure",
17961826
"content": {
@@ -2418,44 +2448,7 @@
24182448
"content": {
24192449
"multipart/form-data": {
24202450
"schema": {
2421-
"required": [
2422-
"title"
2423-
],
2424-
"properties": {
2425-
"title": {
2426-
"type": "string",
2427-
"example": "Newsletter Template"
2428-
},
2429-
"content": {
2430-
"type": "string",
2431-
"example": "<html><body>[CONTENT]</body></html>"
2432-
},
2433-
"text": {
2434-
"type": "string",
2435-
"example": "[CONTENT]"
2436-
},
2437-
"file": {
2438-
"description": "Optional file upload for HTML content",
2439-
"type": "string",
2440-
"format": "binary"
2441-
},
2442-
"check_links": {
2443-
"description": "Check that all links have full URLs",
2444-
"type": "boolean",
2445-
"example": true
2446-
},
2447-
"check_images": {
2448-
"description": "Check that all images have full URLs",
2449-
"type": "boolean",
2450-
"example": false
2451-
},
2452-
"check_external_images": {
2453-
"description": "Check that all external images exist",
2454-
"type": "boolean",
2455-
"example": true
2456-
}
2457-
},
2458-
"type": "object"
2451+
"$ref": "#/components/schemas/CreateTemplateRequest"
24592452
}
24602453
}
24612454
}
@@ -3549,6 +3542,16 @@
35493542
}
35503543
}
35513544
}
3545+
},
3546+
"404": {
3547+
"description": "Failure",
3548+
"content": {
3549+
"application/json": {
3550+
"schema": {
3551+
"$ref": "#/components/schemas/NotFoundErrorResponse"
3552+
}
3553+
}
3554+
}
35523555
}
35533556
}
35543557
}
@@ -5855,6 +5858,46 @@
58555858
},
58565859
"type": "object"
58575860
},
5861+
"CreateTemplateRequest": {
5862+
"required": [
5863+
"title"
5864+
],
5865+
"properties": {
5866+
"title": {
5867+
"type": "string",
5868+
"example": "Newsletter Template"
5869+
},
5870+
"content": {
5871+
"type": "string",
5872+
"example": "<html><body>[CONTENT]</body></html>"
5873+
},
5874+
"text": {
5875+
"type": "string",
5876+
"example": "[CONTENT]"
5877+
},
5878+
"file": {
5879+
"description": "Optional file upload for HTML content",
5880+
"type": "string",
5881+
"format": "binary"
5882+
},
5883+
"check_links": {
5884+
"description": "Check that all links have full URLs",
5885+
"type": "boolean",
5886+
"example": true
5887+
},
5888+
"check_images": {
5889+
"description": "Check that all images have full URLs",
5890+
"type": "boolean",
5891+
"example": false
5892+
},
5893+
"check_external_images": {
5894+
"description": "Check that all external images exist",
5895+
"type": "boolean",
5896+
"example": true
5897+
}
5898+
},
5899+
"type": "object"
5900+
},
58585901
"MessageContentRequest": {
58595902
"required": [
58605903
"subject",

0 commit comments

Comments
 (0)