Skip to content

Commit 636269f

Browse files
author
github-actions
committed
Update REST API documentation Mon May 25 11:52:13 UTC 2026
1 parent bd6da7c commit 636269f

1 file changed

Lines changed: 49 additions & 168 deletions

File tree

‎restapi.json‎

Lines changed: 49 additions & 168 deletions
Original file line numberDiff line numberDiff line change
@@ -4839,6 +4839,21 @@
48394839
"active": {
48404840
"type": "boolean",
48414841
"nullable": true
4842+
},
4843+
"data": {
4844+
"type": "array",
4845+
"items": {
4846+
"properties": {
4847+
"key": {
4848+
"type": "string"
4849+
},
4850+
"value": {
4851+
"type": "string"
4852+
}
4853+
},
4854+
"type": "object"
4855+
},
4856+
"nullable": true
48424857
}
48434858
},
48444859
"type": "object"
@@ -4981,6 +4996,21 @@
49814996
"active": {
49824997
"type": "boolean",
49834998
"nullable": true
4999+
},
5000+
"data": {
5001+
"type": "array",
5002+
"items": {
5003+
"properties": {
5004+
"key": {
5005+
"type": "string"
5006+
},
5007+
"value": {
5008+
"type": "string"
5009+
}
5010+
},
5011+
"type": "object"
5012+
},
5013+
"nullable": true
49845014
}
49855015
},
49865016
"type": "object"
@@ -5075,174 +5105,6 @@
50755105
}
50765106
}
50775107
},
5078-
"/api/v2/subscribe-pages/{id}/data": {
5079-
"get": {
5080-
"tags": [
5081-
"subscriptions"
5082-
],
5083-
"summary": "Get subscribe page data",
5084-
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
5085-
"operationId": "ffe22f26936614a0e853e7c44e5a0fca",
5086-
"parameters": [
5087-
{
5088-
"name": "php-auth-pw",
5089-
"in": "header",
5090-
"description": "Session key obtained from login",
5091-
"required": true,
5092-
"schema": {
5093-
"type": "string"
5094-
}
5095-
},
5096-
{
5097-
"name": "id",
5098-
"in": "path",
5099-
"description": "Subscribe page ID",
5100-
"required": true,
5101-
"schema": {
5102-
"type": "integer"
5103-
}
5104-
}
5105-
],
5106-
"responses": {
5107-
"200": {
5108-
"description": "Success",
5109-
"content": {
5110-
"application/json": {
5111-
"schema": {
5112-
"type": "array",
5113-
"items": {
5114-
"properties": {
5115-
"id": {
5116-
"type": "integer"
5117-
},
5118-
"name": {
5119-
"type": "string"
5120-
},
5121-
"data": {
5122-
"type": "string",
5123-
"nullable": true
5124-
}
5125-
},
5126-
"type": "object"
5127-
}
5128-
}
5129-
}
5130-
}
5131-
},
5132-
"403": {
5133-
"description": "Failure",
5134-
"content": {
5135-
"application/json": {
5136-
"schema": {
5137-
"$ref": "#/components/schemas/UnauthorizedResponse"
5138-
}
5139-
}
5140-
}
5141-
},
5142-
"404": {
5143-
"description": "Not Found",
5144-
"content": {
5145-
"application/json": {
5146-
"schema": {
5147-
"$ref": "#/components/schemas/NotFoundErrorResponse"
5148-
}
5149-
}
5150-
}
5151-
}
5152-
}
5153-
},
5154-
"put": {
5155-
"tags": [
5156-
"subscriptions"
5157-
],
5158-
"summary": "Set subscribe page data item",
5159-
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
5160-
"operationId": "a71571132947a19d862eac4baf7a98a7",
5161-
"parameters": [
5162-
{
5163-
"name": "php-auth-pw",
5164-
"in": "header",
5165-
"description": "Session key obtained from login",
5166-
"required": true,
5167-
"schema": {
5168-
"type": "string"
5169-
}
5170-
},
5171-
{
5172-
"name": "id",
5173-
"in": "path",
5174-
"description": "Subscribe page ID",
5175-
"required": true,
5176-
"schema": {
5177-
"type": "integer"
5178-
}
5179-
}
5180-
],
5181-
"requestBody": {
5182-
"required": true,
5183-
"content": {
5184-
"application/json": {
5185-
"schema": {
5186-
"properties": {
5187-
"name": {
5188-
"type": "string"
5189-
},
5190-
"value": {
5191-
"type": "string",
5192-
"nullable": true
5193-
}
5194-
},
5195-
"type": "object"
5196-
}
5197-
}
5198-
}
5199-
},
5200-
"responses": {
5201-
"200": {
5202-
"description": "Success",
5203-
"content": {
5204-
"application/json": {
5205-
"schema": {
5206-
"properties": {
5207-
"id": {
5208-
"type": "integer"
5209-
},
5210-
"name": {
5211-
"type": "string"
5212-
},
5213-
"data": {
5214-
"type": "string",
5215-
"nullable": true
5216-
}
5217-
},
5218-
"type": "object"
5219-
}
5220-
}
5221-
}
5222-
},
5223-
"403": {
5224-
"description": "Failure",
5225-
"content": {
5226-
"application/json": {
5227-
"schema": {
5228-
"$ref": "#/components/schemas/UnauthorizedResponse"
5229-
}
5230-
}
5231-
}
5232-
},
5233-
"404": {
5234-
"description": "Not Found",
5235-
"content": {
5236-
"application/json": {
5237-
"schema": {
5238-
"$ref": "#/components/schemas/NotFoundErrorResponse"
5239-
}
5240-
}
5241-
}
5242-
}
5243-
}
5244-
}
5245-
},
52465108
"/api/v2/attributes": {
52475109
"get": {
52485110
"tags": [
@@ -8600,6 +8462,19 @@
86008462
},
86018463
"type": "object"
86028464
},
8465+
"SubscribePageData": {
8466+
"properties": {
8467+
"key": {
8468+
"type": "string",
8469+
"example": "button"
8470+
},
8471+
"value": {
8472+
"type": "string",
8473+
"example": "Subscribe to the selected newsletters"
8474+
}
8475+
},
8476+
"type": "object"
8477+
},
86038478
"SubscribePage": {
86048479
"properties": {
86058480
"id": {
@@ -8616,6 +8491,12 @@
86168491
},
86178492
"owner": {
86188493
"$ref": "#/components/schemas/Administrator"
8494+
},
8495+
"data": {
8496+
"type": "array",
8497+
"items": {
8498+
"$ref": "#/components/schemas/SubscribePageData"
8499+
}
86198500
}
86208501
},
86218502
"type": "object"

0 commit comments

Comments
 (0)