{ "openapi": "3.0.3", "info": { "title": "Apex Atlanta LLC REST API", "description": "Apex Atlanta LLC", "version": "7.1.4" }, "servers": [ { "url": "https://www.apexatlanta.com/", "description": "Apex Atlanta LLC" } ], "paths": { "/aios/v1/onboarding": { "get": { "summary": "GET /aios/v1/onboarding", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "aios/v1/onboarding" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/aios/v1/onboarding/tfa_key_is_valid": { "post": { "summary": "POST /aios/v1/onboarding/tfa_key_is_valid", "responses": { "200": { "description": "Successful response" } } } }, "/ajaco/v1": { "get": { "summary": "GET /ajaco/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "ajaco/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/ajaco/v1/external": { "get": { "summary": "GET /ajaco/v1/external", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "refresh", "in": "query", "schema": { "type": "boolean" } } ] } }, "/ajaco/v1/fix": { "post": { "summary": "POST /ajaco/v1/fix", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "check": { "type": "string" } }, "required": [ "check" ] } } } } } }, "/ajaco/v1/health": { "get": { "summary": "GET /ajaco/v1/health", "responses": { "200": { "description": "Successful response" } } } }, "/ajaco/v1/llms/preview": { "post": { "summary": "POST /ajaco/v1/llms/preview", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "config": { "type": "object", "description": "Unsaved llms.txt curation config to preview. Omit to preview the saved config." } } } } } } } }, "/ajaco/v1/scan": { "get": { "summary": "GET /ajaco/v1/scan", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /ajaco/v1/scan", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "checks": { "type": "array", "items": { "type": "string" } } } } } } } } }, "/ajaco/v1/scan/check": { "post": { "summary": "POST /ajaco/v1/scan/check", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "check": { "type": "string" } }, "required": [ "check" ] } } } } } }, "/batch/v1": { "post": { "summary": "POST /batch/v1", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "validation": { "type": "string", "default": "normal", "enum": [ "require-all-validate", "normal" ] }, "requests": { "type": "array", "items": { "type": "object", "properties": { "method": { "type": "string", "enum": [ "POST", "PUT", "PATCH", "DELETE" ], "default": "POST" }, "path": { "type": "string", "required": true }, "body": { "type": "object", "properties": [], "additionalProperties": true }, "headers": { "type": "object", "properties": [], "additionalProperties": { "type": [ "string", "array" ], "items": { "type": "string" } } } } } } }, "required": [ "requests" ] } } } } } }, "/bsf-custom-fonts/v1": { "get": { "summary": "GET /bsf-custom-fonts/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "bsf-custom-fonts/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/bsf-custom-fonts/v1/admin/settings": { "get": { "summary": "GET /bsf-custom-fonts/v1/admin/settings", "responses": { "200": { "description": "Successful response" } } } }, "/code-snippets/v1": { "get": { "summary": "GET /code-snippets/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "code-snippets/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/code-snippets/v1/cloud/snippets": { "get": { "summary": "GET /code-snippets/v1/cloud/snippets", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "query", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Search query." }, { "name": "searchByCodevault", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Treat the search query as the name of a CodeVault instead of a search term." }, { "name": "searchMethod", "in": "query", "schema": { "type": "string", "default": "term", "enum": [ "term", "codevault", "ai" ] }, "description": "Optional search method. Set to "ai" to match snippets by natural-language intent." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "category", "in": "query", "schema": { "type": "string", "default": "" }, "description": "Filter by category ID." }, { "name": "type", "in": "query", "schema": { "type": "string", "default": "" }, "description": "Filter by language/type ID." }, { "name": "status", "in": "query", "schema": { "type": "string", "default": "" }, "description": "Filter by status ID." } ] } }, "/code-snippets/v1/cloud/snippets/featured": { "get": { "summary": "GET /code-snippets/v1/cloud/snippets/featured", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "category", "in": "query", "schema": { "type": "string", "default": "" }, "description": "Filter by category ID." }, { "name": "type", "in": "query", "schema": { "type": "string", "default": "" }, "description": "Filter by language/type ID." }, { "name": "status", "in": "query", "schema": { "type": "string", "default": "" }, "description": "Filter by status ID." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." } ] } }, "/code-snippets/v1/cloud/snippets/{id}/download": { "post": { "summary": "POST /code-snippets/v1/cloud/snippets/{id}/download", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "number" }, "description": "Cloud snippet ID." } ] } }, "/code-snippets/v1/feedback": { "post": { "summary": "POST /code-snippets/v1/feedback", "responses": { "200": { "description": "Successful response" } } } }, "/code-snippets/v1/feedback/search": { "get": { "summary": "GET /code-snippets/v1/feedback/search", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Report title to look for." } ] } }, "/code-snippets/v1/import/file-upload/import": { "post": { "summary": "POST /code-snippets/v1/import/file-upload/import", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "snippets": { "type": "array", "items": { "type": "string" }, "description": "Snippet data to import" }, "duplicate_action": { "type": "string", "default": "ignore", "enum": [ "ignore", "replace", "skip" ], "description": "Action to take when duplicate snippets are found" }, "network": { "type": "boolean", "default": false, "description": "Whether to import to network table" } }, "required": [ "snippets" ] } } } } } }, "/code-snippets/v1/import/file-upload/parse": { "post": { "summary": "POST /code-snippets/v1/import/file-upload/parse", "responses": { "200": { "description": "Successful response" } } } }, "/code-snippets/v1/import/plugins": { "get": { "summary": "GET /code-snippets/v1/import/plugins", "responses": { "200": { "description": "Successful response" } } } }, "/code-snippets/v1/import/plugins/header-footer-code-manager": { "get": { "summary": "GET /code-snippets/v1/import/plugins/header-footer-code-manager", "responses": { "200": { "description": "Successful response" } } } }, "/code-snippets/v1/import/plugins/header-footer-code-manager/import": { "post": { "summary": "POST /code-snippets/v1/import/plugins/header-footer-code-manager/import", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "network": { "type": "boolean" }, "auto_add_tags": { "type": "boolean" }, "tag_value": { "type": "string" } } } } } } } }, "/code-snippets/v1/import/plugins/insert-headers-and-footers": { "get": { "summary": "GET /code-snippets/v1/import/plugins/insert-headers-and-footers", "responses": { "200": { "description": "Successful response" } } } }, "/code-snippets/v1/import/plugins/insert-headers-and-footers/import": { "post": { "summary": "POST /code-snippets/v1/import/plugins/insert-headers-and-footers/import", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "network": { "type": "boolean" }, "auto_add_tags": { "type": "boolean" }, "tag_value": { "type": "string" } } } } } } } }, "/code-snippets/v1/import/plugins/insert-php-code-snippet": { "get": { "summary": "GET /code-snippets/v1/import/plugins/insert-php-code-snippet", "responses": { "200": { "description": "Successful response" } } } }, "/code-snippets/v1/import/plugins/insert-php-code-snippet/import": { "post": { "summary": "POST /code-snippets/v1/import/plugins/insert-php-code-snippet/import", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "string" } }, "network": { "type": "boolean" }, "auto_add_tags": { "type": "boolean" }, "tag_value": { "type": "string" } } } } } } } }, "/code-snippets/v1/preferences/demos-seen": { "get": { "summary": "GET /code-snippets/v1/preferences/demos-seen", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /code-snippets/v1/preferences/demos-seen", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "demo": { "type": "string", "enum": [ "ai-agent", "blueprints", "unified-snippets" ], "description": "Identifier of the feature demo that has been watched." } }, "required": [ "demo" ] } } } } }, "put": { "summary": "PUT /code-snippets/v1/preferences/demos-seen", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "demo": { "type": "string", "enum": [ "ai-agent", "blueprints", "unified-snippets" ], "description": "Identifier of the feature demo that has been watched." } }, "required": [ "demo" ] } } } } }, "patch": { "summary": "PATCH /code-snippets/v1/preferences/demos-seen", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "demo": { "type": "string", "enum": [ "ai-agent", "blueprints", "unified-snippets" ], "description": "Identifier of the feature demo that has been watched." } }, "required": [ "demo" ] } } } } } }, "/code-snippets/v1/preferences/snippet-view": { "get": { "summary": "GET /code-snippets/v1/preferences/snippet-view", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /code-snippets/v1/preferences/snippet-view", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "type": "string", "enum": [ "card", "table" ], "description": "Whether snippet lists display as a grid of cards or a table." } }, "required": [ "view" ] } } } } }, "put": { "summary": "PUT /code-snippets/v1/preferences/snippet-view", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "type": "string", "enum": [ "card", "table" ], "description": "Whether snippet lists display as a grid of cards or a table." } }, "required": [ "view" ] } } } } }, "patch": { "summary": "PATCH /code-snippets/v1/preferences/snippet-view", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "view": { "type": "string", "enum": [ "card", "table" ], "description": "Whether snippet lists display as a grid of cards or a table." } }, "required": [ "view" ] } } } } } }, "/code-snippets/v1/preferences/stats-chart-views": { "get": { "summary": "GET /code-snippets/v1/preferences/stats-chart-views", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /code-snippets/v1/preferences/stats-chart-views", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "views": { "type": "object", "description": "Supported chart-specific view for each Stats chart; tags also supports the cloud view." } }, "required": [ "views" ] } } } } }, "put": { "summary": "PUT /code-snippets/v1/preferences/stats-chart-views", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "views": { "type": "object", "description": "Supported chart-specific view for each Stats chart; tags also supports the cloud view." } }, "required": [ "views" ] } } } } }, "patch": { "summary": "PATCH /code-snippets/v1/preferences/stats-chart-views", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "views": { "type": "object", "description": "Supported chart-specific view for each Stats chart; tags also supports the cloud view." } }, "required": [ "views" ] } } } } } }, "/code-snippets/v1/recently-active": { "get": { "summary": "GET /code-snippets/v1/recently-active", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "network", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Fetch the recent list for network-wide snippets instead of site-wide." } ] }, "delete": { "summary": "DELETE /code-snippets/v1/recently-active", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "network", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Clear the recent list for network-wide snippets instead of site-wide." } ] } }, "/code-snippets/v1/search": { "get": { "summary": "GET /code-snippets/v1/search", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "q", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Text to search for." }, { "name": "sources", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "snippets", "settings", "stats", "welcome", "docs", "community" ] }, "default": [ "snippets", "settings", "stats", "welcome", "docs", "community" ] }, "description": "Sources to search. Defaults to every source." }, { "name": "fields", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "title", "description", "code" ] }, "default": [ "title", "description", "code" ] }, "description": "Fields to match the search text against. Defaults to every field." }, { "name": "method", "in": "query", "schema": { "type": "string", "default": "term", "enum": [ "term", "ai" ] }, "description": "How to search the cloud: by keyword, or with AI." }, { "name": "per_source", "in": "query", "schema": { "type": "integer", "default": 50 }, "description": "Largest number of results to return for each source." }, { "name": "excerpts", "in": "query", "schema": { "type": "boolean", "default": true }, "description": "Whether to shorten long descriptions to an excerpt around the match." }, { "name": "network", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Search network-wide snippets instead of site-wide." } ] } }, "/code-snippets/v1/snippets": { "get": { "summary": "GET /code-snippets/v1/snippets", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "status", "in": "query", "schema": { "type": "string", "default": "all", "enum": [ "all", "active", "inactive" ] }, "description": "Filter snippets by activation status." }, { "name": "exclude_types", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "default": [] }, "description": "List of snippet types to exclude from the response." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "enum": [ "id", "name", "display_name" ] }, "description": "Sort collection by object attribute." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Sort direction." } ] }, "post": { "summary": "POST /code-snippets/v1/snippets", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Descriptive title for the snippet." }, "desc": { "type": "string", "description": "Descriptive text associated with snippet." }, "code": { "type": "string", "description": "Executable snippet code." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag categories the snippet belongs to." }, "scope": { "type": "string", "enum": [ "global", "admin", "front-end", "single-use", "content", "head-content", "body-content", "footer-content", "admin-css", "site-css", "site-head-js", "site-footer-js", "condition" ], "description": "Context in which the snippet is executable." }, "condition_id": { "type": "integer", "description": "Identifier of condition linked to this snippet." }, "active": { "type": "boolean", "description": "Snippet activation status." }, "locked": { "type": "boolean", "description": "Whether the snippet is locked from modification or deletion." }, "priority": { "type": "integer", "description": "Relative priority in which the snippet is executed." }, "network": { "type": "boolean", "description": "Whether the snippet is network-wide instead of site-wide." }, "shared_network": { "type": "boolean", "description": "If a network snippet, whether can be activated on discrete sites instead of network-wide." } } } } } } } }, "/code-snippets/v1/snippets/schema": { "get": { "summary": "GET /code-snippets/v1/snippets/schema", "responses": { "200": { "description": "Successful response" } } } }, "/code-snippets/v1/snippets/{id}": { "get": { "summary": "GET /code-snippets/v1/snippets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /code-snippets/v1/snippets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Descriptive title for the snippet." }, "desc": { "type": "string", "description": "Descriptive text associated with snippet." }, "code": { "type": "string", "description": "Executable snippet code." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag categories the snippet belongs to." }, "scope": { "type": "string", "enum": [ "global", "admin", "front-end", "single-use", "content", "head-content", "body-content", "footer-content", "admin-css", "site-css", "site-head-js", "site-footer-js", "condition" ], "description": "Context in which the snippet is executable." }, "condition_id": { "type": "integer", "description": "Identifier of condition linked to this snippet." }, "active": { "type": "boolean", "description": "Snippet activation status." }, "locked": { "type": "boolean", "description": "Whether the snippet is locked from modification or deletion." }, "priority": { "type": "integer", "description": "Relative priority in which the snippet is executed." }, "network": { "type": "boolean", "description": "Whether the snippet is network-wide instead of site-wide." }, "shared_network": { "type": "boolean", "description": "If a network snippet, whether can be activated on discrete sites instead of network-wide." } } } } } } }, "put": { "summary": "PUT /code-snippets/v1/snippets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Descriptive title for the snippet." }, "desc": { "type": "string", "description": "Descriptive text associated with snippet." }, "code": { "type": "string", "description": "Executable snippet code." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag categories the snippet belongs to." }, "scope": { "type": "string", "enum": [ "global", "admin", "front-end", "single-use", "content", "head-content", "body-content", "footer-content", "admin-css", "site-css", "site-head-js", "site-footer-js", "condition" ], "description": "Context in which the snippet is executable." }, "condition_id": { "type": "integer", "description": "Identifier of condition linked to this snippet." }, "active": { "type": "boolean", "description": "Snippet activation status." }, "locked": { "type": "boolean", "description": "Whether the snippet is locked from modification or deletion." }, "priority": { "type": "integer", "description": "Relative priority in which the snippet is executed." }, "network": { "type": "boolean", "description": "Whether the snippet is network-wide instead of site-wide." }, "shared_network": { "type": "boolean", "description": "If a network snippet, whether can be activated on discrete sites instead of network-wide." } } } } } } }, "patch": { "summary": "PATCH /code-snippets/v1/snippets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "Descriptive title for the snippet." }, "desc": { "type": "string", "description": "Descriptive text associated with snippet." }, "code": { "type": "string", "description": "Executable snippet code." }, "tags": { "type": "array", "items": { "type": "string" }, "description": "List of tag categories the snippet belongs to." }, "scope": { "type": "string", "enum": [ "global", "admin", "front-end", "single-use", "content", "head-content", "body-content", "footer-content", "admin-css", "site-css", "site-head-js", "site-footer-js", "condition" ], "description": "Context in which the snippet is executable." }, "condition_id": { "type": "integer", "description": "Identifier of condition linked to this snippet." }, "active": { "type": "boolean", "description": "Snippet activation status." }, "locked": { "type": "boolean", "description": "Whether the snippet is locked from modification or deletion." }, "priority": { "type": "integer", "description": "Relative priority in which the snippet is executed." }, "network": { "type": "boolean", "description": "Whether the snippet is network-wide instead of site-wide." }, "shared_network": { "type": "boolean", "description": "If a network snippet, whether can be activated on discrete sites instead of network-wide." } } } } } } }, "delete": { "summary": "DELETE /code-snippets/v1/snippets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/code-snippets/v1/snippets/{id}/activate": { "post": { "summary": "POST /code-snippets/v1/snippets/{id}/activate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /code-snippets/v1/snippets/{id}/activate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /code-snippets/v1/snippets/{id}/activate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/code-snippets/v1/snippets/{id}/deactivate": { "post": { "summary": "POST /code-snippets/v1/snippets/{id}/deactivate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /code-snippets/v1/snippets/{id}/deactivate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /code-snippets/v1/snippets/{id}/deactivate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/code-snippets/v1/snippets/{id}/export": { "get": { "summary": "GET /code-snippets/v1/snippets/{id}/export", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/code-snippets/v1/snippets/{id}/export-code": { "get": { "summary": "GET /code-snippets/v1/snippets/{id}/export-code", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/code-snippets/v1/snippets/{id}/restore": { "post": { "summary": "POST /code-snippets/v1/snippets/{id}/restore", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /code-snippets/v1/snippets/{id}/restore", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /code-snippets/v1/snippets/{id}/restore", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/custom-fonts/v1": { "get": { "summary": "GET /custom-fonts/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "custom-fonts/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/custom-fonts/v1/get-tracking-status": { "get": { "summary": "GET /custom-fonts/v1/get-tracking-status", "responses": { "200": { "description": "Successful response" } } } }, "/custom-fonts/v1/update-tracking-status": { "post": { "summary": "POST /custom-fonts/v1/update-tracking-status", "responses": { "200": { "description": "Successful response" } } } }, "/elementor-ai/v1": { "get": { "summary": "GET /elementor-ai/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "elementor-ai/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/elementor-ai/v1/permissions": { "get": { "summary": "GET /elementor-ai/v1/permissions", "responses": { "200": { "description": "Successful response" } } } }, "/elementor-hello-elementor/v1": { "get": { "summary": "GET /elementor-hello-elementor/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "elementor-hello-elementor/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/elementor-hello-elementor/v1/admin-settings": { "get": { "summary": "GET /elementor-hello-elementor/v1/admin-settings", "responses": { "200": { "description": "Successful response" } } } }, "/elementor-hello-elementor/v1/theme-settings": { "get": { "summary": "GET /elementor-hello-elementor/v1/theme-settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /elementor-hello-elementor/v1/theme-settings", "responses": { "200": { "description": "Successful response" } } }, "put": { "summary": "PUT /elementor-hello-elementor/v1/theme-settings", "responses": { "200": { "description": "Successful response" } } }, "patch": { "summary": "PATCH /elementor-hello-elementor/v1/theme-settings", "responses": { "200": { "description": "Successful response" } } } }, "/elementor-hello-elementor/v1/whats-new": { "get": { "summary": "GET /elementor-hello-elementor/v1/whats-new", "responses": { "200": { "description": "Successful response" } } } }, "/elementor-mcp-composer/v1.0.19": { "get": { "summary": "GET /elementor-mcp-composer/v1.0.19", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "elementor-mcp-composer/v1.0.19" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/elementor-mcp-composer/v1.0.19/mcp-credentials": { "post": { "summary": "POST /elementor-mcp-composer/v1.0.19/mcp-credentials", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "client": { "type": "string", "enum": [ "claude-code", "claude-desktop", "codex", "cursor", "other" ] } }, "required": [ "client" ] } } } } } }, "/elementor-mcp-composer/v1.0.19/mcp-settings": { "get": { "summary": "GET /elementor-mcp-composer/v1.0.19/mcp-settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /elementor-mcp-composer/v1.0.19/mcp-settings", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] } } } } } }, "/elementor-one/v1": { "get": { "summary": "GET /elementor-one/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "elementor-one/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/elementor-one/v1/connect/authorize": { "post": { "summary": "POST /elementor-one/v1/connect/authorize", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "clearSession": { "type": "boolean", "default": false } } } } } } } }, "/elementor-one/v1/connect/deactivate": { "post": { "summary": "POST /elementor-one/v1/connect/deactivate", "responses": { "200": { "description": "Successful response" } } } }, "/elementor-one/v1/connect/disconnect": { "post": { "summary": "POST /elementor-one/v1/connect/disconnect", "responses": { "200": { "description": "Successful response" } } } }, "/elementor-one/v1/connect/switch-domain": { "post": { "summary": "POST /elementor-one/v1/connect/switch-domain", "responses": { "200": { "description": "Successful response" } } } }, "/elementor-one/v1/logs": { "get": { "summary": "GET /elementor-one/v1/logs", "responses": { "200": { "description": "Successful response" } } }, "delete": { "summary": "DELETE /elementor-one/v1/logs", "responses": { "200": { "description": "Successful response" } } } }, "/elementor-one/v1/manage-dashboard-widget/state": { "get": { "summary": "GET /elementor-one/v1/manage-dashboard-widget/state", "responses": { "200": { "description": "Successful response" } } } }, "/elementor-one/v1/plugins": { "get": { "summary": "GET /elementor-one/v1/plugins", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "inactive", "active" ] } }, "description": "Limits results to plugins with the given status." } ] }, "post": { "summary": "POST /elementor-one/v1/plugins", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "enum": [ "angie", "manage", "elementor", "elementor-pro", "site-mailer", "image-optimization", "pojo-accessibility", "cookiez", "aryo-activity-log" ], "description": "WordPress.org plugin directory slug." }, "status": { "type": "string", "default": "inactive", "enum": [ "inactive", "active" ], "description": "The plugin activation status." } }, "required": [ "slug" ] } } } } } }, "/elementor-one/v1/plugins/{slug}/activate": { "post": { "summary": "POST /elementor-one/v1/plugins/{slug}/activate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "angie", "manage", "elementor", "elementor-pro", "site-mailer", "image-optimization", "pojo-accessibility", "cookiez", "aryo-activity-log" ] }, "description": "WordPress.org plugin directory slug." } ] } }, "/elementor-one/v1/plugins/{slug}/deactivate": { "post": { "summary": "POST /elementor-one/v1/plugins/{slug}/deactivate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "angie", "manage", "elementor", "elementor-pro", "site-mailer", "image-optimization", "pojo-accessibility", "cookiez", "aryo-activity-log" ] }, "description": "WordPress.org plugin directory slug." } ] } }, "/elementor-one/v1/plugins/{slug}/migration/rollback": { "post": { "summary": "POST /elementor-one/v1/plugins/{slug}/migration/rollback", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "manage", "elementor", "elementor-pro", "site-mailer", "image-optimization", "pojo-accessibility", "cookiez", "aryo-activity-log" ] }, "description": "WordPress.org plugin directory slug." } ] } }, "/elementor-one/v1/plugins/{slug}/migration/run": { "post": { "summary": "POST /elementor-one/v1/plugins/{slug}/migration/run", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "manage", "elementor", "elementor-pro", "site-mailer", "image-optimization", "pojo-accessibility", "cookiez", "aryo-activity-log" ] }, "description": "WordPress.org plugin directory slug." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "force": { "type": "boolean", "default": true, "description": "Force migration even if the plugin is already connected." } } } } } } } }, "/elementor-one/v1/plugins/{slug}/upgrade": { "post": { "summary": "POST /elementor-one/v1/plugins/{slug}/upgrade", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string", "enum": [ "angie", "manage", "elementor", "elementor-pro", "site-mailer", "image-optimization", "pojo-accessibility", "cookiez", "aryo-activity-log" ] }, "description": "WordPress.org plugin directory slug." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "active" ], "description": "The plugin activation status." } } } } } } } }, "/elementor-one/v1/settings": { "get": { "summary": "GET /elementor-one/v1/settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /elementor-one/v1/settings", "responses": { "200": { "description": "Successful response" } } }, "put": { "summary": "PUT /elementor-one/v1/settings", "responses": { "200": { "description": "Successful response" } } }, "patch": { "summary": "PATCH /elementor-one/v1/settings", "responses": { "200": { "description": "Successful response" } } } }, "/elementor-one/v1/themes": { "post": { "summary": "POST /elementor-one/v1/themes", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "WordPress.org theme directory slug." }, "status": { "type": "string", "default": "inactive", "enum": [ "inactive", "active" ], "description": "The theme activation status." } }, "required": [ "slug" ] } } } } } }, "/elementor-one/v1/themes/{slug}/activate": { "post": { "summary": "POST /elementor-one/v1/themes/{slug}/activate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" }, "description": "WordPress.org theme directory slug." } ] } }, "/elementor-one/v1/top-bar/feedback": { "post": { "summary": "POST /elementor-one/v1/top-bar/feedback", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "product": { "type": "string" }, "subject": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "countryCode": { "type": "string" } }, "required": [ "product", "subject", "title", "description" ] } } } } } }, "/elementor-one/v1/top-bar/notifications": { "get": { "summary": "GET /elementor-one/v1/top-bar/notifications", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "app_name", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "app_version", "in": "query", "schema": { "type": "string" }, "required": true } ] } }, "/elementor/v1": { "get": { "summary": "GET /elementor/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "elementor/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/elementor/v1/angie/consent": { "post": { "summary": "POST /elementor/v1/angie/consent", "responses": { "200": { "description": "Successful response" } } } }, "/elementor/v1/cache": { "delete": { "summary": "DELETE /elementor/v1/cache", "responses": { "200": { "description": "Successful response" } } } }, "/elementor/v1/design-system-sync/stylesheet": { "post": { "summary": "POST /elementor/v1/design-system-sync/stylesheet", "responses": { "200": { "description": "Successful response" } } } }, "/elementor/v1/documents": { "get": { "summary": "GET /elementor/v1/documents", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "elementor/v1/documents" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/elementor/v1/documents/{id}/media/import": { "post": { "summary": "POST /elementor/v1/documents/{id}/media/import", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/elementor/v1/events/api/{path}": { "get": { "summary": "GET /elementor/v1/events/api/{path}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "path", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /elementor/v1/events/api/{path}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "path", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/elementor/v1/events/libs/{file}": { "get": { "summary": "GET /elementor/v1/events/libs/{file}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "file", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/elementor/v1/favorites": { "get": { "summary": "GET /elementor/v1/favorites", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." } ] } }, "/elementor/v1/favorites/{id}": { "post": { "summary": "POST /elementor/v1/favorites/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Type of favorites." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "favorite": { "type": "string", "description": "The favorite slug to create." } }, "required": [ "favorite" ] } } } } }, "delete": { "summary": "DELETE /elementor/v1/favorites/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Type of favorites." }, { "name": "favorite", "in": "query", "schema": { "type": "string" }, "required": true, "description": "The favorite slug to delete." } ] } }, "/elementor/v1/feedback": { "get": { "summary": "GET /elementor/v1/feedback", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "elementor/v1/feedback" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/elementor/v1/feedback/submit": { "post": { "summary": "POST /elementor/v1/feedback/submit", "responses": { "200": { "description": "Successful response" } } } }, "/elementor/v1/globals": { "get": { "summary": "GET /elementor/v1/globals", "responses": { "200": { "description": "Successful response" } } } }, "/elementor/v1/globals/colors": { "get": { "summary": "GET /elementor/v1/globals/colors", "responses": { "200": { "description": "Successful response" } } } }, "/elementor/v1/globals/colors/{id}": { "get": { "summary": "GET /elementor/v1/globals/colors/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the object." } ] }, "post": { "summary": "POST /elementor/v1/globals/colors/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the object." } ] }, "delete": { "summary": "DELETE /elementor/v1/globals/colors/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the object." } ] } }, "/elementor/v1/globals/typography": { "get": { "summary": "GET /elementor/v1/globals/typography", "responses": { "200": { "description": "Successful response" } } } }, "/elementor/v1/globals/typography/{id}": { "get": { "summary": "GET /elementor/v1/globals/typography/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the object." } ] }, "post": { "summary": "POST /elementor/v1/globals/typography/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the object." } ] }, "delete": { "summary": "DELETE /elementor/v1/globals/typography/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the object." } ] } }, "/elementor/v1/kit-elements-defaults": { "get": { "summary": "GET /elementor/v1/kit-elements-defaults", "responses": { "200": { "description": "Successful response" } } } }, "/elementor/v1/kit-elements-defaults/{type}": { "post": { "summary": "POST /elementor/v1/kit-elements-defaults/{type}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The type of the element." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "settings": { "type": "object", "description": "All the default values for the requested type" } }, "required": [ "settings" ] } } } } }, "put": { "summary": "PUT /elementor/v1/kit-elements-defaults/{type}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The type of the element." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "settings": { "type": "object", "description": "All the default values for the requested type" } }, "required": [ "settings" ] } } } } }, "patch": { "summary": "PATCH /elementor/v1/kit-elements-defaults/{type}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The type of the element." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "settings": { "type": "object", "description": "All the default values for the requested type" } }, "required": [ "settings" ] } } } } }, "delete": { "summary": "DELETE /elementor/v1/kit-elements-defaults/{type}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The type of the element." } ] } }, "/elementor/v1/library/connect": { "post": { "summary": "POST /elementor/v1/library/connect", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "token": { "type": "string", "description": "Connect CLI token" } }, "required": [ "token" ] } } } } }, "delete": { "summary": "DELETE /elementor/v1/library/connect", "responses": { "200": { "description": "Successful response" } } } }, "/elementor/v1/mcp-proxy": { "post": { "summary": "POST /elementor/v1/mcp-proxy", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tool": { "type": "string" }, "input": { "type": "object" } }, "required": [ "tool", "input" ] } } } } }, "get": { "summary": "GET /elementor/v1/mcp-proxy", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "uri", "in": "query", "schema": { "type": "string" }, "required": true } ] } }, "/elementor/v1/operations/opt-in-v4": { "post": { "summary": "POST /elementor/v1/operations/opt-in-v4", "responses": { "200": { "description": "Successful response" } } } }, "/elementor/v1/post": { "get": { "summary": "GET /elementor/v1/post", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "included_types", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Included post types" }, { "name": "excluded_types", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "default": [ "e-floating-buttons", "e-landing-page", "elementor_library", "attachment", "revision", "nav_menu_item", "custom_css", "customize_changeset" ] }, "description": "Post type to exclude" }, { "name": "term", "in": "query", "schema": { "type": "string", "default": "" }, "description": "Posts to search" }, { "name": "keys_conversion_map", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "default": { "ID": "id", "post_title": "label", "post_type": "groupLabel" } }, "description": "Specify keys to extract and convert, i.e. [\"key_1\" => \"new_key_1\"]." }, { "name": "items_count", "in": "query", "schema": { "type": "integer", "default": 100 }, "description": "Posts per page" }, { "name": "is_public", "in": "query", "schema": { "type": "boolean", "default": true }, "description": "Whether to include only public post types" }, { "name": "meta_query", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "WP_Query meta_query array" }, { "name": "tax_query", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "WP_Query tax_query array" }, { "name": "search_in_content", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to search within post content and excerpt in addition to title" } ] } }, "/elementor/v1/send-event": { "get": { "summary": "GET /elementor/v1/send-event", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string" }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." } ] }, "post": { "summary": "POST /elementor/v1/send-event", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "event_data": { "type": "object", "description": "All the recorded event data in JSON format" } }, "required": [ "event_data" ] } } } } } }, "/elementor/v1/settings/{key}": { "get": { "summary": "GET /elementor/v1/settings/{key}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /elementor/v1/settings/{key}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /elementor/v1/settings/{key}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /elementor/v1/settings/{key}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "key", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/elementor/v1/site-navigation/add-new-post": { "post": { "summary": "POST /elementor/v1/site-navigation/add-new-post", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "post_type": { "type": "string", "default": "post", "description": "Post type to create" } } } } } } } }, "/elementor/v1/site-navigation/recent-posts": { "get": { "summary": "GET /elementor/v1/site-navigation/recent-posts", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "posts_per_page", "in": "query", "schema": { "type": "integer" }, "required": true, "description": "Number of posts to return" }, { "name": "post_type", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "default": [ "page", "post", "elementor_library" ] }, "description": "Post types to retrieve" }, { "name": "post__not_in", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Post id`s to exclude" } ] } }, "/elementor/v1/system-info": { "get": { "summary": "GET /elementor/v1/system-info", "responses": { "200": { "description": "Successful response" } } } }, "/elementor/v1/template-library/templates": { "get": { "summary": "GET /elementor/v1/template-library/templates", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /elementor/v1/template-library/templates", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "The title of the document" }, "type": { "type": "string", "enum": [ "page", "section", "container" ], "description": "The document type." }, "content": { "type": "object", "description": "Elementor data object" } }, "required": [ "type" ] } } } } } }, "/elementor/v1/term": { "get": { "summary": "GET /elementor/v1/term", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "included_types", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Included taxonomy containing terms (categories, tags, etc...)" }, { "name": "excluded_types", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Excluded taxonomy containing terms (categories, tags, etc...)" }, { "name": "term", "in": "query", "schema": { "type": "string", "default": "" }, "description": "Terms to search" }, { "name": "keys_conversion_map", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "default": { "term_id": "id", "name": "label", "taxonomy": "groupLabel" } }, "description": "Specify keys to extract and convert, i.e. [\"key_1\" => \"new_key_1\"]." }, { "name": "items_count", "in": "query", "schema": { "type": "integer", "default": 100 }, "description": "Terms per request" }, { "name": "hide_empty", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to include only public terms" }, { "name": "meta_query", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "WP_Query meta_query array" } ] } }, "/elementor/v1/user": { "get": { "summary": "GET /elementor/v1/user", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "term", "in": "query", "schema": { "type": "string", "default": "" }, "description": "Users to search" }, { "name": "keys_conversion_map", "in": "query", "schema": { "type": "array", "items": { "type": "string" }, "default": { "ID": "id", "display_name": "label", "role": "groupLabel" } }, "description": "Specify keys to extract and convert, i.e. [\"key_1\" => \"new_key_1\"]." }, { "name": "items_count", "in": "query", "schema": { "type": "integer", "default": 100 }, "description": "Number of users to return" } ] } }, "/elementor/v1/user-data/current-user": { "get": { "summary": "GET /elementor/v1/user-data/current-user", "responses": { "200": { "description": "Successful response" } } }, "patch": { "summary": "PATCH /elementor/v1/user-data/current-user", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "suppressedMessages": { "type": "array", "items": { "type": "string" }, "description": "Array of suppressed message keys" } } } } } } } }, "/fluent-crm": { "get": { "summary": "GET /fluent-crm", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "fluent-crm" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/fluent-crm/mcp": { "post": { "summary": "POST /fluent-crm/mcp", "responses": { "200": { "description": "Successful response" } } }, "get": { "summary": "GET /fluent-crm/mcp", "responses": { "200": { "description": "Successful response" } } }, "delete": { "summary": "DELETE /fluent-crm/mcp", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v1": { "get": { "summary": "GET /fluent-crm/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "fluent-crm/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/fluent-crm/v1/editor-autosave": { "post": { "summary": "POST /fluent-crm/v1/editor-autosave", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2": { "get": { "summary": "GET /fluent-crm/v2", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "fluent-crm/v2" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/fluent-crm/v2/abandon-carts": { "get": { "summary": "GET /fluent-crm/v2/abandon-carts", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/abandon-carts/bulk-delete": { "post": { "summary": "POST /fluent-crm/v2/abandon-carts/bulk-delete", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/abandon-carts/report-summary": { "get": { "summary": "GET /fluent-crm/v2/abandon-carts/report-summary", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/ai/contact-summary": { "post": { "summary": "POST /fluent-crm/v2/ai/contact-summary", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/ai/generate": { "post": { "summary": "POST /fluent-crm/v2/ai/generate", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/ai/generate-email-body": { "post": { "summary": "POST /fluent-crm/v2/ai/generate-email-body", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/ai/models": { "post": { "summary": "POST /fluent-crm/v2/ai/models", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/ai/settings": { "get": { "summary": "GET /fluent-crm/v2/ai/settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/ai/settings", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/ai/test": { "post": { "summary": "POST /fluent-crm/v2/ai/test", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/campaigns": { "get": { "summary": "GET /fluent-crm/v2/campaigns", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/campaigns", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/campaigns/do-bulk-action": { "post": { "summary": "POST /fluent-crm/v2/campaigns/do-bulk-action", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/campaigns/email-preview-html": { "post": { "summary": "POST /fluent-crm/v2/campaigns/email-preview-html", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/campaigns/emails/{email_id}/preview": { "get": { "summary": "GET /fluent-crm/v2/campaigns/emails/{email_id}/preview", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "email_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/estimated-contacts": { "post": { "summary": "POST /fluent-crm/v2/campaigns/estimated-contacts", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/campaigns/send-test-email": { "post": { "summary": "POST /fluent-crm/v2/campaigns/send-test-email", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/campaigns/update-single-campaign": { "post": { "summary": "POST /fluent-crm/v2/campaigns/update-single-campaign", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/campaigns/{id}": { "get": { "summary": "GET /fluent-crm/v2/campaigns/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /fluent-crm/v2/campaigns/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/campaigns/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/contacts-by-segment": { "get": { "summary": "GET /fluent-crm/v2/campaigns/{id}/contacts-by-segment", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/draft-recipients": { "post": { "summary": "POST /fluent-crm/v2/campaigns/{id}/draft-recipients", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/duplicate": { "post": { "summary": "POST /fluent-crm/v2/campaigns/{id}/duplicate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/emails": { "get": { "summary": "GET /fluent-crm/v2/campaigns/{id}/emails", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/campaigns/{id}/emails", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/estimated-recipients-count": { "get": { "summary": "GET /fluent-crm/v2/campaigns/{id}/estimated-recipients-count", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/link-report": { "get": { "summary": "GET /fluent-crm/v2/campaigns/{id}/link-report", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/overview_stats": { "get": { "summary": "GET /fluent-crm/v2/campaigns/{id}/overview_stats", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/pause": { "post": { "summary": "POST /fluent-crm/v2/campaigns/{id}/pause", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/processing-stat": { "get": { "summary": "GET /fluent-crm/v2/campaigns/{id}/processing-stat", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/resume": { "post": { "summary": "POST /fluent-crm/v2/campaigns/{id}/resume", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/revenues": { "get": { "summary": "GET /fluent-crm/v2/campaigns/{id}/revenues", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/revenues/resync": { "post": { "summary": "POST /fluent-crm/v2/campaigns/{id}/revenues/resync", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/schedule": { "post": { "summary": "POST /fluent-crm/v2/campaigns/{id}/schedule", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/share-url": { "get": { "summary": "GET /fluent-crm/v2/campaigns/{id}/share-url", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/status": { "get": { "summary": "GET /fluent-crm/v2/campaigns/{id}/status", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/step": { "post": { "summary": "POST /fluent-crm/v2/campaigns/{id}/step", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/title": { "put": { "summary": "PUT /fluent-crm/v2/campaigns/{id}/title", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/un-schedule": { "post": { "summary": "POST /fluent-crm/v2/campaigns/{id}/un-schedule", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/unsubscribers": { "get": { "summary": "GET /fluent-crm/v2/campaigns/{id}/unsubscribers", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/campaigns/{id}/update-labels": { "put": { "summary": "PUT /fluent-crm/v2/campaigns/{id}/update-labels", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/companies": { "get": { "summary": "GET /fluent-crm/v2/companies", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/companies", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/companies/attach-subscribers": { "post": { "summary": "POST /fluent-crm/v2/companies/attach-subscribers", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/companies/companies-property": { "put": { "summary": "PUT /fluent-crm/v2/companies/companies-property", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/companies/csv-import": { "post": { "summary": "POST /fluent-crm/v2/companies/csv-import", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/companies/custom-fields": { "get": { "summary": "GET /fluent-crm/v2/companies/custom-fields", "responses": { "200": { "description": "Successful response" } } }, "put": { "summary": "PUT /fluent-crm/v2/companies/custom-fields", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/companies/custom-fields/update_group_name": { "put": { "summary": "PUT /fluent-crm/v2/companies/custom-fields/update_group_name", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/companies/detach-subscribers": { "post": { "summary": "POST /fluent-crm/v2/companies/detach-subscribers", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/companies/do-bulk-action": { "post": { "summary": "POST /fluent-crm/v2/companies/do-bulk-action", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/companies/search": { "get": { "summary": "GET /fluent-crm/v2/companies/search", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/companies/search-unattached-contacts": { "get": { "summary": "GET /fluent-crm/v2/companies/search-unattached-contacts", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/companies/{id}": { "get": { "summary": "GET /fluent-crm/v2/companies/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /fluent-crm/v2/companies/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/companies/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/companies/{id}/custom_tab_view": { "get": { "summary": "GET /fluent-crm/v2/companies/{id}/custom_tab_view", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/companies/{id}/notes": { "get": { "summary": "GET /fluent-crm/v2/companies/{id}/notes", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /fluent-crm/v2/companies/{id}/notes", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/companies/{id}/notes/bulk-delete": { "post": { "summary": "POST /fluent-crm/v2/companies/{id}/notes/bulk-delete", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/companies/{id}/notes/{note_id}": { "put": { "summary": "PUT /fluent-crm/v2/companies/{id}/notes/{note_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/companies/{id}/notes/{note_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/custom-fields/contacts": { "get": { "summary": "GET /fluent-crm/v2/custom-fields/contacts", "responses": { "200": { "description": "Successful response" } } }, "put": { "summary": "PUT /fluent-crm/v2/custom-fields/contacts", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/custom-fields/contacts/update_group_name": { "put": { "summary": "PUT /fluent-crm/v2/custom-fields/contacts/update_group_name", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/docs": { "get": { "summary": "GET /fluent-crm/v2/docs", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/docs/addons": { "get": { "summary": "GET /fluent-crm/v2/docs/addons", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/docs/{doc_id}": { "get": { "summary": "GET /fluent-crm/v2/docs/{doc_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "doc_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/editor-pattern-categories": { "get": { "summary": "GET /fluent-crm/v2/editor-pattern-categories", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/editor-pattern-categories", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/editor-patterns": { "get": { "summary": "GET /fluent-crm/v2/editor-patterns", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/editor-patterns", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/editor-patterns/{id}": { "get": { "summary": "GET /fluent-crm/v2/editor-patterns/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /fluent-crm/v2/editor-patterns/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /fluent-crm/v2/editor-patterns/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /fluent-crm/v2/editor-patterns/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/editor-patterns/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/editor/cart-products": { "get": { "summary": "GET /fluent-crm/v2/editor/cart-products", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/email-patterns": { "get": { "summary": "GET /fluent-crm/v2/email-patterns", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/email-patterns", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/email-patterns/categories": { "get": { "summary": "GET /fluent-crm/v2/email-patterns/categories", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/email-patterns/categories", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/email-patterns/categories/{id}": { "delete": { "summary": "DELETE /fluent-crm/v2/email-patterns/categories/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/email-patterns/do-bulk-action": { "post": { "summary": "POST /fluent-crm/v2/email-patterns/do-bulk-action", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/email-patterns/wp-format": { "get": { "summary": "GET /fluent-crm/v2/email-patterns/wp-format", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/email-patterns/wp-format", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/email-patterns/{id}": { "get": { "summary": "GET /fluent-crm/v2/email-patterns/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /fluent-crm/v2/email-patterns/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/email-patterns/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/forms": { "get": { "summary": "GET /fluent-crm/v2/forms", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/forms", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/forms/templates": { "get": { "summary": "GET /fluent-crm/v2/forms/templates", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/forms/{form_id}/entries/{id}": { "get": { "summary": "GET /fluent-crm/v2/forms/{form_id}/entries/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/forms/{id}/entries": { "get": { "summary": "GET /fluent-crm/v2/forms/{id}/entries", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels": { "get": { "summary": "GET /fluent-crm/v2/funnels", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/funnels", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/funnels/all-activities": { "get": { "summary": "GET /fluent-crm/v2/funnels/all-activities", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/funnels/create-from-template": { "post": { "summary": "POST /fluent-crm/v2/funnels/create-from-template", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/funnels/do-bulk-action": { "post": { "summary": "POST /fluent-crm/v2/funnels/do-bulk-action", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/funnels/funnel/save-email-action-fallback": { "post": { "summary": "POST /fluent-crm/v2/funnels/funnel/save-email-action-fallback", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/funnels/funnel/save-funnel-sequences": { "post": { "summary": "POST /fluent-crm/v2/funnels/funnel/save-funnel-sequences", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/funnels/funnel/{id}/title": { "put": { "summary": "PUT /fluent-crm/v2/funnels/funnel/{id}/title", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/import": { "post": { "summary": "POST /fluent-crm/v2/funnels/import", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/funnels/remove-bulk-subscribers": { "post": { "summary": "POST /fluent-crm/v2/funnels/remove-bulk-subscribers", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/funnels/send-test-webhook": { "post": { "summary": "POST /fluent-crm/v2/funnels/send-test-webhook", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/funnels/subscriber/{subscriber_id}/automations": { "get": { "summary": "GET /fluent-crm/v2/funnels/subscriber/{subscriber_id}/automations", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "subscriber_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/templates": { "get": { "summary": "GET /fluent-crm/v2/funnels/templates", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/funnels/triggers": { "get": { "summary": "GET /fluent-crm/v2/funnels/triggers", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/funnels/{id}": { "get": { "summary": "GET /fluent-crm/v2/funnels/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /fluent-crm/v2/funnels/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/funnels/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/{id}/change-trigger": { "put": { "summary": "PUT /fluent-crm/v2/funnels/{id}/change-trigger", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/{id}/clone": { "post": { "summary": "POST /fluent-crm/v2/funnels/{id}/clone", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/{id}/email_reports": { "get": { "summary": "GET /fluent-crm/v2/funnels/{id}/email_reports", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/{id}/export": { "post": { "summary": "POST /fluent-crm/v2/funnels/{id}/export", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/{id}/report": { "get": { "summary": "GET /fluent-crm/v2/funnels/{id}/report", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/{id}/sequences": { "post": { "summary": "POST /fluent-crm/v2/funnels/{id}/sequences", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/{id}/sequences/save-email-action": { "post": { "summary": "POST /fluent-crm/v2/funnels/{id}/sequences/save-email-action", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/{id}/sticky-note": { "put": { "summary": "PUT /fluent-crm/v2/funnels/{id}/sticky-note", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/{id}/subscribers": { "get": { "summary": "GET /fluent-crm/v2/funnels/{id}/subscribers", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/funnels/{id}/subscribers", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/{id}/subscribers/{contact_id}": { "get": { "summary": "GET /fluent-crm/v2/funnels/{id}/subscribers/{contact_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "contact_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/{id}/subscribers/{subscriber_id}/advance": { "post": { "summary": "POST /fluent-crm/v2/funnels/{id}/subscribers/{subscriber_id}/advance", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriber_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/{id}/subscribers/{subscriber_id}/status": { "put": { "summary": "PUT /fluent-crm/v2/funnels/{id}/subscribers/{subscriber_id}/status", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "subscriber_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/{id}/sync-new-steps": { "post": { "summary": "POST /fluent-crm/v2/funnels/{id}/sync-new-steps", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/{id}/syncable-counts": { "get": { "summary": "GET /fluent-crm/v2/funnels/{id}/syncable-counts", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/funnels/{id}/update-labels": { "put": { "summary": "PUT /fluent-crm/v2/funnels/{id}/update-labels", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/global-search": { "get": { "summary": "GET /fluent-crm/v2/global-search", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/import/csv-import": { "post": { "summary": "POST /fluent-crm/v2/import/csv-import", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/import/csv-upload": { "post": { "summary": "POST /fluent-crm/v2/import/csv-upload", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/import/drivers": { "get": { "summary": "GET /fluent-crm/v2/import/drivers", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/import/drivers/{driver}": { "get": { "summary": "GET /fluent-crm/v2/import/drivers/{driver}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "driver", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /fluent-crm/v2/import/drivers/{driver}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "driver", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/import/users": { "post": { "summary": "POST /fluent-crm/v2/import/users", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/labels": { "get": { "summary": "GET /fluent-crm/v2/labels", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/labels", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/labels/{id}": { "put": { "summary": "PUT /fluent-crm/v2/labels/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/labels/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/lists": { "get": { "summary": "GET /fluent-crm/v2/lists", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/lists", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/lists/bulk": { "post": { "summary": "POST /fluent-crm/v2/lists/bulk", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/lists/do-bulk-action": { "post": { "summary": "POST /fluent-crm/v2/lists/do-bulk-action", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/lists/{id}": { "get": { "summary": "GET /fluent-crm/v2/lists/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /fluent-crm/v2/lists/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/lists/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/mcp/config-snippet": { "get": { "summary": "GET /fluent-crm/v2/mcp/config-snippet", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/mcp/install-adapter": { "post": { "summary": "POST /fluent-crm/v2/mcp/install-adapter", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/mcp/status": { "get": { "summary": "GET /fluent-crm/v2/mcp/status", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/mcp/toggle": { "post": { "summary": "POST /fluent-crm/v2/mcp/toggle", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/migrators": { "get": { "summary": "GET /fluent-crm/v2/migrators", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/migrators/import": { "post": { "summary": "POST /fluent-crm/v2/migrators/import", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/migrators/list-tag-mappings": { "get": { "summary": "GET /fluent-crm/v2/migrators/list-tag-mappings", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/migrators/summary": { "post": { "summary": "POST /fluent-crm/v2/migrators/summary", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/migrators/verify-cred": { "post": { "summary": "POST /fluent-crm/v2/migrators/verify-cred", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/public/bounce_handler/{service_name}/handle/{security_code}": { "get": { "summary": "GET /fluent-crm/v2/public/bounce_handler/{service_name}/handle/{security_code}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "service_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "security_code", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /fluent-crm/v2/public/bounce_handler/{service_name}/handle/{security_code}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "service_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "security_code", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /fluent-crm/v2/public/bounce_handler/{service_name}/handle/{security_code}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "service_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "security_code", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /fluent-crm/v2/public/bounce_handler/{service_name}/handle/{security_code}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "service_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "security_code", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/public/bounce_handler/{service_name}/handle/{security_code}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "service_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "security_code", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/public/bounce_handler/{service_name}/{security_code}": { "get": { "summary": "GET /fluent-crm/v2/public/bounce_handler/{service_name}/{security_code}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "service_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "security_code", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /fluent-crm/v2/public/bounce_handler/{service_name}/{security_code}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "service_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "security_code", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /fluent-crm/v2/public/bounce_handler/{service_name}/{security_code}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "service_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "security_code", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "patch": { "summary": "PATCH /fluent-crm/v2/public/bounce_handler/{service_name}/{security_code}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "service_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "security_code", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/public/bounce_handler/{service_name}/{security_code}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "service_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "security_code", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/reports/advanced-providers": { "get": { "summary": "GET /fluent-crm/v2/reports/advanced-providers", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/ajax-options": { "get": { "summary": "GET /fluent-crm/v2/reports/ajax-options", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/automations": { "get": { "summary": "GET /fluent-crm/v2/reports/automations", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/automations/{id}/steps": { "get": { "summary": "GET /fluent-crm/v2/reports/automations/{id}/steps", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/reports/campaign-options": { "get": { "summary": "GET /fluent-crm/v2/reports/campaign-options", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/campaigns-list": { "get": { "summary": "GET /fluent-crm/v2/reports/campaigns-list", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/cascade_selections": { "get": { "summary": "GET /fluent-crm/v2/reports/cascade_selections", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/contacts-by-country": { "get": { "summary": "GET /fluent-crm/v2/reports/contacts-by-country", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/contacts-by-lists": { "get": { "summary": "GET /fluent-crm/v2/reports/contacts-by-lists", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/contacts-by-status": { "get": { "summary": "GET /fluent-crm/v2/reports/contacts-by-status", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/contacts-by-tags": { "get": { "summary": "GET /fluent-crm/v2/reports/contacts-by-tags", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/dashboard-stats": { "get": { "summary": "GET /fluent-crm/v2/reports/dashboard-stats", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/email-clicks": { "get": { "summary": "GET /fluent-crm/v2/reports/email-clicks", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/email-opens": { "get": { "summary": "GET /fluent-crm/v2/reports/email-opens", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/email-performance": { "get": { "summary": "GET /fluent-crm/v2/reports/email-performance", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/email-sents": { "get": { "summary": "GET /fluent-crm/v2/reports/email-sents", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/email-unsubs": { "get": { "summary": "GET /fluent-crm/v2/reports/email-unsubs", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/emails": { "get": { "summary": "GET /fluent-crm/v2/reports/emails", "responses": { "200": { "description": "Successful response" } } }, "delete": { "summary": "DELETE /fluent-crm/v2/reports/emails", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/options": { "get": { "summary": "GET /fluent-crm/v2/reports/options", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/ping": { "get": { "summary": "GET /fluent-crm/v2/reports/ping", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/recent-tags": { "get": { "summary": "GET /fluent-crm/v2/reports/recent-tags", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/subscribers": { "get": { "summary": "GET /fluent-crm/v2/reports/subscribers", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/reports/taxonomy-terms": { "get": { "summary": "GET /fluent-crm/v2/reports/taxonomy-terms", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting": { "get": { "summary": "GET /fluent-crm/v2/setting", "responses": { "200": { "description": "Successful response" } } }, "put": { "summary": "PUT /fluent-crm/v2/setting", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/abandon-cart": { "get": { "summary": "GET /fluent-crm/v2/setting/abandon-cart", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/setting/abandon-cart", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/auto_subscribe_settings": { "get": { "summary": "GET /fluent-crm/v2/setting/auto_subscribe_settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/setting/auto_subscribe_settings", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/bounce_configs": { "get": { "summary": "GET /fluent-crm/v2/setting/bounce_configs", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/complete-installation": { "post": { "summary": "POST /fluent-crm/v2/setting/complete-installation", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/compliance": { "get": { "summary": "GET /fluent-crm/v2/setting/compliance", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/setting/compliance", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/cron_status": { "get": { "summary": "GET /fluent-crm/v2/setting/cron_status", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/db-index-health": { "get": { "summary": "GET /fluent-crm/v2/setting/db-index-health", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/db-index-health/repair": { "post": { "summary": "POST /fluent-crm/v2/setting/db-index-health/repair", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/double-optin": { "get": { "summary": "GET /fluent-crm/v2/setting/double-optin", "responses": { "200": { "description": "Successful response" } } }, "put": { "summary": "PUT /fluent-crm/v2/setting/double-optin", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/double-optin/preview": { "post": { "summary": "POST /fluent-crm/v2/setting/double-optin/preview", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/experiments": { "get": { "summary": "GET /fluent-crm/v2/setting/experiments", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/setting/experiments", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/experiments/campaigns": { "get": { "summary": "GET /fluent-crm/v2/setting/experiments/campaigns", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/install-fluent-boards": { "post": { "summary": "POST /fluent-crm/v2/setting/install-fluent-boards", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/install-fluent-booking": { "post": { "summary": "POST /fluent-crm/v2/setting/install-fluent-booking", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/install-fluent-cart": { "post": { "summary": "POST /fluent-crm/v2/setting/install-fluent-cart", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/install-fluent-community": { "post": { "summary": "POST /fluent-crm/v2/setting/install-fluent-community", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/install-fluent-support": { "post": { "summary": "POST /fluent-crm/v2/setting/install-fluent-support", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/install-fluentform": { "post": { "summary": "POST /fluent-crm/v2/setting/install-fluentform", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/install-fluentsmtp": { "post": { "summary": "POST /fluent-crm/v2/setting/install-fluentsmtp", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/integrations": { "get": { "summary": "GET /fluent-crm/v2/setting/integrations", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/setting/integrations", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/old_logs": { "get": { "summary": "GET /fluent-crm/v2/setting/old_logs", "responses": { "200": { "description": "Successful response" } } }, "delete": { "summary": "DELETE /fluent-crm/v2/setting/old_logs", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/reset_db": { "post": { "summary": "POST /fluent-crm/v2/setting/reset_db", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/rest-keys": { "get": { "summary": "GET /fluent-crm/v2/setting/rest-keys", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/setting/rest-keys", "responses": { "200": { "description": "Successful response" } } }, "delete": { "summary": "DELETE /fluent-crm/v2/setting/rest-keys", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/run_cron": { "post": { "summary": "POST /fluent-crm/v2/setting/run_cron", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/system-logs": { "get": { "summary": "GET /fluent-crm/v2/setting/system-logs", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/system-logs/export": { "get": { "summary": "GET /fluent-crm/v2/setting/system-logs/export", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/system-logs/reset": { "delete": { "summary": "DELETE /fluent-crm/v2/setting/system-logs/reset", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/setting/test": { "get": { "summary": "GET /fluent-crm/v2/setting/test", "responses": { "200": { "description": "Successful response" } } }, "put": { "summary": "PUT /fluent-crm/v2/setting/test", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/setting/test", "responses": { "200": { "description": "Successful response" } } }, "delete": { "summary": "DELETE /fluent-crm/v2/setting/test", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/subscribers": { "get": { "summary": "GET /fluent-crm/v2/subscribers", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/subscribers", "responses": { "200": { "description": "Successful response" } } }, "delete": { "summary": "DELETE /fluent-crm/v2/subscribers", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/subscribers/bulk-add-update": { "post": { "summary": "POST /fluent-crm/v2/subscribers/bulk-add-update", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/subscribers/do-bulk-action": { "post": { "summary": "POST /fluent-crm/v2/subscribers/do-bulk-action", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/subscribers/prev-next-ids": { "get": { "summary": "GET /fluent-crm/v2/subscribers/prev-next-ids", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/subscribers/quick-pins": { "post": { "summary": "POST /fluent-crm/v2/subscribers/quick-pins", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/subscribers/search-contacts": { "get": { "summary": "GET /fluent-crm/v2/subscribers/search-contacts", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/subscribers/subscribers-property": { "put": { "summary": "PUT /fluent-crm/v2/subscribers/subscribers-property", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/subscribers/sync-segments": { "post": { "summary": "POST /fluent-crm/v2/subscribers/sync-segments", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/subscribers/track-event": { "post": { "summary": "POST /fluent-crm/v2/subscribers/track-event", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/subscribers/{id}": { "get": { "summary": "GET /fluent-crm/v2/subscribers/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/subscribers/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /fluent-crm/v2/subscribers/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/subscribers/{id}/dynamic-item-view": { "get": { "summary": "GET /fluent-crm/v2/subscribers/{id}/dynamic-item-view", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/subscribers/{id}/emails": { "get": { "summary": "GET /fluent-crm/v2/subscribers/{id}/emails", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/subscribers/{id}/emails", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/subscribers/{id}/emails/send": { "post": { "summary": "POST /fluent-crm/v2/subscribers/{id}/emails/send", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/subscribers/{id}/emails/template-mock": { "get": { "summary": "GET /fluent-crm/v2/subscribers/{id}/emails/template-mock", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/subscribers/{id}/external_view": { "get": { "summary": "GET /fluent-crm/v2/subscribers/{id}/external_view", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /fluent-crm/v2/subscribers/{id}/external_view", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/subscribers/{id}/form-submissions": { "get": { "summary": "GET /fluent-crm/v2/subscribers/{id}/form-submissions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/subscribers/{id}/info-widgets": { "get": { "summary": "GET /fluent-crm/v2/subscribers/{id}/info-widgets", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/subscribers/{id}/notes": { "get": { "summary": "GET /fluent-crm/v2/subscribers/{id}/notes", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /fluent-crm/v2/subscribers/{id}/notes", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/subscribers/{id}/notes/bulk-delete": { "post": { "summary": "POST /fluent-crm/v2/subscribers/{id}/notes/bulk-delete", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/subscribers/{id}/notes/{note_id}": { "put": { "summary": "PUT /fluent-crm/v2/subscribers/{id}/notes/{note_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/subscribers/{id}/notes/{note_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "note_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/subscribers/{id}/purchase-history": { "get": { "summary": "GET /fluent-crm/v2/subscribers/{id}/purchase-history", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/subscribers/{id}/send-double-optin": { "post": { "summary": "POST /fluent-crm/v2/subscribers/{id}/send-double-optin", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/subscribers/{id}/support-tickets": { "get": { "summary": "GET /fluent-crm/v2/subscribers/{id}/support-tickets", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/subscribers/{id}/tracking-events": { "get": { "summary": "GET /fluent-crm/v2/subscribers/{id}/tracking-events", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/subscribers/{id}/url-metrics": { "get": { "summary": "GET /fluent-crm/v2/subscribers/{id}/url-metrics", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/tags": { "get": { "summary": "GET /fluent-crm/v2/tags", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/tags", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/tags/bulk": { "post": { "summary": "POST /fluent-crm/v2/tags/bulk", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/tags/do-bulk-action": { "post": { "summary": "POST /fluent-crm/v2/tags/do-bulk-action", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/tags/{id}": { "get": { "summary": "GET /fluent-crm/v2/tags/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /fluent-crm/v2/tags/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/tags/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/templates": { "get": { "summary": "GET /fluent-crm/v2/templates", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/templates", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/templates/all": { "get": { "summary": "GET /fluent-crm/v2/templates/all", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/templates/built-in-template": { "post": { "summary": "POST /fluent-crm/v2/templates/built-in-template", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/templates/built-in-templates": { "get": { "summary": "GET /fluent-crm/v2/templates/built-in-templates", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/templates/do-bulk-action": { "post": { "summary": "POST /fluent-crm/v2/templates/do-bulk-action", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/templates/duplicate/{id}": { "post": { "summary": "POST /fluent-crm/v2/templates/duplicate/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/templates/set-global-style": { "post": { "summary": "POST /fluent-crm/v2/templates/set-global-style", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/templates/smartcodes": { "get": { "summary": "GET /fluent-crm/v2/templates/smartcodes", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/templates/{id}": { "get": { "summary": "GET /fluent-crm/v2/templates/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /fluent-crm/v2/templates/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/templates/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-crm/v2/users": { "get": { "summary": "GET /fluent-crm/v2/users", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/users/roles": { "get": { "summary": "GET /fluent-crm/v2/users/roles", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/webhooks": { "get": { "summary": "GET /fluent-crm/v2/webhooks", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluent-crm/v2/webhooks", "responses": { "200": { "description": "Successful response" } } } }, "/fluent-crm/v2/webhooks/{id}": { "put": { "summary": "PUT /fluent-crm/v2/webhooks/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluent-crm/v2/webhooks/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluent-smtp": { "get": { "summary": "GET /fluent-smtp", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "fluent-smtp" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/fluent-smtp/outlook_callback": { "get": { "summary": "GET /fluent-smtp/outlook_callback", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1": { "get": { "summary": "GET /fluentform/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "fluentform/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/fluentform/v1/analytics/{form_id}/reset": { "post": { "summary": "POST /fluentform/v1/analytics/{form_id}/reset", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/form-submit": { "post": { "summary": "POST /fluentform/v1/form-submit", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/forms": { "get": { "summary": "GET /fluentform/v1/forms", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluentform/v1/forms", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/forms/ping": { "get": { "summary": "GET /fluentform/v1/forms/ping", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/forms/templates": { "get": { "summary": "GET /fluentform/v1/forms/templates", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/forms/{form_id}": { "get": { "summary": "GET /fluentform/v1/forms/{form_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /fluentform/v1/forms/{form_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluentform/v1/forms/{form_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/forms/{form_id}/clearHistory": { "post": { "summary": "POST /fluentform/v1/forms/{form_id}/clearHistory", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/forms/{form_id}/convert": { "post": { "summary": "POST /fluentform/v1/forms/{form_id}/convert", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/forms/{form_id}/duplicate": { "post": { "summary": "POST /fluentform/v1/forms/{form_id}/duplicate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/forms/{form_id}/editHistory": { "get": { "summary": "GET /fluentform/v1/forms/{form_id}/editHistory", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/forms/{form_id}/fields": { "get": { "summary": "GET /fluentform/v1/forms/{form_id}/fields", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/forms/{form_id}/findShortCodePage": { "get": { "summary": "GET /fluentform/v1/forms/{form_id}/findShortCodePage", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/forms/{form_id}/pages": { "get": { "summary": "GET /fluentform/v1/forms/{form_id}/pages", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/forms/{form_id}/resources": { "get": { "summary": "GET /fluentform/v1/forms/{form_id}/resources", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/forms/{form_id}/shortcodes": { "get": { "summary": "GET /fluentform/v1/forms/{form_id}/shortcodes", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/global-search": { "get": { "summary": "GET /fluentform/v1/global-search", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/global-settings": { "get": { "summary": "GET /fluentform/v1/global-settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluentform/v1/global-settings", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/integrations": { "get": { "summary": "GET /fluentform/v1/integrations", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluentform/v1/integrations", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/integrations/update-status": { "post": { "summary": "POST /fluentform/v1/integrations/update-status", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/integrations/{form_id}": { "get": { "summary": "GET /fluentform/v1/integrations/{form_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /fluentform/v1/integrations/{form_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluentform/v1/integrations/{form_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/integrations/{form_id}/form-integrations": { "get": { "summary": "GET /fluentform/v1/integrations/{form_id}/form-integrations", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/integrations/{form_id}/integration-list-id": { "get": { "summary": "GET /fluentform/v1/integrations/{form_id}/integration-list-id", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/logs": { "get": { "summary": "GET /fluentform/v1/logs", "responses": { "200": { "description": "Successful response" } } }, "delete": { "summary": "DELETE /fluentform/v1/logs", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/logs/filters": { "get": { "summary": "GET /fluentform/v1/logs/filters", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/managers": { "get": { "summary": "GET /fluentform/v1/managers", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluentform/v1/managers", "responses": { "200": { "description": "Successful response" } } }, "delete": { "summary": "DELETE /fluentform/v1/managers", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/managers/users": { "get": { "summary": "GET /fluentform/v1/managers/users", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/mcp/config-snippets": { "get": { "summary": "GET /fluentform/v1/mcp/config-snippets", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/mcp/install-adapter": { "post": { "summary": "POST /fluentform/v1/mcp/install-adapter", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/mcp/status": { "get": { "summary": "GET /fluentform/v1/mcp/status", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/mcp/toggle": { "post": { "summary": "POST /fluentform/v1/mcp/toggle", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/notice": { "post": { "summary": "POST /fluentform/v1/notice", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/report/api-logs": { "get": { "summary": "GET /fluentform/v1/report/api-logs", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/report/completion-rate": { "get": { "summary": "GET /fluentform/v1/report/completion-rate", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/report/country-heatmap": { "get": { "summary": "GET /fluentform/v1/report/country-heatmap", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/report/form-stats": { "get": { "summary": "GET /fluentform/v1/report/form-stats", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/report/forms/{form_id}": { "get": { "summary": "GET /fluentform/v1/report/forms/{form_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/report/heatmap-data": { "get": { "summary": "GET /fluentform/v1/report/heatmap-data", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/report/net-revenue": { "get": { "summary": "GET /fluentform/v1/report/net-revenue", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/report/overview-chart": { "get": { "summary": "GET /fluentform/v1/report/overview-chart", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/report/payment-types": { "get": { "summary": "GET /fluentform/v1/report/payment-types", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/report/revenue-chart": { "get": { "summary": "GET /fluentform/v1/report/revenue-chart", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/report/select-forms": { "get": { "summary": "GET /fluentform/v1/report/select-forms", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/report/submissions": { "post": { "summary": "POST /fluentform/v1/report/submissions", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/report/submissions-analysis": { "get": { "summary": "GET /fluentform/v1/report/submissions-analysis", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/report/subscriptions": { "get": { "summary": "GET /fluentform/v1/report/subscriptions", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/report/top-performing-forms": { "get": { "summary": "GET /fluentform/v1/report/top-performing-forms", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/roles": { "get": { "summary": "GET /fluentform/v1/roles", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /fluentform/v1/roles", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/settings/{form_id}": { "get": { "summary": "GET /fluentform/v1/settings/{form_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /fluentform/v1/settings/{form_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluentform/v1/settings/{form_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/settings/{form_id}/conversational-design": { "get": { "summary": "GET /fluentform/v1/settings/{form_id}/conversational-design", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/settings/{form_id}/customizer": { "get": { "summary": "GET /fluentform/v1/settings/{form_id}/customizer", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /fluentform/v1/settings/{form_id}/customizer", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/settings/{form_id}/entry-columns": { "post": { "summary": "POST /fluentform/v1/settings/{form_id}/entry-columns", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/settings/{form_id}/general": { "get": { "summary": "GET /fluentform/v1/settings/{form_id}/general", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /fluentform/v1/settings/{form_id}/general", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/settings/{form_id}/preset": { "get": { "summary": "GET /fluentform/v1/settings/{form_id}/preset", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/settings/{form_id}/save-preset": { "post": { "summary": "POST /fluentform/v1/settings/{form_id}/save-preset", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/settings/{form_id}/store-conversational-design": { "post": { "summary": "POST /fluentform/v1/settings/{form_id}/store-conversational-design", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "form_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/submissions": { "get": { "summary": "GET /fluentform/v1/submissions", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/submissions/all": { "get": { "summary": "GET /fluentform/v1/submissions/all", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/submissions/bulk-actions": { "post": { "summary": "POST /fluentform/v1/submissions/bulk-actions", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/submissions/print": { "get": { "summary": "GET /fluentform/v1/submissions/print", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/submissions/resources": { "get": { "summary": "GET /fluentform/v1/submissions/resources", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/submissions/{entry_id}": { "delete": { "summary": "DELETE /fluentform/v1/submissions/{entry_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "get": { "summary": "GET /fluentform/v1/submissions/{entry_id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/submissions/{entry_id}/is-favorite": { "post": { "summary": "POST /fluentform/v1/submissions/{entry_id}/is-favorite", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/submissions/{entry_id}/logs": { "get": { "summary": "GET /fluentform/v1/submissions/{entry_id}/logs", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /fluentform/v1/submissions/{entry_id}/logs", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/submissions/{entry_id}/notes": { "get": { "summary": "GET /fluentform/v1/submissions/{entry_id}/notes", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /fluentform/v1/submissions/{entry_id}/notes", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/submissions/{entry_id}/status": { "post": { "summary": "POST /fluentform/v1/submissions/{entry_id}/status", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/submissions/{entry_id}/submission-users": { "get": { "summary": "GET /fluentform/v1/submissions/{entry_id}/submission-users", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/submissions/{entry_id}/update-submission-user": { "post": { "summary": "POST /fluentform/v1/submissions/{entry_id}/update-submission-user", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "entry_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/fluentform/v1/suggested-plugins/activate-plugin": { "post": { "summary": "POST /fluentform/v1/suggested-plugins/activate-plugin", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/suggested-plugins/check-plugin-statuses": { "post": { "summary": "POST /fluentform/v1/suggested-plugins/check-plugin-statuses", "responses": { "200": { "description": "Successful response" } } } }, "/fluentform/v1/suggested-plugins/install-plugin": { "post": { "summary": "POST /fluentform/v1/suggested-plugins/install-plugin", "responses": { "200": { "description": "Successful response" } } } }, "/hfe/v1": { "get": { "summary": "GET /hfe/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "hfe/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/hfe/v1/email-webhook": { "post": { "summary": "POST /hfe/v1/email-webhook", "responses": { "200": { "description": "Successful response" } } } }, "/hfe/v1/get-learn-chapters": { "get": { "summary": "GET /hfe/v1/get-learn-chapters", "responses": { "200": { "description": "Successful response" } } } }, "/hfe/v1/mcp-abilities": { "get": { "summary": "GET /hfe/v1/mcp-abilities", "responses": { "200": { "description": "Successful response" } } } }, "/hfe/v1/mcp-settings": { "get": { "summary": "GET /hfe/v1/mcp-settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /hfe/v1/mcp-settings", "responses": { "200": { "description": "Successful response" } } } }, "/hfe/v1/plugins": { "get": { "summary": "GET /hfe/v1/plugins", "responses": { "200": { "description": "Successful response" } } } }, "/hfe/v1/recommended-plugins": { "get": { "summary": "GET /hfe/v1/recommended-plugins", "responses": { "200": { "description": "Successful response" } } } }, "/hfe/v1/templates": { "get": { "summary": "GET /hfe/v1/templates", "responses": { "200": { "description": "Successful response" } } } }, "/hfe/v1/update-learn-progress": { "post": { "summary": "POST /hfe/v1/update-learn-progress", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "chapterId": { "type": "string" }, "stepId": { "type": "string" }, "completed": { "type": "boolean" } }, "required": [ "chapterId", "stepId", "completed" ] } } } } } }, "/hfe/v1/widgets": { "get": { "summary": "GET /hfe/v1/widgets", "responses": { "200": { "description": "Successful response" } } } }, "/litespeed/v1": { "get": { "summary": "GET /litespeed/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "litespeed/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/litespeed/v1/guest/sync": { "get": { "summary": "GET /litespeed/v1/guest/sync", "responses": { "200": { "description": "Successful response" } } } }, "/litespeed/v1/notify_img": { "post": { "summary": "POST /litespeed/v1/notify_img", "responses": { "200": { "description": "Successful response" } } } }, "/litespeed/v1/toggle_crawler_state": { "post": { "summary": "POST /litespeed/v1/toggle_crawler_state", "responses": { "200": { "description": "Successful response" } } } }, "/litespeed/v1/tool/check_ip": { "get": { "summary": "GET /litespeed/v1/tool/check_ip", "responses": { "200": { "description": "Successful response" } } } }, "/litespeed/v3": { "get": { "summary": "GET /litespeed/v3", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "litespeed/v3" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/litespeed/v3/cdn_status": { "post": { "summary": "POST /litespeed/v3/cdn_status", "responses": { "200": { "description": "Successful response" } } } }, "/litespeed/v3/err_domains": { "post": { "summary": "POST /litespeed/v3/err_domains", "responses": { "200": { "description": "Successful response" } } } }, "/litespeed/v3/ip_validate": { "post": { "summary": "POST /litespeed/v3/ip_validate", "responses": { "200": { "description": "Successful response" } } } }, "/litespeed/v3/ping": { "post": { "summary": "POST /litespeed/v3/ping", "responses": { "200": { "description": "Successful response" } } } }, "/litespeed/v3/wp_rest_echo": { "post": { "summary": "POST /litespeed/v3/wp_rest_echo", "responses": { "200": { "description": "Successful response" } } } }, "/mcp": { "get": { "summary": "GET /mcp", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "mcp" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/mcp/mcp-adapter-default-server": { "post": { "summary": "POST /mcp/mcp-adapter-default-server", "responses": { "200": { "description": "Successful response" } } }, "get": { "summary": "GET /mcp/mcp-adapter-default-server", "responses": { "200": { "description": "Successful response" } } }, "delete": { "summary": "DELETE /mcp/mcp-adapter-default-server", "responses": { "200": { "description": "Successful response" } } } }, "/oembed/1.0": { "get": { "summary": "GET /oembed/1.0", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "oembed/1.0" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/oembed/1.0/embed": { "get": { "summary": "GET /oembed/1.0/embed", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "url", "in": "query", "schema": { "type": "string", "format": "uri" }, "required": true, "description": "The URL of the resource for which to fetch oEmbed data." }, { "name": "format", "in": "query", "schema": { "default": "json" } }, { "name": "maxwidth", "in": "query", "schema": { "default": 600 } } ] } }, "/oembed/1.0/proxy": { "get": { "summary": "GET /oembed/1.0/proxy", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "url", "in": "query", "schema": { "type": "string", "format": "uri" }, "required": true, "description": "The URL of the resource for which to fetch oEmbed data." }, { "name": "format", "in": "query", "schema": { "type": "string", "default": "json", "enum": [ "json", "xml" ] }, "description": "The oEmbed format to use." }, { "name": "maxwidth", "in": "query", "schema": { "type": "integer", "default": 600 }, "description": "The maximum width of the embed frame in pixels." }, { "name": "maxheight", "in": "query", "schema": { "type": "integer" }, "description": "The maximum height of the embed frame in pixels." }, { "name": "discover", "in": "query", "schema": { "type": "boolean", "default": true }, "description": "Whether to perform an oEmbed discovery request for unsanctioned providers." } ] } }, "/seopress/mcp": { "get": { "summary": "GET /seopress/mcp", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "seopress/mcp" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/seopress/mcp/v1": { "post": { "summary": "POST /seopress/mcp/v1", "responses": { "200": { "description": "Successful response" } } }, "get": { "summary": "GET /seopress/mcp/v1", "responses": { "200": { "description": "Successful response" } } }, "delete": { "summary": "DELETE /seopress/mcp/v1", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/mcp/v1/oauth-authorization-server": { "get": { "summary": "GET /seopress/mcp/v1/oauth-authorization-server", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/mcp/v1/oauth-protected-resource": { "get": { "summary": "GET /seopress/mcp/v1/oauth-protected-resource", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/mcp/v1/register": { "post": { "summary": "POST /seopress/mcp/v1/register", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/mcp/v1/revoke": { "post": { "summary": "POST /seopress/mcp/v1/revoke", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/mcp/v1/token": { "post": { "summary": "POST /seopress/mcp/v1/token", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1": { "get": { "summary": "GET /seopress/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "seopress/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/seopress/v1/ai/chat": { "post": { "summary": "POST /seopress/v1/ai/chat", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "messages": { "type": "string" }, "post_context": { "type": "string" }, "command": { "type": "string" }, "command_args": { "type": "string" }, "post_id": { "type": "string" } }, "required": [ "messages" ] } } } } } }, "/seopress/v1/ai/chat/action": { "post": { "summary": "POST /seopress/v1/ai/chat/action", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ability": { "type": "string" }, "input": { "default": [] } }, "required": [ "ability" ] } } } } } }, "/seopress/v1/ai/conversations": { "get": { "summary": "GET /seopress/v1/ai/conversations", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/ai/conversations", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "default": "" }, "messages": { "type": "string" } }, "required": [ "messages" ] } } } } } }, "/seopress/v1/ai/conversations/{id}": { "delete": { "summary": "DELETE /seopress/v1/ai/conversations/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/ai/memory": { "get": { "summary": "GET /seopress/v1/ai/memory", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/ai/memory", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "personal": { "type": "string" }, "site": { "type": "string" }, "active_skills": { "type": "string" } } } } } } } }, "/seopress/v1/alerts": { "get": { "summary": "GET /seopress/v1/alerts", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Bypass cache and force a fresh check." } ] } }, "/seopress/v1/broken-links": { "get": { "summary": "GET /seopress/v1/broken-links", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "per_page", "in": "query", "schema": { "default": 25 } }, { "name": "page", "in": "query", "schema": { "default": 1 } }, { "name": "orderby", "in": "query", "schema": { "default": "date" } }, { "name": "order", "in": "query", "schema": { "default": "DESC" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "status", "in": "query", "schema": { "type": "string" } } ] } }, "/seopress/v1/broken-links/bulk": { "post": { "summary": "POST /seopress/v1/broken-links/bulk", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/broken-links/export": { "get": { "summary": "GET /seopress/v1/broken-links/export", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/broken-links/scan": { "post": { "summary": "POST /seopress/v1/broken-links/scan", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/broken-links/scan-status": { "get": { "summary": "GET /seopress/v1/broken-links/scan-status", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/broken-links/view-preferences": { "get": { "summary": "GET /seopress/v1/broken-links/view-preferences", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/broken-links/view-preferences", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/broken-links/{id}": { "get": { "summary": "GET /seopress/v1/broken-links/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /seopress/v1/broken-links/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/commands/clear-cache": { "post": { "summary": "POST /seopress/v1/commands/clear-cache", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/commands/flush-rewrite-rules": { "post": { "summary": "POST /seopress/v1/commands/flush-rewrite-rules", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/commands/recent": { "get": { "summary": "GET /seopress/v1/commands/recent", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/commands/recent", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" } }, "required": [ "name" ] } } } } } }, "/seopress/v1/content-analysis": { "post": { "summary": "POST /seopress/v1/content-analysis", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "target_keyword": { "type": "string" }, "target_keywords": { "type": "string" }, "post_id": { "type": "integer" } }, "required": [ "content" ] } } } } } }, "/seopress/v1/dashboard/display-preference": { "post": { "summary": "POST /seopress/v1/dashboard/display-preference", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string" }, "value": { "type": "boolean" } }, "required": [ "key", "value" ] } } } } } }, "/seopress/v1/dashboard/feature-toggle": { "post": { "summary": "POST /seopress/v1/dashboard/feature-toggle", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "feature": { "type": "string" }, "enabled": { "type": "boolean" } }, "required": [ "feature", "enabled" ] } } } } } }, "/seopress/v1/diagnostics/indexnow-key": { "post": { "summary": "POST /seopress/v1/diagnostics/indexnow-key", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/diagnostics/llms-txt": { "post": { "summary": "POST /seopress/v1/diagnostics/llms-txt", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/diagnostics/sitemap-fix": { "post": { "summary": "POST /seopress/v1/diagnostics/sitemap-fix", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "fix": { "type": "string" } }, "required": [ "fix" ] } } } } } }, "/seopress/v1/diagnostics/sitemap-test": { "post": { "summary": "POST /seopress/v1/diagnostics/sitemap-test", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/ga4": { "get": { "summary": "GET /seopress/v1/ga4", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/instant-indexing/history": { "get": { "summary": "GET /seopress/v1/instant-indexing/history", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 } }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 20 } }, { "name": "search", "in": "query", "schema": { "type": "string", "default": "" } }, { "name": "source", "in": "query", "schema": { "type": "string", "default": "", "enum": [ "", "manual", "auto" ] } } ] }, "delete": { "summary": "DELETE /seopress/v1/instant-indexing/history", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/license": { "get": { "summary": "GET /seopress/v1/license", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/license/activate": { "post": { "summary": "POST /seopress/v1/license/activate", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "license": { "type": "string" } } } } } } } }, "/seopress/v1/license/clear-cache": { "post": { "summary": "POST /seopress/v1/license/clear-cache", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/license/deactivate": { "post": { "summary": "POST /seopress/v1/license/deactivate", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/license/probe": { "post": { "summary": "POST /seopress/v1/license/probe", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/license/reset": { "post": { "summary": "POST /seopress/v1/license/reset", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/matomo": { "get": { "summary": "GET /seopress/v1/matomo", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/mcp/connections/{uuid}": { "delete": { "summary": "DELETE /seopress/v1/mcp/connections/{uuid}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/mcp/status": { "get": { "summary": "GET /seopress/v1/mcp/status", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/options/advanced-settings": { "get": { "summary": "GET /seopress/v1/options/advanced-settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/options/advanced-settings", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/options/analytics-settings": { "get": { "summary": "GET /seopress/v1/options/analytics-settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/options/analytics-settings", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/options/bot-settings": { "get": { "summary": "GET /seopress/v1/options/bot-settings", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/options/dashboard-settings": { "get": { "summary": "GET /seopress/v1/options/dashboard-settings", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/options/indexing-settings": { "get": { "summary": "GET /seopress/v1/options/indexing-settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/options/indexing-settings", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/options/license-settings": { "get": { "summary": "GET /seopress/v1/options/license-settings", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/options/pro-mu-settings": { "get": { "summary": "GET /seopress/v1/options/pro-mu-settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/options/pro-mu-settings", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/options/pro-settings": { "get": { "summary": "GET /seopress/v1/options/pro-settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/options/pro-settings", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/options/sitemaps-settings": { "get": { "summary": "GET /seopress/v1/options/sitemaps-settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/options/sitemaps-settings", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/options/social-settings": { "get": { "summary": "GET /seopress/v1/options/social-settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/options/social-settings", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/options/titles-settings": { "get": { "summary": "GET /seopress/v1/options/titles-settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/options/titles-settings", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/options/woocommerce-settings": { "get": { "summary": "GET /seopress/v1/options/woocommerce-settings", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/page-speed": { "get": { "summary": "GET /seopress/v1/page-speed", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "device", "in": "query", "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/by-url": { "get": { "summary": "GET /seopress/v1/posts/by-url", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/posts/{id}": { "get": { "summary": "GET /seopress/v1/posts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/content-analysis": { "get": { "summary": "GET /seopress/v1/posts/{id}/content-analysis", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /seopress/v1/posts/{id}/content-analysis", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/content-analysis/analyze": { "post": { "summary": "POST /seopress/v1/posts/{id}/content-analysis/analyze", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/count-target-keywords-use": { "get": { "summary": "GET /seopress/v1/posts/{id}/count-target-keywords-use", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/generate-metas-by-ai": { "post": { "summary": "POST /seopress/v1/posts/{id}/generate-metas-by-ai", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "lang": { "type": "string" } } } } } } } }, "/seopress/v1/posts/{id}/generate-social-metas-by-ai": { "post": { "summary": "POST /seopress/v1/posts/{id}/generate-social-metas-by-ai", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "lang": { "type": "string" }, "platform": { "type": "string" }, "meta_type": { "type": "string" } } } } } } } }, "/seopress/v1/posts/{id}/google-news-settings": { "get": { "summary": "GET /seopress/v1/posts/{id}/google-news-settings", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /seopress/v1/posts/{id}/google-news-settings", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/indexing-history": { "get": { "summary": "GET /seopress/v1/posts/{id}/indexing-history", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/inspect": { "get": { "summary": "GET /seopress/v1/posts/{id}/inspect", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "post": { "summary": "POST /seopress/v1/posts/{id}/inspect", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/meta-robot-settings": { "get": { "summary": "GET /seopress/v1/posts/{id}/meta-robot-settings", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /seopress/v1/posts/{id}/meta-robot-settings", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/page-preview": { "get": { "summary": "GET /seopress/v1/posts/{id}/page-preview", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/page-preview/analyze": { "post": { "summary": "POST /seopress/v1/posts/{id}/page-preview/analyze", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "default": 0 } } } } } } } }, "/seopress/v1/posts/{id}/preview-title-description-metas": { "get": { "summary": "GET /seopress/v1/posts/{id}/preview-title-description-metas", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "title", "in": "query", "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/redirection-settings": { "get": { "summary": "GET /seopress/v1/posts/{id}/redirection-settings", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /seopress/v1/posts/{id}/redirection-settings", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/redirection-test": { "get": { "summary": "GET /seopress/v1/posts/{id}/redirection-test", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/schemas-automatic": { "get": { "summary": "GET /seopress/v1/posts/{id}/schemas-automatic", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /seopress/v1/posts/{id}/schemas-automatic", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/schemas-manual": { "get": { "summary": "GET /seopress/v1/posts/{id}/schemas-manual", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /seopress/v1/posts/{id}/schemas-manual", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/significant-keywords": { "get": { "summary": "GET /seopress/v1/posts/{id}/significant-keywords", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/social-settings": { "get": { "summary": "GET /seopress/v1/posts/{id}/social-settings", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /seopress/v1/posts/{id}/social-settings", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/target-keywords": { "get": { "summary": "GET /seopress/v1/posts/{id}/target-keywords", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /seopress/v1/posts/{id}/target-keywords", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/title-description-metas": { "get": { "summary": "GET /seopress/v1/posts/{id}/title-description-metas", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /seopress/v1/posts/{id}/title-description-metas", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/posts/{id}/video-sitemap": { "get": { "summary": "GET /seopress/v1/posts/{id}/video-sitemap", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /seopress/v1/posts/{id}/video-sitemap", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/redirections": { "get": { "summary": "GET /seopress/v1/redirections", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "enabled", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "schema": { "default": 20 } }, { "name": "page", "in": "query", "schema": { "default": 1 } }, { "name": "orderby", "in": "query", "schema": { "default": "date" } }, { "name": "view", "in": "query", "schema": { "default": "redirects" } }, { "name": "order", "in": "query", "schema": { "default": "DESC" } }, { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "category", "in": "query", "schema": { "type": "string" } } ] }, "post": { "summary": "POST /seopress/v1/redirections", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/redirections/bulk": { "delete": { "summary": "DELETE /seopress/v1/redirections/bulk", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "ids", "in": "query", "schema": { "type": "string" }, "required": true } ] }, "post": { "summary": "POST /seopress/v1/redirections/bulk", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ids": { "type": "string" }, "action": { "type": "string" }, "category_id": { "type": "string" }, "category_ids": { "type": "string" }, "mode": { "type": "string" }, "type": { "type": "string" } }, "required": [ "ids", "action" ] } } } } } }, "/seopress/v1/redirections/categories": { "get": { "summary": "GET /seopress/v1/redirections/categories", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "view", "in": "query", "schema": { "type": "string" } }, { "name": "enabled", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ] }, "post": { "summary": "POST /seopress/v1/redirections/categories", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent": { "default": 0 } }, "required": [ "name" ] } } } } } }, "/seopress/v1/redirections/categories/{id}": { "patch": { "summary": "PATCH /seopress/v1/redirections/categories/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "parent": { "type": "string" } } } } } } }, "delete": { "summary": "DELETE /seopress/v1/redirections/categories/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/redirections/cleanup": { "post": { "summary": "POST /seopress/v1/redirections/cleanup", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "scope": { "type": "string" }, "days": { "type": "string" } }, "required": [ "scope" ] } } } } } }, "/seopress/v1/redirections/import/cancel": { "post": { "summary": "POST /seopress/v1/redirections/import/cancel", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/redirections/import/prepare": { "post": { "summary": "POST /seopress/v1/redirections/import/prepare", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "source": { "type": "string" }, "separator": { "default": "auto" } }, "required": [ "source" ] } } } } } }, "/seopress/v1/redirections/import/run": { "post": { "summary": "POST /seopress/v1/redirections/import/run", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "jobId": { "type": "string" } }, "required": [ "jobId" ] } } } } } }, "/seopress/v1/redirections/import/status": { "get": { "summary": "GET /seopress/v1/redirections/import/status", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/redirections/post-conflict": { "get": { "summary": "GET /seopress/v1/redirections/post-conflict", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "post_id", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "url", "in": "query", "schema": { "type": "string" }, "required": true } ] } }, "/seopress/v1/redirections/test": { "post": { "summary": "POST /seopress/v1/redirections/test", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" } }, "required": [ "url" ] } } } } } }, "/seopress/v1/redirections/validate": { "post": { "summary": "POST /seopress/v1/redirections/validate", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/redirections/view-preferences": { "get": { "summary": "GET /seopress/v1/redirections/view-preferences", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/redirections/view-preferences", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/redirections/{id}": { "get": { "summary": "GET /seopress/v1/redirections/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /seopress/v1/redirections/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /seopress/v1/redirections/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/redirections/{id}/duplicate": { "post": { "summary": "POST /seopress/v1/redirections/{id}/duplicate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/review-prompt": { "post": { "summary": "POST /seopress/v1/review-prompt", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "reviewed", "dismiss", "snooze" ] } }, "required": [ "action" ] } } } } } }, "/seopress/v1/robots-revisions": { "get": { "summary": "GET /seopress/v1/robots-revisions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "type", "in": "query", "schema": { "default": "site" } } ] } }, "/seopress/v1/robots-revisions/diff": { "get": { "summary": "GET /seopress/v1/robots-revisions/diff", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "type", "in": "query", "schema": { "default": "site" } }, { "name": "from", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "to", "in": "query", "schema": { "type": "string" }, "required": true } ] } }, "/seopress/v1/robots-revisions/restore": { "post": { "summary": "POST /seopress/v1/robots-revisions/restore", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "default": "site" }, "id": { "type": "string" } }, "required": [ "id" ] } } } } } }, "/seopress/v1/roles": { "get": { "summary": "GET /seopress/v1/roles", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/schemas": { "get": { "summary": "GET /seopress/v1/schemas", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "schema": { "default": 20 } }, { "name": "page", "in": "query", "schema": { "default": 1 } }, { "name": "orderby", "in": "query", "schema": { "default": "title" } }, { "name": "order", "in": "query", "schema": { "default": "ASC" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ] }, "post": { "summary": "POST /seopress/v1/schemas", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/schemas/bulk": { "delete": { "summary": "DELETE /seopress/v1/schemas/bulk", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "ids", "in": "query", "schema": { "type": "string" }, "required": true } ] } }, "/seopress/v1/schemas/editor-data": { "get": { "summary": "GET /seopress/v1/schemas/editor-data", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/schemas/export": { "get": { "summary": "GET /seopress/v1/schemas/export", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/schemas/import": { "post": { "summary": "POST /seopress/v1/schemas/import", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/schemas/manual-assignments": { "get": { "summary": "GET /seopress/v1/schemas/manual-assignments", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "per_page", "in": "query", "schema": { "default": 20 } }, { "name": "page", "in": "query", "schema": { "default": 1 } }, { "name": "orderby", "in": "query", "schema": { "default": "title" } }, { "name": "order", "in": "query", "schema": { "default": "ASC" } }, { "name": "search", "in": "query", "schema": { "type": "string" } } ] } }, "/seopress/v1/schemas/manual-assignments/view-preferences": { "get": { "summary": "GET /seopress/v1/schemas/manual-assignments/view-preferences", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/schemas/manual-assignments/view-preferences", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/schemas/manual-assignments/{id}": { "delete": { "summary": "DELETE /seopress/v1/schemas/manual-assignments/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/schemas/matching-posts": { "post": { "summary": "POST /seopress/v1/schemas/matching-posts", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/schemas/post-context/{id}": { "get": { "summary": "GET /seopress/v1/schemas/post-context/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/schemas/preferences": { "post": { "summary": "POST /seopress/v1/schemas/preferences", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "showPreview": { "type": "string" } } } } } } } }, "/seopress/v1/schemas/rule-posts": { "get": { "summary": "GET /seopress/v1/schemas/rule-posts", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "search", "in": "query", "schema": { "default": "" } }, { "name": "include", "in": "query", "schema": { "default": [] } } ] } }, "/seopress/v1/schemas/view-preferences": { "get": { "summary": "GET /seopress/v1/schemas/view-preferences", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/schemas/view-preferences", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/schemas/{id}": { "get": { "summary": "GET /seopress/v1/schemas/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "put": { "summary": "PUT /seopress/v1/schemas/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] }, "delete": { "summary": "DELETE /seopress/v1/schemas/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/schemas/{id}/duplicate": { "post": { "summary": "POST /seopress/v1/schemas/{id}/duplicate", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/search-console/performance": { "get": { "summary": "GET /seopress/v1/search-console/performance", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/search-posts": { "get": { "summary": "GET /seopress/v1/search-posts", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "search", "in": "query", "schema": { "type": "string" } }, { "name": "ids", "in": "query", "schema": { "type": "string" } } ] } }, "/seopress/v1/search-url": { "get": { "summary": "GET /seopress/v1/search-url", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "url", "in": "query", "schema": { "type": "string" }, "required": true } ] } }, "/seopress/v1/seo-issues": { "get": { "summary": "GET /seopress/v1/seo-issues", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "ignore", "in": "query", "schema": { "type": "string" } }, { "name": "type", "in": "query", "schema": { "type": "string" } }, { "name": "priority", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } } ] } }, "/seopress/v1/seo-issues/{id}": { "get": { "summary": "GET /seopress/v1/seo-issues/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/site-audit/history": { "get": { "summary": "GET /seopress/v1/site-audit/history", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "days", "in": "query", "schema": { "default": 30 } } ] } }, "/seopress/v1/site-audit/homepage": { "get": { "summary": "GET /seopress/v1/site-audit/homepage", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "refresh", "in": "query", "schema": { "default": 0 } }, { "name": "cached", "in": "query", "schema": { "default": 0 } } ] } }, "/seopress/v1/site-audit/issues": { "get": { "summary": "GET /seopress/v1/site-audit/issues", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/site-audit/issues/bulk-ignore": { "post": { "summary": "POST /seopress/v1/site-audit/issues/bulk-ignore", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/site-audit/issues/{id}/generate-alt": { "post": { "summary": "POST /seopress/v1/site-audit/issues/{id}/generate-alt", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/site-audit/issues/{type}": { "get": { "summary": "GET /seopress/v1/site-audit/issues/{type}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "per_page", "in": "query", "schema": { "default": 25 } }, { "name": "page", "in": "query", "schema": { "default": 1 } }, { "name": "ignored", "in": "query", "schema": { "default": 0 } }, { "name": "search", "in": "query", "schema": { "default": "" } }, { "name": "orderby", "in": "query", "schema": { "default": "priority" } }, { "name": "order", "in": "query", "schema": { "default": "asc" } }, { "name": "issue_name", "in": "query", "schema": { "default": "" } }, { "name": "priority", "in": "query", "schema": { "default": "" } } ] } }, "/seopress/v1/site-audit/issues/{type}/{id}/ignore": { "post": { "summary": "POST /seopress/v1/site-audit/issues/{type}/{id}/ignore", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ignored": { "type": "string" } } } } } } } }, "/seopress/v1/site-audit/overview": { "get": { "summary": "GET /seopress/v1/site-audit/overview", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/site-audit/posts/{post_id}/rescan": { "post": { "summary": "POST /seopress/v1/site-audit/posts/{post_id}/rescan", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "post_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/site-audit/priority-urls": { "get": { "summary": "GET /seopress/v1/site-audit/priority-urls", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "limit", "in": "query", "schema": { "default": 10 } } ] } }, "/seopress/v1/site-audit/scan": { "post": { "summary": "POST /seopress/v1/site-audit/scan", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "default": "start" } } } } } } } }, "/seopress/v1/site-audit/scan-status": { "get": { "summary": "GET /seopress/v1/site-audit/scan-status", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/site-audit/settings": { "get": { "summary": "GET /seopress/v1/site-audit/settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/site-audit/settings", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/site-audit/settings-meta": { "get": { "summary": "GET /seopress/v1/site-audit/settings-meta", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/site-audit/view-preferences": { "get": { "summary": "GET /seopress/v1/site-audit/view-preferences", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/site-audit/view-preferences", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/terms/{id}": { "get": { "summary": "GET /seopress/v1/terms/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/seopress/v1/tools/clean-audit-scans": { "post": { "summary": "POST /seopress/v1/tools/clean-audit-scans", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/tools/clean-content-scans": { "post": { "summary": "POST /seopress/v1/tools/clean-content-scans", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/tools/export": { "get": { "summary": "GET /seopress/v1/tools/export", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/tools/import": { "post": { "summary": "POST /seopress/v1/tools/import", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/tools/reset-notices": { "post": { "summary": "POST /seopress/v1/tools/reset-notices", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/tools/reset-settings": { "post": { "summary": "POST /seopress/v1/tools/reset-settings", "responses": { "200": { "description": "Successful response" } } } }, "/seopress/v1/user/panels-state": { "get": { "summary": "GET /seopress/v1/user/panels-state", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /seopress/v1/user/panels-state", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tab": { "type": "string" }, "expanded": { "type": "boolean" } }, "required": [ "tab", "expanded" ] } } } } } }, "/wp-abilities/v1": { "get": { "summary": "GET /wp-abilities/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "wp-abilities/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/wp-abilities/v1/abilities": { "get": { "summary": "GET /wp-abilities/v1/abilities", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 50 }, "description": "Maximum number of items to be returned in result set." }, { "name": "category", "in": "query", "schema": { "type": "string" }, "description": "Limit results to abilities in specific ability category." }, { "name": "namespace", "in": "query", "schema": { "type": "string" }, "description": "Limit results to abilities in a specific namespace." }, { "name": "meta", "in": "query", "schema": { "type": "object" }, "description": "Limit results to abilities matching all of the given meta fields." } ] } }, "/wp-abilities/v1/abilities/{name}": { "get": { "summary": "GET /wp-abilities/v1/abilities/{name}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the ability." } ] } }, "/wp-abilities/v1/abilities/{name}/run": { "get": { "summary": "GET /wp-abilities/v1/abilities/{name}/run", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the ability." }, { "name": "input", "in": "query", "schema": { "type": "integer" }, "description": "Input parameters for the ability execution." } ] }, "post": { "summary": "POST /wp-abilities/v1/abilities/{name}/run", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the ability." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "integer", "description": "Input parameters for the ability execution." } } } } } } }, "put": { "summary": "PUT /wp-abilities/v1/abilities/{name}/run", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the ability." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "integer", "description": "Input parameters for the ability execution." } } } } } } }, "patch": { "summary": "PATCH /wp-abilities/v1/abilities/{name}/run", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the ability." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "input": { "type": "integer", "description": "Input parameters for the ability execution." } } } } } } }, "delete": { "summary": "DELETE /wp-abilities/v1/abilities/{name}/run", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the ability." }, { "name": "input", "in": "query", "schema": { "type": "integer" }, "description": "Input parameters for the ability execution." } ] } }, "/wp-abilities/v1/categories": { "get": { "summary": "GET /wp-abilities/v1/categories", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 50 }, "description": "Maximum number of items to be returned in result set." } ] } }, "/wp-abilities/v1/categories/{slug}": { "get": { "summary": "GET /wp-abilities/v1/categories/{slug}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the ability category." } ] } }, "/wp-block-editor/v1": { "get": { "summary": "GET /wp-block-editor/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "wp-block-editor/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/wp-block-editor/v1/export": { "get": { "summary": "GET /wp-block-editor/v1/export", "responses": { "200": { "description": "Successful response" } } } }, "/wp-block-editor/v1/navigation-fallback": { "get": { "summary": "GET /wp-block-editor/v1/navigation-fallback", "responses": { "200": { "description": "Successful response" } } } }, "/wp-block-editor/v1/url-details": { "get": { "summary": "GET /wp-block-editor/v1/url-details", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "url", "in": "query", "schema": { "type": "string", "format": "uri" }, "required": true, "description": "The URL to process." } ] } }, "/wp-site-health/v1": { "get": { "summary": "GET /wp-site-health/v1", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "wp-site-health/v1" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/wp-site-health/v1/directory-sizes": { "get": { "summary": "GET /wp-site-health/v1/directory-sizes", "responses": { "200": { "description": "Successful response" } } } }, "/wp-site-health/v1/tests/authorization-header": { "get": { "summary": "GET /wp-site-health/v1/tests/authorization-header", "responses": { "200": { "description": "Successful response" } } } }, "/wp-site-health/v1/tests/background-updates": { "get": { "summary": "GET /wp-site-health/v1/tests/background-updates", "responses": { "200": { "description": "Successful response" } } } }, "/wp-site-health/v1/tests/dotorg-communication": { "get": { "summary": "GET /wp-site-health/v1/tests/dotorg-communication", "responses": { "200": { "description": "Successful response" } } } }, "/wp-site-health/v1/tests/https-status": { "get": { "summary": "GET /wp-site-health/v1/tests/https-status", "responses": { "200": { "description": "Successful response" } } } }, "/wp-site-health/v1/tests/loopback-requests": { "get": { "summary": "GET /wp-site-health/v1/tests/loopback-requests", "responses": { "200": { "description": "Successful response" } } } }, "/wp-site-health/v1/tests/page-cache": { "get": { "summary": "GET /wp-site-health/v1/tests/page-cache", "responses": { "200": { "description": "Successful response" } } } }, "/wp/v2": { "get": { "summary": "GET /wp/v2", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "query", "schema": { "default": "wp/v2" } }, { "name": "context", "in": "query", "schema": { "default": "view" } } ] } }, "/wp/v2/block-directory/search": { "get": { "summary": "GET /wp/v2/block-directory/search", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "term", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Limit result set to blocks matching the search term." } ] } }, "/wp/v2/block-patterns/categories": { "get": { "summary": "GET /wp/v2/block-patterns/categories", "responses": { "200": { "description": "Successful response" } } } }, "/wp/v2/block-patterns/patterns": { "get": { "summary": "GET /wp/v2/block-patterns/patterns", "responses": { "200": { "description": "Successful response" } } } }, "/wp/v2/block-renderer/{name}": { "get": { "summary": "GET /wp/v2/block-renderer/{name}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique registered name for the block." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "attributes", "in": "query", "schema": { "type": "object", "default": [] }, "description": "Attributes for the block." }, { "name": "post_id", "in": "query", "schema": { "type": "integer" }, "description": "ID of the post context." } ] }, "post": { "summary": "POST /wp/v2/block-renderer/{name}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique registered name for the block." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "context": { "type": "string", "default": "view", "enum": [ "edit" ], "description": "Scope under which the request is made; determines fields present in response." }, "attributes": { "type": "object", "default": [], "description": "Attributes for the block." }, "post_id": { "type": "integer", "description": "ID of the post context." } } } } } } } }, "/wp/v2/block-types": { "get": { "summary": "GET /wp/v2/block-types", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "namespace", "in": "query", "schema": { "type": "string" }, "description": "Block namespace." } ] } }, "/wp/v2/block-types/{namespace}": { "get": { "summary": "GET /wp/v2/block-types/{namespace}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Block namespace." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/block-types/{namespace}/{name}": { "get": { "summary": "GET /wp/v2/block-types/{namespace}/{name}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "namespace", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Block namespace." }, { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Block name." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/blocks": { "get": { "summary": "GET /wp/v2/blocks", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by post attribute." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "any" ], "type": "string" }, "default": "publish" }, "description": "Limit result set to posts assigned one or more statuses." }, { "name": "tax_relation", "in": "query", "schema": { "type": "string", "enum": [ "AND", "OR" ] }, "description": "Limit result set based on relationship between multiple taxonomies." }, { "name": "wp_pattern_category", "in": "query", "schema": { "type": "object" }, "description": "Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy." }, { "name": "wp_pattern_category_exclude", "in": "query", "schema": { "type": "object" }, "description": "Limit result set to items except those with specific terms assigned in the wp_pattern_category taxonomy." } ] }, "post": { "summary": "POST /wp/v2/blocks", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "wp_pattern_category": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the wp_pattern_category taxonomy." } } } } } } } }, "/wp/v2/blocks/{id}": { "get": { "summary": "GET /wp/v2/blocks/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "excerpt_length", "in": "query", "schema": { "type": "integer" }, "description": "Override the default excerpt length." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the post if it is password protected." } ] }, "post": { "summary": "POST /wp/v2/blocks/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "wp_pattern_category": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the wp_pattern_category taxonomy." } } } } } } }, "put": { "summary": "PUT /wp/v2/blocks/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "wp_pattern_category": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the wp_pattern_category taxonomy." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/blocks/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "wp_pattern_category": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the wp_pattern_category taxonomy." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/blocks/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/blocks/{id}/autosaves": { "get": { "summary": "GET /wp/v2/blocks/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/blocks/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parent": { "type": "integer", "description": "The ID for the parent of the autosave." }, "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "wp_pattern_category": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the wp_pattern_category taxonomy." } } } } } } } }, "/wp/v2/blocks/{parent}/autosaves/{id}": { "get": { "summary": "GET /wp/v2/blocks/{parent}/autosaves/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/blocks/{parent}/revisions": { "get": { "summary": "GET /wp/v2/blocks/{parent}/revisions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "date", "id", "include", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by object attribute." } ] } }, "/wp/v2/blocks/{parent}/revisions/{id}": { "get": { "summary": "GET /wp/v2/blocks/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "delete": { "summary": "DELETE /wp/v2/blocks/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as revisions do not support trashing." } ] } }, "/wp/v2/categories": { "get": { "summary": "GET /wp/v2/categories", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ] }, "description": "Sort collection by term attribute." }, { "name": "hide_empty", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to hide terms not assigned to any posts." }, { "name": "parent", "in": "query", "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific parent." }, { "name": "post", "in": "query", "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific post." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to terms with one or more specific slugs." } ] }, "post": { "summary": "POST /wp/v2/categories", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "parent": { "type": "integer", "description": "The parent term ID." }, "meta": { "type": "object", "description": "Meta fields." } }, "required": [ "name" ] } } } } } }, "/wp/v2/categories/{id}": { "get": { "summary": "GET /wp/v2/categories/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/categories/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "parent": { "type": "integer", "description": "The parent term ID." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "put": { "summary": "PUT /wp/v2/categories/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "parent": { "type": "integer", "description": "The parent term ID." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/categories/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "parent": { "type": "integer", "description": "The parent term ID." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/categories/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as terms do not support trashing." } ] } }, "/wp/v2/comments": { "get": { "summary": "GET /wp/v2/comments", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to comments published after a given ISO8601 compliant date." }, { "name": "author", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "Limit result set to comments assigned to specific user IDs. Requires authorization." }, { "name": "author_exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" } }, "description": "Ensure result set excludes comments assigned to specific user IDs. Requires authorization." }, { "name": "author_email", "in": "query", "schema": { "type": "string", "format": "email" }, "description": "Limit result set to that from a specific author email. Requires authorization." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to comments published before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date_gmt", "enum": [ "date", "date_gmt", "id", "include", "post", "parent", "type" ] }, "description": "Sort collection by comment attribute." }, { "name": "parent", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to comments of specific parent IDs." }, { "name": "parent_exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific parent IDs." }, { "name": "post", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to comments assigned to specific post IDs." }, { "name": "status", "in": "query", "schema": { "type": "string", "default": "approve" }, "description": "Limit result set to comments assigned a specific status. Requires authorization." }, { "name": "type", "in": "query", "schema": { "type": "string", "default": "comment" }, "description": "Limit result set to comments assigned a specific type. Requires authorization." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the post if it is password protected." } ] }, "post": { "summary": "POST /wp/v2/comments", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "author": { "type": "integer", "description": "The ID of the user object, if author was a user." }, "author_email": { "type": "string", "format": "email", "description": "Email address for the comment author." }, "author_ip": { "type": "string", "format": "ip", "description": "IP address for the comment author." }, "author_name": { "type": "string", "description": "Display name for the comment author." }, "author_url": { "type": "string", "format": "uri", "description": "URL for the comment author." }, "author_user_agent": { "type": "string", "description": "User agent for the comment author." }, "content": { "type": "object", "description": "The content for the comment." }, "date": { "type": "string", "format": "date-time", "description": "The date the comment was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the comment was published, as GMT." }, "parent": { "type": "integer", "default": 0, "description": "The ID for the parent of the comment." }, "post": { "type": "integer", "default": 0, "description": "The ID of the associated post object." }, "status": { "type": "string", "description": "State of the comment." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } } }, "/wp/v2/comments/{id}": { "get": { "summary": "GET /wp/v2/comments/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the comment." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the parent post of the comment (if the post is password protected)." } ] }, "post": { "summary": "POST /wp/v2/comments/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the comment." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "author": { "type": "integer", "description": "The ID of the user object, if author was a user." }, "author_email": { "type": "string", "format": "email", "description": "Email address for the comment author." }, "author_ip": { "type": "string", "format": "ip", "description": "IP address for the comment author." }, "author_name": { "type": "string", "description": "Display name for the comment author." }, "author_url": { "type": "string", "format": "uri", "description": "URL for the comment author." }, "author_user_agent": { "type": "string", "description": "User agent for the comment author." }, "content": { "type": "object", "description": "The content for the comment." }, "date": { "type": "string", "format": "date-time", "description": "The date the comment was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the comment was published, as GMT." }, "parent": { "type": "integer", "description": "The ID for the parent of the comment." }, "post": { "type": "integer", "description": "The ID of the associated post object." }, "status": { "type": "string", "description": "State of the comment." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "put": { "summary": "PUT /wp/v2/comments/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the comment." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "author": { "type": "integer", "description": "The ID of the user object, if author was a user." }, "author_email": { "type": "string", "format": "email", "description": "Email address for the comment author." }, "author_ip": { "type": "string", "format": "ip", "description": "IP address for the comment author." }, "author_name": { "type": "string", "description": "Display name for the comment author." }, "author_url": { "type": "string", "format": "uri", "description": "URL for the comment author." }, "author_user_agent": { "type": "string", "description": "User agent for the comment author." }, "content": { "type": "object", "description": "The content for the comment." }, "date": { "type": "string", "format": "date-time", "description": "The date the comment was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the comment was published, as GMT." }, "parent": { "type": "integer", "description": "The ID for the parent of the comment." }, "post": { "type": "integer", "description": "The ID of the associated post object." }, "status": { "type": "string", "description": "State of the comment." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/comments/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the comment." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "author": { "type": "integer", "description": "The ID of the user object, if author was a user." }, "author_email": { "type": "string", "format": "email", "description": "Email address for the comment author." }, "author_ip": { "type": "string", "format": "ip", "description": "IP address for the comment author." }, "author_name": { "type": "string", "description": "Display name for the comment author." }, "author_url": { "type": "string", "format": "uri", "description": "URL for the comment author." }, "author_user_agent": { "type": "string", "description": "User agent for the comment author." }, "content": { "type": "object", "description": "The content for the comment." }, "date": { "type": "string", "format": "date-time", "description": "The date the comment was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the comment was published, as GMT." }, "parent": { "type": "integer", "description": "The ID for the parent of the comment." }, "post": { "type": "integer", "description": "The ID of the associated post object." }, "status": { "type": "string", "description": "State of the comment." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/comments/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the comment." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the parent post of the comment (if the post is password protected)." } ] } }, "/wp/v2/e-floating-buttons": { "get": { "summary": "GET /wp/v2/e-floating-buttons", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "author", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to posts assigned to specific authors." }, { "name": "author_exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes posts assigned to specific authors." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "menu_order", "in": "query", "schema": { "type": "integer" }, "description": "Limit result set to posts with a specific menu_order value." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order" ] }, "description": "Sort collection by post attribute." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "any" ], "type": "string" }, "default": "publish" }, "description": "Limit result set to posts assigned one or more statuses." }, { "name": "format", "in": "query", "schema": { "type": "array", "items": { "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "type": "string" } }, "description": "Limit result set to items assigned one or more given formats." } ] }, "post": { "summary": "POST /wp/v2/e-floating-buttons", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "menu_order": { "type": "integer", "description": "The order of the post in relation to other posts." }, "format": { "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "description": "The format for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } } }, "/wp/v2/e-floating-buttons/{id}": { "get": { "summary": "GET /wp/v2/e-floating-buttons/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "excerpt_length", "in": "query", "schema": { "type": "integer" }, "description": "Override the default excerpt length." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the post if it is password protected." } ] }, "post": { "summary": "POST /wp/v2/e-floating-buttons/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "menu_order": { "type": "integer", "description": "The order of the post in relation to other posts." }, "format": { "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "description": "The format for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "put": { "summary": "PUT /wp/v2/e-floating-buttons/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "menu_order": { "type": "integer", "description": "The order of the post in relation to other posts." }, "format": { "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "description": "The format for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/e-floating-buttons/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "menu_order": { "type": "integer", "description": "The order of the post in relation to other posts." }, "format": { "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "description": "The format for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/e-floating-buttons/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/e-floating-buttons/{id}/autosaves": { "get": { "summary": "GET /wp/v2/e-floating-buttons/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/e-floating-buttons/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parent": { "type": "integer", "description": "The ID for the parent of the autosave." }, "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "menu_order": { "type": "integer", "description": "The order of the post in relation to other posts." }, "format": { "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "description": "The format for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } } }, "/wp/v2/e-floating-buttons/{parent}/autosaves/{id}": { "get": { "summary": "GET /wp/v2/e-floating-buttons/{parent}/autosaves/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/e-floating-buttons/{parent}/revisions": { "get": { "summary": "GET /wp/v2/e-floating-buttons/{parent}/revisions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "date", "id", "include", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by object attribute." } ] } }, "/wp/v2/e-floating-buttons/{parent}/revisions/{id}": { "get": { "summary": "GET /wp/v2/e-floating-buttons/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "delete": { "summary": "DELETE /wp/v2/e-floating-buttons/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as revisions do not support trashing." } ] } }, "/wp/v2/elementor_library": { "get": { "summary": "GET /wp/v2/elementor_library", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "author", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to posts assigned to specific authors." }, { "name": "author_exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes posts assigned to specific authors." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by post attribute." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "any" ], "type": "string" }, "default": "publish" }, "description": "Limit result set to posts assigned one or more statuses." } ] }, "post": { "summary": "POST /wp/v2/elementor_library", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } } }, "/wp/v2/elementor_library/{id}": { "get": { "summary": "GET /wp/v2/elementor_library/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the post if it is password protected." } ] }, "post": { "summary": "POST /wp/v2/elementor_library/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "put": { "summary": "PUT /wp/v2/elementor_library/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/elementor_library/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/elementor_library/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/fcrm-dummy": { "get": { "summary": "GET /wp/v2/fcrm-dummy", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by post attribute." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "any" ], "type": "string" }, "default": "publish" }, "description": "Limit result set to posts assigned one or more statuses." } ] }, "post": { "summary": "POST /wp/v2/fcrm-dummy", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "content": { "type": "object", "description": "The content for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } } }, "/wp/v2/fcrm-dummy/{id}": { "get": { "summary": "GET /wp/v2/fcrm-dummy/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the post if it is password protected." } ] }, "post": { "summary": "POST /wp/v2/fcrm-dummy/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "content": { "type": "object", "description": "The content for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "put": { "summary": "PUT /wp/v2/fcrm-dummy/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "content": { "type": "object", "description": "The content for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/fcrm-dummy/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "content": { "type": "object", "description": "The content for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/fcrm-dummy/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/fcrm-dummy/{id}/autosaves": { "get": { "summary": "GET /wp/v2/fcrm-dummy/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/fcrm-dummy/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parent": { "type": "integer", "description": "The ID for the parent of the autosave." }, "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "content": { "type": "object", "description": "The content for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } } }, "/wp/v2/fcrm-dummy/{parent}/autosaves/{id}": { "get": { "summary": "GET /wp/v2/fcrm-dummy/{parent}/autosaves/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/font-collections": { "get": { "summary": "GET /wp/v2/font-collections", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." } ] } }, "/wp/v2/font-collections/{slug}": { "get": { "summary": "GET /wp/v2/font-collections/{slug}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/font-families": { "get": { "summary": "GET /wp/v2/font-families", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "id", "enum": [ "id", "include" ] }, "description": "Sort collection by post attribute." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." } ] }, "post": { "summary": "POST /wp/v2/font-families", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "theme_json_version": { "type": "integer", "default": 3, "description": "Version of the theme.json schema used for the typography settings." }, "font_family_settings": { "type": "string", "description": "font-family declaration in theme.json format, encoded as a string." } }, "required": [ "font_family_settings" ] } } } } } }, "/wp/v2/font-families/{font_family_id}/font-faces": { "get": { "summary": "GET /wp/v2/font-families/{font_family_id}/font-faces", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "font_family_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent font family of the font face." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "id", "enum": [ "id", "include" ] }, "description": "Sort collection by post attribute." } ] }, "post": { "summary": "POST /wp/v2/font-families/{font_family_id}/font-faces", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "font_family_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent font family of the font face." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "theme_json_version": { "type": "integer", "default": 3, "description": "Version of the theme.json schema used for the typography settings." }, "font_face_settings": { "type": "string", "description": "font-face declaration in theme.json format, encoded as a string." } }, "required": [ "font_face_settings" ] } } } } } }, "/wp/v2/font-families/{font_family_id}/font-faces/{id}": { "get": { "summary": "GET /wp/v2/font-families/{font_family_id}/font-faces/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "font_family_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent font family of the font face." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the font face." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "delete": { "summary": "DELETE /wp/v2/font-families/{font_family_id}/font-faces/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "font_family_id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent font family of the font face." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the font face." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/font-families/{id}": { "get": { "summary": "GET /wp/v2/font-families/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/font-families/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "theme_json_version": { "type": "integer", "default": 3, "description": "Version of the theme.json schema used for the typography settings." }, "font_family_settings": { "type": "string", "description": "font-family declaration in theme.json format, encoded as a string." } }, "required": [ "font_family_settings" ] } } } } }, "put": { "summary": "PUT /wp/v2/font-families/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "theme_json_version": { "type": "integer", "default": 3, "description": "Version of the theme.json schema used for the typography settings." }, "font_family_settings": { "type": "string", "description": "font-family declaration in theme.json format, encoded as a string." } }, "required": [ "font_family_settings" ] } } } } }, "patch": { "summary": "PATCH /wp/v2/font-families/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "theme_json_version": { "type": "integer", "default": 3, "description": "Version of the theme.json schema used for the typography settings." }, "font_family_settings": { "type": "string", "description": "font-family declaration in theme.json format, encoded as a string." } }, "required": [ "font_family_settings" ] } } } } }, "delete": { "summary": "DELETE /wp/v2/font-families/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/global-styles/themes/{stylesheet}": { "get": { "summary": "GET /wp/v2/global-styles/themes/{stylesheet}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "stylesheet", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The theme identifier" } ] } }, "/wp/v2/global-styles/themes/{stylesheet}/variations": { "get": { "summary": "GET /wp/v2/global-styles/themes/{stylesheet}/variations", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "stylesheet", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The theme identifier" } ] } }, "/wp/v2/global-styles/{id}": { "get": { "summary": "GET /wp/v2/global-styles/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "ID of global styles config." } ] }, "post": { "summary": "POST /wp/v2/global-styles/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "styles": { "type": "object", "description": "Global styles." }, "settings": { "type": "object", "description": "Global settings." }, "title": { "type": "object", "description": "Title of the global styles variation." } } } } } } }, "put": { "summary": "PUT /wp/v2/global-styles/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "styles": { "type": "object", "description": "Global styles." }, "settings": { "type": "object", "description": "Global settings." }, "title": { "type": "object", "description": "Title of the global styles variation." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/global-styles/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "styles": { "type": "object", "description": "Global styles." }, "settings": { "type": "object", "description": "Global settings." }, "title": { "type": "object", "description": "Title of the global styles variation." } } } } } } } }, "/wp/v2/global-styles/{parent}/revisions": { "get": { "summary": "GET /wp/v2/global-styles/{parent}/revisions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." } ] } }, "/wp/v2/global-styles/{parent}/revisions/{id}": { "get": { "summary": "GET /wp/v2/global-styles/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the global styles revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the global styles revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/icon-collections": { "get": { "summary": "GET /wp/v2/icon-collections", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." } ] } }, "/wp/v2/icon-collections/{slug}": { "get": { "summary": "GET /wp/v2/icon-collections/{slug}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "slug", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Icon collection slug." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/icons": { "get": { "summary": "GET /wp/v2/icons", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "collection", "in": "query", "schema": { "type": "string" }, "description": "Limit results to icons belonging to the given collection slug." } ] } }, "/wp/v2/icons/{collection}": { "get": { "summary": "GET /wp/v2/icons/{collection}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "collection", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Limit results to icons belonging to the given collection slug." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." } ] } }, "/wp/v2/icons/{name}": { "get": { "summary": "GET /wp/v2/icons/{name}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "name", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Icon name." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/media": { "get": { "summary": "GET /wp/v2/media", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "author", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to posts assigned to specific authors." }, { "name": "author_exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes posts assigned to specific authors." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by post attribute." }, { "name": "parent", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to items with particular parent IDs." }, { "name": "parent_exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to all items except those of a particular parent ID." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "inherit", "private", "trash" ], "type": "string" }, "default": "inherit" }, "description": "Limit result set to posts assigned one or more statuses." }, { "name": "media_type", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "image", "video", "text", "application", "audio" ] } }, "description": "Limit result set to attachments of a particular media type or media types." }, { "name": "mime_type", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to attachments of a particular MIME type or MIME types." } ] }, "post": { "summary": "POST /wp/v2/media", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "title": { "type": "object", "description": "The title for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "alt_text": { "type": "string", "description": "Alternative text to display when attachment is not displayed." }, "caption": { "type": "object", "description": "The attachment caption." }, "description": { "type": "object", "description": "The attachment description." }, "post": { "type": "integer", "description": "The ID for the associated post of the attachment." }, "generate_sub_sizes": { "type": "boolean", "default": true, "description": "Whether to generate image sub sizes." }, "convert_format": { "type": "boolean", "default": true, "description": "Whether to convert image formats." }, "url": { "type": "string", "format": "uri", "description": "URL of an external image to sideload into the media library, instead of uploading a file." } } } } } } } }, "/wp/v2/media/{id}": { "get": { "summary": "GET /wp/v2/media/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/media/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "title": { "type": "object", "description": "The title for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "alt_text": { "type": "string", "description": "Alternative text to display when attachment is not displayed." }, "caption": { "type": "object", "description": "The attachment caption." }, "description": { "type": "object", "description": "The attachment description." }, "post": { "type": "integer", "description": "The ID for the associated post of the attachment." } } } } } } }, "put": { "summary": "PUT /wp/v2/media/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "title": { "type": "object", "description": "The title for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "alt_text": { "type": "string", "description": "Alternative text to display when attachment is not displayed." }, "caption": { "type": "object", "description": "The attachment caption." }, "description": { "type": "object", "description": "The attachment description." }, "post": { "type": "integer", "description": "The ID for the associated post of the attachment." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/media/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "title": { "type": "object", "description": "The title for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "alt_text": { "type": "string", "description": "Alternative text to display when attachment is not displayed." }, "caption": { "type": "object", "description": "The attachment caption." }, "description": { "type": "object", "description": "The attachment description." }, "post": { "type": "integer", "description": "The ID for the associated post of the attachment." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/media/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/media/{id}/edit": { "post": { "summary": "POST /wp/v2/media/{id}/edit", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "src": { "type": "string", "format": "uri", "description": "URL to the edited image file." }, "modifiers": { "type": "array", "items": { "description": "Image edit.", "type": "object", "required": [ "type", "args" ], "oneOf": [ { "title": "Flip", "properties": { "type": { "description": "Flip type.", "type": "string", "enum": [ "flip" ] }, "args": { "description": "Flip arguments.", "type": "object", "required": [ "flip" ], "properties": { "flip": { "description": "Flip direction.", "type": "object", "required": [ "horizontal", "vertical" ], "properties": { "horizontal": { "description": "Whether to flip in the horizontal direction.", "type": "boolean" }, "vertical": { "description": "Whether to flip in the vertical direction.", "type": "boolean" } } } } } } }, { "title": "Rotation", "properties": { "type": { "description": "Rotation type.", "type": "string", "enum": [ "rotate" ] }, "args": { "description": "Rotation arguments.", "type": "object", "required": [ "angle" ], "properties": { "angle": { "description": "Angle to rotate clockwise in degrees.", "type": "number" } } } } }, { "title": "Crop", "properties": { "type": { "description": "Crop type.", "type": "string", "enum": [ "crop" ] }, "args": { "description": "Crop arguments.", "type": "object", "required": [ "left", "top", "width", "height" ], "properties": { "left": { "description": "Horizontal position from the left to begin the crop as a percentage of the image width.", "type": "number" }, "top": { "description": "Vertical position from the top to begin the crop as a percentage of the image height.", "type": "number" }, "width": { "description": "Width of the crop as a percentage of the image width.", "type": "number" }, "height": { "description": "Height of the crop as a percentage of the image height.", "type": "number" } } } } } ] }, "description": "Array of image edits." }, "rotation": { "type": "integer", "description": "The amount to rotate the image clockwise in degrees. DEPRECATED: Use `modifiers` instead." }, "x": { "type": "number", "description": "As a percentage of the image, the x position to start the crop from. DEPRECATED: Use `modifiers` instead." }, "y": { "type": "number", "description": "As a percentage of the image, the y position to start the crop from. DEPRECATED: Use `modifiers` instead." }, "width": { "type": "number", "description": "As a percentage of the image, the width to crop the image to. DEPRECATED: Use `modifiers` instead." }, "height": { "type": "number", "description": "As a percentage of the image, the height to crop the image to. DEPRECATED: Use `modifiers` instead." }, "caption": { "type": "object", "description": "The attachment caption." }, "description": { "type": "object", "description": "The attachment description." }, "title": { "type": "object", "description": "The title for the post." }, "post": { "type": "integer", "description": "The ID for the associated post of the attachment." }, "alt_text": { "type": "string", "description": "Alternative text to display when attachment is not displayed." } }, "required": [ "src" ] } } } } } }, "/wp/v2/media/{id}/finalize": { "post": { "summary": "POST /wp/v2/media/{id}/finalize", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the attachment." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "sub_sizes": { "type": "array", "items": { "type": "object", "properties": { "image_size": { "description": "Size name, or an array of size names when a single file is registered under multiple sizes with matching dimensions.", "type": [ "string", "array" ], "items": { "type": "string", "minLength": 1 }, "minItems": 1, "minLength": 1, "required": true }, "width": { "type": "integer", "minimum": 1 }, "height": { "type": "integer", "minimum": 1 }, "file": { "type": "string", "minLength": 1 }, "mime_type": { "type": "string", "pattern": "^image/.*" }, "filesize": { "type": "integer", "minimum": 1 }, "original_image": { "type": "string", "minLength": 1 } } }, "default": [], "description": "Array of sub-size metadata collected from sideload responses." } } } } } } } }, "/wp/v2/media/{id}/post-process": { "post": { "summary": "POST /wp/v2/media/{id}/post-process", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the attachment." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "create-image-subsizes" ] } }, "required": [ "action" ] } } } } } }, "/wp/v2/media/{id}/sideload": { "post": { "summary": "POST /wp/v2/media/{id}/sideload", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the attachment." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "image_size": { "type": "string", "description": "Image size. Can be a single size name or an array of size names to register the same file under multiple sizes." }, "convert_format": { "type": "boolean", "default": true, "description": "Whether to convert image formats." } }, "required": [ "image_size" ] } } } } } }, "/wp/v2/menu-items": { "get": { "summary": "GET /wp/v2/menu-items", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "menu_order", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order" ] }, "description": "Sort collection by object attribute." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "any" ], "type": "string" }, "default": "publish" }, "description": "Limit result set to posts assigned one or more statuses." }, { "name": "tax_relation", "in": "query", "schema": { "type": "string", "enum": [ "AND", "OR" ] }, "description": "Limit result set based on relationship between multiple taxonomies." }, { "name": "menus", "in": "query", "schema": { "type": "object" }, "description": "Limit result set to items with specific terms assigned in the menus taxonomy." }, { "name": "menus_exclude", "in": "query", "schema": { "type": "object" }, "description": "Limit result set to items except those with specific terms assigned in the menus taxonomy." }, { "name": "menu_order", "in": "query", "schema": { "type": "integer" }, "description": "Limit result set to posts with a specific menu_order value." } ] }, "post": { "summary": "POST /wp/v2/menu-items", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "The title for the object." }, "type": { "type": "string", "default": "custom", "enum": [ "taxonomy", "post_type", "post_type_archive", "custom" ], "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." }, "status": { "type": "string", "default": "publish", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the object." }, "parent": { "type": "integer", "default": 0, "description": "The ID for the parent of the object." }, "attr_title": { "type": "string", "description": "Text for the title attribute of the link element for this menu item." }, "classes": { "type": "array", "items": { "type": "string" }, "description": "Class names for the link element of this menu item." }, "description": { "type": "string", "description": "The description of this menu item." }, "menu_order": { "type": "integer", "default": 1, "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." }, "object": { "type": "string", "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." }, "object_id": { "type": "integer", "default": 0, "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." }, "target": { "type": "string", "enum": [ "_blank", "" ], "description": "The target attribute of the link element for this menu item." }, "url": { "type": "string", "format": "uri", "description": "The URL to which this menu item points." }, "xfn": { "type": "array", "items": { "type": "string" }, "description": "The XFN relationship expressed in the link of this menu item." }, "menus": { "type": "integer", "description": "The terms assigned to the object in the nav_menu taxonomy." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } } }, "/wp/v2/menu-items/{id}": { "get": { "summary": "GET /wp/v2/menu-items/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/menu-items/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "The title for the object." }, "type": { "type": "string", "enum": [ "taxonomy", "post_type", "post_type_archive", "custom" ], "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the object." }, "parent": { "type": "integer", "description": "The ID for the parent of the object." }, "attr_title": { "type": "string", "description": "Text for the title attribute of the link element for this menu item." }, "classes": { "type": "array", "items": { "type": "string" }, "description": "Class names for the link element of this menu item." }, "description": { "type": "string", "description": "The description of this menu item." }, "menu_order": { "type": "integer", "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." }, "object": { "type": "string", "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." }, "object_id": { "type": "integer", "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." }, "target": { "type": "string", "enum": [ "_blank", "" ], "description": "The target attribute of the link element for this menu item." }, "url": { "type": "string", "format": "uri", "description": "The URL to which this menu item points." }, "xfn": { "type": "array", "items": { "type": "string" }, "description": "The XFN relationship expressed in the link of this menu item." }, "menus": { "type": "integer", "description": "The terms assigned to the object in the nav_menu taxonomy." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "put": { "summary": "PUT /wp/v2/menu-items/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "The title for the object." }, "type": { "type": "string", "enum": [ "taxonomy", "post_type", "post_type_archive", "custom" ], "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the object." }, "parent": { "type": "integer", "description": "The ID for the parent of the object." }, "attr_title": { "type": "string", "description": "Text for the title attribute of the link element for this menu item." }, "classes": { "type": "array", "items": { "type": "string" }, "description": "Class names for the link element of this menu item." }, "description": { "type": "string", "description": "The description of this menu item." }, "menu_order": { "type": "integer", "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." }, "object": { "type": "string", "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." }, "object_id": { "type": "integer", "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." }, "target": { "type": "string", "enum": [ "_blank", "" ], "description": "The target attribute of the link element for this menu item." }, "url": { "type": "string", "format": "uri", "description": "The URL to which this menu item points." }, "xfn": { "type": "array", "items": { "type": "string" }, "description": "The XFN relationship expressed in the link of this menu item." }, "menus": { "type": "integer", "description": "The terms assigned to the object in the nav_menu taxonomy." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/menu-items/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "description": "The title for the object." }, "type": { "type": "string", "enum": [ "taxonomy", "post_type", "post_type_archive", "custom" ], "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the object." }, "parent": { "type": "integer", "description": "The ID for the parent of the object." }, "attr_title": { "type": "string", "description": "Text for the title attribute of the link element for this menu item." }, "classes": { "type": "array", "items": { "type": "string" }, "description": "Class names for the link element of this menu item." }, "description": { "type": "string", "description": "The description of this menu item." }, "menu_order": { "type": "integer", "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." }, "object": { "type": "string", "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." }, "object_id": { "type": "integer", "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." }, "target": { "type": "string", "enum": [ "_blank", "" ], "description": "The target attribute of the link element for this menu item." }, "url": { "type": "string", "format": "uri", "description": "The URL to which this menu item points." }, "xfn": { "type": "array", "items": { "type": "string" }, "description": "The XFN relationship expressed in the link of this menu item." }, "menus": { "type": "integer", "description": "The terms assigned to the object in the nav_menu taxonomy." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/menu-items/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/menu-items/{id}/autosaves": { "get": { "summary": "GET /wp/v2/menu-items/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/menu-items/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parent": { "type": "integer", "description": "The ID for the parent of the object." }, "title": { "type": "string", "description": "The title for the object." }, "type": { "type": "string", "enum": [ "taxonomy", "post_type", "post_type_archive", "custom" ], "description": "The family of objects originally represented, such as \"post_type\" or \"taxonomy\"." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the object." }, "attr_title": { "type": "string", "description": "Text for the title attribute of the link element for this menu item." }, "classes": { "type": "array", "items": { "type": "string" }, "description": "Class names for the link element of this menu item." }, "description": { "type": "string", "description": "The description of this menu item." }, "menu_order": { "type": "integer", "description": "The DB ID of the nav_menu_item that is this item's menu parent, if any, otherwise 0." }, "object": { "type": "string", "description": "The type of object originally represented, such as \"category\", \"post\", or \"attachment\"." }, "object_id": { "type": "integer", "description": "The database ID of the original object this menu item represents, for example the ID for posts or the term_id for categories." }, "target": { "type": "string", "enum": [ "_blank", "" ], "description": "The target attribute of the link element for this menu item." }, "url": { "type": "string", "format": "uri", "description": "The URL to which this menu item points." }, "xfn": { "type": "array", "items": { "type": "string" }, "description": "The XFN relationship expressed in the link of this menu item." }, "menus": { "type": "integer", "description": "The terms assigned to the object in the nav_menu taxonomy." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } } }, "/wp/v2/menu-items/{parent}/autosaves/{id}": { "get": { "summary": "GET /wp/v2/menu-items/{parent}/autosaves/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/menu-locations": { "get": { "summary": "GET /wp/v2/menu-locations", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/menu-locations/{location}": { "get": { "summary": "GET /wp/v2/menu-locations/{location}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "location", "in": "path", "required": true, "schema": { "type": "string" }, "description": "An alphanumeric identifier for the menu location." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/menus": { "get": { "summary": "GET /wp/v2/menus", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ] }, "description": "Sort collection by term attribute." }, { "name": "hide_empty", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to hide terms not assigned to any posts." }, { "name": "post", "in": "query", "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific post." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to terms with one or more specific slugs." } ] }, "post": { "summary": "POST /wp/v2/menus", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." }, "locations": { "type": "array", "items": { "type": "string" }, "description": "The locations assigned to the menu." }, "auto_add": { "type": "boolean", "description": "Whether to automatically add top level pages to this menu." } }, "required": [ "name" ] } } } } } }, "/wp/v2/menus/{id}": { "get": { "summary": "GET /wp/v2/menus/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/menus/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." }, "locations": { "type": "array", "items": { "type": "string" }, "description": "The locations assigned to the menu." }, "auto_add": { "type": "boolean", "description": "Whether to automatically add top level pages to this menu." } } } } } } }, "put": { "summary": "PUT /wp/v2/menus/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." }, "locations": { "type": "array", "items": { "type": "string" }, "description": "The locations assigned to the menu." }, "auto_add": { "type": "boolean", "description": "Whether to automatically add top level pages to this menu." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/menus/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." }, "locations": { "type": "array", "items": { "type": "string" }, "description": "The locations assigned to the menu." }, "auto_add": { "type": "boolean", "description": "Whether to automatically add top level pages to this menu." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/menus/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as terms do not support trashing." } ] } }, "/wp/v2/navigation": { "get": { "summary": "GET /wp/v2/navigation", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by post attribute." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "any" ], "type": "string" }, "default": "publish" }, "description": "Limit result set to posts assigned one or more statuses." } ] }, "post": { "summary": "POST /wp/v2/navigation", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } } }, "/wp/v2/navigation/{id}": { "get": { "summary": "GET /wp/v2/navigation/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the post if it is password protected." } ] }, "post": { "summary": "POST /wp/v2/navigation/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "put": { "summary": "PUT /wp/v2/navigation/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/navigation/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/navigation/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/navigation/{id}/autosaves": { "get": { "summary": "GET /wp/v2/navigation/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/navigation/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parent": { "type": "integer", "description": "The ID for the parent of the autosave." }, "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } } }, "/wp/v2/navigation/{parent}/autosaves/{id}": { "get": { "summary": "GET /wp/v2/navigation/{parent}/autosaves/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/navigation/{parent}/revisions": { "get": { "summary": "GET /wp/v2/navigation/{parent}/revisions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "date", "id", "include", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by object attribute." } ] } }, "/wp/v2/navigation/{parent}/revisions/{id}": { "get": { "summary": "GET /wp/v2/navigation/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "delete": { "summary": "DELETE /wp/v2/navigation/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as revisions do not support trashing." } ] } }, "/wp/v2/pages": { "get": { "summary": "GET /wp/v2/pages", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "author", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to posts assigned to specific authors." }, { "name": "author_exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes posts assigned to specific authors." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "menu_order", "in": "query", "schema": { "type": "integer" }, "description": "Limit result set to posts with a specific menu_order value." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "menu_order" ] }, "description": "Sort collection by post attribute." }, { "name": "parent", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to items with particular parent IDs." }, { "name": "parent_exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to all items except those of a particular parent ID." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "any" ], "type": "string" }, "default": "publish" }, "description": "Limit result set to posts assigned one or more statuses." } ] }, "post": { "summary": "POST /wp/v2/pages", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "parent": { "type": "integer", "description": "The ID for the parent of the post." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "menu_order": { "type": "integer", "description": "The order of the post in relation to other posts." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } } }, "/wp/v2/pages/{id}": { "get": { "summary": "GET /wp/v2/pages/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "excerpt_length", "in": "query", "schema": { "type": "integer" }, "description": "Override the default excerpt length." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the post if it is password protected." } ] }, "post": { "summary": "POST /wp/v2/pages/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "parent": { "type": "integer", "description": "The ID for the parent of the post." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "menu_order": { "type": "integer", "description": "The order of the post in relation to other posts." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "put": { "summary": "PUT /wp/v2/pages/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "parent": { "type": "integer", "description": "The ID for the parent of the post." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "menu_order": { "type": "integer", "description": "The order of the post in relation to other posts." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/pages/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "parent": { "type": "integer", "description": "The ID for the parent of the post." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "menu_order": { "type": "integer", "description": "The order of the post in relation to other posts." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/pages/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/pages/{id}/autosaves": { "get": { "summary": "GET /wp/v2/pages/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/pages/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parent": { "type": "integer", "description": "The ID for the parent of the post." }, "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "menu_order": { "type": "integer", "description": "The order of the post in relation to other posts." }, "meta": { "type": "object", "description": "Meta fields." }, "template": { "type": "string", "description": "The theme file to use to display the post." } } } } } } } }, "/wp/v2/pages/{parent}/autosaves/{id}": { "get": { "summary": "GET /wp/v2/pages/{parent}/autosaves/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/pages/{parent}/revisions": { "get": { "summary": "GET /wp/v2/pages/{parent}/revisions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "date", "id", "include", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by object attribute." } ] } }, "/wp/v2/pages/{parent}/revisions/{id}": { "get": { "summary": "GET /wp/v2/pages/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "delete": { "summary": "DELETE /wp/v2/pages/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as revisions do not support trashing." } ] } }, "/wp/v2/pattern-directory/patterns": { "get": { "summary": "GET /wp/v2/pattern-directory/patterns", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 100 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "category", "in": "query", "schema": { "type": "integer" }, "description": "Limit results to those matching a category ID." }, { "name": "keyword", "in": "query", "schema": { "type": "integer" }, "description": "Limit results to those matching a keyword ID." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit results to those matching a pattern (slug)." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title", "favorite_count" ] }, "description": "Sort collection by post attribute." } ] } }, "/wp/v2/plugins": { "get": { "summary": "GET /wp/v2/plugins", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "type": "string", "enum": [ "inactive", "active" ] } }, "description": "Limits results to plugins with the given status." } ] }, "post": { "summary": "POST /wp/v2/plugins", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "WordPress.org plugin directory slug." }, "status": { "type": "string", "default": "inactive", "enum": [ "inactive", "active" ], "description": "The plugin activation status." } }, "required": [ "slug" ] } } } } } }, "/wp/v2/plugins/{plugin}": { "get": { "summary": "GET /wp/v2/plugins/{plugin}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "plugin", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/plugins/{plugin}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "plugin", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "context": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ], "description": "Scope under which the request is made; determines fields present in response." }, "status": { "type": "string", "enum": [ "inactive", "active" ], "description": "The plugin activation status." } } } } } } }, "put": { "summary": "PUT /wp/v2/plugins/{plugin}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "plugin", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "context": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ], "description": "Scope under which the request is made; determines fields present in response." }, "status": { "type": "string", "enum": [ "inactive", "active" ], "description": "The plugin activation status." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/plugins/{plugin}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "plugin", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "context": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ], "description": "Scope under which the request is made; determines fields present in response." }, "status": { "type": "string", "enum": [ "inactive", "active" ], "description": "The plugin activation status." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/plugins/{plugin}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "plugin", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/posts": { "get": { "summary": "GET /wp/v2/posts", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published after a given ISO8601 compliant date." }, { "name": "modified_after", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified after a given ISO8601 compliant date." }, { "name": "author", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to posts assigned to specific authors." }, { "name": "author_exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes posts assigned to specific authors." }, { "name": "before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts published before a given ISO8601 compliant date." }, { "name": "modified_before", "in": "query", "schema": { "type": "string", "format": "date-time" }, "description": "Limit response to posts modified before a given ISO8601 compliant date." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "search_semantics", "in": "query", "schema": { "type": "string", "enum": [ "exact" ] }, "description": "How to interpret the search input." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "author", "date", "id", "include", "modified", "parent", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by post attribute." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post_title", "post_content", "post_excerpt" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to posts with one or more specific slugs." }, { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "publish", "future", "draft", "pending", "private", "trash", "auto-draft", "inherit", "request-pending", "request-confirmed", "request-failed", "request-completed", "any" ], "type": "string" }, "default": "publish" }, "description": "Limit result set to posts assigned one or more statuses." }, { "name": "tax_relation", "in": "query", "schema": { "type": "string", "enum": [ "AND", "OR" ] }, "description": "Limit result set based on relationship between multiple taxonomies." }, { "name": "categories", "in": "query", "schema": { "type": "object" }, "description": "Limit result set to items with specific terms assigned in the categories taxonomy." }, { "name": "categories_exclude", "in": "query", "schema": { "type": "object" }, "description": "Limit result set to items except those with specific terms assigned in the categories taxonomy." }, { "name": "tags", "in": "query", "schema": { "type": "object" }, "description": "Limit result set to items with specific terms assigned in the tags taxonomy." }, { "name": "tags_exclude", "in": "query", "schema": { "type": "object" }, "description": "Limit result set to items except those with specific terms assigned in the tags taxonomy." }, { "name": "sticky", "in": "query", "schema": { "type": "boolean" }, "description": "Limit result set to items that are sticky." }, { "name": "ignore_sticky", "in": "query", "schema": { "type": "boolean", "default": true }, "description": "Whether to ignore sticky posts or not." }, { "name": "format", "in": "query", "schema": { "type": "array", "items": { "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "type": "string" } }, "description": "Limit result set to items assigned one or more given formats." } ] }, "post": { "summary": "POST /wp/v2/posts", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "format": { "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "description": "The format for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "sticky": { "type": "boolean", "description": "Whether or not the post should be treated as sticky." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "categories": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the category taxonomy." }, "tags": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the post_tag taxonomy." } } } } } } } }, "/wp/v2/posts/{id}": { "get": { "summary": "GET /wp/v2/posts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "excerpt_length", "in": "query", "schema": { "type": "integer" }, "description": "Override the default excerpt length." }, { "name": "password", "in": "query", "schema": { "type": "string" }, "description": "The password for the post if it is password protected." } ] }, "post": { "summary": "POST /wp/v2/posts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "format": { "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "description": "The format for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "sticky": { "type": "boolean", "description": "Whether or not the post should be treated as sticky." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "categories": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the category taxonomy." }, "tags": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the post_tag taxonomy." } } } } } } }, "put": { "summary": "PUT /wp/v2/posts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "format": { "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "description": "The format for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "sticky": { "type": "boolean", "description": "Whether or not the post should be treated as sticky." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "categories": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the category taxonomy." }, "tags": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the post_tag taxonomy." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/posts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "format": { "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "description": "The format for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "sticky": { "type": "boolean", "description": "Whether or not the post should be treated as sticky." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "categories": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the category taxonomy." }, "tags": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the post_tag taxonomy." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/posts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the post." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/posts/{id}/autosaves": { "get": { "summary": "GET /wp/v2/posts/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "parent", "in": "query", "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/posts/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "parent": { "type": "integer", "description": "The ID for the parent of the autosave." }, "date": { "type": "string", "format": "date-time", "description": "The date the post was published, in the site's timezone." }, "date_gmt": { "type": "string", "format": "date-time", "description": "The date the post was published, as GMT." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the post unique to its type." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "A named status for the post." }, "password": { "type": "string", "description": "A password to protect access to the content and excerpt." }, "title": { "type": "object", "description": "The title for the post." }, "content": { "type": "object", "description": "The content for the post." }, "author": { "type": "integer", "description": "The ID for the author of the post." }, "excerpt": { "type": "object", "description": "The excerpt for the post." }, "featured_media": { "type": "integer", "description": "The ID of the featured media for the post." }, "comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not comments are open on the post." }, "ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Whether or not the post can be pinged." }, "format": { "type": "string", "enum": [ "standard", "aside", "chat", "gallery", "link", "image", "quote", "status", "video", "audio" ], "description": "The format for the post." }, "meta": { "type": "object", "description": "Meta fields." }, "sticky": { "type": "boolean", "description": "Whether or not the post should be treated as sticky." }, "template": { "type": "string", "description": "The theme file to use to display the post." }, "categories": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the category taxonomy." }, "tags": { "type": "array", "items": { "type": "integer" }, "description": "The terms assigned to the post in the post_tag taxonomy." } } } } } } } }, "/wp/v2/posts/{parent}/autosaves/{id}": { "get": { "summary": "GET /wp/v2/posts/{parent}/autosaves/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the autosave." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/posts/{parent}/revisions": { "get": { "summary": "GET /wp/v2/posts/{parent}/revisions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "date", "id", "include", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by object attribute." } ] } }, "/wp/v2/posts/{parent}/revisions/{id}": { "get": { "summary": "GET /wp/v2/posts/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "delete": { "summary": "DELETE /wp/v2/posts/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the parent of the revision." }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as revisions do not support trashing." } ] } }, "/wp/v2/search": { "get": { "summary": "GET /wp/v2/search", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "type", "in": "query", "schema": { "type": "string", "default": "post", "enum": [ "post", "term", "post-format" ] }, "description": "Limit results to items of an object type." }, { "name": "subtype", "in": "query", "schema": { "type": "array", "items": { "enum": [ "post", "page", "e-floating-buttons", "elementor_library", "category", "post_tag", "any" ], "type": "string" }, "default": "any" }, "description": "Limit results to items of one or more object subtypes." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." } ] } }, "/wp/v2/settings": { "get": { "summary": "GET /wp/v2/settings", "responses": { "200": { "description": "Successful response" } } }, "post": { "summary": "POST /wp/v2/settings", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "hello_elementor_settings_description_meta_tag": { "type": "string" }, "hello_elementor_settings_skip_link": { "type": "string" }, "hello_elementor_settings_header_footer": { "type": "string" }, "hello_elementor_settings_page_title": { "type": "string" }, "hello_elementor_settings_hello_style": { "type": "string" }, "hello_elementor_settings_hello_theme": { "type": "string" }, "title": { "type": "string", "description": "Site title." }, "description": { "type": "string", "description": "Site tagline." }, "url": { "type": "string", "format": "uri", "description": "Site URL." }, "email": { "type": "string", "format": "email", "description": "This address is used for admin purposes, like new user notification." }, "timezone": { "type": "string", "description": "A city in the same timezone as you." }, "date_format": { "type": "string", "description": "A date format for all date strings." }, "time_format": { "type": "string", "description": "A time format for all time strings." }, "start_of_week": { "type": "integer", "description": "A day number of the week that the week should start on." }, "language": { "type": "string", "description": "WordPress locale code." }, "use_smilies": { "type": "boolean", "description": "Convert emoticons like :-) and :-P to graphics on display." }, "default_category": { "type": "integer", "description": "Default post category." }, "default_post_format": { "type": "string", "description": "Default post format." }, "posts_per_page": { "type": "integer", "description": "Blog pages show at most." }, "show_on_front": { "type": "string", "description": "What to show on the front page" }, "page_on_front": { "type": "integer", "description": "The ID of the page that should be displayed on the front page" }, "page_for_posts": { "type": "integer", "description": "The ID of the page that should display the latest posts" }, "default_ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles." }, "default_comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Allow people to submit comments on new posts." }, "site_logo": { "type": "integer", "description": "Site logo." }, "site_icon": { "type": "integer", "description": "Site icon." }, "elementor_one_welcome_screen_completed": { "type": "boolean", "description": "Elementor One Welcome Screen Completed" }, "elementor_one_dismiss_connect_alert": { "type": "boolean", "description": "Elementor One Dismiss Connect Alert" }, "elementor_one_dismiss_elementor_one_subscription_alert": { "type": "boolean", "description": "Elementor One Dismiss Elementor One Subscription Alert" } } } } } } }, "put": { "summary": "PUT /wp/v2/settings", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "hello_elementor_settings_description_meta_tag": { "type": "string" }, "hello_elementor_settings_skip_link": { "type": "string" }, "hello_elementor_settings_header_footer": { "type": "string" }, "hello_elementor_settings_page_title": { "type": "string" }, "hello_elementor_settings_hello_style": { "type": "string" }, "hello_elementor_settings_hello_theme": { "type": "string" }, "title": { "type": "string", "description": "Site title." }, "description": { "type": "string", "description": "Site tagline." }, "url": { "type": "string", "format": "uri", "description": "Site URL." }, "email": { "type": "string", "format": "email", "description": "This address is used for admin purposes, like new user notification." }, "timezone": { "type": "string", "description": "A city in the same timezone as you." }, "date_format": { "type": "string", "description": "A date format for all date strings." }, "time_format": { "type": "string", "description": "A time format for all time strings." }, "start_of_week": { "type": "integer", "description": "A day number of the week that the week should start on." }, "language": { "type": "string", "description": "WordPress locale code." }, "use_smilies": { "type": "boolean", "description": "Convert emoticons like :-) and :-P to graphics on display." }, "default_category": { "type": "integer", "description": "Default post category." }, "default_post_format": { "type": "string", "description": "Default post format." }, "posts_per_page": { "type": "integer", "description": "Blog pages show at most." }, "show_on_front": { "type": "string", "description": "What to show on the front page" }, "page_on_front": { "type": "integer", "description": "The ID of the page that should be displayed on the front page" }, "page_for_posts": { "type": "integer", "description": "The ID of the page that should display the latest posts" }, "default_ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles." }, "default_comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Allow people to submit comments on new posts." }, "site_logo": { "type": "integer", "description": "Site logo." }, "site_icon": { "type": "integer", "description": "Site icon." }, "elementor_one_welcome_screen_completed": { "type": "boolean", "description": "Elementor One Welcome Screen Completed" }, "elementor_one_dismiss_connect_alert": { "type": "boolean", "description": "Elementor One Dismiss Connect Alert" }, "elementor_one_dismiss_elementor_one_subscription_alert": { "type": "boolean", "description": "Elementor One Dismiss Elementor One Subscription Alert" } } } } } } }, "patch": { "summary": "PATCH /wp/v2/settings", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "hello_elementor_settings_description_meta_tag": { "type": "string" }, "hello_elementor_settings_skip_link": { "type": "string" }, "hello_elementor_settings_header_footer": { "type": "string" }, "hello_elementor_settings_page_title": { "type": "string" }, "hello_elementor_settings_hello_style": { "type": "string" }, "hello_elementor_settings_hello_theme": { "type": "string" }, "title": { "type": "string", "description": "Site title." }, "description": { "type": "string", "description": "Site tagline." }, "url": { "type": "string", "format": "uri", "description": "Site URL." }, "email": { "type": "string", "format": "email", "description": "This address is used for admin purposes, like new user notification." }, "timezone": { "type": "string", "description": "A city in the same timezone as you." }, "date_format": { "type": "string", "description": "A date format for all date strings." }, "time_format": { "type": "string", "description": "A time format for all time strings." }, "start_of_week": { "type": "integer", "description": "A day number of the week that the week should start on." }, "language": { "type": "string", "description": "WordPress locale code." }, "use_smilies": { "type": "boolean", "description": "Convert emoticons like :-) and :-P to graphics on display." }, "default_category": { "type": "integer", "description": "Default post category." }, "default_post_format": { "type": "string", "description": "Default post format." }, "posts_per_page": { "type": "integer", "description": "Blog pages show at most." }, "show_on_front": { "type": "string", "description": "What to show on the front page" }, "page_on_front": { "type": "integer", "description": "The ID of the page that should be displayed on the front page" }, "page_for_posts": { "type": "integer", "description": "The ID of the page that should display the latest posts" }, "default_ping_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles." }, "default_comment_status": { "type": "string", "enum": [ "open", "closed" ], "description": "Allow people to submit comments on new posts." }, "site_logo": { "type": "integer", "description": "Site logo." }, "site_icon": { "type": "integer", "description": "Site icon." }, "elementor_one_welcome_screen_completed": { "type": "boolean", "description": "Elementor One Welcome Screen Completed" }, "elementor_one_dismiss_connect_alert": { "type": "boolean", "description": "Elementor One Dismiss Connect Alert" }, "elementor_one_dismiss_elementor_one_subscription_alert": { "type": "boolean", "description": "Elementor One Dismiss Elementor One Subscription Alert" } } } } } } } }, "/wp/v2/sidebars": { "get": { "summary": "GET /wp/v2/sidebars", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/sidebars/{id}": { "get": { "summary": "GET /wp/v2/sidebars/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a registered sidebar" }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/sidebars/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "widgets": { "type": "array", "items": { "type": [ "object", "string" ] }, "description": "Nested widgets." } } } } } } }, "put": { "summary": "PUT /wp/v2/sidebars/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "widgets": { "type": "array", "items": { "type": [ "object", "string" ] }, "description": "Nested widgets." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/sidebars/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "widgets": { "type": "array", "items": { "type": [ "object", "string" ] }, "description": "Nested widgets." } } } } } } } }, "/wp/v2/statuses": { "get": { "summary": "GET /wp/v2/statuses", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/statuses/{status}": { "get": { "summary": "GET /wp/v2/statuses/{status}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "status", "in": "path", "required": true, "schema": { "type": "string" }, "description": "An alphanumeric identifier for the status." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/tags": { "get": { "summary": "GET /wp/v2/tags", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ] }, "description": "Sort collection by term attribute." }, { "name": "hide_empty", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to hide terms not assigned to any posts." }, { "name": "post", "in": "query", "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific post." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to terms with one or more specific slugs." } ] }, "post": { "summary": "POST /wp/v2/tags", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." } }, "required": [ "name" ] } } } } } }, "/wp/v2/tags/{id}": { "get": { "summary": "GET /wp/v2/tags/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/tags/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "put": { "summary": "PUT /wp/v2/tags/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/tags/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/tags/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as terms do not support trashing." } ] } }, "/wp/v2/taxonomies": { "get": { "summary": "GET /wp/v2/taxonomies", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "type", "in": "query", "schema": { "type": "string" }, "description": "Limit results to taxonomies associated with a specific post type." } ] } }, "/wp/v2/taxonomies/{taxonomy}": { "get": { "summary": "GET /wp/v2/taxonomies/{taxonomy}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "taxonomy", "in": "path", "required": true, "schema": { "type": "string" }, "description": "An alphanumeric identifier for the taxonomy." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/template-parts": { "get": { "summary": "GET /wp/v2/template-parts", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wp_id", "in": "query", "schema": { "type": "integer" }, "description": "Limit to the specified post id." }, { "name": "area", "in": "query", "schema": { "type": "string" }, "description": "Limit to the specified template part area." }, { "name": "post_type", "in": "query", "schema": { "type": "string" }, "description": "Post type to get the templates for." } ] }, "post": { "summary": "POST /wp/v2/template-parts", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "default": "", "description": "Content of template." }, "title": { "type": "object", "default": "", "description": "Title of template." }, "description": { "type": "string", "default": "", "description": "Description of template." }, "status": { "type": "string", "default": "publish", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." }, "area": { "type": "string", "description": "Where the template part is intended for use (header, footer, etc.)" } }, "required": [ "slug" ] } } } } } }, "/wp/v2/template-parts/lookup": { "get": { "summary": "GET /wp/v2/template-parts/lookup", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "slug", "in": "query", "schema": { "type": "string" }, "required": true, "description": "The slug of the template to get the fallback for" }, { "name": "is_custom", "in": "query", "schema": { "type": "boolean" }, "description": "Indicates if a template is custom or part of the template hierarchy" }, { "name": "template_prefix", "in": "query", "schema": { "type": "string" }, "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`" } ] } }, "/wp/v2/template-parts/{id}": { "get": { "summary": "GET /wp/v2/template-parts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/template-parts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "description": "Content of template." }, "title": { "type": "object", "description": "Title of template." }, "description": { "type": "string", "description": "Description of template." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." }, "area": { "type": "string", "description": "Where the template part is intended for use (header, footer, etc.)" } } } } } } }, "put": { "summary": "PUT /wp/v2/template-parts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "description": "Content of template." }, "title": { "type": "object", "description": "Title of template." }, "description": { "type": "string", "description": "Description of template." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." }, "area": { "type": "string", "description": "Where the template part is intended for use (header, footer, etc.)" } } } } } } }, "patch": { "summary": "PATCH /wp/v2/template-parts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "description": "Content of template." }, "title": { "type": "object", "description": "Title of template." }, "description": { "type": "string", "description": "Description of template." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." }, "area": { "type": "string", "description": "Where the template part is intended for use (header, footer, etc.)" } } } } } } }, "delete": { "summary": "DELETE /wp/v2/template-parts/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/template-parts/{id}/autosaves": { "get": { "summary": "GET /wp/v2/template-parts/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/template-parts/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "description": "Content of template." }, "title": { "type": "object", "description": "Title of template." }, "description": { "type": "string", "description": "Description of template." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." }, "area": { "type": "string", "description": "Where the template part is intended for use (header, footer, etc.)" } } } } } } } }, "/wp/v2/template-parts/{parent}/autosaves/{id}": { "get": { "summary": "GET /wp/v2/template-parts/{parent}/autosaves/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/template-parts/{parent}/revisions": { "get": { "summary": "GET /wp/v2/template-parts/{parent}/revisions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "date", "id", "include", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by object attribute." } ] } }, "/wp/v2/template-parts/{parent}/revisions/{id}": { "get": { "summary": "GET /wp/v2/template-parts/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "delete": { "summary": "DELETE /wp/v2/template-parts/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as revisions do not support trashing." } ] } }, "/wp/v2/templates": { "get": { "summary": "GET /wp/v2/templates", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "wp_id", "in": "query", "schema": { "type": "integer" }, "description": "Limit to the specified post id." }, { "name": "area", "in": "query", "schema": { "type": "string" }, "description": "Limit to the specified template part area." }, { "name": "post_type", "in": "query", "schema": { "type": "string" }, "description": "Post type to get the templates for." } ] }, "post": { "summary": "POST /wp/v2/templates", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "default": "", "description": "Content of template." }, "title": { "type": "object", "default": "", "description": "Title of template." }, "description": { "type": "string", "default": "", "description": "Description of template." }, "status": { "type": "string", "default": "publish", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." } }, "required": [ "slug" ] } } } } } }, "/wp/v2/templates/lookup": { "get": { "summary": "GET /wp/v2/templates/lookup", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "slug", "in": "query", "schema": { "type": "string" }, "required": true, "description": "The slug of the template to get the fallback for" }, { "name": "is_custom", "in": "query", "schema": { "type": "boolean" }, "description": "Indicates if a template is custom or part of the template hierarchy" }, { "name": "template_prefix", "in": "query", "schema": { "type": "string" }, "description": "The template prefix for the created template. This is used to extract the main template type, e.g. in `taxonomy-books` extracts the `taxonomy`" } ] } }, "/wp/v2/templates/{id}": { "get": { "summary": "GET /wp/v2/templates/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/templates/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "description": "Content of template." }, "title": { "type": "object", "description": "Title of template." }, "description": { "type": "string", "description": "Description of template." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." } } } } } } }, "put": { "summary": "PUT /wp/v2/templates/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "description": "Content of template." }, "title": { "type": "object", "description": "Title of template." }, "description": { "type": "string", "description": "Description of template." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/templates/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "description": "Content of template." }, "title": { "type": "object", "description": "Title of template." }, "description": { "type": "string", "description": "Description of template." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/templates/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to bypass Trash and force deletion." } ] } }, "/wp/v2/templates/{id}/autosaves": { "get": { "summary": "GET /wp/v2/templates/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/templates/{id}/autosaves", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string", "description": "Unique slug identifying the template." }, "theme": { "type": "string", "description": "Theme identifier for the template." }, "type": { "type": "string", "description": "Type of template." }, "content": { "type": "object", "description": "Content of template." }, "title": { "type": "object", "description": "Title of template." }, "description": { "type": "string", "description": "Description of template." }, "status": { "type": "string", "enum": [ "publish", "future", "draft", "pending", "private" ], "description": "Status of template." }, "author": { "type": "integer", "description": "The ID for the author of the template." } } } } } } } }, "/wp/v2/templates/{parent}/autosaves/{id}": { "get": { "summary": "GET /wp/v2/templates/{parent}/autosaves/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "The ID for the autosave." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/templates/{parent}/revisions": { "get": { "summary": "GET /wp/v2/templates/{parent}/revisions", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer" }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "desc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "date", "enum": [ "date", "id", "include", "relevance", "slug", "include_slugs", "title" ] }, "description": "Sort collection by object attribute." } ] } }, "/wp/v2/templates/{parent}/revisions/{id}": { "get": { "summary": "GET /wp/v2/templates/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "delete": { "summary": "DELETE /wp/v2/templates/{parent}/revisions/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "parent", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The id of a template" }, { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the revision." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as revisions do not support trashing." } ] } }, "/wp/v2/themes": { "get": { "summary": "GET /wp/v2/themes", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "status", "in": "query", "schema": { "type": "array", "items": { "enum": [ "active", "inactive" ], "type": "string" } }, "description": "Limit result set to themes assigned one or more statuses." } ] } }, "/wp/v2/themes/{stylesheet}": { "get": { "summary": "GET /wp/v2/themes/{stylesheet}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "stylesheet", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The theme's stylesheet. This uniquely identifies the theme." } ] } }, "/wp/v2/types": { "get": { "summary": "GET /wp/v2/types", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/types/{type}": { "get": { "summary": "GET /wp/v2/types/{type}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "type", "in": "path", "required": true, "schema": { "type": "string" }, "description": "An alphanumeric identifier for the post type." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/users": { "get": { "summary": "GET /wp/v2/users", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "registered_date", "slug", "include_slugs", "email", "url" ] }, "description": "Sort collection by user attribute." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to users with one or more specific slugs." }, { "name": "roles", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role." }, { "name": "capabilities", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to users matching at least one specific capability provided. Accepts csv list or single capability." }, { "name": "who", "in": "query", "schema": { "type": "string", "enum": [ "authors" ] }, "description": "Limit result set to users who are considered authors." }, { "name": "has_published_posts", "in": "query", "schema": { "type": "boolean" }, "description": "Limit result set to users who have published posts." }, { "name": "search_columns", "in": "query", "schema": { "type": "array", "items": { "enum": [ "email", "name", "id", "username", "slug" ], "type": "string" }, "default": [] }, "description": "Array of column names to be searched." } ] }, "post": { "summary": "POST /wp/v2/users", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Login name for the user." }, "name": { "type": "string", "description": "Display name for the user." }, "first_name": { "type": "string", "description": "First name for the user." }, "last_name": { "type": "string", "description": "Last name for the user." }, "email": { "type": "string", "format": "email", "description": "The email address for the user." }, "url": { "type": "string", "format": "uri", "description": "URL of the user." }, "description": { "type": "string", "description": "Description of the user." }, "locale": { "type": "string", "enum": [ "", "en_US" ], "description": "Locale for the user." }, "nickname": { "type": "string", "description": "The nickname for the user." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles assigned to the user." }, "password": { "type": "string", "description": "Password for the user (never included)." }, "meta": { "type": "object", "description": "Meta fields." }, "elementor_introduction": { "type": "object", "description": "Elementor user meta data" } }, "required": [ "username", "email", "password" ] } } } } } }, "/wp/v2/users/me": { "get": { "summary": "GET /wp/v2/users/me", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/users/me", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Login name for the user." }, "name": { "type": "string", "description": "Display name for the user." }, "first_name": { "type": "string", "description": "First name for the user." }, "last_name": { "type": "string", "description": "Last name for the user." }, "email": { "type": "string", "format": "email", "description": "The email address for the user." }, "url": { "type": "string", "format": "uri", "description": "URL of the user." }, "description": { "type": "string", "description": "Description of the user." }, "locale": { "type": "string", "enum": [ "", "en_US" ], "description": "Locale for the user." }, "nickname": { "type": "string", "description": "The nickname for the user." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles assigned to the user." }, "password": { "type": "string", "description": "Password for the user (never included)." }, "meta": { "type": "object", "description": "Meta fields." }, "elementor_introduction": { "type": "object", "description": "Elementor user meta data" } } } } } } }, "put": { "summary": "PUT /wp/v2/users/me", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Login name for the user." }, "name": { "type": "string", "description": "Display name for the user." }, "first_name": { "type": "string", "description": "First name for the user." }, "last_name": { "type": "string", "description": "Last name for the user." }, "email": { "type": "string", "format": "email", "description": "The email address for the user." }, "url": { "type": "string", "format": "uri", "description": "URL of the user." }, "description": { "type": "string", "description": "Description of the user." }, "locale": { "type": "string", "enum": [ "", "en_US" ], "description": "Locale for the user." }, "nickname": { "type": "string", "description": "The nickname for the user." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles assigned to the user." }, "password": { "type": "string", "description": "Password for the user (never included)." }, "meta": { "type": "object", "description": "Meta fields." }, "elementor_introduction": { "type": "object", "description": "Elementor user meta data" } } } } } } }, "patch": { "summary": "PATCH /wp/v2/users/me", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Login name for the user." }, "name": { "type": "string", "description": "Display name for the user." }, "first_name": { "type": "string", "description": "First name for the user." }, "last_name": { "type": "string", "description": "Last name for the user." }, "email": { "type": "string", "format": "email", "description": "The email address for the user." }, "url": { "type": "string", "format": "uri", "description": "URL of the user." }, "description": { "type": "string", "description": "Description of the user." }, "locale": { "type": "string", "enum": [ "", "en_US" ], "description": "Locale for the user." }, "nickname": { "type": "string", "description": "The nickname for the user." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles assigned to the user." }, "password": { "type": "string", "description": "Password for the user (never included)." }, "meta": { "type": "object", "description": "Meta fields." }, "elementor_introduction": { "type": "object", "description": "Elementor user meta data" } } } } } } }, "delete": { "summary": "DELETE /wp/v2/users/me", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as users do not support trashing." }, { "name": "reassign", "in": "query", "schema": { "type": "integer" }, "required": true, "description": "Reassign the deleted user's posts and links to this user ID." } ] } }, "/wp/v2/users/{id}": { "get": { "summary": "GET /wp/v2/users/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the user." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/users/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the user." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Login name for the user." }, "name": { "type": "string", "description": "Display name for the user." }, "first_name": { "type": "string", "description": "First name for the user." }, "last_name": { "type": "string", "description": "Last name for the user." }, "email": { "type": "string", "format": "email", "description": "The email address for the user." }, "url": { "type": "string", "format": "uri", "description": "URL of the user." }, "description": { "type": "string", "description": "Description of the user." }, "locale": { "type": "string", "enum": [ "", "en_US" ], "description": "Locale for the user." }, "nickname": { "type": "string", "description": "The nickname for the user." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles assigned to the user." }, "password": { "type": "string", "description": "Password for the user (never included)." }, "meta": { "type": "object", "description": "Meta fields." }, "elementor_introduction": { "type": "object", "description": "Elementor user meta data" } } } } } } }, "put": { "summary": "PUT /wp/v2/users/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the user." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Login name for the user." }, "name": { "type": "string", "description": "Display name for the user." }, "first_name": { "type": "string", "description": "First name for the user." }, "last_name": { "type": "string", "description": "Last name for the user." }, "email": { "type": "string", "format": "email", "description": "The email address for the user." }, "url": { "type": "string", "format": "uri", "description": "URL of the user." }, "description": { "type": "string", "description": "Description of the user." }, "locale": { "type": "string", "enum": [ "", "en_US" ], "description": "Locale for the user." }, "nickname": { "type": "string", "description": "The nickname for the user." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles assigned to the user." }, "password": { "type": "string", "description": "Password for the user (never included)." }, "meta": { "type": "object", "description": "Meta fields." }, "elementor_introduction": { "type": "object", "description": "Elementor user meta data" } } } } } } }, "patch": { "summary": "PATCH /wp/v2/users/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the user." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "username": { "type": "string", "description": "Login name for the user." }, "name": { "type": "string", "description": "Display name for the user." }, "first_name": { "type": "string", "description": "First name for the user." }, "last_name": { "type": "string", "description": "Last name for the user." }, "email": { "type": "string", "format": "email", "description": "The email address for the user." }, "url": { "type": "string", "format": "uri", "description": "URL of the user." }, "description": { "type": "string", "description": "Description of the user." }, "locale": { "type": "string", "enum": [ "", "en_US" ], "description": "Locale for the user." }, "nickname": { "type": "string", "description": "The nickname for the user." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the user." }, "roles": { "type": "array", "items": { "type": "string" }, "description": "Roles assigned to the user." }, "password": { "type": "string", "description": "Password for the user (never included)." }, "meta": { "type": "object", "description": "Meta fields." }, "elementor_introduction": { "type": "object", "description": "Elementor user meta data" } } } } } } }, "delete": { "summary": "DELETE /wp/v2/users/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the user." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as users do not support trashing." }, { "name": "reassign", "in": "query", "schema": { "type": "integer" }, "required": true, "description": "Reassign the deleted user's posts and links to this user ID." } ] } }, "/wp/v2/users/{user_id}/application-passwords": { "get": { "summary": "GET /wp/v2/users/{user_id}/application-passwords", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/users/{user_id}/application-passwords", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "app_id": { "type": "string", "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace." }, "name": { "type": "string", "description": "The name of the application password." } }, "required": [ "name" ] } } } } }, "delete": { "summary": "DELETE /wp/v2/users/{user_id}/application-passwords", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/wp/v2/users/{user_id}/application-passwords/introspect": { "get": { "summary": "GET /wp/v2/users/{user_id}/application-passwords/introspect", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/users/{user_id}/application-passwords/{uuid}": { "get": { "summary": "GET /wp/v2/users/{user_id}/application-passwords/{uuid}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/users/{user_id}/application-passwords/{uuid}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "app_id": { "type": "string", "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace." }, "name": { "type": "string", "description": "The name of the application password." } } } } } } }, "put": { "summary": "PUT /wp/v2/users/{user_id}/application-passwords/{uuid}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "app_id": { "type": "string", "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace." }, "name": { "type": "string", "description": "The name of the application password." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/users/{user_id}/application-passwords/{uuid}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "app_id": { "type": "string", "description": "A UUID provided by the application to uniquely identify it. It is recommended to use an UUID v5 with the URL or DNS namespace." }, "name": { "type": "string", "description": "The name of the application password." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/users/{user_id}/application-passwords/{uuid}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "user_id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "uuid", "in": "path", "required": true, "schema": { "type": "string" } } ] } }, "/wp/v2/view-config": { "get": { "summary": "GET /wp/v2/view-config", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "kind", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Entity kind." }, { "name": "name", "in": "query", "schema": { "type": "string" }, "required": true, "description": "Entity name." } ] } }, "/wp/v2/widget-types": { "get": { "summary": "GET /wp/v2/widget-types", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/widget-types/{id}": { "get": { "summary": "GET /wp/v2/widget-types/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The widget type id." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] } }, "/wp/v2/widget-types/{id}/encode": { "post": { "summary": "POST /wp/v2/widget-types/{id}/encode", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The widget type id." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "instance": { "type": "object", "description": "Current instance settings of the widget." }, "form_data": { "type": "string", "description": "Serialized widget form data to encode into instance settings." } } } } } } } }, "/wp/v2/widget-types/{id}/render": { "post": { "summary": "POST /wp/v2/widget-types/{id}/render", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "The widget type id." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "instance": { "type": "object", "description": "Current instance settings of the widget." } } } } } } } }, "/wp/v2/widgets": { "get": { "summary": "GET /wp/v2/widgets", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "sidebar", "in": "query", "schema": { "type": "string" }, "description": "The sidebar to return widgets for." } ] }, "post": { "summary": "POST /wp/v2/widgets", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Unique identifier for the widget." }, "id_base": { "type": "string", "description": "The type of the widget. Corresponds to ID in widget-types endpoint." }, "sidebar": { "type": "string", "default": "wp_inactive_widgets", "description": "The sidebar the widget belongs to." }, "instance": { "type": "object", "description": "Instance settings of the widget, if supported." }, "form_data": { "type": "string", "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only." } }, "required": [ "sidebar" ] } } } } } }, "/wp/v2/widgets/{id}": { "get": { "summary": "GET /wp/v2/widgets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/widgets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the widget." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id_base": { "type": "string", "description": "The type of the widget. Corresponds to ID in widget-types endpoint." }, "sidebar": { "type": "string", "description": "The sidebar the widget belongs to." }, "instance": { "type": "object", "description": "Instance settings of the widget, if supported." }, "form_data": { "type": "string", "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only." } } } } } } }, "put": { "summary": "PUT /wp/v2/widgets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the widget." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id_base": { "type": "string", "description": "The type of the widget. Corresponds to ID in widget-types endpoint." }, "sidebar": { "type": "string", "description": "The sidebar the widget belongs to." }, "instance": { "type": "object", "description": "Instance settings of the widget, if supported." }, "form_data": { "type": "string", "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/widgets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" }, "description": "Unique identifier for the widget." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id_base": { "type": "string", "description": "The type of the widget. Corresponds to ID in widget-types endpoint." }, "sidebar": { "type": "string", "description": "The sidebar the widget belongs to." }, "instance": { "type": "object", "description": "Instance settings of the widget, if supported." }, "form_data": { "type": "string", "description": "URL-encoded form data from the widget admin form. Used to update a widget that does not support instance. Write only." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/widgets/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "force", "in": "query", "schema": { "type": "boolean" }, "description": "Whether to force removal of the widget, or move it to the inactive sidebar." } ] } }, "/wp/v2/wp_pattern_category": { "get": { "summary": "GET /wp/v2/wp_pattern_category", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." }, { "name": "page", "in": "query", "schema": { "type": "integer", "default": 1 }, "description": "Current page of the collection." }, { "name": "per_page", "in": "query", "schema": { "type": "integer", "default": 10 }, "description": "Maximum number of items to be returned in result set." }, { "name": "search", "in": "query", "schema": { "type": "string" }, "description": "Limit results to those matching a string." }, { "name": "exclude", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Ensure result set excludes specific IDs." }, { "name": "include", "in": "query", "schema": { "type": "array", "items": { "type": "integer" }, "default": [] }, "description": "Limit result set to specific IDs." }, { "name": "offset", "in": "query", "schema": { "type": "integer" }, "description": "Offset the result set by a specific number of items." }, { "name": "order", "in": "query", "schema": { "type": "string", "default": "asc", "enum": [ "asc", "desc" ] }, "description": "Order sort attribute ascending or descending." }, { "name": "orderby", "in": "query", "schema": { "type": "string", "default": "name", "enum": [ "id", "include", "name", "slug", "include_slugs", "term_group", "description", "count" ] }, "description": "Sort collection by term attribute." }, { "name": "hide_empty", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Whether to hide terms not assigned to any posts." }, { "name": "post", "in": "query", "schema": { "type": "integer" }, "description": "Limit result set to terms assigned to a specific post." }, { "name": "slug", "in": "query", "schema": { "type": "array", "items": { "type": "string" } }, "description": "Limit result set to terms with one or more specific slugs." } ] }, "post": { "summary": "POST /wp/v2/wp_pattern_category", "responses": { "200": { "description": "Successful response" } }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." } }, "required": [ "name" ] } } } } } }, "/wp/v2/wp_pattern_category/{id}": { "get": { "summary": "GET /wp/v2/wp_pattern_category/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." }, { "name": "context", "in": "query", "schema": { "type": "string", "default": "view", "enum": [ "view", "embed", "edit" ] }, "description": "Scope under which the request is made; determines fields present in response." } ] }, "post": { "summary": "POST /wp/v2/wp_pattern_category/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "put": { "summary": "PUT /wp/v2/wp_pattern_category/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "patch": { "summary": "PATCH /wp/v2/wp_pattern_category/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "description": { "type": "string", "description": "HTML description of the term." }, "name": { "type": "string", "description": "HTML title for the term." }, "slug": { "type": "string", "description": "An alphanumeric identifier for the term unique to its type." }, "meta": { "type": "object", "description": "Meta fields." } } } } } } }, "delete": { "summary": "DELETE /wp/v2/wp_pattern_category/{id}", "responses": { "200": { "description": "Successful response" } }, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "integer" }, "description": "Unique identifier for the term." }, { "name": "force", "in": "query", "schema": { "type": "boolean", "default": false }, "description": "Required to be true, as terms do not support trashing." } ] } } }, "components": { "schemas": { "Post": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "date_gmt": { "type": "string", "format": "date-time" }, "modified": { "type": "string", "format": "date-time" }, "slug": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "link": { "type": "string", "format": "uri" }, "title": { "type": "object", "properties": { "rendered": { "type": "string" } } }, "content": { "type": "object", "properties": { "rendered": { "type": "string" } } }, "excerpt": { "type": "object", "properties": { "rendered": { "type": "string" } } }, "author": { "type": "integer" }, "featured_media": { "type": "integer" }, "categories": { "type": "array", "items": { "type": "integer" } }, "tags": { "type": "array", "items": { "type": "integer" } } } }, "Page": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "slug": { "type": "string" }, "status": { "type": "string" }, "type": { "type": "string" }, "link": { "type": "string", "format": "uri" }, "title": { "type": "object", "properties": { "rendered": { "type": "string" } } }, "content": { "type": "object", "properties": { "rendered": { "type": "string" } } }, "excerpt": { "type": "object", "properties": { "rendered": { "type": "string" } } }, "parent": { "type": "integer" }, "menu_order": { "type": "integer" } } }, "Media": { "type": "object", "properties": { "id": { "type": "integer" }, "date": { "type": "string", "format": "date-time" }, "slug": { "type": "string" }, "media_type": { "type": "string" }, "mime_type": { "type": "string" }, "source_url": { "type": "string", "format": "uri" }, "alt_text": { "type": "string" }, "caption": { "type": "object", "properties": { "rendered": { "type": "string" } } }, "media_details": { "type": "object" } } }, "Term": { "type": "object", "properties": { "id": { "type": "integer" }, "count": { "type": "integer" }, "description": { "type": "string" }, "link": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "slug": { "type": "string" }, "taxonomy": { "type": "string" }, "parent": { "type": "integer" } } }, "User": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "description": { "type": "string" }, "link": { "type": "string", "format": "uri" }, "slug": { "type": "string" }, "avatar_urls": { "type": "object" } } } } } }