Skip to content

Commit 5399934

Browse files
author
github-actions
committed
Update REST API documentation Thu Aug 14 15:48:47 UTC 2025
1 parent 3d164ff commit 5399934

File tree

1 file changed

+301
-0
lines changed

1 file changed

+301
-0
lines changed

‎restapi.json‎

Lines changed: 301 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3356,6 +3356,139 @@
33563356
}
33573357
}
33583358
}
3359+
},
3360+
"put": {
3361+
"tags": [
3362+
"subscriptions"
3363+
],
3364+
"summary": "Update subscribe page",
3365+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
3366+
"operationId": "a82a0cbe52063758b55279ce7b96657b",
3367+
"parameters": [
3368+
{
3369+
"name": "php-auth-pw",
3370+
"in": "header",
3371+
"description": "Session key obtained from login",
3372+
"required": true,
3373+
"schema": {
3374+
"type": "string"
3375+
}
3376+
},
3377+
{
3378+
"name": "id",
3379+
"in": "path",
3380+
"description": "Subscribe page ID",
3381+
"required": true,
3382+
"schema": {
3383+
"type": "integer"
3384+
}
3385+
}
3386+
],
3387+
"requestBody": {
3388+
"required": true,
3389+
"content": {
3390+
"application/json": {
3391+
"schema": {
3392+
"properties": {
3393+
"title": {
3394+
"type": "string",
3395+
"nullable": true
3396+
},
3397+
"active": {
3398+
"type": "boolean",
3399+
"nullable": true
3400+
}
3401+
},
3402+
"type": "object"
3403+
}
3404+
}
3405+
}
3406+
},
3407+
"responses": {
3408+
"200": {
3409+
"description": "Success",
3410+
"content": {
3411+
"application/json": {
3412+
"schema": {
3413+
"$ref": "#/components/schemas/SubscribePage"
3414+
}
3415+
}
3416+
}
3417+
},
3418+
"403": {
3419+
"description": "Failure",
3420+
"content": {
3421+
"application/json": {
3422+
"schema": {
3423+
"$ref": "#/components/schemas/UnauthorizedResponse"
3424+
}
3425+
}
3426+
}
3427+
},
3428+
"404": {
3429+
"description": "Not Found",
3430+
"content": {
3431+
"application/json": {
3432+
"schema": {
3433+
"$ref": "#/components/schemas/NotFoundErrorResponse"
3434+
}
3435+
}
3436+
}
3437+
}
3438+
}
3439+
},
3440+
"delete": {
3441+
"tags": [
3442+
"subscriptions"
3443+
],
3444+
"summary": "Delete subscribe page",
3445+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
3446+
"operationId": "2881b5de1d076caa070f2b9a1c8487fe",
3447+
"parameters": [
3448+
{
3449+
"name": "php-auth-pw",
3450+
"in": "header",
3451+
"description": "Session key obtained from login",
3452+
"required": true,
3453+
"schema": {
3454+
"type": "string"
3455+
}
3456+
},
3457+
{
3458+
"name": "id",
3459+
"in": "path",
3460+
"description": "Subscribe page ID",
3461+
"required": true,
3462+
"schema": {
3463+
"type": "integer"
3464+
}
3465+
}
3466+
],
3467+
"responses": {
3468+
"204": {
3469+
"description": "No Content"
3470+
},
3471+
"403": {
3472+
"description": "Failure",
3473+
"content": {
3474+
"application/json": {
3475+
"schema": {
3476+
"$ref": "#/components/schemas/UnauthorizedResponse"
3477+
}
3478+
}
3479+
}
3480+
},
3481+
"404": {
3482+
"description": "Not Found",
3483+
"content": {
3484+
"application/json": {
3485+
"schema": {
3486+
"$ref": "#/components/schemas/NotFoundErrorResponse"
3487+
}
3488+
}
3489+
}
3490+
}
3491+
}
33593492
}
33603493
},
33613494
"/api/v2/subscribe-pages": {
@@ -3430,6 +3563,174 @@
34303563
}
34313564
}
34323565
},
3566+
"/api/v2/subscribe-pages/{id}/data": {
3567+
"get": {
3568+
"tags": [
3569+
"subscriptions"
3570+
],
3571+
"summary": "Get subscribe page data",
3572+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
3573+
"operationId": "ffe22f26936614a0e853e7c44e5a0fca",
3574+
"parameters": [
3575+
{
3576+
"name": "php-auth-pw",
3577+
"in": "header",
3578+
"description": "Session key obtained from login",
3579+
"required": true,
3580+
"schema": {
3581+
"type": "string"
3582+
}
3583+
},
3584+
{
3585+
"name": "id",
3586+
"in": "path",
3587+
"description": "Subscribe page ID",
3588+
"required": true,
3589+
"schema": {
3590+
"type": "integer"
3591+
}
3592+
}
3593+
],
3594+
"responses": {
3595+
"200": {
3596+
"description": "Success",
3597+
"content": {
3598+
"application/json": {
3599+
"schema": {
3600+
"type": "array",
3601+
"items": {
3602+
"properties": {
3603+
"id": {
3604+
"type": "integer"
3605+
},
3606+
"name": {
3607+
"type": "string"
3608+
},
3609+
"data": {
3610+
"type": "string",
3611+
"nullable": true
3612+
}
3613+
},
3614+
"type": "object"
3615+
}
3616+
}
3617+
}
3618+
}
3619+
},
3620+
"403": {
3621+
"description": "Failure",
3622+
"content": {
3623+
"application/json": {
3624+
"schema": {
3625+
"$ref": "#/components/schemas/UnauthorizedResponse"
3626+
}
3627+
}
3628+
}
3629+
},
3630+
"404": {
3631+
"description": "Not Found",
3632+
"content": {
3633+
"application/json": {
3634+
"schema": {
3635+
"$ref": "#/components/schemas/NotFoundErrorResponse"
3636+
}
3637+
}
3638+
}
3639+
}
3640+
}
3641+
},
3642+
"put": {
3643+
"tags": [
3644+
"subscriptions"
3645+
],
3646+
"summary": "Set subscribe page data item",
3647+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
3648+
"operationId": "a71571132947a19d862eac4baf7a98a7",
3649+
"parameters": [
3650+
{
3651+
"name": "php-auth-pw",
3652+
"in": "header",
3653+
"description": "Session key obtained from login",
3654+
"required": true,
3655+
"schema": {
3656+
"type": "string"
3657+
}
3658+
},
3659+
{
3660+
"name": "id",
3661+
"in": "path",
3662+
"description": "Subscribe page ID",
3663+
"required": true,
3664+
"schema": {
3665+
"type": "integer"
3666+
}
3667+
}
3668+
],
3669+
"requestBody": {
3670+
"required": true,
3671+
"content": {
3672+
"application/json": {
3673+
"schema": {
3674+
"properties": {
3675+
"name": {
3676+
"type": "string"
3677+
},
3678+
"value": {
3679+
"type": "string",
3680+
"nullable": true
3681+
}
3682+
},
3683+
"type": "object"
3684+
}
3685+
}
3686+
}
3687+
},
3688+
"responses": {
3689+
"200": {
3690+
"description": "Success",
3691+
"content": {
3692+
"application/json": {
3693+
"schema": {
3694+
"properties": {
3695+
"id": {
3696+
"type": "integer"
3697+
},
3698+
"name": {
3699+
"type": "string"
3700+
},
3701+
"data": {
3702+
"type": "string",
3703+
"nullable": true
3704+
}
3705+
},
3706+
"type": "object"
3707+
}
3708+
}
3709+
}
3710+
},
3711+
"403": {
3712+
"description": "Failure",
3713+
"content": {
3714+
"application/json": {
3715+
"schema": {
3716+
"$ref": "#/components/schemas/UnauthorizedResponse"
3717+
}
3718+
}
3719+
}
3720+
},
3721+
"404": {
3722+
"description": "Not Found",
3723+
"content": {
3724+
"application/json": {
3725+
"schema": {
3726+
"$ref": "#/components/schemas/NotFoundErrorResponse"
3727+
}
3728+
}
3729+
}
3730+
}
3731+
}
3732+
}
3733+
},
34333734
"/api/v2/subscribers/attributes": {
34343735
"get": {
34353736
"tags": [

0 commit comments

Comments
 (0)