Skip to content

Commit 46ebc52

Browse files
author
github-actions
committed
Update REST API documentation Fri Aug 8 10:26:46 UTC 2025
1 parent 31ca3d8 commit 46ebc52

File tree

1 file changed

+282
-0
lines changed

1 file changed

+282
-0
lines changed

‎restapi.json

Lines changed: 282 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2682,6 +2682,284 @@
26822682
}
26832683
}
26842684
},
2685+
"/api/v2/blacklist/check/{email}": {
2686+
"get": {
2687+
"tags": [
2688+
"blacklist"
2689+
],
2690+
"summary": "Check if email is blacklisted",
2691+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
2692+
"operationId": "8f5aba09fc00fd3dc8cc76e65a7daf95",
2693+
"parameters": [
2694+
{
2695+
"name": "php-auth-pw",
2696+
"in": "header",
2697+
"description": "Session key obtained from login",
2698+
"required": true,
2699+
"schema": {
2700+
"type": "string"
2701+
}
2702+
},
2703+
{
2704+
"name": "email",
2705+
"in": "path",
2706+
"description": "Email address to check",
2707+
"required": true,
2708+
"schema": {
2709+
"type": "string"
2710+
}
2711+
}
2712+
],
2713+
"responses": {
2714+
"200": {
2715+
"description": "Success",
2716+
"content": {
2717+
"application/json": {
2718+
"schema": {
2719+
"properties": {
2720+
"blacklisted": {
2721+
"type": "boolean"
2722+
},
2723+
"reason": {
2724+
"type": "string",
2725+
"nullable": true
2726+
}
2727+
},
2728+
"type": "object"
2729+
}
2730+
}
2731+
}
2732+
},
2733+
"403": {
2734+
"description": "Failure",
2735+
"content": {
2736+
"application/json": {
2737+
"schema": {
2738+
"$ref": "#/components/schemas/UnauthorizedResponse"
2739+
}
2740+
}
2741+
}
2742+
}
2743+
}
2744+
}
2745+
},
2746+
"/api/v2/blacklist/add": {
2747+
"post": {
2748+
"tags": [
2749+
"blacklist"
2750+
],
2751+
"summary": "Adds an email address to the blacklist.",
2752+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
2753+
"operationId": "7f78f4b5d64027dc48350d0fcaa638bb",
2754+
"parameters": [
2755+
{
2756+
"name": "php-auth-pw",
2757+
"in": "header",
2758+
"description": "Session key obtained from login",
2759+
"required": true,
2760+
"schema": {
2761+
"type": "string"
2762+
}
2763+
}
2764+
],
2765+
"requestBody": {
2766+
"description": "Email to blacklist",
2767+
"required": true,
2768+
"content": {
2769+
"application/json": {
2770+
"schema": {
2771+
"properties": {
2772+
"email": {
2773+
"type": "string"
2774+
},
2775+
"reason": {
2776+
"type": "string",
2777+
"nullable": true
2778+
}
2779+
},
2780+
"type": "object"
2781+
}
2782+
}
2783+
}
2784+
},
2785+
"responses": {
2786+
"201": {
2787+
"description": "Success",
2788+
"content": {
2789+
"application/json": {
2790+
"schema": {
2791+
"properties": {
2792+
"success": {
2793+
"type": "boolean"
2794+
},
2795+
"message": {
2796+
"type": "string"
2797+
}
2798+
},
2799+
"type": "object"
2800+
}
2801+
}
2802+
}
2803+
},
2804+
"403": {
2805+
"description": "Failure",
2806+
"content": {
2807+
"application/json": {
2808+
"schema": {
2809+
"$ref": "#/components/schemas/UnauthorizedResponse"
2810+
}
2811+
}
2812+
}
2813+
},
2814+
"422": {
2815+
"description": "Failure",
2816+
"content": {
2817+
"application/json": {
2818+
"schema": {
2819+
"$ref": "#/components/schemas/ValidationErrorResponse"
2820+
}
2821+
}
2822+
}
2823+
}
2824+
}
2825+
}
2826+
},
2827+
"/api/v2/blacklist/remove/{email}": {
2828+
"delete": {
2829+
"tags": [
2830+
"blacklist"
2831+
],
2832+
"summary": "Removes an email address from the blacklist.",
2833+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
2834+
"operationId": "38e6653f87e655e0f8f2a64eb9506f73",
2835+
"parameters": [
2836+
{
2837+
"name": "php-auth-pw",
2838+
"in": "header",
2839+
"description": "Session key obtained from login",
2840+
"required": true,
2841+
"schema": {
2842+
"type": "string"
2843+
}
2844+
},
2845+
{
2846+
"name": "email",
2847+
"in": "path",
2848+
"description": "Email address to remove from blacklist",
2849+
"required": true,
2850+
"schema": {
2851+
"type": "string"
2852+
}
2853+
}
2854+
],
2855+
"responses": {
2856+
"200": {
2857+
"description": "Success",
2858+
"content": {
2859+
"application/json": {
2860+
"schema": {
2861+
"properties": {
2862+
"success": {
2863+
"type": "boolean"
2864+
},
2865+
"message": {
2866+
"type": "string"
2867+
}
2868+
},
2869+
"type": "object"
2870+
}
2871+
}
2872+
}
2873+
},
2874+
"403": {
2875+
"description": "Failure",
2876+
"content": {
2877+
"application/json": {
2878+
"schema": {
2879+
"$ref": "#/components/schemas/UnauthorizedResponse"
2880+
}
2881+
}
2882+
}
2883+
}
2884+
}
2885+
}
2886+
},
2887+
"/api/v2/blacklist/info/{email}": {
2888+
"get": {
2889+
"tags": [
2890+
"blacklist"
2891+
],
2892+
"summary": "Gets detailed information about a blacklisted email.",
2893+
"description": "🚧 **Status: Beta** – This method is under development. Avoid using in production.",
2894+
"operationId": "ad7bb11ee621df03163c16daf9b7d24d",
2895+
"parameters": [
2896+
{
2897+
"name": "php-auth-pw",
2898+
"in": "header",
2899+
"description": "Session key obtained from login",
2900+
"required": true,
2901+
"schema": {
2902+
"type": "string"
2903+
}
2904+
},
2905+
{
2906+
"name": "email",
2907+
"in": "path",
2908+
"description": "Email address to get information for",
2909+
"required": true,
2910+
"schema": {
2911+
"type": "string"
2912+
}
2913+
}
2914+
],
2915+
"responses": {
2916+
"200": {
2917+
"description": "Success",
2918+
"content": {
2919+
"application/json": {
2920+
"schema": {
2921+
"properties": {
2922+
"email": {
2923+
"type": "string"
2924+
},
2925+
"added": {
2926+
"type": "string",
2927+
"format": "date-time",
2928+
"nullable": true
2929+
},
2930+
"reason": {
2931+
"type": "string",
2932+
"nullable": true
2933+
}
2934+
},
2935+
"type": "object"
2936+
}
2937+
}
2938+
}
2939+
},
2940+
"403": {
2941+
"description": "Failure",
2942+
"content": {
2943+
"application/json": {
2944+
"schema": {
2945+
"$ref": "#/components/schemas/UnauthorizedResponse"
2946+
}
2947+
}
2948+
}
2949+
},
2950+
"404": {
2951+
"description": "Failure",
2952+
"content": {
2953+
"application/json": {
2954+
"schema": {
2955+
"$ref": "#/components/schemas/BadRequestResponse"
2956+
}
2957+
}
2958+
}
2959+
}
2960+
}
2961+
}
2962+
},
26852963
"/api/v2/lists/{listId}/subscribers": {
26862964
"get": {
26872965
"tags": [
@@ -5765,6 +6043,10 @@
57656043
"name": "analytics",
57666044
"description": "analytics"
57676045
},
6046+
{
6047+
"name": "blacklist",
6048+
"description": "blacklist"
6049+
},
57686050
{
57696051
"name": "subscriptions",
57706052
"description": "subscriptions"

0 commit comments

Comments
 (0)