openapi: 3.1.0 info: title: WordPress.com REST API — wp/v2 namespace version: v2 description: Derived by API Evangelist from the WordPress.com REST API route index published at https://public-api.wordpress.com/wp/v2/. Paths, HTTP methods, and parameter names/types/descriptions/defaults are taken verbatim from that index. Response schemas are not published in the route index, so successful responses are described but not schematised; the error envelope was observed live on public-api.wordpress.com. contact: name: Automattic url: https://developer.wordpress.com/docs/api/ x-derived-from: https://public-api.wordpress.com/wp/v2/ x-derived-by: API Evangelist enrichment pipeline servers: - url: https://public-api.wordpress.com tags: - name: abilities - name: activity-log-events - name: akismet - name: block-directory - name: block-patterns - name: block-renderer - name: block-types - name: blocks - name: categories - name: comments - name: feedback - name: font-collections - name: font-families - name: global-styles - name: guidelines - name: icon-collections - name: icons - name: jetpack-forms - name: jetpack-global-styles - name: jp_pay_order - name: jp_pay_product - name: knowledge - name: media - name: menu-items - name: menu-locations - name: menus - name: navigation - name: pages - name: pattern-directory - name: plugins - name: posts - name: search - name: settings - name: sidebars - name: statuses - name: tags - name: taxonomies - name: template-parts - name: templates - name: themes - name: types - name: users - name: view-config - name: widget-types - name: widgets - name: wp-abilities - name: wp-v2 - name: wp_guideline_type - name: wp_knowledge_type - name: wp_pattern_category paths: /wp/v2: get: operationId: getWpV2 summary: GET /wp/v2 tags: - wp-v2 responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: namespace in: query required: false schema: default: wp/v2 - name: context in: query required: false schema: default: view /wp/v2/abilities/{name}/run: get: operationId: getWpV2AbilitiesbyNameRun summary: GET /wp/v2/abilities/{name}/run tags: - abilities responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: name in: path required: true schema: type: string - name: input in: query required: false schema: type: string description: Input parameters for the ability execution. post: operationId: postWpV2AbilitiesbyNameRun summary: POST /wp/v2/abilities/{name}/run tags: - abilities responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: name in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: input: type: string description: Input parameters for the ability execution. put: operationId: putWpV2AbilitiesbyNameRun summary: PUT /wp/v2/abilities/{name}/run tags: - abilities responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: name in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: input: type: string description: Input parameters for the ability execution. patch: operationId: patchWpV2AbilitiesbyNameRun summary: PATCH /wp/v2/abilities/{name}/run tags: - abilities responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: name in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: input: type: string description: Input parameters for the ability execution. delete: operationId: deleteWpV2AbilitiesbyNameRun summary: DELETE /wp/v2/abilities/{name}/run tags: - abilities responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: name in: path required: true schema: type: string - name: input in: query required: false schema: type: string description: Input parameters for the ability execution. /wp/v2/sites/{wpcom_site}: get: operationId: getWpV2SitesbyWpcomSite summary: GET /wp/v2/sites/{wpcom_site} tags: - wp-v2 responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: namespace in: query required: false schema: default: wp/v2 - name: context in: query required: false schema: default: view /wp/v2/sites/{wpcom_site}/activity-log-events: get: operationId: getWpV2SitesbyWpcomSiteActivityLogEvents summary: GET /wp/v2/sites/{wpcom_site}/activity-log-events tags: - activity-log-events responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. post: operationId: postWpV2SitesbyWpcomSiteActivityLogEvents summary: POST /wp/v2/sites/{wpcom_site}/activity-log-events tags: - activity-log-events responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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 - spam 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/sites/{wpcom_site}/activity-log-events/{id}: get: operationId: getWpV2SitesbyWpcomSiteActivityLogEventsbyId summary: GET /wp/v2/sites/{wpcom_site}/activity-log-events/{id} tags: - activity-log-events responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. post: operationId: postWpV2SitesbyWpcomSiteActivityLogEventsbyId summary: POST /wp/v2/sites/{wpcom_site}/activity-log-events/{id} tags: - activity-log-events responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: &id001 - publish - future - draft - pending - private - spam 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: operationId: putWpV2SitesbyWpcomSiteActivityLogEventsbyId summary: PUT /wp/v2/sites/{wpcom_site}/activity-log-events/{id} tags: - activity-log-events responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id001 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: operationId: patchWpV2SitesbyWpcomSiteActivityLogEventsbyId summary: PATCH /wp/v2/sites/{wpcom_site}/activity-log-events/{id} tags: - activity-log-events responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id001 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: operationId: deleteWpV2SitesbyWpcomSiteActivityLogEventsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/activity-log-events/{id} tags: - activity-log-events responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/activity-log-events/{id}/autosaves: get: operationId: getWpV2SitesbyWpcomSiteActivityLogEventsbyIdAutosaves summary: GET /wp/v2/sites/{wpcom_site}/activity-log-events/{id}/autosaves tags: - activity-log-events responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteActivityLogEventsbyIdAutosaves summary: POST /wp/v2/sites/{wpcom_site}/activity-log-events/{id}/autosaves tags: - activity-log-events responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - 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 - spam 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/sites/{wpcom_site}/activity-log-events/{parent}/autosaves/{id}: get: operationId: getWpV2SitesbyWpcomSiteActivityLogEventsbyParentAutosavesbyId summary: GET /wp/v2/sites/{wpcom_site}/activity-log-events/{parent}/autosaves/{id} tags: - activity-log-events responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/akismet/v1/webhook: post: operationId: postWpV2SitesbyWpcomSiteAkismetV1Webhook summary: POST /wp/v2/sites/{wpcom_site}/akismet/v1/webhook tags: - akismet responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/block-directory/search: get: operationId: getWpV2SitesbyWpcomSiteBlockDirectorySearch summary: GET /wp/v2/sites/{wpcom_site}/block-directory/search tags: - block-directory responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: term in: query required: true schema: type: string description: Limit result set to blocks matching the search term. /wp/v2/sites/{wpcom_site}/block-patterns/categories: get: operationId: getWpV2SitesbyWpcomSiteBlockPatternsCategories summary: GET /wp/v2/sites/{wpcom_site}/block-patterns/categories tags: - block-patterns responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/block-patterns/patterns: get: operationId: getWpV2SitesbyWpcomSiteBlockPatternsPatterns summary: GET /wp/v2/sites/{wpcom_site}/block-patterns/patterns tags: - block-patterns responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/block-renderer/{name}: get: operationId: getWpV2SitesbyWpcomSiteBlockRendererbyName summary: GET /wp/v2/sites/{wpcom_site}/block-renderer/{name} tags: - block-renderer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: name in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: &id002 - edit default: view description: Scope under which the request is made; determines fields present in response. - name: attributes in: query required: false schema: type: object default: &id003 [] description: Attributes for the block. - name: post_id in: query required: false schema: type: integer description: ID of the post context. post: operationId: postWpV2SitesbyWpcomSiteBlockRendererbyName summary: POST /wp/v2/sites/{wpcom_site}/block-renderer/{name} tags: - block-renderer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: name in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: context: type: string enum: *id002 default: view description: Scope under which the request is made; determines fields present in response. attributes: type: object default: *id003 description: Attributes for the block. post_id: type: integer description: ID of the post context. /wp/v2/sites/{wpcom_site}/block-types: get: operationId: getWpV2SitesbyWpcomSiteBlockTypes summary: GET /wp/v2/sites/{wpcom_site}/block-types tags: - block-types responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: namespace in: query required: false schema: type: string description: Block namespace. /wp/v2/sites/{wpcom_site}/block-types/{namespace}: get: operationId: getWpV2SitesbyWpcomSiteBlockTypesbyNamespace summary: GET /wp/v2/sites/{wpcom_site}/block-types/{namespace} tags: - block-types responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: namespace in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/block-types/{namespace}/{name}: get: operationId: getWpV2SitesbyWpcomSiteBlockTypesbyNamespacebyName summary: GET /wp/v2/sites/{wpcom_site}/block-types/{namespace}/{name} tags: - block-types responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: namespace in: path required: true schema: type: string - name: name in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/blocks: get: operationId: getWpV2SitesbyWpcomSiteBlocks summary: GET /wp/v2/sites/{wpcom_site}/blocks tags: - blocks responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. - name: tax_relation in: query required: false schema: type: string enum: - AND - OR description: Limit result set based on relationship between multiple taxonomies. - name: wp_pattern_category in: query required: false schema: type: string description: Limit result set to items with specific terms assigned in the wp_pattern_category taxonomy. - name: wp_pattern_category_exclude in: query required: false schema: type: string description: Limit result set to items except those with specific terms assigned in the wp_pattern_category taxonomy. post: operationId: postWpV2SitesbyWpcomSiteBlocks summary: POST /wp/v2/sites/{wpcom_site}/blocks tags: - blocks responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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 - spam 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/sites/{wpcom_site}/blocks/{id}: get: operationId: getWpV2SitesbyWpcomSiteBlocksbyId summary: GET /wp/v2/sites/{wpcom_site}/blocks/{id} tags: - blocks responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: excerpt_length in: query required: false schema: type: integer description: Override the default excerpt length. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. post: operationId: postWpV2SitesbyWpcomSiteBlocksbyId summary: POST /wp/v2/sites/{wpcom_site}/blocks/{id} tags: - blocks responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: &id004 - publish - future - draft - pending - private - spam 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: operationId: putWpV2SitesbyWpcomSiteBlocksbyId summary: PUT /wp/v2/sites/{wpcom_site}/blocks/{id} tags: - blocks responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id004 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: operationId: patchWpV2SitesbyWpcomSiteBlocksbyId summary: PATCH /wp/v2/sites/{wpcom_site}/blocks/{id} tags: - blocks responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id004 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: operationId: deleteWpV2SitesbyWpcomSiteBlocksbyId summary: DELETE /wp/v2/sites/{wpcom_site}/blocks/{id} tags: - blocks responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/blocks/{id}/autosaves: get: operationId: getWpV2SitesbyWpcomSiteBlocksbyIdAutosaves summary: GET /wp/v2/sites/{wpcom_site}/blocks/{id}/autosaves tags: - blocks responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteBlocksbyIdAutosaves summary: POST /wp/v2/sites/{wpcom_site}/blocks/{id}/autosaves tags: - blocks responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - 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 - spam 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/sites/{wpcom_site}/blocks/{parent}/autosaves/{id}: get: operationId: getWpV2SitesbyWpcomSiteBlocksbyParentAutosavesbyId summary: GET /wp/v2/sites/{wpcom_site}/blocks/{parent}/autosaves/{id} tags: - blocks responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/blocks/{parent}/revisions: get: operationId: getWpV2SitesbyWpcomSiteBlocksbyParentRevisions summary: GET /wp/v2/sites/{wpcom_site}/blocks/{parent}/revisions tags: - blocks responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. /wp/v2/sites/{wpcom_site}/blocks/{parent}/revisions/{id}: get: operationId: getWpV2SitesbyWpcomSiteBlocksbyParentRevisionsbyId summary: GET /wp/v2/sites/{wpcom_site}/blocks/{parent}/revisions/{id} tags: - blocks responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. delete: operationId: deleteWpV2SitesbyWpcomSiteBlocksbyParentRevisionsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/blocks/{parent}/revisions/{id} tags: - blocks responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as revisions do not support trashing. /wp/v2/sites/{wpcom_site}/categories: get: operationId: getWpV2SitesbyWpcomSiteCategories summary: GET /wp/v2/sites/{wpcom_site}/categories tags: - categories responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name description: Sort collection by term attribute. - name: hide_empty in: query required: false schema: type: boolean default: false description: Whether to hide terms not assigned to any posts. - name: parent in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific parent. - name: post in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific post. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to terms with one or more specific slugs. post: operationId: postWpV2SitesbyWpcomSiteCategories summary: POST /wp/v2/sites/{wpcom_site}/categories tags: - categories responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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/sites/{wpcom_site}/categories/{id}: get: operationId: getWpV2SitesbyWpcomSiteCategoriesbyId summary: GET /wp/v2/sites/{wpcom_site}/categories/{id} tags: - categories responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteCategoriesbyId summary: POST /wp/v2/sites/{wpcom_site}/categories/{id} tags: - categories responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: putWpV2SitesbyWpcomSiteCategoriesbyId summary: PUT /wp/v2/sites/{wpcom_site}/categories/{id} tags: - categories responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: patchWpV2SitesbyWpcomSiteCategoriesbyId summary: PATCH /wp/v2/sites/{wpcom_site}/categories/{id} tags: - categories responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: deleteWpV2SitesbyWpcomSiteCategoriesbyId summary: DELETE /wp/v2/sites/{wpcom_site}/categories/{id} tags: - categories responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as terms do not support trashing. /wp/v2/sites/{wpcom_site}/comments: get: operationId: getWpV2SitesbyWpcomSiteComments summary: GET /wp/v2/sites/{wpcom_site}/comments tags: - comments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to comments published after a given ISO8601 compliant date. - name: author in: query required: false schema: type: array items: type: integer description: Limit result set to comments assigned to specific user IDs. Requires authorization. - name: author_exclude in: query required: false schema: type: array items: type: integer description: Ensure result set excludes comments assigned to specific user IDs. Requires authorization. - name: author_email in: query required: false schema: type: string format: email description: Limit result set to that from a specific author email. Requires authorization. - name: before in: query required: false schema: type: string format: date-time description: Limit response to comments published before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - date_gmt - id - include - post - parent - type default: date_gmt description: Sort collection by comment attribute. - name: parent in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to comments of specific parent IDs. - name: parent_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific parent IDs. - name: post in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to comments assigned to specific post IDs. - name: status in: query required: false schema: type: string default: approve description: Limit result set to comments assigned a specific status. Requires authorization. - name: type in: query required: false schema: type: string default: comment description: Limit result set to comments assigned a specific type. Requires authorization. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. post: operationId: postWpV2SitesbyWpcomSiteComments summary: POST /wp/v2/sites/{wpcom_site}/comments tags: - comments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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/sites/{wpcom_site}/comments/{id}: get: operationId: getWpV2SitesbyWpcomSiteCommentsbyId summary: GET /wp/v2/sites/{wpcom_site}/comments/{id} tags: - comments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: password in: query required: false schema: type: string description: The password for the parent post of the comment (if the post is password protected). post: operationId: postWpV2SitesbyWpcomSiteCommentsbyId summary: POST /wp/v2/sites/{wpcom_site}/comments/{id} tags: - comments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: putWpV2SitesbyWpcomSiteCommentsbyId summary: PUT /wp/v2/sites/{wpcom_site}/comments/{id} tags: - comments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: patchWpV2SitesbyWpcomSiteCommentsbyId summary: PATCH /wp/v2/sites/{wpcom_site}/comments/{id} tags: - comments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: deleteWpV2SitesbyWpcomSiteCommentsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/comments/{id} tags: - comments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. - name: password in: query required: false schema: type: string description: The password for the parent post of the comment (if the post is password protected). /wp/v2/sites/{wpcom_site}/feedback: get: operationId: getWpV2SitesbyWpcomSiteFeedback summary: GET /wp/v2/sites/{wpcom_site}/feedback tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. - name: parent in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to items with particular parent IDs. - name: parent_exclude in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to all items except those of a particular parent ID. - name: source in: query required: false schema: type: integer description: Limit result set to feedback submitted from a particular source post ID. - name: is_unread in: query required: false schema: type: boolean description: Limit result set to read or unread feedback items. - name: is_test in: query required: false schema: type: boolean description: Limit result set to test responses (from form preview) or exclude them. - name: invalid_ids in: query required: false schema: type: array default: [] items: type: integer description: List of item IDs to include in results regardless of filters. - name: fields_format in: query required: false schema: type: string enum: - label-value - collection default: label-value description: Format for the fields data in the response. post: operationId: postWpV2SitesbyWpcomSiteFeedback summary: POST /wp/v2/sites/{wpcom_site}/feedback tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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 - spam description: A named status 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. /wp/v2/sites/{wpcom_site}/feedback/bulk_actions: post: operationId: postWpV2SitesbyWpcomSiteFeedbackBulkActions summary: POST /wp/v2/sites/{wpcom_site}/feedback/bulk_actions tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: action: type: string enum: - mark_as_spam - mark_as_not_spam post_ids: type: array items: type: integer required: - action - post_ids /wp/v2/sites/{wpcom_site}/feedback/config: get: operationId: getWpV2SitesbyWpcomSiteFeedbackConfig summary: GET /wp/v2/sites/{wpcom_site}/feedback/config tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/feedback/counts: get: operationId: getWpV2SitesbyWpcomSiteFeedbackCounts summary: GET /wp/v2/sites/{wpcom_site}/feedback/counts tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: parent in: query required: false schema: type: integer description: Limit results to those of a specific parent ID. - name: before in: query required: false schema: type: string format: date-time description: Limit results to feedback published before a given ISO8601 compliant date. - name: after in: query required: false schema: type: string format: date-time description: Limit results to feedback published after a given ISO8601 compliant date. - name: is_unread in: query required: false schema: type: boolean description: Limit results to read or unread feedback items. - name: is_test in: query required: false schema: type: boolean description: Limit results to test responses or exclude them. - name: source in: query required: false schema: type: integer description: Limit results to feedback submitted from a specific source post ID. /wp/v2/sites/{wpcom_site}/feedback/dismiss-classic-forms-notice: post: operationId: postWpV2SitesbyWpcomSiteFeedbackDismissClassicFormsNotice summary: POST /wp/v2/sites/{wpcom_site}/feedback/dismiss-classic-forms-notice tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/feedback/filters: get: operationId: getWpV2SitesbyWpcomSiteFeedbackFilters summary: GET /wp/v2/sites/{wpcom_site}/feedback/filters tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/feedback/integrations: get: operationId: getWpV2SitesbyWpcomSiteFeedbackIntegrations summary: GET /wp/v2/sites/{wpcom_site}/feedback/integrations tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: version in: query required: false schema: type: integer default: 1 /wp/v2/sites/{wpcom_site}/feedback/integrations-metadata: get: operationId: getWpV2SitesbyWpcomSiteFeedbackIntegrationsMetadata summary: GET /wp/v2/sites/{wpcom_site}/feedback/integrations-metadata tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/feedback/integrations/{slug}: get: operationId: getWpV2SitesbyWpcomSiteFeedbackIntegrationsbySlug summary: GET /wp/v2/sites/{wpcom_site}/feedback/integrations/{slug} tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: slug in: path required: true schema: type: string delete: operationId: deleteWpV2SitesbyWpcomSiteFeedbackIntegrationsbySlug summary: DELETE /wp/v2/sites/{wpcom_site}/feedback/integrations/{slug} tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: slug in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/feedback/trash: delete: operationId: deleteWpV2SitesbyWpcomSiteFeedbackTrash summary: DELETE /wp/v2/sites/{wpcom_site}/feedback/trash tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: status in: query required: false schema: type: string enum: - trash - spam default: trash /wp/v2/sites/{wpcom_site}/feedback/{id}: get: operationId: getWpV2SitesbyWpcomSiteFeedbackbyId summary: GET /wp/v2/sites/{wpcom_site}/feedback/{id} tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteFeedbackbyId summary: POST /wp/v2/sites/{wpcom_site}/feedback/{id} tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: &id005 - publish - future - draft - pending - private - spam description: A named status for the post. comment_status: type: string enum: &id006 - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: &id007 - open - closed description: Whether or not the post can be pinged. put: operationId: putWpV2SitesbyWpcomSiteFeedbackbyId summary: PUT /wp/v2/sites/{wpcom_site}/feedback/{id} tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id005 description: A named status for the post. comment_status: type: string enum: *id006 description: Whether or not comments are open on the post. ping_status: type: string enum: *id007 description: Whether or not the post can be pinged. patch: operationId: patchWpV2SitesbyWpcomSiteFeedbackbyId summary: PATCH /wp/v2/sites/{wpcom_site}/feedback/{id} tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id005 description: A named status for the post. comment_status: type: string enum: *id006 description: Whether or not comments are open on the post. ping_status: type: string enum: *id007 description: Whether or not the post can be pinged. delete: operationId: deleteWpV2SitesbyWpcomSiteFeedbackbyId summary: DELETE /wp/v2/sites/{wpcom_site}/feedback/{id} tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/feedback/{id}/autosaves: get: operationId: getWpV2SitesbyWpcomSiteFeedbackbyIdAutosaves summary: GET /wp/v2/sites/{wpcom_site}/feedback/{id}/autosaves tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteFeedbackbyIdAutosaves summary: POST /wp/v2/sites/{wpcom_site}/feedback/{id}/autosaves tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - 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 - spam description: A named status 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. /wp/v2/sites/{wpcom_site}/feedback/{id}/read: post: operationId: postWpV2SitesbyWpcomSiteFeedbackbyIdRead summary: POST /wp/v2/sites/{wpcom_site}/feedback/{id}/read tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: is_unread: type: boolean required: - is_unread /wp/v2/sites/{wpcom_site}/feedback/{parent}/autosaves/{id}: get: operationId: getWpV2SitesbyWpcomSiteFeedbackbyParentAutosavesbyId summary: GET /wp/v2/sites/{wpcom_site}/feedback/{parent}/autosaves/{id} tags: - feedback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/font-collections: get: operationId: getWpV2SitesbyWpcomSiteFontCollections summary: GET /wp/v2/sites/{wpcom_site}/font-collections tags: - font-collections responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. /wp/v2/sites/{wpcom_site}/font-collections/{slug}: get: operationId: getWpV2SitesbyWpcomSiteFontCollectionsbySlug summary: GET /wp/v2/sites/{wpcom_site}/font-collections/{slug} tags: - font-collections responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: slug in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/font-families: get: operationId: getWpV2SitesbyWpcomSiteFontFamilies summary: GET /wp/v2/sites/{wpcom_site}/font-families tags: - font-families responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include default: id description: Sort collection by post attribute. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. post: operationId: postWpV2SitesbyWpcomSiteFontFamilies summary: POST /wp/v2/sites/{wpcom_site}/font-families tags: - font-families responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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/sites/{wpcom_site}/font-families/{font_family_id}/font-faces: get: operationId: getWpV2SitesbyWpcomSiteFontFamiliesbyFontFamilyIdFontFaces summary: GET /wp/v2/sites/{wpcom_site}/font-families/{font_family_id}/font-faces tags: - font-families responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: font_family_id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include default: id description: Sort collection by post attribute. post: operationId: postWpV2SitesbyWpcomSiteFontFamiliesbyFontFamilyIdFontFaces summary: POST /wp/v2/sites/{wpcom_site}/font-families/{font_family_id}/font-faces tags: - font-families responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: font_family_id in: path required: true schema: type: string 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/sites/{wpcom_site}/font-families/{font_family_id}/font-faces/{id}: get: operationId: getWpV2SitesbyWpcomSiteFontFamiliesbyFontFamilyIdFontFacesbyId summary: GET /wp/v2/sites/{wpcom_site}/font-families/{font_family_id}/font-faces/{id} tags: - font-families responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: font_family_id in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. delete: operationId: deleteWpV2SitesbyWpcomSiteFontFamiliesbyFontFamilyIdFontFacesbyId summary: DELETE /wp/v2/sites/{wpcom_site}/font-families/{font_family_id}/font-faces/{id} tags: - font-families responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: font_family_id in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/font-families/{id}: get: operationId: getWpV2SitesbyWpcomSiteFontFamiliesbyId summary: GET /wp/v2/sites/{wpcom_site}/font-families/{id} tags: - font-families responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteFontFamiliesbyId summary: POST /wp/v2/sites/{wpcom_site}/font-families/{id} tags: - font-families responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: putWpV2SitesbyWpcomSiteFontFamiliesbyId summary: PUT /wp/v2/sites/{wpcom_site}/font-families/{id} tags: - font-families responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: patchWpV2SitesbyWpcomSiteFontFamiliesbyId summary: PATCH /wp/v2/sites/{wpcom_site}/font-families/{id} tags: - font-families responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: deleteWpV2SitesbyWpcomSiteFontFamiliesbyId summary: DELETE /wp/v2/sites/{wpcom_site}/font-families/{id} tags: - font-families responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/global-styles/themes/{stylesheet}: get: operationId: getWpV2SitesbyWpcomSiteGlobalStylesThemesbyStylesheet summary: GET /wp/v2/sites/{wpcom_site}/global-styles/themes/{stylesheet} tags: - global-styles responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: stylesheet in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/global-styles/themes/{stylesheet}/variations: get: operationId: getWpV2SitesbyWpcomSiteGlobalStylesThemesbyStylesheetVariations summary: GET /wp/v2/sites/{wpcom_site}/global-styles/themes/{stylesheet}/variations tags: - global-styles responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: stylesheet in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/global-styles/{id}: get: operationId: getWpV2SitesbyWpcomSiteGlobalStylesbyId summary: GET /wp/v2/sites/{wpcom_site}/global-styles/{id} tags: - global-styles responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string post: operationId: postWpV2SitesbyWpcomSiteGlobalStylesbyId summary: POST /wp/v2/sites/{wpcom_site}/global-styles/{id} tags: - global-styles responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - 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: string description: Title of the global styles variation. put: operationId: putWpV2SitesbyWpcomSiteGlobalStylesbyId summary: PUT /wp/v2/sites/{wpcom_site}/global-styles/{id} tags: - global-styles responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - 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: string description: Title of the global styles variation. patch: operationId: patchWpV2SitesbyWpcomSiteGlobalStylesbyId summary: PATCH /wp/v2/sites/{wpcom_site}/global-styles/{id} tags: - global-styles responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - 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: string description: Title of the global styles variation. /wp/v2/sites/{wpcom_site}/global-styles/{parent}/revisions: get: operationId: getWpV2SitesbyWpcomSiteGlobalStylesbyParentRevisions summary: GET /wp/v2/sites/{wpcom_site}/global-styles/{parent}/revisions tags: - global-styles responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. /wp/v2/sites/{wpcom_site}/global-styles/{parent}/revisions/{id}: get: operationId: getWpV2SitesbyWpcomSiteGlobalStylesbyParentRevisionsbyId summary: GET /wp/v2/sites/{wpcom_site}/global-styles/{parent}/revisions/{id} tags: - global-styles responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/guidelines: get: operationId: getWpV2SitesbyWpcomSiteGuidelines summary: GET /wp/v2/sites/{wpcom_site}/guidelines tags: - guidelines responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: author in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to posts assigned to specific authors. - name: author_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes posts assigned to specific authors. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. - name: tax_relation in: query required: false schema: type: string enum: - AND - OR description: Limit result set based on relationship between multiple taxonomies. - name: wp_guideline_type in: query required: false schema: type: string description: Limit result set to items with specific terms assigned in the wp_guideline_type taxonomy. - name: wp_guideline_type_exclude in: query required: false schema: type: string description: Limit result set to items except those with specific terms assigned in the wp_guideline_type taxonomy. post: operationId: postWpV2SitesbyWpcomSiteGuidelines summary: POST /wp/v2/sites/{wpcom_site}/guidelines tags: - guidelines responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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 - spam 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. template: type: string description: The theme file to use to display the post. wp_guideline_type: type: array items: type: integer description: The terms assigned to the post in the wp_guideline_type taxonomy. /wp/v2/sites/{wpcom_site}/guidelines/{id}: get: operationId: getWpV2SitesbyWpcomSiteGuidelinesbyId summary: GET /wp/v2/sites/{wpcom_site}/guidelines/{id} tags: - guidelines responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: excerpt_length in: query required: false schema: type: integer description: Override the default excerpt length. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. post: operationId: postWpV2SitesbyWpcomSiteGuidelinesbyId summary: POST /wp/v2/sites/{wpcom_site}/guidelines/{id} tags: - guidelines responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: &id008 - publish - future - draft - pending - private - spam 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. template: type: string description: The theme file to use to display the post. wp_guideline_type: type: array items: type: integer description: The terms assigned to the post in the wp_guideline_type taxonomy. put: operationId: putWpV2SitesbyWpcomSiteGuidelinesbyId summary: PUT /wp/v2/sites/{wpcom_site}/guidelines/{id} tags: - guidelines responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id008 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. template: type: string description: The theme file to use to display the post. wp_guideline_type: type: array items: type: integer description: The terms assigned to the post in the wp_guideline_type taxonomy. patch: operationId: patchWpV2SitesbyWpcomSiteGuidelinesbyId summary: PATCH /wp/v2/sites/{wpcom_site}/guidelines/{id} tags: - guidelines responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id008 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. template: type: string description: The theme file to use to display the post. wp_guideline_type: type: array items: type: integer description: The terms assigned to the post in the wp_guideline_type taxonomy. delete: operationId: deleteWpV2SitesbyWpcomSiteGuidelinesbyId summary: DELETE /wp/v2/sites/{wpcom_site}/guidelines/{id} tags: - guidelines responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/guidelines/{id}/autosaves: get: operationId: getWpV2SitesbyWpcomSiteGuidelinesbyIdAutosaves summary: GET /wp/v2/sites/{wpcom_site}/guidelines/{id}/autosaves tags: - guidelines responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteGuidelinesbyIdAutosaves summary: POST /wp/v2/sites/{wpcom_site}/guidelines/{id}/autosaves tags: - guidelines responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - 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 - spam 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. template: type: string description: The theme file to use to display the post. wp_guideline_type: type: array items: type: integer description: The terms assigned to the post in the wp_guideline_type taxonomy. /wp/v2/sites/{wpcom_site}/guidelines/{parent}/autosaves/{id}: get: operationId: getWpV2SitesbyWpcomSiteGuidelinesbyParentAutosavesbyId summary: GET /wp/v2/sites/{wpcom_site}/guidelines/{parent}/autosaves/{id} tags: - guidelines responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/guidelines/{parent}/revisions: get: operationId: getWpV2SitesbyWpcomSiteGuidelinesbyParentRevisions summary: GET /wp/v2/sites/{wpcom_site}/guidelines/{parent}/revisions tags: - guidelines responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. /wp/v2/sites/{wpcom_site}/guidelines/{parent}/revisions/{id}: get: operationId: getWpV2SitesbyWpcomSiteGuidelinesbyParentRevisionsbyId summary: GET /wp/v2/sites/{wpcom_site}/guidelines/{parent}/revisions/{id} tags: - guidelines responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. delete: operationId: deleteWpV2SitesbyWpcomSiteGuidelinesbyParentRevisionsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/guidelines/{parent}/revisions/{id} tags: - guidelines responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as revisions do not support trashing. /wp/v2/sites/{wpcom_site}/icon-collections: get: operationId: getWpV2SitesbyWpcomSiteIconCollections summary: GET /wp/v2/sites/{wpcom_site}/icon-collections tags: - icon-collections responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. /wp/v2/sites/{wpcom_site}/icon-collections/{slug}: get: operationId: getWpV2SitesbyWpcomSiteIconCollectionsbySlug summary: GET /wp/v2/sites/{wpcom_site}/icon-collections/{slug} tags: - icon-collections responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: slug in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/icons: get: operationId: getWpV2SitesbyWpcomSiteIcons summary: GET /wp/v2/sites/{wpcom_site}/icons tags: - icons responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: collection in: query required: false schema: type: string description: Limit results to icons belonging to the given collection slug. /wp/v2/sites/{wpcom_site}/icons/{collection}: get: operationId: getWpV2SitesbyWpcomSiteIconsbyCollection summary: GET /wp/v2/sites/{wpcom_site}/icons/{collection} tags: - icons responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: collection in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. /wp/v2/sites/{wpcom_site}/icons/{name}: get: operationId: getWpV2SitesbyWpcomSiteIconsbyName summary: GET /wp/v2/sites/{wpcom_site}/icons/{name} tags: - icons responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: name in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/jetpack-forms: get: operationId: getWpV2SitesbyWpcomSiteJetpackForms summary: GET /wp/v2/sites/{wpcom_site}/jetpack-forms tags: - jetpack-forms responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: author in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to posts assigned to specific authors. - name: author_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes posts assigned to specific authors. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. - name: jetpack_forms_context in: query required: false schema: type: string enum: - '' - dashboard default: '' description: Request context for Jetpack Forms. Use "dashboard" to include dashboard-only fields. - name: has_responses in: query required: false schema: type: string enum: - '' - 'true' - 'false' default: '' description: Filter forms by whether they have responses. "true" returns only forms with responses, "false" returns only forms without. post: operationId: postWpV2SitesbyWpcomSiteJetpackForms summary: POST /wp/v2/sites/{wpcom_site}/jetpack-forms tags: - jetpack-forms responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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 - spam - auto-draft 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. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. /wp/v2/sites/{wpcom_site}/jetpack-forms/status-counts: get: operationId: getWpV2SitesbyWpcomSiteJetpackFormsStatusCounts summary: GET /wp/v2/sites/{wpcom_site}/jetpack-forms/status-counts tags: - jetpack-forms responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/jetpack-forms/{id}: get: operationId: getWpV2SitesbyWpcomSiteJetpackFormsbyId summary: GET /wp/v2/sites/{wpcom_site}/jetpack-forms/{id} tags: - jetpack-forms responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. post: operationId: postWpV2SitesbyWpcomSiteJetpackFormsbyId summary: POST /wp/v2/sites/{wpcom_site}/jetpack-forms/{id} tags: - jetpack-forms responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: &id009 - publish - future - draft - pending - private - spam - auto-draft 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. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. put: operationId: putWpV2SitesbyWpcomSiteJetpackFormsbyId summary: PUT /wp/v2/sites/{wpcom_site}/jetpack-forms/{id} tags: - jetpack-forms responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id009 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. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. patch: operationId: patchWpV2SitesbyWpcomSiteJetpackFormsbyId summary: PATCH /wp/v2/sites/{wpcom_site}/jetpack-forms/{id} tags: - jetpack-forms responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id009 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. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. delete: operationId: deleteWpV2SitesbyWpcomSiteJetpackFormsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/jetpack-forms/{id} tags: - jetpack-forms responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/jetpack-forms/{id}/autosaves: get: operationId: getWpV2SitesbyWpcomSiteJetpackFormsbyIdAutosaves summary: GET /wp/v2/sites/{wpcom_site}/jetpack-forms/{id}/autosaves tags: - jetpack-forms responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteJetpackFormsbyIdAutosaves summary: POST /wp/v2/sites/{wpcom_site}/jetpack-forms/{id}/autosaves tags: - jetpack-forms responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - 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 - spam - auto-draft 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. meta: type: object description: Meta fields. template: type: string description: The theme file to use to display the post. /wp/v2/sites/{wpcom_site}/jetpack-forms/{id}/preview-url: get: operationId: getWpV2SitesbyWpcomSiteJetpackFormsbyIdPreviewUrl summary: GET /wp/v2/sites/{wpcom_site}/jetpack-forms/{id}/preview-url tags: - jetpack-forms responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/jetpack-forms/{parent}/autosaves/{id}: get: operationId: getWpV2SitesbyWpcomSiteJetpackFormsbyParentAutosavesbyId summary: GET /wp/v2/sites/{wpcom_site}/jetpack-forms/{parent}/autosaves/{id} tags: - jetpack-forms responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/jetpack-forms/{parent}/revisions: get: operationId: getWpV2SitesbyWpcomSiteJetpackFormsbyParentRevisions summary: GET /wp/v2/sites/{wpcom_site}/jetpack-forms/{parent}/revisions tags: - jetpack-forms responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. /wp/v2/sites/{wpcom_site}/jetpack-forms/{parent}/revisions/{id}: get: operationId: getWpV2SitesbyWpcomSiteJetpackFormsbyParentRevisionsbyId summary: GET /wp/v2/sites/{wpcom_site}/jetpack-forms/{parent}/revisions/{id} tags: - jetpack-forms responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. delete: operationId: deleteWpV2SitesbyWpcomSiteJetpackFormsbyParentRevisionsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/jetpack-forms/{parent}/revisions/{id} tags: - jetpack-forms responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as revisions do not support trashing. /wp/v2/sites/{wpcom_site}/jetpack-global-styles: get: operationId: getWpV2SitesbyWpcomSiteJetpackGlobalStyles summary: GET /wp/v2/sites/{wpcom_site}/jetpack-global-styles tags: - jetpack-global-styles responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string post: operationId: postWpV2SitesbyWpcomSiteJetpackGlobalStyles summary: POST /wp/v2/sites/{wpcom_site}/jetpack-global-styles tags: - jetpack-global-styles responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/jp_pay_order: get: operationId: getWpV2SitesbyWpcomSiteJpPayOrder summary: GET /wp/v2/sites/{wpcom_site}/jp_pay_order tags: - jp_pay_order responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. post: operationId: postWpV2SitesbyWpcomSiteJpPayOrder summary: POST /wp/v2/sites/{wpcom_site}/jp_pay_order tags: - jp_pay_order responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. 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/v2/sites/{wpcom_site}/jp_pay_order/{id}: get: operationId: getWpV2SitesbyWpcomSiteJpPayOrderbyId summary: GET /wp/v2/sites/{wpcom_site}/jp_pay_order/{id} tags: - jp_pay_order responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: excerpt_length in: query required: false schema: type: integer description: Override the default excerpt length. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. post: operationId: postWpV2SitesbyWpcomSiteJpPayOrderbyId summary: POST /wp/v2/sites/{wpcom_site}/jp_pay_order/{id} tags: - jp_pay_order responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: &id010 - publish - future - draft - pending - private - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. 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. put: operationId: putWpV2SitesbyWpcomSiteJpPayOrderbyId summary: PUT /wp/v2/sites/{wpcom_site}/jp_pay_order/{id} tags: - jp_pay_order responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id010 description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. 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. patch: operationId: patchWpV2SitesbyWpcomSiteJpPayOrderbyId summary: PATCH /wp/v2/sites/{wpcom_site}/jp_pay_order/{id} tags: - jp_pay_order responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id010 description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. 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. delete: operationId: deleteWpV2SitesbyWpcomSiteJpPayOrderbyId summary: DELETE /wp/v2/sites/{wpcom_site}/jp_pay_order/{id} tags: - jp_pay_order responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/jp_pay_order/{id}/autosaves: get: operationId: getWpV2SitesbyWpcomSiteJpPayOrderbyIdAutosaves summary: GET /wp/v2/sites/{wpcom_site}/jp_pay_order/{id}/autosaves tags: - jp_pay_order responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteJpPayOrderbyIdAutosaves summary: POST /wp/v2/sites/{wpcom_site}/jp_pay_order/{id}/autosaves tags: - jp_pay_order responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - 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 - spam description: A named status for the post. password: type: string description: A password to protect access to the content and excerpt. 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/v2/sites/{wpcom_site}/jp_pay_order/{parent}/autosaves/{id}: get: operationId: getWpV2SitesbyWpcomSiteJpPayOrderbyParentAutosavesbyId summary: GET /wp/v2/sites/{wpcom_site}/jp_pay_order/{parent}/autosaves/{id} tags: - jp_pay_order responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/jp_pay_product: get: operationId: getWpV2SitesbyWpcomSiteJpPayProduct summary: GET /wp/v2/sites/{wpcom_site}/jp_pay_product tags: - jp_pay_product responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: author in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to posts assigned to specific authors. - name: author_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes posts assigned to specific authors. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. post: operationId: postWpV2SitesbyWpcomSiteJpPayProduct summary: POST /wp/v2/sites/{wpcom_site}/jp_pay_product tags: - jp_pay_product responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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 - spam 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. 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/sites/{wpcom_site}/jp_pay_product/{id}: get: operationId: getWpV2SitesbyWpcomSiteJpPayProductbyId summary: GET /wp/v2/sites/{wpcom_site}/jp_pay_product/{id} tags: - jp_pay_product responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. post: operationId: postWpV2SitesbyWpcomSiteJpPayProductbyId summary: POST /wp/v2/sites/{wpcom_site}/jp_pay_product/{id} tags: - jp_pay_product responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: &id011 - publish - future - draft - pending - private - spam 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. 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: operationId: putWpV2SitesbyWpcomSiteJpPayProductbyId summary: PUT /wp/v2/sites/{wpcom_site}/jp_pay_product/{id} tags: - jp_pay_product responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id011 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. 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: operationId: patchWpV2SitesbyWpcomSiteJpPayProductbyId summary: PATCH /wp/v2/sites/{wpcom_site}/jp_pay_product/{id} tags: - jp_pay_product responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id011 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. 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: operationId: deleteWpV2SitesbyWpcomSiteJpPayProductbyId summary: DELETE /wp/v2/sites/{wpcom_site}/jp_pay_product/{id} tags: - jp_pay_product responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/jp_pay_product/{id}/autosaves: get: operationId: getWpV2SitesbyWpcomSiteJpPayProductbyIdAutosaves summary: GET /wp/v2/sites/{wpcom_site}/jp_pay_product/{id}/autosaves tags: - jp_pay_product responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteJpPayProductbyIdAutosaves summary: POST /wp/v2/sites/{wpcom_site}/jp_pay_product/{id}/autosaves tags: - jp_pay_product responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - 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 - spam 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. 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/sites/{wpcom_site}/jp_pay_product/{parent}/autosaves/{id}: get: operationId: getWpV2SitesbyWpcomSiteJpPayProductbyParentAutosavesbyId summary: GET /wp/v2/sites/{wpcom_site}/jp_pay_product/{parent}/autosaves/{id} tags: - jp_pay_product responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/knowledge: get: operationId: getWpV2SitesbyWpcomSiteKnowledge summary: GET /wp/v2/sites/{wpcom_site}/knowledge tags: - knowledge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: author in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to posts assigned to specific authors. - name: author_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes posts assigned to specific authors. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. - name: tax_relation in: query required: false schema: type: string enum: - AND - OR description: Limit result set based on relationship between multiple taxonomies. - name: wp_knowledge_type in: query required: false schema: type: string description: Limit result set to items with specific terms assigned in the wp_knowledge_type taxonomy. - name: wp_knowledge_type_exclude in: query required: false schema: type: string description: Limit result set to items except those with specific terms assigned in the wp_knowledge_type taxonomy. post: operationId: postWpV2SitesbyWpcomSiteKnowledge summary: POST /wp/v2/sites/{wpcom_site}/knowledge tags: - knowledge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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 - spam 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. template: type: string description: The theme file to use to display the post. wp_knowledge_type: type: array items: type: integer description: The terms assigned to the post in the wp_knowledge_type taxonomy. /wp/v2/sites/{wpcom_site}/knowledge/guideline-scopes: get: operationId: getWpV2SitesbyWpcomSiteKnowledgeGuidelineScopes summary: GET /wp/v2/sites/{wpcom_site}/knowledge/guideline-scopes tags: - knowledge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/knowledge/{id}: get: operationId: getWpV2SitesbyWpcomSiteKnowledgebyId summary: GET /wp/v2/sites/{wpcom_site}/knowledge/{id} tags: - knowledge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: excerpt_length in: query required: false schema: type: integer description: Override the default excerpt length. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. post: operationId: postWpV2SitesbyWpcomSiteKnowledgebyId summary: POST /wp/v2/sites/{wpcom_site}/knowledge/{id} tags: - knowledge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: &id012 - publish - future - draft - pending - private - spam 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. template: type: string description: The theme file to use to display the post. wp_knowledge_type: type: array items: type: integer description: The terms assigned to the post in the wp_knowledge_type taxonomy. put: operationId: putWpV2SitesbyWpcomSiteKnowledgebyId summary: PUT /wp/v2/sites/{wpcom_site}/knowledge/{id} tags: - knowledge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id012 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. template: type: string description: The theme file to use to display the post. wp_knowledge_type: type: array items: type: integer description: The terms assigned to the post in the wp_knowledge_type taxonomy. patch: operationId: patchWpV2SitesbyWpcomSiteKnowledgebyId summary: PATCH /wp/v2/sites/{wpcom_site}/knowledge/{id} tags: - knowledge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id012 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. template: type: string description: The theme file to use to display the post. wp_knowledge_type: type: array items: type: integer description: The terms assigned to the post in the wp_knowledge_type taxonomy. delete: operationId: deleteWpV2SitesbyWpcomSiteKnowledgebyId summary: DELETE /wp/v2/sites/{wpcom_site}/knowledge/{id} tags: - knowledge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/knowledge/{id}/autosaves: get: operationId: getWpV2SitesbyWpcomSiteKnowledgebyIdAutosaves summary: GET /wp/v2/sites/{wpcom_site}/knowledge/{id}/autosaves tags: - knowledge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteKnowledgebyIdAutosaves summary: POST /wp/v2/sites/{wpcom_site}/knowledge/{id}/autosaves tags: - knowledge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - 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 - spam 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. template: type: string description: The theme file to use to display the post. wp_knowledge_type: type: array items: type: integer description: The terms assigned to the post in the wp_knowledge_type taxonomy. /wp/v2/sites/{wpcom_site}/knowledge/{parent}/autosaves/{id}: get: operationId: getWpV2SitesbyWpcomSiteKnowledgebyParentAutosavesbyId summary: GET /wp/v2/sites/{wpcom_site}/knowledge/{parent}/autosaves/{id} tags: - knowledge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/knowledge/{parent}/revisions: get: operationId: getWpV2SitesbyWpcomSiteKnowledgebyParentRevisions summary: GET /wp/v2/sites/{wpcom_site}/knowledge/{parent}/revisions tags: - knowledge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. /wp/v2/sites/{wpcom_site}/knowledge/{parent}/revisions/{id}: get: operationId: getWpV2SitesbyWpcomSiteKnowledgebyParentRevisionsbyId summary: GET /wp/v2/sites/{wpcom_site}/knowledge/{parent}/revisions/{id} tags: - knowledge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. delete: operationId: deleteWpV2SitesbyWpcomSiteKnowledgebyParentRevisionsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/knowledge/{parent}/revisions/{id} tags: - knowledge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as revisions do not support trashing. /wp/v2/sites/{wpcom_site}/media: get: operationId: getWpV2SitesbyWpcomSiteMedia summary: GET /wp/v2/sites/{wpcom_site}/media tags: - media responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: author in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to posts assigned to specific authors. - name: author_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes posts assigned to specific authors. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: parent in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to items with particular parent IDs. - name: parent_exclude in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to all items except those of a particular parent ID. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: inherit items: type: string description: Limit result set to posts assigned one or more statuses. - name: media_type in: query required: false schema: type: array items: type: string description: Limit result set to attachments of a particular media type or media types. - name: mime_type in: query required: false schema: type: array items: type: string description: Limit result set to attachments of a particular MIME type or MIME types. post: operationId: postWpV2SitesbyWpcomSiteMedia summary: POST /wp/v2/sites/{wpcom_site}/media tags: - media responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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 - spam 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? filename: type: string description: Original attachment file name filesize: type: number description: Attachment file size jetpack_likes_enabled: type: boolean description: Are Likes enabled? 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/sites/{wpcom_site}/media/{id}: get: operationId: getWpV2SitesbyWpcomSiteMediabyId summary: GET /wp/v2/sites/{wpcom_site}/media/{id} tags: - media responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteMediabyId summary: POST /wp/v2/sites/{wpcom_site}/media/{id} tags: - media responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: &id013 - publish - future - draft - pending - private - spam 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: &id014 - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: &id015 - 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? filename: type: string description: Original attachment file name filesize: type: number description: Attachment file size jetpack_likes_enabled: type: boolean description: Are Likes enabled? 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: operationId: putWpV2SitesbyWpcomSiteMediabyId summary: PUT /wp/v2/sites/{wpcom_site}/media/{id} tags: - media responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id013 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: *id014 description: Whether or not comments are open on the post. ping_status: type: string enum: *id015 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? filename: type: string description: Original attachment file name filesize: type: number description: Attachment file size jetpack_likes_enabled: type: boolean description: Are Likes enabled? 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: operationId: patchWpV2SitesbyWpcomSiteMediabyId summary: PATCH /wp/v2/sites/{wpcom_site}/media/{id} tags: - media responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id013 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: *id014 description: Whether or not comments are open on the post. ping_status: type: string enum: *id015 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? filename: type: string description: Original attachment file name filesize: type: number description: Attachment file size jetpack_likes_enabled: type: boolean description: Are Likes enabled? 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: operationId: deleteWpV2SitesbyWpcomSiteMediabyId summary: DELETE /wp/v2/sites/{wpcom_site}/media/{id} tags: - media responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/media/{id}/edit: post: operationId: postWpV2SitesbyWpcomSiteMediabyIdEdit summary: POST /wp/v2/sites/{wpcom_site}/media/{id}/edit tags: - media responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - 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: type: object 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/sites/{wpcom_site}/media/{id}/finalize: post: operationId: postWpV2SitesbyWpcomSiteMediabyIdFinalize summary: POST /wp/v2/sites/{wpcom_site}/media/{id}/finalize tags: - media responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: sub_sizes: type: array default: [] items: type: object description: Array of sub-size metadata collected from sideload responses. /wp/v2/sites/{wpcom_site}/media/{id}/post-process: post: operationId: postWpV2SitesbyWpcomSiteMediabyIdPostProcess summary: POST /wp/v2/sites/{wpcom_site}/media/{id}/post-process tags: - media responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: action: type: string enum: - create-image-subsizes required: - action /wp/v2/sites/{wpcom_site}/media/{id}/sideload: post: operationId: postWpV2SitesbyWpcomSiteMediabyIdSideload summary: POST /wp/v2/sites/{wpcom_site}/media/{id}/sideload tags: - media responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: image_size: type: string items: 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/sites/{wpcom_site}/menu-items: get: operationId: getWpV2SitesbyWpcomSiteMenuItems summary: GET /wp/v2/sites/{wpcom_site}/menu-items tags: - menu-items responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 100 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - menu_order default: menu_order description: Sort collection by object attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. - name: tax_relation in: query required: false schema: type: string enum: - AND - OR description: Limit result set based on relationship between multiple taxonomies. - name: menus in: query required: false schema: type: string description: Limit result set to items with specific terms assigned in the menus taxonomy. - name: menus_exclude in: query required: false schema: type: string description: Limit result set to items except those with specific terms assigned in the menus taxonomy. - name: menu_order in: query required: false schema: type: integer description: Limit result set to posts with a specific menu_order value. post: operationId: postWpV2SitesbyWpcomSiteMenuItems summary: POST /wp/v2/sites/{wpcom_site}/menu-items tags: - menu-items responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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 default: custom description: The family of objects originally represented, such as "post_type" or "taxonomy". status: type: string enum: - publish - future - draft - pending - private - spam default: publish 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/sites/{wpcom_site}/menu-items/{id}: get: operationId: getWpV2SitesbyWpcomSiteMenuItemsbyId summary: GET /wp/v2/sites/{wpcom_site}/menu-items/{id} tags: - menu-items responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteMenuItemsbyId summary: POST /wp/v2/sites/{wpcom_site}/menu-items/{id} tags: - menu-items responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: title: type: string description: The title for the object. type: type: string enum: &id016 - taxonomy - post_type - post_type_archive - custom description: The family of objects originally represented, such as "post_type" or "taxonomy". status: type: string enum: &id017 - publish - future - draft - pending - private - spam 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: &id018 - _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: operationId: putWpV2SitesbyWpcomSiteMenuItemsbyId summary: PUT /wp/v2/sites/{wpcom_site}/menu-items/{id} tags: - menu-items responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: title: type: string description: The title for the object. type: type: string enum: *id016 description: The family of objects originally represented, such as "post_type" or "taxonomy". status: type: string enum: *id017 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: *id018 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: operationId: patchWpV2SitesbyWpcomSiteMenuItemsbyId summary: PATCH /wp/v2/sites/{wpcom_site}/menu-items/{id} tags: - menu-items responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: title: type: string description: The title for the object. type: type: string enum: *id016 description: The family of objects originally represented, such as "post_type" or "taxonomy". status: type: string enum: *id017 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: *id018 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: operationId: deleteWpV2SitesbyWpcomSiteMenuItemsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/menu-items/{id} tags: - menu-items responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/menu-items/{id}/autosaves: get: operationId: getWpV2SitesbyWpcomSiteMenuItemsbyIdAutosaves summary: GET /wp/v2/sites/{wpcom_site}/menu-items/{id}/autosaves tags: - menu-items responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteMenuItemsbyIdAutosaves summary: POST /wp/v2/sites/{wpcom_site}/menu-items/{id}/autosaves tags: - menu-items responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - 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 - spam 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/sites/{wpcom_site}/menu-items/{parent}/autosaves/{id}: get: operationId: getWpV2SitesbyWpcomSiteMenuItemsbyParentAutosavesbyId summary: GET /wp/v2/sites/{wpcom_site}/menu-items/{parent}/autosaves/{id} tags: - menu-items responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/menu-locations: get: operationId: getWpV2SitesbyWpcomSiteMenuLocations summary: GET /wp/v2/sites/{wpcom_site}/menu-locations tags: - menu-locations responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/menu-locations/{location}: get: operationId: getWpV2SitesbyWpcomSiteMenuLocationsbyLocation summary: GET /wp/v2/sites/{wpcom_site}/menu-locations/{location} tags: - menu-locations responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: location in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/menus: get: operationId: getWpV2SitesbyWpcomSiteMenus summary: GET /wp/v2/sites/{wpcom_site}/menus tags: - menus responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name description: Sort collection by term attribute. - name: hide_empty in: query required: false schema: type: boolean default: false description: Whether to hide terms not assigned to any posts. - name: post in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific post. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to terms with one or more specific slugs. post: operationId: postWpV2SitesbyWpcomSiteMenus summary: POST /wp/v2/sites/{wpcom_site}/menus tags: - menus responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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/sites/{wpcom_site}/menus/{id}: get: operationId: getWpV2SitesbyWpcomSiteMenusbyId summary: GET /wp/v2/sites/{wpcom_site}/menus/{id} tags: - menus responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteMenusbyId summary: POST /wp/v2/sites/{wpcom_site}/menus/{id} tags: - menus responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: putWpV2SitesbyWpcomSiteMenusbyId summary: PUT /wp/v2/sites/{wpcom_site}/menus/{id} tags: - menus responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: patchWpV2SitesbyWpcomSiteMenusbyId summary: PATCH /wp/v2/sites/{wpcom_site}/menus/{id} tags: - menus responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: deleteWpV2SitesbyWpcomSiteMenusbyId summary: DELETE /wp/v2/sites/{wpcom_site}/menus/{id} tags: - menus responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as terms do not support trashing. /wp/v2/sites/{wpcom_site}/navigation: get: operationId: getWpV2SitesbyWpcomSiteNavigation summary: GET /wp/v2/sites/{wpcom_site}/navigation tags: - navigation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. post: operationId: postWpV2SitesbyWpcomSiteNavigation summary: POST /wp/v2/sites/{wpcom_site}/navigation tags: - navigation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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 - spam 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/sites/{wpcom_site}/navigation/{id}: get: operationId: getWpV2SitesbyWpcomSiteNavigationbyId summary: GET /wp/v2/sites/{wpcom_site}/navigation/{id} tags: - navigation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. post: operationId: postWpV2SitesbyWpcomSiteNavigationbyId summary: POST /wp/v2/sites/{wpcom_site}/navigation/{id} tags: - navigation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: &id019 - publish - future - draft - pending - private - spam 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: operationId: putWpV2SitesbyWpcomSiteNavigationbyId summary: PUT /wp/v2/sites/{wpcom_site}/navigation/{id} tags: - navigation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id019 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: operationId: patchWpV2SitesbyWpcomSiteNavigationbyId summary: PATCH /wp/v2/sites/{wpcom_site}/navigation/{id} tags: - navigation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id019 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: operationId: deleteWpV2SitesbyWpcomSiteNavigationbyId summary: DELETE /wp/v2/sites/{wpcom_site}/navigation/{id} tags: - navigation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/navigation/{id}/autosaves: get: operationId: getWpV2SitesbyWpcomSiteNavigationbyIdAutosaves summary: GET /wp/v2/sites/{wpcom_site}/navigation/{id}/autosaves tags: - navigation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteNavigationbyIdAutosaves summary: POST /wp/v2/sites/{wpcom_site}/navigation/{id}/autosaves tags: - navigation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - 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 - spam 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/sites/{wpcom_site}/navigation/{parent}/autosaves/{id}: get: operationId: getWpV2SitesbyWpcomSiteNavigationbyParentAutosavesbyId summary: GET /wp/v2/sites/{wpcom_site}/navigation/{parent}/autosaves/{id} tags: - navigation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/navigation/{parent}/revisions: get: operationId: getWpV2SitesbyWpcomSiteNavigationbyParentRevisions summary: GET /wp/v2/sites/{wpcom_site}/navigation/{parent}/revisions tags: - navigation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. /wp/v2/sites/{wpcom_site}/navigation/{parent}/revisions/{id}: get: operationId: getWpV2SitesbyWpcomSiteNavigationbyParentRevisionsbyId summary: GET /wp/v2/sites/{wpcom_site}/navigation/{parent}/revisions/{id} tags: - navigation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. delete: operationId: deleteWpV2SitesbyWpcomSiteNavigationbyParentRevisionsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/navigation/{parent}/revisions/{id} tags: - navigation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as revisions do not support trashing. /wp/v2/sites/{wpcom_site}/pages: get: operationId: getWpV2SitesbyWpcomSitePages summary: GET /wp/v2/sites/{wpcom_site}/pages tags: - pages responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: author in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to posts assigned to specific authors. - name: author_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes posts assigned to specific authors. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: menu_order in: query required: false schema: type: integer description: Limit result set to posts with a specific menu_order value. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - menu_order default: date description: Sort collection by post attribute. - name: parent in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to items with particular parent IDs. - name: parent_exclude in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to all items except those of a particular parent ID. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. - name: orderby_hierarchy in: query required: false schema: type: boolean default: false description: Sort pages by hierarchy. post: operationId: postWpV2SitesbyWpcomSitePages summary: POST /wp/v2/sites/{wpcom_site}/pages tags: - pages responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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 - spam - auto-draft 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? jetpack_likes_enabled: type: boolean description: Are Likes enabled? /wp/v2/sites/{wpcom_site}/pages/{id}: get: operationId: getWpV2SitesbyWpcomSitePagesbyId summary: GET /wp/v2/sites/{wpcom_site}/pages/{id} tags: - pages responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: excerpt_length in: query required: false schema: type: integer description: Override the default excerpt length. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. post: operationId: postWpV2SitesbyWpcomSitePagesbyId summary: POST /wp/v2/sites/{wpcom_site}/pages/{id} tags: - pages responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: &id020 - publish - future - draft - pending - private - spam - auto-draft 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: &id021 - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: &id022 - 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? jetpack_likes_enabled: type: boolean description: Are Likes enabled? put: operationId: putWpV2SitesbyWpcomSitePagesbyId summary: PUT /wp/v2/sites/{wpcom_site}/pages/{id} tags: - pages responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id020 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: *id021 description: Whether or not comments are open on the post. ping_status: type: string enum: *id022 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? jetpack_likes_enabled: type: boolean description: Are Likes enabled? patch: operationId: patchWpV2SitesbyWpcomSitePagesbyId summary: PATCH /wp/v2/sites/{wpcom_site}/pages/{id} tags: - pages responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id020 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: *id021 description: Whether or not comments are open on the post. ping_status: type: string enum: *id022 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? jetpack_likes_enabled: type: boolean description: Are Likes enabled? delete: operationId: deleteWpV2SitesbyWpcomSitePagesbyId summary: DELETE /wp/v2/sites/{wpcom_site}/pages/{id} tags: - pages responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/pages/{id}/autosaves: get: operationId: getWpV2SitesbyWpcomSitePagesbyIdAutosaves summary: GET /wp/v2/sites/{wpcom_site}/pages/{id}/autosaves tags: - pages responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSitePagesbyIdAutosaves summary: POST /wp/v2/sites/{wpcom_site}/pages/{id}/autosaves tags: - pages responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - 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 - spam - auto-draft 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? jetpack_likes_enabled: type: boolean description: Are Likes enabled? /wp/v2/sites/{wpcom_site}/pages/{parent}/autosaves/{id}: get: operationId: getWpV2SitesbyWpcomSitePagesbyParentAutosavesbyId summary: GET /wp/v2/sites/{wpcom_site}/pages/{parent}/autosaves/{id} tags: - pages responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/pages/{parent}/revisions: get: operationId: getWpV2SitesbyWpcomSitePagesbyParentRevisions summary: GET /wp/v2/sites/{wpcom_site}/pages/{parent}/revisions tags: - pages responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. /wp/v2/sites/{wpcom_site}/pages/{parent}/revisions/{id}: get: operationId: getWpV2SitesbyWpcomSitePagesbyParentRevisionsbyId summary: GET /wp/v2/sites/{wpcom_site}/pages/{parent}/revisions/{id} tags: - pages responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. delete: operationId: deleteWpV2SitesbyWpcomSitePagesbyParentRevisionsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/pages/{parent}/revisions/{id} tags: - pages responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as revisions do not support trashing. /wp/v2/sites/{wpcom_site}/pattern-directory/patterns: get: operationId: getWpV2SitesbyWpcomSitePatternDirectoryPatterns summary: GET /wp/v2/sites/{wpcom_site}/pattern-directory/patterns tags: - pattern-directory responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 100 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: category in: query required: false schema: type: integer description: Limit results to those matching a category ID. - name: keyword in: query required: false schema: type: integer description: Limit results to those matching a keyword ID. - name: slug in: query required: false schema: type: array items: {} description: Limit results to those matching a pattern (slug). - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title - favorite_count default: date description: Sort collection by post attribute. /wp/v2/sites/{wpcom_site}/plugins: get: operationId: getWpV2SitesbyWpcomSitePlugins summary: GET /wp/v2/sites/{wpcom_site}/plugins tags: - plugins responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: status in: query required: false schema: type: array items: type: string description: Limits results to plugins with the given status. post: operationId: postWpV2SitesbyWpcomSitePlugins summary: POST /wp/v2/sites/{wpcom_site}/plugins tags: - plugins responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: slug: type: string description: WordPress.org plugin directory slug. status: type: string enum: - inactive - active - network-active default: inactive description: The plugin activation status. required: - slug /wp/v2/sites/{wpcom_site}/plugins/{plugin}: get: operationId: getWpV2SitesbyWpcomSitePluginsbyPlugin summary: GET /wp/v2/sites/{wpcom_site}/plugins/{plugin} tags: - plugins responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: plugin in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSitePluginsbyPlugin summary: POST /wp/v2/sites/{wpcom_site}/plugins/{plugin} tags: - plugins responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: plugin in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: context: type: string enum: &id023 - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. status: type: string enum: &id024 - inactive - active - network-active description: The plugin activation status. put: operationId: putWpV2SitesbyWpcomSitePluginsbyPlugin summary: PUT /wp/v2/sites/{wpcom_site}/plugins/{plugin} tags: - plugins responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: plugin in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: context: type: string enum: *id023 default: view description: Scope under which the request is made; determines fields present in response. status: type: string enum: *id024 description: The plugin activation status. patch: operationId: patchWpV2SitesbyWpcomSitePluginsbyPlugin summary: PATCH /wp/v2/sites/{wpcom_site}/plugins/{plugin} tags: - plugins responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: plugin in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: context: type: string enum: *id023 default: view description: Scope under which the request is made; determines fields present in response. status: type: string enum: *id024 description: The plugin activation status. delete: operationId: deleteWpV2SitesbyWpcomSitePluginsbyPlugin summary: DELETE /wp/v2/sites/{wpcom_site}/plugins/{plugin} tags: - plugins responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: plugin in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/posts: get: operationId: getWpV2SitesbyWpcomSitePosts summary: GET /wp/v2/sites/{wpcom_site}/posts tags: - posts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: modified_after in: query required: false schema: type: string format: date-time description: Limit response to posts modified after a given ISO8601 compliant date. - name: author in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to posts assigned to specific authors. - name: author_exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes posts assigned to specific authors. - name: before in: query required: false schema: type: string format: date-time description: Limit response to posts published before a given ISO8601 compliant date. - name: modified_before in: query required: false schema: type: string format: date-time description: Limit response to posts modified before a given ISO8601 compliant date. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: search_semantics in: query required: false schema: type: string enum: - exact description: How to interpret the search input. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - author - date - id - include - modified - parent - relevance - slug - include_slugs - title default: date description: Sort collection by post attribute. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to posts with one or more specific slugs. - name: status in: query required: false schema: type: array default: publish items: type: string description: Limit result set to posts assigned one or more statuses. - name: tax_relation in: query required: false schema: type: string enum: - AND - OR description: Limit result set based on relationship between multiple taxonomies. - name: categories in: query required: false schema: type: string description: Limit result set to items with specific terms assigned in the categories taxonomy. - name: categories_exclude in: query required: false schema: type: string description: Limit result set to items except those with specific terms assigned in the categories taxonomy. - name: tags in: query required: false schema: type: string description: Limit result set to items with specific terms assigned in the tags taxonomy. - name: tags_exclude in: query required: false schema: type: string description: Limit result set to items except those with specific terms assigned in the tags taxonomy. - name: sticky in: query required: false schema: type: boolean description: Limit result set to items that are sticky. - name: ignore_sticky in: query required: false schema: type: boolean default: true description: Whether to ignore sticky posts or not. - name: format in: query required: false schema: type: array items: type: string description: Limit result set to items assigned one or more given formats. post: operationId: postWpV2SitesbyWpcomSitePosts summary: POST /wp/v2/sites/{wpcom_site}/posts tags: - posts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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 - spam - auto-draft 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? jetpack_likes_enabled: type: boolean description: Are Likes enabled? jetpack_publicize_connections: type: array default: [] items: type: object /wp/v2/sites/{wpcom_site}/posts/{id}: get: operationId: getWpV2SitesbyWpcomSitePostsbyId summary: GET /wp/v2/sites/{wpcom_site}/posts/{id} tags: - posts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: excerpt_length in: query required: false schema: type: integer description: Override the default excerpt length. - name: password in: query required: false schema: type: string description: The password for the post if it is password protected. post: operationId: postWpV2SitesbyWpcomSitePostsbyId summary: POST /wp/v2/sites/{wpcom_site}/posts/{id} tags: - posts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: &id025 - publish - future - draft - pending - private - spam - auto-draft 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: &id026 - open - closed description: Whether or not comments are open on the post. ping_status: type: string enum: &id027 - open - closed description: Whether or not the post can be pinged. format: type: string enum: &id028 - 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? jetpack_likes_enabled: type: boolean description: Are Likes enabled? jetpack_publicize_connections: type: array items: type: object put: operationId: putWpV2SitesbyWpcomSitePostsbyId summary: PUT /wp/v2/sites/{wpcom_site}/posts/{id} tags: - posts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id025 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: *id026 description: Whether or not comments are open on the post. ping_status: type: string enum: *id027 description: Whether or not the post can be pinged. format: type: string enum: *id028 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? jetpack_likes_enabled: type: boolean description: Are Likes enabled? jetpack_publicize_connections: type: array items: type: object patch: operationId: patchWpV2SitesbyWpcomSitePostsbyId summary: PATCH /wp/v2/sites/{wpcom_site}/posts/{id} tags: - posts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id025 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: *id026 description: Whether or not comments are open on the post. ping_status: type: string enum: *id027 description: Whether or not the post can be pinged. format: type: string enum: *id028 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? jetpack_likes_enabled: type: boolean description: Are Likes enabled? jetpack_publicize_connections: type: array items: type: object delete: operationId: deleteWpV2SitesbyWpcomSitePostsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/posts/{id} tags: - posts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/posts/{id}/autosaves: get: operationId: getWpV2SitesbyWpcomSitePostsbyIdAutosaves summary: GET /wp/v2/sites/{wpcom_site}/posts/{id}/autosaves tags: - posts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: parent in: query required: false schema: type: integer description: The ID for the parent of the autosave. - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSitePostsbyIdAutosaves summary: POST /wp/v2/sites/{wpcom_site}/posts/{id}/autosaves tags: - posts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - 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 - spam - auto-draft 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. jetpack_sharing_enabled: type: boolean description: Are sharing buttons enabled? jetpack_likes_enabled: type: boolean description: Are Likes enabled? jetpack_publicize_connections: type: array items: type: object /wp/v2/sites/{wpcom_site}/posts/{parent}/autosaves/{id}: get: operationId: getWpV2SitesbyWpcomSitePostsbyParentAutosavesbyId summary: GET /wp/v2/sites/{wpcom_site}/posts/{parent}/autosaves/{id} tags: - posts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/posts/{parent}/revisions: get: operationId: getWpV2SitesbyWpcomSitePostsbyParentRevisions summary: GET /wp/v2/sites/{wpcom_site}/posts/{parent}/revisions tags: - posts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. /wp/v2/sites/{wpcom_site}/posts/{parent}/revisions/{id}: get: operationId: getWpV2SitesbyWpcomSitePostsbyParentRevisionsbyId summary: GET /wp/v2/sites/{wpcom_site}/posts/{parent}/revisions/{id} tags: - posts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. delete: operationId: deleteWpV2SitesbyWpcomSitePostsbyParentRevisionsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/posts/{parent}/revisions/{id} tags: - posts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as revisions do not support trashing. /wp/v2/sites/{wpcom_site}/search: get: operationId: getWpV2SitesbyWpcomSiteSearch summary: GET /wp/v2/sites/{wpcom_site}/search tags: - search responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: type in: query required: false schema: type: string enum: - post - term - post-format default: post description: Limit results to items of an object type. - name: subtype in: query required: false schema: type: array default: any items: type: string description: Limit results to items of one or more object subtypes. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. /wp/v2/sites/{wpcom_site}/settings: get: operationId: getWpV2SitesbyWpcomSiteSettings summary: GET /wp/v2/sites/{wpcom_site}/settings tags: - settings responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string post: operationId: postWpV2SitesbyWpcomSiteSettings summary: POST /wp/v2/sites/{wpcom_site}/settings tags: - settings responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: active_templates: type: object wordpress_api_key: type: string description: API key for the Akismet Anti-spam connector. site_logo: type: integer description: Site logo. site_icon: type: integer description: Site icon. title: type: string description: Site title. description: type: string description: Site tagline. 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: &id029 - open - closed description: Allow link notifications from other blogs (pingbacks and trackbacks) on new articles. default_comment_status: type: string enum: &id030 - open - closed description: Allow people to submit comments on new posts. gutenberg-experiments: type: object jetpack_social_image_generator_settings: type: object jetpack_social_utm_settings: type: object jetpack-social_show_pricing_page: type: boolean jetpack-social-note: type: boolean jetpack_social_notes_config: type: object jetpack_social_message_template: type: string cookie_consent_template: type: string Blogroll Recommendations: type: array items: type: object description: Site Recommendations put: operationId: putWpV2SitesbyWpcomSiteSettings summary: PUT /wp/v2/sites/{wpcom_site}/settings tags: - settings responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: active_templates: type: object wordpress_api_key: type: string description: API key for the Akismet Anti-spam connector. site_logo: type: integer description: Site logo. site_icon: type: integer description: Site icon. title: type: string description: Site title. description: type: string description: Site tagline. 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: *id029 description: Allow link notifications from other blogs (pingbacks and trackbacks) on new articles. default_comment_status: type: string enum: *id030 description: Allow people to submit comments on new posts. gutenberg-experiments: type: object jetpack_social_image_generator_settings: type: object jetpack_social_utm_settings: type: object jetpack-social_show_pricing_page: type: boolean jetpack-social-note: type: boolean jetpack_social_notes_config: type: object jetpack_social_message_template: type: string cookie_consent_template: type: string Blogroll Recommendations: type: array items: type: object description: Site Recommendations patch: operationId: patchWpV2SitesbyWpcomSiteSettings summary: PATCH /wp/v2/sites/{wpcom_site}/settings tags: - settings responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: active_templates: type: object wordpress_api_key: type: string description: API key for the Akismet Anti-spam connector. site_logo: type: integer description: Site logo. site_icon: type: integer description: Site icon. title: type: string description: Site title. description: type: string description: Site tagline. 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: *id029 description: Allow link notifications from other blogs (pingbacks and trackbacks) on new articles. default_comment_status: type: string enum: *id030 description: Allow people to submit comments on new posts. gutenberg-experiments: type: object jetpack_social_image_generator_settings: type: object jetpack_social_utm_settings: type: object jetpack-social_show_pricing_page: type: boolean jetpack-social-note: type: boolean jetpack_social_notes_config: type: object jetpack_social_message_template: type: string cookie_consent_template: type: string Blogroll Recommendations: type: array items: type: object description: Site Recommendations /wp/v2/sites/{wpcom_site}/sidebars: get: operationId: getWpV2SitesbyWpcomSiteSidebars summary: GET /wp/v2/sites/{wpcom_site}/sidebars tags: - sidebars responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/sidebars/{id}: get: operationId: getWpV2SitesbyWpcomSiteSidebarsbyId summary: GET /wp/v2/sites/{wpcom_site}/sidebars/{id} tags: - sidebars responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteSidebarsbyId summary: POST /wp/v2/sites/{wpcom_site}/sidebars/{id} tags: - sidebars responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: widgets: type: array items: {} description: Nested widgets. put: operationId: putWpV2SitesbyWpcomSiteSidebarsbyId summary: PUT /wp/v2/sites/{wpcom_site}/sidebars/{id} tags: - sidebars responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: widgets: type: array items: {} description: Nested widgets. patch: operationId: patchWpV2SitesbyWpcomSiteSidebarsbyId summary: PATCH /wp/v2/sites/{wpcom_site}/sidebars/{id} tags: - sidebars responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: widgets: type: array items: {} description: Nested widgets. /wp/v2/sites/{wpcom_site}/statuses: get: operationId: getWpV2SitesbyWpcomSiteStatuses summary: GET /wp/v2/sites/{wpcom_site}/statuses tags: - statuses responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/statuses/{status}: get: operationId: getWpV2SitesbyWpcomSiteStatusesbyStatus summary: GET /wp/v2/sites/{wpcom_site}/statuses/{status} tags: - statuses responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: status in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/tags: get: operationId: getWpV2SitesbyWpcomSiteTags summary: GET /wp/v2/sites/{wpcom_site}/tags tags: - tags responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name description: Sort collection by term attribute. - name: hide_empty in: query required: false schema: type: boolean default: false description: Whether to hide terms not assigned to any posts. - name: post in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific post. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to terms with one or more specific slugs. post: operationId: postWpV2SitesbyWpcomSiteTags summary: POST /wp/v2/sites/{wpcom_site}/tags tags: - tags responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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/sites/{wpcom_site}/tags/{id}: get: operationId: getWpV2SitesbyWpcomSiteTagsbyId summary: GET /wp/v2/sites/{wpcom_site}/tags/{id} tags: - tags responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteTagsbyId summary: POST /wp/v2/sites/{wpcom_site}/tags/{id} tags: - tags responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: putWpV2SitesbyWpcomSiteTagsbyId summary: PUT /wp/v2/sites/{wpcom_site}/tags/{id} tags: - tags responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: patchWpV2SitesbyWpcomSiteTagsbyId summary: PATCH /wp/v2/sites/{wpcom_site}/tags/{id} tags: - tags responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: deleteWpV2SitesbyWpcomSiteTagsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/tags/{id} tags: - tags responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as terms do not support trashing. /wp/v2/sites/{wpcom_site}/taxonomies: get: operationId: getWpV2SitesbyWpcomSiteTaxonomies summary: GET /wp/v2/sites/{wpcom_site}/taxonomies tags: - taxonomies responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: type in: query required: false schema: type: string description: Limit results to taxonomies associated with a specific post type. /wp/v2/sites/{wpcom_site}/taxonomies/{taxonomy}: get: operationId: getWpV2SitesbyWpcomSiteTaxonomiesbyTaxonomy summary: GET /wp/v2/sites/{wpcom_site}/taxonomies/{taxonomy} tags: - taxonomies responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: taxonomy in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/template-parts: get: operationId: getWpV2SitesbyWpcomSiteTemplateParts summary: GET /wp/v2/sites/{wpcom_site}/template-parts tags: - template-parts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: wp_id in: query required: false schema: type: integer description: Limit to the specified post id. - name: area in: query required: false schema: type: string description: Limit to the specified template part area. - name: post_type in: query required: false schema: type: string description: Post type to get the templates for. post: operationId: postWpV2SitesbyWpcomSiteTemplateParts summary: POST /wp/v2/sites/{wpcom_site}/template-parts tags: - template-parts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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: string default: '' description: Content of template. title: type: string default: '' description: Title of template. description: type: string default: '' description: Description of template. status: type: string enum: - publish - future - draft - pending - private - spam default: publish 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/sites/{wpcom_site}/template-parts/lookup: get: operationId: getWpV2SitesbyWpcomSiteTemplatePartsLookup summary: GET /wp/v2/sites/{wpcom_site}/template-parts/lookup tags: - template-parts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: slug in: query required: true schema: type: string description: The slug of the template to get the fallback for - name: is_custom in: query required: false schema: type: boolean description: Indicates if a template is custom or part of the template hierarchy - name: template_prefix in: query required: false 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/sites/{wpcom_site}/template-parts/{id}: get: operationId: getWpV2SitesbyWpcomSiteTemplatePartsbyId summary: GET /wp/v2/sites/{wpcom_site}/template-parts/{id} tags: - template-parts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteTemplatePartsbyId summary: POST /wp/v2/sites/{wpcom_site}/template-parts/{id} tags: - template-parts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: string description: Content of template. title: type: string description: Title of template. description: type: string description: Description of template. status: type: string enum: &id031 - publish - future - draft - pending - private - spam 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: operationId: putWpV2SitesbyWpcomSiteTemplatePartsbyId summary: PUT /wp/v2/sites/{wpcom_site}/template-parts/{id} tags: - template-parts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: string description: Content of template. title: type: string description: Title of template. description: type: string description: Description of template. status: type: string enum: *id031 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: operationId: patchWpV2SitesbyWpcomSiteTemplatePartsbyId summary: PATCH /wp/v2/sites/{wpcom_site}/template-parts/{id} tags: - template-parts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: string description: Content of template. title: type: string description: Title of template. description: type: string description: Description of template. status: type: string enum: *id031 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: operationId: deleteWpV2SitesbyWpcomSiteTemplatePartsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/template-parts/{id} tags: - template-parts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/template-parts/{id}/autosaves: get: operationId: getWpV2SitesbyWpcomSiteTemplatePartsbyIdAutosaves summary: GET /wp/v2/sites/{wpcom_site}/template-parts/{id}/autosaves tags: - template-parts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteTemplatePartsbyIdAutosaves summary: POST /wp/v2/sites/{wpcom_site}/template-parts/{id}/autosaves tags: - template-parts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: string description: Content of template. title: type: string description: Title of template. description: type: string description: Description of template. status: type: string enum: - publish - future - draft - pending - private - spam 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/sites/{wpcom_site}/template-parts/{parent}/autosaves/{id}: get: operationId: getWpV2SitesbyWpcomSiteTemplatePartsbyParentAutosavesbyId summary: GET /wp/v2/sites/{wpcom_site}/template-parts/{parent}/autosaves/{id} tags: - template-parts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/template-parts/{parent}/revisions: get: operationId: getWpV2SitesbyWpcomSiteTemplatePartsbyParentRevisions summary: GET /wp/v2/sites/{wpcom_site}/template-parts/{parent}/revisions tags: - template-parts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. /wp/v2/sites/{wpcom_site}/template-parts/{parent}/revisions/{id}: get: operationId: getWpV2SitesbyWpcomSiteTemplatePartsbyParentRevisionsbyId summary: GET /wp/v2/sites/{wpcom_site}/template-parts/{parent}/revisions/{id} tags: - template-parts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. delete: operationId: deleteWpV2SitesbyWpcomSiteTemplatePartsbyParentRevisionsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/template-parts/{parent}/revisions/{id} tags: - template-parts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as revisions do not support trashing. /wp/v2/sites/{wpcom_site}/templates: get: operationId: getWpV2SitesbyWpcomSiteTemplates summary: GET /wp/v2/sites/{wpcom_site}/templates tags: - templates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: wp_id in: query required: false schema: type: integer description: Limit to the specified post id. - name: area in: query required: false schema: type: string description: Limit to the specified template part area. - name: post_type in: query required: false schema: type: string description: Post type to get the templates for. post: operationId: postWpV2SitesbyWpcomSiteTemplates summary: POST /wp/v2/sites/{wpcom_site}/templates tags: - templates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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: string default: '' description: Content of template. title: type: string default: '' description: Title of template. description: type: string default: '' description: Description of template. status: type: string enum: - publish - future - draft - pending - private - spam default: publish description: Status of template. author: type: integer description: The ID for the author of the template. required: - slug /wp/v2/sites/{wpcom_site}/templates/lookup: get: operationId: getWpV2SitesbyWpcomSiteTemplatesLookup summary: GET /wp/v2/sites/{wpcom_site}/templates/lookup tags: - templates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: slug in: query required: true schema: type: string description: The slug of the template to get the fallback for - name: is_custom in: query required: false schema: type: boolean description: Indicates if a template is custom or part of the template hierarchy - name: template_prefix in: query required: false 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/sites/{wpcom_site}/templates/{id}: get: operationId: getWpV2SitesbyWpcomSiteTemplatesbyId summary: GET /wp/v2/sites/{wpcom_site}/templates/{id} tags: - templates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteTemplatesbyId summary: POST /wp/v2/sites/{wpcom_site}/templates/{id} tags: - templates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: string description: Content of template. title: type: string description: Title of template. description: type: string description: Description of template. status: type: string enum: &id032 - publish - future - draft - pending - private - spam description: Status of template. author: type: integer description: The ID for the author of the template. put: operationId: putWpV2SitesbyWpcomSiteTemplatesbyId summary: PUT /wp/v2/sites/{wpcom_site}/templates/{id} tags: - templates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: string description: Content of template. title: type: string description: Title of template. description: type: string description: Description of template. status: type: string enum: *id032 description: Status of template. author: type: integer description: The ID for the author of the template. patch: operationId: patchWpV2SitesbyWpcomSiteTemplatesbyId summary: PATCH /wp/v2/sites/{wpcom_site}/templates/{id} tags: - templates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: string description: Content of template. title: type: string description: Title of template. description: type: string description: Description of template. status: type: string enum: *id032 description: Status of template. author: type: integer description: The ID for the author of the template. delete: operationId: deleteWpV2SitesbyWpcomSiteTemplatesbyId summary: DELETE /wp/v2/sites/{wpcom_site}/templates/{id} tags: - templates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Whether to bypass Trash and force deletion. /wp/v2/sites/{wpcom_site}/templates/{id}/autosaves: get: operationId: getWpV2SitesbyWpcomSiteTemplatesbyIdAutosaves summary: GET /wp/v2/sites/{wpcom_site}/templates/{id}/autosaves tags: - templates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteTemplatesbyIdAutosaves summary: POST /wp/v2/sites/{wpcom_site}/templates/{id}/autosaves tags: - templates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: string description: Content of template. title: type: string description: Title of template. description: type: string description: Description of template. status: type: string enum: - publish - future - draft - pending - private - spam description: Status of template. author: type: integer description: The ID for the author of the template. /wp/v2/sites/{wpcom_site}/templates/{parent}/autosaves/{id}: get: operationId: getWpV2SitesbyWpcomSiteTemplatesbyParentAutosavesbyId summary: GET /wp/v2/sites/{wpcom_site}/templates/{parent}/autosaves/{id} tags: - templates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/templates/{parent}/revisions: get: operationId: getWpV2SitesbyWpcomSiteTemplatesbyParentRevisions summary: GET /wp/v2/sites/{wpcom_site}/templates/{parent}/revisions tags: - templates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - date - id - include - relevance - slug - include_slugs - title default: date description: Sort collection by object attribute. /wp/v2/sites/{wpcom_site}/templates/{parent}/revisions/{id}: get: operationId: getWpV2SitesbyWpcomSiteTemplatesbyParentRevisionsbyId summary: GET /wp/v2/sites/{wpcom_site}/templates/{parent}/revisions/{id} tags: - templates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. delete: operationId: deleteWpV2SitesbyWpcomSiteTemplatesbyParentRevisionsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/templates/{parent}/revisions/{id} tags: - templates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: parent in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as revisions do not support trashing. /wp/v2/sites/{wpcom_site}/themes: get: operationId: getWpV2SitesbyWpcomSiteThemes summary: GET /wp/v2/sites/{wpcom_site}/themes tags: - themes responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: status in: query required: false schema: type: array items: type: string description: Limit result set to themes assigned one or more statuses. /wp/v2/sites/{wpcom_site}/themes/{stylesheet}: get: operationId: getWpV2SitesbyWpcomSiteThemesbyStylesheet summary: GET /wp/v2/sites/{wpcom_site}/themes/{stylesheet} tags: - themes responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: stylesheet in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/types: get: operationId: getWpV2SitesbyWpcomSiteTypes summary: GET /wp/v2/sites/{wpcom_site}/types tags: - types responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/types/{type}: get: operationId: getWpV2SitesbyWpcomSiteTypesbyType summary: GET /wp/v2/sites/{wpcom_site}/types/{type} tags: - types responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: type in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/users: get: operationId: getWpV2SitesbyWpcomSiteUsers summary: GET /wp/v2/sites/{wpcom_site}/users tags: - users responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - registered_date - slug - include_slugs - email - url default: name description: Sort collection by user attribute. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to users with one or more specific slugs. - name: roles in: query required: false 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 required: false 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 required: false schema: type: string enum: - authors description: Limit result set to users who are considered authors. - name: has_published_posts in: query required: false schema: type: string items: type: string description: Limit result set to users who have published posts. - name: search_columns in: query required: false schema: type: array default: [] items: type: string description: Array of column names to be searched. post: operationId: postWpV2SitesbyWpcomSiteUsers summary: POST /wp/v2/sites/{wpcom_site}/users tags: - users responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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 - af - am - an - ar - as - ast - az - bel - bg - bn - bo - br - bs - ca - ckb - cs - cv - cy - da - de - de-ch - de_formal - dv - el - el-po - en - en-gb - eo - es - es-cl - es-mx - et - eu - fa - fi - fo - fr - fr-be - fr-ca - fr-ch - fur - fy - ga - gd - gl - gu - he - hi - hr - hu - hy - id - is - it - ja - ka - kab - kal - kir - kk - km - kn - ko - la - lo - lt - lv - mk - ml - mn - mr - ms - mt - mwl - nb - ne - nl - nn - oci - pa - pl - ps - pt - pt-br - ro - ru - rup - si - sk - skr - sl - snd - so - sq - sr - sr_latin - su - sv - ta - te - th - tir - tl - tr - ug - uk - ur - uz - vi - yi - yo - zh-cn - zh-hk - zh-sg - zh-tw 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. required: - username - email - password /wp/v2/sites/{wpcom_site}/users/me: get: operationId: getWpV2SitesbyWpcomSiteUsersMe summary: GET /wp/v2/sites/{wpcom_site}/users/me tags: - users responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteUsersMe summary: POST /wp/v2/sites/{wpcom_site}/users/me tags: - users responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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: &id033 - '' - en_US - af - am - an - ar - as - ast - az - bel - bg - bn - bo - br - bs - ca - ckb - cs - cv - cy - da - de - de-ch - de_formal - dv - el - el-po - en - en-gb - eo - es - es-cl - es-mx - et - eu - fa - fi - fo - fr - fr-be - fr-ca - fr-ch - fur - fy - ga - gd - gl - gu - he - hi - hr - hu - hy - id - is - it - ja - ka - kab - kal - kir - kk - km - kn - ko - la - lo - lt - lv - mk - ml - mn - mr - ms - mt - mwl - nb - ne - nl - nn - oci - pa - pl - ps - pt - pt-br - ro - ru - rup - si - sk - skr - sl - snd - so - sq - sr - sr_latin - su - sv - ta - te - th - tir - tl - tr - ug - uk - ur - uz - vi - yi - yo - zh-cn - zh-hk - zh-sg - zh-tw 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. put: operationId: putWpV2SitesbyWpcomSiteUsersMe summary: PUT /wp/v2/sites/{wpcom_site}/users/me tags: - users responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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: *id033 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. patch: operationId: patchWpV2SitesbyWpcomSiteUsersMe summary: PATCH /wp/v2/sites/{wpcom_site}/users/me tags: - users responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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: *id033 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. delete: operationId: deleteWpV2SitesbyWpcomSiteUsersMe summary: DELETE /wp/v2/sites/{wpcom_site}/users/me tags: - users responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as users do not support trashing. - name: reassign in: query required: true schema: type: integer description: Reassign the deleted user's posts and links to this user ID. /wp/v2/sites/{wpcom_site}/users/{id}: get: operationId: getWpV2SitesbyWpcomSiteUsersbyId summary: GET /wp/v2/sites/{wpcom_site}/users/{id} tags: - users responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteUsersbyId summary: POST /wp/v2/sites/{wpcom_site}/users/{id} tags: - users responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: &id034 - '' - en_US - af - am - an - ar - as - ast - az - bel - bg - bn - bo - br - bs - ca - ckb - cs - cv - cy - da - de - de-ch - de_formal - dv - el - el-po - en - en-gb - eo - es - es-cl - es-mx - et - eu - fa - fi - fo - fr - fr-be - fr-ca - fr-ch - fur - fy - ga - gd - gl - gu - he - hi - hr - hu - hy - id - is - it - ja - ka - kab - kal - kir - kk - km - kn - ko - la - lo - lt - lv - mk - ml - mn - mr - ms - mt - mwl - nb - ne - nl - nn - oci - pa - pl - ps - pt - pt-br - ro - ru - rup - si - sk - skr - sl - snd - so - sq - sr - sr_latin - su - sv - ta - te - th - tir - tl - tr - ug - uk - ur - uz - vi - yi - yo - zh-cn - zh-hk - zh-sg - zh-tw 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. put: operationId: putWpV2SitesbyWpcomSiteUsersbyId summary: PUT /wp/v2/sites/{wpcom_site}/users/{id} tags: - users responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id034 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. patch: operationId: patchWpV2SitesbyWpcomSiteUsersbyId summary: PATCH /wp/v2/sites/{wpcom_site}/users/{id} tags: - users responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: *id034 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. delete: operationId: deleteWpV2SitesbyWpcomSiteUsersbyId summary: DELETE /wp/v2/sites/{wpcom_site}/users/{id} tags: - users responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as users do not support trashing. - name: reassign in: query required: true schema: type: integer description: Reassign the deleted user's posts and links to this user ID. /wp/v2/sites/{wpcom_site}/view-config: get: operationId: getWpV2SitesbyWpcomSiteViewConfig summary: GET /wp/v2/sites/{wpcom_site}/view-config tags: - view-config responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: kind in: query required: true schema: type: string description: Entity kind. - name: name in: query required: true schema: type: string description: Entity name. /wp/v2/sites/{wpcom_site}/widget-types: get: operationId: getWpV2SitesbyWpcomSiteWidgetTypes summary: GET /wp/v2/sites/{wpcom_site}/widget-types tags: - widget-types responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/widget-types/{id}: get: operationId: getWpV2SitesbyWpcomSiteWidgetTypesbyId summary: GET /wp/v2/sites/{wpcom_site}/widget-types/{id} tags: - widget-types responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. /wp/v2/sites/{wpcom_site}/widget-types/{id}/encode: post: operationId: postWpV2SitesbyWpcomSiteWidgetTypesbyIdEncode summary: POST /wp/v2/sites/{wpcom_site}/widget-types/{id}/encode tags: - widget-types responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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/sites/{wpcom_site}/widget-types/{id}/render: post: operationId: postWpV2SitesbyWpcomSiteWidgetTypesbyIdRender summary: POST /wp/v2/sites/{wpcom_site}/widget-types/{id}/render tags: - widget-types responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: instance: type: object description: Current instance settings of the widget. /wp/v2/sites/{wpcom_site}/widgets: get: operationId: getWpV2SitesbyWpcomSiteWidgets summary: GET /wp/v2/sites/{wpcom_site}/widgets tags: - widgets responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: sidebar in: query required: false schema: type: string description: The sidebar to return widgets for. post: operationId: postWpV2SitesbyWpcomSiteWidgets summary: POST /wp/v2/sites/{wpcom_site}/widgets tags: - widgets responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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/sites/{wpcom_site}/widgets/{id}: get: operationId: getWpV2SitesbyWpcomSiteWidgetsbyId summary: GET /wp/v2/sites/{wpcom_site}/widgets/{id} tags: - widgets responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteWidgetsbyId summary: POST /wp/v2/sites/{wpcom_site}/widgets/{id} tags: - widgets responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: putWpV2SitesbyWpcomSiteWidgetsbyId summary: PUT /wp/v2/sites/{wpcom_site}/widgets/{id} tags: - widgets responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: patchWpV2SitesbyWpcomSiteWidgetsbyId summary: PATCH /wp/v2/sites/{wpcom_site}/widgets/{id} tags: - widgets responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: deleteWpV2SitesbyWpcomSiteWidgetsbyId summary: DELETE /wp/v2/sites/{wpcom_site}/widgets/{id} tags: - widgets responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean description: Whether to force removal of the widget, or move it to the inactive sidebar. /wp/v2/sites/{wpcom_site}/wp-abilities/v1/abilities: get: operationId: getWpV2SitesbyWpcomSiteWpAbilitiesV1Abilities summary: GET /wp/v2/sites/{wpcom_site}/wp-abilities/v1/abilities tags: - wp-abilities responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 50 description: Maximum number of items to be returned in result set. - name: category in: query required: false schema: type: string description: Limit results to abilities in specific ability category. /wp/v2/sites/{wpcom_site}/wp-abilities/v1/abilities/{name}: get: operationId: getWpV2SitesbyWpcomSiteWpAbilitiesV1AbilitiesbyName summary: GET /wp/v2/sites/{wpcom_site}/wp-abilities/v1/abilities/{name} tags: - wp-abilities responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: name in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/wp-abilities/v1/abilities/{name}/run: get: operationId: getWpV2SitesbyWpcomSiteWpAbilitiesV1AbilitiesbyNameRun summary: GET /wp/v2/sites/{wpcom_site}/wp-abilities/v1/abilities/{name}/run tags: - wp-abilities responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: name in: path required: true schema: type: string - name: input in: query required: false schema: type: string description: Input parameters for the ability execution. post: operationId: postWpV2SitesbyWpcomSiteWpAbilitiesV1AbilitiesbyNameRun summary: POST /wp/v2/sites/{wpcom_site}/wp-abilities/v1/abilities/{name}/run tags: - wp-abilities responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: name in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: input: type: string description: Input parameters for the ability execution. put: operationId: putWpV2SitesbyWpcomSiteWpAbilitiesV1AbilitiesbyNameRun summary: PUT /wp/v2/sites/{wpcom_site}/wp-abilities/v1/abilities/{name}/run tags: - wp-abilities responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: name in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: input: type: string description: Input parameters for the ability execution. patch: operationId: patchWpV2SitesbyWpcomSiteWpAbilitiesV1AbilitiesbyNameRun summary: PATCH /wp/v2/sites/{wpcom_site}/wp-abilities/v1/abilities/{name}/run tags: - wp-abilities responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: name in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: input: type: string description: Input parameters for the ability execution. delete: operationId: deleteWpV2SitesbyWpcomSiteWpAbilitiesV1AbilitiesbyNameRun summary: DELETE /wp/v2/sites/{wpcom_site}/wp-abilities/v1/abilities/{name}/run tags: - wp-abilities responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: name in: path required: true schema: type: string - name: input in: query required: false schema: type: string description: Input parameters for the ability execution. /wp/v2/sites/{wpcom_site}/wp-abilities/v1/categories: get: operationId: getWpV2SitesbyWpcomSiteWpAbilitiesV1Categories summary: GET /wp/v2/sites/{wpcom_site}/wp-abilities/v1/categories tags: - wp-abilities responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 50 description: Maximum number of items to be returned in result set. /wp/v2/sites/{wpcom_site}/wp-abilities/v1/categories/{slug}: get: operationId: getWpV2SitesbyWpcomSiteWpAbilitiesV1CategoriesbySlug summary: GET /wp/v2/sites/{wpcom_site}/wp-abilities/v1/categories/{slug} tags: - wp-abilities responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: slug in: path required: true schema: type: string /wp/v2/sites/{wpcom_site}/wp_guideline_type: get: operationId: getWpV2SitesbyWpcomSiteWpGuidelineType summary: GET /wp/v2/sites/{wpcom_site}/wp_guideline_type tags: - wp_guideline_type responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name description: Sort collection by term attribute. - name: hide_empty in: query required: false schema: type: boolean default: false description: Whether to hide terms not assigned to any posts. - name: parent in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific parent. - name: post in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific post. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to terms with one or more specific slugs. post: operationId: postWpV2SitesbyWpcomSiteWpGuidelineType summary: POST /wp/v2/sites/{wpcom_site}/wp_guideline_type tags: - wp_guideline_type responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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/sites/{wpcom_site}/wp_guideline_type/{id}: get: operationId: getWpV2SitesbyWpcomSiteWpGuidelineTypebyId summary: GET /wp/v2/sites/{wpcom_site}/wp_guideline_type/{id} tags: - wp_guideline_type responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteWpGuidelineTypebyId summary: POST /wp/v2/sites/{wpcom_site}/wp_guideline_type/{id} tags: - wp_guideline_type responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: putWpV2SitesbyWpcomSiteWpGuidelineTypebyId summary: PUT /wp/v2/sites/{wpcom_site}/wp_guideline_type/{id} tags: - wp_guideline_type responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: patchWpV2SitesbyWpcomSiteWpGuidelineTypebyId summary: PATCH /wp/v2/sites/{wpcom_site}/wp_guideline_type/{id} tags: - wp_guideline_type responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: deleteWpV2SitesbyWpcomSiteWpGuidelineTypebyId summary: DELETE /wp/v2/sites/{wpcom_site}/wp_guideline_type/{id} tags: - wp_guideline_type responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as terms do not support trashing. /wp/v2/sites/{wpcom_site}/wp_knowledge_type: get: operationId: getWpV2SitesbyWpcomSiteWpKnowledgeType summary: GET /wp/v2/sites/{wpcom_site}/wp_knowledge_type tags: - wp_knowledge_type responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name description: Sort collection by term attribute. - name: hide_empty in: query required: false schema: type: boolean default: false description: Whether to hide terms not assigned to any posts. - name: parent in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific parent. - name: post in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific post. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to terms with one or more specific slugs. post: operationId: postWpV2SitesbyWpcomSiteWpKnowledgeType summary: POST /wp/v2/sites/{wpcom_site}/wp_knowledge_type tags: - wp_knowledge_type responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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/sites/{wpcom_site}/wp_knowledge_type/{id}: get: operationId: getWpV2SitesbyWpcomSiteWpKnowledgeTypebyId summary: GET /wp/v2/sites/{wpcom_site}/wp_knowledge_type/{id} tags: - wp_knowledge_type responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteWpKnowledgeTypebyId summary: POST /wp/v2/sites/{wpcom_site}/wp_knowledge_type/{id} tags: - wp_knowledge_type responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: putWpV2SitesbyWpcomSiteWpKnowledgeTypebyId summary: PUT /wp/v2/sites/{wpcom_site}/wp_knowledge_type/{id} tags: - wp_knowledge_type responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: patchWpV2SitesbyWpcomSiteWpKnowledgeTypebyId summary: PATCH /wp/v2/sites/{wpcom_site}/wp_knowledge_type/{id} tags: - wp_knowledge_type responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: deleteWpV2SitesbyWpcomSiteWpKnowledgeTypebyId summary: DELETE /wp/v2/sites/{wpcom_site}/wp_knowledge_type/{id} tags: - wp_knowledge_type responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as terms do not support trashing. /wp/v2/sites/{wpcom_site}/wp_pattern_category: get: operationId: getWpV2SitesbyWpcomSiteWpPatternCategory summary: GET /wp/v2/sites/{wpcom_site}/wp_pattern_category tags: - wp_pattern_category responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: per_page in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: search in: query required: false schema: type: string description: Limit results to those matching a string. - name: exclude in: query required: false schema: type: array default: [] items: type: integer description: Ensure result set excludes specific IDs. - name: include in: query required: false schema: type: array default: [] items: type: integer description: Limit result set to specific IDs. - name: offset in: query required: false schema: type: integer description: Offset the result set by a specific number of items. - name: order in: query required: false schema: type: string enum: - asc - desc default: asc description: Order sort attribute ascending or descending. - name: orderby in: query required: false schema: type: string enum: - id - include - name - slug - include_slugs - term_group - description - count default: name description: Sort collection by term attribute. - name: hide_empty in: query required: false schema: type: boolean default: false description: Whether to hide terms not assigned to any posts. - name: post in: query required: false schema: type: integer description: Limit result set to terms assigned to a specific post. - name: slug in: query required: false schema: type: array items: type: string description: Limit result set to terms with one or more specific slugs. post: operationId: postWpV2SitesbyWpcomSiteWpPatternCategory summary: POST /wp/v2/sites/{wpcom_site}/wp_pattern_category tags: - wp_pattern_category responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string 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/sites/{wpcom_site}/wp_pattern_category/{id}: get: operationId: getWpV2SitesbyWpcomSiteWpPatternCategorybyId summary: GET /wp/v2/sites/{wpcom_site}/wp_pattern_category/{id} tags: - wp_pattern_category responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: context in: query required: false schema: type: string enum: - view - embed - edit default: view description: Scope under which the request is made; determines fields present in response. post: operationId: postWpV2SitesbyWpcomSiteWpPatternCategorybyId summary: POST /wp/v2/sites/{wpcom_site}/wp_pattern_category/{id} tags: - wp_pattern_category responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: putWpV2SitesbyWpcomSiteWpPatternCategorybyId summary: PUT /wp/v2/sites/{wpcom_site}/wp_pattern_category/{id} tags: - wp_pattern_category responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: patchWpV2SitesbyWpcomSiteWpPatternCategorybyId summary: PATCH /wp/v2/sites/{wpcom_site}/wp_pattern_category/{id} tags: - wp_pattern_category responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string 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: operationId: deleteWpV2SitesbyWpcomSiteWpPatternCategorybyId summary: DELETE /wp/v2/sites/{wpcom_site}/wp_pattern_category/{id} tags: - wp_pattern_category responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: id in: path required: true schema: type: string - name: force in: query required: false schema: type: boolean default: false description: Required to be true, as terms do not support trashing. components: securitySchemes: oauth2: type: oauth2 description: WordPress.com OAuth 2.1, per https://public-api.wordpress.com/.well-known/openid-configuration flows: authorizationCode: authorizationUrl: https://public-api.wordpress.com/oauth2-1/authorize tokenUrl: https://public-api.wordpress.com/oauth2-1/token refreshUrl: https://public-api.wordpress.com/oauth2-1/token scopes: global: '' auth: '' openid: '' profile: '' email: '' users: '' sites: '' posts: '' comments: '' taxonomy: '' follow: '' sharing: '' freshly-pressed: '' notifications: '' insights: '' read: '' stats: '' media: '' menus: '' batch: '' videos: '' bearerAuth: type: http scheme: bearer schemas: WPRestError: type: object description: WordPress REST API error envelope (observed on public-api.wordpress.com). properties: code: type: string example: rest_unauthorized message: type: string example: Authentication required. data: type: object properties: status: type: integer example: 401 security: - bearerAuth: []