openapi: 3.1.0 info: title: WordPress.com REST API — wpcom/v2 namespace version: v2 description: Derived by API Evangelist from the WordPress.com REST API route index published at https://public-api.wordpress.com/wpcom/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/wpcom/v2/ x-derived-by: API Evangelist enrichment pipeline servers: - url: https://public-api.wordpress.com tags: - name: a8c-lore - name: a8cmentorship - name: activity - name: activitypub - name: adflow - name: admin-bar - name: admin-color - name: admin-menu - name: agency - name: agency-client - name: agents-manager - name: ai - name: ai-agents-settings - name: ai-image - name: ai-launchpad - name: alerts - name: analytics - name: analyze-url - name: app-media - name: articles - name: atomic - name: atomic-migration-status - name: auth - name: automated-migration - name: backup - name: big-sky - name: blaze - name: block-editor - name: block-layouts - name: block-previews - name: block-recipes - name: block-renderer - name: blog-stats - name: blogging-prompts - name: blueprint-archive - name: blueprint-archive-import - name: breakingbot - name: business-hours - name: calypso-slack-channel-status - name: ceo-voice-agent - name: checkGoogleDocVisibility - name: ciab - name: cmp - name: colors - name: coming-soon - name: commercial-classification - name: common-block-layouts - name: common-starter-site-designs - name: concierge - name: content-research - name: copy-from-site - name: country-codes - name: courses - name: currency-overrides - name: dashboard - name: dashboards - name: deepl - name: dictation-client-secret - name: discount - name: do-it-for-me - name: domains - name: editor - name: editor-assets - name: email-like - name: email-preview - name: emails - name: enterpret-webhook - name: experiments - name: external-contributors - name: external-media - name: external-services - name: following - name: fsor-airtable-report - name: github - name: global-styles - name: global-styles-variation - name: glossary - name: goodreads - name: google-drive - name: grafana - name: gravatar - name: gravatar-upload - name: gutenberg - name: gutenpen - name: hello - name: help - name: home - name: host-partners - name: hosting - name: hosting-provider - name: iap - name: imports - name: individual-subscriber-stats - name: instagram - name: instagram-gallery - name: introductory-offers - name: invites - name: ip-to-geo - name: jetpack - name: jetpack-about - name: jetpack-active-connected-plugins - name: jetpack-agency - name: jetpack-ai - name: jetpack-ai-image - name: jetpack-ai-query - name: jetpack-ai-transcription - name: jetpack-boost - name: jetpack-boost-proxy - name: jetpack-clone-settings - name: jetpack-connect - name: jetpack-connection-health - name: jetpack-golden-token - name: jetpack-licensing - name: jetpack-manage - name: jetpack-marketing - name: jetpack-monitor-incidents - name: jetpack-monitor-settings - name: jetpack-monitor-status - name: jetpack-monitor-uptime - name: jetpack-openai-query - name: jetpack-package-versions - name: jetpack-partner - name: jetpack-partners - name: jetpack-pinghub - name: jetpack-product-data - name: jetpack-protect-global-stats - name: jetpack-protect-send-verification-code - name: jetpack-protect-status - name: jetpack-protect-weak-password - name: jetpack-recommendations - name: jetpack-refresh-blog-token - name: jetpack-remote-connect-user - name: jetpack-report-error - name: jetpack-search - name: jetpack-social - name: jetpack-start-webhooks - name: jetpack-stats - name: jetpack-stats-dashboard - name: jetpack-sync-actions - name: jetpack-token-health - name: jetpack-user-attributes - name: jetpack-user-tracking - name: jetpack-wpcom-user-data - name: jitm - name: jurassic-ninja - name: lasagna - name: launch - name: launch-site - name: launchpad - name: legal - name: liked-posts - name: linear-solver - name: linearmattic - name: mailchimp - name: mailpoet - name: mapbox - name: mapkit - name: marketing - name: marketplace - name: mcp-abilities - name: me - name: media - name: memberships - name: meta - name: migrate-from - name: migrate-provision - name: migration-enabled - name: migration-flow - name: migration-provider-notifications - name: migration-provider-redirect - name: migration-status - name: migrations - name: mobile - name: mobile-support - name: newsletter-categories - name: newsletter-email-sent-status - name: newspack-blocks-posts - name: newspack-blocks-specific-posts - name: newspack-gpt - name: newspack-manager - name: notifications - name: nudge - name: oauth2 - name: odie - name: odie-search - name: oembed-proxy - name: onboarding - name: onboarding-customization - name: p2 - name: pagespeed - name: partners - name: pattern-assembler - name: pending-blog-subscriptions - name: photodna - name: pigeon - name: plans - name: playground - name: plugins - name: podcast - name: podcast-distribution - name: podcast-player - name: podcast-stats - name: portfolio-dashboard-agent - name: post-comment-subscriptions - name: post-counts - name: post-types - name: posts - name: posts-to-podcast - name: presales - name: preview-links - name: pricing-dashboard - name: privacy-policy - name: private - name: private-podcasts - name: products - name: profile - name: publicize - name: push-notifications - name: read - name: reader - name: reader-chat-settings - name: recovery-mode-status - name: related-posts - name: reset-migration - name: reset-site - name: restore-site - name: rewind - name: rtc - name: rtc-notices - name: scan - name: scheduled-updates - name: search-stats - name: search-suggestions - name: seen-posts - name: segmentation-survey - name: segments - name: seller_footer - name: send - name: send-email-continue-site-build - name: send-email-preview - name: service-api-keys - name: shares-count - name: shipstation - name: simple-payments - name: site-assembler - name: site-goals - name: site-has-never-published-post - name: site-importer - name: site-intent - name: site-migration-status-sticker - name: site-owner-transfer - name: site-suggestions - name: site-type - name: site-vertical - name: slack - name: ssh-migration - name: staging-site - name: starter-designs - name: studio-app - name: subscribers - name: subscribers_by_user_type - name: support-interactions - name: supportforums - name: sync - name: tags - name: telegram-bot - name: template-loader - name: test - name: text-completion - name: theme-headstart - name: theme-setup - name: theme-support - name: themes - name: timezones - name: titan - name: top-posts - name: tortuga - name: traffic-guide-download - name: transfer - name: transients - name: trelloCallback - name: trends-agent - name: tumblr-smtp - name: twilio-notification - name: twitter - name: typekit-fonts - name: ucp - name: unauth-file-upload - name: update-schedules - name: upgrades - name: user-type - name: users - name: verticals - name: vibehost - name: videopress - name: videos - name: vip - name: vouchers - name: waf-rules - name: wc - name: wcai-pa - name: wcbazaar - name: wccom - name: webhook-airtable-create - name: whats-new - name: widget-modules - name: woo - name: woo-mobile-ai - name: woocommerce - name: wordads - name: wordcamp-coupons - name: work-with-us - name: wp-admin-sidebar - name: wpcom-v2 - name: xposts - name: zendesk - name: zendesk-notification - name: zendesk-notification-staging paths: /wpcom/v2: get: operationId: getWpcomV2 summary: GET /wpcom/v2 tags: - wpcom-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: wpcom/v2 - name: context in: query required: false schema: default: view /wpcom/v2/a8c-lore/slack/events: post: operationId: postWpcomV2A8CLoreSlackEvents summary: POST /wpcom/v2/a8c-lore/slack/events tags: - a8c-lore responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/a8c-lore/slack/interactivity: post: operationId: postWpcomV2A8CLoreSlackInteractivity summary: POST /wpcom/v2/a8c-lore/slack/interactivity tags: - a8c-lore responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/a8cmentorship/slack/interactivity: post: operationId: postWpcomV2A8CmentorshipSlackInteractivity summary: POST /wpcom/v2/a8cmentorship/slack/interactivity tags: - a8cmentorship responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/agency: get: operationId: getWpcomV2Agency summary: GET /wpcom/v2/agency tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2Agency summary: POST /wpcom/v2/agency tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: first_name: type: string last_name: type: string agency_name: type: string agency_url: type: string initial_source: type: string address_line1: type: string default: '' address_line2: type: string default: '' address_city: type: string address_state: type: string default: '' address_postal_code: type: string default: '' address_country: type: string agency_size: type: string number_sites: type: string services_offered: type: array items: type: string products_offered: type: array items: type: string products_to_offer: type: array items: type: string expansion_planned: type: string referral_url: type: string referral_status: type: string hubspotutk: type: string bypass_duplicate_check: type: boolean default: false skip_hubspot: type: boolean default: false required: - first_name - last_name - agency_name - agency_url - address_city - address_country /wpcom/v2/agency-client/agency/{agency_id}/referrals/{referral_id}: get: operationId: getWpcomV2AgencyClientAgencybyAgencyIdReferralsbyReferralId summary: GET /wpcom/v2/agency-client/agency/{agency_id}/referrals/{referral_id} tags: - agency-client responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: referral_id in: path required: true schema: type: string - name: secret in: query required: true schema: type: string post: operationId: postWpcomV2AgencyClientAgencybyAgencyIdReferralsbyReferralId summary: POST /wpcom/v2/agency-client/agency/{agency_id}/referrals/{referral_id} tags: - agency-client responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: referral_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: secret: type: string required: - secret /wpcom/v2/agency-client/license: delete: operationId: deleteWpcomV2AgencyClientLicense summary: DELETE /wpcom/v2/agency-client/license tags: - agency-client responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: args in: query required: false schema: {} /wpcom/v2/agency-client/public/pricing: get: operationId: getWpcomV2AgencyClientPublicPricing summary: GET /wpcom/v2/agency-client/public/pricing tags: - agency-client responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/agency-client/public/products: get: operationId: getWpcomV2AgencyClientPublicProducts summary: GET /wpcom/v2/agency-client/public/products tags: - agency-client responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/agency-client/referrals: get: operationId: getWpcomV2AgencyClientReferrals summary: GET /wpcom/v2/agency-client/referrals tags: - agency-client responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/agency-client/stripe/invoices: get: operationId: getWpcomV2AgencyClientStripeInvoices summary: GET /wpcom/v2/agency-client/stripe/invoices tags: - agency-client responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: status in: query required: false schema: type: string default: '' description: Set this if you want results to be filtered by their status. - name: limit in: query required: false schema: type: integer default: 24 description: The number of invoices to return. - name: starting_after in: query required: false schema: type: string description: A cursor for use in pagination. It is an object ID that defines your place in the list. - name: ending_before in: query required: false schema: type: string description: A cursor for use in pagination. It is an object ID that defines your place in the list. /wpcom/v2/agency-client/stripe/payment-method: post: operationId: postWpcomV2AgencyClientStripePaymentMethod summary: POST /wpcom/v2/agency-client/stripe/payment-method tags: - agency-client responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: payment_method_id: type: string description: The Stripe payment method ID that should be attached to the customer. use_as_primary_payment_method: type: boolean default: false description: Set this payment method as default for the customer. stripe_setup_intent_id: type: string default: '' description: The Stripe Setup Intent id for the payment method. required: - payment_method_id delete: operationId: deleteWpcomV2AgencyClientStripePaymentMethod summary: DELETE /wpcom/v2/agency-client/stripe/payment-method tags: - agency-client responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: payment_method_id in: query required: true schema: type: string description: The Stripe payment method ID that should be detached. - name: primary_payment_method_id in: query required: false schema: type: string description: The Stripe payment method ID that should be set as a primary. /wpcom/v2/agency-client/stripe/payment-methods: get: operationId: getWpcomV2AgencyClientStripePaymentMethods summary: GET /wpcom/v2/agency-client/stripe/payment-methods tags: - agency-client responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: starting_after in: query required: false schema: type: string description: A cursor for use in pagination. It is an object ID that defines your place in the list. - name: ending_before in: query required: false schema: type: string description: A cursor for use in pagination. It is an object ID that defines your place in the list. /wpcom/v2/agency/blog/{blog_id}: get: operationId: getWpcomV2AgencyBlogbyBlogId summary: GET /wpcom/v2/agency/blog/{blog_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: blog_id in: path required: true schema: type: string /wpcom/v2/agency/embeds/tipalti: get: operationId: getWpcomV2AgencyEmbedsTipalti summary: GET /wpcom/v2/agency/embeds/tipalti tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: query required: true schema: type: integer /wpcom/v2/agency/exists/name: get: operationId: getWpcomV2AgencyExistsName summary: GET /wpcom/v2/agency/exists/name tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: value in: query required: true schema: type: string /wpcom/v2/agency/exists/url: get: operationId: getWpcomV2AgencyExistsUrl summary: GET /wpcom/v2/agency/exists/url tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: value in: query required: true schema: type: string /wpcom/v2/agency/help/pressable/support: post: operationId: postWpcomV2AgencyHelpPressableSupport summary: POST /wpcom/v2/agency/help/pressable/support tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: name: type: string email: type: string site: type: string contact_type: type: string pressable_id: type: string message: type: string required: - name - email - contact_type - message /wpcom/v2/agency/help/zendesk/create-ticket: post: operationId: postWpcomV2AgencyHelpZendeskCreateTicket summary: POST /wpcom/v2/agency/help/zendesk/create-ticket tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: name: type: string email: type: string product: type: string message: type: string tags: type: array items: type: string required: - name - email - product - message /wpcom/v2/agency/hire-an-expert: post: operationId: postWpcomV2AgencyHireAnExpert summary: POST /wpcom/v2/agency/hire-an-expert tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: full_name: type: string email: type: string company_name: type: string url: type: string business_description: type: string project_goal: type: string project_description: type: string timeline: type: string budget: type: string business_unit: type: string required: - full_name - email /wpcom/v2/agency/hubspot/webhook: post: operationId: postWpcomV2AgencyHubspotWebhook summary: POST /wpcom/v2/agency/hubspot/webhook tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/agency/lead-matching/client: post: operationId: postWpcomV2AgencyLeadMatchingClient summary: POST /wpcom/v2/agency/lead-matching/client tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/agency/license: delete: operationId: deleteWpcomV2AgencyLicense summary: DELETE /wpcom/v2/agency/license tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: args in: query required: false schema: {} /wpcom/v2/agency/license/dev-site: get: operationId: getWpcomV2AgencyLicenseDevSite summary: GET /wpcom/v2/agency/license/dev-site tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: args in: query required: false schema: {} /wpcom/v2/agency/partner-directory: get: operationId: getWpcomV2AgencyPartnerDirectory summary: GET /wpcom/v2/agency/partner-directory tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_directory in: query required: false schema: type: string /wpcom/v2/agency/partner-directory/form-submission: post: operationId: postWpcomV2AgencyPartnerDirectoryFormSubmission summary: POST /wpcom/v2/agency/partner-directory/form-submission tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: agency_id: type: string agency_email: type: string full_name: type: string email: type: string business_name: type: string project_description: type: string project_type: type: string url: type: string budget: type: string required: - agency_id - agency_email - full_name - email - business_name - project_type - budget /wpcom/v2/agency/partner-directory/{agency_id}: get: operationId: getWpcomV2AgencyPartnerDirectorybyAgencyId summary: GET /wpcom/v2/agency/partner-directory/{agency_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string /wpcom/v2/agency/pressable/new-account: post: operationId: postWpcomV2AgencyPressableNewAccount summary: POST /wpcom/v2/agency/pressable/new-account tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: email: type: string chargify_id: type: integer pressable_id: type: integer required: - email - chargify_id /wpcom/v2/agency/pressable/premium-plan-referral: post: operationId: postWpcomV2AgencyPressablePremiumPlanReferral summary: POST /wpcom/v2/agency/pressable/premium-plan-referral tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: agency_id: type: integer company_name: type: string address: type: string country_code: type: string state: type: string city: type: string zip: type: string first_name: type: string last_name: type: string title: type: string phone: type: string email: type: string website: type: string opportunity_description: type: string required: - agency_id - company_name - address - country_code - city - zip - first_name - last_name - title - email - website - opportunity_description /wpcom/v2/agency/products: get: operationId: getWpcomV2AgencyProducts summary: GET /wpcom/v2/agency/products tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/agency/resources: get: operationId: getWpcomV2AgencyResources summary: GET /wpcom/v2/agency/resources tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/agency/resources/record-event: post: operationId: postWpcomV2AgencyResourcesRecordEvent summary: POST /wpcom/v2/agency/resources/record-event tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: agency_id: type: integer description: The agency ID. resource_id: type: string resource_name: type: string required: - agency_id - resource_id - resource_name /wpcom/v2/agency/signup: post: operationId: postWpcomV2AgencySignup summary: POST /wpcom/v2/agency/signup tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: first_name: type: string last_name: type: string email: type: string agency_name: type: string agency_url: type: string initial_source: type: string address_line1: type: string default: '' address_line2: type: string default: '' address_city: type: string default: '' address_state: type: string default: '' address_postal_code: type: string default: '' address_country: type: string agency_size: type: string number_sites: type: string services_offered: type: array items: type: string products_offered: type: array items: type: string products_to_offer: type: array items: type: string expansion_planned: type: string referral_url: type: string referral_status: type: string top_partnering_goal: type: string top_yearly_goal: type: string work_with_clients: type: string work_with_clients_other: type: string default: '' approach_and_challenges: type: string default: '' required: - first_name - last_name - email - agency_name - agency_url - address_country /wpcom/v2/agency/signup-context: get: operationId: getWpcomV2AgencySignupContext summary: GET /wpcom/v2/agency/signup-context tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/agency/signup/contact-support: post: operationId: postWpcomV2AgencySignupContactSupport summary: POST /wpcom/v2/agency/signup/contact-support tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: name: type: string email: type: string message: type: string signup_agency_name: type: string signup_agency_url: type: string tags: type: array items: type: string required: - name - email - message /wpcom/v2/agency/user-feedback: post: operationId: postWpcomV2AgencyUserFeedback summary: POST /wpcom/v2/agency/user-feedback tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: source_url: type: string rating: type: integer feedback: type: string required: - source_url - rating - feedback /wpcom/v2/agency/validate/{field}: get: operationId: getWpcomV2AgencyValidatebyField summary: GET /wpcom/v2/agency/validate/{field} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: field in: path required: true schema: type: string - name: value in: query required: true schema: type: string /wpcom/v2/agency/vip/partner-opportunity: post: operationId: postWpcomV2AgencyVipPartnerOpportunity summary: POST /wpcom/v2/agency/vip/partner-opportunity tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: agency_id: type: integer company_name: type: string address: type: string country_code: type: string state: type: string city: type: string zip: type: string first_name: type: string last_name: type: string title: type: string phone: type: string email: type: string website: type: string opportunity_description: type: string lead_type: type: string is_rfp: type: boolean required: - agency_id - company_name - address - country_code - city - zip - first_name - last_name - title - email - website - opportunity_description - lead_type - is_rfp /wpcom/v2/agency/{agency_id}: put: operationId: putWpcomV2AgencybyAgencyId summary: PUT /wpcom/v2/agency/{agency_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: agency_name: type: string agency_url: type: string address_line1: type: string address_line2: type: string address_city: type: string address_state: type: string address_postal_code: type: string address_country: type: string /wpcom/v2/agency/{agency_id}/a4a-mcp/settings: get: operationId: getWpcomV2AgencybyAgencyIdA4AMcpSettings summary: GET /wpcom/v2/agency/{agency_id}/a4a-mcp/settings tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string post: operationId: postWpcomV2AgencybyAgencyIdA4AMcpSettings summary: POST /wpcom/v2/agency/{agency_id}/a4a-mcp/settings tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: enabled: type: boolean abilities: type: object /wpcom/v2/agency/{agency_id}/a4a/collateral/{post_id}: get: operationId: getWpcomV2AgencybyAgencyIdA4ACollateralbyPostId summary: GET /wpcom/v2/agency/{agency_id}/a4a/collateral/{post_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: post_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/a4a/collateral/{post_id}/html: get: operationId: getWpcomV2AgencybyAgencyIdA4ACollateralbyPostIdHtml summary: GET /wpcom/v2/agency/{agency_id}/a4a/collateral/{post_id}/html tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: post_id in: path required: true schema: type: string - name: variant in: query required: true schema: type: string - name: sig in: query required: true schema: type: string - name: layout in: query required: false schema: type: string enum: - document - filmstrip - name: pages in: query required: false schema: type: integer /wpcom/v2/agency/{agency_id}/a4a/collateral/{post_id}/pdf: get: operationId: getWpcomV2AgencybyAgencyIdA4ACollateralbyPostIdPdf summary: GET /wpcom/v2/agency/{agency_id}/a4a/collateral/{post_id}/pdf tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: post_id in: path required: true schema: type: string - name: variant in: query required: true schema: type: string - name: sig in: query required: true schema: type: string /wpcom/v2/agency/{agency_id}/a4a/collateral/{post_id}/social/{direction_id}/{size}/png: post: operationId: postWpcomV2AgencybyAgencyIdA4ACollateralbyPostIdSocialbyDirectionIdbySizePng summary: POST /wpcom/v2/agency/{agency_id}/a4a/collateral/{post_id}/social/{direction_id}/{size}/png tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: post_id in: path required: true schema: type: string - name: direction_id in: path required: true schema: type: string - name: size in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: html: type: string width: type: integer height: type: integer required: - html - width - height /wpcom/v2/agency/{agency_id}/a4a/collaterals/{collateral_id}/refine: post: operationId: postWpcomV2AgencybyAgencyIdA4ACollateralsbyCollateralIdRefine summary: POST /wpcom/v2/agency/{agency_id}/a4a/collaterals/{collateral_id}/refine tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: collateral_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: instruction: type: string required: - instruction /wpcom/v2/agency/{agency_id}/a4a/outputs: get: operationId: getWpcomV2AgencybyAgencyIdA4AOutputs summary: GET /wpcom/v2/agency/{agency_id}/a4a/outputs tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/a4a/projects: get: operationId: getWpcomV2AgencybyAgencyIdA4AProjects summary: GET /wpcom/v2/agency/{agency_id}/a4a/projects tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string post: operationId: postWpcomV2AgencybyAgencyIdA4AProjects summary: POST /wpcom/v2/agency/{agency_id}/a4a/projects tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: name: type: string clientName: type: string brief: type: string required: - name /wpcom/v2/agency/{agency_id}/a4a/projects/{project_id}: get: operationId: getWpcomV2AgencybyAgencyIdA4AProjectsbyProjectId summary: GET /wpcom/v2/agency/{agency_id}/a4a/projects/{project_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: project_id in: path required: true schema: type: string delete: operationId: deleteWpcomV2AgencybyAgencyIdA4AProjectsbyProjectId summary: DELETE /wpcom/v2/agency/{agency_id}/a4a/projects/{project_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: project_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/a4a/projects/{project_id}/outputs: get: operationId: getWpcomV2AgencybyAgencyIdA4AProjectsbyProjectIdOutputs summary: GET /wpcom/v2/agency/{agency_id}/a4a/projects/{project_id}/outputs tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: project_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/a4a/runs: post: operationId: postWpcomV2AgencybyAgencyIdA4ARuns summary: POST /wpcom/v2/agency/{agency_id}/a4a/runs tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: recipe: type: string input: type: object default: {} required: - recipe /wpcom/v2/agency/{agency_id}/a4a/runs/{run_id}: get: operationId: getWpcomV2AgencybyAgencyIdA4ARunsbyRunId summary: GET /wpcom/v2/agency/{agency_id}/a4a/runs/{run_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: run_id in: path required: true schema: type: string delete: operationId: deleteWpcomV2AgencybyAgencyIdA4ARunsbyRunId summary: DELETE /wpcom/v2/agency/{agency_id}/a4a/runs/{run_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: run_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/amplify/reports: post: operationId: postWpcomV2AgencybyAgencyIdAmplifyReports summary: POST /wpcom/v2/agency/{agency_id}/amplify/reports tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: url: type: string mode: type: string required: - url - mode get: operationId: getWpcomV2AgencybyAgencyIdAmplifyReports summary: GET /wpcom/v2/agency/{agency_id}/amplify/reports tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: page in: query required: false schema: type: integer default: 1 - name: per_page in: query required: false schema: type: integer default: 20 /wpcom/v2/agency/{agency_id}/amplify/reports/{report_id}: get: operationId: getWpcomV2AgencybyAgencyIdAmplifyReportsbyReportId summary: GET /wpcom/v2/agency/{agency_id}/amplify/reports/{report_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: report_id in: path required: true schema: type: string post: operationId: postWpcomV2AgencybyAgencyIdAmplifyReportsbyReportId summary: POST /wpcom/v2/agency/{agency_id}/amplify/reports/{report_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: report_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: archived: type: boolean required: - archived put: operationId: putWpcomV2AgencybyAgencyIdAmplifyReportsbyReportId summary: PUT /wpcom/v2/agency/{agency_id}/amplify/reports/{report_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: report_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: archived: type: boolean required: - archived patch: operationId: patchWpcomV2AgencybyAgencyIdAmplifyReportsbyReportId summary: PATCH /wpcom/v2/agency/{agency_id}/amplify/reports/{report_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: report_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: archived: type: boolean required: - archived /wpcom/v2/agency/{agency_id}/benchmarks: get: operationId: getWpcomV2AgencybyAgencyIdBenchmarks summary: GET /wpcom/v2/agency/{agency_id}/benchmarks tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string post: operationId: postWpcomV2AgencybyAgencyIdBenchmarks summary: POST /wpcom/v2/agency/{agency_id}/benchmarks tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: quarter: type: integer year: type: integer gross_margin: type: number billable_utilization: type: number avg_project_size_usd: type: number win_rate: type: number retainer_mrr_usd: type: number avg_time_to_close_days: type: integer client_retention: type: number ai_work_involvement: type: number ai_revenue_percentage: type: number ai_productivity_lift: type: number team_ai_training_percentage: type: number governance_maturity: type: string enum: - none - informal_guidelines - documented_policy - policy_client_contracts_updated - full_governance_program_with_audits stakeholder_demand: type: string enum: - no_client_demand_yet - occasional_asks - frequent_asks - majority_of_new_work - all_new_work_is_ai_related ai_tools_used: type: array default: [] items: type: string ai_use_cases: type: array default: [] items: type: string required: - quarter - year - gross_margin - billable_utilization - avg_project_size_usd - win_rate - retainer_mrr_usd - avg_time_to_close_days - client_retention - ai_work_involvement - ai_revenue_percentage - ai_productivity_lift - team_ai_training_percentage - governance_maturity - stakeholder_demand /wpcom/v2/agency/{agency_id}/benchmarks/aggregates: get: operationId: getWpcomV2AgencybyAgencyIdBenchmarksAggregates summary: GET /wpcom/v2/agency/{agency_id}/benchmarks/aggregates tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: quarter in: query required: false schema: type: integer - name: year in: query required: false schema: type: integer /wpcom/v2/agency/{agency_id}/benchmarks/config: get: operationId: getWpcomV2AgencybyAgencyIdBenchmarksConfig summary: GET /wpcom/v2/agency/{agency_id}/benchmarks/config tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/benchmarks/peers: get: operationId: getWpcomV2AgencybyAgencyIdBenchmarksPeers summary: GET /wpcom/v2/agency/{agency_id}/benchmarks/peers tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: quarter in: query required: true schema: type: integer - name: year in: query required: true schema: type: integer /wpcom/v2/agency/{agency_id}/benchmarks/{quarter}/{year}: get: operationId: getWpcomV2AgencybyAgencyIdBenchmarksbyQuarterbyYear summary: GET /wpcom/v2/agency/{agency_id}/benchmarks/{quarter}/{year} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: quarter in: path required: true schema: type: string - name: year in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/clients: get: operationId: getWpcomV2AgencybyAgencyIdClients summary: GET /wpcom/v2/agency/{agency_id}/clients tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string post: operationId: postWpcomV2AgencybyAgencyIdClients summary: POST /wpcom/v2/agency/{agency_id}/clients tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: email: type: string required: - email /wpcom/v2/agency/{agency_id}/clients/{client_id}: get: operationId: getWpcomV2AgencybyAgencyIdClientsbyClientId summary: GET /wpcom/v2/agency/{agency_id}/clients/{client_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: client_id in: path required: true schema: type: string put: operationId: putWpcomV2AgencybyAgencyIdClientsbyClientId summary: PUT /wpcom/v2/agency/{agency_id}/clients/{client_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: client_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: email: type: string required: - email delete: operationId: deleteWpcomV2AgencybyAgencyIdClientsbyClientId summary: DELETE /wpcom/v2/agency/{agency_id}/clients/{client_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: client_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/lead-matching: get: operationId: getWpcomV2AgencybyAgencyIdLeadMatching summary: GET /wpcom/v2/agency/{agency_id}/lead-matching tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string put: operationId: putWpcomV2AgencybyAgencyIdLeadMatching summary: PUT /wpcom/v2/agency/{agency_id}/lead-matching tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/media: post: operationId: postWpcomV2AgencybyAgencyIdMedia summary: POST /wpcom/v2/agency/{agency_id}/media tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: asset_type: type: string enum: - partner_directory_logo - agent_media required: - asset_type /wpcom/v2/agency/{agency_id}/profile: put: operationId: putWpcomV2AgencybyAgencyIdProfile summary: PUT /wpcom/v2/agency/{agency_id}/profile tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: profile_company_name: type: string profile_company_email: type: string format: email profile_company_website: type: string format: uri profile_company_bio_description: type: string profile_company_logo_url: type: string format: uri profile_company_country: type: string profile_company_landing_page_url: type: string format: uri profile_listing_industries: type: array items: {} profile_listing_is_available: type: string profile_listing_is_global: type: string profile_listing_services: type: array items: {} profile_listing_products: type: array items: {} profile_listing_languages_spoken: type: array items: {} profile_budget_budget_lower_range: {} profile_budget_budget_upper_range: {} /wpcom/v2/agency/{agency_id}/profile/application: put: operationId: putWpcomV2AgencybyAgencyIdProfileApplication summary: PUT /wpcom/v2/agency/{agency_id}/profile/application tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: services: type: array items: {} products: type: array items: {} directories: type: array items: {} feedback_url: type: string is_published: type: boolean /wpcom/v2/agency/{agency_id}/referral-email-preview: post: operationId: postWpcomV2AgencybyAgencyIdReferralEmailPreview summary: POST /wpcom/v2/agency/{agency_id}/referral-email-preview tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: product_ids: type: array items: type: integer greeting_line: type: string logo_url: type: string term_pricing: type: string enum: - monthly - yearly default: yearly required: - product_ids /wpcom/v2/agency/{agency_id}/referrals: get: operationId: getWpcomV2AgencybyAgencyIdReferrals summary: GET /wpcom/v2/agency/{agency_id}/referrals tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string post: operationId: postWpcomV2AgencybyAgencyIdReferrals summary: POST /wpcom/v2/agency/{agency_id}/referrals tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: client_email: type: string client_message: type: string flow_type: type: string enum: - send - copy logo: type: object product_ids: type: array items: type: integer licenses: type: array items: type: object required: - client_email - product_ids /wpcom/v2/agency/{agency_id}/referrals/commission-payout: get: operationId: getWpcomV2AgencybyAgencyIdReferralsCommissionPayout summary: GET /wpcom/v2/agency/{agency_id}/referrals/commission-payout tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/referrals/invoices: get: operationId: getWpcomV2AgencybyAgencyIdReferralsInvoices summary: GET /wpcom/v2/agency/{agency_id}/referrals/invoices tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/referrals/{referral_id}: get: operationId: getWpcomV2AgencybyAgencyIdReferralsbyReferralId summary: GET /wpcom/v2/agency/{agency_id}/referrals/{referral_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: referral_id in: path required: true schema: type: string delete: operationId: deleteWpcomV2AgencybyAgencyIdReferralsbyReferralId summary: DELETE /wpcom/v2/agency/{agency_id}/referrals/{referral_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: referral_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/referrals/{referral_id}/archive: post: operationId: postWpcomV2AgencybyAgencyIdReferralsbyReferralIdArchive summary: POST /wpcom/v2/agency/{agency_id}/referrals/{referral_id}/archive tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: referral_id in: path required: true schema: type: string put: operationId: putWpcomV2AgencybyAgencyIdReferralsbyReferralIdArchive summary: PUT /wpcom/v2/agency/{agency_id}/referrals/{referral_id}/archive tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: referral_id in: path required: true schema: type: string patch: operationId: patchWpcomV2AgencybyAgencyIdReferralsbyReferralIdArchive summary: PATCH /wpcom/v2/agency/{agency_id}/referrals/{referral_id}/archive tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: referral_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/referrals/{referral_id}/resend: post: operationId: postWpcomV2AgencybyAgencyIdReferralsbyReferralIdResend summary: POST /wpcom/v2/agency/{agency_id}/referrals/{referral_id}/resend tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: referral_id in: path required: true schema: type: string put: operationId: putWpcomV2AgencybyAgencyIdReferralsbyReferralIdResend summary: PUT /wpcom/v2/agency/{agency_id}/referrals/{referral_id}/resend tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: referral_id in: path required: true schema: type: string patch: operationId: patchWpcomV2AgencybyAgencyIdReferralsbyReferralIdResend summary: PATCH /wpcom/v2/agency/{agency_id}/referrals/{referral_id}/resend tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: referral_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/reports: get: operationId: getWpcomV2AgencybyAgencyIdReports summary: GET /wpcom/v2/agency/{agency_id}/reports tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string post: operationId: postWpcomV2AgencybyAgencyIdReports summary: POST /wpcom/v2/agency/{agency_id}/reports tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: managed_site_id: type: integer timeframe: type: string enum: - 7_days - 30_days - 24_hours - custom start_date: type: string format: date end_date: type: string format: date client_emails: type: array items: type: string teammate_emails: type: array items: type: string send_copy_to_team: type: boolean default: false send_me_a_copy: type: boolean default: false custom_intro_text: type: string stats_items: type: object required: - managed_site_id - timeframe /wpcom/v2/agency/{agency_id}/reports/{report_id}: get: operationId: getWpcomV2AgencybyAgencyIdReportsbyReportId summary: GET /wpcom/v2/agency/{agency_id}/reports/{report_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: report_id in: path required: true schema: type: string delete: operationId: deleteWpcomV2AgencybyAgencyIdReportsbyReportId summary: DELETE /wpcom/v2/agency/{agency_id}/reports/{report_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: report_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/reports/{report_id}/send: post: operationId: postWpcomV2AgencybyAgencyIdReportsbyReportIdSend summary: POST /wpcom/v2/agency/{agency_id}/reports/{report_id}/send tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: report_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: preview: type: boolean default: false /wpcom/v2/agency/{agency_id}/schedule-call-link: get: operationId: getWpcomV2AgencybyAgencyIdScheduleCallLink summary: GET /wpcom/v2/agency/{agency_id}/schedule-call-link tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/sites: get: operationId: getWpcomV2AgencybyAgencyIdSites summary: GET /wpcom/v2/agency/{agency_id}/sites tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: filters in: query required: false schema: type: object default: [] description: Filters to apply to the sites list post: operationId: postWpcomV2AgencybyAgencyIdSites summary: POST /wpcom/v2/agency/{agency_id}/sites tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: blog_id: type: integer url: type: string title: type: string /wpcom/v2/agency/{agency_id}/sites/pending: get: operationId: getWpcomV2AgencybyAgencyIdSitesPending summary: GET /wpcom/v2/agency/{agency_id}/sites/pending tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/sites/provision-dev-site: post: operationId: postWpcomV2AgencybyAgencyIdSitesProvisionDevSite summary: POST /wpcom/v2/agency/{agency_id}/sites/provision-dev-site tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: site_name: type: string description: The site name. php_version: type: string description: The PHP version. primary_data_center: type: string description: The primary data center. is_fully_managed_agency_site: type: boolean description: Whether the site is fully managed by the agency. /wpcom/v2/agency/{agency_id}/sites/tag-for-commission: put: operationId: putWpcomV2AgencybyAgencyIdSitesTagForCommission summary: PUT /wpcom/v2/agency/{agency_id}/sites/tag-for-commission tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: site_ids: type: array items: type: integer tags: type: array items: type: string migration_source_host: type: string required: - site_ids - tags - migration_source_host /wpcom/v2/agency/{agency_id}/sites/tags: put: operationId: putWpcomV2AgencybyAgencyIdSitesTags summary: PUT /wpcom/v2/agency/{agency_id}/sites/tags tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: site_ids: type: array items: type: integer tags: type: array items: type: string required: - site_ids - tags /wpcom/v2/agency/{agency_id}/sites/{jetpack_site_id}/monitor: put: operationId: putWpcomV2AgencybyAgencyIdSitesbyJetpackSiteIdMonitor summary: PUT /wpcom/v2/agency/{agency_id}/sites/{jetpack_site_id}/monitor tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: jetpack_site_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: monitor_active: type: boolean required: - monitor_active /wpcom/v2/agency/{agency_id}/sites/{site_id}: put: operationId: putWpcomV2AgencybyAgencyIdSitesbySiteId summary: PUT /wpcom/v2/agency/{agency_id}/sites/{site_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: site_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: title: type: string delete: operationId: deleteWpcomV2AgencybyAgencyIdSitesbySiteId summary: DELETE /wpcom/v2/agency/{agency_id}/sites/{site_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: site_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/sites/{site_id}/delete-dev-site: delete: operationId: deleteWpcomV2AgencybyAgencyIdSitesbySiteIdDeleteDevSite summary: DELETE /wpcom/v2/agency/{agency_id}/sites/{site_id}/delete-dev-site tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: site_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/sites/{site_id}/notes: get: operationId: getWpcomV2AgencybyAgencyIdSitesbySiteIdNotes summary: GET /wpcom/v2/agency/{agency_id}/sites/{site_id}/notes tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: site_id in: path required: true schema: type: string post: operationId: postWpcomV2AgencybyAgencyIdSitesbySiteIdNotes summary: POST /wpcom/v2/agency/{agency_id}/sites/{site_id}/notes tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: site_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: content: type: string required: - content /wpcom/v2/agency/{agency_id}/sites/{site_id}/notes/{note_id}: put: operationId: putWpcomV2AgencybyAgencyIdSitesbySiteIdNotesbyNoteId summary: PUT /wpcom/v2/agency/{agency_id}/sites/{site_id}/notes/{note_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: site_id in: path required: true schema: type: string - name: note_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: content: type: string required: - content delete: operationId: deleteWpcomV2AgencybyAgencyIdSitesbySiteIdNotesbyNoteId summary: DELETE /wpcom/v2/agency/{agency_id}/sites/{site_id}/notes/{note_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: site_id in: path required: true schema: type: string - name: note_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/sites/{site_id}/provision: post: operationId: postWpcomV2AgencybyAgencyIdSitesbySiteIdProvision summary: POST /wpcom/v2/agency/{agency_id}/sites/{site_id}/provision tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: site_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: site_name: type: string description: The site name. php_version: type: string description: The PHP version. primary_data_center: type: string description: The primary data center. is_fully_managed_agency_site: type: boolean description: Whether the site is fully managed by the agency. /wpcom/v2/agency/{agency_id}/sites/{site_id}/request-migration-reverification: post: operationId: postWpcomV2AgencybyAgencyIdSitesbySiteIdRequestMigrationReverification summary: POST /wpcom/v2/agency/{agency_id}/sites/{site_id}/request-migration-reverification tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: site_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: reason: type: string description: The reason for requesting re-verification and why the site should be re-evaluated for commission eligibility. required: - reason /wpcom/v2/agency/{agency_id}/sites/{site_id}/tags: get: operationId: getWpcomV2AgencybyAgencyIdSitesbySiteIdTags summary: GET /wpcom/v2/agency/{agency_id}/sites/{site_id}/tags tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: site_id in: path required: true schema: type: string put: operationId: putWpcomV2AgencybyAgencyIdSitesbySiteIdTags summary: PUT /wpcom/v2/agency/{agency_id}/sites/{site_id}/tags tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: site_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: tags: type: array items: type: string required: - tags /wpcom/v2/agency/{agency_id}/tipalti: get: operationId: getWpcomV2AgencybyAgencyIdTipalti summary: GET /wpcom/v2/agency/{agency_id}/tipalti tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/transfer-ownership: post: operationId: postWpcomV2AgencybyAgencyIdTransferOwnership summary: POST /wpcom/v2/agency/{agency_id}/transfer-ownership tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: new_owner_id: type: integer required: - new_owner_id put: operationId: putWpcomV2AgencybyAgencyIdTransferOwnership summary: PUT /wpcom/v2/agency/{agency_id}/transfer-ownership tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: new_owner_id: type: integer required: - new_owner_id patch: operationId: patchWpcomV2AgencybyAgencyIdTransferOwnership summary: PATCH /wpcom/v2/agency/{agency_id}/transfer-ownership tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: new_owner_id: type: integer required: - new_owner_id /wpcom/v2/agency/{agency_id}/user-invites: get: operationId: getWpcomV2AgencybyAgencyIdUserInvites summary: GET /wpcom/v2/agency/{agency_id}/user-invites tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string post: operationId: postWpcomV2AgencybyAgencyIdUserInvites summary: POST /wpcom/v2/agency/{agency_id}/user-invites tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: login: type: string message: type: string required: - login /wpcom/v2/agency/{agency_id}/user-invites/{invite_id}: get: operationId: getWpcomV2AgencybyAgencyIdUserInvitesbyInviteId summary: GET /wpcom/v2/agency/{agency_id}/user-invites/{invite_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: invite_id in: path required: true schema: type: string post: operationId: postWpcomV2AgencybyAgencyIdUserInvitesbyInviteId summary: POST /wpcom/v2/agency/{agency_id}/user-invites/{invite_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: invite_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: secret: type: string required: - secret delete: operationId: deleteWpcomV2AgencybyAgencyIdUserInvitesbyInviteId summary: DELETE /wpcom/v2/agency/{agency_id}/user-invites/{invite_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: invite_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/user-invites/{invite_id}/resend: post: operationId: postWpcomV2AgencybyAgencyIdUserInvitesbyInviteIdResend summary: POST /wpcom/v2/agency/{agency_id}/user-invites/{invite_id}/resend tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: invite_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/users: get: operationId: getWpcomV2AgencybyAgencyIdUsers summary: GET /wpcom/v2/agency/{agency_id}/users tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/users/{user_id}: delete: operationId: deleteWpcomV2AgencybyAgencyIdUsersbyUserId summary: DELETE /wpcom/v2/agency/{agency_id}/users/{user_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: user_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/validate-site-address: post: operationId: postWpcomV2AgencybyAgencyIdValidateSiteAddress summary: POST /wpcom/v2/agency/{agency_id}/validate-site-address tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: site_name: type: string description: The site name. required: - site_name /wpcom/v2/agency/{agency_id}/woocommerce/woopayments: get: operationId: getWpcomV2AgencybyAgencyIdWoocommerceWoopayments summary: GET /wpcom/v2/agency/{agency_id}/woocommerce/woopayments tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string /wpcom/v2/agency/{agency_id}/woocommerce/woopayments/{blog_id}: get: operationId: getWpcomV2AgencybyAgencyIdWoocommerceWoopaymentsbyBlogId summary: GET /wpcom/v2/agency/{agency_id}/woocommerce/woopayments/{blog_id} tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agency_id in: path required: true schema: type: string - name: blog_id in: path required: true schema: type: string - name: format in: query required: false schema: type: string enum: - json - csv default: json /wpcom/v2/agency/{customer_uid}/pressable/event: post: operationId: postWpcomV2AgencybyCustomerUidPressableEvent summary: POST /wpcom/v2/agency/{customer_uid}/pressable/event tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: customer_uid in: path required: true schema: type: string /wpcom/v2/agency/{customer_uid}/pressable/mrr: get: operationId: getWpcomV2AgencybyCustomerUidPressableMrr summary: GET /wpcom/v2/agency/{customer_uid}/pressable/mrr tags: - agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: customer_uid in: path required: true schema: type: string /wpcom/v2/agents-manager/state: get: operationId: getWpcomV2AgentsManagerState summary: GET /wpcom/v2/agents-manager/state tags: - agents-manager responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: key in: query required: false schema: type: string enum: - agents_manager_open - agents_manager_docked - agents_manager_minimized - agents_manager_floating_position - agents_manager_router_history - agents_manager_last_activity - unified_ai_chat description: A specific preference key to retrieve. Must be one of the allowed Agents Manager keys. post: operationId: postWpcomV2AgentsManagerState summary: POST /wpcom/v2/agents-manager/state tags: - agents-manager responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: state: type: object description: Agents Manager state to update. Only allowed keys will be processed. required: - state put: operationId: putWpcomV2AgentsManagerState summary: PUT /wpcom/v2/agents-manager/state tags: - agents-manager responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: state: type: object description: Agents Manager state to update. Only allowed keys will be processed. required: - state patch: operationId: patchWpcomV2AgentsManagerState summary: PATCH /wpcom/v2/agents-manager/state tags: - agents-manager responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: state: type: object description: Agents Manager state to update. Only allowed keys will be processed. required: - state /wpcom/v2/ai/agent/{agent_id}: post: operationId: postWpcomV2AiAgentbyAgentId summary: POST /wpcom/v2/ai/agent/{agent_id} tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agent_id in: path required: true schema: type: string /wpcom/v2/ai/agent/{agent_id}/sites: get: operationId: getWpcomV2AiAgentbyAgentIdSites summary: GET /wpcom/v2/ai/agent/{agent_id}/sites tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: agent_id in: path required: true schema: type: string /wpcom/v2/ai/bots: get: operationId: getWpcomV2AiBots summary: GET /wpcom/v2/ai/bots tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: product in: query required: false schema: type: string enum: - akismet - automattic - beeper - ciab - cloudup - crowdsignal - dayone - gravatar - happytools - intensedebate - jetpack - longreads - mailpoet - newspack - parsely - pocketcasts - p2 - sensei - simplenote - template - texts - tumblr - vip - woo - wordpressjobmanager - wpcom description: Return only bots belonging to this product. - name: search in: query required: false schema: type: string description: Return only bots whose slug or description contains this substring (case-insensitive). - name: include_archived in: query required: false schema: type: boolean default: false description: Include archived versions, and bots whose only versions are archived. post: operationId: postWpcomV2AiBots summary: POST /wpcom/v2/ai/bots tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: yaml: type: string description: The bot YAML configuration; its shape determines the bot type. description: type: string description: Human-readable description of the bot. product: type: string enum: - akismet - automattic - beeper - ciab - cloudup - crowdsignal - dayone - gravatar - happytools - intensedebate - jetpack - longreads - mailpoet - newspack - parsely - pocketcasts - p2 - sensei - simplenote - template - texts - tumblr - vip - woo - wordpressjobmanager - wpcom description: Product the bot belongs to. slug_suffix: type: string description: Trailing part of the slug; the full slug is composed as {product}-{type}-{suffix}. status: type: string enum: - draft - active - abtest description: Status of the initial version. team: type: string description: Owning team. visibility: type: string enum: - all-users - logged-in-users - paid-users - internal-users description: Who may access the bot. p2_link: type: string description: Optional link to a P2 discussing the bot. reason: type: string description: Optional reason recorded in the audit trail. required: - yaml - description - product - slug_suffix - status - team - visibility /wpcom/v2/ai/bots/{slug}: get: operationId: getWpcomV2AiBotsbySlug summary: GET /wpcom/v2/ai/bots/{slug} tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: slug in: path required: true schema: type: string - name: version in: query required: false schema: type: string description: Specific version to fetch. Omit for the bot's default version — the version the bot loads when run (on a live bot, its active version). /wpcom/v2/ai/bots/{slug}/versions: get: operationId: getWpcomV2AiBotsbySlugVersions summary: GET /wpcom/v2/ai/bots/{slug}/versions tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: slug in: path required: true schema: type: string - name: include_archived in: query required: false schema: type: boolean default: false description: Include archived versions in the response. post: operationId: postWpcomV2AiBotsbySlugVersions summary: POST /wpcom/v2/ai/bots/{slug}/versions tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: slug in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: yaml: type: string description: The new version's YAML configuration. new_version: type: string description: New version number, e.g. 2.0 or 1.3.1. description: type: string description: Human-readable description of this version. status: type: string enum: - draft - active - abtest description: Status to create the version with. team: type: string description: Owning team. p2_link: type: string description: Optional link to a P2 discussing this version. reason: type: string description: Optional reason recorded in the audit trail. required: - yaml - new_version - description - status - team /wpcom/v2/ai/bots/{slug}/versions/{version}: get: operationId: getWpcomV2AiBotsbySlugVersionsbyVersion summary: GET /wpcom/v2/ai/bots/{slug}/versions/{version} tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: slug in: path required: true schema: type: string - name: version in: path required: true schema: type: string /wpcom/v2/ai/bots/{slug}/versions/{version}/status: post: operationId: postWpcomV2AiBotsbySlugVersionsbyVersionStatus summary: POST /wpcom/v2/ai/bots/{slug}/versions/{version}/status tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: slug in: path required: true schema: type: string - name: version in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: new_status: type: string enum: - draft - active - abtest - archived description: 'Target status: draft, active, abtest, or archived.' reason: type: string description: Why the status is changing; recorded in the audit trail. p2_link: type: string description: Optional link to a P2 discussing the change. required: - new_status - reason /wpcom/v2/ai/chat/{bot_id}/{chat_id}: get: operationId: getWpcomV2AiChatbyBotIdbyChatId summary: GET /wpcom/v2/ai/chat/{bot_id}/{chat_id} tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: bot_id in: path required: true schema: type: string - name: chat_id in: path required: true schema: type: string - name: page_number in: query required: false schema: type: integer default: 1 description: The number of the page to retrieve, limited to 100 - name: items_per_page in: query required: false schema: type: integer default: 10 description: The number of items per page. - name: include_feedback in: query required: false schema: type: boolean description: If true, include the feedback rating value for each message in the response. /wpcom/v2/ai/chats/{bot_ids}: get: operationId: getWpcomV2AiChatsbyBotIds summary: GET /wpcom/v2/ai/chats/{bot_ids} tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: bot_ids in: path required: true schema: type: string - name: truncation_method in: query required: false schema: type: string enum: - first_message - last_message default: last_message description: The method to use for truncating the conversations. Either "first_message" or "last_message". Defaults to "last_message". Note that this parameter affects the response shape. If it is set to `last_message`, the response will include the last message from each chat, while `first_message` will include the first message. - name: page_number in: query required: false schema: type: integer default: 1 description: The 1-indexed page number to retrieve. Each page contains up to 10 conversations. /wpcom/v2/ai/chats/{bot_id}: get: operationId: getWpcomV2AiChatsbyBotId summary: GET /wpcom/v2/ai/chats/{bot_id} tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: bot_id in: path required: true schema: type: string - name: truncation_method in: query required: false schema: type: string enum: - first_message - last_message default: last_message description: The method to use for truncating the conversations. Either "first_message" or "last_message". Defaults to "last_message". Note that this parameter affects the response shape. If it is set to `last_message`, the response will include the last message from each chat, while `first_message` will include the first message. - name: page_number in: query required: false schema: type: integer default: 1 description: The 1-indexed page number to retrieve. Each page contains up to 10 conversations. /wpcom/v2/ai/dai/workspaces: get: operationId: getWpcomV2AiDaiWorkspaces summary: GET /wpcom/v2/ai/dai/workspaces tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/ai/feedback/{session_uuid}/rate: post: operationId: postWpcomV2AiFeedbackbySessionUuidRate summary: POST /wpcom/v2/ai/feedback/{session_uuid}/rate tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: session_uuid in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: message_id: type: string trace_id: type: string rating: type: string enum: - up - down message_text: type: string metadata: type: object default: [] required: - rating /wpcom/v2/ai/feedback/{session_uuid}/text: post: operationId: postWpcomV2AiFeedbackbySessionUuidText summary: POST /wpcom/v2/ai/feedback/{session_uuid}/text tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: session_uuid in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: message_id: type: string trace_id: type: string feedback: type: string previous_messages: type: array default: [] items: type: object page_url: type: string required: - message_id - feedback /wpcom/v2/ai/jwt: post: operationId: postWpcomV2AiJwt summary: POST /wpcom/v2/ai/jwt tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: blog_id: type: integer /wpcom/v2/analyze-url/colors: post: operationId: postWpcomV2AnalyzeUrlColors summary: POST /wpcom/v2/analyze-url/colors tags: - analyze-url responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: url: type: string num: type: integer default: 5 required: - url /wpcom/v2/auth/qr-code-app/approve: post: operationId: postWpcomV2AuthQrCodeAppApprove summary: POST /wpcom/v2/auth/qr-code-app/approve tags: - auth responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/auth/qr-code-app/exchange: post: operationId: postWpcomV2AuthQrCodeAppExchange summary: POST /wpcom/v2/auth/qr-code-app/exchange tags: - auth responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/auth/qr-code-app/scan: post: operationId: postWpcomV2AuthQrCodeAppScan summary: POST /wpcom/v2/auth/qr-code-app/scan tags: - auth responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/auth/qr-code-app/session-status: get: operationId: getWpcomV2AuthQrCodeAppSessionStatus summary: GET /wpcom/v2/auth/qr-code-app/session-status tags: - auth responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/auth/qr-code-app/status: get: operationId: getWpcomV2AuthQrCodeAppStatus summary: GET /wpcom/v2/auth/qr-code-app/status tags: - auth responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/auth/qr-code-app/token: post: operationId: postWpcomV2AuthQrCodeAppToken summary: POST /wpcom/v2/auth/qr-code-app/token tags: - auth responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/auth/qr-code/authenticate: post: operationId: postWpcomV2AuthQrCodeAuthenticate summary: POST /wpcom/v2/auth/qr-code/authenticate tags: - auth responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: token: type: string default: '' data: type: string default: '' /wpcom/v2/auth/qr-code/validate: post: operationId: postWpcomV2AuthQrCodeValidate summary: POST /wpcom/v2/auth/qr-code/validate tags: - auth responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: token: type: string default: '' data: type: string default: '' /wpcom/v2/big-sky/blueprint-status/{spec_id}: get: operationId: getWpcomV2BigSkyBlueprintStatusbySpecId summary: GET /wpcom/v2/big-sky/blueprint-status/{spec_id} tags: - big-sky responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: spec_id in: path required: true schema: type: string /wpcom/v2/big-sky/build-from-brief: post: operationId: postWpcomV2BigSkyBuildFromBrief summary: POST /wpcom/v2/big-sky/build-from-brief tags: - big-sky responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: brief: type: string description: The markdown brief describing the site to build. Requires YAML frontmatter with siteTitle, siteDescription, siteType, and topic. A "## Do NOT include" section is honored as a build constraint and never published. Sent verbatim — do NOT sanitize, which would strip the newlines and markdown the parser needs. generate_images: type: boolean default: false description: Whether the build should generate images for the site. user_confirmed: type: boolean default: false description: Approval gate. Set true ONLY after the user has approved building this site. Calling without it is rejected on purpose so a real site is never created without explicit approval. required: - brief /wpcom/v2/big-sky/build-from-brief/status: get: operationId: getWpcomV2BigSkyBuildFromBriefStatus summary: GET /wpcom/v2/big-sky/build-from-brief/status tags: - big-sky responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: builder_session_id in: query required: true schema: type: string description: The opaque session id returned by POST /wpcom/v2/big-sky/build-from-brief. /wpcom/v2/big-sky/replace-content: post: operationId: postWpcomV2BigSkyReplaceContent summary: POST /wpcom/v2/big-sky/replace-content tags: - big-sky responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: siteDescription: type: string content: type: object sections: type: array items: type: string required: - siteDescription - content /wpcom/v2/big-sky/site-spec-avatar: post: operationId: postWpcomV2BigSkySiteSpecAvatar summary: POST /wpcom/v2/big-sky/site-spec-avatar tags: - big-sky responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: session_id: type: string avatar_url: type: string required: - session_id - avatar_url /wpcom/v2/big-sky/site-spec/{spec_id}: get: operationId: getWpcomV2BigSkySiteSpecbySpecId summary: GET /wpcom/v2/big-sky/site-spec/{spec_id} tags: - big-sky responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: spec_id in: path required: true schema: type: string /wpcom/v2/big-sky/site-spec/{spec_id}/blueprint: post: operationId: postWpcomV2BigSkySiteSpecbySpecIdBlueprint summary: POST /wpcom/v2/big-sky/site-spec/{spec_id}/blueprint tags: - big-sky responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: spec_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: skip_images: type: boolean default: false /wpcom/v2/blaze/assign-user-to-experiment: post: operationId: postWpcomV2BlazeAssignUserToExperiment summary: POST /wpcom/v2/blaze/assign-user-to-experiment tags: - blaze responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: wpcom_user_id: type: string experiment_name: type: string required: - wpcom_user_id - experiment_name /wpcom/v2/block-previews/pattern: get: operationId: getWpcomV2BlockPreviewsPattern summary: GET /wpcom/v2/block-previews/pattern tags: - block-previews responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: demo_site in: query required: false schema: type: string description: A domain or blog ID of the site you want to preview. - name: stylesheet in: query required: false schema: type: string default: pub/zoologist description: 'Theme stylesheet, e.g.: pub/zoologist' - name: source_site in: query required: false schema: type: string description: 'Source site of the pattern, e.g.: dotcompatterns.wordpress.com' - name: pattern_id in: query required: true schema: type: string description: 'Post id of the pattern with the source site id encoded or not, e.g.: 123 or 123-174455321' - name: language in: query required: false schema: type: string default: en description: 'Language, e.g.: ja' - name: site_title in: query required: false schema: type: string description: 'Site title to inject in the header, e.g.: My Restaurant' - name: site_tagline in: query required: false schema: type: string description: Tagline of the site being previewed. - name: site_logo_url in: query required: false schema: type: string description: The logo url of the site being previewed. - name: viewport_height in: query required: false schema: type: integer description: The viewport height in px to approximate in CSS - name: vertical_id in: query required: false schema: type: string description: 'Vertical ID, e.g.: 3' - name: use_screenshot_overrides in: query required: false schema: type: string description: Override the preview markup to be more compatible for taking screenshots /wpcom/v2/block-previews/site: get: operationId: getWpcomV2BlockPreviewsSite summary: GET /wpcom/v2/block-previews/site tags: - block-previews responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: demo_site in: query required: false schema: type: string description: A domain or blog ID of the site you want to preview. - name: stylesheet in: query required: false schema: type: string default: pub/zoologist description: 'Theme stylesheet, e.g.: pub/zoologist' - name: pattern_ids in: query required: false schema: type: string default: '' description: 'Comma-separated list of post ids with the source site id encoded, e.g.: 123-174455321,456-174455321. It's used to override original content' - name: source_site in: query required: false schema: type: string description: 'Source site of the pattern, e.g.: casselstarter.wordpress.com' - name: language in: query required: false schema: type: string default: en description: 'Language, e.g.: ja' - name: site_title in: query required: false schema: type: string description: 'Site title to inject in the header, e.g.: My Restaurant' - name: site_tagline in: query required: false schema: type: string description: Tagline of the site being previewed. - name: site_logo_url in: query required: false schema: type: string description: The logo url of the site being previewed. - name: viewport_height in: query required: false schema: type: integer description: The viewport height in px to approximate in CSS - name: vertical_id in: query required: false schema: type: string description: 'Vertical ID, e.g.: 3' - name: colors in: query required: false schema: type: array items: {} description: Custom CSS colors (background, text or links) to override original style. - name: use_screenshot_overrides in: query required: false schema: type: string description: Override the preview markup to be more compatible for taking screenshots - name: header_pattern_ids in: query required: false schema: type: string description: 'Comma-separated list of post ids with the source site id encoded, e.g.: 123-174455321,456-174455321. It's used to override original header' - name: footer_pattern_ids in: query required: false schema: type: string description: 'Comma-separated list of post ids with the source site id encoded, e.g.: 123-174455321,456-174455321. It's used to override original footer' - name: style_variation in: query required: false schema: type: string description: Title of a theme variation to override the default variation - name: viewport_unit_to_px in: query required: false schema: type: string description: Override viewport units to px /wpcom/v2/block-recipes: get: operationId: getWpcomV2BlockRecipes summary: GET /wpcom/v2/block-recipes tags: - block-recipes responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: source_site_id in: query required: false schema: type: integer description: Source site id of the recipes post: operationId: postWpcomV2BlockRecipes summary: POST /wpcom/v2/block-recipes tags: - block-recipes responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: source_site_id: type: integer description: Source site id of the recipes /wpcom/v2/block-recipes/{recipe_id}: post: operationId: postWpcomV2BlockRecipesbyRecipeId summary: POST /wpcom/v2/block-recipes/{recipe_id} tags: - block-recipes responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: recipe_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: source_site_id: type: integer description: Source site id of the recipes put: operationId: putWpcomV2BlockRecipesbyRecipeId summary: PUT /wpcom/v2/block-recipes/{recipe_id} tags: - block-recipes responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: recipe_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: source_site_id: type: integer description: Source site id of the recipes patch: operationId: patchWpcomV2BlockRecipesbyRecipeId summary: PATCH /wpcom/v2/block-recipes/{recipe_id} tags: - block-recipes responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: recipe_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: source_site_id: type: integer description: Source site id of the recipes get: operationId: getWpcomV2BlockRecipesbyRecipeId summary: GET /wpcom/v2/block-recipes/{recipe_id} tags: - block-recipes responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: recipe_id in: path required: true schema: type: string - name: source_site_id in: query required: false schema: type: integer description: Source site id of the recipes delete: operationId: deleteWpcomV2BlockRecipesbyRecipeId summary: DELETE /wpcom/v2/block-recipes/{recipe_id} tags: - block-recipes responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: recipe_id in: path required: true schema: type: string - name: source_site_id in: query required: false schema: type: integer description: Source site id of the recipes /wpcom/v2/blueprint-archive/{slug}: get: operationId: getWpcomV2BlueprintArchivebySlug summary: GET /wpcom/v2/blueprint-archive/{slug} tags: - blueprint-archive responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: slug in: path required: true schema: type: string /wpcom/v2/breakingbot/report/new: post: operationId: postWpcomV2BreakingbotReportNew summary: POST /wpcom/v2/breakingbot/report/new tags: - breakingbot responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: post_title: type: string post_content: type: string tags: type: array items: type: string wpcom_username: type: string required: - post_title - post_content - tags /wpcom/v2/breakingbot/resolveuser: get: operationId: getWpcomV2BreakingbotResolveuser summary: GET /wpcom/v2/breakingbot/resolveuser tags: - breakingbot responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: slack_member_id in: query required: true schema: type: string /wpcom/v2/calypso-slack-channel-status: get: operationId: getWpcomV2CalypsoSlackChannelStatus summary: GET /wpcom/v2/calypso-slack-channel-status tags: - calypso-slack-channel-status responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/ceo-voice-agent/ground-truth: get: operationId: getWpcomV2CeoVoiceAgentGroundTruth summary: GET /wpcom/v2/ceo-voice-agent/ground-truth tags: - ceo-voice-agent responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/ceo-voice-agent/ingest: post: operationId: postWpcomV2CeoVoiceAgentIngest summary: POST /wpcom/v2/ceo-voice-agent/ingest tags: - ceo-voice-agent responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: force: type: boolean default: false description: Bypass the freshness cooldown and re-run ingest immediately. /wpcom/v2/ceo-voice-agent/run-stream: post: operationId: postWpcomV2CeoVoiceAgentRunStream summary: POST /wpcom/v2/ceo-voice-agent/run-stream tags: - ceo-voice-agent responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: prompt: type: string prior_messages: type: array default: [] items: {} mode: type: string enum: - validate - audit default: validate strategy_cards: type: string description: Strategy agent output to validate (required for validate mode). model: type: string enum: - claude-sonnet-4-6 - claude-sonnet-4-5-20250929 - claude-opus-4-6 - claude-haiku-4-5-20251001 required: - prompt /wpcom/v2/colors/palettes: get: operationId: getWpcomV2ColorsPalettes summary: GET /wpcom/v2/colors/palettes tags: - colors responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: color in: query required: false schema: type: string - name: limit in: query required: false schema: type: integer - name: offset in: query required: false schema: type: integer - name: colors in: query required: false schema: type: string /wpcom/v2/colors/palettes/{id}: get: operationId: getWpcomV2ColorsPalettesbyId summary: GET /wpcom/v2/colors/palettes/{id} tags: - colors responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string /wpcom/v2/colors/patterns: get: operationId: getWpcomV2ColorsPatterns summary: GET /wpcom/v2/colors/patterns tags: - colors responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: color in: query required: false schema: type: string - name: limit in: query required: false schema: type: integer - name: offset in: query required: false schema: type: integer /wpcom/v2/colors/patterns/{id}: get: operationId: getWpcomV2ColorsPatternsbyId summary: GET /wpcom/v2/colors/patterns/{id} tags: - colors responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string /wpcom/v2/common-block-layouts: get: operationId: getWpcomV2CommonBlockLayouts summary: GET /wpcom/v2/common-block-layouts tags: - common-block-layouts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: supported_blocks in: query required: false schema: {} - name: exclude in: query required: false schema: {} - name: preview_width in: query required: false schema: {} - name: preview_height in: query required: false schema: {} - name: scale in: query required: false schema: default: 1 - name: is_beta in: query required: false schema: default: false - name: type in: query required: false schema: {} /wpcom/v2/common-starter-site-designs: get: operationId: getWpcomV2CommonStarterSiteDesigns summary: GET /wpcom/v2/common-starter-site-designs tags: - common-starter-site-designs responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: preview_width in: query required: false schema: {} - name: preview_height in: query required: false schema: {} - name: scale in: query required: false schema: default: 1 - name: is_beta in: query required: false schema: default: false - name: group in: query required: false schema: {} - name: type in: query required: false schema: {} /wpcom/v2/concierge/initial: get: operationId: getWpcomV2ConciergeInitial summary: GET /wpcom/v2/concierge/initial tags: - concierge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: begin_timestamp in: query required: false schema: type: integer description: the begin of the query time span. - name: site_id in: query required: false schema: type: integer description: A unique identifier of a dotcom site. - name: available_sessions in: query required: false schema: type: array items: {} description: A unique array of site ids from sites that have concierge sessions available. /wpcom/v2/concierge/schedules: get: operationId: getWpcomV2ConciergeSchedules summary: GET /wpcom/v2/concierge/schedules tags: - concierge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/concierge/schedules/{id}/available_staff: get: operationId: getWpcomV2ConciergeSchedulesbyIdAvailableStaff summary: GET /wpcom/v2/concierge/schedules/{id}/available_staff tags: - concierge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: begin_timestamp in: query required: false schema: type: integer description: the begin of the query time span. - name: end_timestamp in: query required: false schema: type: integer description: the end of the query time span. /wpcom/v2/concierge/schedules/{id}/available_times: get: operationId: getWpcomV2ConciergeSchedulesbyIdAvailableTimes summary: GET /wpcom/v2/concierge/schedules/{id}/available_times tags: - concierge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: begin_timestamp in: query required: false schema: type: integer description: the begin of the query time span. /wpcom/v2/concierge/schedules/{schedule_id}/appointments: get: operationId: getWpcomV2ConciergeSchedulesbyScheduleIdAppointments summary: GET /wpcom/v2/concierge/schedules/{schedule_id}/appointments tags: - concierge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: schedule_id in: path required: true schema: type: string - name: begin_timestamp in: query required: false schema: type: integer description: the begin of the query time span. post: operationId: postWpcomV2ConciergeSchedulesbyScheduleIdAppointments summary: POST /wpcom/v2/concierge/schedules/{schedule_id}/appointments tags: - concierge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: schedule_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: begin_timestamp: type: integer description: the begin of the target appointment time span. end_timestamp: type: integer description: the end of the target appointment time span. customer_id: type: integer description: The user id of whom is making this appointment request. site_id: type: integer description: The site id of which the appointment is about. meta: type: string description: A json blob string that includes the meta data of this appointment. /wpcom/v2/concierge/schedules/{schedule_id}/appointments/all: get: operationId: getWpcomV2ConciergeSchedulesbyScheduleIdAppointmentsAll summary: GET /wpcom/v2/concierge/schedules/{schedule_id}/appointments/all tags: - concierge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: schedule_id in: path required: true schema: type: string - name: username in: query required: false schema: type: string description: wp username - name: begin_timestamp in: query required: false schema: type: integer description: the begin of the query time span. - name: end_timestamp in: query required: false schema: type: integer description: the end of the query time span. - name: include_cancelled in: query required: false schema: type: boolean description: Indicated whether we should include cancelled appointments in the results /wpcom/v2/concierge/schedules/{schedule_id}/appointments/{appointment_id}/cancel: post: operationId: postWpcomV2ConciergeSchedulesbyScheduleIdAppointmentsbyAppointmentIdCancel summary: POST /wpcom/v2/concierge/schedules/{schedule_id}/appointments/{appointment_id}/cancel tags: - concierge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: schedule_id in: path required: true schema: type: string - name: appointment_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: reason: type: string description: Text that explains why this appointment has been cancelled. /wpcom/v2/concierge/schedules/{schedule_id}/appointments/{appointment_id}/detail: get: operationId: getWpcomV2ConciergeSchedulesbyScheduleIdAppointmentsbyAppointmentIdDetail summary: GET /wpcom/v2/concierge/schedules/{schedule_id}/appointments/{appointment_id}/detail tags: - concierge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: schedule_id in: path required: true schema: type: string - name: appointment_id in: path required: true schema: type: string /wpcom/v2/concierge/schedules/{schedule_id}/appointments/{appointment_id}/reassign: post: operationId: postWpcomV2ConciergeSchedulesbyScheduleIdAppointmentsbyAppointmentIdReassign summary: POST /wpcom/v2/concierge/schedules/{schedule_id}/appointments/{appointment_id}/reassign tags: - concierge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: schedule_id in: path required: true schema: type: string - name: appointment_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: staff_id: type: integer description: A unique identifier of whom is going to take over the appointment availability_type: type: string description: Indicates availability category of picked staff as one one with buffer/without buffer/not scheduled /wpcom/v2/concierge/schedules/{schedule_id}/appointments/{appointment_id}/reschedule: post: operationId: postWpcomV2ConciergeSchedulesbyScheduleIdAppointmentsbyAppointmentIdReschedule summary: POST /wpcom/v2/concierge/schedules/{schedule_id}/appointments/{appointment_id}/reschedule tags: - concierge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: schedule_id in: path required: true schema: type: string - name: appointment_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: begin_timestamp: type: integer description: The new appointment start time meta: type: string description: A json blob string that includes the meta data of this appointment. /wpcom/v2/concierge/schedules/{schedule_id}/appointments/{appointment_id}/update-conference-link: post: operationId: postWpcomV2ConciergeSchedulesbyScheduleIdAppointmentsbyAppointmentIdUpdateConferenceLink summary: POST /wpcom/v2/concierge/schedules/{schedule_id}/appointments/{appointment_id}/update-conference-link tags: - concierge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: schedule_id in: path required: true schema: type: string - name: appointment_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: conference_link: type: string description: A URL for the screen share conference session. /wpcom/v2/content-research/search: get: operationId: getWpcomV2ContentResearchSearch summary: GET /wpcom/v2/content-research/search tags: - content-research responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: topic in: query required: true schema: type: string - name: sources in: query required: false schema: type: array default: - hn - reader - googlenews - myposts items: type: string - name: count in: query required: false schema: type: integer default: 10 /wpcom/v2/content-research/summarize: post: operationId: postWpcomV2ContentResearchSummarize summary: POST /wpcom/v2/content-research/summarize tags: - content-research responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: topic: type: string results: type: array items: type: object required: - topic - results /wpcom/v2/country-codes: get: operationId: getWpcomV2CountryCodes summary: GET /wpcom/v2/country-codes tags: - country-codes responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/courses: get: operationId: getWpcomV2Courses summary: GET /wpcom/v2/courses tags: - courses responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: course_slug in: query required: false schema: {} /wpcom/v2/courses/videos: post: operationId: postWpcomV2CoursesVideos summary: POST /wpcom/v2/courses/videos tags: - courses responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: course_slug: {} video_slug: {} required: - course_slug - video_slug /wpcom/v2/currency-overrides: get: operationId: getWpcomV2CurrencyOverrides summary: GET /wpcom/v2/currency-overrides tags: - currency-overrides responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/dashboard/admin-bar: get: operationId: getWpcomV2DashboardAdminBar summary: GET /wpcom/v2/dashboard/admin-bar tags: - dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/dashboard/site-filters: get: operationId: getWpcomV2DashboardSiteFilters summary: GET /wpcom/v2/dashboard/site-filters tags: - dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: fields in: query required: true schema: type: array items: type: string - name: site_types in: query required: false schema: type: array default: [] items: type: string /wpcom/v2/dashboard/site-issues: get: operationId: getWpcomV2DashboardSiteIssues summary: GET /wpcom/v2/dashboard/site-issues tags: - dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/deepl/translate: post: operationId: postWpcomV2DeeplTranslate summary: POST /wpcom/v2/deepl/translate tags: - deepl responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: text: description: The text to be translated target_lang: description: The language you want returned required: - text - target_lang /wpcom/v2/dictation-client-secret: post: operationId: postWpcomV2DictationClientSecret summary: POST /wpcom/v2/dictation-client-secret tags: - dictation-client-secret responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: session: type: object /wpcom/v2/dictation-client-secret/remaining-time: get: operationId: getWpcomV2DictationClientSecretRemainingTime summary: GET /wpcom/v2/dictation-client-secret/remaining-time tags: - dictation-client-secret responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/dictation-client-secret/settle: post: operationId: postWpcomV2DictationClientSecretSettle summary: POST /wpcom/v2/dictation-client-secret/settle tags: - dictation-client-secret responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/domains/auction/expired-domain-stats: get: operationId: getWpcomV2DomainsAuctionExpiredDomainStats summary: GET /wpcom/v2/domains/auction/expired-domain-stats tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/domains/auction/expired-list-csv: get: operationId: getWpcomV2DomainsAuctionExpiredListCsv summary: GET /wpcom/v2/domains/auction/expired-list-csv tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/domains/auction/renew: post: operationId: postWpcomV2DomainsAuctionRenew summary: POST /wpcom/v2/domains/auction/renew tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/domains/auction/transfer{query_string}: post: operationId: postWpcomV2DomainsAuctionTransferQueryString summary: POST /wpcom/v2/domains/auction/transfer{query_string} tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: query_string in: path required: true schema: type: string /wpcom/v2/domains/bulk-actions: get: operationId: getWpcomV2DomainsBulkActions summary: GET /wpcom/v2/domains/bulk-actions tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' delete: operationId: deleteWpcomV2DomainsBulkActions summary: DELETE /wpcom/v2/domains/bulk-actions tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/domains/bulk-actions/set-auto-renew: post: operationId: postWpcomV2DomainsBulkActionsSetAutoRenew summary: POST /wpcom/v2/domains/bulk-actions/set-auto-renew tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/domains/bulk-actions/update-contact-info: post: operationId: postWpcomV2DomainsBulkActionsUpdateContactInfo summary: POST /wpcom/v2/domains/bulk-actions/update-contact-info tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/domains/bulk-availability-check/{domain_names}: get: operationId: getWpcomV2DomainsBulkAvailabilityCheckbyDomainNames summary: GET /wpcom/v2/domains/bulk-availability-check/{domain_names} tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain_names in: path required: true schema: type: string /wpcom/v2/domains/bundle: get: operationId: getWpcomV2DomainsBundle summary: GET /wpcom/v2/domains/bundle tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: query in: query required: false schema: type: string default: '' description: Domain name (e.g. "flowers.com") to build a bundle suggestion for. /wpcom/v2/domains/diagnostics/{domain}: get: operationId: getWpcomV2DomainsDiagnosticsbyDomain summary: GET /wpcom/v2/domains/diagnostics/{domain} tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: path required: true schema: type: string /wpcom/v2/domains/dns/email/set-default-records: post: operationId: postWpcomV2DomainsDnsEmailSetDefaultRecords summary: POST /wpcom/v2/domains/dns/email/set-default-records tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: domain: description: The domain which default email DNS records will be restored required: - domain /wpcom/v2/domains/dns/import/bind/{domain}: post: operationId: postWpcomV2DomainsDnsImportBindbyDomain summary: POST /wpcom/v2/domains/dns/import/bind/{domain} tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: path required: true schema: type: string /wpcom/v2/domains/dnssec/{domain}: post: operationId: postWpcomV2DomainsDnssecbyDomain summary: POST /wpcom/v2/domains/dnssec/{domain} tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: path required: true schema: type: string put: operationId: putWpcomV2DomainsDnssecbyDomain summary: PUT /wpcom/v2/domains/dnssec/{domain} tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: data: type: object required: - data delete: operationId: deleteWpcomV2DomainsDnssecbyDomain summary: DELETE /wpcom/v2/domains/dnssec/{domain} tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: path required: true schema: type: string /wpcom/v2/domains/dnssec/{domain}/nameserver: get: operationId: getWpcomV2DomainsDnssecbyDomainNameserver summary: GET /wpcom/v2/domains/dnssec/{domain}/nameserver tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: path required: true schema: type: string /wpcom/v2/domains/dnssec/{domain}/registry: get: operationId: getWpcomV2DomainsDnssecbyDomainRegistry summary: GET /wpcom/v2/domains/dnssec/{domain}/registry tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: path required: true schema: type: string /wpcom/v2/domains/glue-records: post: operationId: postWpcomV2DomainsGlueRecords summary: POST /wpcom/v2/domains/glue-records tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: name_server: type: string ip_addresses: type: array items: {} required: - name_server - ip_addresses put: operationId: putWpcomV2DomainsGlueRecords summary: PUT /wpcom/v2/domains/glue-records tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: name_server: type: string ip_addresses: type: array items: {} required: - name_server - ip_addresses patch: operationId: patchWpcomV2DomainsGlueRecords summary: PATCH /wpcom/v2/domains/glue-records tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: name_server: type: string ip_addresses: type: array items: {} required: - name_server - ip_addresses /wpcom/v2/domains/glue-records/{domain}: get: operationId: getWpcomV2DomainsGlueRecordsbyDomain summary: GET /wpcom/v2/domains/glue-records/{domain} tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: path required: true schema: type: string /wpcom/v2/domains/glue-records/{name_server}: delete: operationId: deleteWpcomV2DomainsGlueRecordsbyNameServer summary: DELETE /wpcom/v2/domains/glue-records/{name_server} tags: - domains responses: '200': description: OK '401': description: 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_server in: path required: true schema: type: string /wpcom/v2/domains/list/mine: get: operationId: getWpcomV2DomainsListMine summary: GET /wpcom/v2/domains/list/mine tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/domains/name-pulse/availability-check: post: operationId: postWpcomV2DomainsNamePulseAvailabilityCheck summary: POST /wpcom/v2/domains/name-pulse/availability-check tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: domain_names: type: array items: type: string description: Domain names to check availability for (max 50) include_pricing: type: boolean default: true description: Whether to include pricing data for available domains required: - domain_names /wpcom/v2/domains/name-pulse/suggestions: get: operationId: getWpcomV2DomainsNamePulseSuggestions summary: GET /wpcom/v2/domains/name-pulse/suggestions tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: query in: query required: true schema: type: string description: Search term for domain suggestions - name: providers in: query required: false schema: type: string description: Comma-separated provider names (donuts, verisign, domainsbot) - name: quantity in: query required: false schema: type: integer description: Number of suggestions to return (1-200). If omitted, returns all available suggestions. - name: timeout in: query required: false schema: type: integer description: Total timeout in milliseconds - name: tlds in: query required: false schema: type: string default: '' description: Comma-separated TLDs to include - name: use_ai in: query required: false schema: type: integer enum: - 0 - 1 default: 0 description: Enable AI suggestions (0 or 1) - name: allow_premium in: query required: false schema: type: boolean default: true description: Include premium domains - name: language in: query required: false schema: type: string default: en description: Language for suggestions - name: include_pricing in: query required: false schema: type: boolean default: true description: Whether to include pricing data for suggestions - name: exclude_exact_matches in: query required: false schema: type: boolean default: true description: Exclude suggestions whose SLD exactly matches the query with spaces removed /wpcom/v2/domains/point-to-wpcom: post: operationId: postWpcomV2DomainsPointToWpcom summary: POST /wpcom/v2/domains/point-to-wpcom tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: domain: type: string required: - domain /wpcom/v2/domains/propagation-status/{domain}: get: operationId: getWpcomV2DomainsPropagationStatusbyDomain summary: GET /wpcom/v2/domains/propagation-status/{domain} tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: path required: true schema: type: string /wpcom/v2/domains/secure-your-brand/{domain}: get: operationId: getWpcomV2DomainsSecureYourBrandbyDomain summary: GET /wpcom/v2/domains/secure-your-brand/{domain} tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: path required: true schema: type: string /wpcom/v2/domains/ssl/{domain}: get: operationId: getWpcomV2DomainsSslbyDomain summary: GET /wpcom/v2/domains/ssl/{domain} tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: path required: true schema: type: string post: operationId: postWpcomV2DomainsSslbyDomain summary: POST /wpcom/v2/domains/ssl/{domain} tags: - domains responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: path required: true schema: type: string /wpcom/v2/emails/titan/{account_id}/control-panel-auto-login-url: get: operationId: getWpcomV2EmailsTitanbyAccountIdControlPanelAutoLoginUrl summary: GET /wpcom/v2/emails/titan/{account_id}/control-panel-auto-login-url tags: - emails responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: account_id in: path required: true schema: type: string /wpcom/v2/emails/titan/{account_id}/control-panel-iframe-url: get: operationId: getWpcomV2EmailsTitanbyAccountIdControlPanelIframeUrl summary: GET /wpcom/v2/emails/titan/{account_id}/control-panel-iframe-url tags: - emails responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: account_id in: path required: true schema: type: string /wpcom/v2/emails/titan/{domain}/check-mailbox-availability/{mailbox}: get: operationId: getWpcomV2EmailsTitanbyDomainCheckMailboxAvailabilitybyMailbox summary: GET /wpcom/v2/emails/titan/{domain}/check-mailbox-availability/{mailbox} tags: - emails responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: path required: true schema: type: string - name: mailbox in: path required: true schema: type: string /wpcom/v2/emails/titan/{domain}/mailbox/create: post: operationId: postWpcomV2EmailsTitanbyDomainMailboxCreate summary: POST /wpcom/v2/emails/titan/{domain}/mailbox/create tags: - emails responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: name: type: string description: The name of the mailbox owner/user mailbox: type: string description: The mailbox name i.e. the email address excluding the domain password: type: string description: The password to authenticate users who want to access the mailbox alternate_email_address: type: string description: The alternate email address for password resets and notifications is_admin: type: boolean default: false description: Whether this user should have administrative permissions/privileges for the domain required: - name - mailbox - password - alternate_email_address /wpcom/v2/emails/titan/{domain}/mailbox/{mailbox}: delete: operationId: deleteWpcomV2EmailsTitanbyDomainMailboxbyMailbox summary: DELETE /wpcom/v2/emails/titan/{domain}/mailbox/{mailbox} tags: - emails responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: path required: true schema: type: string - name: mailbox in: path required: true schema: type: string /wpcom/v2/emails/titan/{domain}/order-provisioning-url: get: operationId: getWpcomV2EmailsTitanbyDomainOrderProvisioningUrl summary: GET /wpcom/v2/emails/titan/{domain}/order-provisioning-url tags: - emails responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: path required: true schema: type: string /wpcom/v2/enterpret-webhook/{secret}/{enterpret_api_key}: post: operationId: postWpcomV2EnterpretWebhookbySecretbyEnterpretApiKey summary: POST /wpcom/v2/enterpret-webhook/{secret}/{enterpret_api_key} tags: - enterpret-webhook responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: secret in: path required: true schema: type: string - name: enterpret_api_key in: path required: true schema: type: string /wpcom/v2/experiments/0.1.0/analyses/{experiment_id}: get: operationId: getWpcomV2Experiments010AnalysesbyExperimentId summary: GET /wpcom/v2/experiments/0.1.0/analyses/{experiment_id} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: experiment_id in: path required: true schema: type: string - name: metric_assignment_id in: query required: false schema: type: integer /wpcom/v2/experiments/0.1.0/analyses/{experiment_id}/latest: get: operationId: getWpcomV2Experiments010AnalysesbyExperimentIdLatest summary: GET /wpcom/v2/experiments/0.1.0/analyses/{experiment_id}/latest tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: experiment_id in: path required: true schema: type: string - name: metric_assignment_id in: query required: false schema: type: integer /wpcom/v2/experiments/0.1.0/assignments: patch: operationId: patchWpcomV2Experiments010Assignments summary: PATCH /wpcom/v2/experiments/0.1.0/assignments tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: anon_id: type: string username_override: type: string variations: type: object required: - variations /wpcom/v2/experiments/0.1.0/assignments/log: post: operationId: postWpcomV2Experiments010AssignmentsLog summary: POST /wpcom/v2/experiments/0.1.0/assignments/log tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: flag_key: type: string experiment_id: type: integer experiment_variation_id: type: integer hash_attribute: type: string enum: - anon_id - wpcom_user_id - dayone_user_id - pocketcasts_user_id hash_value: type: string required: - flag_key - experiment_id - experiment_variation_id - hash_attribute - hash_value /wpcom/v2/experiments/0.1.0/assignments/{platform}: get: operationId: getWpcomV2Experiments010AssignmentsbyPlatform summary: GET /wpcom/v2/experiments/0.1.0/assignments/{platform} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: platform in: path required: true schema: type: string - name: anon_id in: query required: false schema: type: string - name: experiment_names in: query required: false schema: type: string /wpcom/v2/experiments/0.1.0/autocomplete/events: get: operationId: getWpcomV2Experiments010AutocompleteEvents summary: GET /wpcom/v2/experiments/0.1.0/autocomplete/events tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/experiments/0.1.0/autocomplete/events/{name}: get: operationId: getWpcomV2Experiments010AutocompleteEventsbyName summary: GET /wpcom/v2/experiments/0.1.0/autocomplete/events/{name} tags: - experiments responses: '200': description: OK '401': description: 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 /wpcom/v2/experiments/0.1.0/autocomplete/products: get: operationId: getWpcomV2Experiments010AutocompleteProducts summary: GET /wpcom/v2/experiments/0.1.0/autocomplete/products tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/experiments/0.1.0/autocomplete/transaction-types: get: operationId: getWpcomV2Experiments010AutocompleteTransactionTypes summary: GET /wpcom/v2/experiments/0.1.0/autocomplete/transaction-types tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/experiments/0.1.0/autocomplete/users: get: operationId: getWpcomV2Experiments010AutocompleteUsers summary: GET /wpcom/v2/experiments/0.1.0/autocomplete/users tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/experiments/0.1.0/experiments: get: operationId: getWpcomV2Experiments010Experiments summary: GET /wpcom/v2/experiments/0.1.0/experiments tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: include_analyses in: query required: false schema: type: string post: operationId: postWpcomV2Experiments010Experiments summary: POST /wpcom/v2/experiments/0.1.0/experiments tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: name: type: string start_datetime: type: string format: date-time end_datetime: type: string format: date-time platform: type: string enum: - akismet - calypso - dayone - dsp - email - jetpack - lohp - mlsales - pipe - pocketcasts - tumblr - wccom - woocommerce - woocommerceandroid - woocommerceios - wpandroid - wpcom - wpios owner_login: type: string description: type: string existing_users_allowed: type: boolean p2_url: type: string format: uri eligibility: type: object exposure_events: type: array items: type: object variations: type: array items: type: object metric_assignments: type: array items: type: object segment_assignments: type: array items: type: object exclusion_group_tag_ids: type: array items: type: integer apply_guardrails: type: boolean default: false required: - name - platform - owner_login - description - existing_users_allowed - variations - metric_assignments - segment_assignments - exclusion_group_tag_ids /wpcom/v2/experiments/0.1.0/experiments/guardrails/{platform}: get: operationId: getWpcomV2Experiments010ExperimentsGuardrailsbyPlatform summary: GET /wpcom/v2/experiments/0.1.0/experiments/guardrails/{platform} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: platform in: path required: true schema: type: string /wpcom/v2/experiments/0.1.0/experiments/preset: post: operationId: postWpcomV2Experiments010ExperimentsPreset summary: POST /wpcom/v2/experiments/0.1.0/experiments/preset tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: name: type: string platform: type: string enum: - akismet - calypso - dayone - dsp - email - jetpack - lohp - mlsales - pipe - pocketcasts - tumblr - wccom - woocommerce - woocommerceandroid - woocommerceios - wpandroid - wpcom - wpios required: - name - platform /wpcom/v2/experiments/0.1.0/experiments/{experiment_id}: get: operationId: getWpcomV2Experiments010ExperimentsbyExperimentId summary: GET /wpcom/v2/experiments/0.1.0/experiments/{experiment_id} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: experiment_id in: path required: true schema: type: string - name: include_participants in: query required: false schema: type: string put: operationId: putWpcomV2Experiments010ExperimentsbyExperimentId summary: PUT /wpcom/v2/experiments/0.1.0/experiments/{experiment_id} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: experiment_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: name: type: string start_datetime: type: string format: date-time end_datetime: type: string format: date-time platform: type: string enum: - akismet - calypso - dayone - dsp - email - jetpack - lohp - mlsales - pipe - pocketcasts - tumblr - wccom - woocommerce - woocommerceandroid - woocommerceios - wpandroid - wpcom - wpios owner_login: type: string description: type: string existing_users_allowed: type: boolean p2_url: type: string format: uri eligibility: type: object exposure_events: type: array items: type: object variations: type: array items: type: object metric_assignments: type: array items: type: object segment_assignments: type: array items: type: object exclusion_group_tag_ids: type: array items: type: integer apply_guardrails: type: boolean default: false required: - name - platform - owner_login - description - existing_users_allowed - variations - metric_assignments - segment_assignments - exclusion_group_tag_ids patch: operationId: patchWpcomV2Experiments010ExperimentsbyExperimentId summary: PATCH /wpcom/v2/experiments/0.1.0/experiments/{experiment_id} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: experiment_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: variations: type: array items: type: object end_datetime: type: string format: date-time owner_login: type: string description: type: string p2_url: type: string format: uri metric_assignments: type: array items: type: object end_reason: type: string conclusion_url: type: string format: uri deployed_variation_id: type: integer /wpcom/v2/experiments/0.1.0/experiments/{experiment_id}/apply-guardrails: post: operationId: postWpcomV2Experiments010ExperimentsbyExperimentIdApplyGuardrails summary: POST /wpcom/v2/experiments/0.1.0/experiments/{experiment_id}/apply-guardrails tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: experiment_id in: path required: true schema: type: string /wpcom/v2/experiments/0.1.0/experiments/{experiment_id}/early-participants: get: operationId: getWpcomV2Experiments010ExperimentsbyExperimentIdEarlyParticipants summary: GET /wpcom/v2/experiments/0.1.0/experiments/{experiment_id}/early-participants tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: experiment_id in: path required: true schema: type: string - name: hours in: query required: false schema: type: integer default: 168 /wpcom/v2/experiments/0.1.0/experiments/{experiment_id}/status: put: operationId: putWpcomV2Experiments010ExperimentsbyExperimentIdStatus summary: PUT /wpcom/v2/experiments/0.1.0/experiments/{experiment_id}/status tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: experiment_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: status: type: string enum: - staging - running - completed - disabled required: - status /wpcom/v2/experiments/0.1.0/flags: post: operationId: postWpcomV2Experiments010Flags summary: POST /wpcom/v2/experiments/0.1.0/flags tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: experiment_flag_key: type: string description: type: string value_type: type: string enum: - string - boolean - number - json default_value: type: string rules: type: array default: [] items: {} client_safe: type: boolean default: false required: - experiment_flag_key - value_type - default_value get: operationId: getWpcomV2Experiments010Flags summary: GET /wpcom/v2/experiments/0.1.0/flags tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: status in: query required: false schema: type: string enum: - active - archived default: active - name: q in: query required: false schema: type: string - name: page in: query required: false schema: type: integer default: 1 - name: per_page in: query required: false schema: type: integer default: 50 /wpcom/v2/experiments/0.1.0/flags/preset: post: operationId: postWpcomV2Experiments010FlagsPreset summary: POST /wpcom/v2/experiments/0.1.0/flags/preset tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: experiment_flag_key: type: string description: type: string required: - experiment_flag_key /wpcom/v2/experiments/0.1.0/flags/{experiment_flag_key}: patch: operationId: patchWpcomV2Experiments010FlagsbyExperimentFlagKey summary: PATCH /wpcom/v2/experiments/0.1.0/flags/{experiment_flag_key} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: experiment_flag_key in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: description: type: string value_type: type: string enum: - string - boolean - number - json default_value: type: string rules: type: array items: {} client_safe: type: boolean status: type: string enum: - active - archived delete: operationId: deleteWpcomV2Experiments010FlagsbyExperimentFlagKey summary: DELETE /wpcom/v2/experiments/0.1.0/flags/{experiment_flag_key} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: experiment_flag_key in: path required: true schema: type: string /wpcom/v2/experiments/0.1.0/flags/{experiment_flag_key}/details: get: operationId: getWpcomV2Experiments010FlagsbyExperimentFlagKeyDetails summary: GET /wpcom/v2/experiments/0.1.0/flags/{experiment_flag_key}/details tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: experiment_flag_key in: path required: true schema: type: string /wpcom/v2/experiments/0.1.0/flags/{experiment_flag_key}/experiments: post: operationId: postWpcomV2Experiments010FlagsbyExperimentFlagKeyExperiments summary: POST /wpcom/v2/experiments/0.1.0/flags/{experiment_flag_key}/experiments tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: experiment_flag_key in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: experiment_id: type: integer hash_attribute: type: string enum: - anon_id - wpcom_user_id - dayone_user_id - pocketcasts_user_id variation_values: type: object required: - experiment_id /wpcom/v2/experiments/0.1.0/flags/{platform}: get: operationId: getWpcomV2Experiments010FlagsbyPlatform summary: GET /wpcom/v2/experiments/0.1.0/flags/{platform} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: platform in: path required: true schema: type: string - name: source in: query required: false schema: type: string enum: - cache - db default: cache /wpcom/v2/experiments/0.1.0/metrics: get: operationId: getWpcomV2Experiments010Metrics summary: GET /wpcom/v2/experiments/0.1.0/metrics tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2Experiments010Metrics summary: POST /wpcom/v2/experiments/0.1.0/metrics tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: name: type: string description: type: string higher_is_better: type: boolean pipe_params: type: object event_params: type: array items: type: object revenue_params: type: object tags: type: array items: type: object required: - name - description - higher_is_better /wpcom/v2/experiments/0.1.0/metrics/{metric_id}: get: operationId: getWpcomV2Experiments010MetricsbyMetricId summary: GET /wpcom/v2/experiments/0.1.0/metrics/{metric_id} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: metric_id in: path required: true schema: type: string put: operationId: putWpcomV2Experiments010MetricsbyMetricId summary: PUT /wpcom/v2/experiments/0.1.0/metrics/{metric_id} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: metric_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: name: type: string description: type: string higher_is_better: type: boolean pipe_params: type: object event_params: type: array items: type: object revenue_params: type: object tags: type: array items: type: object required: - name - description - higher_is_better delete: operationId: deleteWpcomV2Experiments010MetricsbyMetricId summary: DELETE /wpcom/v2/experiments/0.1.0/metrics/{metric_id} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: metric_id in: path required: true schema: type: string /wpcom/v2/experiments/0.1.0/segments: get: operationId: getWpcomV2Experiments010Segments summary: GET /wpcom/v2/experiments/0.1.0/segments tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2Experiments010Segments summary: POST /wpcom/v2/experiments/0.1.0/segments tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: name: type: string type: type: string enum: - country - locale required: - name - type /wpcom/v2/experiments/0.1.0/segments/{segment_id}: get: operationId: getWpcomV2Experiments010SegmentsbySegmentId summary: GET /wpcom/v2/experiments/0.1.0/segments/{segment_id} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: segment_id in: path required: true schema: type: string delete: operationId: deleteWpcomV2Experiments010SegmentsbySegmentId summary: DELETE /wpcom/v2/experiments/0.1.0/segments/{segment_id} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: segment_id in: path required: true schema: type: string /wpcom/v2/experiments/0.1.0/tags: get: operationId: getWpcomV2Experiments010Tags summary: GET /wpcom/v2/experiments/0.1.0/tags tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2Experiments010Tags summary: POST /wpcom/v2/experiments/0.1.0/tags tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: namespace: type: string name: type: string description: type: string required: - namespace - name - description /wpcom/v2/experiments/0.1.0/tags/{tag_id}: get: operationId: getWpcomV2Experiments010TagsbyTagId summary: GET /wpcom/v2/experiments/0.1.0/tags/{tag_id} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: tag_id in: path required: true schema: type: string put: operationId: putWpcomV2Experiments010TagsbyTagId summary: PUT /wpcom/v2/experiments/0.1.0/tags/{tag_id} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: tag_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: namespace: type: string name: type: string description: type: string required: - namespace - name - description delete: operationId: deleteWpcomV2Experiments010TagsbyTagId summary: DELETE /wpcom/v2/experiments/0.1.0/tags/{tag_id} tags: - experiments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: tag_id in: path required: true schema: type: string /wpcom/v2/following/mine: get: operationId: getWpcomV2FollowingMine summary: GET /wpcom/v2/following/mine tags: - following responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: ignore_user_blogs in: query required: false schema: type: boolean /wpcom/v2/following/recommendations: get: operationId: getWpcomV2FollowingRecommendations summary: GET /wpcom/v2/following/recommendations tags: - following responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: number in: query required: false schema: type: number default: 5 /wpcom/v2/fsor-airtable-report/generate: post: operationId: postWpcomV2FsorAirtableReportGenerate summary: POST /wpcom/v2/fsor-airtable-report/generate tags: - fsor-airtable-report responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: view_id: type: string description: Airtable view ID. table_id: type: string description: Airtable table ID. base_id: type: string description: Airtable base ID. after_date: type: string format: date-time description: The date to filter the records by (in ISO8601 format) cluster_method: type: string enum: - kmedoids - dbscan description: 'The clustering method to use. Available options: kmedoids, dbscan.' num_clusters: type: integer description: The number of clusters to use. report_name: type: string description: The name of the report. required: - view_id /wpcom/v2/github: post: operationId: postWpcomV2Github summary: POST /wpcom/v2/github tags: - github responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/github/commit-email-validator: post: operationId: postWpcomV2GithubCommitEmailValidator summary: POST /wpcom/v2/github/commit-email-validator tags: - github responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/glossary: get: operationId: getWpcomV2Glossary summary: GET /wpcom/v2/glossary tags: - glossary responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2Glossary summary: POST /wpcom/v2/glossary tags: - glossary responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: name: type: string description: Glossary item name. description: type: string description: Glossary item description required: - name - description /wpcom/v2/glossary/{item_id}: get: operationId: getWpcomV2GlossarybyItemId summary: GET /wpcom/v2/glossary/{item_id} tags: - glossary responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: item_id in: path required: true schema: type: string post: operationId: postWpcomV2GlossarybyItemId summary: POST /wpcom/v2/glossary/{item_id} tags: - glossary responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: item_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: name: type: string description: Glossary item name. description: type: string description: Glossary item description put: operationId: putWpcomV2GlossarybyItemId summary: PUT /wpcom/v2/glossary/{item_id} tags: - glossary responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: item_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: name: type: string description: Glossary item name. description: type: string description: Glossary item description patch: operationId: patchWpcomV2GlossarybyItemId summary: PATCH /wpcom/v2/glossary/{item_id} tags: - glossary responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: item_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: name: type: string description: Glossary item name. description: type: string description: Glossary item description delete: operationId: deleteWpcomV2GlossarybyItemId summary: DELETE /wpcom/v2/glossary/{item_id} tags: - glossary responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: item_id in: path required: true schema: type: string /wpcom/v2/grafana/alert-webhook: post: operationId: postWpcomV2GrafanaAlertWebhook summary: POST /wpcom/v2/grafana/alert-webhook tags: - grafana responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/gravatar-upload: post: operationId: postWpcomV2GravatarUpload summary: POST /wpcom/v2/gravatar-upload tags: - gravatar-upload responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: account: type: string required: - account /wpcom/v2/gravatar/custom-domains/add-email-forward: post: operationId: postWpcomV2GravatarCustomDomainsAddEmailForward summary: POST /wpcom/v2/gravatar/custom-domains/add-email-forward tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: user_id: type: integer domain: type: string mailbox: type: string destination: type: string required: - user_id - domain - mailbox - destination /wpcom/v2/gravatar/custom-domains/delete-email-forward: delete: operationId: deleteWpcomV2GravatarCustomDomainsDeleteEmailForward summary: DELETE /wpcom/v2/gravatar/custom-domains/delete-email-forward tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: user_id in: query required: true schema: type: integer - name: domain in: query required: true schema: type: string - name: mailbox in: query required: true schema: type: string - name: destination in: query required: true schema: type: string /wpcom/v2/gravatar/custom-domains/email-forwards: get: operationId: getWpcomV2GravatarCustomDomainsEmailForwards summary: GET /wpcom/v2/gravatar/custom-domains/email-forwards tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: user_id in: query required: true schema: type: integer - name: domain in: query required: true schema: type: string /wpcom/v2/gravatar/custom-domains/purchase: get: operationId: getWpcomV2GravatarCustomDomainsPurchase summary: GET /wpcom/v2/gravatar/custom-domains/purchase tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: domain in: query required: true schema: type: string - name: user_id in: query required: true schema: type: integer /wpcom/v2/gravatar/custom-domains/set-auto-renew: post: operationId: postWpcomV2GravatarCustomDomainsSetAutoRenew summary: POST /wpcom/v2/gravatar/custom-domains/set-auto-renew tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: domain: type: string type: type: string user_id: type: integer subscription_id: type: integer required: - domain - type - user_id - subscription_id put: operationId: putWpcomV2GravatarCustomDomainsSetAutoRenew summary: PUT /wpcom/v2/gravatar/custom-domains/set-auto-renew tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: domain: type: string type: type: string user_id: type: integer subscription_id: type: integer required: - domain - type - user_id - subscription_id patch: operationId: patchWpcomV2GravatarCustomDomainsSetAutoRenew summary: PATCH /wpcom/v2/gravatar/custom-domains/set-auto-renew tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: domain: type: string type: type: string user_id: type: integer subscription_id: type: integer required: - domain - type - user_id - subscription_id /wpcom/v2/gravatar/custom-domains/set-email-forward: post: operationId: postWpcomV2GravatarCustomDomainsSetEmailForward summary: POST /wpcom/v2/gravatar/custom-domains/set-email-forward tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: user_id: type: integer domain: type: string mailbox: type: string destination: type: string type: type: string required: - user_id - domain - mailbox - destination - type put: operationId: putWpcomV2GravatarCustomDomainsSetEmailForward summary: PUT /wpcom/v2/gravatar/custom-domains/set-email-forward tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: user_id: type: integer domain: type: string mailbox: type: string destination: type: string type: type: string required: - user_id - domain - mailbox - destination - type patch: operationId: patchWpcomV2GravatarCustomDomainsSetEmailForward summary: PATCH /wpcom/v2/gravatar/custom-domains/set-email-forward tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: user_id: type: integer domain: type: string mailbox: type: string destination: type: string type: type: string required: - user_id - domain - mailbox - destination - type /wpcom/v2/gravatar/custom-domains/update-email-forward: post: operationId: postWpcomV2GravatarCustomDomainsUpdateEmailForward summary: POST /wpcom/v2/gravatar/custom-domains/update-email-forward tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: user_id: type: integer domain: type: string mailbox: type: string destination: type: string new_destination: type: string is_active: type: boolean required: - user_id - domain - mailbox - destination - new_destination - is_active put: operationId: putWpcomV2GravatarCustomDomainsUpdateEmailForward summary: PUT /wpcom/v2/gravatar/custom-domains/update-email-forward tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: user_id: type: integer domain: type: string mailbox: type: string destination: type: string new_destination: type: string is_active: type: boolean required: - user_id - domain - mailbox - destination - new_destination - is_active patch: operationId: patchWpcomV2GravatarCustomDomainsUpdateEmailForward summary: PATCH /wpcom/v2/gravatar/custom-domains/update-email-forward tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: user_id: type: integer domain: type: string mailbox: type: string destination: type: string new_destination: type: string is_active: type: boolean required: - user_id - domain - mailbox - destination - new_destination - is_active /wpcom/v2/gravatar/developers/applications: post: operationId: postWpcomV2GravatarDevelopersApplications summary: POST /wpcom/v2/gravatar/developers/applications tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: user_id: type: integer title: type: string description: type: string organization_name: type: string organization_website: type: string required: - user_id - title - description - organization_name - organization_website get: operationId: getWpcomV2GravatarDevelopersApplications summary: GET /wpcom/v2/gravatar/developers/applications tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: user_id in: query required: true schema: type: integer /wpcom/v2/gravatar/developers/applications/count: get: operationId: getWpcomV2GravatarDevelopersApplicationsCount summary: GET /wpcom/v2/gravatar/developers/applications/count tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/gravatar/developers/applications/{app_id}: delete: operationId: deleteWpcomV2GravatarDevelopersApplicationsbyAppId summary: DELETE /wpcom/v2/gravatar/developers/applications/{app_id} tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: app_id in: path required: true schema: type: string - name: user_id in: query required: true schema: type: integer get: operationId: getWpcomV2GravatarDevelopersApplicationsbyAppId summary: GET /wpcom/v2/gravatar/developers/applications/{app_id} tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: app_id in: path required: true schema: type: string post: operationId: postWpcomV2GravatarDevelopersApplicationsbyAppId summary: POST /wpcom/v2/gravatar/developers/applications/{app_id} tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: app_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: title: type: string description: type: string organization_name: type: string organization_website: type: string redirect_urls: type: array items: {} javascript_origins: type: array items: {} type: type: string user_id: type: integer icon: type: string put: operationId: putWpcomV2GravatarDevelopersApplicationsbyAppId summary: PUT /wpcom/v2/gravatar/developers/applications/{app_id} tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: app_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: title: type: string description: type: string organization_name: type: string organization_website: type: string redirect_urls: type: array items: {} javascript_origins: type: array items: {} type: type: string user_id: type: integer icon: type: string patch: operationId: patchWpcomV2GravatarDevelopersApplicationsbyAppId summary: PATCH /wpcom/v2/gravatar/developers/applications/{app_id} tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: app_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: title: type: string description: type: string organization_name: type: string organization_website: type: string redirect_urls: type: array items: {} javascript_origins: type: array items: {} type: type: string user_id: type: integer icon: type: string /wpcom/v2/gravatar/developers/applications/{app_id}/reset-secret: post: operationId: postWpcomV2GravatarDevelopersApplicationsbyAppIdResetSecret summary: POST /wpcom/v2/gravatar/developers/applications/{app_id}/reset-secret tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: app_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: user_id: type: integer required: - user_id put: operationId: putWpcomV2GravatarDevelopersApplicationsbyAppIdResetSecret summary: PUT /wpcom/v2/gravatar/developers/applications/{app_id}/reset-secret tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: app_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: user_id: type: integer required: - user_id patch: operationId: patchWpcomV2GravatarDevelopersApplicationsbyAppIdResetSecret summary: PATCH /wpcom/v2/gravatar/developers/applications/{app_id}/reset-secret tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: app_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: user_id: type: integer required: - user_id /wpcom/v2/gravatar/emails-blocklist: get: operationId: getWpcomV2GravatarEmailsBlocklist summary: GET /wpcom/v2/gravatar/emails-blocklist tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: emails in: query required: true schema: type: array items: type: string description: List of emails delete: operationId: deleteWpcomV2GravatarEmailsBlocklist summary: DELETE /wpcom/v2/gravatar/emails-blocklist tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: emails in: query required: true schema: type: array items: type: string description: List of emails /wpcom/v2/gravatar/stats/recently-visited-profiles: get: operationId: getWpcomV2GravatarStatsRecentlyVisitedProfiles summary: GET /wpcom/v2/gravatar/stats/recently-visited-profiles tags: - gravatar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: limit in: query required: false schema: type: integer default: 1000 - name: minutes_back in: query required: false schema: type: integer default: 60 /wpcom/v2/gutenberg/core-server-block-settings: get: operationId: getWpcomV2GutenbergCoreServerBlockSettings summary: GET /wpcom/v2/gutenberg/core-server-block-settings tags: - gutenberg responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/gutenpen/patterns: get: operationId: getWpcomV2GutenpenPatterns summary: GET /wpcom/v2/gutenpen/patterns tags: - gutenpen responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/gutenpen/post-content: post: operationId: postWpcomV2GutenpenPostContent summary: POST /wpcom/v2/gutenpen/post-content tags: - gutenpen responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: post_id: type: integer description: The source post ID from the Atomic site. post_content: type: string description: The post content to store. post_title: type: string description: The post title to store. collection: type: string description: The pattern collection to assign. required: - post_id - post_content - post_title - collection /wpcom/v2/gutenpen/post-content/{post_id}: delete: operationId: deleteWpcomV2GutenpenPostContentbyPostId summary: DELETE /wpcom/v2/gutenpen/post-content/{post_id} tags: - gutenpen responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: post_id in: path required: true schema: type: string /wpcom/v2/help/article: get: operationId: getWpcomV2HelpArticle summary: GET /wpcom/v2/help/article tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: post_url in: query required: true schema: type: string /wpcom/v2/help/article/{blog_id}/{post_id}: get: operationId: getWpcomV2HelpArticlebyBlogIdbyPostId summary: GET /wpcom/v2/help/article/{blog_id}/{post_id} tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: blog_id in: path required: true schema: type: string - name: post_id in: path required: true schema: type: string /wpcom/v2/help/articles: get: operationId: getWpcomV2HelpArticles summary: GET /wpcom/v2/help/articles tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: blog_id in: query required: true schema: type: number - name: post_ids in: query required: true schema: type: array items: type: string /wpcom/v2/help/authenticate/chat: post: operationId: postWpcomV2HelpAuthenticateChat summary: POST /wpcom/v2/help/authenticate/chat tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: type: type: string test_mode: type: boolean required: - type /wpcom/v2/help/courses: get: operationId: getWpcomV2HelpCourses summary: GET /wpcom/v2/help/courses tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/help/csat: post: operationId: postWpcomV2HelpCsat summary: POST /wpcom/v2/help/csat tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: ticket_id: type: string score: type: string enum: - good - bad comment: type: string reason_id: type: string test_mode: type: boolean required: - ticket_id - score /wpcom/v2/help/cta: get: operationId: getWpcomV2HelpCta summary: GET /wpcom/v2/help/cta tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/help/forum/new: post: operationId: postWpcomV2HelpForumNew summary: POST /wpcom/v2/help/forum/new tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: subject: type: string message: type: string blog_url: type: string blog_id: type: integer tags: type: array default: [] items: {} locale: type: string hide_blog_info: type: boolean default: false should_use_test_forums: type: boolean required: - subject - message /wpcom/v2/help/messaging/is-available: get: operationId: getWpcomV2HelpMessagingIsAvailable summary: GET /wpcom/v2/help/messaging/is-available tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: group in: query required: true schema: type: string - name: environment in: query required: true schema: type: string /wpcom/v2/help/migration-ticket/new: post: operationId: postWpcomV2HelpMigrationTicketNew summary: POST /wpcom/v2/help/migration-ticket/new tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: locale: type: string default: en blog_url: type: string from_url: type: string context: type: string description: Additional context to add to the ticket. required: - blog_url - from_url /wpcom/v2/help/migration-ticket/site-info: post: operationId: postWpcomV2HelpMigrationTicketSiteInfo summary: POST /wpcom/v2/help/migration-ticket/site-info tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: source_username: type: string description: The username to use for the credentials migration. source_password: type: string description: The password to use for the credentials migration. source_url: type: string description: The URL of the source blog or a backup to migrate from. required: - source_url /wpcom/v2/help/migration-ticket/stickers: post: operationId: postWpcomV2HelpMigrationTicketStickers summary: POST /wpcom/v2/help/migration-ticket/stickers tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: stickers: type: array items: type: string blog_id: type: integer required: - blog_id /wpcom/v2/help/search: get: operationId: getWpcomV2HelpSearch summary: GET /wpcom/v2/help/search tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: query in: query required: true schema: type: string description: Search term - name: locale in: query required: false schema: type: string default: en description: User language - name: section in: query required: false schema: type: string description: UI section - name: source in: query required: false schema: type: string description: Source of the search /wpcom/v2/help/search/forums: get: operationId: getWpcomV2HelpSearchForums summary: GET /wpcom/v2/help/search/forums tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: query in: query required: true schema: type: string description: Search term - name: locale in: query required: false schema: type: string default: en description: User language /wpcom/v2/help/search/wpcom: get: operationId: getWpcomV2HelpSearchWpcom summary: GET /wpcom/v2/help/search/wpcom tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: query in: query required: true schema: type: string description: Search term - name: locale in: query required: false schema: type: string default: en description: User language - name: section in: query required: false schema: type: string description: UI section /wpcom/v2/help/sibyl: get: operationId: getWpcomV2HelpSibyl summary: GET /wpcom/v2/help/sibyl tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: query in: query required: true schema: type: string description: Search term - name: source in: query required: false schema: type: string default: wpcom description: wpcom or jpop /wpcom/v2/help/support-status: get: operationId: getWpcomV2HelpSupportStatus summary: GET /wpcom/v2/help/support-status tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/help/support-status/messaging: get: operationId: getWpcomV2HelpSupportStatusMessaging summary: GET /wpcom/v2/help/support-status/messaging tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: group in: query required: true schema: type: string enum: - jp_presales - wpcom_messaging - wpcom_presales - woo_messaging - name: environment in: query required: true schema: type: string enum: - production - development /wpcom/v2/help/ticket/new: post: operationId: postWpcomV2HelpTicketNew summary: POST /wpcom/v2/help/ticket/new tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: subject: type: string message: type: string locale: type: string default: en is_chat_overflow: type: boolean default: false source: type: string blog_url: type: string ai_chat_id: type: string ai_message: type: string required: - subject - message /wpcom/v2/help/wpe-migration-ticket/new: post: operationId: postWpcomV2HelpWpeMigrationTicketNew summary: POST /wpcom/v2/help/wpe-migration-ticket/new tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: locale: type: string default: en site_url: type: string email: type: string required: - site_url - email /wpcom/v2/help/zendesk/ai: get: operationId: getWpcomV2HelpZendeskAi summary: GET /wpcom/v2/help/zendesk/ai tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: blog_id in: query required: true schema: type: integer - name: email in: query required: false schema: type: string - name: query in: query required: true schema: type: string /wpcom/v2/help/zendesk/update-user-fields: post: operationId: postWpcomV2HelpZendeskUpdateUserFields summary: POST /wpcom/v2/help/zendesk/update-user-fields tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: fields: type: object required: - fields put: operationId: putWpcomV2HelpZendeskUpdateUserFields summary: PUT /wpcom/v2/help/zendesk/update-user-fields tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: fields: type: object required: - fields patch: operationId: patchWpcomV2HelpZendeskUpdateUserFields summary: PATCH /wpcom/v2/help/zendesk/update-user-fields tags: - help responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: fields: type: object required: - fields /wpcom/v2/host-partners: get: operationId: getWpcomV2HostPartners summary: GET /wpcom/v2/host-partners tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: atomic_client_id in: query required: false schema: type: integer description: When supplied by a proxied Automattician, scopes the response to the given client. Ignored for non-Automattician callers. /wpcom/v2/host-partners/for/{client_id}/metrics/site/{site}: post: operationId: postWpcomV2HostPartnersForbyClientIdMetricsSitebySite summary: POST /wpcom/v2/host-partners/for/{client_id}/metrics/site/{site} tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: client_id in: path required: true schema: type: string - name: site in: path required: true schema: type: string /wpcom/v2/host-partners/for/{client_id}/site-meta/{site}/{key}: get: operationId: getWpcomV2HostPartnersForbyClientIdSiteMetabySitebyKey summary: GET /wpcom/v2/host-partners/for/{client_id}/site-meta/{site}/{key} tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: client_id in: path required: true schema: type: string - name: site in: path required: true schema: type: string - name: key in: path required: true schema: type: string /wpcom/v2/host-partners/jetpack/licenses: get: operationId: getWpcomV2HostPartnersJetpackLicenses summary: GET /wpcom/v2/host-partners/jetpack/licenses tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: page in: query required: false schema: type: integer default: 1 - name: per_page in: query required: false schema: type: integer default: 50 - name: order_by in: query required: false schema: type: string enum: - issued_at - attached_at - revoked_at - product_id default: issued_at - name: order in: query required: false schema: type: string enum: - asc - desc default: desc - name: filters in: query required: false schema: type: object /wpcom/v2/host-partners/jetpack/{license_key}: delete: operationId: deleteWpcomV2HostPartnersJetpackbyLicenseKey summary: DELETE /wpcom/v2/host-partners/jetpack/{license_key} tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: license_key in: path required: true schema: type: string /wpcom/v2/host-partners/members: get: operationId: getWpcomV2HostPartnersMembers summary: GET /wpcom/v2/host-partners/members tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: client_id in: query required: false schema: type: integer /wpcom/v2/host-partners/members/invite: post: operationId: postWpcomV2HostPartnersMembersInvite summary: POST /wpcom/v2/host-partners/members/invite tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: client_id: type: integer login: type: string role: type: string message: type: string required: - login - role /wpcom/v2/host-partners/members/invites/mine: get: operationId: getWpcomV2HostPartnersMembersInvitesMine summary: GET /wpcom/v2/host-partners/members/invites/mine tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/host-partners/members/invites/{invite_id}: delete: operationId: deleteWpcomV2HostPartnersMembersInvitesbyInviteId summary: DELETE /wpcom/v2/host-partners/members/invites/{invite_id} tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: invite_id in: path required: true schema: type: string - name: client_id in: query required: false schema: type: integer /wpcom/v2/host-partners/members/invites/{invite_id}/accept: post: operationId: postWpcomV2HostPartnersMembersInvitesbyInviteIdAccept summary: POST /wpcom/v2/host-partners/members/invites/{invite_id}/accept tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: invite_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: client_id: type: integer secret: type: string required: - client_id - secret /wpcom/v2/host-partners/members/invites/{invite_id}/claim: post: operationId: postWpcomV2HostPartnersMembersInvitesbyInviteIdClaim summary: POST /wpcom/v2/host-partners/members/invites/{invite_id}/claim tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: invite_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: client_id: type: integer required: - client_id /wpcom/v2/host-partners/members/{user_id}: delete: operationId: deleteWpcomV2HostPartnersMembersbyUserId summary: DELETE /wpcom/v2/host-partners/members/{user_id} tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: user_id in: path required: true schema: type: string - name: client_id in: query required: false schema: type: integer post: operationId: postWpcomV2HostPartnersMembersbyUserId summary: POST /wpcom/v2/host-partners/members/{user_id} tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: user_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: client_id: type: integer role: type: string required: - role put: operationId: putWpcomV2HostPartnersMembersbyUserId summary: PUT /wpcom/v2/host-partners/members/{user_id} tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: user_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: client_id: type: integer role: type: string required: - role patch: operationId: patchWpcomV2HostPartnersMembersbyUserId summary: PATCH /wpcom/v2/host-partners/members/{user_id} tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: user_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: client_id: type: integer role: type: string required: - role /wpcom/v2/host-partners/metrics/site/{site}: post: operationId: postWpcomV2HostPartnersMetricsSitebySite summary: POST /wpcom/v2/host-partners/metrics/site/{site} tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: site in: path required: true schema: type: string /wpcom/v2/host-partners/payment-method: delete: operationId: deleteWpcomV2HostPartnersPaymentMethod summary: DELETE /wpcom/v2/host-partners/payment-method tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: payment_method_id in: query required: true schema: type: string description: The Stripe PaymentMethodId that should be detached. post: operationId: postWpcomV2HostPartnersPaymentMethod summary: POST /wpcom/v2/host-partners/payment-method tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: payment_method_id: type: string description: The Stripe payment method ID that should be attached to the customer. use_as_primary_payment_method: type: boolean default: false description: Set this payment method as default for the customer. stripe_setup_intent_id: type: string default: '' description: The Stripe Setup Intent id for the payment method. required: - payment_method_id /wpcom/v2/host-partners/payment-methods: get: operationId: getWpcomV2HostPartnersPaymentMethods summary: GET /wpcom/v2/host-partners/payment-methods tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/host-partners/site-meta/{site}/{key}: get: operationId: getWpcomV2HostPartnersSiteMetabySitebyKey summary: GET /wpcom/v2/host-partners/site-meta/{site}/{key} tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: site in: path required: true schema: type: string - name: key in: path required: true schema: type: string /wpcom/v2/host-partners/wpcloud: post: operationId: postWpcomV2HostPartnersWpcloud summary: POST /wpcom/v2/host-partners/wpcloud tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: first_name: type: string description: First name of the host partner. last_name: type: string description: Last name of the host partner. business_name: type: string description: Business name of the host partner. business_type: type: string description: Business type of the host partner (e.g. host, agency...). Fixed Values. business_description: type: string description: User-provided description of the business type. hosting_method: type: string description: The method by which the host partner provides hosting (e.g., own infrastructure, 3rd party). consider_migrating: type: string description: Will the host partner consider migrating sites to WP Cloud. num_migrations: type: string description: How many sites will be migrated, if any. Not required. which_web_panel: type: string description: Which web panel the prospective partner uses, if any. Not required. which_web_panel_other: type: string description: Which other web panel the prospective partner uses, if any. Not required. anything_else: type: string description: Anything goes. The user can add whatever text theyd like here. lead_source: type: string description: Answer to How did you hear about us? wp_sites_management_count: type: string description: The number of WordPress sites managed by the host partner. interest_in_wpcloud: type: string description: The user-provided reason for the interest in WP Cloud. url: type: string description: URL associated with the host partner. email: type: string description: Email associated with the host partner. team_email: type: string description: Email alias to reach the partner team. ip_allowlist: type: string description: Plain text field listing one or more IP addresses or CIDR ranges. accepted_tos: type: boolean description: True if the TOS was accepted. accepted_pricing: type: boolean description: Date when pricing was last accepted. accepted_removal_subjection: type: boolean description: Date when removal subjection was last accepted. accepted_email_subscription: type: boolean description: The user consented to join the email newsletter. signed_contract: type: boolean description: Date when the contract was last signed. /wpcom/v2/host-partners/wpcloud/api-access: post: operationId: postWpcomV2HostPartnersWpcloudApiAccess summary: POST /wpcom/v2/host-partners/wpcloud/api-access tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: first_name: type: string last_name: type: string email: type: string format: email ip_addresses: type: string required: - first_name - last_name - email - ip_addresses /wpcom/v2/host-partners/wpcloud/api-keys: get: operationId: getWpcomV2HostPartnersWpcloudApiKeys summary: GET /wpcom/v2/host-partners/wpcloud/api-keys tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: client_id in: query required: false schema: type: integer /wpcom/v2/host-partners/wpcloud/api-keys/action: post: operationId: postWpcomV2HostPartnersWpcloudApiKeysAction summary: POST /wpcom/v2/host-partners/wpcloud/api-keys/action tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: client_id: type: integer action: type: string key_name: type: string endpoints: type: array items: {} ip_ranges: type: array items: {} add_endpoints: type: array items: {} remove_endpoints: type: array items: {} add_ip_ranges: type: array items: {} remove_ip_ranges: type: array items: {} verification_token: type: string required: - action - verification_token /wpcom/v2/host-partners/wpcloud/api-keys/mfa: get: operationId: getWpcomV2HostPartnersWpcloudApiKeysMfa summary: GET /wpcom/v2/host-partners/wpcloud/api-keys/mfa tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: client_id in: query required: false schema: type: integer /wpcom/v2/host-partners/wpcloud/api-keys/mfa/start: post: operationId: postWpcomV2HostPartnersWpcloudApiKeysMfaStart summary: POST /wpcom/v2/host-partners/wpcloud/api-keys/mfa/start tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: client_id: type: integer return_url: type: string intent: type: object required: - return_url /wpcom/v2/host-partners/wpcloud/api-keys/mfa/validate: post: operationId: postWpcomV2HostPartnersWpcloudApiKeysMfaValidate summary: POST /wpcom/v2/host-partners/wpcloud/api-keys/mfa/validate tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: client_id: type: integer code: type: string verification_token: type: string /wpcom/v2/host-partners/wpcloud/billing: get: operationId: getWpcomV2HostPartnersWpcloudBilling summary: GET /wpcom/v2/host-partners/wpcloud/billing tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/host-partners/wpcloud/billing/invoices: get: operationId: getWpcomV2HostPartnersWpcloudBillingInvoices summary: GET /wpcom/v2/host-partners/wpcloud/billing/invoices tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: page in: query required: false schema: type: string default: '1' /wpcom/v2/host-partners/wpcloud/billing/invoices/{invoice_id}/payment: post: operationId: postWpcomV2HostPartnersWpcloudBillingInvoicesbyInvoiceIdPayment summary: POST /wpcom/v2/host-partners/wpcloud/billing/invoices/{invoice_id}/payment tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: invoice_id in: path required: true schema: type: string /wpcom/v2/host-partners/wpcloud/billing/invoices/{invoice_id}/usage-report: get: operationId: getWpcomV2HostPartnersWpcloudBillingInvoicesbyInvoiceIdUsageReport summary: GET /wpcom/v2/host-partners/wpcloud/billing/invoices/{invoice_id}/usage-report tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: invoice_id in: path required: true schema: type: string /wpcom/v2/host-partners/wpcloud/clients: get: operationId: getWpcomV2HostPartnersWpcloudClients summary: GET /wpcom/v2/host-partners/wpcloud/clients tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/host-partners/wpcloud/inventory: get: operationId: getWpcomV2HostPartnersWpcloudInventory summary: GET /wpcom/v2/host-partners/wpcloud/inventory tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: page in: query required: false schema: type: integer default: 1 - name: per_page in: query required: false schema: type: integer default: 10 - name: order_by in: query required: false schema: type: string enum: - atomic_site_id - domain_name default: atomic_site_id - name: order in: query required: false schema: type: string enum: - asc - desc default: asc - name: s in: query required: false schema: type: string description: Search term to filter results. /wpcom/v2/host-partners/wpcloud/news: get: operationId: getWpcomV2HostPartnersWpcloudNews summary: GET /wpcom/v2/host-partners/wpcloud/news tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/host-partners/wpcloud/onboarding: get: operationId: getWpcomV2HostPartnersWpcloudOnboarding summary: GET /wpcom/v2/host-partners/wpcloud/onboarding tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2HostPartnersWpcloudOnboarding summary: POST /wpcom/v2/host-partners/wpcloud/onboarding tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: key: type: string required: - key /wpcom/v2/host-partners/wpcloud/pricing: get: operationId: getWpcomV2HostPartnersWpcloudPricing summary: GET /wpcom/v2/host-partners/wpcloud/pricing tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: site in: query required: true schema: type: object - name: count in: query required: true schema: type: integer /wpcom/v2/host-partners/wpcloud/pricing/simple: get: operationId: getWpcomV2HostPartnersWpcloudPricingSimple summary: GET /wpcom/v2/host-partners/wpcloud/pricing/simple tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/host-partners/wpcloud/stripe/configuration: get: operationId: getWpcomV2HostPartnersWpcloudStripeConfiguration summary: GET /wpcom/v2/host-partners/wpcloud/stripe/configuration tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/host-partners/wpcloud/stripe/setup-intent: get: operationId: getWpcomV2HostPartnersWpcloudStripeSetupIntent summary: GET /wpcom/v2/host-partners/wpcloud/stripe/setup-intent tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/host-partners/wpcloud/support: post: operationId: postWpcomV2HostPartnersWpcloudSupport summary: POST /wpcom/v2/host-partners/wpcloud/support tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: body: type: string subject: type: string user_name: type: string user_email: type: string partner_name: type: string attachment: type: string required: - body - subject - user_name - user_email - partner_name /wpcom/v2/host-partners/wpcloud/usage: get: operationId: getWpcomV2HostPartnersWpcloudUsage summary: GET /wpcom/v2/host-partners/wpcloud/usage tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: granularity in: query required: false schema: type: string enum: - day - month default: month /wpcom/v2/host-partners/wpcloud/warden/events: get: operationId: getWpcomV2HostPartnersWpcloudWardenEvents summary: GET /wpcom/v2/host-partners/wpcloud/warden/events tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: client_id in: query required: false schema: type: integer - name: page in: query required: false schema: type: integer default: 1 - name: per_page in: query required: false schema: type: integer default: 25 - name: min_indicator in: query required: false schema: type: string enum: - watch - alert - critical default: watch /wpcom/v2/host-partners/wpcloud/{wpcom_user_id}: delete: operationId: deleteWpcomV2HostPartnersWpcloudbyWpcomUserId summary: DELETE /wpcom/v2/host-partners/wpcloud/{wpcom_user_id} tags: - host-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_user_id in: path required: true schema: type: string /wpcom/v2/hosting/github/accounts: post: operationId: postWpcomV2HostingGithubAccounts summary: POST /wpcom/v2/hosting/github/accounts tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: access_token: type: string required: - access_token /wpcom/v2/hosting/github/app-authorize: get: operationId: getWpcomV2HostingGithubAppAuthorize summary: GET /wpcom/v2/hosting/github/app-authorize tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: redirect_uri in: query required: false schema: type: string - name: ux_mode in: query required: false schema: type: string default: popup - name: scope in: query required: false schema: type: string default: read:user,user:email /wpcom/v2/hosting/github/app-callback: get: operationId: getWpcomV2HostingGithubAppCallback summary: GET /wpcom/v2/hosting/github/app-callback tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: code in: query required: false schema: type: string - name: setup_action in: query required: false schema: type: string enum: - authorize - request - install - update - name: installation_id in: query required: false schema: type: integer - name: error in: query required: false schema: type: string - name: error_description in: query required: false schema: type: string - name: error_uri in: query required: false schema: type: string - name: state in: query required: false schema: type: string /wpcom/v2/hosting/github/app-install: get: operationId: getWpcomV2HostingGithubAppInstall summary: GET /wpcom/v2/hosting/github/app-install tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/hosting/github/app-webhook: post: operationId: postWpcomV2HostingGithubAppWebhook summary: POST /wpcom/v2/hosting/github/app-webhook tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/hosting/github/installations: get: operationId: getWpcomV2HostingGithubInstallations summary: GET /wpcom/v2/hosting/github/installations tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/hosting/github/repositories: get: operationId: getWpcomV2HostingGithubRepositories summary: GET /wpcom/v2/hosting/github/repositories tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: installation_id in: query required: true schema: type: number description: The installation ID of the GitHub App. /wpcom/v2/hosting/github/repository/branches: get: operationId: getWpcomV2HostingGithubRepositoryBranches summary: GET /wpcom/v2/hosting/github/repository/branches tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: installation_id in: query required: true schema: type: integer - name: repository_owner in: query required: true schema: type: string - name: repository_name in: query required: true schema: type: string /wpcom/v2/hosting/github/repository/pre-connect-checks: get: operationId: getWpcomV2HostingGithubRepositoryPreConnectChecks summary: GET /wpcom/v2/hosting/github/repository/pre-connect-checks tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: installation_id in: query required: true schema: type: integer - name: repository_owner in: query required: true schema: type: string - name: repository_name in: query required: true schema: type: string - name: repository_branch in: query required: true schema: type: string /wpcom/v2/hosting/github/workflow-templates: get: operationId: getWpcomV2HostingGithubWorkflowTemplates summary: GET /wpcom/v2/hosting/github/workflow-templates tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: template in: query required: true schema: type: string enum: - simple - with_composer - name: branch_name in: query required: true schema: type: string /wpcom/v2/hosting/github/workflows: get: operationId: getWpcomV2HostingGithubWorkflows summary: GET /wpcom/v2/hosting/github/workflows tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: repository_name in: query required: true schema: type: string - name: repository_owner in: query required: true schema: type: string - name: branch_name in: query required: true schema: type: string post: operationId: postWpcomV2HostingGithubWorkflows summary: POST /wpcom/v2/hosting/github/workflows tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: repository_owner: type: string repository_name: type: string branch_name: type: string workflow_template: type: string enum: - simple - with_composer required: - repository_owner - repository_name - branch_name - workflow_template /wpcom/v2/hosting/github/workflows/checks: get: operationId: getWpcomV2HostingGithubWorkflowsChecks summary: GET /wpcom/v2/hosting/github/workflows/checks tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: repository_name in: query required: true schema: type: string - name: repository_owner in: query required: true schema: type: string - name: branch_name in: query required: true schema: type: string - name: workflow_filename in: query required: true schema: type: string /wpcom/v2/iap/notification: post: operationId: postWpcomV2IapNotification summary: POST /wpcom/v2/iap/notification tags: - iap responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/iap/orders: get: operationId: getWpcomV2IapOrders summary: GET /wpcom/v2/iap/orders tags: - iap responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: site_id in: query required: false schema: type: integer description: Site ID post: operationId: postWpcomV2IapOrders summary: POST /wpcom/v2/iap/orders tags: - iap responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: product_id: type: string description: Product ID price: type: integer description: Product Price appstore_country: type: string description: Country of the customer's AppStore currency: type: string description: Currency of the customer's purchase original_transaction_id: type: string description: Apple original transaction ID transaction_id: type: string description: Apple transaction ID purchase_token: type: string description: Google Play Purchase Token site_id: type: integer description: Site ID required: - product_id - price /wpcom/v2/iap/products: get: operationId: getWpcomV2IapProducts summary: GET /wpcom/v2/iap/products tags: - iap responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: site_id in: query required: false schema: type: integer description: Site ID /wpcom/v2/imports/url-analyzer/images: get: operationId: getWpcomV2ImportsUrlAnalyzerImages summary: GET /wpcom/v2/imports/url-analyzer/images tags: - imports responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: url in: query required: true schema: type: string description: The address of the URL to analyze - name: cache in: query required: false schema: type: boolean default: true description: User internal cache for results. /wpcom/v2/imports/url-analyzer/multiple: get: operationId: getWpcomV2ImportsUrlAnalyzerMultiple summary: GET /wpcom/v2/imports/url-analyzer/multiple tags: - imports responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: url in: query required: true schema: type: string description: The address of the URL to analyze - name: cache in: query required: false schema: type: boolean default: true description: User internal cache for results. /wpcom/v2/introductory-offers: get: operationId: getWpcomV2IntroductoryOffers summary: GET /wpcom/v2/introductory-offers tags: - introductory-offers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: site in: query required: false schema: type: number description: Site ID - name: currency in: query required: false schema: type: string description: Currency code - name: product_slugs in: query required: false schema: type: string description: Product Slugs /wpcom/v2/jetpack-about: get: operationId: getWpcomV2JetpackAbout summary: GET /wpcom/v2/jetpack-about tags: - jetpack-about responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-agency/contacts: post: operationId: postWpcomV2JetpackAgencyContacts summary: POST /wpcom/v2/jetpack-agency/contacts tags: - jetpack-agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: type: type: string enum: - sms - email value: type: string site_ids: type: array items: {} number: type: string country_code: type: string country_numeric_code: type: string required: - type - value - site_ids get: operationId: getWpcomV2JetpackAgencyContacts summary: GET /wpcom/v2/jetpack-agency/contacts tags: - jetpack-agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-agency/contacts/resend-verification: post: operationId: postWpcomV2JetpackAgencyContactsResendVerification summary: POST /wpcom/v2/jetpack-agency/contacts/resend-verification tags: - jetpack-agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: type: type: string enum: - sms - email value: type: string required: - type - value /wpcom/v2/jetpack-agency/contacts/verify: post: operationId: postWpcomV2JetpackAgencyContactsVerify summary: POST /wpcom/v2/jetpack-agency/contacts/verify tags: - jetpack-agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: type: type: string enum: - sms - email value: type: string verification_code: type: integer required: - type - value - verification_code /wpcom/v2/jetpack-agency/provisioning-sites: get: operationId: getWpcomV2JetpackAgencyProvisioningSites summary: GET /wpcom/v2/jetpack-agency/provisioning-sites tags: - jetpack-agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-agency/sites: get: operationId: getWpcomV2JetpackAgencySites summary: GET /wpcom/v2/jetpack-agency/sites tags: - jetpack-agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: backup_failed in: query required: false schema: {} - name: backup_warning in: query required: false schema: {} - name: threats_found in: query required: false schema: {} - name: site_down in: query required: false schema: {} - name: site_disconnected in: query required: false schema: {} - name: plugin_updates in: query required: false schema: {} - name: not_multisite in: query required: false schema: {} - name: all_issues in: query required: false schema: {} - name: sort_field in: query required: false schema: {} - name: sort_direction in: query required: false schema: {} - name: added_within_days in: query required: false schema: type: integer /wpcom/v2/jetpack-agency/sites/boost-scores: post: operationId: postWpcomV2JetpackAgencySitesBoostScores summary: POST /wpcom/v2/jetpack-agency/sites/boost-scores tags: - jetpack-agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: site_ids: type: array items: {} required: - site_ids /wpcom/v2/jetpack-agency/sites/favorite: post: operationId: postWpcomV2JetpackAgencySitesFavorite summary: POST /wpcom/v2/jetpack-agency/sites/favorite tags: - jetpack-agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: site_id: type: string required: - site_id delete: operationId: deleteWpcomV2JetpackAgencySitesFavorite summary: DELETE /wpcom/v2/jetpack-agency/sites/favorite tags: - jetpack-agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: site_id in: query required: true schema: type: string /wpcom/v2/jetpack-agency/sites/plugins/install: post: operationId: postWpcomV2JetpackAgencySitesPluginsInstall summary: POST /wpcom/v2/jetpack-agency/sites/plugins/install tags: - jetpack-agency responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: site_id: type: string plugin_slug: type: string required: - site_id - plugin_slug /wpcom/v2/jetpack-ai-image: get: operationId: getWpcomV2JetpackAiImage summary: GET /wpcom/v2/jetpack-ai-image tags: - jetpack-ai-image responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: background in: query required: false schema: type: string description: The background color of the image. - name: prompt in: query required: false schema: type: string description: A prompt describing the image requested to the OpenAI service. - name: model in: query required: false schema: type: string default: dall-e-3 description: The model to be used. - name: size in: query required: false schema: type: string description: The image resolution. - name: quantity in: query required: false schema: type: string description: The number of images. - name: n in: query required: false schema: type: integer default: 1 description: The number of images. Up to 10 - name: quality in: query required: false schema: type: string default: auto description: The image quality. - name: output_format in: query required: false schema: type: string default: png description: The output format of the image. - name: response_format in: query required: false schema: type: string default: b64_json description: The expected response format. Stable Diffusion only supports b64_json. - name: feature in: query required: false schema: type: string description: The feature to use for logging requests. - name: image_format in: query required: false schema: type: string default: PNG description: The output format of the image. - name: session_id in: query required: false schema: type: string description: Session ID for logging purposes. - name: style in: query required: false schema: type: string description: The style of the image, when generating using Stable Diffusion or FLUX. - name: messages in: query required: false schema: type: string description: The JSON-encoded list of messages to be completed by the OpenAI service. - name: token in: query required: true schema: type: string description: The JWT token to authenticate the request. post: operationId: postWpcomV2JetpackAiImage summary: POST /wpcom/v2/jetpack-ai-image tags: - jetpack-ai-image responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: background: type: string description: The background color of the image. prompt: type: string description: A prompt describing the image requested to the OpenAI service. model: type: string default: dall-e-3 description: The model to be used. size: type: string description: The image resolution. quantity: type: string description: The number of images. n: type: integer default: 1 description: The number of images. Up to 10 quality: type: string default: auto description: The image quality. output_format: type: string default: png description: The output format of the image. response_format: type: string default: b64_json description: The expected response format. Stable Diffusion only supports b64_json. feature: type: string description: The feature to use for logging requests. image_format: type: string default: PNG description: The output format of the image. session_id: type: string description: Session ID for logging purposes. style: type: string description: The style of the image, when generating using Stable Diffusion or FLUX. messages: type: array items: {} description: The list of messages to be completed by the OpenAI service. put: operationId: putWpcomV2JetpackAiImage summary: PUT /wpcom/v2/jetpack-ai-image tags: - jetpack-ai-image responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: background: type: string description: The background color of the image. prompt: type: string description: A prompt describing the image requested to the OpenAI service. model: type: string default: dall-e-3 description: The model to be used. size: type: string description: The image resolution. quantity: type: string description: The number of images. n: type: integer default: 1 description: The number of images. Up to 10 quality: type: string default: auto description: The image quality. output_format: type: string default: png description: The output format of the image. response_format: type: string default: b64_json description: The expected response format. Stable Diffusion only supports b64_json. feature: type: string description: The feature to use for logging requests. image_format: type: string default: PNG description: The output format of the image. session_id: type: string description: Session ID for logging purposes. style: type: string description: The style of the image, when generating using Stable Diffusion or FLUX. messages: type: array items: {} description: The list of messages to be completed by the OpenAI service. patch: operationId: patchWpcomV2JetpackAiImage summary: PATCH /wpcom/v2/jetpack-ai-image tags: - jetpack-ai-image responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: background: type: string description: The background color of the image. prompt: type: string description: A prompt describing the image requested to the OpenAI service. model: type: string default: dall-e-3 description: The model to be used. size: type: string description: The image resolution. quantity: type: string description: The number of images. n: type: integer default: 1 description: The number of images. Up to 10 quality: type: string default: auto description: The image quality. output_format: type: string default: png description: The output format of the image. response_format: type: string default: b64_json description: The expected response format. Stable Diffusion only supports b64_json. feature: type: string description: The feature to use for logging requests. image_format: type: string default: PNG description: The output format of the image. session_id: type: string description: Session ID for logging purposes. style: type: string description: The style of the image, when generating using Stable Diffusion or FLUX. messages: type: array items: {} description: The list of messages to be completed by the OpenAI service. /wpcom/v2/jetpack-ai-query: get: operationId: getWpcomV2JetpackAiQuery summary: GET /wpcom/v2/jetpack-ai-query tags: - jetpack-ai-query responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: question in: query required: false schema: type: string description: A prompt to be completed by the OpenAI service. - name: model in: query required: false schema: type: string description: The model to be used. - name: post_id in: query required: false schema: type: integer description: The post_id for the post where the completion will be used. - name: session_id in: query required: false schema: type: string description: Session ID for logging purposes. - name: feature in: query required: false schema: type: string description: The feature to use for logging completions. - name: functions in: query required: false schema: type: array items: {} description: 'DEPRECATED: The function signatures for the Function Calling OpenAI feature.' - name: tools in: query required: false schema: type: array items: {} description: The function signatures for the Function Calling OpenAI feature. - name: stream in: query required: false schema: type: boolean default: true description: If the response should be streamed or not. - name: response_format in: query required: false schema: type: string default: text description: The expected response format. - name: max_tokens in: query required: false schema: type: integer description: The maximum amount of tokens to generate on the output. Beware of model limitations. - name: store in: query required: false schema: type: boolean description: Whether to store the completion in OpenAI. - name: parallel_tool_calls in: query required: false schema: type: boolean description: Whether to use parallel tool calls. - name: language_code in: query required: false schema: type: string description: The language code to use for the response. - name: messages in: query required: false schema: type: string description: The JSON-encoded list of messages to be completed by the OpenAI service. - name: token in: query required: true schema: type: string description: The JWT token to authenticate the request. post: operationId: postWpcomV2JetpackAiQuery summary: POST /wpcom/v2/jetpack-ai-query tags: - jetpack-ai-query responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: question: type: string description: A prompt to be completed by the OpenAI service. model: type: string description: The model to be used. post_id: type: integer description: The post_id for the post where the completion will be used. session_id: type: string description: Session ID for logging purposes. feature: type: string description: The feature to use for logging completions. functions: type: array items: {} description: 'DEPRECATED: The function signatures for the Function Calling OpenAI feature.' tools: type: array items: {} description: The function signatures for the Function Calling OpenAI feature. stream: type: boolean default: true description: If the response should be streamed or not. response_format: type: string default: text description: The expected response format. max_tokens: type: integer description: The maximum amount of tokens to generate on the output. Beware of model limitations. store: type: boolean description: Whether to store the completion in OpenAI. parallel_tool_calls: type: boolean description: Whether to use parallel tool calls. language_code: type: string description: The language code to use for the response. messages: type: array items: {} description: The JSON-encoded list of messages to be completed by the OpenAI service. put: operationId: putWpcomV2JetpackAiQuery summary: PUT /wpcom/v2/jetpack-ai-query tags: - jetpack-ai-query responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: question: type: string description: A prompt to be completed by the OpenAI service. model: type: string description: The model to be used. post_id: type: integer description: The post_id for the post where the completion will be used. session_id: type: string description: Session ID for logging purposes. feature: type: string description: The feature to use for logging completions. functions: type: array items: {} description: 'DEPRECATED: The function signatures for the Function Calling OpenAI feature.' tools: type: array items: {} description: The function signatures for the Function Calling OpenAI feature. stream: type: boolean default: true description: If the response should be streamed or not. response_format: type: string default: text description: The expected response format. max_tokens: type: integer description: The maximum amount of tokens to generate on the output. Beware of model limitations. store: type: boolean description: Whether to store the completion in OpenAI. parallel_tool_calls: type: boolean description: Whether to use parallel tool calls. language_code: type: string description: The language code to use for the response. messages: type: array items: {} description: The JSON-encoded list of messages to be completed by the OpenAI service. patch: operationId: patchWpcomV2JetpackAiQuery summary: PATCH /wpcom/v2/jetpack-ai-query tags: - jetpack-ai-query responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: question: type: string description: A prompt to be completed by the OpenAI service. model: type: string description: The model to be used. post_id: type: integer description: The post_id for the post where the completion will be used. session_id: type: string description: Session ID for logging purposes. feature: type: string description: The feature to use for logging completions. functions: type: array items: {} description: 'DEPRECATED: The function signatures for the Function Calling OpenAI feature.' tools: type: array items: {} description: The function signatures for the Function Calling OpenAI feature. stream: type: boolean default: true description: If the response should be streamed or not. response_format: type: string default: text description: The expected response format. max_tokens: type: integer description: The maximum amount of tokens to generate on the output. Beware of model limitations. store: type: boolean description: Whether to store the completion in OpenAI. parallel_tool_calls: type: boolean description: Whether to use parallel tool calls. language_code: type: string description: The language code to use for the response. messages: type: array items: {} description: The JSON-encoded list of messages to be completed by the OpenAI service. /wpcom/v2/jetpack-ai-transcription: post: operationId: postWpcomV2JetpackAiTranscription summary: POST /wpcom/v2/jetpack-ai-transcription tags: - jetpack-ai-transcription responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: feature: type: string description: The feature requesting the transcription. token: type: string description: The JWT token to authenticate the request, may be present on the URL or on the authorization header. audio_file: type: string description: The audio file to be transcribed into a message. put: operationId: putWpcomV2JetpackAiTranscription summary: PUT /wpcom/v2/jetpack-ai-transcription tags: - jetpack-ai-transcription responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: feature: type: string description: The feature requesting the transcription. token: type: string description: The JWT token to authenticate the request, may be present on the URL or on the authorization header. audio_file: type: string description: The audio file to be transcribed into a message. patch: operationId: patchWpcomV2JetpackAiTranscription summary: PATCH /wpcom/v2/jetpack-ai-transcription tags: - jetpack-ai-transcription responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: feature: type: string description: The feature requesting the transcription. token: type: string description: The JWT token to authenticate the request, may be present on the URL or on the authorization header. audio_file: type: string description: The audio file to be transcribed into a message. /wpcom/v2/jetpack-boost-proxy/health-check: get: operationId: getWpcomV2JetpackBoostProxyHealthCheck summary: GET /wpcom/v2/jetpack-boost-proxy/health-check tags: - jetpack-boost-proxy responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: _boost_api_url in: query required: false schema: type: string /wpcom/v2/jetpack-boost-proxy/health-check-auth: get: operationId: getWpcomV2JetpackBoostProxyHealthCheckAuth summary: GET /wpcom/v2/jetpack-boost-proxy/health-check-auth tags: - jetpack-boost-proxy responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: _boost_api_url in: query required: false schema: type: string /wpcom/v2/jetpack-boost-proxy/service-payload: get: operationId: getWpcomV2JetpackBoostProxyServicePayload summary: GET /wpcom/v2/jetpack-boost-proxy/service-payload tags: - jetpack-boost-proxy responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: blog in: query required: true schema: {} - name: service in: query required: true schema: {} /wpcom/v2/jetpack-boost-proxy/{version}metrics: post: operationId: postWpcomV2JetpackBoostProxybyVersionMetrics summary: POST /wpcom/v2/jetpack-boost-proxy/{version}metrics tags: - jetpack-boost-proxy responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: version in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: _boost_api_url: type: string async: type: boolean successCallback: type: object errorCallback: type: object url: type: string type: type: string strategy: type: string metrics: type: object viewport: type: object requestHeaders: type: object verify: type: string tags: type: array items: {} required: - url - viewport /wpcom/v2/jetpack-licensing/dev-licenses: get: operationId: getWpcomV2JetpackLicensingDevLicenses summary: GET /wpcom/v2/jetpack-licensing/dev-licenses tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-licensing/jetpack-crm/license: get: operationId: getWpcomV2JetpackLicensingJetpackCrmLicense summary: GET /wpcom/v2/jetpack-licensing/jetpack-crm/license tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: license_key in: query required: true schema: {} /wpcom/v2/jetpack-licensing/license: get: operationId: getWpcomV2JetpackLicensingLicense summary: GET /wpcom/v2/jetpack-licensing/license tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: license_key in: query required: true schema: {} post: operationId: postWpcomV2JetpackLicensingLicense summary: POST /wpcom/v2/jetpack-licensing/license tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: product: {} quantity: type: integer default: 1 required: - product delete: operationId: deleteWpcomV2JetpackLicensingLicense summary: DELETE /wpcom/v2/jetpack-licensing/license tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: license_key in: query required: true schema: {} - name: cancellation_email in: query required: false schema: type: string /wpcom/v2/jetpack-licensing/license/{license_key}/children: get: operationId: getWpcomV2JetpackLicensingLicensebyLicenseKeyChildren summary: GET /wpcom/v2/jetpack-licensing/license/{license_key}/children tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: license_key in: path required: true schema: type: string /wpcom/v2/jetpack-licensing/license/{license_key}/download: get: operationId: getWpcomV2JetpackLicensingLicensebyLicenseKeyDownload summary: GET /wpcom/v2/jetpack-licensing/license/{license_key}/download tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: license_key in: path required: true schema: type: string /wpcom/v2/jetpack-licensing/license/{license_key}/site: post: operationId: postWpcomV2JetpackLicensingLicensebyLicenseKeySite summary: POST /wpcom/v2/jetpack-licensing/license/{license_key}/site tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: license_key in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: site: type: string required: - site delete: operationId: deleteWpcomV2JetpackLicensingLicensebyLicenseKeySite summary: DELETE /wpcom/v2/jetpack-licensing/license/{license_key}/site tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: license_key in: path required: true schema: type: string /wpcom/v2/jetpack-licensing/licenses: get: operationId: getWpcomV2JetpackLicensingLicenses summary: GET /wpcom/v2/jetpack-licensing/licenses tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: page in: query required: false schema: {} - name: per_page in: query required: false schema: {} - name: search in: query required: false schema: type: string - name: parent_id in: query required: false schema: type: integer - name: filter in: query required: false schema: {} - name: sort_field in: query required: false schema: {} - name: sort_direction in: query required: false schema: {} post: operationId: postWpcomV2JetpackLicensingLicenses summary: POST /wpcom/v2/jetpack-licensing/licenses tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: product: {} quantity: type: integer bundle: type: boolean required: - product - quantity - bundle /wpcom/v2/jetpack-licensing/licenses/billing: get: operationId: getWpcomV2JetpackLicensingLicensesBilling summary: GET /wpcom/v2/jetpack-licensing/licenses/billing tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-licensing/licenses/counts: get: operationId: getWpcomV2JetpackLicensingLicensesCounts summary: GET /wpcom/v2/jetpack-licensing/licenses/counts tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-licensing/partner: get: operationId: getWpcomV2JetpackLicensingPartner summary: GET /wpcom/v2/jetpack-licensing/partner tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2JetpackLicensingPartner summary: POST /wpcom/v2/jetpack-licensing/partner tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: tos: type: string name: type: string contact_person: type: string company_website: type: string company_type: type: string country: type: string state: type: string line1: type: string line2: type: string postal_code: type: string city: type: string managed_sites: type: string partner_program_opt_in: type: boolean referrer: {} required: - tos - name put: operationId: putWpcomV2JetpackLicensingPartner summary: PUT /wpcom/v2/jetpack-licensing/partner tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: tos: type: string name: type: string contact_person: type: string company_website: type: string company_type: type: string country: type: string state: type: string line1: type: string line2: type: string postal_code: type: string city: type: string managed_sites: type: string partner_program_opt_in: type: boolean referrer: {} /wpcom/v2/jetpack-licensing/partner/invoice/{invoice_id}/payment: post: operationId: postWpcomV2JetpackLicensingPartnerInvoicebyInvoiceIdPayment summary: POST /wpcom/v2/jetpack-licensing/partner/invoice/{invoice_id}/payment tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: invoice_id in: path required: true schema: type: string /wpcom/v2/jetpack-licensing/partner/invoices: get: operationId: getWpcomV2JetpackLicensingPartnerInvoices summary: GET /wpcom/v2/jetpack-licensing/partner/invoices tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: starting_after in: query required: false schema: type: string default: '' description: A cursor for use in pagination. It is an object ID that defines your place in the list. - name: ending_before in: query required: false schema: type: string default: '' description: A cursor for use in pagination. It is an object ID that defines your place in the list. - name: status in: query required: false schema: type: string default: '' description: Set this if you want results to be filtered by their status. /wpcom/v2/jetpack-licensing/partner/product-families: get: operationId: getWpcomV2JetpackLicensingPartnerProductFamilies summary: GET /wpcom/v2/jetpack-licensing/partner/product-families tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-licensing/product-families: get: operationId: getWpcomV2JetpackLicensingProductFamilies summary: GET /wpcom/v2/jetpack-licensing/product-families tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-licensing/public/manage-pricing: get: operationId: getWpcomV2JetpackLicensingPublicManagePricing summary: GET /wpcom/v2/jetpack-licensing/public/manage-pricing tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-licensing/site-connection: post: operationId: postWpcomV2JetpackLicensingSiteConnection summary: POST /wpcom/v2/jetpack-licensing/site-connection tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: url: {} local_user: {} required: - url - local_user /wpcom/v2/jetpack-licensing/stripe/payment-method: post: operationId: postWpcomV2JetpackLicensingStripePaymentMethod summary: POST /wpcom/v2/jetpack-licensing/stripe/payment-method tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: payment_method_id: type: string description: The Stripe payment method ID that should be attached to the customer. use_as_primary_payment_method: type: boolean default: false description: Set this payment method as default for the customer. stripe_setup_intent_id: type: string default: '' description: The Stripe Setup Intent id for the payment method. required: - payment_method_id delete: operationId: deleteWpcomV2JetpackLicensingStripePaymentMethod summary: DELETE /wpcom/v2/jetpack-licensing/stripe/payment-method tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: payment_method_id in: query required: true schema: type: string description: The Stripe payment method ID that should be detached. - name: primary_payment_method_id in: query required: false schema: type: string description: The Stripe payment method ID that should be set as a primary. /wpcom/v2/jetpack-licensing/stripe/payment-methods: get: operationId: getWpcomV2JetpackLicensingStripePaymentMethods summary: GET /wpcom/v2/jetpack-licensing/stripe/payment-methods tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: starting_after in: query required: false schema: type: string description: A cursor for use in pagination. It is an object ID that defines your place in the list. - name: ending_before in: query required: false schema: type: string description: A cursor for use in pagination. It is an object ID that defines your place in the list. /wpcom/v2/jetpack-licensing/user/licenses: get: operationId: getWpcomV2JetpackLicensingUserLicenses summary: GET /wpcom/v2/jetpack-licensing/user/licenses tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-licensing/user/licenses/counts: get: operationId: getWpcomV2JetpackLicensingUserLicensesCounts summary: GET /wpcom/v2/jetpack-licensing/user/licenses/counts tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-licensing/user/order/{order_id}: get: operationId: getWpcomV2JetpackLicensingUserOrderbyOrderId summary: GET /wpcom/v2/jetpack-licensing/user/order/{order_id} tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: order_id in: path required: true schema: type: string /wpcom/v2/jetpack-licensing/user/receipt/{receipt_id}: get: operationId: getWpcomV2JetpackLicensingUserReceiptbyReceiptId summary: GET /wpcom/v2/jetpack-licensing/user/receipt/{receipt_id} tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: receipt_id in: path required: true schema: type: string /wpcom/v2/jetpack-licensing/user/subscription/{subscription_id}: get: operationId: getWpcomV2JetpackLicensingUserSubscriptionbySubscriptionId summary: GET /wpcom/v2/jetpack-licensing/user/subscription/{subscription_id} tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: subscription_id in: path required: true schema: type: string /wpcom/v2/jetpack-licensing/vendasta/provision-or-deprovision/{product_id}: post: operationId: postWpcomV2JetpackLicensingVendastaProvisionOrDeprovisionbyProductId summary: POST /wpcom/v2/jetpack-licensing/vendasta/provision-or-deprovision/{product_id} tags: - jetpack-licensing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: product_id in: path required: true schema: type: string /wpcom/v2/jetpack-manage/site: post: operationId: postWpcomV2JetpackManageSite summary: POST /wpcom/v2/jetpack-manage/site tags: - jetpack-manage responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: url: type: string format: uri required: - url /wpcom/v2/jetpack-manage/user-feedback: post: operationId: postWpcomV2JetpackManageUserFeedback summary: POST /wpcom/v2/jetpack-manage/user-feedback tags: - jetpack-manage responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: source_url: type: string rating: type: integer feedback: type: string required: - source_url - rating - feedback /wpcom/v2/jetpack-marketing/jetpack-menu: get: operationId: getWpcomV2JetpackMarketingJetpackMenu summary: GET /wpcom/v2/jetpack-marketing/jetpack-menu tags: - jetpack-marketing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-marketing/sale-coupon: get: operationId: getWpcomV2JetpackMarketingSaleCoupon summary: GET /wpcom/v2/jetpack-marketing/sale-coupon tags: - jetpack-marketing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-partner/coupon/v1/coupon: get: operationId: getWpcomV2JetpackPartnerCouponV1Coupon summary: GET /wpcom/v2/jetpack-partner/coupon/v1/coupon tags: - jetpack-partner responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: coupon_code in: query required: true schema: type: string post: operationId: postWpcomV2JetpackPartnerCouponV1Coupon summary: POST /wpcom/v2/jetpack-partner/coupon/v1/coupon tags: - jetpack-partner responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: preset: type: string required: - preset delete: operationId: deleteWpcomV2JetpackPartnerCouponV1Coupon summary: DELETE /wpcom/v2/jetpack-partner/coupon/v1/coupon tags: - jetpack-partner responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: coupon_code in: query required: true schema: type: string /wpcom/v2/jetpack-partner/coupon/v1/coupons: post: operationId: postWpcomV2JetpackPartnerCouponV1Coupons summary: POST /wpcom/v2/jetpack-partner/coupon/v1/coupons tags: - jetpack-partner responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: preset: type: string quantity: type: integer required: - preset - quantity get: operationId: getWpcomV2JetpackPartnerCouponV1Coupons summary: GET /wpcom/v2/jetpack-partner/coupon/v1/coupons tags: - jetpack-partner responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: coupon_codes in: query required: true schema: type: array items: type: string /wpcom/v2/jetpack-partner/coupon/v1/presets: get: operationId: getWpcomV2JetpackPartnerCouponV1Presets summary: GET /wpcom/v2/jetpack-partner/coupon/v1/presets tags: - jetpack-partner responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-partners: get: operationId: getWpcomV2JetpackPartners summary: GET /wpcom/v2/jetpack-partners tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: all in: query required: false schema: type: boolean default: false post: operationId: postWpcomV2JetpackPartners summary: POST /wpcom/v2/jetpack-partners tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' put: operationId: putWpcomV2JetpackPartners summary: PUT /wpcom/v2/jetpack-partners tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' patch: operationId: patchWpcomV2JetpackPartners summary: PATCH /wpcom/v2/jetpack-partners tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-partners/activations: get: operationId: getWpcomV2JetpackPartnersActivations summary: GET /wpcom/v2/jetpack-partners/activations tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: key_id in: query required: false schema: type: string - name: scale in: query required: false schema: type: string default: month /wpcom/v2/jetpack-partners/capabilities: get: operationId: getWpcomV2JetpackPartnersCapabilities summary: GET /wpcom/v2/jetpack-partners/capabilities tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-partners/{partner_id}: get: operationId: getWpcomV2JetpackPartnersbyPartnerId summary: GET /wpcom/v2/jetpack-partners/{partner_id} tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string /wpcom/v2/jetpack-partners/{partner_id}/key: post: operationId: postWpcomV2JetpackPartnersbyPartnerIdKey summary: POST /wpcom/v2/jetpack-partners/{partner_id}/key tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string put: operationId: putWpcomV2JetpackPartnersbyPartnerIdKey summary: PUT /wpcom/v2/jetpack-partners/{partner_id}/key tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string patch: operationId: patchWpcomV2JetpackPartnersbyPartnerIdKey summary: PATCH /wpcom/v2/jetpack-partners/{partner_id}/key tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}: get: operationId: getWpcomV2JetpackPartnersbyPartnerIdKeybyKeyId summary: GET /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id} tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string post: operationId: postWpcomV2JetpackPartnersbyPartnerIdKeybyKeyId summary: POST /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id} tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string put: operationId: putWpcomV2JetpackPartnersbyPartnerIdKeybyKeyId summary: PUT /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id} tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string patch: operationId: patchWpcomV2JetpackPartnersbyPartnerIdKeybyKeyId summary: PATCH /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id} tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/activation/{activation_id}: delete: operationId: deleteWpcomV2JetpackPartnersbyPartnerIdKeybyKeyIdActivationbyActivationId summary: DELETE /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/activation/{activation_id} tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string - name: activation_id in: path required: true schema: type: string /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/activations: get: operationId: getWpcomV2JetpackPartnersbyPartnerIdKeybyKeyIdActivations summary: GET /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/activations tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string - name: page in: query required: false schema: type: integer default: 1 - name: per_page in: query required: false schema: type: integer default: 20 - name: plans in: query required: false schema: type: array items: {} - name: activated_after in: query required: false schema: type: string - name: activated_before in: query required: false schema: type: string /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/disable: post: operationId: postWpcomV2JetpackPartnersbyPartnerIdKeybyKeyIdDisable summary: POST /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/disable tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string put: operationId: putWpcomV2JetpackPartnersbyPartnerIdKeybyKeyIdDisable summary: PUT /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/disable tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string patch: operationId: patchWpcomV2JetpackPartnersbyPartnerIdKeybyKeyIdDisable summary: PATCH /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/disable tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/enable: post: operationId: postWpcomV2JetpackPartnersbyPartnerIdKeybyKeyIdEnable summary: POST /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/enable tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string put: operationId: putWpcomV2JetpackPartnersbyPartnerIdKeybyKeyIdEnable summary: PUT /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/enable tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string patch: operationId: patchWpcomV2JetpackPartnersbyPartnerIdKeybyKeyIdEnable summary: PATCH /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/enable tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/stripe/invoices: get: operationId: getWpcomV2JetpackPartnersbyPartnerIdKeybyKeyIdStripeInvoices summary: GET /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/stripe/invoices tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/stripe/subscription: get: operationId: getWpcomV2JetpackPartnersbyPartnerIdKeybyKeyIdStripeSubscription summary: GET /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/stripe/subscription tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/stripe/upcoming-invoice: get: operationId: getWpcomV2JetpackPartnersbyPartnerIdKeybyKeyIdStripeUpcomingInvoice summary: GET /wpcom/v2/jetpack-partners/{partner_id}/key/{key_id}/stripe/upcoming-invoice tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string - name: key_id in: path required: true schema: type: string /wpcom/v2/jetpack-partners/{partner_id}/stripe/customer: get: operationId: getWpcomV2JetpackPartnersbyPartnerIdStripeCustomer summary: GET /wpcom/v2/jetpack-partners/{partner_id}/stripe/customer tags: - jetpack-partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: partner_id in: path required: true schema: type: string /wpcom/v2/jetpack-protect-global-stats: get: operationId: getWpcomV2JetpackProtectGlobalStats summary: GET /wpcom/v2/jetpack-protect-global-stats tags: - jetpack-protect-global-stats responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-protect-weak-password/{hash_prefix}: get: operationId: getWpcomV2JetpackProtectWeakPasswordbyHashPrefix summary: GET /wpcom/v2/jetpack-protect-weak-password/{hash_prefix} tags: - jetpack-protect-weak-password responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: hash_prefix in: path required: true schema: type: string /wpcom/v2/jetpack-search/pricing: get: operationId: getWpcomV2JetpackSearchPricing summary: GET /wpcom/v2/jetpack-search/pricing tags: - jetpack-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: record_count in: query required: false schema: type: integer default: 0 description: Record count to estimate pricing - name: search_request_count in: query required: false schema: type: integer default: 0 description: Search request count to estimate pricing - name: locale in: query required: false schema: {} description: (string) Locale for translating strings in response data - name: currency in: query required: false schema: {} description: (string) Manually request currency code of response. /wpcom/v2/jetpack-start-webhooks/stripe: post: operationId: postWpcomV2JetpackStartWebhooksStripe summary: POST /wpcom/v2/jetpack-start-webhooks/stripe tags: - jetpack-start-webhooks responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jetpack-user-attributes: get: operationId: getWpcomV2JetpackUserAttributes summary: GET /wpcom/v2/jetpack-user-attributes tags: - jetpack-user-attributes responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: attributes in: query required: true schema: type: array items: type: string description: The list of user attributes to fetch. /wpcom/v2/jetpack-user-tracking: get: operationId: getWpcomV2JetpackUserTracking summary: GET /wpcom/v2/jetpack-user-tracking tags: - jetpack-user-tracking responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2JetpackUserTracking summary: POST /wpcom/v2/jetpack-user-tracking tags: - jetpack-user-tracking responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: tracks_opt_out: type: boolean put: operationId: putWpcomV2JetpackUserTracking summary: PUT /wpcom/v2/jetpack-user-tracking tags: - jetpack-user-tracking responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: tracks_opt_out: type: boolean patch: operationId: patchWpcomV2JetpackUserTracking summary: PATCH /wpcom/v2/jetpack-user-tracking tags: - jetpack-user-tracking responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: tracks_opt_out: type: boolean /wpcom/v2/jetpack/stripe/configuration: get: operationId: getWpcomV2JetpackStripeConfiguration summary: GET /wpcom/v2/jetpack/stripe/configuration tags: - jetpack responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: needs_intent in: query required: false schema: type: boolean description: Will create a setup intent if true. /wpcom/v2/jetpack/support/user-chat-token: get: operationId: getWpcomV2JetpackSupportUserChatToken summary: GET /wpcom/v2/jetpack/support/user-chat-token tags: - jetpack responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jurassic-ninja/create-new-site-from-zip: post: operationId: postWpcomV2JurassicNinjaCreateNewSiteFromZip summary: POST /wpcom/v2/jurassic-ninja/create-new-site-from-zip tags: - jurassic-ninja responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: wordpress_version: type: string description: The WordPress version to be used. connected_site_id: type: integer /wpcom/v2/jurassic-ninja/delete: post: operationId: postWpcomV2JurassicNinjaDelete summary: POST /wpcom/v2/jurassic-ninja/delete tags: - jurassic-ninja responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: site_id: type: integer required: - site_id /wpcom/v2/jurassic-ninja/delete/all: post: operationId: postWpcomV2JurassicNinjaDeleteAll summary: POST /wpcom/v2/jurassic-ninja/delete/all tags: - jurassic-ninja responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jurassic-ninja/extend: post: operationId: postWpcomV2JurassicNinjaExtend summary: POST /wpcom/v2/jurassic-ninja/extend tags: - jurassic-ninja responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: domain: type: string api_token: type: string required: - domain - api_token /wpcom/v2/jurassic-ninja/list: get: operationId: getWpcomV2JurassicNinjaList summary: GET /wpcom/v2/jurassic-ninja/list tags: - jurassic-ninja responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/jurassic-ninja/status: get: operationId: getWpcomV2JurassicNinjaStatus summary: GET /wpcom/v2/jurassic-ninja/status tags: - jurassic-ninja responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: site_id in: query required: true schema: type: integer /wpcom/v2/jurassic-ninja/update-site-from-zip: post: operationId: postWpcomV2JurassicNinjaUpdateSiteFromZip summary: POST /wpcom/v2/jurassic-ninja/update-site-from-zip tags: - jurassic-ninja responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: site_id: type: integer wordpress_version: type: string description: The WordPress version to be used. required: - site_id put: operationId: putWpcomV2JurassicNinjaUpdateSiteFromZip summary: PUT /wpcom/v2/jurassic-ninja/update-site-from-zip tags: - jurassic-ninja responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: site_id: type: integer wordpress_version: type: string description: The WordPress version to be used. required: - site_id patch: operationId: patchWpcomV2JurassicNinjaUpdateSiteFromZip summary: PATCH /wpcom/v2/jurassic-ninja/update-site-from-zip tags: - jurassic-ninja responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: site_id: type: integer wordpress_version: type: string description: The WordPress version to be used. required: - site_id /wpcom/v2/jurassic-ninja/usage: get: operationId: getWpcomV2JurassicNinjaUsage summary: GET /wpcom/v2/jurassic-ninja/usage tags: - jurassic-ninja responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/lasagna/jwt/sign: post: operationId: postWpcomV2LasagnaJwtSign summary: POST /wpcom/v2/lasagna/jwt/sign tags: - lasagna responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: jwt_type: type: string payload: type: object required: - jwt_type - payload /wpcom/v2/legal: get: operationId: getWpcomV2Legal summary: GET /wpcom/v2/legal tags: - legal responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2Legal summary: POST /wpcom/v2/legal tags: - legal responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: action: type: string description: Action to perform on endpoint required: - action put: operationId: putWpcomV2Legal summary: PUT /wpcom/v2/legal tags: - legal responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: action: type: string description: Action to perform on endpoint required: - action patch: operationId: patchWpcomV2Legal summary: PATCH /wpcom/v2/legal tags: - legal responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: action: type: string description: Action to perform on endpoint required: - action /wpcom/v2/liked-posts: get: operationId: getWpcomV2LikedPosts summary: GET /wpcom/v2/liked-posts tags: - liked-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: count in: query required: false schema: type: integer - name: after in: query required: false schema: type: string /wpcom/v2/linear-solver/bridges: get: operationId: getWpcomV2LinearSolverBridges summary: GET /wpcom/v2/linear-solver/bridges tags: - linear-solver responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/linear-solver/bridges/heartbeat: post: operationId: postWpcomV2LinearSolverBridgesHeartbeat summary: POST /wpcom/v2/linear-solver/bridges/heartbeat tags: - linear-solver responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/linear-solver/github-webhook: post: operationId: postWpcomV2LinearSolverGithubWebhook summary: POST /wpcom/v2/linear-solver/github-webhook tags: - linear-solver responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' put: operationId: putWpcomV2LinearSolverGithubWebhook summary: PUT /wpcom/v2/linear-solver/github-webhook tags: - linear-solver responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' patch: operationId: patchWpcomV2LinearSolverGithubWebhook summary: PATCH /wpcom/v2/linear-solver/github-webhook tags: - linear-solver responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/linear-solver/health: get: operationId: getWpcomV2LinearSolverHealth summary: GET /wpcom/v2/linear-solver/health tags: - linear-solver responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/linear-solver/register-tunnel: post: operationId: postWpcomV2LinearSolverRegisterTunnel summary: POST /wpcom/v2/linear-solver/register-tunnel tags: - linear-solver responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' put: operationId: putWpcomV2LinearSolverRegisterTunnel summary: PUT /wpcom/v2/linear-solver/register-tunnel tags: - linear-solver responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' patch: operationId: patchWpcomV2LinearSolverRegisterTunnel summary: PATCH /wpcom/v2/linear-solver/register-tunnel tags: - linear-solver responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/linear-solver/runs: post: operationId: postWpcomV2LinearSolverRuns summary: POST /wpcom/v2/linear-solver/runs tags: - linear-solver responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' get: operationId: getWpcomV2LinearSolverRuns summary: GET /wpcom/v2/linear-solver/runs tags: - linear-solver responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/linear-solver/runs/{run_id}: get: operationId: getWpcomV2LinearSolverRunsbyRunId summary: GET /wpcom/v2/linear-solver/runs/{run_id} tags: - linear-solver responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: run_id in: path required: true schema: type: string /wpcom/v2/linear-solver/webhook: post: operationId: postWpcomV2LinearSolverWebhook summary: POST /wpcom/v2/linear-solver/webhook tags: - linear-solver responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' put: operationId: putWpcomV2LinearSolverWebhook summary: PUT /wpcom/v2/linear-solver/webhook tags: - linear-solver responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' patch: operationId: patchWpcomV2LinearSolverWebhook summary: PATCH /wpcom/v2/linear-solver/webhook tags: - linear-solver responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/linearmattic/webhook: post: operationId: postWpcomV2LinearmatticWebhook summary: POST /wpcom/v2/linearmattic/webhook tags: - linearmattic responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' put: operationId: putWpcomV2LinearmatticWebhook summary: PUT /wpcom/v2/linearmattic/webhook tags: - linearmattic responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' patch: operationId: patchWpcomV2LinearmatticWebhook summary: PATCH /wpcom/v2/linearmattic/webhook tags: - linearmattic responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/linearmattic/webhook/triagebot: post: operationId: postWpcomV2LinearmatticWebhookTriagebot summary: POST /wpcom/v2/linearmattic/webhook/triagebot tags: - linearmattic responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' put: operationId: putWpcomV2LinearmatticWebhookTriagebot summary: PUT /wpcom/v2/linearmattic/webhook/triagebot tags: - linearmattic responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' patch: operationId: patchWpcomV2LinearmatticWebhookTriagebot summary: PATCH /wpcom/v2/linearmattic/webhook/triagebot tags: - linearmattic responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/mapkit: get: operationId: getWpcomV2Mapkit summary: GET /wpcom/v2/mapkit tags: - mapkit responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/marketing/survey: post: operationId: postWpcomV2MarketingSurvey summary: POST /wpcom/v2/marketing/survey tags: - marketing responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: site_id: type: integer survey_id: type: string survey_responses: {} required: - site_id - survey_id - survey_responses /wpcom/v2/marketplace/jetpack-scan: post: operationId: postWpcomV2MarketplaceJetpackScan summary: POST /wpcom/v2/marketplace/jetpack-scan tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: signature: type: string description: The signature of the request signature_ts: type: number description: The timestamp used to sign the request required: - signature - signature_ts /wpcom/v2/marketplace/products: get: operationId: getWpcomV2MarketplaceProducts summary: GET /wpcom/v2/marketplace/products tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/marketplace/products/{id}: get: operationId: getWpcomV2MarketplaceProductsbyId summary: GET /wpcom/v2/marketplace/products/{id} tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string /wpcom/v2/marketplace/products/{slug}: get: operationId: getWpcomV2MarketplaceProductsbySlug summary: GET /wpcom/v2/marketplace/products/{slug} tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: slug in: path required: true schema: type: string post: operationId: postWpcomV2MarketplaceProductsbySlug summary: POST /wpcom/v2/marketplace/products/{slug} tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: slug in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: webhook_url: type: string description: The product webhook URL saas_landing_page: type: string description: The vendor landing page URL put: operationId: putWpcomV2MarketplaceProductsbySlug summary: PUT /wpcom/v2/marketplace/products/{slug} tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: slug in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: webhook_url: type: string description: The product webhook URL saas_landing_page: type: string description: The vendor landing page URL patch: operationId: patchWpcomV2MarketplaceProductsbySlug summary: PATCH /wpcom/v2/marketplace/products/{slug} tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: slug in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: webhook_url: type: string description: The product webhook URL saas_landing_page: type: string description: The vendor landing page URL /wpcom/v2/marketplace/vendor/billing-intent: post: operationId: postWpcomV2MarketplaceVendorBillingIntent summary: POST /wpcom/v2/marketplace/vendor/billing-intent tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: product_slug: type: string description: The slug of product to create billing intent for. blog_id: type: string description: The ID of the site this billing intent belongs to. user_id: type: string description: The ID of the user this billing intent belongs to. name: type: string description: The name of the product for billing intent. price: type: integer description: The price of product for charging user. billing_period: type: string enum: - month - year default: year description: The billing period for the billing intent. return_url: type: string format: uri description: The url where users will be redirected upon successful purchase of product required: - product_slug - blog_id - user_id - name - price /wpcom/v2/marketplace/vendor/billing-intent-siteless: post: operationId: postWpcomV2MarketplaceVendorBillingIntentSiteless summary: POST /wpcom/v2/marketplace/vendor/billing-intent-siteless tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: product_slug: type: string description: The accounting slug of product to create billing intent for. name: type: string description: The name of the product for the billing intent. price: type: integer description: The price for the billing intent. currency: type: string description: The currency for the billing intent. Defaults to 'USD'. billing_period: type: string enum: - month - year default: year description: The billing period for the billing intent. return_url: type: string format: uri description: The url where users will be redirected upon successful purchase of product required: - product_slug - name - price /wpcom/v2/marketplace/vendor/billing-intent/{intent_id}: get: operationId: getWpcomV2MarketplaceVendorBillingIntentbyIntentId summary: GET /wpcom/v2/marketplace/vendor/billing-intent/{intent_id} tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: intent_id in: path required: true schema: type: string /wpcom/v2/marketplace/vendor/schema: get: operationId: getWpcomV2MarketplaceVendorSchema summary: GET /wpcom/v2/marketplace/vendor/schema tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/marketplace/vendor/subscriptions: get: operationId: getWpcomV2MarketplaceVendorSubscriptions summary: GET /wpcom/v2/marketplace/vendor/subscriptions tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - 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: product_slug in: query required: false schema: type: string description: Limit results to those matching a product_slug. /wpcom/v2/marketplace/vendor/subscriptions/{ownership_id}: get: operationId: getWpcomV2MarketplaceVendorSubscriptionsbyOwnershipId summary: GET /wpcom/v2/marketplace/vendor/subscriptions/{ownership_id} tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: ownership_id in: path required: true schema: type: string /wpcom/v2/marketplace/vendor/subscriptions/{ownership_id}/addon: post: operationId: postWpcomV2MarketplaceVendorSubscriptionsbyOwnershipIdAddon summary: POST /wpcom/v2/marketplace/vendor/subscriptions/{ownership_id}/addon tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: ownership_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: name: type: string description: The name of the product for billing intent. price: type: integer description: The price of product for charging user. return_url: type: string format: uri description: The url where users will be redirected upon successful purchase of product required: - name - price /wpcom/v2/marketplace/vendor/subscriptions/{ownership_id}/cancel: post: operationId: postWpcomV2MarketplaceVendorSubscriptionsbyOwnershipIdCancel summary: POST /wpcom/v2/marketplace/vendor/subscriptions/{ownership_id}/cancel tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: ownership_id in: path required: true schema: type: string /wpcom/v2/marketplace/vendor/subscriptions/{wpcom_site}/{product_slug}: get: operationId: getWpcomV2MarketplaceVendorSubscriptionsbyWpcomSitebyProductSlug summary: GET /wpcom/v2/marketplace/vendor/subscriptions/{wpcom_site}/{product_slug} tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: product_slug in: path required: true schema: type: string /wpcom/v2/marketplace/vendor/webhooks: post: operationId: postWpcomV2MarketplaceVendorWebhooks summary: POST /wpcom/v2/marketplace/vendor/webhooks tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: webhook_url: type: string format: uri description: A webhook url for testing. event: type: string enum: - provision_license - subscription_cancelled - subscription_created - subscription_domain_changed - subscription_refunded - subscription_renewed default: subscription_created description: A subscription event type to request webhook. Default `subscription_created`. domain: type: string default: example.wordpress.com description: A test domain for testing. Default `example.wordpress.com`. product_slug: type: string default: product-slug description: A product slug for testing. Default `product-slug`. billing_cycle: type: string enum: - yearly - monthly default: yearly description: A billing cycle for testing. Default `yearly`. intent_id: type: integer description: The billing intent id for testing. required: - webhook_url /wpcom/v2/marketplace/{type}/updates: get: operationId: getWpcomV2MarketplacebyTypeUpdates summary: GET /wpcom/v2/marketplace/{type}/updates tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: type in: path required: true schema: type: string /wpcom/v2/me/blocks/sites: get: operationId: getWpcomV2MeBlocksSites summary: GET /wpcom/v2/me/blocks/sites tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: page in: query required: false schema: type: integer default: 1 - name: per_page in: query required: false schema: type: integer default: 100 /wpcom/v2/me/connections: get: operationId: getWpcomV2MeConnections summary: GET /wpcom/v2/me/connections tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: force_external_users_refetch in: query required: false schema: type: boolean default: false - name: force_connection_test in: query required: false schema: type: boolean default: false /wpcom/v2/me/connections/{token_id}: get: operationId: getWpcomV2MeConnectionsbyTokenId summary: GET /wpcom/v2/me/connections/{token_id} tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: token_id in: path required: true schema: type: string - name: force_external_users_refetch in: query required: false schema: type: boolean default: false - name: force_connection_test in: query required: false schema: type: boolean default: false delete: operationId: deleteWpcomV2MeConnectionsbyTokenId summary: DELETE /wpcom/v2/me/connections/{token_id} tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: token_id in: path required: true schema: type: string - name: force_external_users_refetch in: query required: false schema: type: boolean default: false - name: force_connection_test in: query required: false schema: type: boolean default: false /wpcom/v2/me/education-student-validation: post: operationId: postWpcomV2MeEducationStudentValidation summary: POST /wpcom/v2/me/education-student-validation tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: code: type: string description: Education student validation code. required: - code /wpcom/v2/me/following: get: operationId: getWpcomV2MeFollowing summary: GET /wpcom/v2/me/following tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: ignore_user_blogs in: query required: false schema: type: boolean default: false /wpcom/v2/me/following/recommendations: get: operationId: getWpcomV2MeFollowingRecommendations summary: GET /wpcom/v2/me/following/recommendations tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: number in: query required: false schema: type: number default: 5 /wpcom/v2/me/get-apps/send-download-sms: post: operationId: postWpcomV2MeGetAppsSendDownloadSms summary: POST /wpcom/v2/me/get-apps/send-download-sms tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/me/gutenberg: get: operationId: getWpcomV2MeGutenberg summary: GET /wpcom/v2/me/gutenberg tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2MeGutenberg summary: POST /wpcom/v2/me/gutenberg tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: editor: type: string platform: type: string required: - editor - platform put: operationId: putWpcomV2MeGutenberg summary: PUT /wpcom/v2/me/gutenberg tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: editor: type: string platform: type: string required: - editor - platform patch: operationId: patchWpcomV2MeGutenberg summary: PATCH /wpcom/v2/me/gutenberg tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: editor: type: string platform: type: string required: - editor - platform /wpcom/v2/me/legacy-contacts: get: operationId: getWpcomV2MeLegacyContacts summary: GET /wpcom/v2/me/legacy-contacts tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2MeLegacyContacts summary: POST /wpcom/v2/me/legacy-contacts tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: email: type: string format: email notes: type: string default: '' required: - email /wpcom/v2/me/legacy-contacts/{legacy_contact_id}: get: operationId: getWpcomV2MeLegacyContactsbyLegacyContactId summary: GET /wpcom/v2/me/legacy-contacts/{legacy_contact_id} tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: legacy_contact_id in: path required: true schema: type: string delete: operationId: deleteWpcomV2MeLegacyContactsbyLegacyContactId summary: DELETE /wpcom/v2/me/legacy-contacts/{legacy_contact_id} tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: legacy_contact_id in: path required: true schema: type: string /wpcom/v2/me/locale: get: operationId: getWpcomV2MeLocale summary: GET /wpcom/v2/me/locale tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2MeLocale summary: POST /wpcom/v2/me/locale tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: locale: type: string description: An updated locale. required: - locale put: operationId: putWpcomV2MeLocale summary: PUT /wpcom/v2/me/locale tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: locale: type: string description: An updated locale. required: - locale patch: operationId: patchWpcomV2MeLocale summary: PATCH /wpcom/v2/me/locale tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: locale: type: string description: An updated locale. required: - locale /wpcom/v2/me/preferences: get: operationId: getWpcomV2MePreferences summary: GET /wpcom/v2/me/preferences tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: preference_key in: query required: false schema: type: string description: A calypso preference key to retrieve the value of. If not provided, all preferences will be returned. post: operationId: postWpcomV2MePreferences summary: POST /wpcom/v2/me/preferences tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: calypso_preferences: type: object description: A calypso preferences subset to be merged with the existing preferences. required: - calypso_preferences put: operationId: putWpcomV2MePreferences summary: PUT /wpcom/v2/me/preferences tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: calypso_preferences: type: object description: A calypso preferences subset to be merged with the existing preferences. required: - calypso_preferences patch: operationId: patchWpcomV2MePreferences summary: PATCH /wpcom/v2/me/preferences tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: calypso_preferences: type: object description: A calypso preferences subset to be merged with the existing preferences. required: - calypso_preferences /wpcom/v2/me/profile: get: operationId: getWpcomV2MeProfile summary: GET /wpcom/v2/me/profile tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/me/sites/stats/summary: get: operationId: getWpcomV2MeSitesStatsSummary summary: GET /wpcom/v2/me/sites/stats/summary tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: offset in: query required: false schema: type: string description: Optional offset in hours to shift stats. Ints between -24 and 24 are allowed. - name: period in: query required: false schema: type: string default: day description: 'Duration of time units to report on. String: ''year'', ''month'', ''week'' or default ''day''.' - name: num in: query required: false schema: type: string default: 1 description: 'Number of periods to include in report. Counts backward from date parameter. For example: period=day, num=5, date=2023-06-06 would include 2023-06-02 00:00-2023-06-06 23:59.' - name: date in: query required: false schema: type: string description: End date of report in YYYY-MM-DD form. If blank, defaults to the current date right now in each blog's local time (this allows for different end dates per blog). - name: site_limit in: query required: false schema: type: string default: 75 description: Limit of how many sites to return. Defaults to 75. Max value allowed is 150. - name: site_offset in: query required: false schema: type: string default: 0 description: Offset of which sites to return. Default is 0. Use site_limit and site_offset together to paginate results. /wpcom/v2/me/ssh-keys: get: operationId: getWpcomV2MeSshKeys summary: GET /wpcom/v2/me/ssh-keys tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2MeSshKeys summary: POST /wpcom/v2/me/ssh-keys tags: - me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: key: type: string required: - key /wpcom/v2/me/ssh-keys/{name}: post: operationId: postWpcomV2MeSshKeysbyName summary: POST /wpcom/v2/me/ssh-keys/{name} tags: - me responses: '200': description: OK '401': description: 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: key: type: string required: - key put: operationId: putWpcomV2MeSshKeysbyName summary: PUT /wpcom/v2/me/ssh-keys/{name} tags: - me responses: '200': description: OK '401': description: 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: key: type: string required: - key patch: operationId: patchWpcomV2MeSshKeysbyName summary: PATCH /wpcom/v2/me/ssh-keys/{name} tags: - me responses: '200': description: OK '401': description: 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: key: type: string required: - key delete: operationId: deleteWpcomV2MeSshKeysbyName summary: DELETE /wpcom/v2/me/ssh-keys/{name} tags: - me responses: '200': description: OK '401': description: 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 /wpcom/v2/meta/external-media/connection/{service}: get: operationId: getWpcomV2MetaExternalMediaConnectionbyService summary: GET /wpcom/v2/meta/external-media/connection/{service} tags: - meta responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: service in: path required: true schema: type: string delete: operationId: deleteWpcomV2MetaExternalMediaConnectionbyService summary: DELETE /wpcom/v2/meta/external-media/connection/{service} tags: - meta responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: service in: path required: true schema: type: string /wpcom/v2/meta/external-media/connection/{service}/picker_status: get: operationId: getWpcomV2MetaExternalMediaConnectionbyServicePickerStatus summary: GET /wpcom/v2/meta/external-media/connection/{service}/picker_status tags: - meta responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: service in: path required: true schema: type: string /wpcom/v2/meta/external-media/proxy/{service}: post: operationId: postWpcomV2MetaExternalMediaProxybyService summary: POST /wpcom/v2/meta/external-media/proxy/{service} tags: - meta responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: service in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: url: type: string required: - url /wpcom/v2/meta/external-media/session/{service}: post: operationId: postWpcomV2MetaExternalMediaSessionbyService summary: POST /wpcom/v2/meta/external-media/session/{service} tags: - meta responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: service in: path required: true schema: type: string /wpcom/v2/meta/external-media/session/{service}/{session_id}: get: operationId: getWpcomV2MetaExternalMediaSessionbyServicebySessionId summary: GET /wpcom/v2/meta/external-media/session/{service}/{session_id} tags: - meta responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: service in: path required: true schema: type: string - name: session_id in: path required: true schema: type: string delete: operationId: deleteWpcomV2MetaExternalMediaSessionbyServicebySessionId summary: DELETE /wpcom/v2/meta/external-media/session/{service}/{session_id} tags: - meta responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: service in: path required: true schema: type: string - name: session_id in: path required: true schema: type: string /wpcom/v2/meta/external-media/{service}: get: operationId: getWpcomV2MetaExternalMediabyService summary: GET /wpcom/v2/meta/external-media/{service} tags: - meta responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: service in: path required: true schema: type: string - name: path in: query required: false schema: type: string default: '' - name: search in: query required: false schema: type: string - name: number in: query required: false schema: type: number - name: page_handle in: query required: false schema: type: string default: '' - name: session_id in: query required: false schema: type: string /wpcom/v2/migration-provider-notifications/{provider}/{mode}: post: operationId: postWpcomV2MigrationProviderNotificationsbyProviderbyMode summary: POST /wpcom/v2/migration-provider-notifications/{provider}/{mode} tags: - migration-provider-notifications responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: provider in: path required: true schema: type: string - name: mode in: path required: true schema: type: string /wpcom/v2/migration-provider-redirect/{provider}/{mode}: post: operationId: postWpcomV2MigrationProviderRedirectbyProviderbyMode summary: POST /wpcom/v2/migration-provider-redirect/{provider}/{mode} tags: - migration-provider-redirect responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: provider in: path required: true schema: type: string - name: mode in: path required: true schema: type: string /wpcom/v2/migrations/from-source/{source_blog_id}: post: operationId: postWpcomV2MigrationsFromSourcebySourceBlogId summary: POST /wpcom/v2/migrations/from-source/{source_blog_id} tags: - migrations responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: source_blog_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: target_blog_id: description: Blog ID of WordPress.com site we're migrating to required: - target_blog_id /wpcom/v2/migrations/from-source/{source_blog}: get: operationId: getWpcomV2MigrationsFromSourcebySourceBlog summary: GET /wpcom/v2/migrations/from-source/{source_blog} tags: - migrations responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: source_blog in: path required: true schema: type: string /wpcom/v2/mobile-support/attachments/{attachment_id}: get: operationId: getWpcomV2MobileSupportAttachmentsbyAttachmentId summary: GET /wpcom/v2/mobile-support/attachments/{attachment_id} tags: - mobile-support responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: attachment_id in: path required: true schema: type: string /wpcom/v2/mobile-support/conversations: get: operationId: getWpcomV2MobileSupportConversations summary: GET /wpcom/v2/mobile-support/conversations tags: - mobile-support responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2MobileSupportConversations summary: POST /wpcom/v2/mobile-support/conversations tags: - mobile-support responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: subject: type: string description: The subject of the conversation. message: type: string description: The message to add to the chat application: type: string enum: - woocommerce - wordpress - jetpack description: The application that is creating the conversation. wpcom_site_id: type: integer description: The WordPress.com site ID that the conversation relates to. tags: type: object description: An application-specified set of tags to add to the conversation. encrypted_log_ids: type: array items: type: string description: An array of encrypted log IDs to attach to the conversation. required: - subject - message - application /wpcom/v2/mobile-support/conversations/{conversation_id}: get: operationId: getWpcomV2MobileSupportConversationsbyConversationId summary: GET /wpcom/v2/mobile-support/conversations/{conversation_id} tags: - mobile-support responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: conversation_id in: path required: true schema: type: string post: operationId: postWpcomV2MobileSupportConversationsbyConversationId summary: POST /wpcom/v2/mobile-support/conversations/{conversation_id} tags: - mobile-support responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: conversation_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: message: type: string description: The message to add to the chat required: - message /wpcom/v2/mobile-support/eligibility: get: operationId: getWpcomV2MobileSupportEligibility summary: GET /wpcom/v2/mobile-support/eligibility tags: - mobile-support responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/mobile-support/unified-conversations: get: operationId: getWpcomV2MobileSupportUnifiedConversations summary: GET /wpcom/v2/mobile-support/unified-conversations tags: - mobile-support responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/mobile-support/unified-conversations/{conversation_id}: get: operationId: getWpcomV2MobileSupportUnifiedConversationsbyConversationId summary: GET /wpcom/v2/mobile-support/unified-conversations/{conversation_id} tags: - mobile-support responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: conversation_id in: path required: true schema: type: string post: operationId: postWpcomV2MobileSupportUnifiedConversationsbyConversationId summary: POST /wpcom/v2/mobile-support/unified-conversations/{conversation_id} tags: - mobile-support responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: conversation_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: message: type: string description: The message to add to the chat encrypted_log_ids: type: array items: type: string description: An array of encrypted log IDs to attach to the conversation. Only applied when the reply routes to a Zendesk ticket (e.g. an escalated conversation). required: - message /wpcom/v2/mobile/feature-announcements: get: operationId: getWpcomV2MobileFeatureAnnouncements summary: GET /wpcom/v2/mobile/feature-announcements tags: - mobile responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: _locale in: query required: false schema: type: string description: locale of the client app, also variations are accepted but filtered out in logic - name: app_id in: query required: false schema: type: integer description: unique application id of the client app (for example getting a 1 here is WORDPRESS_ANDROID_APP_ID) /wpcom/v2/mobile/feature-flags: get: operationId: getWpcomV2MobileFeatureFlags summary: GET /wpcom/v2/mobile/feature-flags tags: - mobile responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: device_id in: query required: false schema: type: string - name: platform in: query required: false schema: type: string - name: build_number in: query required: false schema: type: string - name: marketing_version in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string - name: os_version in: query required: false schema: type: string /wpcom/v2/mobile/migration: post: operationId: postWpcomV2MobileMigration summary: POST /wpcom/v2/mobile/migration tags: - mobile responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/mobile/remote-config: get: operationId: getWpcomV2MobileRemoteConfig summary: GET /wpcom/v2/mobile/remote-config tags: - mobile responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/mobile/resolve-reader-url: get: operationId: getWpcomV2MobileResolveReaderUrl summary: GET /wpcom/v2/mobile/resolve-reader-url tags: - mobile responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: url in: query required: true schema: type: string description: The reader URL to resolve. /wpcom/v2/mobile/share-app-link: get: operationId: getWpcomV2MobileShareAppLink summary: GET /wpcom/v2/mobile/share-app-link tags: - mobile responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: locale in: query required: false schema: default: en - name: app in: query required: false schema: type: string /wpcom/v2/newspack-manager/log: post: operationId: postWpcomV2NewspackManagerLog summary: POST /wpcom/v2/newspack-manager/log tags: - newspack-manager responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: error_code: type: string description: The error code that will be sent to the error_code field in logstash type: type: string description: The type of log. Can be either "error" or "debug". The log will be written to logstash in a feature called newspack_{$type} message: type: string description: The message that will be sent to the message field in logstash log_level: type: integer description: 'All messages will be sent to logstash. If log_level is 3, the message will also be sent to the #newspack-errors Slack channel. If log_level is 4, the message will be sent to the #newspack-product Slack channel.' url: type: string description: The URL that will be sent to the url field in logstash data: type: string description: Extra data that will be sent to the extra field in logstash user_email: type: string description: The user email related to the log entry. Will be sent to the external_user_id field in logstash required: - error_code - type - message - log_level /wpcom/v2/notifications: post: operationId: postWpcomV2Notifications summary: POST /wpcom/v2/notifications tags: - notifications responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: user_id: {} note_type: {} args: {} required: - user_id - note_type /wpcom/v2/oauth2/client-data/{client_id}: get: operationId: getWpcomV2Oauth2ClientDatabyClientId summary: GET /wpcom/v2/oauth2/client-data/{client_id} tags: - oauth2 responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: client_id in: path required: true schema: type: string /wpcom/v2/odie/chat/{bot_id}: get: operationId: getWpcomV2OdieChatbyBotId summary: GET /wpcom/v2/odie/chat/{bot_id} tags: - odie responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: bot_id in: path required: true schema: type: string post: operationId: postWpcomV2OdieChatbyBotId summary: POST /wpcom/v2/odie/chat/{bot_id} tags: - odie responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: bot_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: context: type: object description: The context to continue the chat with. message: type: string description: The message to add to the chat source: type: string enum: - big-sky - profiler - aifficiency - gpt description: The source of the request. Typically omitted. source_user: type: string description: An id identifying the user at the source. Typically omitted. test: type: boolean description: Whether to mark this as a test chat (a11n-only). role: type: string enum: - user - navigation default: user description: Whether to mark this as a navigation message. required: - message /wpcom/v2/odie/chat/{bot_id}/{chat_id}: get: operationId: getWpcomV2OdieChatbyBotIdbyChatId summary: GET /wpcom/v2/odie/chat/{bot_id}/{chat_id} tags: - odie responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: bot_id in: path required: true schema: type: string - name: chat_id in: path required: true schema: type: string - name: page_number in: query required: false schema: type: integer default: 1 description: The number of the page to retrieve, limited to 100 - name: items_per_page in: query required: false schema: type: integer default: 10 description: The number of items per page. - name: include_feedback in: query required: false schema: type: boolean description: If true, include the feedback rating value for each message in the response. post: operationId: postWpcomV2OdieChatbyBotIdbyChatId summary: POST /wpcom/v2/odie/chat/{bot_id}/{chat_id} tags: - odie responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: bot_id in: path required: true schema: type: string - name: chat_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: role: type: string enum: - user - navigation default: user description: Whether to mark this as a navigation message. message: type: string description: The message to add to the chat context: type: object description: The context to continue the chat with. required: - message /wpcom/v2/odie/chat/{bot_id}/{chat_id}/{message_id}/feedback: post: operationId: postWpcomV2OdieChatbyBotIdbyChatIdbyMessageIdFeedback summary: POST /wpcom/v2/odie/chat/{bot_id}/{chat_id}/{message_id}/feedback tags: - odie responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: bot_id in: path required: true schema: type: string - name: chat_id in: path required: true schema: type: string - name: message_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: rating_value: type: integer description: The feedback rating value. required: - rating_value /wpcom/v2/odie/conversations/{bot_ids}: get: operationId: getWpcomV2OdieConversationsbyBotIds summary: GET /wpcom/v2/odie/conversations/{bot_ids} tags: - odie responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: bot_ids in: path required: true schema: type: string - name: truncation_method in: query required: false schema: type: string enum: - first_message - last_message default: last_message description: The method to use for truncating the conversations. Either "first_message" or "last_message". Defaults to "last_message". Note that this parameter affects the response shape. If it is set to `last_message`, the response will include the last message from each chat, while `first_message` will include the first message. - name: page_number in: query required: false schema: type: integer default: 1 description: The 1-indexed page number to retrieve. Each page contains up to 10 conversations. /wpcom/v2/odie/conversations/{bot_id}: get: operationId: getWpcomV2OdieConversationsbyBotId summary: GET /wpcom/v2/odie/conversations/{bot_id} tags: - odie responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: bot_id in: path required: true schema: type: string - name: truncation_method in: query required: false schema: type: string enum: - first_message - last_message default: last_message description: The method to use for truncating the conversations. Either "first_message" or "last_message". Defaults to "last_message". Note that this parameter affects the response shape. If it is set to `last_message`, the response will include the last message from each chat, while `first_message` will include the first message. - name: page_number in: query required: false schema: type: integer default: 1 description: The 1-indexed page number to retrieve. Each page contains up to 10 conversations. /wpcom/v2/oembed-proxy: get: operationId: getWpcomV2OembedProxy summary: GET /wpcom/v2/oembed-proxy tags: - oembed-proxy responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/oembed-proxy/instagram: get: operationId: getWpcomV2OembedProxyInstagram summary: GET /wpcom/v2/oembed-proxy/instagram tags: - oembed-proxy responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/onboarding/domains/categories: get: operationId: getWpcomV2OnboardingDomainsCategories summary: GET /wpcom/v2/onboarding/domains/categories tags: - onboarding responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/pagespeed: post: operationId: postWpcomV2Pagespeed summary: POST /wpcom/v2/pagespeed tags: - pagespeed responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: url: type: string default: false strategy: type: string default: mobile required: - url /wpcom/v2/pattern-assembler/ai/custom-gpt/generate: post: operationId: postWpcomV2PatternAssemblerAiCustomGptGenerate summary: POST /wpcom/v2/pattern-assembler/ai/custom-gpt/generate tags: - pattern-assembler responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: header_pattern: type: number enum: [] description: ID of the pattern used for a header on all pages. footer_pattern: type: number enum: [] description: ID of the pattern used for a footer on all pages. home_patterns: type: array items: type: number description: List of patterns used on the home page. style: type: string enum: [] description: Visual color style of the website. font: type: string enum: [] description: Font choice for the website. pages: type: array items: type: object description: List of pages on the site, apart from the "Home" page. site_title: type: string description: Title of the site, used as the name of the blog. site_tagline: type: string description: Description of the site, used as a tagline. /wpcom/v2/pattern-assembler/ai/custom-gpt/get_schema: get: operationId: getWpcomV2PatternAssemblerAiCustomGptGetSchema summary: GET /wpcom/v2/pattern-assembler/ai/custom-gpt/get_schema tags: - pattern-assembler responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/pattern-assembler/ai/custom-gpt/patterns: get: operationId: getWpcomV2PatternAssemblerAiCustomGptPatterns summary: GET /wpcom/v2/pattern-assembler/ai/custom-gpt/patterns tags: - pattern-assembler responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/pattern-assembler/ai/custom-gpt/styles: get: operationId: getWpcomV2PatternAssemblerAiCustomGptStyles summary: GET /wpcom/v2/pattern-assembler/ai/custom-gpt/styles tags: - pattern-assembler responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/pattern-assembler/ai/latest/generate: post: operationId: postWpcomV2PatternAssemblerAiLatestGenerate summary: POST /wpcom/v2/pattern-assembler/ai/latest/generate tags: - pattern-assembler responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: description: description: Description of the site to generate pages for. patterns_version: default: '1' description: Version of patterns to use. required: - description /wpcom/v2/pattern-assembler/ai/v5/generate: post: operationId: postWpcomV2PatternAssemblerAiV5Generate summary: POST /wpcom/v2/pattern-assembler/ai/v5/generate tags: - pattern-assembler responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: description: description: Description of the site to generate pages for. patterns_version: default: '1' description: Version of patterns to use. required: - description /wpcom/v2/pending-blog-subscriptions: get: operationId: getWpcomV2PendingBlogSubscriptions summary: GET /wpcom/v2/pending-blog-subscriptions tags: - pending-blog-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/pending-blog-subscriptions/{key}/confirm: post: operationId: postWpcomV2PendingBlogSubscriptionsbyKeyConfirm summary: POST /wpcom/v2/pending-blog-subscriptions/{key}/confirm tags: - pending-blog-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: key in: path required: true schema: type: string put: operationId: putWpcomV2PendingBlogSubscriptionsbyKeyConfirm summary: PUT /wpcom/v2/pending-blog-subscriptions/{key}/confirm tags: - pending-blog-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: key in: path required: true schema: type: string patch: operationId: patchWpcomV2PendingBlogSubscriptionsbyKeyConfirm summary: PATCH /wpcom/v2/pending-blog-subscriptions/{key}/confirm tags: - pending-blog-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: key in: path required: true schema: type: string /wpcom/v2/pending-blog-subscriptions/{subscription_id}/delete: post: operationId: postWpcomV2PendingBlogSubscriptionsbySubscriptionIdDelete summary: POST /wpcom/v2/pending-blog-subscriptions/{subscription_id}/delete tags: - pending-blog-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: subscription_id in: path required: true schema: type: string put: operationId: putWpcomV2PendingBlogSubscriptionsbySubscriptionIdDelete summary: PUT /wpcom/v2/pending-blog-subscriptions/{subscription_id}/delete tags: - pending-blog-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: subscription_id in: path required: true schema: type: string patch: operationId: patchWpcomV2PendingBlogSubscriptionsbySubscriptionIdDelete summary: PATCH /wpcom/v2/pending-blog-subscriptions/{subscription_id}/delete tags: - pending-blog-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: subscription_id in: path required: true schema: type: string /wpcom/v2/photodna: post: operationId: postWpcomV2Photodna summary: POST /wpcom/v2/photodna tags: - photodna responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: report: type: string description: description /wpcom/v2/pigeon/confirm: get: operationId: getWpcomV2PigeonConfirm summary: GET /wpcom/v2/pigeon/confirm tags: - pigeon responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: nonce in: query required: true schema: type: string - name: email_address in: query required: true schema: type: string format: email - name: first_name in: query required: true schema: type: string - name: last_name in: query required: false schema: type: string - name: mailing_list_category in: query required: true schema: type: string - name: from_path in: query required: true schema: type: string - name: from_href in: query required: true schema: type: string - name: redirect_to in: query required: false schema: type: string - name: question in: query required: false schema: type: string - name: question_response in: query required: false schema: type: string /wpcom/v2/pigeon/subscribe: post: operationId: postWpcomV2PigeonSubscribe summary: POST /wpcom/v2/pigeon/subscribe tags: - pigeon responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: nonce: type: string email_address: type: string format: email first_name: type: string last_name: type: string mailing_list_category: type: string from_path: type: string from_href: type: string redirect_to: type: string question: type: string question_response: type: string required: - nonce - email_address - first_name - mailing_list_category - from_path - from_href /wpcom/v2/plans: get: operationId: getWpcomV2Plans summary: GET /wpcom/v2/plans tags: - plans responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: country in: query required: false schema: {} - name: currency in: query required: false schema: {} /wpcom/v2/plans/details: get: operationId: getWpcomV2PlansDetails summary: GET /wpcom/v2/plans/details tags: - plans responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: locale in: query required: false schema: default: en /wpcom/v2/plans/features: get: operationId: getWpcomV2PlansFeatures summary: GET /wpcom/v2/plans/features tags: - plans responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: locale in: query required: false schema: default: en /wpcom/v2/plans/mobile: get: operationId: getWpcomV2PlansMobile summary: GET /wpcom/v2/plans/mobile tags: - plans responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: locale in: query required: false schema: default: en /wpcom/v2/playground/ai/blueprint: post: operationId: postWpcomV2PlaygroundAiBlueprint summary: POST /wpcom/v2/playground/ai/blueprint tags: - playground responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: prompt: description: Description of the site. blueprint: description: Existing blueprint schema to modify. required: - prompt - blueprint /wpcom/v2/playground/declarative/ai/blueprint: post: operationId: postWpcomV2PlaygroundDeclarativeAiBlueprint summary: POST /wpcom/v2/playground/declarative/ai/blueprint tags: - playground responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: prompt: description: Description of the site. blueprint: description: Existing blueprint schema to modify. required: - prompt - blueprint /wpcom/v2/plugins/featured: get: operationId: getWpcomV2PluginsFeatured summary: GET /wpcom/v2/plugins/featured 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' /wpcom/v2/portfolio-dashboard-agent/run: post: operationId: postWpcomV2PortfolioDashboardAgentRun summary: POST /wpcom/v2/portfolio-dashboard-agent/run tags: - portfolio-dashboard-agent responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: prompt: type: string description: The user prompt to send to the agent. prior_messages: type: array default: [] items: {} description: 'Optional conversation history. Array of { role: "user"|"assistant", content: string }.' emphasized_tools: type: array default: [] items: {} description: Optional tool or leaf names the client wants the model to prioritize (Mission Control roadmapping v1). seed_p2_urls: type: array default: [] items: {} description: Optional P2 URLs merged into the prompt when relevant (agent has P2 fetch tools). model: type: string enum: - claude-sonnet-4-6 - claude-sonnet-4-5-20250929 - claude-opus-4-6 - claude-haiku-4-5-20251001 description: Optional Anthropic model id for this run. Omitted = Portfolio_Dashboard_Agent default (claude-sonnet-4-6). month_key: type: string description: Optional Portfolio Dashboard month (YYYY-MM) the user is viewing. Injected into the prompt so compute-health-score / scan-portfolio use the same month. skill: type: string enum: - dashboard - strategy description: Which skill prompt the agent should load. "dashboard" (default) loads the tactical PD assistant; "strategy" loads the senior-PM synthesis skill used by the Mission Control roadmapping page. include_matt_priorities: type: boolean default: false description: When true and skill="strategy", load Matt's distilled priorities markdown into the agent's system prompt before the run. Ignored for other skills. See ceo-voice-v2-outline.md Phase 2. required: - prompt /wpcom/v2/portfolio-dashboard-agent/run-stream: post: operationId: postWpcomV2PortfolioDashboardAgentRunStream summary: POST /wpcom/v2/portfolio-dashboard-agent/run-stream tags: - portfolio-dashboard-agent responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: prompt: type: string description: The user prompt to send to the agent. prior_messages: type: array default: [] items: {} description: 'Optional conversation history. Array of { role: "user"|"assistant", content: string }.' emphasized_tools: type: array default: [] items: {} description: Optional tool or leaf names the client wants the model to prioritize (Mission Control roadmapping v1). seed_p2_urls: type: array default: [] items: {} description: Optional P2 URLs merged into the prompt when relevant (agent has P2 fetch tools). model: type: string enum: - claude-sonnet-4-6 - claude-sonnet-4-5-20250929 - claude-opus-4-6 - claude-haiku-4-5-20251001 description: Optional Anthropic model id for this run. Omitted = Portfolio_Dashboard_Agent default (claude-sonnet-4-6). month_key: type: string description: Optional Portfolio Dashboard month (YYYY-MM) the user is viewing. Injected into the prompt so compute-health-score / scan-portfolio use the same month. skill: type: string enum: - dashboard - strategy description: Which skill prompt the agent should load. "dashboard" (default) loads the tactical PD assistant; "strategy" loads the senior-PM synthesis skill used by the Mission Control roadmapping page. include_matt_priorities: type: boolean default: false description: When true and skill="strategy", load Matt's distilled priorities markdown into the agent's system prompt before the run. Ignored for other skills. See ceo-voice-v2-outline.md Phase 2. required: - prompt /wpcom/v2/post-comment-subscriptions: get: operationId: getWpcomV2PostCommentSubscriptions summary: GET /wpcom/v2/post-comment-subscriptions tags: - post-comment-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/post-comment-subscriptions/{subscription_id}/confirm: post: operationId: postWpcomV2PostCommentSubscriptionsbySubscriptionIdConfirm summary: POST /wpcom/v2/post-comment-subscriptions/{subscription_id}/confirm tags: - post-comment-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: subscription_id in: path required: true schema: type: string put: operationId: putWpcomV2PostCommentSubscriptionsbySubscriptionIdConfirm summary: PUT /wpcom/v2/post-comment-subscriptions/{subscription_id}/confirm tags: - post-comment-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: subscription_id in: path required: true schema: type: string patch: operationId: patchWpcomV2PostCommentSubscriptionsbySubscriptionIdConfirm summary: PATCH /wpcom/v2/post-comment-subscriptions/{subscription_id}/confirm tags: - post-comment-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: subscription_id in: path required: true schema: type: string /wpcom/v2/post-comment-subscriptions/{subscription_id}/delete: post: operationId: postWpcomV2PostCommentSubscriptionsbySubscriptionIdDelete summary: POST /wpcom/v2/post-comment-subscriptions/{subscription_id}/delete tags: - post-comment-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: subscription_id in: path required: true schema: type: string put: operationId: putWpcomV2PostCommentSubscriptionsbySubscriptionIdDelete summary: PUT /wpcom/v2/post-comment-subscriptions/{subscription_id}/delete tags: - post-comment-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: subscription_id in: path required: true schema: type: string patch: operationId: patchWpcomV2PostCommentSubscriptionsbySubscriptionIdDelete summary: PATCH /wpcom/v2/post-comment-subscriptions/{subscription_id}/delete tags: - post-comment-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: subscription_id in: path required: true schema: type: string /wpcom/v2/post-comment-subscriptions/{subscription_id}/update: post: operationId: postWpcomV2PostCommentSubscriptionsbySubscriptionIdUpdate summary: POST /wpcom/v2/post-comment-subscriptions/{subscription_id}/update tags: - post-comment-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: subscription_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: send_comments: type: boolean description: Whether to send comments for this subscription required: - send_comments put: operationId: putWpcomV2PostCommentSubscriptionsbySubscriptionIdUpdate summary: PUT /wpcom/v2/post-comment-subscriptions/{subscription_id}/update tags: - post-comment-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: subscription_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: send_comments: type: boolean description: Whether to send comments for this subscription required: - send_comments patch: operationId: patchWpcomV2PostCommentSubscriptionsbySubscriptionIdUpdate summary: PATCH /wpcom/v2/post-comment-subscriptions/{subscription_id}/update tags: - post-comment-subscriptions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: subscription_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: send_comments: type: boolean description: Whether to send comments for this subscription required: - send_comments /wpcom/v2/presales/chat: get: operationId: getWpcomV2PresalesChat summary: GET /wpcom/v2/presales/chat tags: - presales responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: group in: query required: false schema: type: string description: The presales chat group to check /wpcom/v2/pricing-dashboard/currencies: get: operationId: getWpcomV2PricingDashboardCurrencies summary: GET /wpcom/v2/pricing-dashboard/currencies tags: - pricing-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/pricing-dashboard/jetpack-products: get: operationId: getWpcomV2PricingDashboardJetpackProducts summary: GET /wpcom/v2/pricing-dashboard/jetpack-products tags: - pricing-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/pricing-dashboard/prices: get: operationId: getWpcomV2PricingDashboardPrices summary: GET /wpcom/v2/pricing-dashboard/prices tags: - pricing-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: products in: query required: true schema: {} description: The product IDs to fetch prices for. Can be a comma-separated string or an array of integers. - name: env in: query required: true schema: type: string enum: - staging - production post: operationId: postWpcomV2PricingDashboardPrices summary: POST /wpcom/v2/pricing-dashboard/prices tags: - pricing-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: p2_url: type: string format: uri data: type: object dry_run: type: boolean required: - p2_url - data /wpcom/v2/pricing-dashboard/prod-sync: post: operationId: postWpcomV2PricingDashboardProdSync summary: POST /wpcom/v2/pricing-dashboard/prod-sync tags: - pricing-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/pricing-dashboard/staging-prod-diff: get: operationId: getWpcomV2PricingDashboardStagingProdDiff summary: GET /wpcom/v2/pricing-dashboard/staging-prod-diff tags: - pricing-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/privacy-policy: get: operationId: getWpcomV2PrivacyPolicy summary: GET /wpcom/v2/privacy-policy tags: - privacy-policy responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/privacy-policy/{entity}: get: operationId: getWpcomV2PrivacyPolicybyEntity summary: GET /wpcom/v2/privacy-policy/{entity} tags: - privacy-policy responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: entity in: path required: true schema: type: string /wpcom/v2/private-podcasts/auth: get: operationId: getWpcomV2PrivatePodcastsAuth summary: GET /wpcom/v2/private-podcasts/auth tags: - private-podcasts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/private-podcasts/feed: get: operationId: getWpcomV2PrivatePodcastsFeed summary: GET /wpcom/v2/private-podcasts/feed tags: - private-podcasts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: token in: query required: true schema: type: string description: Ouath code sent back from the authorization flow. /wpcom/v2/private-podcasts/file: get: operationId: getWpcomV2PrivatePodcastsFile summary: GET /wpcom/v2/private-podcasts/file tags: - private-podcasts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: token in: query required: true schema: type: string description: Ouath code sent back from the authorization flow. - name: media_id in: query required: true schema: type: string description: File to access. /wpcom/v2/private-podcasts/token: get: operationId: getWpcomV2PrivatePodcastsToken summary: GET /wpcom/v2/private-podcasts/token tags: - private-podcasts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: code in: query required: true schema: type: string description: Ouath code sent back from the authorization flow. /wpcom/v2/products: get: operationId: getWpcomV2Products summary: GET /wpcom/v2/products tags: - products responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: locale in: query required: false schema: default: en - name: type in: query required: false schema: default: '' /wpcom/v2/read/interests: get: operationId: getWpcomV2ReadInterests summary: GET /wpcom/v2/read/interests tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/read/lists/{list_id}/export: get: operationId: getWpcomV2ReadListsbyListIdExport summary: GET /wpcom/v2/read/lists/{list_id}/export tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: list_id in: path required: true schema: type: string /wpcom/v2/read/sites/{blog_id}/notification-subscriptions/delete: post: operationId: postWpcomV2ReadSitesbyBlogIdNotificationSubscriptionsDelete summary: POST /wpcom/v2/read/sites/{blog_id}/notification-subscriptions/delete tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: blog_id in: path required: true schema: type: string /wpcom/v2/read/sites/{blog_id}/notification-subscriptions/new: post: operationId: postWpcomV2ReadSitesbyBlogIdNotificationSubscriptionsNew summary: POST /wpcom/v2/read/sites/{blog_id}/notification-subscriptions/new tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: blog_id in: path required: true schema: type: string /wpcom/v2/read/sites/{blog_id}/posts/{post_id}/follow: post: operationId: postWpcomV2ReadSitesbyBlogIdPostsbyPostIdFollow summary: POST /wpcom/v2/read/sites/{blog_id}/posts/{post_id}/follow tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: blog_id in: path required: true schema: type: string - name: post_id in: path required: true schema: type: string /wpcom/v2/read/sites/{blog_id}/posts/{post_id}/forget: post: operationId: postWpcomV2ReadSitesbyBlogIdPostsbyPostIdForget summary: POST /wpcom/v2/read/sites/{blog_id}/posts/{post_id}/forget tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: blog_id in: path required: true schema: type: string - name: post_id in: path required: true schema: type: string /wpcom/v2/read/sites/{blog_id}/posts/{post_id}/mute: post: operationId: postWpcomV2ReadSitesbyBlogIdPostsbyPostIdMute summary: POST /wpcom/v2/read/sites/{blog_id}/posts/{post_id}/mute tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: blog_id in: path required: true schema: type: string - name: post_id in: path required: true schema: type: string /wpcom/v2/read/sites/{blog_id}/posts/{post_id}/remember: post: operationId: postWpcomV2ReadSitesbyBlogIdPostsbyPostIdRemember summary: POST /wpcom/v2/read/sites/{blog_id}/posts/{post_id}/remember tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: blog_id in: path required: true schema: type: string - name: post_id in: path required: true schema: type: string /wpcom/v2/read/sites/{blog_id}/posts/{post_id}/tags/add: post: operationId: postWpcomV2ReadSitesbyBlogIdPostsbyPostIdTagsAdd summary: POST /wpcom/v2/read/sites/{blog_id}/posts/{post_id}/tags/add tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: blog_id in: path required: true schema: type: string - name: post_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: tags: type: array items: {} description: Tags to save. required: - tags /wpcom/v2/read/sites/{blog_id}/subscription-details: get: operationId: getWpcomV2ReadSitesbyBlogIdSubscriptionDetails summary: GET /wpcom/v2/read/sites/{blog_id}/subscription-details tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: blog_id in: path required: true schema: type: string /wpcom/v2/read/smart-feed/user-model: get: operationId: getWpcomV2ReadSmartFeedUserModel summary: GET /wpcom/v2/read/smart-feed/user-model tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2ReadSmartFeedUserModel summary: POST /wpcom/v2/read/smart-feed/user-model tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: abstract: type: string description: Free-form text describing the user's interests. Omit to update fingerprint/style only. fingerprint: type: object description: Optional fingerprint overrides (latitude, longitude, location_precision, ...). style: type: object description: Optional style vector overrides (intensity, verbosity, ..., links_preference). delete: operationId: deleteWpcomV2ReadSmartFeedUserModel summary: DELETE /wpcom/v2/read/smart-feed/user-model tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/read/streams/on-this-day: get: operationId: getWpcomV2ReadStreamsOnThisDay summary: GET /wpcom/v2/read/streams/on-this-day tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: page in: query required: false schema: type: integer default: 1 - name: month in: query required: false schema: type: integer - name: day in: query required: false schema: type: integer /wpcom/v2/read/subscriptions/{subscription_id}: get: operationId: getWpcomV2ReadSubscriptionsbySubscriptionId summary: GET /wpcom/v2/read/subscriptions/{subscription_id} tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: subscription_id in: path required: true schema: type: string /wpcom/v2/read/tags/cards: get: operationId: getWpcomV2ReadTagsCards summary: GET /wpcom/v2/read/tags/cards tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - 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: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: sort in: query required: false schema: type: string default: popularity description: Sort order. - name: page in: query required: false schema: type: integer default: 1 description: Page number of the posts to return. - name: _locale in: query required: false schema: type: string default: en description: Locale of the client. - name: page_handle in: query required: false schema: type: string description: A page handle, returned from a previous API call as a next_page_handle property. This is the most efficient way to fetch the next page of results. - name: refresh in: query required: false schema: type: integer description: The number of times the cards have been refreshed. Provided by the client to enable different results on each refresh. 0 will provide the best results from the entire index. - name: tag_recs_per_card in: query required: false schema: type: integer description: The number of tag recommendations to return in card results - name: site_recs_per_card in: query required: false schema: type: integer description: The number of site recommendations to return in card results - name: tags in: query required: true schema: type: array items: {} description: Tags to fetch cards for. /wpcom/v2/read/tags/posts: get: operationId: getWpcomV2ReadTagsPosts summary: GET /wpcom/v2/read/tags/posts tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - 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: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: sort in: query required: false schema: type: string default: date description: Sort order. - name: number in: query required: false schema: type: integer default: 10 description: Number of posts to return. - name: page in: query required: false schema: type: integer default: 1 description: Page number of the posts to return. - name: _locale in: query required: false schema: type: string default: en description: Locale of the client. - name: page_handle in: query required: false schema: type: string description: A page handle, returned from a previous API call as a next_page_handle property. This is the most efficient way to fetch the next page of results. - name: tags in: query required: true schema: type: array items: {} description: Tags to fetch posts for. /wpcom/v2/read/tags/{tag}/cards: get: operationId: getWpcomV2ReadTagsbyTagCards summary: GET /wpcom/v2/read/tags/{tag}/cards tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: tag in: path required: true schema: type: string - 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: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: sort in: query required: false schema: type: string default: popularity description: Sort order. - name: page in: query required: false schema: type: integer default: 1 description: Page number of the posts to return. - name: _locale in: query required: false schema: type: string default: en description: Locale of the client. - name: page_handle in: query required: false schema: type: string description: A page handle, returned from a previous API call as a next_page_handle property. This is the most efficient way to fetch the next page of results. - name: refresh in: query required: false schema: type: integer description: The number of times the cards have been refreshed. Provided by the client to enable different results on each refresh. 0 will provide the best results from the entire index. - name: tag_recs_per_card in: query required: false schema: type: integer description: The number of tag recommendations to return in card results - name: site_recs_per_card in: query required: false schema: type: integer description: The number of site recommendations to return in card results - name: age_based_decay in: query required: false schema: type: number description: A value above 0 and under 1 defining how much to penalize older posts. A value of 0.1 would mean that posts are devalued by 90% per day of age. /wpcom/v2/read/tags/{tag}/posts: get: operationId: getWpcomV2ReadTagsbyTagPosts summary: GET /wpcom/v2/read/tags/{tag}/posts tags: - read responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: tag in: path required: true schema: type: string - 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: after in: query required: false schema: type: string format: date-time description: Limit response to posts published after a given ISO8601 compliant date. - name: sort in: query required: false schema: type: string default: date description: Sort order. - name: number in: query required: false schema: type: integer default: 10 description: Number of posts to return. - name: page in: query required: false schema: type: integer default: 1 description: Page number of the posts to return. - name: _locale in: query required: false schema: type: string default: en description: Locale of the client. - name: page_handle in: query required: false schema: type: string description: A page handle, returned from a previous API call as a next_page_handle property. This is the most efficient way to fetch the next page of results. /wpcom/v2/reader/atmosphere/connections: get: operationId: getWpcomV2ReaderAtmosphereConnections summary: GET /wpcom/v2/reader/atmosphere/connections tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2ReaderAtmosphereConnections summary: POST /wpcom/v2/reader/atmosphere/connections tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: handle: type: string app_password: type: string required: - handle - app_password /wpcom/v2/reader/atmosphere/connections/{id}: get: operationId: getWpcomV2ReaderAtmosphereConnectionsbyId summary: GET /wpcom/v2/reader/atmosphere/connections/{id} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string delete: operationId: deleteWpcomV2ReaderAtmosphereConnectionsbyId summary: DELETE /wpcom/v2/reader/atmosphere/connections/{id} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string /wpcom/v2/reader/atmosphere/connections/{id}/blobs: post: operationId: postWpcomV2ReaderAtmosphereConnectionsbyIdBlobs summary: POST /wpcom/v2/reader/atmosphere/connections/{id}/blobs tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string /wpcom/v2/reader/atmosphere/connections/{id}/follows: post: operationId: postWpcomV2ReaderAtmosphereConnectionsbyIdFollows summary: POST /wpcom/v2/reader/atmosphere/connections/{id}/follows tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: subject_did: type: string required: - subject_did /wpcom/v2/reader/atmosphere/connections/{id}/follows/{rkey}: delete: operationId: deleteWpcomV2ReaderAtmosphereConnectionsbyIdFollowsbyRkey summary: DELETE /wpcom/v2/reader/atmosphere/connections/{id}/follows/{rkey} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: rkey in: path required: true schema: type: string /wpcom/v2/reader/atmosphere/connections/{id}/likes: post: operationId: postWpcomV2ReaderAtmosphereConnectionsbyIdLikes summary: POST /wpcom/v2/reader/atmosphere/connections/{id}/likes tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: post_uri: type: string post_cid: type: string required: - post_uri - post_cid /wpcom/v2/reader/atmosphere/connections/{id}/likes/{rkey}: delete: operationId: deleteWpcomV2ReaderAtmosphereConnectionsbyIdLikesbyRkey summary: DELETE /wpcom/v2/reader/atmosphere/connections/{id}/likes/{rkey} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: rkey in: path required: true schema: type: string /wpcom/v2/reader/atmosphere/connections/{id}/notifications: get: operationId: getWpcomV2ReaderAtmosphereConnectionsbyIdNotifications summary: GET /wpcom/v2/reader/atmosphere/connections/{id}/notifications tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 30 - name: types in: query required: false schema: type: string default: '' /wpcom/v2/reader/atmosphere/connections/{id}/posts: post: operationId: postWpcomV2ReaderAtmosphereConnectionsbyIdPosts summary: POST /wpcom/v2/reader/atmosphere/connections/{id}/posts tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: text: type: string reply: {} quote: {} media: {} interaction_settings: {} /wpcom/v2/reader/atmosphere/connections/{id}/posts/{rkey}: delete: operationId: deleteWpcomV2ReaderAtmosphereConnectionsbyIdPostsbyRkey summary: DELETE /wpcom/v2/reader/atmosphere/connections/{id}/posts/{rkey} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: rkey in: path required: true schema: type: string /wpcom/v2/reader/atmosphere/connections/{id}/profile/{actor}: get: operationId: getWpcomV2ReaderAtmosphereConnectionsbyIdProfilebyActor summary: GET /wpcom/v2/reader/atmosphere/connections/{id}/profile/{actor} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: actor in: path required: true schema: type: string /wpcom/v2/reader/atmosphere/connections/{id}/profile/{actor}/feed: get: operationId: getWpcomV2ReaderAtmosphereConnectionsbyIdProfilebyActorFeed summary: GET /wpcom/v2/reader/atmosphere/connections/{id}/profile/{actor}/feed tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: actor in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 30 - name: filter in: query required: false schema: type: string enum: - posts_with_replies - posts_no_replies - posts_with_media - posts_and_author_threads default: posts_no_replies /wpcom/v2/reader/atmosphere/connections/{id}/profile/{actor}/followers: get: operationId: getWpcomV2ReaderAtmosphereConnectionsbyIdProfilebyActorFollowers summary: GET /wpcom/v2/reader/atmosphere/connections/{id}/profile/{actor}/followers tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: actor in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 50 /wpcom/v2/reader/atmosphere/connections/{id}/profile/{actor}/follows: get: operationId: getWpcomV2ReaderAtmosphereConnectionsbyIdProfilebyActorFollows summary: GET /wpcom/v2/reader/atmosphere/connections/{id}/profile/{actor}/follows tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: actor in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 50 /wpcom/v2/reader/atmosphere/connections/{id}/reposts: post: operationId: postWpcomV2ReaderAtmosphereConnectionsbyIdReposts summary: POST /wpcom/v2/reader/atmosphere/connections/{id}/reposts tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: post_uri: type: string post_cid: type: string required: - post_uri - post_cid /wpcom/v2/reader/atmosphere/connections/{id}/reposts/{rkey}: delete: operationId: deleteWpcomV2ReaderAtmosphereConnectionsbyIdRepostsbyRkey summary: DELETE /wpcom/v2/reader/atmosphere/connections/{id}/reposts/{rkey} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: rkey in: path required: true schema: type: string /wpcom/v2/reader/atmosphere/connections/{id}/tag/{hashtag}/feed: get: operationId: getWpcomV2ReaderAtmosphereConnectionsbyIdTagbyHashtagFeed summary: GET /wpcom/v2/reader/atmosphere/connections/{id}/tag/{hashtag}/feed tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: hashtag in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 25 /wpcom/v2/reader/atmosphere/connections/{id}/thread: get: operationId: getWpcomV2ReaderAtmosphereConnectionsbyIdThread summary: GET /wpcom/v2/reader/atmosphere/connections/{id}/thread tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: uri in: query required: true schema: type: string - name: depth in: query required: false schema: type: integer default: 6 - name: parentHeight in: query required: false schema: type: integer default: 80 /wpcom/v2/reader/atmosphere/connections/{id}/timeline: get: operationId: getWpcomV2ReaderAtmosphereConnectionsbyIdTimeline summary: GET /wpcom/v2/reader/atmosphere/connections/{id}/timeline tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 30 - name: algorithm in: query required: false schema: type: string default: '' /wpcom/v2/reader/atmosphere/profile/{actor}: get: operationId: getWpcomV2ReaderAtmosphereProfilebyActor summary: GET /wpcom/v2/reader/atmosphere/profile/{actor} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: actor in: path required: true schema: type: string /wpcom/v2/reader/atmosphere/profile/{actor}/feed: get: operationId: getWpcomV2ReaderAtmosphereProfilebyActorFeed summary: GET /wpcom/v2/reader/atmosphere/profile/{actor}/feed tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: actor in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 30 - name: filter in: query required: false schema: type: string enum: - posts_with_replies - posts_no_replies - posts_with_media - posts_and_author_threads default: posts_no_replies /wpcom/v2/reader/atmosphere/thread: get: operationId: getWpcomV2ReaderAtmosphereThread summary: GET /wpcom/v2/reader/atmosphere/thread tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: uri in: query required: true schema: type: string - name: depth in: query required: false schema: type: integer default: 6 - name: parentHeight in: query required: false schema: type: integer default: 80 /wpcom/v2/reader/fediverse/connections: get: operationId: getWpcomV2ReaderFediverseConnections summary: GET /wpcom/v2/reader/fediverse/connections tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/fediverse/connections/{id}: get: operationId: getWpcomV2ReaderFediverseConnectionsbyId summary: GET /wpcom/v2/reader/fediverse/connections/{id} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string /wpcom/v2/reader/fediverse/connections/{id}/follows: post: operationId: postWpcomV2ReaderFediverseConnectionsbyIdFollows summary: POST /wpcom/v2/reader/fediverse/connections/{id}/follows tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: actor: type: string required: - actor /wpcom/v2/reader/fediverse/connections/{id}/follows/{follow_id}: delete: operationId: deleteWpcomV2ReaderFediverseConnectionsbyIdFollowsbyFollowId summary: DELETE /wpcom/v2/reader/fediverse/connections/{id}/follows/{follow_id} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: follow_id in: path required: true schema: type: string /wpcom/v2/reader/fediverse/connections/{id}/notifications: get: operationId: getWpcomV2ReaderFediverseConnectionsbyIdNotifications summary: GET /wpcom/v2/reader/fediverse/connections/{id}/notifications tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 30 - name: types in: query required: false schema: type: string default: '' /wpcom/v2/reader/fediverse/connections/{id}/posts: post: operationId: postWpcomV2ReaderFediverseConnectionsbyIdPosts summary: POST /wpcom/v2/reader/fediverse/connections/{id}/posts tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: content: type: string summary: type: string default: '' sensitive: type: boolean default: false visibility: type: string default: public language: type: string default: '' reply: type: string default: '' required: - content /wpcom/v2/reader/fediverse/connections/{id}/profile: get: operationId: getWpcomV2ReaderFediverseConnectionsbyIdProfile summary: GET /wpcom/v2/reader/fediverse/connections/{id}/profile tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string /wpcom/v2/reader/fediverse/connections/{id}/profile/{actor}: get: operationId: getWpcomV2ReaderFediverseConnectionsbyIdProfilebyActor summary: GET /wpcom/v2/reader/fediverse/connections/{id}/profile/{actor} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: actor in: path required: true schema: type: string /wpcom/v2/reader/fediverse/connections/{id}/profile/{actor}/followers: get: operationId: getWpcomV2ReaderFediverseConnectionsbyIdProfilebyActorFollowers summary: GET /wpcom/v2/reader/fediverse/connections/{id}/profile/{actor}/followers tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: actor in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 40 /wpcom/v2/reader/fediverse/connections/{id}/profile/{actor}/following: get: operationId: getWpcomV2ReaderFediverseConnectionsbyIdProfilebyActorFollowing summary: GET /wpcom/v2/reader/fediverse/connections/{id}/profile/{actor}/following tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: actor in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 40 /wpcom/v2/reader/fediverse/connections/{id}/profile/{actor}/timeline: get: operationId: getWpcomV2ReaderFediverseConnectionsbyIdProfilebyActorTimeline summary: GET /wpcom/v2/reader/fediverse/connections/{id}/profile/{actor}/timeline tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: actor in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 20 /wpcom/v2/reader/fediverse/connections/{id}/timeline: get: operationId: getWpcomV2ReaderFediverseConnectionsbyIdTimeline summary: GET /wpcom/v2/reader/fediverse/connections/{id}/timeline tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 20 /wpcom/v2/reader/greader: get: operationId: getWpcomV2ReaderGreader summary: GET /wpcom/v2/reader/greader tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/accounts/ClientLogin: get: operationId: getWpcomV2ReaderGreaderAccountsClientlogin summary: GET /wpcom/v2/reader/greader/accounts/ClientLogin tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: Email in: query required: true schema: type: string - name: Passwd in: query required: true schema: type: string post: operationId: postWpcomV2ReaderGreaderAccountsClientlogin summary: POST /wpcom/v2/reader/greader/accounts/ClientLogin tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: Email: type: string Passwd: type: string required: - Email - Passwd /wpcom/v2/reader/greader/api/greader.php/accounts/ClientLogin: get: operationId: getWpcomV2ReaderGreaderApiGreaderPhpAccountsClientlogin summary: GET /wpcom/v2/reader/greader/api/greader.php/accounts/ClientLogin tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: Email in: query required: true schema: type: string - name: Passwd in: query required: true schema: type: string post: operationId: postWpcomV2ReaderGreaderApiGreaderPhpAccountsClientlogin summary: POST /wpcom/v2/reader/greader/api/greader.php/accounts/ClientLogin tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: Email: type: string Passwd: type: string required: - Email - Passwd /wpcom/v2/reader/greader/api/greader.php/reader/api/0/disable-tag: post: operationId: postWpcomV2ReaderGreaderApiGreaderPhpReaderApi0DisableTag summary: POST /wpcom/v2/reader/greader/api/greader.php/reader/api/0/disable-tag tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/api/greader.php/reader/api/0/edit-tag: post: operationId: postWpcomV2ReaderGreaderApiGreaderPhpReaderApi0EditTag summary: POST /wpcom/v2/reader/greader/api/greader.php/reader/api/0/edit-tag tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/api/greader.php/reader/api/0/mark-all-as-read: post: operationId: postWpcomV2ReaderGreaderApiGreaderPhpReaderApi0MarkAllAsRead summary: POST /wpcom/v2/reader/greader/api/greader.php/reader/api/0/mark-all-as-read tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/api/greader.php/reader/api/0/rename-tag: post: operationId: postWpcomV2ReaderGreaderApiGreaderPhpReaderApi0RenameTag summary: POST /wpcom/v2/reader/greader/api/greader.php/reader/api/0/rename-tag tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/api/greader.php/reader/api/0/stream/contents/{stream}: get: operationId: getWpcomV2ReaderGreaderApiGreaderPhpReaderApi0StreamContentsbyStream summary: GET /wpcom/v2/reader/greader/api/greader.php/reader/api/0/stream/contents/{stream} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: stream in: path required: true schema: type: string /wpcom/v2/reader/greader/api/greader.php/reader/api/0/stream/items/contents: post: operationId: postWpcomV2ReaderGreaderApiGreaderPhpReaderApi0StreamItemsContents summary: POST /wpcom/v2/reader/greader/api/greader.php/reader/api/0/stream/items/contents tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/api/greader.php/reader/api/0/stream/items/ids: get: operationId: getWpcomV2ReaderGreaderApiGreaderPhpReaderApi0StreamItemsIds summary: GET /wpcom/v2/reader/greader/api/greader.php/reader/api/0/stream/items/ids tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/api/greader.php/reader/api/0/subscription/edit: post: operationId: postWpcomV2ReaderGreaderApiGreaderPhpReaderApi0SubscriptionEdit summary: POST /wpcom/v2/reader/greader/api/greader.php/reader/api/0/subscription/edit tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/api/greader.php/reader/api/0/subscription/list: get: operationId: getWpcomV2ReaderGreaderApiGreaderPhpReaderApi0SubscriptionList summary: GET /wpcom/v2/reader/greader/api/greader.php/reader/api/0/subscription/list tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/api/greader.php/reader/api/0/subscription/quickadd: post: operationId: postWpcomV2ReaderGreaderApiGreaderPhpReaderApi0SubscriptionQuickadd summary: POST /wpcom/v2/reader/greader/api/greader.php/reader/api/0/subscription/quickadd tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/api/greader.php/reader/api/0/tag/list: get: operationId: getWpcomV2ReaderGreaderApiGreaderPhpReaderApi0TagList summary: GET /wpcom/v2/reader/greader/api/greader.php/reader/api/0/tag/list tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/api/greader.php/reader/api/0/token: get: operationId: getWpcomV2ReaderGreaderApiGreaderPhpReaderApi0Token summary: GET /wpcom/v2/reader/greader/api/greader.php/reader/api/0/token tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/api/greader.php/reader/api/0/unread-count: get: operationId: getWpcomV2ReaderGreaderApiGreaderPhpReaderApi0UnreadCount summary: GET /wpcom/v2/reader/greader/api/greader.php/reader/api/0/unread-count tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/api/greader.php/reader/api/0/user-info: get: operationId: getWpcomV2ReaderGreaderApiGreaderPhpReaderApi0UserInfo summary: GET /wpcom/v2/reader/greader/api/greader.php/reader/api/0/user-info tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/greader.php/accounts/ClientLogin: get: operationId: getWpcomV2ReaderGreaderGreaderPhpAccountsClientlogin summary: GET /wpcom/v2/reader/greader/greader.php/accounts/ClientLogin tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: Email in: query required: true schema: type: string - name: Passwd in: query required: true schema: type: string post: operationId: postWpcomV2ReaderGreaderGreaderPhpAccountsClientlogin summary: POST /wpcom/v2/reader/greader/greader.php/accounts/ClientLogin tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: Email: type: string Passwd: type: string required: - Email - Passwd /wpcom/v2/reader/greader/greader.php/reader/api/0/disable-tag: post: operationId: postWpcomV2ReaderGreaderGreaderPhpReaderApi0DisableTag summary: POST /wpcom/v2/reader/greader/greader.php/reader/api/0/disable-tag tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/greader.php/reader/api/0/edit-tag: post: operationId: postWpcomV2ReaderGreaderGreaderPhpReaderApi0EditTag summary: POST /wpcom/v2/reader/greader/greader.php/reader/api/0/edit-tag tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/greader.php/reader/api/0/mark-all-as-read: post: operationId: postWpcomV2ReaderGreaderGreaderPhpReaderApi0MarkAllAsRead summary: POST /wpcom/v2/reader/greader/greader.php/reader/api/0/mark-all-as-read tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/greader.php/reader/api/0/rename-tag: post: operationId: postWpcomV2ReaderGreaderGreaderPhpReaderApi0RenameTag summary: POST /wpcom/v2/reader/greader/greader.php/reader/api/0/rename-tag tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/greader.php/reader/api/0/stream/contents/{stream}: get: operationId: getWpcomV2ReaderGreaderGreaderPhpReaderApi0StreamContentsbyStream summary: GET /wpcom/v2/reader/greader/greader.php/reader/api/0/stream/contents/{stream} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: stream in: path required: true schema: type: string /wpcom/v2/reader/greader/greader.php/reader/api/0/stream/items/contents: post: operationId: postWpcomV2ReaderGreaderGreaderPhpReaderApi0StreamItemsContents summary: POST /wpcom/v2/reader/greader/greader.php/reader/api/0/stream/items/contents tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/greader.php/reader/api/0/stream/items/ids: get: operationId: getWpcomV2ReaderGreaderGreaderPhpReaderApi0StreamItemsIds summary: GET /wpcom/v2/reader/greader/greader.php/reader/api/0/stream/items/ids tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/greader.php/reader/api/0/subscription/edit: post: operationId: postWpcomV2ReaderGreaderGreaderPhpReaderApi0SubscriptionEdit summary: POST /wpcom/v2/reader/greader/greader.php/reader/api/0/subscription/edit tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/greader.php/reader/api/0/subscription/list: get: operationId: getWpcomV2ReaderGreaderGreaderPhpReaderApi0SubscriptionList summary: GET /wpcom/v2/reader/greader/greader.php/reader/api/0/subscription/list tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/greader.php/reader/api/0/subscription/quickadd: post: operationId: postWpcomV2ReaderGreaderGreaderPhpReaderApi0SubscriptionQuickadd summary: POST /wpcom/v2/reader/greader/greader.php/reader/api/0/subscription/quickadd tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/greader.php/reader/api/0/tag/list: get: operationId: getWpcomV2ReaderGreaderGreaderPhpReaderApi0TagList summary: GET /wpcom/v2/reader/greader/greader.php/reader/api/0/tag/list tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/greader.php/reader/api/0/token: get: operationId: getWpcomV2ReaderGreaderGreaderPhpReaderApi0Token summary: GET /wpcom/v2/reader/greader/greader.php/reader/api/0/token tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/greader.php/reader/api/0/unread-count: get: operationId: getWpcomV2ReaderGreaderGreaderPhpReaderApi0UnreadCount summary: GET /wpcom/v2/reader/greader/greader.php/reader/api/0/unread-count tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/greader.php/reader/api/0/user-info: get: operationId: getWpcomV2ReaderGreaderGreaderPhpReaderApi0UserInfo summary: GET /wpcom/v2/reader/greader/greader.php/reader/api/0/user-info tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/reader/api/0/disable-tag: post: operationId: postWpcomV2ReaderGreaderReaderApi0DisableTag summary: POST /wpcom/v2/reader/greader/reader/api/0/disable-tag tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/reader/api/0/edit-tag: post: operationId: postWpcomV2ReaderGreaderReaderApi0EditTag summary: POST /wpcom/v2/reader/greader/reader/api/0/edit-tag tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/reader/api/0/mark-all-as-read: post: operationId: postWpcomV2ReaderGreaderReaderApi0MarkAllAsRead summary: POST /wpcom/v2/reader/greader/reader/api/0/mark-all-as-read tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/reader/api/0/rename-tag: post: operationId: postWpcomV2ReaderGreaderReaderApi0RenameTag summary: POST /wpcom/v2/reader/greader/reader/api/0/rename-tag tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/reader/api/0/stream/contents/{stream}: get: operationId: getWpcomV2ReaderGreaderReaderApi0StreamContentsbyStream summary: GET /wpcom/v2/reader/greader/reader/api/0/stream/contents/{stream} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: stream in: path required: true schema: type: string /wpcom/v2/reader/greader/reader/api/0/stream/items/contents: post: operationId: postWpcomV2ReaderGreaderReaderApi0StreamItemsContents summary: POST /wpcom/v2/reader/greader/reader/api/0/stream/items/contents tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/reader/api/0/stream/items/ids: get: operationId: getWpcomV2ReaderGreaderReaderApi0StreamItemsIds summary: GET /wpcom/v2/reader/greader/reader/api/0/stream/items/ids tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/reader/api/0/subscription/edit: post: operationId: postWpcomV2ReaderGreaderReaderApi0SubscriptionEdit summary: POST /wpcom/v2/reader/greader/reader/api/0/subscription/edit tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/reader/api/0/subscription/list: get: operationId: getWpcomV2ReaderGreaderReaderApi0SubscriptionList summary: GET /wpcom/v2/reader/greader/reader/api/0/subscription/list tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/reader/api/0/subscription/quickadd: post: operationId: postWpcomV2ReaderGreaderReaderApi0SubscriptionQuickadd summary: POST /wpcom/v2/reader/greader/reader/api/0/subscription/quickadd tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/reader/api/0/tag/list: get: operationId: getWpcomV2ReaderGreaderReaderApi0TagList summary: GET /wpcom/v2/reader/greader/reader/api/0/tag/list tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/reader/api/0/token: get: operationId: getWpcomV2ReaderGreaderReaderApi0Token summary: GET /wpcom/v2/reader/greader/reader/api/0/token tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/reader/api/0/unread-count: get: operationId: getWpcomV2ReaderGreaderReaderApi0UnreadCount summary: GET /wpcom/v2/reader/greader/reader/api/0/unread-count tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/greader/reader/api/0/user-info: get: operationId: getWpcomV2ReaderGreaderReaderApi0UserInfo summary: GET /wpcom/v2/reader/greader/reader/api/0/user-info tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/reader/mastodon/connections: get: operationId: getWpcomV2ReaderMastodonConnections summary: GET /wpcom/v2/reader/mastodon/connections tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2ReaderMastodonConnections summary: POST /wpcom/v2/reader/mastodon/connections tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: step: type: string enum: - authorize - complete instance: type: string state: type: string code: type: string required: - step /wpcom/v2/reader/mastodon/connections/{id}: get: operationId: getWpcomV2ReaderMastodonConnectionsbyId summary: GET /wpcom/v2/reader/mastodon/connections/{id} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string /wpcom/v2/reader/mastodon/connections/{id}/auth-status: get: operationId: getWpcomV2ReaderMastodonConnectionsbyIdAuthStatus summary: GET /wpcom/v2/reader/mastodon/connections/{id}/auth-status tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string /wpcom/v2/reader/mastodon/connections/{id}/follows: post: operationId: postWpcomV2ReaderMastodonConnectionsbyIdFollows summary: POST /wpcom/v2/reader/mastodon/connections/{id}/follows tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: account_id: type: string /wpcom/v2/reader/mastodon/connections/{id}/follows/{account_id}: delete: operationId: deleteWpcomV2ReaderMastodonConnectionsbyIdFollowsbyAccountId summary: DELETE /wpcom/v2/reader/mastodon/connections/{id}/follows/{account_id} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: account_id in: path required: true schema: type: string /wpcom/v2/reader/mastodon/connections/{id}/likes: post: operationId: postWpcomV2ReaderMastodonConnectionsbyIdLikes summary: POST /wpcom/v2/reader/mastodon/connections/{id}/likes tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: status_id: type: string required: - status_id /wpcom/v2/reader/mastodon/connections/{id}/likes/{status_id}: delete: operationId: deleteWpcomV2ReaderMastodonConnectionsbyIdLikesbyStatusId summary: DELETE /wpcom/v2/reader/mastodon/connections/{id}/likes/{status_id} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: status_id in: path required: true schema: type: string /wpcom/v2/reader/mastodon/connections/{id}/media: post: operationId: postWpcomV2ReaderMastodonConnectionsbyIdMedia summary: POST /wpcom/v2/reader/mastodon/connections/{id}/media tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: description: type: string /wpcom/v2/reader/mastodon/connections/{id}/notifications: get: operationId: getWpcomV2ReaderMastodonConnectionsbyIdNotifications summary: GET /wpcom/v2/reader/mastodon/connections/{id}/notifications tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 30 - name: types in: query required: false schema: type: string default: '' /wpcom/v2/reader/mastodon/connections/{id}/profile/{actor}: get: operationId: getWpcomV2ReaderMastodonConnectionsbyIdProfilebyActor summary: GET /wpcom/v2/reader/mastodon/connections/{id}/profile/{actor} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: actor in: path required: true schema: type: string /wpcom/v2/reader/mastodon/connections/{id}/profile/{actor}/feed: get: operationId: getWpcomV2ReaderMastodonConnectionsbyIdProfilebyActorFeed summary: GET /wpcom/v2/reader/mastodon/connections/{id}/profile/{actor}/feed tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: actor in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: max_id in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 20 - name: exclude_replies in: query required: false schema: type: boolean default: false - name: only_media in: query required: false schema: type: boolean default: false /wpcom/v2/reader/mastodon/connections/{id}/profile/{actor}/followers: get: operationId: getWpcomV2ReaderMastodonConnectionsbyIdProfilebyActorFollowers summary: GET /wpcom/v2/reader/mastodon/connections/{id}/profile/{actor}/followers tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: actor in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: max_id in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 40 /wpcom/v2/reader/mastodon/connections/{id}/profile/{actor}/following: get: operationId: getWpcomV2ReaderMastodonConnectionsbyIdProfilebyActorFollowing summary: GET /wpcom/v2/reader/mastodon/connections/{id}/profile/{actor}/following tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: actor in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: max_id in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 40 /wpcom/v2/reader/mastodon/connections/{id}/reposts: post: operationId: postWpcomV2ReaderMastodonConnectionsbyIdReposts summary: POST /wpcom/v2/reader/mastodon/connections/{id}/reposts tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: status_id: type: string required: - status_id /wpcom/v2/reader/mastodon/connections/{id}/reposts/{status_id}: delete: operationId: deleteWpcomV2ReaderMastodonConnectionsbyIdRepostsbyStatusId summary: DELETE /wpcom/v2/reader/mastodon/connections/{id}/reposts/{status_id} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: status_id in: path required: true schema: type: string /wpcom/v2/reader/mastodon/connections/{id}/statuses: post: operationId: postWpcomV2ReaderMastodonConnectionsbyIdStatuses summary: POST /wpcom/v2/reader/mastodon/connections/{id}/statuses tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: status: type: string default: '' in_reply_to_id: type: string default: '' quoted_status_id: type: string default: '' media_ids: type: array default: [] items: type: string sensitive: type: boolean default: false visibility: type: string default: '' spoiler_text: type: string default: '' /wpcom/v2/reader/mastodon/connections/{id}/statuses/{status_id}: delete: operationId: deleteWpcomV2ReaderMastodonConnectionsbyIdStatusesbyStatusId summary: DELETE /wpcom/v2/reader/mastodon/connections/{id}/statuses/{status_id} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: status_id in: path required: true schema: type: string /wpcom/v2/reader/mastodon/connections/{id}/tag/{hashtag}/feed: get: operationId: getWpcomV2ReaderMastodonConnectionsbyIdTagbyHashtagFeed summary: GET /wpcom/v2/reader/mastodon/connections/{id}/tag/{hashtag}/feed tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: hashtag in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: max_id in: query required: false schema: type: string default: '' - name: min_id in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 20 - name: only_media in: query required: false schema: type: boolean default: false - name: local in: query required: false schema: type: boolean default: false - name: remote in: query required: false schema: type: boolean default: false /wpcom/v2/reader/mastodon/connections/{id}/thread: get: operationId: getWpcomV2ReaderMastodonConnectionsbyIdThread summary: GET /wpcom/v2/reader/mastodon/connections/{id}/thread tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: status_id in: query required: true schema: type: string /wpcom/v2/reader/mastodon/connections/{id}/timeline: get: operationId: getWpcomV2ReaderMastodonConnectionsbyIdTimeline summary: GET /wpcom/v2/reader/mastodon/connections/{id}/timeline tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: cursor in: query required: false schema: type: string default: '' - name: max_id in: query required: false schema: type: string default: '' - name: min_id in: query required: false schema: type: string default: '' - name: limit in: query required: false schema: type: integer default: 20 /wpcom/v2/reader/spaces: get: operationId: getWpcomV2ReaderSpaces summary: GET /wpcom/v2/reader/spaces tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2ReaderSpaces summary: POST /wpcom/v2/reader/spaces tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: title: type: string description: The name of the space. feeds: type: array default: [] items: {} description: Followed feeds — each a feed_id or a feed_url. tags: type: array default: [] items: type: string description: Followed Reader tag slugs. languages: type: array default: [] items: type: string description: Retrieval languages (locale or base codes; normalized to base ES codes like en, pt). Filter the followed-tag slice of the posts feed and Discover; followed feeds are never language-filtered. layout: type: object description: 'Presentation: { color, icon, view, iconColor, width } (optional strings). width is "regular" | "wide". Keys are camelCase (client passes layout through verbatim), unlike the snake_case follows array.' required: - title /wpcom/v2/reader/spaces/membership: get: operationId: getWpcomV2ReaderSpacesMembership summary: GET /wpcom/v2/reader/spaces/membership tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: feed in: query required: false schema: type: string description: A feed_id or feed_url to look up. Provide exactly one of feed or tag. - name: tag in: query required: false schema: type: string description: A Reader tag slug to look up. Provide exactly one of feed or tag. /wpcom/v2/reader/spaces/slug/{slug}: get: operationId: getWpcomV2ReaderSpacesSlugbySlug summary: GET /wpcom/v2/reader/spaces/slug/{slug} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: slug in: path required: true schema: type: string /wpcom/v2/reader/spaces/{id}: get: operationId: getWpcomV2ReaderSpacesbyId summary: GET /wpcom/v2/reader/spaces/{id} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string post: operationId: postWpcomV2ReaderSpacesbyId summary: POST /wpcom/v2/reader/spaces/{id} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: title: type: string description: New space title. layout: type: object description: 'Presentation: { color, icon, view, iconColor, width } (optional strings). width is "regular" | "wide". Keys are camelCase (client passes layout through verbatim), unlike the snake_case follows array.' tags: type: array items: type: string description: Full tag set (slugs) to replace the space's tags. Pass [] to clear. feeds: type: array items: {} description: Full feed set (feed_id or feed_url) to replace the space's feeds. Pass [] to clear. languages: type: array items: type: string description: Full language set (locale or base codes; normalized to base ES codes) to replace the space's languages. Pass [] to clear. put: operationId: putWpcomV2ReaderSpacesbyId summary: PUT /wpcom/v2/reader/spaces/{id} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: title: type: string description: New space title. layout: type: object description: 'Presentation: { color, icon, view, iconColor, width } (optional strings). width is "regular" | "wide". Keys are camelCase (client passes layout through verbatim), unlike the snake_case follows array.' tags: type: array items: type: string description: Full tag set (slugs) to replace the space's tags. Pass [] to clear. feeds: type: array items: {} description: Full feed set (feed_id or feed_url) to replace the space's feeds. Pass [] to clear. languages: type: array items: type: string description: Full language set (locale or base codes; normalized to base ES codes) to replace the space's languages. Pass [] to clear. patch: operationId: patchWpcomV2ReaderSpacesbyId summary: PATCH /wpcom/v2/reader/spaces/{id} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: title: type: string description: New space title. layout: type: object description: 'Presentation: { color, icon, view, iconColor, width } (optional strings). width is "regular" | "wide". Keys are camelCase (client passes layout through verbatim), unlike the snake_case follows array.' tags: type: array items: type: string description: Full tag set (slugs) to replace the space's tags. Pass [] to clear. feeds: type: array items: {} description: Full feed set (feed_id or feed_url) to replace the space's feeds. Pass [] to clear. languages: type: array items: type: string description: Full language set (locale or base codes; normalized to base ES codes) to replace the space's languages. Pass [] to clear. delete: operationId: deleteWpcomV2ReaderSpacesbyId summary: DELETE /wpcom/v2/reader/spaces/{id} tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string /wpcom/v2/reader/spaces/{id}/discover: get: operationId: getWpcomV2ReaderSpacesbyIdDiscover summary: GET /wpcom/v2/reader/spaces/{id}/discover tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: count in: query required: false schema: type: integer default: 7 description: Number of posts per page (max 7 — an Elasticsearch query-size limit; paginate via page_handle for more). - name: page_handle in: query required: false schema: type: string description: Opaque cursor from a previous response, to fetch the next page. - name: _locale in: query required: false schema: type: string default: en description: Locale for the stream. /wpcom/v2/reader/spaces/{id}/posts: get: operationId: getWpcomV2ReaderSpacesbyIdPosts summary: GET /wpcom/v2/reader/spaces/{id}/posts tags: - reader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: id in: path required: true schema: type: string - name: count in: query required: false schema: type: integer default: 8 description: Number of posts per page (max 15; larger requests are clamped — paginate via page_handle for more). - name: tag_limit in: query required: false schema: type: integer description: Max posts per page from the space's followed tags (0 = feeds only). Clamped to count, effectively capped at 7 (an Elasticsearch query-size limit). When omitted, it defaults to 3 ONLY if the space has both feeds and tags (to keep feed posts visible); a tag-only or feed-only space has no cap. - name: page_handle in: query required: false schema: type: string description: Opaque cursor from a previous response, to fetch the next page. - name: _locale in: query required: false schema: type: string default: en description: Locale for the stream. /wpcom/v2/restore-site: put: operationId: putWpcomV2RestoreSite summary: PUT /wpcom/v2/restore-site tags: - restore-site responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: site_id: type: integer required: - site_id /wpcom/v2/seen-posts/seen/all/new: post: operationId: postWpcomV2SeenPostsSeenAllNew summary: POST /wpcom/v2/seen-posts/seen/all/new tags: - seen-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' requestBody: content: application/json: schema: type: object properties: feed_ids: type: array items: {} source: type: string enum: - notification-web - notification-ios - notification-android - reader-web - reader-ios - reader-android - frontend - frontend-p2 required: - feed_ids - source /wpcom/v2/seen-posts/seen/blog/delete: post: operationId: postWpcomV2SeenPostsSeenBlogDelete summary: POST /wpcom/v2/seen-posts/seen/blog/delete tags: - seen-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' requestBody: content: application/json: schema: type: object properties: blog_id: type: integer post_ids: type: array items: {} source: type: string enum: - notification-web - notification-ios - notification-android - reader-web - reader-ios - reader-android - frontend - frontend-p2 required: - blog_id - post_ids - source /wpcom/v2/seen-posts/seen/blog/new: post: operationId: postWpcomV2SeenPostsSeenBlogNew summary: POST /wpcom/v2/seen-posts/seen/blog/new tags: - seen-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' requestBody: content: application/json: schema: type: object properties: blog_id: type: integer post_ids: type: array items: {} source: type: string enum: - notification-web - notification-ios - notification-android - reader-web - reader-ios - reader-android - frontend - frontend-p2 required: - blog_id - post_ids - source /wpcom/v2/seen-posts/seen/delete: post: operationId: postWpcomV2SeenPostsSeenDelete summary: POST /wpcom/v2/seen-posts/seen/delete tags: - seen-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' requestBody: content: application/json: schema: type: object properties: feed_id: type: integer feed_item_ids: type: array items: {} source: type: string enum: - notification-web - notification-ios - notification-android - reader-web - reader-ios - reader-android - frontend - frontend-p2 required: - feed_id - feed_item_ids - source /wpcom/v2/seen-posts/seen/new: post: operationId: postWpcomV2SeenPostsSeenNew summary: POST /wpcom/v2/seen-posts/seen/new tags: - seen-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' requestBody: content: application/json: schema: type: object properties: feed_id: type: integer feed_item_ids: type: array items: {} source: type: string enum: - notification-web - notification-ios - notification-android - reader-web - reader-ios - reader-android - frontend - frontend-p2 required: - feed_id - feed_item_ids - source /wpcom/v2/seen-posts/unseen/status: get: operationId: getWpcomV2SeenPostsUnseenStatus summary: GET /wpcom/v2/seen-posts/unseen/status tags: - seen-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' /wpcom/v2/segmentation-survey/answer: post: operationId: postWpcomV2SegmentationSurveyAnswer summary: POST /wpcom/v2/segmentation-survey/answer tags: - segmentation-survey responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: blog_id: type: integer survey_key: type: string question_key: type: string answers: type: array items: type: string required: - survey_key - question_key - answers put: operationId: putWpcomV2SegmentationSurveyAnswer summary: PUT /wpcom/v2/segmentation-survey/answer tags: - segmentation-survey responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: blog_id: type: integer survey_key: type: string question_key: type: string answers: type: array items: type: string required: - survey_key - question_key - answers patch: operationId: patchWpcomV2SegmentationSurveyAnswer summary: PATCH /wpcom/v2/segmentation-survey/answer tags: - segmentation-survey responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: blog_id: type: integer survey_key: type: string question_key: type: string answers: type: array items: type: string required: - survey_key - question_key - answers /wpcom/v2/segmentation-survey/answers: get: operationId: getWpcomV2SegmentationSurveyAnswers summary: GET /wpcom/v2/segmentation-survey/answers tags: - segmentation-survey responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: survey_key in: query required: true schema: type: string /wpcom/v2/segmentation-survey/answers/link: post: operationId: postWpcomV2SegmentationSurveyAnswersLink summary: POST /wpcom/v2/segmentation-survey/answers/link tags: - segmentation-survey responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: blog_id: type: integer survey_key: type: string required: - blog_id - survey_key put: operationId: putWpcomV2SegmentationSurveyAnswersLink summary: PUT /wpcom/v2/segmentation-survey/answers/link tags: - segmentation-survey responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: blog_id: type: integer survey_key: type: string required: - blog_id - survey_key patch: operationId: patchWpcomV2SegmentationSurveyAnswersLink summary: PATCH /wpcom/v2/segmentation-survey/answers/link tags: - segmentation-survey responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: blog_id: type: integer survey_key: type: string required: - blog_id - survey_key /wpcom/v2/segmentation-survey/{survey_key}: get: operationId: getWpcomV2SegmentationSurveybySurveyKey summary: GET /wpcom/v2/segmentation-survey/{survey_key} tags: - segmentation-survey responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: survey_key in: path required: true schema: type: string /wpcom/v2/segments: get: operationId: getWpcomV2Segments summary: GET /wpcom/v2/segments tags: - segments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/send/pressable-hubspot-form/new: post: operationId: postWpcomV2SendPressableHubspotFormNew summary: POST /wpcom/v2/send/pressable-hubspot-form/new tags: - send responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: first_name: type: string last_name: type: string email: type: string host_name: type: string required: - first_name - last_name - email - host_name /wpcom/v2/send/spain-newsletter/new: post: operationId: postWpcomV2SendSpainNewsletterNew summary: POST /wpcom/v2/send/spain-newsletter/new tags: - send responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: first_name: type: string last_name: type: string email: type: string form_id: type: string profile: type: string _landing_page: type: string required: - first_name - last_name - email /wpcom/v2/send/wpcom-education/new: post: operationId: postWpcomV2SendWpcomEducationNew summary: POST /wpcom/v2/send/wpcom-education/new tags: - send responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: first_name: type: string last_name: type: string email: type: string institution: type: string institution_website: type: string course: type: string topic: type: string enum: - it - marketing - journalism - arts - other number_of_students: type: integer future_wordpress_usage: type: string current_wordpress_usage: type: string enum: - shared_server - local_installation - free_temporary_online_service - playground - wordpress_com_free_plan - do_not_use_wordpress - other start_date: type: string end_date: type: string comments: type: string _landing_page: type: string _language: type: string program_type: type: string school_type: type: string required: - first_name - last_name - email /wpcom/v2/site-suggestions: get: operationId: getWpcomV2SiteSuggestions summary: GET /wpcom/v2/site-suggestions tags: - site-suggestions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: dictionary in: query required: false schema: type: string enum: - hosting /wpcom/v2/sites/{site_id}/ai/agent/{agent_id}: post: operationId: postWpcomV2SitesbySiteIdAiAgentbyAgentId summary: POST /wpcom/v2/sites/{site_id}/ai/agent/{agent_id} tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: site_id in: path required: true schema: type: string - name: agent_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}: get: operationId: getWpcomV2SitesbyWpcomSite summary: GET /wpcom/v2/sites/{wpcom_site} tags: - wpcom-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: wpcom/v2 - name: context in: query required: false schema: default: view /wpcom/v2/sites/{wpcom_site}/activity: post: operationId: postWpcomV2SitesbyWpcomSiteActivity summary: POST /wpcom/v2/sites/{wpcom_site}/activity tags: - activity responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: {} args: {} required: - action_type get: operationId: getWpcomV2SitesbyWpcomSiteActivity summary: GET /wpcom/v2/sites/{wpcom_site}/activity tags: - activity responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: _envelope in: query required: false schema: {} - name: action in: query required: false schema: default: false - name: after in: query required: false schema: {} - name: before in: query required: false schema: {} - name: by in: query required: false schema: default: false - name: date_range in: query required: false schema: default: 6 months ago - name: group in: query required: false schema: default: false - name: locale in: query required: false schema: default: en - name: name in: query required: false schema: default: false - name: not_group in: query required: false schema: default: false - name: number in: query required: false schema: default: 20 - name: 'on' in: query required: false schema: {} - name: page in: query required: false schema: default: 1 - name: search_after in: query required: false schema: {} - name: sort_order in: query required: false schema: default: desc - name: aggregate in: query required: false schema: default: false - name: aggregate_show in: query required: false schema: default: 10 - name: text_search in: query required: false schema: {} - name: ai_only in: query required: false schema: default: false - name: actor in: query required: false schema: default: false /wpcom/v2/sites/{wpcom_site}/activity/actors: get: operationId: getWpcomV2SitesbyWpcomSiteActivityActors summary: GET /wpcom/v2/sites/{wpcom_site}/activity/actors tags: - activity responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: after in: query required: false schema: {} - name: before in: query required: false schema: {} - name: date_range in: query required: false schema: default: 6 months ago - name: number in: query required: false schema: default: 1000 - name: 'on' in: query required: false schema: {} /wpcom/v2/sites/{wpcom_site}/activity/count: get: operationId: getWpcomV2SitesbyWpcomSiteActivityCount summary: GET /wpcom/v2/sites/{wpcom_site}/activity/count tags: - activity responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: _envelope in: query required: false schema: {} - name: action in: query required: false schema: default: false - name: after in: query required: false schema: {} - name: before in: query required: false schema: {} - name: by in: query required: false schema: default: false - name: date_range in: query required: false schema: default: 6 months ago - name: group in: query required: false schema: default: false - name: locale in: query required: false schema: default: en - name: name in: query required: false schema: default: false - name: not_group in: query required: false schema: default: false - name: number in: query required: false schema: default: 20 - name: 'on' in: query required: false schema: {} - name: page in: query required: false schema: default: 1 - name: search_after in: query required: false schema: {} - name: sort_order in: query required: false schema: default: desc - name: aggregate in: query required: false schema: default: false - name: aggregate_show in: query required: false schema: default: 10 - name: text_search in: query required: false schema: {} - name: ai_only in: query required: false schema: default: false - name: actor in: query required: false schema: default: false /wpcom/v2/sites/{wpcom_site}/activity/count/group: get: operationId: getWpcomV2SitesbyWpcomSiteActivityCountGroup summary: GET /wpcom/v2/sites/{wpcom_site}/activity/count/group tags: - activity responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: _envelope in: query required: false schema: {} - name: action in: query required: false schema: default: false - name: after in: query required: false schema: {} - name: before in: query required: false schema: {} - name: by in: query required: false schema: default: false - name: date_range in: query required: false schema: default: 6 months ago - name: group in: query required: false schema: default: false - name: locale in: query required: false schema: default: en - name: name in: query required: false schema: default: false - name: not_group in: query required: false schema: default: false - name: number in: query required: false schema: default: 20 - name: 'on' in: query required: false schema: {} - name: page in: query required: false schema: default: 1 - name: search_after in: query required: false schema: {} - name: sort_order in: query required: false schema: default: desc - name: aggregate in: query required: false schema: default: false - name: aggregate_show in: query required: false schema: default: 10 - name: text_search in: query required: false schema: {} - name: ai_only in: query required: false schema: default: false - name: actor in: query required: false schema: default: false /wpcom/v2/sites/{wpcom_site}/activity/rewindable: get: operationId: getWpcomV2SitesbyWpcomSiteActivityRewindable summary: GET /wpcom/v2/sites/{wpcom_site}/activity/rewindable tags: - activity responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: _envelope in: query required: false schema: {} - name: action in: query required: false schema: default: false - name: after in: query required: false schema: {} - name: before in: query required: false schema: {} - name: by in: query required: false schema: default: false - name: date_range in: query required: false schema: default: 6 months ago - name: group in: query required: false schema: default: false - name: locale in: query required: false schema: default: en - name: name in: query required: false schema: default: false - name: not_group in: query required: false schema: default: false - name: number in: query required: false schema: default: 20 - name: 'on' in: query required: false schema: {} - name: page in: query required: false schema: default: 1 - name: search_after in: query required: false schema: {} - name: sort_order in: query required: false schema: default: desc - name: aggregate in: query required: false schema: default: false - name: aggregate_show in: query required: false schema: default: 10 - name: text_search in: query required: false schema: {} - name: ai_only in: query required: false schema: default: false - name: actor in: query required: false schema: default: false /wpcom/v2/sites/{wpcom_site}/activity/rewindable/count/group: get: operationId: getWpcomV2SitesbyWpcomSiteActivityRewindableCountGroup summary: GET /wpcom/v2/sites/{wpcom_site}/activity/rewindable/count/group tags: - activity responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: _envelope in: query required: false schema: {} - name: action in: query required: false schema: default: false - name: after in: query required: false schema: {} - name: before in: query required: false schema: {} - name: by in: query required: false schema: default: false - name: date_range in: query required: false schema: default: 6 months ago - name: group in: query required: false schema: default: false - name: locale in: query required: false schema: default: en - name: name in: query required: false schema: default: false - name: not_group in: query required: false schema: default: false - name: number in: query required: false schema: default: 20 - name: 'on' in: query required: false schema: {} - name: page in: query required: false schema: default: 1 - name: search_after in: query required: false schema: {} - name: sort_order in: query required: false schema: default: desc - name: aggregate in: query required: false schema: default: false - name: aggregate_show in: query required: false schema: default: 10 - name: text_search in: query required: false schema: {} - name: ai_only in: query required: false schema: default: false - name: actor in: query required: false schema: default: false /wpcom/v2/sites/{wpcom_site}/activity/{rewind_id}: get: operationId: getWpcomV2SitesbyWpcomSiteActivitybyRewindId summary: GET /wpcom/v2/sites/{wpcom_site}/activity/{rewind_id} tags: - activity responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: rewind_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/activity/{rewind_id}/share: post: operationId: postWpcomV2SitesbyWpcomSiteActivitybyRewindIdShare summary: POST /wpcom/v2/sites/{wpcom_site}/activity/{rewind_id}/share tags: - activity responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: rewind_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: email: type: string format: email required: - email /wpcom/v2/sites/{wpcom_site}/activitypub/status: get: operationId: getWpcomV2SitesbyWpcomSiteActivitypubStatus summary: GET /wpcom/v2/sites/{wpcom_site}/activitypub/status tags: - activitypub responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteActivitypubStatus summary: POST /wpcom/v2/sites/{wpcom_site}/activitypub/status tags: - activitypub responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: enabled: type: boolean description: Enable or disable ActivityPub put: operationId: putWpcomV2SitesbyWpcomSiteActivitypubStatus summary: PUT /wpcom/v2/sites/{wpcom_site}/activitypub/status tags: - activitypub responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: enabled: type: boolean description: Enable or disable ActivityPub patch: operationId: patchWpcomV2SitesbyWpcomSiteActivitypubStatus summary: PATCH /wpcom/v2/sites/{wpcom_site}/activitypub/status tags: - activitypub responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: enabled: type: boolean description: Enable or disable ActivityPub /wpcom/v2/sites/{wpcom_site}/adflow/conf: get: operationId: getWpcomV2SitesbyWpcomSiteAdflowConf summary: GET /wpcom/v2/sites/{wpcom_site}/adflow/conf tags: - adflow responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: _jsonp in: query required: true schema: type: string description: JSONP callback - name: is_singular in: query required: false schema: type: integer default: 0 description: Whether the request is for a singular post (1 for true, 0 for false) /wpcom/v2/sites/{wpcom_site}/admin-bar: get: operationId: getWpcomV2SitesbyWpcomSiteAdminBar summary: GET /wpcom/v2/sites/{wpcom_site}/admin-bar tags: - admin-bar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/admin-color: get: operationId: getWpcomV2SitesbyWpcomSiteAdminColor summary: GET /wpcom/v2/sites/{wpcom_site}/admin-color tags: - admin-color responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/admin-menu: get: operationId: getWpcomV2SitesbyWpcomSiteAdminMenu summary: GET /wpcom/v2/sites/{wpcom_site}/admin-menu tags: - admin-menu responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/ai-agents-settings: get: operationId: getWpcomV2SitesbyWpcomSiteAiAgentsSettings summary: GET /wpcom/v2/sites/{wpcom_site}/ai-agents-settings tags: - ai-agents-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: postWpcomV2SitesbyWpcomSiteAiAgentsSettings summary: POST /wpcom/v2/sites/{wpcom_site}/ai-agents-settings tags: - ai-agents-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: enabled: type: boolean required: - enabled /wpcom/v2/sites/{wpcom_site}/ai-image: post: operationId: postWpcomV2SitesbyWpcomSiteAiImage summary: POST /wpcom/v2/sites/{wpcom_site}/ai-image tags: - ai-image responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: token: type: string description: The JWT token to authenticate the request. prompt: type: string description: The prompt to generate the image. model: type: string enum: - stable-diffusion - flux default: stable-diffusion description: The model to use for the image generation. style: type: string enum: - 3d-model - analog-film - anime - cinematic - comicbook - craft-clay - digital-art - enhance - fantasy-art - isometric - line-art - lowpoly - neonpunk - origami - photographic - pixel-art - texture description: The style of the image. width: type: number enum: - 512 - 768 - 1024 - 1360 description: Width of the image. height: type: number enum: - 512 - 768 - 1024 - 1360 description: Height of the image. required: - prompt /wpcom/v2/sites/{wpcom_site}/ai-launchpad: get: operationId: getWpcomV2SitesbyWpcomSiteAiLaunchpad summary: GET /wpcom/v2/sites/{wpcom_site}/ai-launchpad tags: - ai-launchpad responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: all_tasks in: query required: false schema: type: boolean default: false description: Return the full task catalog instead of the tailored list (testing aid). delete: operationId: deleteWpcomV2SitesbyWpcomSiteAiLaunchpad summary: DELETE /wpcom/v2/sites/{wpcom_site}/ai-launchpad tags: - ai-launchpad responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/ai-launchpad/available-tasks: get: operationId: getWpcomV2SitesbyWpcomSiteAiLaunchpadAvailableTasks summary: GET /wpcom/v2/sites/{wpcom_site}/ai-launchpad/available-tasks tags: - ai-launchpad responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: goal in: query required: false schema: type: string default: '' description: The selected goal; sell keeps commerce tasks as available previews. /wpcom/v2/sites/{wpcom_site}/ai-launchpad/complete-task: post: operationId: postWpcomV2SitesbyWpcomSiteAiLaunchpadCompleteTask summary: POST /wpcom/v2/sites/{wpcom_site}/ai-launchpad/complete-task tags: - ai-launchpad responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: task_id: type: string description: The acknowledgment task to mark complete. required: - task_id /wpcom/v2/sites/{wpcom_site}/ai-launchpad/skip-task: post: operationId: postWpcomV2SitesbyWpcomSiteAiLaunchpadSkipTask summary: POST /wpcom/v2/sites/{wpcom_site}/ai-launchpad/skip-task tags: - ai-launchpad responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: task_id: type: string description: The task to skip. required: - task_id /wpcom/v2/sites/{wpcom_site}/ai-launchpad/tailored: put: operationId: putWpcomV2SitesbyWpcomSiteAiLaunchpadTailored summary: PUT /wpcom/v2/sites/{wpcom_site}/ai-launchpad/tailored tags: - ai-launchpad responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: source: type: string enum: - ai - fallback default: ai description: Whether the payload came from the AI or the deterministic fallback. Query parameter; the JSON body must match the agent output schema exactly. duration_ms: type: integer description: Client-measured tailoring duration in milliseconds, for the tailored Logstash record. attempts: type: integer description: How many jetpack-ai-query attempts the client made, for the tailored Logstash record. /wpcom/v2/sites/{wpcom_site}/ai-launchpad/wizard: put: operationId: putWpcomV2SitesbyWpcomSiteAiLaunchpadWizard summary: PUT /wpcom/v2/sites/{wpcom_site}/ai-launchpad/wizard tags: - ai-launchpad responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: goal: type: string enum: - write - build - sell - newsletter - educate - portfolio description: The site goal picked in the wizard. site_name: type: string description: The site name entered in the wizard. description: type: string description: The free-text site description entered in the wizard. locale: type: string default: en description: The user locale. required: - goal - site_name - description /wpcom/v2/sites/{wpcom_site}/ai/asset/{jwt}/download: get: operationId: getWpcomV2SitesbyWpcomSiteAiAssetbyJwtDownload summary: GET /wpcom/v2/sites/{wpcom_site}/ai/asset/{jwt}/download tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: jwt in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/ai/transcription: post: operationId: postWpcomV2SitesbyWpcomSiteAiTranscription summary: POST /wpcom/v2/sites/{wpcom_site}/ai/transcription tags: - ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: intent: type: string description: 'Transcription intent: dictation, command, agent, or auto.' selected_text: type: string description: Selected text to transform when intent is command. app_context: type: string description: JSON encoded client context. client: type: string description: Client identifier. client_version: type: string description: Client version. audio_file: type: string description: The audio file to transcribe. save_artifact: type: boolean default: false description: When true, save the transcript as a private wp_guideline artifact post tagged Transcription. /wpcom/v2/sites/{wpcom_site}/alerts: get: operationId: getWpcomV2SitesbyWpcomSiteAlerts summary: GET /wpcom/v2/sites/{wpcom_site}/alerts tags: - alerts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteAlerts summary: POST /wpcom/v2/sites/{wpcom_site}/alerts tags: - alerts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: type: type: string slug: type: string version: type: string required: - type put: operationId: putWpcomV2SitesbyWpcomSiteAlerts summary: PUT /wpcom/v2/sites/{wpcom_site}/alerts tags: - alerts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: type: type: string slug: type: string version: type: string required: - type patch: operationId: patchWpcomV2SitesbyWpcomSiteAlerts summary: PATCH /wpcom/v2/sites/{wpcom_site}/alerts tags: - alerts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: type: type: string slug: type: string version: type: string required: - type /wpcom/v2/sites/{wpcom_site}/alerts/fix: get: operationId: getWpcomV2SitesbyWpcomSiteAlertsFix summary: GET /wpcom/v2/sites/{wpcom_site}/alerts/fix tags: - alerts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: threat_ids in: query required: true schema: type: array items: type: integer post: operationId: postWpcomV2SitesbyWpcomSiteAlertsFix summary: POST /wpcom/v2/sites/{wpcom_site}/alerts/fix tags: - alerts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: threat_ids: type: array items: type: integer required: - threat_ids put: operationId: putWpcomV2SitesbyWpcomSiteAlertsFix summary: PUT /wpcom/v2/sites/{wpcom_site}/alerts/fix tags: - alerts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: threat_ids: type: array items: type: integer required: - threat_ids patch: operationId: patchWpcomV2SitesbyWpcomSiteAlertsFix summary: PATCH /wpcom/v2/sites/{wpcom_site}/alerts/fix tags: - alerts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: threat_ids: type: array items: type: integer required: - threat_ids /wpcom/v2/sites/{wpcom_site}/alerts/{id}: get: operationId: getWpcomV2SitesbyWpcomSiteAlertsbyId summary: GET /wpcom/v2/sites/{wpcom_site}/alerts/{id} tags: - alerts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: postWpcomV2SitesbyWpcomSiteAlertsbyId summary: POST /wpcom/v2/sites/{wpcom_site}/alerts/{id} tags: - alerts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: ignore: type: boolean default: false unignore: type: boolean default: false fix: type: boolean default: false put: operationId: putWpcomV2SitesbyWpcomSiteAlertsbyId summary: PUT /wpcom/v2/sites/{wpcom_site}/alerts/{id} tags: - alerts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: ignore: type: boolean default: false unignore: type: boolean default: false fix: type: boolean default: false patch: operationId: patchWpcomV2SitesbyWpcomSiteAlertsbyId summary: PATCH /wpcom/v2/sites/{wpcom_site}/alerts/{id} tags: - alerts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: ignore: type: boolean default: false unignore: type: boolean default: false fix: type: boolean default: false /wpcom/v2/sites/{wpcom_site}/analytics/options/campaigns: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsOptionsCampaigns summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/options/campaigns tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: Search query to filter items. - 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: limit in: query required: false schema: type: integer description: Maximum number of items to be returned (alternative to per_page). - name: orderby in: query required: false schema: type: string description: Order by parameter. - name: order in: query required: false schema: type: string enum: - ASC - DESC default: ASC description: Order parameter. - name: cachebuster in: query required: false schema: type: string description: Cachebuster parameter to force fresh data retrieval. /wpcom/v2/sites/{wpcom_site}/analytics/options/channels: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsOptionsChannels summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/options/channels tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: Search query to filter items. - 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: limit in: query required: false schema: type: integer description: Maximum number of items to be returned (alternative to per_page). - name: orderby in: query required: false schema: type: string description: Order by parameter. - name: order in: query required: false schema: type: string enum: - ASC - DESC default: ASC description: Order parameter. - name: cachebuster in: query required: false schema: type: string description: Cachebuster parameter to force fresh data retrieval. /wpcom/v2/sites/{wpcom_site}/analytics/options/channels-sources: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsOptionsChannelsSources summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/options/channels-sources tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: Search query to filter items. - 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: limit in: query required: false schema: type: integer description: Maximum number of items to be returned (alternative to per_page). - name: orderby in: query required: false schema: type: string description: Order by parameter. - name: order in: query required: false schema: type: string enum: - ASC - DESC default: ASC description: Order parameter. - name: cachebuster in: query required: false schema: type: string description: Cachebuster parameter to force fresh data retrieval. /wpcom/v2/sites/{wpcom_site}/analytics/options/sources: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsOptionsSources summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/options/sources tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: Search query to filter items. - 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: limit in: query required: false schema: type: integer description: Maximum number of items to be returned (alternative to per_page). - name: orderby in: query required: false schema: type: string description: Order by parameter. - name: order in: query required: false schema: type: string enum: - ASC - DESC default: ASC description: Order parameter. - name: cachebuster in: query required: false schema: type: string description: Cachebuster parameter to force fresh data retrieval. /wpcom/v2/sites/{wpcom_site}/analytics/reports/bookings/by-date: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsBookingsByDate summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/bookings/by-date tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Start date/time (ISO8601) for the report. e.g. 2020-01-01T12:00:00. - name: to in: query required: true schema: type: string format: date-time description: End date/time (ISO8601) for the report. e.g. 2020-03-01T16:00:00. - name: interval in: query required: true schema: type: string enum: - hour - day - week - month - quarter - year description: The time interval for the report. - name: date_type in: query required: false schema: type: string enum: - created - paid - completed description: The order date field to use for filtering (created, paid, completed). When specified, filters by order dates instead of booking dates. - name: filters in: query required: false schema: type: array items: type: object description: Filters to apply to the report. - name: fields in: query required: false schema: type: array items: type: string description: Fields to include in the response. /wpcom/v2/sites/{wpcom_site}/analytics/reports/coupons: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsCoupons summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/coupons tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Start date/time (ISO8601) for the report. - name: to in: query required: true schema: type: string format: date-time description: End date/time (ISO8601) for the report. - name: date_type in: query required: false schema: type: string enum: - created - paid - completed description: The date field to use for filtering (created, paid, completed). Defaults to site setting. - name: orderby in: query required: false schema: type: string enum: - discount_amount - orders_count - coupon_code - total_sales default: discount_amount description: Field to sort by. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Sort direction. - name: filters in: query required: false schema: type: array items: type: object description: Filters to apply to the report. - name: fields in: query required: false schema: type: array items: type: string description: Fields to include in the response. /wpcom/v2/sites/{wpcom_site}/analytics/reports/coupons/by-date: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsCouponsByDate summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/coupons/by-date tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Start date/time (ISO8601) for the report. - name: to in: query required: true schema: type: string format: date-time description: End date/time (ISO8601) for the report. - name: date_type in: query required: false schema: type: string enum: - created - paid - completed description: The date field to use for filtering (created, paid, completed). Defaults to site setting. - name: interval in: query required: true schema: type: string enum: - hour - day - week - month - quarter - year description: Time interval for grouping data. - name: filters in: query required: false schema: type: array items: type: object description: Filters to apply to the report. - name: fields in: query required: false schema: type: array items: type: string description: Fields to include in the response. /wpcom/v2/sites/{wpcom_site}/analytics/reports/customers/by-date: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsCustomersByDate summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/customers/by-date tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Start date/time (ISO8601) for the report. - name: to in: query required: true schema: type: string format: date-time description: End date/time (ISO8601) for the report. - name: interval in: query required: true schema: type: string enum: - hour - day - week - month - quarter - year description: The time interval for the report. - name: filters in: query required: false schema: type: array items: type: object description: Filters to apply to the report. - name: date_type in: query required: false schema: type: string enum: - created - paid - completed description: The date field to use for filtering (created, paid, completed). Defaults to site setting. - name: fields in: query required: false schema: type: array items: type: string description: Fields to include in the response. /wpcom/v2/sites/{wpcom_site}/analytics/reports/customers/new-returning: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsCustomersNewReturning summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/customers/new-returning tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Start date/time (ISO8601) for the report. - name: to in: query required: true schema: type: string format: date-time description: End date/time (ISO8601) for the report. - name: filters in: query required: false schema: type: array items: type: object description: Filters to apply to the report. - name: date_type in: query required: false schema: type: string enum: - created - paid - completed description: The date field to use for filtering (created, paid, completed). Defaults to site setting. - name: fields in: query required: false schema: type: array items: type: string description: Fields to include in the response. /wpcom/v2/sites/{wpcom_site}/analytics/reports/forecast-with-narrative: post: operationId: postWpcomV2SitesbyWpcomSiteAnalyticsReportsForecastWithNarrative summary: POST /wpcom/v2/sites/{wpcom_site}/analytics/reports/forecast-with-narrative tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: product_id: type: integer from: type: string format: date-time description: Start of the historical training window (ISO-8601 datetime). to: type: string format: date-time description: End of the historical training window (ISO-8601 datetime). prediction_periods: type: integer prediction_granularity: type: string enum: - day - week - month narrative: type: boolean default: true required: - product_id - from - to - prediction_periods - prediction_granularity /wpcom/v2/sites/{wpcom_site}/analytics/reports/log-diagnostics: post: operationId: postWpcomV2SitesbyWpcomSiteAnalyticsReportsLogDiagnostics summary: POST /wpcom/v2/sites/{wpcom_site}/analytics/reports/log-diagnostics tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: scan_id: type: string generated_at: type: string local_evidence: type: array items: type: object metadata: type: object required: - local_evidence /wpcom/v2/sites/{wpcom_site}/analytics/reports/order-attribution-by-product/{view}/summary: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsOrderAttributionByProductbyViewSummary summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/order-attribution-by-product/{view}/summary tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: view in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Attribution items from this given ISO8601 compliant date. - name: to in: query required: true schema: type: string format: date-time description: Attribution items upto this given ISO8601 compliant date. - name: interval in: query required: true schema: type: string enum: - hour - day - week - month - quarter - year description: The interval length to be used in the graph. - name: include_unassigned in: query required: false schema: type: boolean default: true description: Include unassigned items in the result set. - name: filters in: query required: false schema: type: array items: type: object description: Filters to apply to the report. - name: date_type in: query required: false schema: type: string enum: - created - paid - completed description: The date field to use for filtering (created, paid, completed). Defaults to site setting. /wpcom/v2/sites/{wpcom_site}/analytics/reports/order-attribution/{view}/compare: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsOrderAttributionbyViewCompare summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/order-attribution/{view}/compare tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: view in: path required: true schema: type: string - name: item in: query required: true schema: type: array items: type: string description: Limit comparison to the specified items. - name: from in: query required: true schema: type: string format: date-time description: Attribution items from this given ISO8601 compliant date. - name: to in: query required: true schema: type: string format: date-time description: Attribution items upto this given ISO8601 compliant date. - name: interval in: query required: true schema: type: string enum: - hour - day - week - month - quarter - year description: The interval length to be used in the graph. - name: filters in: query required: false schema: type: array items: type: object description: Filters to apply to the report. - name: date_type in: query required: false schema: type: string enum: - created - paid - completed description: The date field to use for filtering (created, paid, completed). Defaults to site setting. /wpcom/v2/sites/{wpcom_site}/analytics/reports/order-attribution/{view}/items: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsOrderAttributionbyViewItems summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/order-attribution/{view}/items tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: view in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Attribution items from this given ISO8601 compliant date. - name: to in: query required: true schema: type: string format: date-time description: Attribution items upto this given ISO8601 compliant date. - name: limit in: query required: false schema: type: integer default: 100 description: Maximum number of items to be returned in result set. - name: page in: query required: false schema: type: integer default: 1 description: Current page of the collection. - name: orderby in: query required: false schema: type: string enum: - item - net_sales - gross_sales - total_sales - orders_count - refunds - fees - taxes - coupons - shipping - total_customers - new_customers - repeat_orders - avg_order_value - avg_items default: net_sales description: Sort collection by item attribute. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Order sort attribute ascending or descending. - name: item in: query required: false schema: type: array items: type: string description: Limit comparison to the specified items. - name: include_unassigned in: query required: false schema: type: boolean default: true description: Include unassigned items in the result set. - name: filters in: query required: false schema: type: array items: type: object description: Filters to apply to the report. - name: date_type in: query required: false schema: type: string enum: - created - paid - completed description: The date field to use for filtering (created, paid, completed). Defaults to site setting. - name: fields in: query required: false schema: type: array items: type: string description: Fields to include in the response. /wpcom/v2/sites/{wpcom_site}/analytics/reports/order-attribution/{view}/summary: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsOrderAttributionbyViewSummary summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/order-attribution/{view}/summary tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: view in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Attribution items from this given ISO8601 compliant date. - name: to in: query required: true schema: type: string format: date-time description: Attribution items upto this given ISO8601 compliant date. - name: compare_from in: query required: true schema: type: string format: date-time description: Compare attribution items from this given ISO8601 compliant date. - name: compare_to in: query required: true schema: type: string format: date-time description: Compare attribution items upto this given ISO8601 compliant date. - name: interval in: query required: true schema: type: string enum: - hour - day - week - month - quarter - year description: The interval length to be used in the graph. - name: include_unassigned in: query required: false schema: type: boolean default: true description: Include unassigned items in the result set. - name: filters in: query required: false schema: type: array items: type: object description: Filters to apply to the report. - name: date_type in: query required: false schema: type: string enum: - created - paid - completed description: The date field to use for filtering (created, paid, completed). Defaults to site setting. /wpcom/v2/sites/{wpcom_site}/analytics/reports/orders-by-product-type/by-date: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsOrdersByProductTypeByDate summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/orders-by-product-type/by-date tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Start date/time (ISO8601) for the report. e.g. 2020-01-01T12:00:00. - name: to in: query required: true schema: type: string format: date-time description: End date/time (ISO8601) for the report. e.g. 2020-03-01T16:00:00. - name: interval in: query required: true schema: type: string enum: - hour - day - week - month - quarter - year description: The time interval for the report. - name: filters in: query required: false schema: type: array items: type: object description: Filters to apply to the report. - name: date_type in: query required: false schema: type: string enum: - created - paid - completed description: The date field to use for filtering (created, paid, completed). Defaults to site setting. - name: fields in: query required: false schema: type: array items: type: string description: Fields to include in the response. /wpcom/v2/sites/{wpcom_site}/analytics/reports/orders/by-date: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsOrdersByDate summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/orders/by-date tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Start date/time (ISO8601) for the report. e.g. 2020-01-01T12:00:00. - name: to in: query required: true schema: type: string format: date-time description: End date/time (ISO8601) for the report. e.g. 2020-03-01T16:00:00. - name: interval in: query required: true schema: type: string enum: - hour - day - week - month - quarter - year description: The time interval for the report. - name: date_type in: query required: false schema: type: string enum: - created - paid - completed description: The date field to use for filtering (created, paid, completed). Defaults to site setting. - name: filters in: query required: false schema: type: array items: type: object description: Filters to apply to the report. - name: fields in: query required: false schema: type: array items: type: string description: Fields to include in the response. /wpcom/v2/sites/{wpcom_site}/analytics/reports/products: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsProducts summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/products tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Start date/time (ISO8601) for the report. - name: to in: query required: true schema: type: string format: date-time description: End date/time (ISO8601) for the report. - name: orderby in: query required: false schema: type: string enum: - product_net_revenue - product_gross_revenue - total_quantity - orders_count - product_name - sku - product_type default: product_net_revenue description: Field to sort by. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Sort direction. - name: limit in: query required: false schema: type: integer default: 100 description: Maximum number of items to be returned in result set. - name: filters in: query required: false schema: type: array items: type: object description: Filters to apply to the report. - name: date_type in: query required: false schema: type: string enum: - created - paid - completed description: The date field to use for filtering (created, paid, completed). Defaults to site setting. - name: fields in: query required: false schema: type: array items: type: string description: Fields to include in the response. /wpcom/v2/sites/{wpcom_site}/analytics/reports/segment-narrative: post: operationId: postWpcomV2SitesbyWpcomSiteAnalyticsReportsSegmentNarrative summary: POST /wpcom/v2/sites/{wpcom_site}/analytics/reports/segment-narrative tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: cohort: type: object description: Optional cohort context — surfaces the merchant's pre-filter to the LLM so the playbook adapts. segments: type: array items: type: object description: Aggregate per-segment summaries — no PII. required: - segments /wpcom/v2/sites/{wpcom_site}/analytics/reports/sessions/by-conversion-rate: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsSessionsByConversionRate summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/sessions/by-conversion-rate tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Start date/time (ISO8601) for the report. e.g. 2020-01-01T12:00:00. - name: to in: query required: true schema: type: string format: date-time description: End date/time (ISO8601) for the report. e.g. 2020-03-01T16:00:00. - name: interval in: query required: true schema: type: string enum: - hour - day - week - month - quarter - year description: The interval for the report. - name: filters in: query required: false schema: type: array items: type: object description: Filters to apply to the report. - name: fields in: query required: false schema: type: array items: type: string description: Fields to include in the response. /wpcom/v2/sites/{wpcom_site}/analytics/reports/sessions/by-date: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsSessionsByDate summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/sessions/by-date tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Start date/time (ISO8601) for the report. e.g. 2020-01-01T12:00:00. - name: to in: query required: true schema: type: string format: date-time description: End date/time (ISO8601) for the report. e.g. 2020-03-01T16:00:00. - name: interval in: query required: true schema: type: string enum: - hour - day - week - month - quarter - year description: The interval for the report. - name: filters in: query required: false schema: type: array items: type: object description: Filters to apply to the report. - name: fields in: query required: false schema: type: array items: type: string description: Fields to include in the response. /wpcom/v2/sites/{wpcom_site}/analytics/reports/sessions/by-device: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsSessionsByDevice summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/sessions/by-device tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Start date/time (ISO8601) for the report. e.g. 2020-01-01T12:00:00. - name: to in: query required: true schema: type: string format: date-time description: End date/time (ISO8601) for the report. e.g. 2020-03-01T16:00:00. - name: fields in: query required: false schema: type: array items: type: string description: Fields to include in the response. /wpcom/v2/sites/{wpcom_site}/analytics/reports/sessions/by-location: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsSessionsByLocation summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/sessions/by-location tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Start date/time (ISO8601) for the report. e.g. 2020-01-01T12:00:00. - name: to in: query required: true schema: type: string format: date-time description: End date/time (ISO8601) for the report. e.g. 2020-03-01T16:00:00. - name: group_by in: query required: false schema: type: string enum: - country - region default: country description: How to group location items. Use "country" for worldwide and "region" to group within a country (requires country_code). - name: country_code in: query required: false schema: type: string description: ISO-3166-1 alpha-2 country code. Required when group_by=region. - name: limit in: query required: false schema: type: integer default: 10 description: Maximum number of items to be returned in result set. - name: fields in: query required: false schema: type: array items: type: string description: Fields to include in the response. /wpcom/v2/sites/{wpcom_site}/analytics/reports/taxes/breakdown: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsTaxesBreakdown summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/taxes/breakdown tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Start date/time (ISO8601) for the report. - name: to in: query required: true schema: type: string format: date-time description: End date/time (ISO8601) for the report. - name: date_type in: query required: false schema: type: string enum: - created - paid - completed description: The date field to use for filtering (created, paid, completed). Defaults to site setting. - name: orderby in: query required: false schema: type: string enum: - total_tax - order_tax - shipping_tax - orders_count - tax_rate_code default: total_tax description: Field to sort by. - name: order in: query required: false schema: type: string enum: - asc - desc default: desc description: Sort direction. - name: filters in: query required: false schema: type: array items: type: object description: Filters to apply to the report. - name: fields in: query required: false schema: type: array items: type: string description: Fields to include in the response. /wpcom/v2/sites/{wpcom_site}/analytics/reports/taxes/by-date: get: operationId: getWpcomV2SitesbyWpcomSiteAnalyticsReportsTaxesByDate summary: GET /wpcom/v2/sites/{wpcom_site}/analytics/reports/taxes/by-date tags: - analytics responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: from in: query required: true schema: type: string format: date-time description: Start date/time (ISO8601) for the report. - name: to in: query required: true schema: type: string format: date-time description: End date/time (ISO8601) for the report. - name: date_type in: query required: false schema: type: string enum: - created - paid - completed description: The date field to use for filtering (created, paid, completed). Defaults to site setting. - name: interval in: query required: true schema: type: string enum: - hour - day - week - month - quarter - year description: Time interval for grouping data. - name: filters in: query required: false schema: type: array items: type: object description: Filters to apply to the report. - name: fields in: query required: false schema: type: array items: type: string description: Fields to include in the response. /wpcom/v2/sites/{wpcom_site}/app-media: get: operationId: getWpcomV2SitesbyWpcomSiteAppMedia summary: GET /wpcom/v2/sites/{wpcom_site}/app-media tags: - app-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: number in: query required: false schema: type: number default: 20 description: Number of media items in the request - name: page_handle in: query required: false schema: type: number default: 1 - name: after in: query required: true schema: type: number default: 0 description: Timestamp since the media was uploaded /wpcom/v2/sites/{wpcom_site}/articles: get: operationId: getWpcomV2SitesbyWpcomSiteArticles summary: GET /wpcom/v2/sites/{wpcom_site}/articles tags: - articles responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: className in: query required: false schema: type: string default: '' - name: showExcerpt in: query required: false schema: type: boolean default: true - name: showFullContent in: query required: false schema: type: boolean default: false - name: excerptLength in: query required: false schema: type: number default: 55 - name: showReadMore in: query required: false schema: type: boolean default: false - name: infiniteScroll in: query required: false schema: type: boolean default: false - name: readMoreLabel in: query required: false schema: type: string default: Keep reading - name: showDate in: query required: false schema: type: boolean default: true - name: showImage in: query required: false schema: type: boolean default: true - name: showCaption in: query required: false schema: type: boolean default: false - name: showCredit in: query required: false schema: type: boolean default: false - name: disableImageLazyLoad in: query required: false schema: type: boolean default: false - name: fetchPriority in: query required: false schema: type: string default: '' - name: imageShape in: query required: false schema: type: string default: landscape - name: minHeight in: query required: false schema: type: integer default: 0 - name: moreButton in: query required: false schema: type: boolean default: false - name: moreButtonText in: query required: false schema: type: string default: '' - name: showAuthor in: query required: false schema: type: boolean default: true - name: showAvatar in: query required: false schema: type: boolean default: true - name: showCategory in: query required: false schema: type: boolean default: false - name: postLayout in: query required: false schema: type: string default: list - name: columns in: query required: false schema: type: integer default: 3 - name: colGap in: query required: false schema: type: integer default: 3 - name: postsToShow in: query required: false schema: type: integer default: 3 - name: mediaPosition in: query required: false schema: type: string default: top - name: authors in: query required: false schema: type: array default: [] items: type: integer - name: categories in: query required: false schema: type: array default: [] items: type: integer - name: categoryJoinType in: query required: false schema: type: string enum: - or - all default: or - name: includeSubcategories in: query required: false schema: type: boolean default: true - name: tags in: query required: false schema: type: array default: [] items: type: integer - name: customTaxonomies in: query required: false schema: type: array default: [] items: type: object - name: tagExclusions in: query required: false schema: type: array default: [] items: type: integer - name: categoryExclusions in: query required: false schema: type: array default: [] items: type: integer - name: customTaxonomyExclusions in: query required: false schema: type: array default: [] items: type: object - name: specificPosts in: query required: false schema: type: array default: [] items: type: integer - name: typeScale in: query required: false schema: type: integer default: 4 - name: imageScale in: query required: false schema: type: integer default: 3 - name: mobileStack in: query required: false schema: type: boolean default: false - name: sectionHeader in: query required: false schema: type: string default: '' - name: specificMode in: query required: false schema: type: boolean default: false - name: textColor in: query required: false schema: type: string default: '' - name: customTextColor in: query required: false schema: type: string default: '' - name: singleMode in: query required: false schema: type: boolean default: false - name: showSubtitle in: query required: false schema: type: boolean default: false - name: postType in: query required: false schema: type: array default: - post items: type: string - name: textAlign in: query required: false schema: type: string default: left - name: includedPostStatuses in: query required: false schema: type: array default: - publish items: type: string - name: deduplicate in: query required: false schema: type: boolean default: true - name: exclude_ids in: query required: false schema: type: array default: [] items: type: integer /wpcom/v2/sites/{wpcom_site}/atomic-migration-status: post: operationId: postWpcomV2SitesbyWpcomSiteAtomicMigrationStatus summary: POST /wpcom/v2/sites/{wpcom_site}/atomic-migration-status tags: - atomic-migration-status responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: status: type: string enum: - started description: Set the status of the migration, only allowed value for the time being is "started" migration_type: type: string enum: - migrate-guru description: Specify which type of migration is involved required: - status - migration_type /wpcom/v2/sites/{wpcom_site}/atomic-migration-status/migrate-guru-key: get: operationId: getWpcomV2SitesbyWpcomSiteAtomicMigrationStatusMigrateGuruKey summary: GET /wpcom/v2/sites/{wpcom_site}/atomic-migration-status/migrate-guru-key tags: - atomic-migration-status responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/atomic-migration-status/wpcom-migration-key: get: operationId: getWpcomV2SitesbyWpcomSiteAtomicMigrationStatusWpcomMigrationKey summary: GET /wpcom/v2/sites/{wpcom_site}/atomic-migration-status/wpcom-migration-key tags: - atomic-migration-status responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/atomic/transfer-ssh-migration: post: operationId: postWpcomV2SitesbyWpcomSiteAtomicTransferSshMigration summary: POST /wpcom/v2/sites/{wpcom_site}/atomic/transfer-ssh-migration tags: - atomic responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/atomic/transfer-with-software: post: operationId: postWpcomV2SitesbyWpcomSiteAtomicTransferWithSoftware summary: POST /wpcom/v2/sites/{wpcom_site}/atomic/transfer-with-software tags: - atomic responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: plugin_slug: type: string default: '' theme_slug: type: string default: '' settings: type: object default: [] context: type: string default: rest_api_v2_atomic_transfer_with_software description: Flow, page or action that initiated this transfer request. /wpcom/v2/sites/{wpcom_site}/automated-migration: post: operationId: postWpcomV2SitesbyWpcomSiteAutomatedMigration summary: POST /wpcom/v2/sites/{wpcom_site}/automated-migration tags: - automated-migration responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: locale: type: string default: en description: User current locale. from_url: type: string description: The URL of the source blog or a backup to migrate from. migration_type: type: string enum: - credentials - backup description: The type of migration to perform. Can be either "credentials" or "backup". username: type: string description: The username to use for the credentials migration. password: type: string description: The password to use for the credentials migration. notes: type: string default: '' description: Additional notes to include with the migration request. required: - from_url - migration_type /wpcom/v2/sites/{wpcom_site}/automated-migration/application-passwords: post: operationId: postWpcomV2SitesbyWpcomSiteAutomatedMigrationApplicationPasswords summary: POST /wpcom/v2/sites/{wpcom_site}/automated-migration/application-passwords tags: - automated-migration responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: from_url: type: string description: The URL of the site. username: type: string description: The login of the user. password: type: string description: The application password for the user. required: - from_url - username - password /wpcom/v2/sites/{wpcom_site}/automated-migration/application-passwords/setup: post: operationId: postWpcomV2SitesbyWpcomSiteAutomatedMigrationApplicationPasswordsSetup summary: POST /wpcom/v2/sites/{wpcom_site}/automated-migration/application-passwords/setup tags: - automated-migration responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: source: type: string description: The URL of the source site. required: - source /wpcom/v2/sites/{wpcom_site}/automated-migration/cancel-migration: post: operationId: postWpcomV2SitesbyWpcomSiteAutomatedMigrationCancelMigration summary: POST /wpcom/v2/sites/{wpcom_site}/automated-migration/cancel-migration tags: - automated-migration responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/automated-migration/find-ticket: get: operationId: getWpcomV2SitesbyWpcomSiteAutomatedMigrationFindTicket summary: GET /wpcom/v2/sites/{wpcom_site}/automated-migration/find-ticket tags: - automated-migration responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/automated-migration/wpcom-survey: post: operationId: postWpcomV2SitesbyWpcomSiteAutomatedMigrationWpcomSurvey summary: POST /wpcom/v2/sites/{wpcom_site}/automated-migration/wpcom-survey tags: - automated-migration responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: intents: type: array items: type: string description: An array of user intents. Must contain at least one valid intent. other_details: type: string description: Optional additional details. required: - intents /wpcom/v2/sites/{wpcom_site}/backup/retention/update: post: operationId: postWpcomV2SitesbyWpcomSiteBackupRetentionUpdate summary: POST /wpcom/v2/sites/{wpcom_site}/backup/retention/update tags: - backup responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: retention_days: type: integer description: The backup retention period in days. required: - retention_days /wpcom/v2/sites/{wpcom_site}/big-sky/build-progress: get: operationId: getWpcomV2SitesbyWpcomSiteBigSkyBuildProgress summary: GET /wpcom/v2/sites/{wpcom_site}/big-sky/build-progress tags: - big-sky responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/big-sky/build-wow: post: operationId: postWpcomV2SitesbyWpcomSiteBigSkyBuildWow summary: POST /wpcom/v2/sites/{wpcom_site}/big-sky/build-wow tags: - big-sky responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: spec_id: type: string /wpcom/v2/sites/{wpcom_site}/big-sky/build-wow/status: get: operationId: getWpcomV2SitesbyWpcomSiteBigSkyBuildWowStatus summary: GET /wpcom/v2/sites/{wpcom_site}/big-sky/build-wow/status tags: - big-sky responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/big-sky/trigger-backend-build: post: operationId: postWpcomV2SitesbyWpcomSiteBigSkyTriggerBackendBuild summary: POST /wpcom/v2/sites/{wpcom_site}/big-sky/trigger-backend-build tags: - big-sky responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: spec_id: type: string required: - spec_id /wpcom/v2/sites/{wpcom_site}/blaze/posts: get: operationId: getWpcomV2SitesbyWpcomSiteBlazePosts summary: GET /wpcom/v2/sites/{wpcom_site}/blaze/posts tags: - blaze responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: title in: query required: false schema: type: string description: Search for posts by title - name: page in: query required: false schema: type: integer default: 1 description: 'Current page of the collection. A max of 20 items will be returned per page. Does not apply for fields: like_count and monthly_view_count which will return the full collection' - name: posts_per_page in: query required: false schema: type: integer default: 20 description: 'Max number of posts to include in the result, with a maximum of 20. Does not apply for fields: like_count and monthly_view_count which will return the full collection' - name: order_by in: query required: false schema: type: string enum: - post_title - type - date - modified - comment_count - like_count - monthly_view_count description: 'Order by field. Valid values are: post_title, type, date, modified, comment_count, like_count, monthly_view_count' - name: order in: query required: false schema: type: string enum: - asc - desc description: 'Order by ascendent or descendent. Valid values are: asc, desc' - name: filter_post_type in: query required: false schema: type: string description: 'Comma-separated list of post types to filter. Valid values are: post, page, product.' /wpcom/v2/sites/{wpcom_site}/blaze/posts/{post_id}: get: operationId: getWpcomV2SitesbyWpcomSiteBlazePostsbyPostId summary: GET /wpcom/v2/sites/{wpcom_site}/blaze/posts/{post_id} tags: - blaze responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: post_id in: path required: true schema: type: string - name: start_date in: query required: false schema: type: integer description: 'Filter views by start date. Format: YYYYMMDD' - name: end_date in: query required: false schema: type: integer description: 'Filter views by end date: YYYYMMDD. Required if using startdate param.' /wpcom/v2/sites/{wpcom_site}/blaze/posts/{post_id}/view-stats: get: operationId: getWpcomV2SitesbyWpcomSiteBlazePostsbyPostIdViewStats summary: GET /wpcom/v2/sites/{wpcom_site}/blaze/posts/{post_id}/view-stats tags: - blaze responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: post_id in: path required: true schema: type: string - name: start_date in: query required: true schema: type: integer description: 'Filter views by start date. Format: YYYYMMDD' - name: end_date in: query required: true schema: type: integer description: 'Filter views by end date. Format: YYYYMMDD' /wpcom/v2/sites/{wpcom_site}/blaze/status: get: operationId: getWpcomV2SitesbyWpcomSiteBlazeStatus summary: GET /wpcom/v2/sites/{wpcom_site}/blaze/status tags: - blaze responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/block-editor: get: operationId: getWpcomV2SitesbyWpcomSiteBlockEditor summary: GET /wpcom/v2/sites/{wpcom_site}/block-editor tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/block-editor/has-seen-seller-celebration-modal: get: operationId: getWpcomV2SitesbyWpcomSiteBlockEditorHasSeenSellerCelebrationModal summary: GET /wpcom/v2/sites/{wpcom_site}/block-editor/has-seen-seller-celebration-modal tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteBlockEditorHasSeenSellerCelebrationModal summary: POST /wpcom/v2/sites/{wpcom_site}/block-editor/has-seen-seller-celebration-modal tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: has_seen_seller_celebration_modal: type: boolean required: - has_seen_seller_celebration_modal put: operationId: putWpcomV2SitesbyWpcomSiteBlockEditorHasSeenSellerCelebrationModal summary: PUT /wpcom/v2/sites/{wpcom_site}/block-editor/has-seen-seller-celebration-modal tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: has_seen_seller_celebration_modal: type: boolean required: - has_seen_seller_celebration_modal patch: operationId: patchWpcomV2SitesbyWpcomSiteBlockEditorHasSeenSellerCelebrationModal summary: PATCH /wpcom/v2/sites/{wpcom_site}/block-editor/has-seen-seller-celebration-modal tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: has_seen_seller_celebration_modal: type: boolean required: - has_seen_seller_celebration_modal /wpcom/v2/sites/{wpcom_site}/block-editor/has-seen-video-celebration-modal: get: operationId: getWpcomV2SitesbyWpcomSiteBlockEditorHasSeenVideoCelebrationModal summary: GET /wpcom/v2/sites/{wpcom_site}/block-editor/has-seen-video-celebration-modal tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteBlockEditorHasSeenVideoCelebrationModal summary: POST /wpcom/v2/sites/{wpcom_site}/block-editor/has-seen-video-celebration-modal tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: has_seen_video_celebration_modal: type: boolean required: - has_seen_video_celebration_modal put: operationId: putWpcomV2SitesbyWpcomSiteBlockEditorHasSeenVideoCelebrationModal summary: PUT /wpcom/v2/sites/{wpcom_site}/block-editor/has-seen-video-celebration-modal tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: has_seen_video_celebration_modal: type: boolean required: - has_seen_video_celebration_modal patch: operationId: patchWpcomV2SitesbyWpcomSiteBlockEditorHasSeenVideoCelebrationModal summary: PATCH /wpcom/v2/sites/{wpcom_site}/block-editor/has-seen-video-celebration-modal tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: has_seen_video_celebration_modal: type: boolean required: - has_seen_video_celebration_modal /wpcom/v2/sites/{wpcom_site}/block-editor/nux: get: operationId: getWpcomV2SitesbyWpcomSiteBlockEditorNux summary: GET /wpcom/v2/sites/{wpcom_site}/block-editor/nux tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteBlockEditorNux summary: POST /wpcom/v2/sites/{wpcom_site}/block-editor/nux tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteBlockEditorNux summary: PUT /wpcom/v2/sites/{wpcom_site}/block-editor/nux tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteBlockEditorNux summary: PATCH /wpcom/v2/sites/{wpcom_site}/block-editor/nux tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/block-editor/recommended-tags-modal-dismissed: post: operationId: postWpcomV2SitesbyWpcomSiteBlockEditorRecommendedTagsModalDismissed summary: POST /wpcom/v2/sites/{wpcom_site}/block-editor/recommended-tags-modal-dismissed tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteBlockEditorRecommendedTagsModalDismissed summary: PUT /wpcom/v2/sites/{wpcom_site}/block-editor/recommended-tags-modal-dismissed tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteBlockEditorRecommendedTagsModalDismissed summary: PATCH /wpcom/v2/sites/{wpcom_site}/block-editor/recommended-tags-modal-dismissed tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/block-editor/should-show-first-post-published-modal: get: operationId: getWpcomV2SitesbyWpcomSiteBlockEditorShouldShowFirstPostPublishedModal summary: GET /wpcom/v2/sites/{wpcom_site}/block-editor/should-show-first-post-published-modal tags: - block-editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/block-layouts: get: operationId: getWpcomV2SitesbyWpcomSiteBlockLayouts summary: GET /wpcom/v2/sites/{wpcom_site}/block-layouts tags: - block-layouts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: supported_blocks in: query required: false schema: {} - name: exclude in: query required: false schema: {} - name: preview_width in: query required: false schema: {} - name: preview_height in: query required: false schema: {} - name: scale in: query required: false schema: default: 1 - name: is_beta in: query required: false schema: default: false - name: type in: query required: false schema: {} /wpcom/v2/sites/{wpcom_site}/block-renderer/content/render: post: operationId: postWpcomV2SitesbyWpcomSiteBlockRendererContentRender summary: POST /wpcom/v2/sites/{wpcom_site}/block-renderer/content/render 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 requestBody: content: application/json: schema: type: object properties: stylesheet: type: string description: 'Theme stylesheet, e.g.: pub/zoologist' variations: type: array items: {} description: Slugs of style variations to apply. Falls back to default variation if not found site_title: type: string description: Title of the site being previewed. site_tagline: type: string description: Tagline of the site being previewed. /wpcom/v2/sites/{wpcom_site}/block-renderer/patterns/render: get: operationId: getWpcomV2SitesbyWpcomSiteBlockRendererPatternsRender summary: GET /wpcom/v2/sites/{wpcom_site}/block-renderer/patterns/render 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: stylesheet in: query required: false schema: type: string description: 'Theme stylesheet, e.g.: pub/zoologist' - name: pattern_ids in: query required: false schema: type: string default: '' description: 'Comma-separated list of post ids with the source site id encoded, e.g.: 123-174455321,456-174455321.' - name: site_title in: query required: false schema: type: string description: Title of the site being previewed. - name: site_tagline in: query required: false schema: type: string description: Tagline of the site being previewed. /wpcom/v2/sites/{wpcom_site}/block-renderer/settings: get: operationId: getWpcomV2SitesbyWpcomSiteBlockRendererSettings summary: GET /wpcom/v2/sites/{wpcom_site}/block-renderer/settings 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: stylesheet in: query required: false schema: type: string description: 'Theme stylesheet, e.g.: pub/zoologist' - name: use_inline_styles in: query required: false schema: type: string description: Whether to transform external styles into inline styles /wpcom/v2/sites/{wpcom_site}/blog-stats: get: operationId: getWpcomV2SitesbyWpcomSiteBlogStats summary: GET /wpcom/v2/sites/{wpcom_site}/blog-stats tags: - blog-stats responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: post_id in: query required: false schema: type: string description: Post ID to obtain stats for. /wpcom/v2/sites/{wpcom_site}/blogging-prompts: get: operationId: getWpcomV2SitesbyWpcomSiteBloggingPrompts summary: GET /wpcom/v2/sites/{wpcom_site}/blogging-prompts tags: - blogging-prompts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: number in: query required: false schema: type: integer default: 20 description: 'The number of posts to return. Limit: 100, Default: 20.' - name: from in: query required: true schema: type: string description: Return prompts from the specified date in YYYY-MM-DD format /wpcom/v2/sites/{wpcom_site}/blogging-prompts/settings: get: operationId: getWpcomV2SitesbyWpcomSiteBloggingPromptsSettings summary: GET /wpcom/v2/sites/{wpcom_site}/blogging-prompts/settings tags: - blogging-prompts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteBloggingPromptsSettings summary: POST /wpcom/v2/sites/{wpcom_site}/blogging-prompts/settings tags: - blogging-prompts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: prompts_card_opted_in: type: boolean description: User opted in to prompts daily card. prompts_reminders_opted_in: type: boolean description: User opted in to prompts reminders. reminders_days: type: object description: User reminders days settings. reminders_time: type: string description: User reminders time setting. /wpcom/v2/sites/{wpcom_site}/blueprint-archive-import: post: operationId: postWpcomV2SitesbyWpcomSiteBlueprintArchiveImport summary: POST /wpcom/v2/sites/{wpcom_site}/blueprint-archive-import tags: - blueprint-archive-import responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: blueprint_slug: type: string description: Slug of a blueprint post on the blueprint host site. blueprint_url: type: string format: uri description: Blueprint library URL, e.g. https://blueprintlibrary.wordpress.com/?blueprint=941 /wpcom/v2/sites/{wpcom_site}/business-hours/localized-week: get: operationId: getWpcomV2SitesbyWpcomSiteBusinessHoursLocalizedWeek summary: GET /wpcom/v2/sites/{wpcom_site}/business-hours/localized-week tags: - business-hours responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/checkGoogleDocVisibility: get: operationId: getWpcomV2SitesbyWpcomSiteCheckgoogledocvisibility summary: GET /wpcom/v2/sites/{wpcom_site}/checkGoogleDocVisibility tags: - checkGoogleDocVisibility responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/ciab/address-autocomplete-token: post: operationId: postWpcomV2SitesbyWpcomSiteCiabAddressAutocompleteToken summary: POST /wpcom/v2/sites/{wpcom_site}/ciab/address-autocomplete-token tags: - ciab responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/cmp/configuration/{locale}: get: operationId: getWpcomV2SitesbyWpcomSiteCmpConfigurationbyLocale summary: GET /wpcom/v2/sites/{wpcom_site}/cmp/configuration/{locale} tags: - cmp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: locale in: path required: true schema: type: string - name: _jsonp in: query required: true schema: type: string description: JSONP callback /wpcom/v2/sites/{wpcom_site}/cmp/vendors/{language}: get: operationId: getWpcomV2SitesbyWpcomSiteCmpVendorsbyLanguage summary: GET /wpcom/v2/sites/{wpcom_site}/cmp/vendors/{language} tags: - cmp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: language in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/cmp/v{gvl_specification_version}/vendors/{language}: get: operationId: getWpcomV2SitesbyWpcomSiteCmpVGvlSpecificationVersionVendorsbyLanguage summary: GET /wpcom/v2/sites/{wpcom_site}/cmp/v{gvl_specification_version}/vendors/{language} tags: - cmp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: gvl_specification_version in: path required: true schema: type: string - name: language in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/coming-soon: post: operationId: postWpcomV2SitesbyWpcomSiteComingSoon summary: POST /wpcom/v2/sites/{wpcom_site}/coming-soon tags: - coming-soon responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: is_coming_soon: type: string description: Coming soon status. 1 is coming soon, 0 is live. required: - is_coming_soon /wpcom/v2/sites/{wpcom_site}/commercial-classification: post: operationId: postWpcomV2SitesbyWpcomSiteCommercialClassification summary: POST /wpcom/v2/sites/{wpcom_site}/commercial-classification tags: - commercial-classification responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteCommercialClassification summary: PUT /wpcom/v2/sites/{wpcom_site}/commercial-classification tags: - commercial-classification responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteCommercialClassification summary: PATCH /wpcom/v2/sites/{wpcom_site}/commercial-classification tags: - commercial-classification responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/copy-from-site: post: operationId: postWpcomV2SitesbyWpcomSiteCopyFromSite summary: POST /wpcom/v2/sites/{wpcom_site}/copy-from-site tags: - copy-from-site responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: source_blog_id: type: integer required: - source_blog_id /wpcom/v2/sites/{wpcom_site}/dashboard/cards: get: operationId: getWpcomV2SitesbyWpcomSiteDashboardCards summary: GET /wpcom/v2/sites/{wpcom_site}/dashboard/cards tags: - dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/dashboard/cards-data: get: operationId: getWpcomV2SitesbyWpcomSiteDashboardCardsData summary: GET /wpcom/v2/sites/{wpcom_site}/dashboard/cards-data tags: - dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: cards in: query required: true schema: type: string description: Dashboard cards as a comma delimited string - name: device_id in: query required: false schema: type: string - name: platform in: query required: false schema: type: string - name: build_number in: query required: false schema: type: string - name: marketing_version in: query required: false schema: type: string - name: identifier in: query required: false schema: type: string - name: os_version in: query required: false schema: type: string /wpcom/v2/sites/{wpcom_site}/dashboards/{name}/default-layout: get: operationId: getWpcomV2SitesbyWpcomSiteDashboardsbyNameDefaultLayout summary: GET /wpcom/v2/sites/{wpcom_site}/dashboards/{name}/default-layout tags: - dashboards responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 /wpcom/v2/sites/{wpcom_site}/dashboards/{name}/sections: get: operationId: getWpcomV2SitesbyWpcomSiteDashboardsbyNameSections summary: GET /wpcom/v2/sites/{wpcom_site}/dashboards/{name}/sections tags: - dashboards responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 /wpcom/v2/sites/{wpcom_site}/dashboards/{name}/sections/{section}/default-layout: get: operationId: getWpcomV2SitesbyWpcomSiteDashboardsbyNameSectionsbySectionDefaultLayout summary: GET /wpcom/v2/sites/{wpcom_site}/dashboards/{name}/sections/{section}/default-layout tags: - dashboards responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: section in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/discount: get: operationId: getWpcomV2SitesbyWpcomSiteDiscount summary: GET /wpcom/v2/sites/{wpcom_site}/discount tags: - discount responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/do-it-for-me/website-content: post: operationId: postWpcomV2SitesbyWpcomSiteDoItForMeWebsiteContent summary: POST /wpcom/v2/sites/{wpcom_site}/do-it-for-me/website-content tags: - do-it-for-me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: pages: type: array items: type: object description: The list of pages site_logo_url: type: string description: The URL to the site logo. generic_feedback: type: string description: General feedback provided for a site build search_terms: type: string description: Search terms provided by the user. put: operationId: putWpcomV2SitesbyWpcomSiteDoItForMeWebsiteContent summary: PUT /wpcom/v2/sites/{wpcom_site}/do-it-for-me/website-content tags: - do-it-for-me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: pages: type: array items: type: object description: The list of pages site_logo_url: type: string description: The URL to the site logo. generic_feedback: type: string description: General feedback provided for a site build search_terms: type: string description: Search terms provided by the user. get: operationId: getWpcomV2SitesbyWpcomSiteDoItForMeWebsiteContent summary: GET /wpcom/v2/sites/{wpcom_site}/do-it-for-me/website-content tags: - do-it-for-me responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/editor-assets: get: operationId: getWpcomV2SitesbyWpcomSiteEditorAssets summary: GET /wpcom/v2/sites/{wpcom_site}/editor-assets tags: - editor-assets responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: exclude in: query required: false schema: type: string default: '' description: 'Comma-separated list of asset types to exclude from the response. Supported values: "core" (WordPress core assets), "gutenberg" (Gutenberg plugin assets), or plugin handle prefixes (e.g., "contact-form-7").' /wpcom/v2/sites/{wpcom_site}/editor/redirect: get: operationId: getWpcomV2SitesbyWpcomSiteEditorRedirect summary: GET /wpcom/v2/sites/{wpcom_site}/editor/redirect tags: - editor responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: path in: query required: true schema: type: string description: The path to the editor. - name: redirect in: query required: false schema: type: boolean default: true /wpcom/v2/sites/{wpcom_site}/email-like: post: operationId: postWpcomV2SitesbyWpcomSiteEmailLike summary: POST /wpcom/v2/sites/{wpcom_site}/email-like tags: - email-like responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: post_id: type: integer like_actor: type: integer like_hmac: type: string required: - post_id - like_actor - like_hmac /wpcom/v2/sites/{wpcom_site}/email-preview: get: operationId: getWpcomV2SitesbyWpcomSiteEmailPreview summary: GET /wpcom/v2/sites/{wpcom_site}/email-preview tags: - email-preview responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: query required: false schema: type: integer description: Unique identifier for the post. - name: access in: query required: false schema: enum: - everybody - subscribers - paid_subscribers default: everybody description: Access level. /wpcom/v2/sites/{wpcom_site}/emails/accounts/{domain}: get: operationId: getWpcomV2SitesbyWpcomSiteEmailsAccountsbyDomain summary: GET /wpcom/v2/sites/{wpcom_site}/emails/accounts/{domain} tags: - emails responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: domain in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/emails/accounts/{domain}/mailboxes: get: operationId: getWpcomV2SitesbyWpcomSiteEmailsAccountsbyDomainMailboxes summary: GET /wpcom/v2/sites/{wpcom_site}/emails/accounts/{domain}/mailboxes tags: - emails responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: domain in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/emails/domains: get: operationId: getWpcomV2SitesbyWpcomSiteEmailsDomains summary: GET /wpcom/v2/sites/{wpcom_site}/emails/domains tags: - emails responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/emails/mailboxes: get: operationId: getWpcomV2SitesbyWpcomSiteEmailsMailboxes summary: GET /wpcom/v2/sites/{wpcom_site}/emails/mailboxes tags: - emails responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/external-contributors: get: operationId: getWpcomV2SitesbyWpcomSiteExternalContributors summary: GET /wpcom/v2/sites/{wpcom_site}/external-contributors tags: - external-contributors responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/external-contributors/add: post: operationId: postWpcomV2SitesbyWpcomSiteExternalContributorsAdd summary: POST /wpcom/v2/sites/{wpcom_site}/external-contributors/add tags: - external-contributors responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: user_id: type: integer required: - user_id /wpcom/v2/sites/{wpcom_site}/external-contributors/remove: post: operationId: postWpcomV2SitesbyWpcomSiteExternalContributorsRemove summary: POST /wpcom/v2/sites/{wpcom_site}/external-contributors/remove tags: - external-contributors responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: user_id: type: integer required: - user_id /wpcom/v2/sites/{wpcom_site}/external-media/connection/{service}: get: operationId: getWpcomV2SitesbyWpcomSiteExternalMediaConnectionbyService summary: GET /wpcom/v2/sites/{wpcom_site}/external-media/connection/{service} tags: - external-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: service in: path required: true schema: type: string delete: operationId: deleteWpcomV2SitesbyWpcomSiteExternalMediaConnectionbyService summary: DELETE /wpcom/v2/sites/{wpcom_site}/external-media/connection/{service} tags: - external-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: service in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/external-media/connection/{service}/picker_status: get: operationId: getWpcomV2SitesbyWpcomSiteExternalMediaConnectionbyServicePickerStatus summary: GET /wpcom/v2/sites/{wpcom_site}/external-media/connection/{service}/picker_status tags: - external-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: service in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/external-media/copy/{service}: post: operationId: postWpcomV2SitesbyWpcomSiteExternalMediaCopybyService summary: POST /wpcom/v2/sites/{wpcom_site}/external-media/copy/{service} tags: - external-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: service in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: media: type: array items: type: array description: Media data to copy. post_id: type: number description: The post ID to attach the upload to. should_proxy: type: boolean default: false description: Whether to proxy the media request. required: - media /wpcom/v2/sites/{wpcom_site}/external-media/list/{service}: get: operationId: getWpcomV2SitesbyWpcomSiteExternalMediaListbyService summary: GET /wpcom/v2/sites/{wpcom_site}/external-media/list/{service} tags: - external-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: service in: path required: true schema: type: string - name: search in: query required: false schema: type: string description: Media collection search term. - name: number in: query required: false schema: type: number default: 20 description: Number of media items in the request - name: path in: query required: false schema: type: string - name: page_handle in: query required: false schema: type: string - name: session_id in: query required: false schema: type: string description: Session id of a service, currently only Google Photos Picker /wpcom/v2/sites/{wpcom_site}/external-media/proxy/{service}: post: operationId: postWpcomV2SitesbyWpcomSiteExternalMediaProxybyService summary: POST /wpcom/v2/sites/{wpcom_site}/external-media/proxy/{service} tags: - external-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: service in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: url: type: string required: - url /wpcom/v2/sites/{wpcom_site}/external-media/session/{service}: post: operationId: postWpcomV2SitesbyWpcomSiteExternalMediaSessionbyService summary: POST /wpcom/v2/sites/{wpcom_site}/external-media/session/{service} tags: - external-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: service in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/external-media/session/{service}/{session_id}: get: operationId: getWpcomV2SitesbyWpcomSiteExternalMediaSessionbyServicebySessionId summary: GET /wpcom/v2/sites/{wpcom_site}/external-media/session/{service}/{session_id} tags: - external-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: service in: path required: true schema: type: string - name: session_id in: path required: true schema: type: string delete: operationId: deleteWpcomV2SitesbyWpcomSiteExternalMediaSessionbyServicebySessionId summary: DELETE /wpcom/v2/sites/{wpcom_site}/external-media/session/{service}/{session_id} tags: - external-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: service in: path required: true schema: type: string - name: session_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/external-services: get: operationId: getWpcomV2SitesbyWpcomSiteExternalServices summary: GET /wpcom/v2/sites/{wpcom_site}/external-services tags: - external-services responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: query required: false schema: type: string /wpcom/v2/sites/{wpcom_site}/global-styles-variation/color-palettes: get: operationId: getWpcomV2SitesbyWpcomSiteGlobalStylesVariationColorPalettes summary: GET /wpcom/v2/sites/{wpcom_site}/global-styles-variation/color-palettes tags: - global-styles-variation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: query required: false schema: type: string description: 'Theme stylesheet, e.g.: pub/zoologist' - name: base_variation_stylesheet in: query required: false schema: type: string description: 'Theme stylesheet, e.g.: pub/zoologist' /wpcom/v2/sites/{wpcom_site}/global-styles-variation/current: get: operationId: getWpcomV2SitesbyWpcomSiteGlobalStylesVariationCurrent summary: GET /wpcom/v2/sites/{wpcom_site}/global-styles-variation/current tags: - global-styles-variation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/global-styles-variation/font-pairings: get: operationId: getWpcomV2SitesbyWpcomSiteGlobalStylesVariationFontPairings summary: GET /wpcom/v2/sites/{wpcom_site}/global-styles-variation/font-pairings tags: - global-styles-variation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: query required: false schema: type: string description: 'Theme stylesheet, e.g.: pub/zoologist' - name: base_variation_stylesheet in: query required: false schema: type: string description: 'Theme stylesheet, e.g.: pub/zoologist' /wpcom/v2/sites/{wpcom_site}/global-styles-variation/site-accent-color: get: operationId: getWpcomV2SitesbyWpcomSiteGlobalStylesVariationSiteAccentColor summary: GET /wpcom/v2/sites/{wpcom_site}/global-styles-variation/site-accent-color tags: - global-styles-variation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteGlobalStylesVariationSiteAccentColor summary: POST /wpcom/v2/sites/{wpcom_site}/global-styles-variation/site-accent-color tags: - global-styles-variation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: color: type: string format: hex-color description: The new accent color to set. Hex value with hash included. required: - color put: operationId: putWpcomV2SitesbyWpcomSiteGlobalStylesVariationSiteAccentColor summary: PUT /wpcom/v2/sites/{wpcom_site}/global-styles-variation/site-accent-color tags: - global-styles-variation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: color: type: string format: hex-color description: The new accent color to set. Hex value with hash included. required: - color patch: operationId: patchWpcomV2SitesbyWpcomSiteGlobalStylesVariationSiteAccentColor summary: PATCH /wpcom/v2/sites/{wpcom_site}/global-styles-variation/site-accent-color tags: - global-styles-variation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: color: type: string format: hex-color description: The new accent color to set. Hex value with hash included. required: - color /wpcom/v2/sites/{wpcom_site}/global-styles-variation/theme: get: operationId: getWpcomV2SitesbyWpcomSiteGlobalStylesVariationTheme summary: GET /wpcom/v2/sites/{wpcom_site}/global-styles-variation/theme tags: - global-styles-variation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/global-styles/status: get: operationId: getWpcomV2SitesbyWpcomSiteGlobalStylesStatus summary: GET /wpcom/v2/sites/{wpcom_site}/global-styles/status 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 /wpcom/v2/sites/{wpcom_site}/goodreads/user-id: get: operationId: getWpcomV2SitesbyWpcomSiteGoodreadsUserId summary: GET /wpcom/v2/sites/{wpcom_site}/goodreads/user-id tags: - goodreads responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: query required: true schema: type: integer description: Goodreads user ID /wpcom/v2/sites/{wpcom_site}/google-drive/connection: get: operationId: getWpcomV2SitesbyWpcomSiteGoogleDriveConnection summary: GET /wpcom/v2/sites/{wpcom_site}/google-drive/connection tags: - google-drive responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/google-drive/sheets: post: operationId: postWpcomV2SitesbyWpcomSiteGoogleDriveSheets summary: POST /wpcom/v2/sites/{wpcom_site}/google-drive/sheets tags: - google-drive responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: rows: type: array items: {} title: type: string put: operationId: putWpcomV2SitesbyWpcomSiteGoogleDriveSheets summary: PUT /wpcom/v2/sites/{wpcom_site}/google-drive/sheets tags: - google-drive responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: rows: type: array items: {} title: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteGoogleDriveSheets summary: PATCH /wpcom/v2/sites/{wpcom_site}/google-drive/sheets tags: - google-drive responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: rows: type: array items: {} title: type: string /wpcom/v2/sites/{wpcom_site}/gutenberg: get: operationId: getWpcomV2SitesbyWpcomSiteGutenberg summary: GET /wpcom/v2/sites/{wpcom_site}/gutenberg tags: - gutenberg responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteGutenberg summary: POST /wpcom/v2/sites/{wpcom_site}/gutenberg tags: - gutenberg responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: editor: type: string platform: type: string required: - editor - platform put: operationId: putWpcomV2SitesbyWpcomSiteGutenberg summary: PUT /wpcom/v2/sites/{wpcom_site}/gutenberg tags: - gutenberg responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: editor: type: string platform: type: string required: - editor - platform patch: operationId: patchWpcomV2SitesbyWpcomSiteGutenberg summary: PATCH /wpcom/v2/sites/{wpcom_site}/gutenberg tags: - gutenberg responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: editor: type: string platform: type: string required: - editor - platform /wpcom/v2/sites/{wpcom_site}/gutenberg/available-extensions: get: operationId: getWpcomV2SitesbyWpcomSiteGutenbergAvailableExtensions summary: GET /wpcom/v2/sites/{wpcom_site}/gutenberg/available-extensions tags: - gutenberg responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/hello: get: operationId: getWpcomV2SitesbyWpcomSiteHello summary: GET /wpcom/v2/sites/{wpcom_site}/hello tags: - hello responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/home/layout: get: operationId: getWpcomV2SitesbyWpcomSiteHomeLayout summary: GET /wpcom/v2/sites/{wpcom_site}/home/layout tags: - home responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: dev in: query required: false schema: {} - name: view in: query required: false schema: {} - name: shuffle in: query required: false schema: default: 'true' /wpcom/v2/sites/{wpcom_site}/home/layout/skip: post: operationId: postWpcomV2SitesbyWpcomSiteHomeLayoutSkip summary: POST /wpcom/v2/sites/{wpcom_site}/home/layout/skip tags: - home responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: dev: {} reminder: type: string view: type: string card: type: string put: operationId: putWpcomV2SitesbyWpcomSiteHomeLayoutSkip summary: PUT /wpcom/v2/sites/{wpcom_site}/home/layout/skip tags: - home responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: dev: {} reminder: type: string view: type: string card: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteHomeLayoutSkip summary: PATCH /wpcom/v2/sites/{wpcom_site}/home/layout/skip tags: - home responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: dev: {} reminder: type: string view: type: string card: type: string /wpcom/v2/sites/{wpcom_site}/hosting-provider: get: operationId: getWpcomV2SitesbyWpcomSiteHostingProvider summary: GET /wpcom/v2/sites/{wpcom_site}/hosting-provider tags: - hosting-provider responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments: get: operationId: getWpcomV2SitesbyWpcomSiteHostingCodeDeployments summary: GET /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: query in: query required: false schema: type: string description: Query term to search for code deployments post: operationId: postWpcomV2SitesbyWpcomSiteHostingCodeDeployments summary: POST /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: external_repository_id: type: integer description: The external repository ID. branch_name: type: string description: The branch to deploy. target_dir: type: string description: The target directory to deploy to. installation_id: type: integer description: The installation ID. is_automated: type: boolean description: Whether to deploy on a code push to the given branch or manually. workflow_path: type: string description: The path to the workflow file. required: - external_repository_id - branch_name - target_dir - installation_id /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}: get: operationId: getWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentId summary: GET /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id} tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string post: operationId: postWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentId summary: POST /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id} tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: external_repository_id: type: integer description: The external repository ID. branch_name: type: string description: The branch to deploy. target_dir: type: string description: The target directory to deploy to. installation_id: type: integer description: The installation ID. is_automated: type: boolean description: Whether to deploy on a code push to the given branch or manually. workflow_path: type: string description: The path to the workflow file. required: - external_repository_id - branch_name - target_dir - installation_id put: operationId: putWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentId summary: PUT /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id} tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: external_repository_id: type: integer description: The external repository ID. branch_name: type: string description: The branch to deploy. target_dir: type: string description: The target directory to deploy to. installation_id: type: integer description: The installation ID. is_automated: type: boolean description: Whether to deploy on a code push to the given branch or manually. workflow_path: type: string description: The path to the workflow file. required: - external_repository_id - branch_name - target_dir - installation_id patch: operationId: patchWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentId summary: PATCH /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id} tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: external_repository_id: type: integer description: The external repository ID. branch_name: type: string description: The branch to deploy. target_dir: type: string description: The target directory to deploy to. installation_id: type: integer description: The installation ID. is_automated: type: boolean description: Whether to deploy on a code push to the given branch or manually. workflow_path: type: string description: The path to the workflow file. required: - external_repository_id - branch_name - target_dir - installation_id delete: operationId: deleteWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentId summary: DELETE /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id} tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string - name: remove_files in: query required: false schema: type: string description: If true, the deployed files will be removed, if any. /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/runs: get: operationId: getWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdRuns summary: GET /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/runs tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string post: operationId: postWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdRuns summary: POST /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/runs tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/runs/{deployment_run_id}/logs: get: operationId: getWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdRunsbyDeploymentRunIdLogs summary: GET /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/runs/{deployment_run_id}/logs tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string - name: deployment_run_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/runs/{deployment_run_id}/logs/{command_identifier}: get: operationId: getWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdRunsbyDeploymentRunIdLogsbyCommandIdentifier summary: GET /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/runs/{deployment_run_id}/logs/{command_identifier} tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string - name: deployment_run_id in: path required: true schema: type: string - name: command_identifier in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks: post: operationId: postWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdWebhooks summary: POST /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: url: type: string description: Webhook URL to receive notifications. events: type: string default: building,queued,started,completed,failed,cancelled description: Comma-separated list of events to subscribe to. Defaults to all events. required: - url get: operationId: getWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdWebhooks summary: GET /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id}: post: operationId: postWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdWebhooksbyWebhookId summary: POST /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id} tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string - name: webhook_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: url: type: string description: Webhook URL. events: type: string description: Comma-separated list of events to subscribe to. put: operationId: putWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdWebhooksbyWebhookId summary: PUT /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id} tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string - name: webhook_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: url: type: string description: Webhook URL. events: type: string description: Comma-separated list of events to subscribe to. patch: operationId: patchWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdWebhooksbyWebhookId summary: PATCH /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id} tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string - name: webhook_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: url: type: string description: Webhook URL. events: type: string description: Comma-separated list of events to subscribe to. delete: operationId: deleteWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdWebhooksbyWebhookId summary: DELETE /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id} tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string - name: webhook_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id}/deliveries: get: operationId: getWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdWebhooksbyWebhookIdDeliveries summary: GET /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id}/deliveries tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string - name: webhook_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id}/test: post: operationId: postWpcomV2SitesbyWpcomSiteHostingCodeDeploymentsbyDeploymentIdWebhooksbyWebhookIdTest summary: POST /wpcom/v2/sites/{wpcom_site}/hosting/code-deployments/{deployment_id}/webhooks/{webhook_id}/test tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: deployment_id in: path required: true schema: type: string - name: webhook_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/hosting/ssh-keys: get: operationId: getWpcomV2SitesbyWpcomSiteHostingSshKeys summary: GET /wpcom/v2/sites/{wpcom_site}/hosting/ssh-keys tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteHostingSshKeys summary: POST /wpcom/v2/sites/{wpcom_site}/hosting/ssh-keys tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: name: type: string description: Name of the SSH key we want to attach. Currently only "default" is supported. required: - name /wpcom/v2/sites/{wpcom_site}/hosting/ssh-keys/{user_name}/{name}: delete: operationId: deleteWpcomV2SitesbyWpcomSiteHostingSshKeysbyUserNamebyName summary: DELETE /wpcom/v2/sites/{wpcom_site}/hosting/ssh-keys/{user_name}/{name} tags: - hosting responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: user_name in: path required: true schema: type: string - name: name in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/individual-subscriber-stats: get: operationId: getWpcomV2SitesbyWpcomSiteIndividualSubscriberStats summary: GET /wpcom/v2/sites/{wpcom_site}/individual-subscriber-stats tags: - individual-subscriber-stats responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: subscription_id in: query required: false schema: {} - name: user_id in: query required: false schema: {} /wpcom/v2/sites/{wpcom_site}/instagram-gallery/connect-url: get: operationId: getWpcomV2SitesbyWpcomSiteInstagramGalleryConnectUrl summary: GET /wpcom/v2/sites/{wpcom_site}/instagram-gallery/connect-url tags: - instagram-gallery responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/instagram-gallery/connections: get: operationId: getWpcomV2SitesbyWpcomSiteInstagramGalleryConnections summary: GET /wpcom/v2/sites/{wpcom_site}/instagram-gallery/connections tags: - instagram-gallery responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/instagram-gallery/gallery: get: operationId: getWpcomV2SitesbyWpcomSiteInstagramGalleryGallery summary: GET /wpcom/v2/sites/{wpcom_site}/instagram-gallery/gallery tags: - instagram-gallery responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: access_token in: query required: true schema: type: integer description: An Instagram Keyring access token. - name: count in: query required: true schema: type: integer description: How many Instagram posts? /wpcom/v2/sites/{wpcom_site}/instagram/{token_id}: get: operationId: getWpcomV2SitesbyWpcomSiteInstagrambyTokenId summary: GET /wpcom/v2/sites/{wpcom_site}/instagram/{token_id} tags: - instagram responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: token_id in: path required: true schema: type: string - name: count in: query required: false schema: type: integer delete: operationId: deleteWpcomV2SitesbyWpcomSiteInstagrambyTokenId summary: DELETE /wpcom/v2/sites/{wpcom_site}/instagram/{token_id} tags: - instagram responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: token_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/instagram/{token_id}/check-legacy: get: operationId: getWpcomV2SitesbyWpcomSiteInstagrambyTokenIdCheckLegacy summary: GET /wpcom/v2/sites/{wpcom_site}/instagram/{token_id}/check-legacy tags: - instagram responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: token_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/instagram/{token_id}/check-token: get: operationId: getWpcomV2SitesbyWpcomSiteInstagrambyTokenIdCheckToken summary: GET /wpcom/v2/sites/{wpcom_site}/instagram/{token_id}/check-token tags: - instagram responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: token_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/invites/are-users-invited: post: operationId: postWpcomV2SitesbyWpcomSiteInvitesAreUsersInvited summary: POST /wpcom/v2/sites/{wpcom_site}/invites/are-users-invited tags: - invites responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: users: type: array items: type: string required: - users /wpcom/v2/sites/{wpcom_site}/invites/delete: post: operationId: postWpcomV2SitesbyWpcomSiteInvitesDelete summary: POST /wpcom/v2/sites/{wpcom_site}/invites/delete tags: - invites responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: invite_ids: type: array items: type: string required: - invite_ids /wpcom/v2/sites/{wpcom_site}/invites/is-invited: get: operationId: getWpcomV2SitesbyWpcomSiteInvitesIsInvited summary: GET /wpcom/v2/sites/{wpcom_site}/invites/is-invited tags: - invites responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: email_or_username in: query required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/invites/links/disable: post: operationId: postWpcomV2SitesbyWpcomSiteInvitesLinksDisable summary: POST /wpcom/v2/sites/{wpcom_site}/invites/links/disable tags: - invites responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: role: type: string /wpcom/v2/sites/{wpcom_site}/invites/links/generate: post: operationId: postWpcomV2SitesbyWpcomSiteInvitesLinksGenerate summary: POST /wpcom/v2/sites/{wpcom_site}/invites/links/generate tags: - invites responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: role: type: string expiry: type: integer /wpcom/v2/sites/{wpcom_site}/invites/new: post: operationId: postWpcomV2SitesbyWpcomSiteInvitesNew summary: POST /wpcom/v2/sites/{wpcom_site}/invites/new tags: - invites responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: invitees: type: array items: type: object required: - invitees /wpcom/v2/sites/{wpcom_site}/invites/resend: post: operationId: postWpcomV2SitesbyWpcomSiteInvitesResend summary: POST /wpcom/v2/sites/{wpcom_site}/invites/resend tags: - invites responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: invite_slug: type: string required: - invite_slug /wpcom/v2/sites/{wpcom_site}/ip-to-geo/{ip_address}: get: operationId: getWpcomV2SitesbyWpcomSiteIpToGeobyIpAddress summary: GET /wpcom/v2/sites/{wpcom_site}/ip-to-geo/{ip_address} tags: - ip-to-geo responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: ip_address in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-active-connected-plugins: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackActiveConnectedPlugins summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-active-connected-plugins tags: - jetpack-active-connected-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: active_connected_plugins: description: An associative array of Jetpack active connected plugins. required: - active_connected_plugins put: operationId: putWpcomV2SitesbyWpcomSiteJetpackActiveConnectedPlugins summary: PUT /wpcom/v2/sites/{wpcom_site}/jetpack-active-connected-plugins tags: - jetpack-active-connected-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: active_connected_plugins: description: An associative array of Jetpack active connected plugins. required: - active_connected_plugins patch: operationId: patchWpcomV2SitesbyWpcomSiteJetpackActiveConnectedPlugins summary: PATCH /wpcom/v2/sites/{wpcom_site}/jetpack-active-connected-plugins tags: - jetpack-active-connected-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: active_connected_plugins: description: An associative array of Jetpack active connected plugins. required: - active_connected_plugins /wpcom/v2/sites/{wpcom_site}/jetpack-ai/ai-assistant-feature: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackAiAiAssistantFeature summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-ai/ai-assistant-feature tags: - jetpack-ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-ai/blogging/prompts: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackAiBloggingPrompts summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-ai/blogging/prompts tags: - jetpack-ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-ai/completions: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackAiCompletions summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-ai/completions tags: - jetpack-ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: content: type: string post_id: type: integer skip_cache: type: boolean description: Whether to skip the cache and make a new request required: - content /wpcom/v2/sites/{wpcom_site}/jetpack-ai/guidelines-banner-dismissed: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackAiGuidelinesBannerDismissed summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-ai/guidelines-banner-dismissed tags: - jetpack-ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteJetpackAiGuidelinesBannerDismissed summary: PUT /wpcom/v2/sites/{wpcom_site}/jetpack-ai/guidelines-banner-dismissed tags: - jetpack-ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteJetpackAiGuidelinesBannerDismissed summary: PATCH /wpcom/v2/sites/{wpcom_site}/jetpack-ai/guidelines-banner-dismissed tags: - jetpack-ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-ai/images/generations: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackAiImagesGenerations summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-ai/images/generations tags: - jetpack-ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: prompt: type: string post_id: type: integer required: - prompt /wpcom/v2/sites/{wpcom_site}/jetpack-ai/suggest-guidelines: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackAiSuggestGuidelines summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-ai/suggest-guidelines tags: - jetpack-ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: categories: type: object required: - categories /wpcom/v2/sites/{wpcom_site}/jetpack-boost/cloud-css: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackBoostCloudCss summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-boost/cloud-css tags: - jetpack-boost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-boost/cloud-css/update: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackBoostCloudCssUpdate summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-boost/cloud-css/update tags: - jetpack-boost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-boost/features: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackBoostFeatures summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-boost/features tags: - jetpack-boost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-boost/lcp: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackBoostLcp summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-boost/lcp tags: - jetpack-boost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-boost/lcp/update: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackBoostLcpUpdate summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-boost/lcp/update tags: - jetpack-boost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-boost/speed-scores: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackBoostSpeedScores summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-boost/speed-scores tags: - jetpack-boost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: url: type: string request_id: type: string client: type: string required: - url - request_id /wpcom/v2/sites/{wpcom_site}/jetpack-boost/speed-scores-history: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackBoostSpeedScoresHistory summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-boost/speed-scores-history tags: - jetpack-boost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: start in: query required: true schema: {} description: Timestamp of the start of the time range to retrieve the performance history for. - name: end in: query required: true schema: {} description: Timestamp of the end of the time range to retrieve the performance history for. - name: page_size in: query required: false schema: {} description: The maximum number of records to retrieve in a single request. Defaults to 100. /wpcom/v2/sites/{wpcom_site}/jetpack-boost/speed-scores/update: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackBoostSpeedScoresUpdate summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-boost/speed-scores/update tags: - jetpack-boost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteJetpackBoostSpeedScoresUpdate summary: PUT /wpcom/v2/sites/{wpcom_site}/jetpack-boost/speed-scores/update tags: - jetpack-boost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteJetpackBoostSpeedScoresUpdate summary: PATCH /wpcom/v2/sites/{wpcom_site}/jetpack-boost/speed-scores/update tags: - jetpack-boost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-boost/speed-scores/{request_id}: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackBoostSpeedScoresbyRequestId summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-boost/speed-scores/{request_id} tags: - jetpack-boost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: request_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-boost/{report_type}/reports: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackBoostbyReportTypeReports summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-boost/{report_type}/reports tags: - jetpack-boost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: report_type in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-boost/{report_type}/reports/{id}: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackBoostbyReportTypeReportsbyId summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-boost/{report_type}/reports/{id} tags: - jetpack-boost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: report_type in: path required: true schema: type: string - name: id in: path required: true schema: type: string post: operationId: postWpcomV2SitesbyWpcomSiteJetpackBoostbyReportTypeReportsbyId summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-boost/{report_type}/reports/{id} tags: - jetpack-boost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: report_type in: path required: true schema: type: string - name: id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: success: type: boolean data: type: object required: - data /wpcom/v2/sites/{wpcom_site}/jetpack-boost/{report_type}/reports/{id}/done: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackBoostbyReportTypeReportsbyIdDone summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-boost/{report_type}/reports/{id}/done tags: - jetpack-boost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: report_type in: path required: true schema: type: string - name: id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-boost/{report_type}/reports/{id}/issues: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackBoostbyReportTypeReportsbyIdIssues summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-boost/{report_type}/reports/{id}/issues tags: - jetpack-boost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: report_type in: path required: true schema: type: string - name: id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-clone-settings: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackCloneSettings summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-clone-settings tags: - jetpack-clone-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: destination_blog_id: description: The WPCOM blog ID of the destination site to clone Jetpack settings to. required: - destination_blog_id /wpcom/v2/sites/{wpcom_site}/jetpack-connect/is-user-connected: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackConnectIsUserConnected summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-connect/is-user-connected tags: - jetpack-connect responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-connection-health: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackConnectionHealth summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-connection-health tags: - jetpack-connection-health responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-golden-token/activate: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackGoldenTokenActivate summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-golden-token/activate tags: - jetpack-golden-token responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-golden-token/get: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackGoldenTokenGet summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-golden-token/get tags: - jetpack-golden-token responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-monitor-incidents: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackMonitorIncidents summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-monitor-incidents tags: - jetpack-monitor-incidents responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: period in: query required: false schema: type: string enum: - day - week - month - year description: The period within the Monitor incidents occurred. - name: status in: query required: false schema: type: boolean description: 'The Monitor incidents'' status: 1 means up, 0 means down' - name: url in: query required: false schema: type: string format: uri description: The Monitor incidents' URL. Handy when Jetpack Monitor is configured to monitor additional URLs on top of the homepage - name: page in: query required: false schema: type: integer - name: per_page in: query required: false schema: type: integer /wpcom/v2/sites/{wpcom_site}/jetpack-monitor-settings: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackMonitorSettings summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-monitor-settings tags: - jetpack-monitor-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: postWpcomV2SitesbyWpcomSiteJetpackMonitorSettings summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-monitor-settings tags: - jetpack-monitor-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: email_notifications: type: boolean sms_notifications: type: boolean wp_note_notifications: type: boolean jetmon_defer_status_down_minutes: type: integer urls: type: array items: type: object contacts: type: object /wpcom/v2/sites/{wpcom_site}/jetpack-monitor-settings/verify-contact-method: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackMonitorSettingsVerifyContactMethod summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-monitor-settings/verify-contact-method tags: - jetpack-monitor-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: type: type: string value: type: string verification_code: type: string required: - type - value - verification_code /wpcom/v2/sites/{wpcom_site}/jetpack-monitor-status: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackMonitorStatus summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-monitor-status tags: - jetpack-monitor-status responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-monitor-uptime: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackMonitorUptime summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-monitor-uptime tags: - jetpack-monitor-uptime responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: period in: query required: false schema: type: string enum: - day - week - 30 days - 90 days description: The period we want to fetch the site's uptime for. Defaults to week. /wpcom/v2/sites/{wpcom_site}/jetpack-openai-query/jwt: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackOpenaiQueryJwt summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-openai-query/jwt tags: - jetpack-openai-query responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-package-versions: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackPackageVersions summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-package-versions tags: - jetpack-package-versions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: package_versions: description: An associative array of Jetpack packages and their corresponding versions as key/value pairs. You may use either the package names, eg automattic/jetpack-backup or their simplified version (slug) eg backup. required: - package_versions put: operationId: putWpcomV2SitesbyWpcomSiteJetpackPackageVersions summary: PUT /wpcom/v2/sites/{wpcom_site}/jetpack-package-versions tags: - jetpack-package-versions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: package_versions: description: An associative array of Jetpack packages and their corresponding versions as key/value pairs. You may use either the package names, eg automattic/jetpack-backup or their simplified version (slug) eg backup. required: - package_versions patch: operationId: patchWpcomV2SitesbyWpcomSiteJetpackPackageVersions summary: PATCH /wpcom/v2/sites/{wpcom_site}/jetpack-package-versions tags: - jetpack-package-versions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: package_versions: description: An associative array of Jetpack packages and their corresponding versions as key/value pairs. You may use either the package names, eg automattic/jetpack-backup or their simplified version (slug) eg backup. required: - package_versions /wpcom/v2/sites/{wpcom_site}/jetpack-partner/coupon/v1/site/coupon: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackPartnerCouponV1SiteCoupon summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-partner/coupon/v1/site/coupon tags: - jetpack-partner responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: coupon_code in: query required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-pinghub/jwt/sign: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackPinghubJwtSign summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-pinghub/jwt/sign tags: - jetpack-pinghub responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-product-data: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackProductData summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-product-data tags: - jetpack-product-data responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-protect-send-verification-code: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackProtectSendVerificationCode summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-protect-send-verification-code tags: - jetpack-protect-send-verification-code responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-protect-status: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackProtectStatus summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-protect-status tags: - jetpack-protect-status responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-recommendations/evaluation: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackRecommendationsEvaluation summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-recommendations/evaluation tags: - jetpack-recommendations responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-recommendations/product-suggestions: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackRecommendationsProductSuggestions summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-recommendations/product-suggestions tags: - jetpack-recommendations responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-recommendations/site-registered-date: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackRecommendationsSiteRegisteredDate summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-recommendations/site-registered-date tags: - jetpack-recommendations responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-recommendations/upsell: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackRecommendationsUpsell summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-recommendations/upsell tags: - jetpack-recommendations responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-refresh-blog-token: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackRefreshBlogToken summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-refresh-blog-token tags: - jetpack-refresh-blog-token responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-remote-connect-user: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackRemoteConnectUser summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-remote-connect-user tags: - jetpack-remote-connect-user responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: secret: type: string description: Remote registration secret external_user_id: type: string description: External user ID. redirect_uri: type: string description: Redirect URI. scope: type: string description: Scope. required: - secret - external_user_id - redirect_uri - scope /wpcom/v2/sites/{wpcom_site}/jetpack-report-error: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackReportError summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-report-error tags: - jetpack-report-error responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: error_data: type: string description: Encrypted error data required: - error_data /wpcom/v2/sites/{wpcom_site}/jetpack-search/ai/rank: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackSearchAiRank summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-search/ai/rank tags: - jetpack-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: cache_key in: query required: true schema: {} description: Cache key of your response - name: comment in: query required: false schema: {} description: Optional feedback - name: rank in: query required: false schema: {} description: How do you rank this response /wpcom/v2/sites/{wpcom_site}/jetpack-search/ai/search: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackSearchAiSearch summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-search/ai/search tags: - jetpack-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: query in: query required: true schema: {} description: Your question to the site - name: stop_at in: query required: false schema: default: full description: 'Which stage to return: urls (fast preview) or response (full answer).' - name: session_id in: query required: false schema: {} description: Conversation session id to continue. /wpcom/v2/sites/{wpcom_site}/jetpack-search/plan: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackSearchPlan summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-search/plan tags: - jetpack-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 /wpcom/v2/sites/{wpcom_site}/jetpack-search/queue-post-count: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackSearchQueuePostCount summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-search/queue-post-count tags: - jetpack-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 /wpcom/v2/sites/{wpcom_site}/jetpack-search/stats: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackSearchStats summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-search/stats tags: - jetpack-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 /wpcom/v2/sites/{wpcom_site}/jetpack-social: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackSocial summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-social tags: - jetpack-social responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-social/generate-image-token: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackSocialGenerateImageToken summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-social/generate-image-token tags: - jetpack-social responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: text: type: string image_url: type: string format: uri template: type: string required: - text /wpcom/v2/sites/{wpcom_site}/jetpack-stats-dashboard/module-settings: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackStatsDashboardModuleSettings summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-stats-dashboard/module-settings tags: - jetpack-stats-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteJetpackStatsDashboardModuleSettings summary: PUT /wpcom/v2/sites/{wpcom_site}/jetpack-stats-dashboard/module-settings tags: - jetpack-stats-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteJetpackStatsDashboardModuleSettings summary: PATCH /wpcom/v2/sites/{wpcom_site}/jetpack-stats-dashboard/module-settings tags: - jetpack-stats-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string get: operationId: getWpcomV2SitesbyWpcomSiteJetpackStatsDashboardModuleSettings summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-stats-dashboard/module-settings tags: - jetpack-stats-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-stats-dashboard/modules: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackStatsDashboardModules summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-stats-dashboard/modules tags: - jetpack-stats-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteJetpackStatsDashboardModules summary: PUT /wpcom/v2/sites/{wpcom_site}/jetpack-stats-dashboard/modules tags: - jetpack-stats-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteJetpackStatsDashboardModules summary: PATCH /wpcom/v2/sites/{wpcom_site}/jetpack-stats-dashboard/modules tags: - jetpack-stats-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string get: operationId: getWpcomV2SitesbyWpcomSiteJetpackStatsDashboardModules summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-stats-dashboard/modules tags: - jetpack-stats-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-stats-dashboard/notices: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackStatsDashboardNotices summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-stats-dashboard/notices tags: - jetpack-stats-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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 enum: &id001 - opt_out_new_stats - new_stats_feedback - opt_in_new_stats - do_you_love_jetpack_stats - commercial_site_upgrade - tier_upgrade - focus_jetpack_purchase - traffic_page_settings - traffic_page_highlights_module_settings - gdpr_cookie_consent - able_to_submit_user_feedback - show_floating_user_feedback_panel description: ID of the notice status: type: string enum: &id002 - dismissed - postponed description: Status of the notice postponed_for: type: number description: Postponed for (in seconds) required: - id - status put: operationId: putWpcomV2SitesbyWpcomSiteJetpackStatsDashboardNotices summary: PUT /wpcom/v2/sites/{wpcom_site}/jetpack-stats-dashboard/notices tags: - jetpack-stats-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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 enum: *id001 description: ID of the notice status: type: string enum: *id002 description: Status of the notice postponed_for: type: number description: Postponed for (in seconds) required: - id - status patch: operationId: patchWpcomV2SitesbyWpcomSiteJetpackStatsDashboardNotices summary: PATCH /wpcom/v2/sites/{wpcom_site}/jetpack-stats-dashboard/notices tags: - jetpack-stats-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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 enum: *id001 description: ID of the notice status: type: string enum: *id002 description: Status of the notice postponed_for: type: number description: Postponed for (in seconds) required: - id - status get: operationId: getWpcomV2SitesbyWpcomSiteJetpackStatsDashboardNotices summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-stats-dashboard/notices tags: - jetpack-stats-dashboard responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-stats/usage: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackStatsUsage summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-stats/usage tags: - jetpack-stats responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-stats/user-feedback: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackStatsUserFeedback summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-stats/user-feedback tags: - jetpack-stats responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: source_url: type: string description: URL of the request source product_name: type: string description: Product name of the feedback target feedback: type: string description: Feedback content required: - source_url - product_name - feedback /wpcom/v2/sites/{wpcom_site}/jetpack-sync-actions: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackSyncActions summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-sync-actions tags: - jetpack-sync-actions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: codec: type: string enum: &id003 - simple - deflate-json - deflate-json-array description: The name of the codec that encodes the data. queue: type: string enum: &id004 - sync - immediate-send - full_sync description: The name of the Sync queue. timestamp: type: number description: Current server time so we can compensate for clock differences. cd: type: string description: Checkout_duration, aka time spent retrieving queue items from the DB. pd: type: string description: Preprocess duration, aka time spent converting queue items into data to send. buffer_id: type: string description: The ID of the Queue buffer checked out for processing. queue_size: type: integer description: Current size of Sync queue. timeout: type: integer default: 30 description: Request timeout sync_flow_type: type: string enum: &id005 - default - dedicated description: Whether Sync actions are sent on shutdown (default) or in a separate dedicated request (dedicated). storage_type: type: string enum: &id006 - options - custom description: Whether Sync actions are stored in the options table (options) or in a custom table (custom). required: - codec - queue - timestamp - cd - pd put: operationId: putWpcomV2SitesbyWpcomSiteJetpackSyncActions summary: PUT /wpcom/v2/sites/{wpcom_site}/jetpack-sync-actions tags: - jetpack-sync-actions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: codec: type: string enum: *id003 description: The name of the codec that encodes the data. queue: type: string enum: *id004 description: The name of the Sync queue. timestamp: type: number description: Current server time so we can compensate for clock differences. cd: type: string description: Checkout_duration, aka time spent retrieving queue items from the DB. pd: type: string description: Preprocess duration, aka time spent converting queue items into data to send. buffer_id: type: string description: The ID of the Queue buffer checked out for processing. queue_size: type: integer description: Current size of Sync queue. timeout: type: integer default: 30 description: Request timeout sync_flow_type: type: string enum: *id005 description: Whether Sync actions are sent on shutdown (default) or in a separate dedicated request (dedicated). storage_type: type: string enum: *id006 description: Whether Sync actions are stored in the options table (options) or in a custom table (custom). required: - codec - queue - timestamp - cd - pd patch: operationId: patchWpcomV2SitesbyWpcomSiteJetpackSyncActions summary: PATCH /wpcom/v2/sites/{wpcom_site}/jetpack-sync-actions tags: - jetpack-sync-actions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: codec: type: string enum: *id003 description: The name of the codec that encodes the data. queue: type: string enum: *id004 description: The name of the Sync queue. timestamp: type: number description: Current server time so we can compensate for clock differences. cd: type: string description: Checkout_duration, aka time spent retrieving queue items from the DB. pd: type: string description: Preprocess duration, aka time spent converting queue items into data to send. buffer_id: type: string description: The ID of the Queue buffer checked out for processing. queue_size: type: integer description: Current size of Sync queue. timeout: type: integer default: 30 description: Request timeout sync_flow_type: type: string enum: *id005 description: Whether Sync actions are sent on shutdown (default) or in a separate dedicated request (dedicated). storage_type: type: string enum: *id006 description: Whether Sync actions are stored in the options table (options) or in a custom table (custom). required: - codec - queue - timestamp - cd - pd /wpcom/v2/sites/{wpcom_site}/jetpack-token-health: post: operationId: postWpcomV2SitesbyWpcomSiteJetpackTokenHealth summary: POST /wpcom/v2/sites/{wpcom_site}/jetpack-token-health tags: - jetpack-token-health responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: blog_token: type: string description: Signed blog token, as it would appear in the authorization header of a request user_token: type: string description: Signed user token, as it would appear in the authorization header of a request required: - blog_token - user_token /wpcom/v2/sites/{wpcom_site}/jetpack-token-health/blog: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackTokenHealthBlog summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-token-health/blog tags: - jetpack-token-health responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-token-health/user: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackTokenHealthUser summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-token-health/user tags: - jetpack-token-health responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jetpack-wpcom-user-data: get: operationId: getWpcomV2SitesbyWpcomSiteJetpackWpcomUserData summary: GET /wpcom/v2/sites/{wpcom_site}/jetpack-wpcom-user-data tags: - jetpack-wpcom-user-data responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/jitm/{message_path}: get: operationId: getWpcomV2SitesbyWpcomSiteJitmbyMessagePath summary: GET /wpcom/v2/sites/{wpcom_site}/jitm/{message_path} tags: - jitm responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: message_path in: path required: true schema: type: string - name: external_user_id in: query required: false schema: type: integer - name: user_roles in: query required: false schema: type: string - name: query_string in: query required: false schema: type: string - name: mobile_browser in: query required: false schema: type: integer /wpcom/v2/sites/{wpcom_site}/launch: post: operationId: postWpcomV2SitesbyWpcomSiteLaunch summary: POST /wpcom/v2/sites/{wpcom_site}/launch tags: - launch responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/launch-site: post: operationId: postWpcomV2SitesbyWpcomSiteLaunchSite summary: POST /wpcom/v2/sites/{wpcom_site}/launch-site tags: - launch-site responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/launchpad: get: operationId: getWpcomV2SitesbyWpcomSiteLaunchpad summary: GET /wpcom/v2/sites/{wpcom_site}/launchpad tags: - launchpad responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: checklist_slug in: query required: false schema: type: string enum: - build - free - link-in-bio - link-in-bio-tld - newsletter - intent-newsletter-goal - create-course-goal - videopress - write - design-first - intent-build - intent-write - intent-free-newsletter - intent-paid-newsletter - earn - host-site - subscribers - assembler-first - readymade-template - ai-assembler - legacy-site-setup - sell - entrepreneur-site-setup - post-migration - start-writing description: Checklist slug - name: launchpad_context in: query required: false schema: type: string description: Screen where Launchpand instance is loaded. - name: use_goals in: query required: false schema: type: boolean default: false description: Should the launchpad data use site goals or intent. - name: enable_checklist_for_goals in: query required: false schema: type: array default: [] items: type: string description: Used by the client to signal to Jetpack which launchpad goals have been enabled (e.g. via feature flags) post: operationId: postWpcomV2SitesbyWpcomSiteLaunchpad summary: POST /wpcom/v2/sites/{wpcom_site}/launchpad tags: - launchpad responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: checklist_statuses: type: object description: Launchpad statuses launchpad_screen: type: string enum: &id007 - 'off' - minimized - full - skipped description: Launchpad screen is_checklist_dismissed: type: object description: Marks a checklist as dismissed by the user hide_fse_next_steps_modal: type: boolean description: Controls whether we show or hide the next steps modal in the full site editor put: operationId: putWpcomV2SitesbyWpcomSiteLaunchpad summary: PUT /wpcom/v2/sites/{wpcom_site}/launchpad tags: - launchpad responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: checklist_statuses: type: object description: Launchpad statuses launchpad_screen: type: string enum: *id007 description: Launchpad screen is_checklist_dismissed: type: object description: Marks a checklist as dismissed by the user hide_fse_next_steps_modal: type: boolean description: Controls whether we show or hide the next steps modal in the full site editor patch: operationId: patchWpcomV2SitesbyWpcomSiteLaunchpad summary: PATCH /wpcom/v2/sites/{wpcom_site}/launchpad tags: - launchpad responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: checklist_statuses: type: object description: Launchpad statuses launchpad_screen: type: string enum: *id007 description: Launchpad screen is_checklist_dismissed: type: object description: Marks a checklist as dismissed by the user hide_fse_next_steps_modal: type: boolean description: Controls whether we show or hide the next steps modal in the full site editor /wpcom/v2/sites/{wpcom_site}/launchpad/navigator: get: operationId: getWpcomV2SitesbyWpcomSiteLaunchpadNavigator summary: GET /wpcom/v2/sites/{wpcom_site}/launchpad/navigator tags: - launchpad responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteLaunchpadNavigator summary: POST /wpcom/v2/sites/{wpcom_site}/launchpad/navigator tags: - launchpad responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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_checklist_slug: type: string description: The slug of the checklist to set as active. remove_checklist_slug: type: string enum: &id008 - build - free - link-in-bio - link-in-bio-tld - newsletter - intent-newsletter-goal - create-course-goal - videopress - write - design-first - intent-build - intent-write - intent-free-newsletter - intent-paid-newsletter - earn - host-site - subscribers - assembler-first - readymade-template - ai-assembler - legacy-site-setup - sell - entrepreneur-site-setup - post-migration - start-writing description: The slug of the checklist to remove from the active list. put: operationId: putWpcomV2SitesbyWpcomSiteLaunchpadNavigator summary: PUT /wpcom/v2/sites/{wpcom_site}/launchpad/navigator tags: - launchpad responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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_checklist_slug: type: string description: The slug of the checklist to set as active. remove_checklist_slug: type: string enum: *id008 description: The slug of the checklist to remove from the active list. patch: operationId: patchWpcomV2SitesbyWpcomSiteLaunchpadNavigator summary: PATCH /wpcom/v2/sites/{wpcom_site}/launchpad/navigator tags: - launchpad responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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_checklist_slug: type: string description: The slug of the checklist to set as active. remove_checklist_slug: type: string enum: *id008 description: The slug of the checklist to remove from the active list. /wpcom/v2/sites/{wpcom_site}/mailchimp: get: operationId: getWpcomV2SitesbyWpcomSiteMailchimp summary: GET /wpcom/v2/sites/{wpcom_site}/mailchimp tags: - mailchimp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/mailchimp/groups: get: operationId: getWpcomV2SitesbyWpcomSiteMailchimpGroups summary: GET /wpcom/v2/sites/{wpcom_site}/mailchimp/groups tags: - mailchimp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/mailchimp/settings: get: operationId: getWpcomV2SitesbyWpcomSiteMailchimpSettings summary: GET /wpcom/v2/sites/{wpcom_site}/mailchimp/settings tags: - mailchimp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/mailpoet/add-upgrade: post: operationId: postWpcomV2SitesbyWpcomSiteMailpoetAddUpgrade summary: POST /wpcom/v2/sites/{wpcom_site}/mailpoet/add-upgrade tags: - mailpoet responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/mapbox: get: operationId: getWpcomV2SitesbyWpcomSiteMapbox summary: GET /wpcom/v2/sites/{wpcom_site}/mapbox tags: - mapbox responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/marketplace/products/reinstall: get: operationId: getWpcomV2SitesbyWpcomSiteMarketplaceProductsReinstall summary: GET /wpcom/v2/sites/{wpcom_site}/marketplace/products/reinstall tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/marketplace/reviews/{product_type}/{product_slug}/stats: get: operationId: getWpcomV2SitesbyWpcomSiteMarketplaceReviewsbyProductTypebyProductSlugStats summary: GET /wpcom/v2/sites/{wpcom_site}/marketplace/reviews/{product_type}/{product_slug}/stats tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: product_type in: path required: true schema: type: string - name: product_slug in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/marketplace/reviews/{product_type}/{product_slug}/validate: get: operationId: getWpcomV2SitesbyWpcomSiteMarketplaceReviewsbyProductTypebyProductSlugValidate summary: GET /wpcom/v2/sites/{wpcom_site}/marketplace/reviews/{product_type}/{product_slug}/validate tags: - marketplace responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: product_type in: path required: true schema: type: string - name: product_slug in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/mcp-abilities: get: operationId: getWpcomV2SitesbyWpcomSiteMcpAbilities summary: GET /wpcom/v2/sites/{wpcom_site}/mcp-abilities tags: - mcp-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 post: operationId: postWpcomV2SitesbyWpcomSiteMcpAbilities summary: POST /wpcom/v2/sites/{wpcom_site}/mcp-abilities tags: - mcp-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 requestBody: content: application/json: schema: type: object properties: site_level_enabled: type: boolean abilities: type: object group_intents: type: object /wpcom/v2/sites/{wpcom_site}/media/videopress-playback-jwt/{guid}: post: operationId: postWpcomV2SitesbyWpcomSiteMediaVideopressPlaybackJwtbyGuid summary: POST /wpcom/v2/sites/{wpcom_site}/media/videopress-playback-jwt/{guid} 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: guid in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteMediaVideopressPlaybackJwtbyGuid summary: PUT /wpcom/v2/sites/{wpcom_site}/media/videopress-playback-jwt/{guid} 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: guid in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteMediaVideopressPlaybackJwtbyGuid summary: PATCH /wpcom/v2/sites/{wpcom_site}/media/videopress-playback-jwt/{guid} 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: guid in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/media/videopress-privacy-details/{guid}: post: operationId: postWpcomV2SitesbyWpcomSiteMediaVideopressPrivacyDetailsbyGuid summary: POST /wpcom/v2/sites/{wpcom_site}/media/videopress-privacy-details/{guid} 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: guid in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteMediaVideopressPrivacyDetailsbyGuid summary: PUT /wpcom/v2/sites/{wpcom_site}/media/videopress-privacy-details/{guid} 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: guid in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteMediaVideopressPrivacyDetailsbyGuid summary: PATCH /wpcom/v2/sites/{wpcom_site}/media/videopress-privacy-details/{guid} 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: guid in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/media/videopress-upload-jwt: post: operationId: postWpcomV2SitesbyWpcomSiteMediaVideopressUploadJwt summary: POST /wpcom/v2/sites/{wpcom_site}/media/videopress-upload-jwt 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 put: operationId: putWpcomV2SitesbyWpcomSiteMediaVideopressUploadJwt summary: PUT /wpcom/v2/sites/{wpcom_site}/media/videopress-upload-jwt 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 patch: operationId: patchWpcomV2SitesbyWpcomSiteMediaVideopressUploadJwt summary: PATCH /wpcom/v2/sites/{wpcom_site}/media/videopress-upload-jwt 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 /wpcom/v2/sites/{wpcom_site}/memberships/comp/{comp_id}: get: operationId: getWpcomV2SitesbyWpcomSiteMembershipsCompbyCompId summary: GET /wpcom/v2/sites/{wpcom_site}/memberships/comp/{comp_id} tags: - memberships responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: comp_id in: path required: true schema: type: string delete: operationId: deleteWpcomV2SitesbyWpcomSiteMembershipsCompbyCompId summary: DELETE /wpcom/v2/sites/{wpcom_site}/memberships/comp/{comp_id} tags: - memberships responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: comp_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/memberships/comps: get: operationId: getWpcomV2SitesbyWpcomSiteMembershipsComps summary: GET /wpcom/v2/sites/{wpcom_site}/memberships/comps tags: - memberships responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/memberships/comps/{user_id}/{plan_id}: post: operationId: postWpcomV2SitesbyWpcomSiteMembershipsCompsbyUserIdbyPlanId summary: POST /wpcom/v2/sites/{wpcom_site}/memberships/comps/{user_id}/{plan_id} tags: - memberships responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: user_id in: path required: true schema: type: string - name: plan_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: no_expiration: type: boolean default: false description: Set to true for an indefinite comp. Otherwise end_date is inferred from the plan renewal interval. /wpcom/v2/sites/{wpcom_site}/memberships/coupon/{coupon_id}: put: operationId: putWpcomV2SitesbyWpcomSiteMembershipsCouponbyCouponId summary: PUT /wpcom/v2/sites/{wpcom_site}/memberships/coupon/{coupon_id} tags: - memberships responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: coupon_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: coupon_code: type: string description: Coupon code for the coupon. can_be_combined: type: string description: If the coupon can be combined with other coupons. first_time_purchase_only: type: string description: If the coupon can only be used if the user is not yet subscribed. limit_per_user: type: string description: Limit of use of this coupon per user. start_date: type: string description: Coupon campaign start date (format yyyy-mm-dd). end_date: type: string description: Coupon campaign end date (format yyyy-mm-dd). plan_ids_allow_list: type: array items: {} description: Array of plan ids the coupon can be applied to. duration: type: string description: Duration of the coupon once applied. In months. It can be a human-readable string, but it will always return a number of months (example "12 months"). email_allow_list: type: array items: {} description: List of white listed emails with potential wildcards. discount_type: type: string enum: - amount - percentage description: Type of discount applied. discount_value: type: string description: Discount value (if discount_type set as "amount"). discount_percentage: type: string description: Discount percentage (if discount_type set as "percentage"). required: - coupon_code - can_be_combined - first_time_purchase_only - start_date - plan_ids_allow_list - email_allow_list - discount_type delete: operationId: deleteWpcomV2SitesbyWpcomSiteMembershipsCouponbyCouponId summary: DELETE /wpcom/v2/sites/{wpcom_site}/memberships/coupon/{coupon_id} tags: - memberships responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: coupon_id in: path required: true schema: type: string - name: currency in: query required: false schema: default: false /wpcom/v2/sites/{wpcom_site}/memberships/coupons: post: operationId: postWpcomV2SitesbyWpcomSiteMembershipsCoupons summary: POST /wpcom/v2/sites/{wpcom_site}/memberships/coupons tags: - memberships responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: coupon_code: type: string description: Coupon code for the coupon. can_be_combined: type: string description: If the coupon can be combined with other coupons. first_time_purchase_only: type: string description: If the coupon can only be used if the user is not yet subscribed. limit_per_user: type: string description: Limit of use of this coupon per user. start_date: type: string description: Coupon campaign start date (format yyyy-mm-dd). end_date: type: string description: Coupon campaign end date (format yyyy-mm-dd). plan_ids_allow_list: type: array items: {} description: Array of plan ids the coupon can be applied to. duration: type: string description: Duration of the coupon once applied. In months. It can be a human-readable string, but it will always return a number of months (example "12 months"). email_allow_list: type: array items: {} description: List of white listed emails with potential wildcards. discount_type: type: string enum: - amount - percentage description: Type of discount applied. discount_value: type: string description: Discount value (if discount_type set as "amount"). discount_percentage: type: string description: Discount percentage (if discount_type set as "percentage"). required: - coupon_code - can_be_combined - first_time_purchase_only - start_date - plan_ids_allow_list - email_allow_list - discount_type get: operationId: getWpcomV2SitesbyWpcomSiteMembershipsCoupons summary: GET /wpcom/v2/sites/{wpcom_site}/memberships/coupons tags: - memberships responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/memberships/coupons/apply: post: operationId: postWpcomV2SitesbyWpcomSiteMembershipsCouponsApply summary: POST /wpcom/v2/sites/{wpcom_site}/memberships/coupons/apply tags: - memberships responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: coupon_codes: type: array items: {} description: List of coupon codes. plan_id: type: string description: Plan id. user_email: type: string description: User email. required: - coupon_codes - plan_id - user_email /wpcom/v2/sites/{wpcom_site}/memberships/earnings: get: operationId: getWpcomV2SitesbyWpcomSiteMembershipsEarnings summary: GET /wpcom/v2/sites/{wpcom_site}/memberships/earnings tags: - memberships responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: currency in: query required: false schema: default: false /wpcom/v2/sites/{wpcom_site}/memberships/subscriber-importer/get_subscriptions: get: operationId: getWpcomV2SitesbyWpcomSiteMembershipsSubscriberImporterGetSubscriptions summary: GET /wpcom/v2/sites/{wpcom_site}/memberships/subscriber-importer/get_subscriptions tags: - memberships responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/memberships/subscriber-importer/import: post: operationId: postWpcomV2SitesbyWpcomSiteMembershipsSubscriberImporterImport summary: POST /wpcom/v2/sites/{wpcom_site}/memberships/subscriber-importer/import tags: - memberships responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: product_id: type: string description: WPCOM Plan id. subscription_id: type: string description: Stripe Subscription id. customer_email: type: string description: User email. stripe_restricted_key: type: string description: Stripe restricted key with subscription_write scope. required: - product_id - subscription_id - customer_email /wpcom/v2/sites/{wpcom_site}/memberships/subscribers: get: operationId: getWpcomV2SitesbyWpcomSiteMembershipsSubscribers summary: GET /wpcom/v2/sites/{wpcom_site}/memberships/subscribers tags: - memberships responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: offset in: query required: false schema: default: 0 description: Offset of the list. - name: single in: query required: false schema: type: boolean default: false description: Returns only one memberships. - name: search in: query required: false schema: type: string description: Allow to search a user either by email, login or name. /wpcom/v2/sites/{wpcom_site}/migrate-from/{source_blog_id}: post: operationId: postWpcomV2SitesbyWpcomSiteMigrateFrombySourceBlogId summary: POST /wpcom/v2/sites/{wpcom_site}/migrate-from/{source_blog_id} tags: - migrate-from responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: source_blog_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/migrate-provision/{source_blog_id}: post: operationId: postWpcomV2SitesbyWpcomSiteMigrateProvisionbySourceBlogId summary: POST /wpcom/v2/sites/{wpcom_site}/migrate-provision/{source_blog_id} tags: - migrate-provision responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: source_blog_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/migration-enabled/{source_blog}: get: operationId: getWpcomV2SitesbyWpcomSiteMigrationEnabledbySourceBlog summary: GET /wpcom/v2/sites/{wpcom_site}/migration-enabled/{source_blog} tags: - migration-enabled responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: source_blog in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/migration-flow: post: operationId: postWpcomV2SitesbyWpcomSiteMigrationFlow summary: POST /wpcom/v2/sites/{wpcom_site}/migration-flow tags: - migration-flow responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string delete: operationId: deleteWpcomV2SitesbyWpcomSiteMigrationFlow summary: DELETE /wpcom/v2/sites/{wpcom_site}/migration-flow tags: - migration-flow responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/migration-status: get: operationId: getWpcomV2SitesbyWpcomSiteMigrationStatus summary: GET /wpcom/v2/sites/{wpcom_site}/migration-status tags: - migration-status responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/newsletter-categories: get: operationId: getWpcomV2SitesbyWpcomSiteNewsletterCategories summary: GET /wpcom/v2/sites/{wpcom_site}/newsletter-categories tags: - newsletter-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 /wpcom/v2/sites/{wpcom_site}/newsletter-categories/count: get: operationId: getWpcomV2SitesbyWpcomSiteNewsletterCategoriesCount summary: GET /wpcom/v2/sites/{wpcom_site}/newsletter-categories/count tags: - newsletter-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: term_ids in: query required: false schema: default: '' /wpcom/v2/sites/{wpcom_site}/newsletter-categories/subscriptions: get: operationId: getWpcomV2SitesbyWpcomSiteNewsletterCategoriesSubscriptions summary: GET /wpcom/v2/sites/{wpcom_site}/newsletter-categories/subscriptions tags: - newsletter-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 post: operationId: postWpcomV2SitesbyWpcomSiteNewsletterCategoriesSubscriptions summary: POST /wpcom/v2/sites/{wpcom_site}/newsletter-categories/subscriptions tags: - newsletter-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: token: {} tracks: {} categories: type: array items: type: object put: operationId: putWpcomV2SitesbyWpcomSiteNewsletterCategoriesSubscriptions summary: PUT /wpcom/v2/sites/{wpcom_site}/newsletter-categories/subscriptions tags: - newsletter-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: token: {} tracks: {} categories: type: array items: type: object patch: operationId: patchWpcomV2SitesbyWpcomSiteNewsletterCategoriesSubscriptions summary: PATCH /wpcom/v2/sites/{wpcom_site}/newsletter-categories/subscriptions tags: - newsletter-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: token: {} tracks: {} categories: type: array items: type: object /wpcom/v2/sites/{wpcom_site}/newsletter-categories/subscriptions/{subscription_id}: get: operationId: getWpcomV2SitesbyWpcomSiteNewsletterCategoriesSubscriptionsbySubscriptionId summary: GET /wpcom/v2/sites/{wpcom_site}/newsletter-categories/subscriptions/{subscription_id} tags: - newsletter-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: subscription_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/newsletter-categories/{term_id}: post: operationId: postWpcomV2SitesbyWpcomSiteNewsletterCategoriesbyTermId summary: POST /wpcom/v2/sites/{wpcom_site}/newsletter-categories/{term_id} tags: - newsletter-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: term_id in: path required: true schema: type: string delete: operationId: deleteWpcomV2SitesbyWpcomSiteNewsletterCategoriesbyTermId summary: DELETE /wpcom/v2/sites/{wpcom_site}/newsletter-categories/{term_id} tags: - newsletter-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: term_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/newsletter-email-sent-status: get: operationId: getWpcomV2SitesbyWpcomSiteNewsletterEmailSentStatus summary: GET /wpcom/v2/sites/{wpcom_site}/newsletter-email-sent-status tags: - newsletter-email-sent-status responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: post_id in: query required: true schema: type: integer /wpcom/v2/sites/{wpcom_site}/newspack-blocks-posts: get: operationId: getWpcomV2SitesbyWpcomSiteNewspackBlocksPosts summary: GET /wpcom/v2/sites/{wpcom_site}/newspack-blocks-posts tags: - newspack-blocks-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: className in: query required: false schema: type: string default: '' - name: showExcerpt in: query required: false schema: type: boolean default: true - name: showFullContent in: query required: false schema: type: boolean default: false - name: excerptLength in: query required: false schema: type: number default: 55 - name: showReadMore in: query required: false schema: type: boolean default: false - name: infiniteScroll in: query required: false schema: type: boolean default: false - name: readMoreLabel in: query required: false schema: type: string default: Keep reading - name: showDate in: query required: false schema: type: boolean default: true - name: showImage in: query required: false schema: type: boolean default: true - name: showCaption in: query required: false schema: type: boolean default: false - name: showCredit in: query required: false schema: type: boolean default: false - name: disableImageLazyLoad in: query required: false schema: type: boolean default: false - name: fetchPriority in: query required: false schema: type: string default: '' - name: imageShape in: query required: false schema: type: string default: landscape - name: minHeight in: query required: false schema: type: integer default: 0 - name: moreButton in: query required: false schema: type: boolean default: false - name: moreButtonText in: query required: false schema: type: string default: '' - name: showAuthor in: query required: false schema: type: boolean default: true - name: showAvatar in: query required: false schema: type: boolean default: true - name: showCategory in: query required: false schema: type: boolean default: false - name: postLayout in: query required: false schema: type: string default: list - name: columns in: query required: false schema: type: integer default: 3 - name: colGap in: query required: false schema: type: integer default: 3 - name: postsToShow in: query required: false schema: type: integer default: 3 - name: mediaPosition in: query required: false schema: type: string default: top - name: authors in: query required: false schema: type: array default: [] items: type: integer - name: categories in: query required: false schema: type: array default: [] items: type: integer - name: categoryJoinType in: query required: false schema: type: string enum: - or - all default: or - name: includeSubcategories in: query required: false schema: type: boolean default: true - name: tags in: query required: false schema: type: array default: [] items: type: integer - name: customTaxonomies in: query required: false schema: type: array default: [] items: type: object - name: tagExclusions in: query required: false schema: type: array default: [] items: type: integer - name: categoryExclusions in: query required: false schema: type: array default: [] items: type: integer - name: customTaxonomyExclusions in: query required: false schema: type: array default: [] items: type: object - name: specificPosts in: query required: false schema: type: array default: [] items: type: integer - name: typeScale in: query required: false schema: type: integer default: 4 - name: imageScale in: query required: false schema: type: integer default: 3 - name: mobileStack in: query required: false schema: type: boolean default: false - name: sectionHeader in: query required: false schema: type: string default: '' - name: specificMode in: query required: false schema: type: boolean default: false - name: textColor in: query required: false schema: type: string default: '' - name: customTextColor in: query required: false schema: type: string default: '' - name: singleMode in: query required: false schema: type: boolean default: false - name: showSubtitle in: query required: false schema: type: boolean default: false - name: postType in: query required: false schema: type: array default: - post items: type: string - name: textAlign in: query required: false schema: type: string default: left - name: includedPostStatuses in: query required: false schema: type: array default: - publish items: type: string - name: deduplicate in: query required: false schema: type: boolean default: true - name: exclude_ids in: query required: false schema: type: array default: [] items: type: integer - name: exclude in: query required: false schema: type: array default: [] items: type: integer - name: include in: query required: false schema: type: array default: [] items: type: integer /wpcom/v2/sites/{wpcom_site}/newspack-blocks-specific-posts: get: operationId: getWpcomV2SitesbyWpcomSiteNewspackBlocksSpecificPosts summary: GET /wpcom/v2/sites/{wpcom_site}/newspack-blocks-specific-posts tags: - newspack-blocks-specific-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: search in: query required: false schema: {} - name: postsToShow in: query required: false schema: {} - name: postType in: query required: false schema: type: array default: [] items: type: string /wpcom/v2/sites/{wpcom_site}/newspack-gpt/chat-completion: post: operationId: postWpcomV2SitesbyWpcomSiteNewspackGptChatCompletion summary: POST /wpcom/v2/sites/{wpcom_site}/newspack-gpt/chat-completion tags: - newspack-gpt responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: backscroll: type: array items: {} functions: type: array items: {} /wpcom/v2/sites/{wpcom_site}/nudge/click: post: operationId: postWpcomV2SitesbyWpcomSiteNudgeClick summary: POST /wpcom/v2/sites/{wpcom_site}/nudge/click tags: - nudge responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: nudge_name: {} required: - nudge_name /wpcom/v2/sites/{wpcom_site}/odie-search/search/{bot_id}: post: operationId: postWpcomV2SitesbyWpcomSiteOdieSearchSearchbyBotId summary: POST /wpcom/v2/sites/{wpcom_site}/odie-search/search/{bot_id} tags: - odie-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: bot_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: query: type: string description: The query to search for. required: - query /wpcom/v2/sites/{wpcom_site}/onboarding-customization: post: operationId: postWpcomV2SitesbyWpcomSiteOnboardingCustomization summary: POST /wpcom/v2/sites/{wpcom_site}/onboarding-customization tags: - onboarding-customization responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: settings: type: string pattern: type: string enable_features_for_goals: type: string put: operationId: putWpcomV2SitesbyWpcomSiteOnboardingCustomization summary: PUT /wpcom/v2/sites/{wpcom_site}/onboarding-customization tags: - onboarding-customization responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: settings: type: string pattern: type: string enable_features_for_goals: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteOnboardingCustomization summary: PATCH /wpcom/v2/sites/{wpcom_site}/onboarding-customization tags: - onboarding-customization responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: settings: type: string pattern: type: string enable_features_for_goals: type: string /wpcom/v2/sites/{wpcom_site}/p2/summary/rank: get: operationId: getWpcomV2SitesbyWpcomSiteP2SummaryRank summary: GET /wpcom/v2/sites/{wpcom_site}/p2/summary/rank tags: - p2 responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: post_id in: query required: true schema: {} description: Post ID to rank - name: rank in: query required: false schema: {} description: How do you rank this response /wpcom/v2/sites/{wpcom_site}/p2/summary/summarize: post: operationId: postWpcomV2SitesbyWpcomSiteP2SummarySummarize summary: POST /wpcom/v2/sites/{wpcom_site}/p2/summary/summarize tags: - p2 responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: post_id: description: Post ID to summarize required: - post_id /wpcom/v2/sites/{wpcom_site}/partners/{partner}/notifications: post: operationId: postWpcomV2SitesbyWpcomSitePartnersbyPartnerNotifications summary: POST /wpcom/v2/sites/{wpcom_site}/partners/{partner}/notifications tags: - partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: partner in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSitePartnersbyPartnerNotifications summary: PUT /wpcom/v2/sites/{wpcom_site}/partners/{partner}/notifications tags: - partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: partner in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSitePartnersbyPartnerNotifications summary: PATCH /wpcom/v2/sites/{wpcom_site}/partners/{partner}/notifications tags: - partners responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: partner in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/plugins/recommended: get: operationId: getWpcomV2SitesbyWpcomSitePluginsRecommended summary: GET /wpcom/v2/sites/{wpcom_site}/plugins/recommended 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: limit in: query required: false schema: type: integer default: -1 description: Limit the number of recommended plugins returned. -1 for no limits. /wpcom/v2/sites/{wpcom_site}/podcast-distribution/pocket-casts/submit: post: operationId: postWpcomV2SitesbyWpcomSitePodcastDistributionPocketCastsSubmit summary: POST /wpcom/v2/sites/{wpcom_site}/podcast-distribution/pocket-casts/submit tags: - podcast-distribution responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: feed_path: type: string description: Optional site-relative feed path (e.g. /category/podcast/feed/). The host is always this blog, so it cannot target another site. /wpcom/v2/sites/{wpcom_site}/podcast-player: get: operationId: getWpcomV2SitesbyWpcomSitePodcastPlayer summary: GET /wpcom/v2/sites/{wpcom_site}/podcast-player tags: - podcast-player responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: url in: query required: true schema: type: string description: The Podcast RSS feed URL. - name: guids in: query required: true schema: type: array items: {} description: A list of unique identifiers for fetching specific podcast episodes. - name: episode-options in: query required: true schema: type: boolean description: Whether we should return the episodes list for use in the selection UI /wpcom/v2/sites/{wpcom_site}/podcast-player/track-quantity: get: operationId: getWpcomV2SitesbyWpcomSitePodcastPlayerTrackQuantity summary: GET /wpcom/v2/sites/{wpcom_site}/podcast-player/track-quantity tags: - podcast-player responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/podcast-stats: get: operationId: getWpcomV2SitesbyWpcomSitePodcastStats summary: GET /wpcom/v2/sites/{wpcom_site}/podcast-stats tags: - podcast-stats responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: from in: query required: false schema: type: string - name: to in: query required: false schema: type: string - name: limit in: query required: false schema: type: integer /wpcom/v2/sites/{wpcom_site}/podcast-stats/episode-totals: get: operationId: getWpcomV2SitesbyWpcomSitePodcastStatsEpisodeTotals summary: GET /wpcom/v2/sites/{wpcom_site}/podcast-stats/episode-totals tags: - podcast-stats responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: post_ids in: query required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/podcast-stats/episode/{post_id}: get: operationId: getWpcomV2SitesbyWpcomSitePodcastStatsEpisodebyPostId summary: GET /wpcom/v2/sites/{wpcom_site}/podcast-stats/episode/{post_id} tags: - podcast-stats responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: post_id in: path required: true schema: type: string - name: from in: query required: false schema: type: string - name: to in: query required: false schema: type: string /wpcom/v2/sites/{wpcom_site}/podcast-stats/overview: get: operationId: getWpcomV2SitesbyWpcomSitePodcastStatsOverview summary: GET /wpcom/v2/sites/{wpcom_site}/podcast-stats/overview tags: - podcast-stats responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: limit in: query required: false schema: type: integer /wpcom/v2/sites/{wpcom_site}/podcast/settings: get: operationId: getWpcomV2SitesbyWpcomSitePodcastSettings summary: GET /wpcom/v2/sites/{wpcom_site}/podcast/settings tags: - podcast responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSitePodcastSettings summary: POST /wpcom/v2/sites/{wpcom_site}/podcast/settings tags: - podcast responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: podcasting_category_id: type: integer podcasting_title: type: string podcasting_talent_name: type: string podcasting_summary: type: string podcasting_copyright: type: string podcasting_explicit: type: string podcasting_image: type: string podcasting_image_id: type: integer podcasting_category_1: type: string podcasting_category_2: type: string podcasting_category_3: type: string podcasting_email: type: string podcasting_show_urls: type: object podcasting_show_states: type: object put: operationId: putWpcomV2SitesbyWpcomSitePodcastSettings summary: PUT /wpcom/v2/sites/{wpcom_site}/podcast/settings tags: - podcast responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: podcasting_category_id: type: integer podcasting_title: type: string podcasting_talent_name: type: string podcasting_summary: type: string podcasting_copyright: type: string podcasting_explicit: type: string podcasting_image: type: string podcasting_image_id: type: integer podcasting_category_1: type: string podcasting_category_2: type: string podcasting_category_3: type: string podcasting_email: type: string podcasting_show_urls: type: object podcasting_show_states: type: object patch: operationId: patchWpcomV2SitesbyWpcomSitePodcastSettings summary: PATCH /wpcom/v2/sites/{wpcom_site}/podcast/settings tags: - podcast responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: podcasting_category_id: type: integer podcasting_title: type: string podcasting_talent_name: type: string podcasting_summary: type: string podcasting_copyright: type: string podcasting_explicit: type: string podcasting_image: type: string podcasting_image_id: type: integer podcasting_category_1: type: string podcasting_category_2: type: string podcasting_category_3: type: string podcasting_email: type: string podcasting_show_urls: type: object podcasting_show_states: type: object /wpcom/v2/sites/{wpcom_site}/post-counts/{type}: get: operationId: getWpcomV2SitesbyWpcomSitePostCountsbyType summary: GET /wpcom/v2/sites/{wpcom_site}/post-counts/{type} tags: - post-counts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: author in: query required: false schema: type: integer default: 0 description: 'author ID to filter post ' /wpcom/v2/sites/{wpcom_site}/post-types: get: operationId: getWpcomV2SitesbyWpcomSitePostTypes summary: GET /wpcom/v2/sites/{wpcom_site}/post-types tags: - post-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 /wpcom/v2/sites/{wpcom_site}/posts-to-podcast: get: operationId: getWpcomV2SitesbyWpcomSitePostsToPodcast summary: GET /wpcom/v2/sites/{wpcom_site}/posts-to-podcast tags: - posts-to-podcast responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSitePostsToPodcast summary: POST /wpcom/v2/sites/{wpcom_site}/posts-to-podcast tags: - posts-to-podcast responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: window: type: object description: 'Either { unit: days|weeks|months, n: } or { from, to } as ISO-8601 dates. Mutually exclusive with postIds.' postIds: type: array items: type: integer description: Explicit list of post IDs to source the episode from. Mutually exclusive with window. Lists longer than POST_IDS_MAX entries are truncated to the first POST_IDS_MAX after deduplication. length: type: string enum: - short - medium - long default: medium description: 'Length preset controlling the dialogue script''s total word budget: short (~450 words, ~3 min), medium (~1050 words, ~7 min), long (~1800 words, ~12 min). Does not affect which posts are included — that is fully determined by `postIds` or the resolved `window`. Defaults to medium.' voicePreset: type: string enum: - witty - earnest - professional default: witty description: Registered voice-preset id (one satirical + one mitigator pair). Defaults to witty. prompt: type: string default: '' description: Optional free-text steering for the dialogue stage. Influences tone, framing, and focus but cannot override output structure. /wpcom/v2/sites/{wpcom_site}/posts-to-podcast/episodes: get: operationId: getWpcomV2SitesbyWpcomSitePostsToPodcastEpisodes summary: GET /wpcom/v2/sites/{wpcom_site}/posts-to-podcast/episodes tags: - posts-to-podcast responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: page in: query required: false schema: type: integer default: 1 - name: per_page in: query required: false schema: type: integer default: 5 /wpcom/v2/sites/{wpcom_site}/posts-to-podcast/jobs/{job_id}: get: operationId: getWpcomV2SitesbyWpcomSitePostsToPodcastJobsbyJobId summary: GET /wpcom/v2/sites/{wpcom_site}/posts-to-podcast/jobs/{job_id} tags: - posts-to-podcast responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: job_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/posts-to-podcast/post-publish-promo/dismiss: post: operationId: postWpcomV2SitesbyWpcomSitePostsToPodcastPostPublishPromoDismiss summary: POST /wpcom/v2/sites/{wpcom_site}/posts-to-podcast/post-publish-promo/dismiss tags: - posts-to-podcast responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/posts/auto-draft: post: operationId: postWpcomV2SitesbyWpcomSitePostsAutoDraft summary: POST /wpcom/v2/sites/{wpcom_site}/posts/auto-draft 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 /wpcom/v2/sites/{wpcom_site}/posts/map-url: get: operationId: getWpcomV2SitesbyWpcomSitePostsMapUrl summary: GET /wpcom/v2/sites/{wpcom_site}/posts/map-url 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: latitude in: query required: true schema: type: string - name: longitude in: query required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/posts/{postId}/map-url: get: operationId: getWpcomV2SitesbyWpcomSitePostsbyPostidMapUrl summary: GET /wpcom/v2/sites/{wpcom_site}/posts/{postId}/map-url 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: postId in: path required: true schema: type: string - name: latitude in: query required: true schema: type: string - name: longitude in: query required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/posts/{postId}/publicize: post: operationId: postWpcomV2SitesbyWpcomSitePostsbyPostidPublicize summary: POST /wpcom/v2/sites/{wpcom_site}/posts/{postId}/publicize 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: postId in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: message: type: string description: The message to share. skipped_connections: type: array items: {} description: Array of external connection IDs to skip sharing. async: type: boolean default: false description: Whether to share the post asynchronously. required: - message /wpcom/v2/sites/{wpcom_site}/posts/{postId}/publicize/published-actions: get: operationId: getWpcomV2SitesbyWpcomSitePostsbyPostidPublicizePublishedActions summary: GET /wpcom/v2/sites/{wpcom_site}/posts/{postId}/publicize/published-actions 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: postId in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/preview-links: get: operationId: getWpcomV2SitesbyWpcomSitePreviewLinks summary: GET /wpcom/v2/sites/{wpcom_site}/preview-links tags: - preview-links responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSitePreviewLinks summary: POST /wpcom/v2/sites/{wpcom_site}/preview-links tags: - preview-links responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/preview-links/{code}: delete: operationId: deleteWpcomV2SitesbyWpcomSitePreviewLinksbyCode summary: DELETE /wpcom/v2/sites/{wpcom_site}/preview-links/{code} tags: - preview-links responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: code in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/private/media/{jwt}/download: get: operationId: getWpcomV2SitesbyWpcomSitePrivateMediabyJwtDownload summary: GET /wpcom/v2/sites/{wpcom_site}/private/media/{jwt}/download tags: - private responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: jwt in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/profile: get: operationId: getWpcomV2SitesbyWpcomSiteProfile summary: GET /wpcom/v2/sites/{wpcom_site}/profile tags: - profile responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/publicize/connection-test-results: get: operationId: getWpcomV2SitesbyWpcomSitePublicizeConnectionTestResults summary: GET /wpcom/v2/sites/{wpcom_site}/publicize/connection-test-results tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/publicize/connections: get: operationId: getWpcomV2SitesbyWpcomSitePublicizeConnections summary: GET /wpcom/v2/sites/{wpcom_site}/publicize/connections tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: test_connections in: query required: false schema: type: boolean description: Whether to test connections. post: operationId: postWpcomV2SitesbyWpcomSitePublicizeConnections summary: POST /wpcom/v2/sites/{wpcom_site}/publicize/connections tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: keyring_connection_ID: type: integer description: Keyring connection ID. external_user_ID: type: string description: External User Id - in case of services like Facebook. shared: type: boolean description: Whether the connection is shared with other users. required: - keyring_connection_ID /wpcom/v2/sites/{wpcom_site}/publicize/connections/{connection_id}: post: operationId: postWpcomV2SitesbyWpcomSitePublicizeConnectionsbyConnectionId summary: POST /wpcom/v2/sites/{wpcom_site}/publicize/connections/{connection_id} tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: connection_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: shared: type: boolean description: Whether the connection is shared with other users. put: operationId: putWpcomV2SitesbyWpcomSitePublicizeConnectionsbyConnectionId summary: PUT /wpcom/v2/sites/{wpcom_site}/publicize/connections/{connection_id} tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: connection_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: shared: type: boolean description: Whether the connection is shared with other users. patch: operationId: patchWpcomV2SitesbyWpcomSitePublicizeConnectionsbyConnectionId summary: PATCH /wpcom/v2/sites/{wpcom_site}/publicize/connections/{connection_id} tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: connection_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: shared: type: boolean description: Whether the connection is shared with other users. delete: operationId: deleteWpcomV2SitesbyWpcomSitePublicizeConnectionsbyConnectionId summary: DELETE /wpcom/v2/sites/{wpcom_site}/publicize/connections/{connection_id} tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: connection_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/publicize/keyring-result: get: operationId: getWpcomV2SitesbyWpcomSitePublicizeKeyringResult summary: GET /wpcom/v2/sites/{wpcom_site}/publicize/keyring-result tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: request_id in: query required: true schema: type: string description: ID of the connect request. /wpcom/v2/sites/{wpcom_site}/publicize/message-templates/placeholders: get: operationId: getWpcomV2SitesbyWpcomSitePublicizeMessageTemplatesPlaceholders summary: GET /wpcom/v2/sites/{wpcom_site}/publicize/message-templates/placeholders tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/publicize/published-actions: get: operationId: getWpcomV2SitesbyWpcomSitePublicizePublishedActions summary: GET /wpcom/v2/sites/{wpcom_site}/publicize/published-actions tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/publicize/render-messages: post: operationId: postWpcomV2SitesbyWpcomSitePublicizeRenderMessages summary: POST /wpcom/v2/sites/{wpcom_site}/publicize/render-messages tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: post_id: type: integer description: The ID of the post to render the messages for. items: type: array items: type: object description: List of per-connection render inputs. post_intent: type: object default: [] description: Edited post fields to use when rendering unsaved preview changes. required: - post_id - items /wpcom/v2/sites/{wpcom_site}/publicize/scheduled-actions: get: operationId: getWpcomV2SitesbyWpcomSitePublicizeScheduledActions summary: GET /wpcom/v2/sites/{wpcom_site}/publicize/scheduled-actions tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: post_id in: query required: false schema: type: integer description: The post ID to filter the items by. post: operationId: postWpcomV2SitesbyWpcomSitePublicizeScheduledActions summary: POST /wpcom/v2/sites/{wpcom_site}/publicize/scheduled-actions tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: post_id: type: integer connection_id: type: integer message: type: string share_date: type: integer description: Deprecated in favor of timestamp. timestamp: type: integer description: GMT/UTC Unix timestamp in seconds for the action. required: - post_id - connection_id /wpcom/v2/sites/{wpcom_site}/publicize/scheduled-actions/{action_id}: get: operationId: getWpcomV2SitesbyWpcomSitePublicizeScheduledActionsbyActionId summary: GET /wpcom/v2/sites/{wpcom_site}/publicize/scheduled-actions/{action_id} tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: action_id in: path required: true schema: type: string post: operationId: postWpcomV2SitesbyWpcomSitePublicizeScheduledActionsbyActionId summary: POST /wpcom/v2/sites/{wpcom_site}/publicize/scheduled-actions/{action_id} tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: action_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: message: type: string share_date: type: integer description: Deprecated in favor of timestamp. timestamp: type: integer description: GMT/UTC Unix timestamp in seconds for the action. put: operationId: putWpcomV2SitesbyWpcomSitePublicizeScheduledActionsbyActionId summary: PUT /wpcom/v2/sites/{wpcom_site}/publicize/scheduled-actions/{action_id} tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: action_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: message: type: string share_date: type: integer description: Deprecated in favor of timestamp. timestamp: type: integer description: GMT/UTC Unix timestamp in seconds for the action. patch: operationId: patchWpcomV2SitesbyWpcomSitePublicizeScheduledActionsbyActionId summary: PATCH /wpcom/v2/sites/{wpcom_site}/publicize/scheduled-actions/{action_id} tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: action_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: message: type: string share_date: type: integer description: Deprecated in favor of timestamp. timestamp: type: integer description: GMT/UTC Unix timestamp in seconds for the action. delete: operationId: deleteWpcomV2SitesbyWpcomSitePublicizeScheduledActionsbyActionId summary: DELETE /wpcom/v2/sites/{wpcom_site}/publicize/scheduled-actions/{action_id} tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: action_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/publicize/services: get: operationId: getWpcomV2SitesbyWpcomSitePublicizeServices summary: GET /wpcom/v2/sites/{wpcom_site}/publicize/services tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/publicize/share-post/{postId}: post: operationId: postWpcomV2SitesbyWpcomSitePublicizeSharePostbyPostid summary: POST /wpcom/v2/sites/{wpcom_site}/publicize/share-post/{postId} tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: postId in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: message: type: string description: The message to share. skipped_connections: type: array items: {} description: Array of external connection IDs to skip sharing. async: type: boolean default: false description: Whether to share the post asynchronously. required: - message /wpcom/v2/sites/{wpcom_site}/publicize/share-status: get: operationId: getWpcomV2SitesbyWpcomSitePublicizeShareStatus summary: GET /wpcom/v2/sites/{wpcom_site}/publicize/share-status tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: post_id in: query required: true schema: type: integer description: The post ID to filter the items by. /wpcom/v2/sites/{wpcom_site}/publicize/share-status/sync: post: operationId: postWpcomV2SitesbyWpcomSitePublicizeShareStatusSync summary: POST /wpcom/v2/sites/{wpcom_site}/publicize/share-status/sync tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: post_id: type: integer description: The post ID to update the data for. shares: type: array items: type: object description: The share status items. required: - post_id - shares /wpcom/v2/sites/{wpcom_site}/publicize/social-image-generator/font-options: get: operationId: getWpcomV2SitesbyWpcomSitePublicizeSocialImageGeneratorFontOptions summary: GET /wpcom/v2/sites/{wpcom_site}/publicize/social-image-generator/font-options tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/publicize/social-image-generator/generate-token: post: operationId: postWpcomV2SitesbyWpcomSitePublicizeSocialImageGeneratorGenerateToken summary: POST /wpcom/v2/sites/{wpcom_site}/publicize/social-image-generator/generate-token tags: - publicize responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: text: type: string description: The text to be used to generate the image. image_url: description: The URL of the background image to use when generating the social image. template: type: string enum: - highway - dois - fullscreen - edge description: The template slug. font: type: string description: The font slug. required: - text /wpcom/v2/sites/{wpcom_site}/push-notifications: post: operationId: postWpcomV2SitesbyWpcomSitePushNotifications summary: POST /wpcom/v2/sites/{wpcom_site}/push-notifications tags: - push-notifications responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: type: type: string enum: - store_order - store_review - store_stock description: The notification type (e.g., store_order, store_review, store_stock). title: type: object description: The title to display in the notification. message: type: object description: The message to display in the notification. icon: type: string description: The icon to use in the notification (optional). timestamp: type: string description: The timestamp this notification was generated. resource_id: type: integer description: The ID of the resource this notification relates to, e.g. order ID, review ID. meta: type: object description: Any extra meta data that is relevant to the notification. tokens: type: array items: type: object description: An array of notifications to send required: - type - title - message - timestamp - resource_id - tokens /wpcom/v2/sites/{wpcom_site}/reader-chat-settings: get: operationId: getWpcomV2SitesbyWpcomSiteReaderChatSettings summary: GET /wpcom/v2/sites/{wpcom_site}/reader-chat-settings tags: - reader-chat-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: postWpcomV2SitesbyWpcomSiteReaderChatSettings summary: POST /wpcom/v2/sites/{wpcom_site}/reader-chat-settings tags: - reader-chat-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: enabled: type: boolean required: - enabled /wpcom/v2/sites/{wpcom_site}/recovery-mode-status: post: operationId: postWpcomV2SitesbyWpcomSiteRecoveryModeStatus summary: POST /wpcom/v2/sites/{wpcom_site}/recovery-mode-status tags: - recovery-mode-status responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: recovery_mode_email_last_sent: type: integer recovery_session_entered_at: type: integer recovery_session_exited_at: type: integer recovery_session_errors: type: array items: type: object /wpcom/v2/sites/{wpcom_site}/related-posts: get: operationId: getWpcomV2SitesbyWpcomSiteRelatedPosts summary: GET /wpcom/v2/sites/{wpcom_site}/related-posts tags: - related-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 /wpcom/v2/sites/{wpcom_site}/related-posts/enable: post: operationId: postWpcomV2SitesbyWpcomSiteRelatedPostsEnable summary: POST /wpcom/v2/sites/{wpcom_site}/related-posts/enable tags: - related-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 /wpcom/v2/sites/{wpcom_site}/related-posts/{id}: get: operationId: getWpcomV2SitesbyWpcomSiteRelatedPostsbyId summary: GET /wpcom/v2/sites/{wpcom_site}/related-posts/{id} tags: - related-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 /wpcom/v2/sites/{wpcom_site}/reset-migration: post: operationId: postWpcomV2SitesbyWpcomSiteResetMigration summary: POST /wpcom/v2/sites/{wpcom_site}/reset-migration tags: - reset-migration responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/reset-site: post: operationId: postWpcomV2SitesbyWpcomSiteResetSite summary: POST /wpcom/v2/sites/{wpcom_site}/reset-site tags: - reset-site responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/reset-site/content-summary: get: operationId: getWpcomV2SitesbyWpcomSiteResetSiteContentSummary summary: GET /wpcom/v2/sites/{wpcom_site}/reset-site/content-summary tags: - reset-site responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/reset-site/status: get: operationId: getWpcomV2SitesbyWpcomSiteResetSiteStatus summary: GET /wpcom/v2/sites/{wpcom_site}/reset-site/status tags: - reset-site responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind: get: operationId: getWpcomV2SitesbyWpcomSiteRewind summary: GET /wpcom/v2/sites/{wpcom_site}/rewind tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/abspath: get: operationId: getWpcomV2SitesbyWpcomSiteRewindAbspath summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/abspath tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/backup/filtered/prepare: post: operationId: postWpcomV2SitesbyWpcomSiteRewindBackupFilteredPrepare summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/backup/filtered/prepare tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: backup_id: type: string manifest_filter: type: string data_type: type: string required: - backup_id - manifest_filter - data_type /wpcom/v2/sites/{wpcom_site}/rewind/backup/filtered/status: post: operationId: postWpcomV2SitesbyWpcomSiteRewindBackupFilteredStatus summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/backup/filtered/status tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: key: type: string data_type: type: string required: - key - data_type /wpcom/v2/sites/{wpcom_site}/rewind/backup/ls: post: operationId: postWpcomV2SitesbyWpcomSiteRewindBackupLs summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/backup/ls tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: backup_id: type: string path: type: string extension_version: type: string required: - backup_id /wpcom/v2/sites/{wpcom_site}/rewind/backup/path-info: post: operationId: postWpcomV2SitesbyWpcomSiteRewindBackupPathInfo summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/backup/path-info tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: backup_id: type: string manifest_path: type: string extension_type: type: string required: - backup_id /wpcom/v2/sites/{wpcom_site}/rewind/backup/{backup_id}/extension/{extension_type}/stream: get: operationId: getWpcomV2SitesbyWpcomSiteRewindBackupbyBackupIdExtensionbyExtensionTypeStream summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/backup/{backup_id}/extension/{extension_type}/stream tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: backup_id in: path required: true schema: type: string - name: extension_type in: path required: true schema: type: string - name: extension_slug in: query required: true schema: type: string - name: extension_version in: query required: true schema: type: string - name: token in: query required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/backup/{backup_id}/extension/{extension_type}/url: post: operationId: postWpcomV2SitesbyWpcomSiteRewindBackupbyBackupIdExtensionbyExtensionTypeUrl summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/backup/{backup_id}/extension/{extension_type}/url tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: backup_id in: path required: true schema: type: string - name: extension_type in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: extension_slug: type: string extension_version: type: string required: - extension_slug - extension_version /wpcom/v2/sites/{wpcom_site}/rewind/backup/{backup_id}/file/{manifest_path}/stream: get: operationId: getWpcomV2SitesbyWpcomSiteRewindBackupbyBackupIdFilebyManifestPathStream summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/backup/{backup_id}/file/{manifest_path}/stream tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: backup_id in: path required: true schema: type: string - name: manifest_path in: path required: true schema: type: string - name: token in: query required: true schema: type: string - name: disposition in: query required: false schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/backup/{backup_id}/file/{manifest_path}/url: get: operationId: getWpcomV2SitesbyWpcomSiteRewindBackupbyBackupIdFilebyManifestPathUrl summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/backup/{backup_id}/file/{manifest_path}/url tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: backup_id in: path required: true schema: type: string - name: manifest_path in: path required: true schema: type: string - name: disposition in: query required: false schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/backups: get: operationId: getWpcomV2SitesbyWpcomSiteRewindBackups summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/backups tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/backups/enqueue: post: operationId: postWpcomV2SitesbyWpcomSiteRewindBackupsEnqueue summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/backups/enqueue tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/basic: get: operationId: getWpcomV2SitesbyWpcomSiteRewindBasic summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/basic tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/billing/receipts: get: operationId: getWpcomV2SitesbyWpcomSiteRewindBillingReceipts summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/billing/receipts tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/capabilities: get: operationId: getWpcomV2SitesbyWpcomSiteRewindCapabilities summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/capabilities tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/credentials: get: operationId: getWpcomV2SitesbyWpcomSiteRewindCredentials summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/credentials tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/credentials/delete: post: operationId: postWpcomV2SitesbyWpcomSiteRewindCredentialsDelete summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/credentials/delete tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: role: {} required: - role /wpcom/v2/sites/{wpcom_site}/rewind/credentials/test: post: operationId: postWpcomV2SitesbyWpcomSiteRewindCredentialsTest summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/credentials/test tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: role: {} required: - role /wpcom/v2/sites/{wpcom_site}/rewind/credentials/update: post: operationId: postWpcomV2SitesbyWpcomSiteRewindCredentialsUpdate summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/credentials/update tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: credentials: type: object required: - credentials /wpcom/v2/sites/{wpcom_site}/rewind/downloads: get: operationId: getWpcomV2SitesbyWpcomSiteRewindDownloads summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/downloads tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteRewindDownloads summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/downloads tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: rewindId: {} include_path_list: {} exclude_path_list: {} types: {} skip_activity_log: type: boolean default: false /wpcom/v2/sites/{wpcom_site}/rewind/downloads/{id}: get: operationId: getWpcomV2SitesbyWpcomSiteRewindDownloadsbyId summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/downloads/{id} tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: postWpcomV2SitesbyWpcomSiteRewindDownloadsbyId summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/downloads/{id} tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: dismissed: type: boolean default: false put: operationId: putWpcomV2SitesbyWpcomSiteRewindDownloadsbyId summary: PUT /wpcom/v2/sites/{wpcom_site}/rewind/downloads/{id} tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: dismissed: type: boolean default: false patch: operationId: patchWpcomV2SitesbyWpcomSiteRewindDownloadsbyId summary: PATCH /wpcom/v2/sites/{wpcom_site}/rewind/downloads/{id} tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: dismissed: type: boolean default: false /wpcom/v2/sites/{wpcom_site}/rewind/downloads/{id}/data: get: operationId: getWpcomV2SitesbyWpcomSiteRewindDownloadsbyIdData summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/downloads/{id}/data tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: token in: query required: true schema: {} /wpcom/v2/sites/{wpcom_site}/rewind/options: get: operationId: getWpcomV2SitesbyWpcomSiteRewindOptions summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/options tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteRewindOptions summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/options tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/policies: get: operationId: getWpcomV2SitesbyWpcomSiteRewindPolicies summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/policies tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/preflight: get: operationId: getWpcomV2SitesbyWpcomSiteRewindPreflight summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/preflight tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteRewindPreflight summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/preflight tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/restores: get: operationId: getWpcomV2SitesbyWpcomSiteRewindRestores summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/restores tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/restores/{id}: post: operationId: postWpcomV2SitesbyWpcomSiteRewindRestoresbyId summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/restores/{id} tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: dismissed: type: boolean default: false put: operationId: putWpcomV2SitesbyWpcomSiteRewindRestoresbyId summary: PUT /wpcom/v2/sites/{wpcom_site}/rewind/restores/{id} tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: dismissed: type: boolean default: false patch: operationId: patchWpcomV2SitesbyWpcomSiteRewindRestoresbyId summary: PATCH /wpcom/v2/sites/{wpcom_site}/rewind/restores/{id} tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: dismissed: type: boolean default: false /wpcom/v2/sites/{wpcom_site}/rewind/scheduled: get: operationId: getWpcomV2SitesbyWpcomSiteRewindScheduled summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/scheduled tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteRewindScheduled summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/scheduled tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: schedule_hour: type: integer required: - schedule_hour /wpcom/v2/sites/{wpcom_site}/rewind/screenshots: get: operationId: getWpcomV2SitesbyWpcomSiteRewindScreenshots summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/screenshots tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: period in: query required: false schema: {} /wpcom/v2/sites/{wpcom_site}/rewind/send-security-notification: post: operationId: postWpcomV2SitesbyWpcomSiteRewindSendSecurityNotification summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/send-security-notification tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/size: get: operationId: getWpcomV2SitesbyWpcomSiteRewindSize summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/size tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/staging: get: operationId: getWpcomV2SitesbyWpcomSiteRewindStaging summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/staging tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/staging/list: get: operationId: getWpcomV2SitesbyWpcomSiteRewindStagingList summary: GET /wpcom/v2/sites/{wpcom_site}/rewind/staging/list tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/rewind/staging/update: post: operationId: postWpcomV2SitesbyWpcomSiteRewindStagingUpdate summary: POST /wpcom/v2/sites/{wpcom_site}/rewind/staging/update tags: - rewind responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: staging: type: boolean required: - staging /wpcom/v2/sites/{wpcom_site}/rtc-notices/join-request: post: operationId: postWpcomV2SitesbyWpcomSiteRtcNoticesJoinRequest summary: POST /wpcom/v2/sites/{wpcom_site}/rtc-notices/join-request tags: - rtc-notices responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: post_id: type: integer required: - post_id /wpcom/v2/sites/{wpcom_site}/rtc-notices/join-requests: get: operationId: getWpcomV2SitesbyWpcomSiteRtcNoticesJoinRequests summary: GET /wpcom/v2/sites/{wpcom_site}/rtc-notices/join-requests tags: - rtc-notices responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: post_id in: query required: true schema: type: integer /wpcom/v2/sites/{wpcom_site}/rtc-notices/join-requests/clear: post: operationId: postWpcomV2SitesbyWpcomSiteRtcNoticesJoinRequestsClear summary: POST /wpcom/v2/sites/{wpcom_site}/rtc-notices/join-requests/clear tags: - rtc-notices responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: post_id: type: integer required: - post_id /wpcom/v2/sites/{wpcom_site}/rtc/connection-log: post: operationId: postWpcomV2SitesbyWpcomSiteRtcConnectionLog summary: POST /wpcom/v2/sites/{wpcom_site}/rtc/connection-log tags: - rtc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: event: type: string enum: - connected - disconnected - reconnecting - jwt_fetch_error properties: type: object default: [] required: - event /wpcom/v2/sites/{wpcom_site}/rtc/pinghub-token: post: operationId: postWpcomV2SitesbyWpcomSiteRtcPinghubToken summary: POST /wpcom/v2/sites/{wpcom_site}/rtc/pinghub-token tags: - rtc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/scan: get: operationId: getWpcomV2SitesbyWpcomSiteScan summary: GET /wpcom/v2/sites/{wpcom_site}/scan tags: - scan responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/scan/counts: get: operationId: getWpcomV2SitesbyWpcomSiteScanCounts summary: GET /wpcom/v2/sites/{wpcom_site}/scan/counts tags: - scan responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/scan/enqueue: post: operationId: postWpcomV2SitesbyWpcomSiteScanEnqueue summary: POST /wpcom/v2/sites/{wpcom_site}/scan/enqueue tags: - scan responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/scan/history: get: operationId: getWpcomV2SitesbyWpcomSiteScanHistory summary: GET /wpcom/v2/sites/{wpcom_site}/scan/history tags: - scan responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: filter in: query required: false schema: type: string default: - ignored - fixed /wpcom/v2/sites/{wpcom_site}/scan/threat/{threatId}: get: operationId: getWpcomV2SitesbyWpcomSiteScanThreatbyThreatid summary: GET /wpcom/v2/sites/{wpcom_site}/scan/threat/{threatId} tags: - scan responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: threatId in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/scheduled-updates/notifications: get: operationId: getWpcomV2SitesbyWpcomSiteScheduledUpdatesNotifications summary: GET /wpcom/v2/sites/{wpcom_site}/scheduled-updates/notifications tags: - scheduled-updates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteScheduledUpdatesNotifications summary: POST /wpcom/v2/sites/{wpcom_site}/scheduled-updates/notifications tags: - scheduled-updates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: success: type: boolean description: Indicates if the success notification is enabled for your user failure: type: boolean description: Indicates if the failure notification is enabled for your user put: operationId: putWpcomV2SitesbyWpcomSiteScheduledUpdatesNotifications summary: PUT /wpcom/v2/sites/{wpcom_site}/scheduled-updates/notifications tags: - scheduled-updates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: success: type: boolean description: Indicates if the success notification is enabled for your user failure: type: boolean description: Indicates if the failure notification is enabled for your user patch: operationId: patchWpcomV2SitesbyWpcomSiteScheduledUpdatesNotifications summary: PATCH /wpcom/v2/sites/{wpcom_site}/scheduled-updates/notifications tags: - scheduled-updates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: success: type: boolean description: Indicates if the success notification is enabled for your user failure: type: boolean description: Indicates if the failure notification is enabled for your user /wpcom/v2/sites/{wpcom_site}/scheduled-updates/verify-path-status: get: operationId: getWpcomV2SitesbyWpcomSiteScheduledUpdatesVerifyPathStatus summary: GET /wpcom/v2/sites/{wpcom_site}/scheduled-updates/verify-path-status tags: - scheduled-updates responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: path in: query required: true schema: type: string description: The path to check for availability. /wpcom/v2/sites/{wpcom_site}/search-stats: get: operationId: getWpcomV2SitesbyWpcomSiteSearchStats summary: GET /wpcom/v2/sites/{wpcom_site}/search-stats tags: - search-stats responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: start_date in: query required: true schema: type: string description: start date to compute the stat - name: end_date in: query required: true schema: type: string description: end date to compute the stat - name: stat_names in: query required: true schema: type: array items: {} description: name of the stat to compute /wpcom/v2/sites/{wpcom_site}/search-suggestions: get: operationId: getWpcomV2SitesbyWpcomSiteSearchSuggestions summary: GET /wpcom/v2/sites/{wpcom_site}/search-suggestions tags: - search-suggestions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: query in: query required: true schema: type: string description: The search query prefix. - name: size in: query required: false schema: type: integer default: 5 description: The maximum number of suggestions to return. - name: language in: query required: false schema: type: string description: The optional language context for suggestions. /wpcom/v2/sites/{wpcom_site}/seller_footer: post: operationId: postWpcomV2SitesbyWpcomSiteSellerFooter summary: POST /wpcom/v2/sites/{wpcom_site}/seller_footer tags: - seller_footer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteSellerFooter summary: PUT /wpcom/v2/sites/{wpcom_site}/seller_footer tags: - seller_footer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteSellerFooter summary: PATCH /wpcom/v2/sites/{wpcom_site}/seller_footer tags: - seller_footer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/send-email-continue-site-build: post: operationId: postWpcomV2SitesbyWpcomSiteSendEmailContinueSiteBuild summary: POST /wpcom/v2/sites/{wpcom_site}/send-email-continue-site-build tags: - send-email-continue-site-build responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/send-email-preview: post: operationId: postWpcomV2SitesbyWpcomSiteSendEmailPreview summary: POST /wpcom/v2/sites/{wpcom_site}/send-email-preview tags: - send-email-preview responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: integer description: Unique identifier for the post. /wpcom/v2/sites/{wpcom_site}/service-api-keys/{service}: get: operationId: getWpcomV2SitesbyWpcomSiteServiceApiKeysbyService summary: GET /wpcom/v2/sites/{wpcom_site}/service-api-keys/{service} tags: - service-api-keys responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: service in: path required: true schema: type: string post: operationId: postWpcomV2SitesbyWpcomSiteServiceApiKeysbyService summary: POST /wpcom/v2/sites/{wpcom_site}/service-api-keys/{service} tags: - service-api-keys responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: service in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: service_api_key: type: string required: - service_api_key put: operationId: putWpcomV2SitesbyWpcomSiteServiceApiKeysbyService summary: PUT /wpcom/v2/sites/{wpcom_site}/service-api-keys/{service} tags: - service-api-keys responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: service in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: service_api_key: type: string required: - service_api_key patch: operationId: patchWpcomV2SitesbyWpcomSiteServiceApiKeysbyService summary: PATCH /wpcom/v2/sites/{wpcom_site}/service-api-keys/{service} tags: - service-api-keys responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: service in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: service_api_key: type: string required: - service_api_key delete: operationId: deleteWpcomV2SitesbyWpcomSiteServiceApiKeysbyService summary: DELETE /wpcom/v2/sites/{wpcom_site}/service-api-keys/{service} tags: - service-api-keys responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: service in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/shares-count: get: operationId: getWpcomV2SitesbyWpcomSiteSharesCount summary: GET /wpcom/v2/sites/{wpcom_site}/shares-count tags: - shares-count responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/shipstation/{rest_path}: get: operationId: getWpcomV2SitesbyWpcomSiteShipstationbyRestPath summary: GET /wpcom/v2/sites/{wpcom_site}/shipstation/{rest_path} tags: - shipstation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: rest_path in: path required: true schema: type: string post: operationId: postWpcomV2SitesbyWpcomSiteShipstationbyRestPath summary: POST /wpcom/v2/sites/{wpcom_site}/shipstation/{rest_path} tags: - shipstation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: rest_path in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteShipstationbyRestPath summary: PUT /wpcom/v2/sites/{wpcom_site}/shipstation/{rest_path} tags: - shipstation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: rest_path in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteShipstationbyRestPath summary: PATCH /wpcom/v2/sites/{wpcom_site}/shipstation/{rest_path} tags: - shipstation responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: rest_path in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/simple-payments/paypal/payment: post: operationId: postWpcomV2SitesbyWpcomSiteSimplePaymentsPaypalPayment summary: POST /wpcom/v2/sites/{wpcom_site}/simple-payments/paypal/payment tags: - simple-payments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/simple-payments/paypal/{paymentId}/execute: post: operationId: postWpcomV2SitesbyWpcomSiteSimplePaymentsPaypalbyPaymentidExecute summary: POST /wpcom/v2/sites/{wpcom_site}/simple-payments/paypal/{paymentId}/execute tags: - simple-payments responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: paymentId in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/site-assembler: post: operationId: postWpcomV2SitesbyWpcomSiteSiteAssembler summary: POST /wpcom/v2/sites/{wpcom_site}/site-assembler tags: - site-assembler responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: templates: type: array items: type: object pages: type: array items: type: object global_styles: type: object description: The global styles variation. can_replace_content: type: boolean default: false description: Whether to allow replacing existing content of the site including pages and posts. site_setup_option: type: string enum: &id009 - assembler - assembler-virtual-theme - readymade-template - '' default: '' description: Value to set the option wpcom_site_setup to mark assembled sites. put: operationId: putWpcomV2SitesbyWpcomSiteSiteAssembler summary: PUT /wpcom/v2/sites/{wpcom_site}/site-assembler tags: - site-assembler responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: templates: type: array items: type: object pages: type: array items: type: object global_styles: type: object description: The global styles variation. can_replace_content: type: boolean default: false description: Whether to allow replacing existing content of the site including pages and posts. site_setup_option: type: string enum: *id009 default: '' description: Value to set the option wpcom_site_setup to mark assembled sites. patch: operationId: patchWpcomV2SitesbyWpcomSiteSiteAssembler summary: PATCH /wpcom/v2/sites/{wpcom_site}/site-assembler tags: - site-assembler responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: templates: type: array items: type: object pages: type: array items: type: object global_styles: type: object description: The global styles variation. can_replace_content: type: boolean default: false description: Whether to allow replacing existing content of the site including pages and posts. site_setup_option: type: string enum: *id009 default: '' description: Value to set the option wpcom_site_setup to mark assembled sites. /wpcom/v2/sites/{wpcom_site}/site-goals: get: operationId: getWpcomV2SitesbyWpcomSiteSiteGoals summary: GET /wpcom/v2/sites/{wpcom_site}/site-goals tags: - site-goals responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteSiteGoals summary: POST /wpcom/v2/sites/{wpcom_site}/site-goals tags: - site-goals responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: site_goals: type: array items: {} required: - site_goals put: operationId: putWpcomV2SitesbyWpcomSiteSiteGoals summary: PUT /wpcom/v2/sites/{wpcom_site}/site-goals tags: - site-goals responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: site_goals: type: array items: {} required: - site_goals patch: operationId: patchWpcomV2SitesbyWpcomSiteSiteGoals summary: PATCH /wpcom/v2/sites/{wpcom_site}/site-goals tags: - site-goals responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: site_goals: type: array items: {} required: - site_goals /wpcom/v2/sites/{wpcom_site}/site-has-never-published-post: get: operationId: getWpcomV2SitesbyWpcomSiteSiteHasNeverPublishedPost summary: GET /wpcom/v2/sites/{wpcom_site}/site-has-never-published-post tags: - site-has-never-published-post responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: include_pages in: query required: false schema: type: boolean default: false description: Flag that also checks if user has ever published pages. /wpcom/v2/sites/{wpcom_site}/site-importer/paid-newsletter: post: operationId: postWpcomV2SitesbyWpcomSiteSiteImporterPaidNewsletter summary: POST /wpcom/v2/sites/{wpcom_site}/site-importer/paid-newsletter tags: - site-importer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: engine: type: string current_step: type: string skip: type: string import_url: type: string newsletter_location: type: string default: import-paid-subscribers required: - engine get: operationId: getWpcomV2SitesbyWpcomSiteSiteImporterPaidNewsletter summary: GET /wpcom/v2/sites/{wpcom_site}/site-importer/paid-newsletter tags: - site-importer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: engine in: query required: true schema: type: string - name: current_step in: query required: false schema: type: string - name: newsletter_location in: query required: false schema: type: string default: import-paid-subscribers /wpcom/v2/sites/{wpcom_site}/site-importer/paid-newsletter/map-stripe-plan-to-product: post: operationId: postWpcomV2SitesbyWpcomSiteSiteImporterPaidNewsletterMapStripePlanToProduct summary: POST /wpcom/v2/sites/{wpcom_site}/site-importer/paid-newsletter/map-stripe-plan-to-product tags: - site-importer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: engine: type: string current_step: type: string stripe_plan_id: type: string product_id: type: string newsletter_location: type: string default: import-paid-subscribers required: - engine - stripe_plan_id - product_id /wpcom/v2/sites/{wpcom_site}/site-importer/paid-newsletter/reset: post: operationId: postWpcomV2SitesbyWpcomSiteSiteImporterPaidNewsletterReset summary: POST /wpcom/v2/sites/{wpcom_site}/site-importer/paid-newsletter/reset tags: - site-importer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: engine: type: string import_url: type: string description: The URL being imported (must be a valid Substack newsletter URL) newsletter_location: type: string default: import-paid-subscribers required: - engine /wpcom/v2/sites/{wpcom_site}/site-importer/paid-newsletter/set-comp-plan: post: operationId: postWpcomV2SitesbyWpcomSiteSiteImporterPaidNewsletterSetCompPlan summary: POST /wpcom/v2/sites/{wpcom_site}/site-importer/paid-newsletter/set-comp-plan tags: - site-importer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: engine: type: string current_step: type: string comp_stripe_plan_id: type: string newsletter_location: type: string default: import-paid-subscribers required: - engine - comp_stripe_plan_id /wpcom/v2/sites/{wpcom_site}/site-importer/paid-newsletter/subscriber-import: post: operationId: postWpcomV2SitesbyWpcomSiteSiteImporterPaidNewsletterSubscriberImport summary: POST /wpcom/v2/sites/{wpcom_site}/site-importer/paid-newsletter/subscriber-import tags: - site-importer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: engine: type: string current_step: type: string newsletter_location: type: string default: import-paid-subscribers required: - engine /wpcom/v2/sites/{wpcom_site}/site-intent: post: operationId: postWpcomV2SitesbyWpcomSiteSiteIntent summary: POST /wpcom/v2/sites/{wpcom_site}/site-intent tags: - site-intent responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: site_intent: type: string required: - site_intent put: operationId: putWpcomV2SitesbyWpcomSiteSiteIntent summary: PUT /wpcom/v2/sites/{wpcom_site}/site-intent tags: - site-intent responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: site_intent: type: string required: - site_intent patch: operationId: patchWpcomV2SitesbyWpcomSiteSiteIntent summary: PATCH /wpcom/v2/sites/{wpcom_site}/site-intent tags: - site-intent responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: site_intent: type: string required: - site_intent get: operationId: getWpcomV2SitesbyWpcomSiteSiteIntent summary: GET /wpcom/v2/sites/{wpcom_site}/site-intent tags: - site-intent responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/site-migration-status-sticker: post: operationId: postWpcomV2SitesbyWpcomSiteSiteMigrationStatusSticker summary: POST /wpcom/v2/sites/{wpcom_site}/site-migration-status-sticker tags: - site-migration-status-sticker responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: status_sticker: type: string enum: - migration-in-progress - migration-pending - migration-pending-diy - migration-pending-difm - migration-pending-ssh - migration-started-diy - migration-started-difm - migration-started-ssh - migration-completed-diy - migration-completed-difm - migration-completed-ssh - migration-cancelled-difm required: - status_sticker delete: operationId: deleteWpcomV2SitesbyWpcomSiteSiteMigrationStatusSticker summary: DELETE /wpcom/v2/sites/{wpcom_site}/site-migration-status-sticker tags: - site-migration-status-sticker responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: query required: true schema: type: string enum: - pending /wpcom/v2/sites/{wpcom_site}/site-owner-transfer: post: operationId: postWpcomV2SitesbyWpcomSiteSiteOwnerTransfer summary: POST /wpcom/v2/sites/{wpcom_site}/site-owner-transfer tags: - site-owner-transfer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: new_site_owner: type: string context: type: string required: - new_site_owner /wpcom/v2/sites/{wpcom_site}/site-owner-transfer/confirm: post: operationId: postWpcomV2SitesbyWpcomSiteSiteOwnerTransferConfirm summary: POST /wpcom/v2/sites/{wpcom_site}/site-owner-transfer/confirm tags: - site-owner-transfer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: hash: type: string required: - hash /wpcom/v2/sites/{wpcom_site}/site-owner-transfer/eligibility: post: operationId: postWpcomV2SitesbyWpcomSiteSiteOwnerTransferEligibility summary: POST /wpcom/v2/sites/{wpcom_site}/site-owner-transfer/eligibility tags: - site-owner-transfer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: new_site_owner: type: string required: - new_site_owner /wpcom/v2/sites/{wpcom_site}/site-type: post: operationId: postWpcomV2SitesbyWpcomSiteSiteType summary: POST /wpcom/v2/sites/{wpcom_site}/site-type tags: - site-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: site_type: type: string required: - site_type put: operationId: putWpcomV2SitesbyWpcomSiteSiteType summary: PUT /wpcom/v2/sites/{wpcom_site}/site-type tags: - site-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: site_type: type: string required: - site_type patch: operationId: patchWpcomV2SitesbyWpcomSiteSiteType summary: PATCH /wpcom/v2/sites/{wpcom_site}/site-type tags: - site-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: site_type: type: string required: - site_type /wpcom/v2/sites/{wpcom_site}/site-vertical: post: operationId: postWpcomV2SitesbyWpcomSiteSiteVertical summary: POST /wpcom/v2/sites/{wpcom_site}/site-vertical tags: - site-vertical responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: site_vertical: type: string required: - site_vertical put: operationId: putWpcomV2SitesbyWpcomSiteSiteVertical summary: PUT /wpcom/v2/sites/{wpcom_site}/site-vertical tags: - site-vertical responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: site_vertical: type: string required: - site_vertical patch: operationId: patchWpcomV2SitesbyWpcomSiteSiteVertical summary: PATCH /wpcom/v2/sites/{wpcom_site}/site-vertical tags: - site-vertical responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: site_vertical: type: string required: - site_vertical /wpcom/v2/sites/{wpcom_site}/ssh-migration: get: operationId: getWpcomV2SitesbyWpcomSiteSshMigration summary: GET /wpcom/v2/sites/{wpcom_site}/ssh-migration tags: - ssh-migration responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteSshMigration summary: POST /wpcom/v2/sites/{wpcom_site}/ssh-migration tags: - ssh-migration responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: migration_source_site_domain: type: string description: Source site domain for the migration required: - migration_source_site_domain /wpcom/v2/sites/{wpcom_site}/ssh-migration/configure: post: operationId: postWpcomV2SitesbyWpcomSiteSshMigrationConfigure summary: POST /wpcom/v2/sites/{wpcom_site}/ssh-migration/configure tags: - ssh-migration responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: remote_host: type: string description: Remote host to connect to remote_user: type: string description: SSH username for the source site remote_domain: type: string description: Domain of the source site remote_port: type: integer description: SSH port for the source site required: - remote_host - remote_user - remote_domain /wpcom/v2/sites/{wpcom_site}/ssh-migration/start: post: operationId: postWpcomV2SitesbyWpcomSiteSshMigrationStart summary: POST /wpcom/v2/sites/{wpcom_site}/ssh-migration/start tags: - ssh-migration responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: remote_host: type: string description: Remote host to connect to remote_user: type: string description: SSH username for the source site remote_domain: type: string description: Domain of the source site remote_pass: type: string description: SSH password for the source site remote_docroot: type: string description: Document root path on the source site ssh_id: type: string description: SSH key identity data ssh_id_pass: type: string description: Passphrase for the SSH key remote_port: type: integer description: SSH port for the source site required: - remote_host - remote_user - remote_domain /wpcom/v2/sites/{wpcom_site}/ssh-migration/status: get: operationId: getWpcomV2SitesbyWpcomSiteSshMigrationStatus summary: GET /wpcom/v2/sites/{wpcom_site}/ssh-migration/status tags: - ssh-migration responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/ssh-migration/verify-host: post: operationId: postWpcomV2SitesbyWpcomSiteSshMigrationVerifyHost summary: POST /wpcom/v2/sites/{wpcom_site}/ssh-migration/verify-host tags: - ssh-migration responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: host: type: string description: The hostname or IP address to verify port: type: integer default: 22 description: 'The port number to verify (default: 22)' required: - host /wpcom/v2/sites/{wpcom_site}/staging-site: get: operationId: getWpcomV2SitesbyWpcomSiteStagingSite summary: GET /wpcom/v2/sites/{wpcom_site}/staging-site tags: - staging-site responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteStagingSite summary: POST /wpcom/v2/sites/{wpcom_site}/staging-site tags: - staging-site responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/staging-site/production-site-details: get: operationId: getWpcomV2SitesbyWpcomSiteStagingSiteProductionSiteDetails summary: GET /wpcom/v2/sites/{wpcom_site}/staging-site/production-site-details tags: - staging-site responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/staging-site/pull-from-staging/{staging_site_id}: post: operationId: postWpcomV2SitesbyWpcomSiteStagingSitePullFromStagingbyStagingSiteId summary: POST /wpcom/v2/sites/{wpcom_site}/staging-site/pull-from-staging/{staging_site_id} tags: - staging-site responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: staging_site_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: allow_woo_sync: type: boolean options: type: string items: type: string /wpcom/v2/sites/{wpcom_site}/staging-site/push-to-staging/{staging_site_id}: post: operationId: postWpcomV2SitesbyWpcomSiteStagingSitePushToStagingbyStagingSiteId summary: POST /wpcom/v2/sites/{wpcom_site}/staging-site/push-to-staging/{staging_site_id} tags: - staging-site responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: staging_site_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: options: type: object /wpcom/v2/sites/{wpcom_site}/staging-site/sync-state: get: operationId: getWpcomV2SitesbyWpcomSiteStagingSiteSyncState summary: GET /wpcom/v2/sites/{wpcom_site}/staging-site/sync-state tags: - staging-site responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/staging-site/validate-quota: post: operationId: postWpcomV2SitesbyWpcomSiteStagingSiteValidateQuota summary: POST /wpcom/v2/sites/{wpcom_site}/staging-site/validate-quota tags: - staging-site responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/staging-site/{staging_site_id}: delete: operationId: deleteWpcomV2SitesbyWpcomSiteStagingSitebyStagingSiteId summary: DELETE /wpcom/v2/sites/{wpcom_site}/staging-site/{staging_site_id} tags: - staging-site responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: staging_site_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/studio-app/sync/backup: post: operationId: postWpcomV2SitesbyWpcomSiteStudioAppSyncBackup summary: POST /wpcom/v2/sites/{wpcom_site}/studio-app/sync/backup tags: - studio-app responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: options: type: array default: - all items: type: string description: The types of data to include in the backup include_path_list: type: array items: type: string description: List of specific paths to include when using the "paths" option get: operationId: getWpcomV2SitesbyWpcomSiteStudioAppSyncBackup summary: GET /wpcom/v2/sites/{wpcom_site}/studio-app/sync/backup tags: - studio-app responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: backup_id in: query required: true schema: type: string description: The identifier of the backup to retrieve the status for /wpcom/v2/sites/{wpcom_site}/studio-app/sync/get-latest-rewind-id: get: operationId: getWpcomV2SitesbyWpcomSiteStudioAppSyncGetLatestRewindId summary: GET /wpcom/v2/sites/{wpcom_site}/studio-app/sync/get-latest-rewind-id tags: - studio-app responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/studio-app/sync/import: post: operationId: postWpcomV2SitesbyWpcomSiteStudioAppSyncImport summary: POST /wpcom/v2/sites/{wpcom_site}/studio-app/sync/import tags: - studio-app responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: options: type: array default: - all items: type: string description: The options for the import list_sync_items: type: array items: type: string description: List of specific paths to include when using the "paths" option get: operationId: getWpcomV2SitesbyWpcomSiteStudioAppSyncImport summary: GET /wpcom/v2/sites/{wpcom_site}/studio-app/sync/import tags: - studio-app responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/studio-app/sync/import/initiate: post: operationId: postWpcomV2SitesbyWpcomSiteStudioAppSyncImportInitiate summary: POST /wpcom/v2/sites/{wpcom_site}/studio-app/sync/import/initiate tags: - studio-app responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: import_attachment_id: type: integer description: The ID of the import attachment containing the Studio site archive options: type: array default: - all items: type: string description: The options for the import list_sync_items: type: array items: type: string description: List of specific paths to include when using the "paths" option required: - import_attachment_id /wpcom/v2/sites/{wpcom_site}/subscribers: get: operationId: getWpcomV2SitesbyWpcomSiteSubscribers summary: GET /wpcom/v2/sites/{wpcom_site}/subscribers tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: page in: query required: false schema: type: string default: 1 description: The current page. - name: per_page in: query required: false schema: type: string default: 100 description: The amount of items to show per page. - name: search in: query required: false schema: type: string description: Search for subscribers - name: sort in: query required: false schema: type: string enum: - date_subscribed - email - name - plan - subscription_status default: date_subscribed description: Sort subscribers by a specific field - name: sort_order in: query required: false schema: type: string enum: - asc - desc description: Sort order - name: filter in: query required: false schema: type: string enum: - all - wpcom - email - paid - comp - free - email_subscriber - reader_subscriber - unconfirmed_subscriber - blocked_subscriber description: Filter subscribers by a specific subscriber type - name: filters in: query required: false schema: type: array items: type: string description: Array of filters to apply (combined with AND logic). If provided, overrides the single filter parameter. - name: use_new_helper in: query required: false schema: type: boolean default: false description: Use the new helper to get subscribers - name: no_cache in: query required: false schema: type: boolean default: false description: Do not use the cache - name: include in: query required: false schema: type: array default: [] items: type: string description: An array of additional fields to include /wpcom/v2/sites/{wpcom_site}/subscribers/add: post: operationId: postWpcomV2SitesbyWpcomSiteSubscribersAdd summary: POST /wpcom/v2/sites/{wpcom_site}/subscribers/add tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: emails: type: array items: type: string required: - emails /wpcom/v2/sites/{wpcom_site}/subscribers/comp: post: operationId: postWpcomV2SitesbyWpcomSiteSubscribersComp summary: POST /wpcom/v2/sites/{wpcom_site}/subscribers/comp tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: user_id: type: integer plan_id: type: integer no_expiration: type: boolean default: false required: - user_id - plan_id /wpcom/v2/sites/{wpcom_site}/subscribers/count: get: operationId: getWpcomV2SitesbyWpcomSiteSubscribersCount summary: GET /wpcom/v2/sites/{wpcom_site}/subscribers/count tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/subscribers/counts: get: operationId: getWpcomV2SitesbyWpcomSiteSubscribersCounts summary: GET /wpcom/v2/sites/{wpcom_site}/subscribers/counts tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: subscription_status in: query required: false schema: type: string enum: - all - active - inactive - pending default: active description: Filter subscriptions based on status - name: subscriber_status in: query required: false schema: type: string enum: - all - active - blocked default: all description: Filter subscribers based on status /wpcom/v2/sites/{wpcom_site}/subscribers/import: get: operationId: getWpcomV2SitesbyWpcomSiteSubscribersImport summary: GET /wpcom/v2/sites/{wpcom_site}/subscribers/import tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteSubscribersImport summary: POST /wpcom/v2/sites/{wpcom_site}/subscribers/import tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: emails: type: array items: {} description: A list of emails to add as subscribers to the current site. categories: type: array items: {} description: A list of category IDs the emails should be subscribed to. parse_only: type: boolean default: false description: If true, the import will only parse the file and return the number of subscribers that would be imported. /wpcom/v2/sites/{wpcom_site}/subscribers/import/reset-state: post: operationId: postWpcomV2SitesbyWpcomSiteSubscribersImportResetState summary: POST /wpcom/v2/sites/{wpcom_site}/subscribers/import/reset-state tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/subscribers/import/reset_state: post: operationId: postWpcomV2SitesbyWpcomSiteSubscribersImportResetState2 summary: POST /wpcom/v2/sites/{wpcom_site}/subscribers/import/reset_state tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/subscribers/import/{id}: get: operationId: getWpcomV2SitesbyWpcomSiteSubscribersImportbyId summary: GET /wpcom/v2/sites/{wpcom_site}/subscribers/import/{id} tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 /wpcom/v2/sites/{wpcom_site}/subscribers/individual: get: operationId: getWpcomV2SitesbyWpcomSiteSubscribersIndividual summary: GET /wpcom/v2/sites/{wpcom_site}/subscribers/individual tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: subscription_id in: query required: false schema: type: integer default: 0 - name: user_id in: query required: false schema: type: integer default: 0 /wpcom/v2/sites/{wpcom_site}/subscribers/individual-stats: get: operationId: getWpcomV2SitesbyWpcomSiteSubscribersIndividualStats summary: GET /wpcom/v2/sites/{wpcom_site}/subscribers/individual-stats tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: subscription_id in: query required: false schema: type: integer default: 0 - name: user_id in: query required: false schema: type: integer default: 0 /wpcom/v2/sites/{wpcom_site}/subscribers/list: get: operationId: getWpcomV2SitesbyWpcomSiteSubscribersList summary: GET /wpcom/v2/sites/{wpcom_site}/subscribers/list tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: page in: query required: false schema: type: integer default: 1 - name: per_page in: query required: false schema: type: integer default: 10 - name: sort in: query required: false schema: type: string enum: - date_subscribed - name - plan - subscription_status default: date_subscribed - name: sort_order in: query required: false schema: type: string enum: - asc - desc default: desc - name: search in: query required: false schema: type: string default: '' - name: filters in: query required: false schema: type: array default: - all items: type: string - name: use_new_helper in: query required: false schema: type: boolean default: true /wpcom/v2/sites/{wpcom_site}/subscribers/products: get: operationId: getWpcomV2SitesbyWpcomSiteSubscribersProducts summary: GET /wpcom/v2/sites/{wpcom_site}/subscribers/products tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/subscribers/remove: post: operationId: postWpcomV2SitesbyWpcomSiteSubscribersRemove summary: POST /wpcom/v2/sites/{wpcom_site}/subscribers/remove tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: user_id: type: integer default: 0 email_subscription_id: type: integer default: 0 paid_subscription_ids: type: array default: [] items: type: string /wpcom/v2/sites/{wpcom_site}/subscribers/remove-comp: post: operationId: postWpcomV2SitesbyWpcomSiteSubscribersRemoveComp summary: POST /wpcom/v2/sites/{wpcom_site}/subscribers/remove-comp tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: comp_id: type: integer required: - comp_id /wpcom/v2/sites/{wpcom_site}/subscribers/stats: get: operationId: getWpcomV2SitesbyWpcomSiteSubscribersStats summary: GET /wpcom/v2/sites/{wpcom_site}/subscribers/stats tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: subscription_id in: query required: false schema: type: integer default: 0 - name: user_id in: query required: false schema: type: integer default: 0 /wpcom/v2/sites/{wpcom_site}/subscribers/totals: get: operationId: getWpcomV2SitesbyWpcomSiteSubscribersTotals summary: GET /wpcom/v2/sites/{wpcom_site}/subscribers/totals tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/subscribers_by_user_type: get: operationId: getWpcomV2SitesbyWpcomSiteSubscribersByUserType summary: GET /wpcom/v2/sites/{wpcom_site}/subscribers_by_user_type tags: - subscribers_by_user_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: page in: query required: false schema: type: integer default: 1 description: The current page. - name: per_page in: query required: false schema: type: integer default: 100 description: The amount of items to show per page. - name: search in: query required: false schema: type: string description: Search for subscribers - name: sort in: query required: false schema: type: string enum: - date_subscribed - email - name - plan default: date_subscribed description: Sort subscribers by a specific field - name: sort_order in: query required: false schema: type: string enum: - asc - desc description: Sort order - name: user_type in: query required: false schema: type: string enum: - wpcom - email default: wpcom description: Filter subscribers by a specific subscriber type /wpcom/v2/sites/{wpcom_site}/supportforums/ticket: post: operationId: postWpcomV2SitesbyWpcomSiteSupportforumsTicket summary: POST /wpcom/v2/sites/{wpcom_site}/supportforums/ticket tags: - supportforums responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: topic_id: type: integer required: - topic_id /wpcom/v2/sites/{wpcom_site}/sync/updates: post: operationId: postWpcomV2SitesbyWpcomSiteSyncUpdates summary: POST /wpcom/v2/sites/{wpcom_site}/sync/updates tags: - sync responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: rooms: type: array items: type: object required: - rooms /wpcom/v2/sites/{wpcom_site}/template-loader/{template_type}: get: operationId: getWpcomV2SitesbyWpcomSiteTemplateLoaderbyTemplateType summary: GET /wpcom/v2/sites/{wpcom_site}/template-loader/{template_type} tags: - template-loader responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: template_type in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/theme-headstart: post: operationId: postWpcomV2SitesbyWpcomSiteThemeHeadstart summary: POST /wpcom/v2/sites/{wpcom_site}/theme-headstart tags: - theme-headstart responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/theme-setup: post: operationId: postWpcomV2SitesbyWpcomSiteThemeSetup summary: POST /wpcom/v2/sites/{wpcom_site}/theme-setup tags: - theme-setup responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/theme-support: get: operationId: getWpcomV2SitesbyWpcomSiteThemeSupport summary: GET /wpcom/v2/sites/{wpcom_site}/theme-support tags: - theme-support responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/themes/activation-history: get: operationId: getWpcomV2SitesbyWpcomSiteThemesActivationHistory summary: GET /wpcom/v2/sites/{wpcom_site}/themes/activation-history 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 /wpcom/v2/sites/{wpcom_site}/top-posts: get: operationId: getWpcomV2SitesbyWpcomSiteTopPosts summary: GET /wpcom/v2/sites/{wpcom_site}/top-posts tags: - top-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: period in: query required: true schema: type: string description: Timeframe for stats. /wpcom/v2/sites/{wpcom_site}/transfer: get: operationId: getWpcomV2SitesbyWpcomSiteTransfer summary: GET /wpcom/v2/sites/{wpcom_site}/transfer tags: - transfer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteTransfer summary: POST /wpcom/v2/sites/{wpcom_site}/transfer tags: - transfer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteTransfer summary: PUT /wpcom/v2/sites/{wpcom_site}/transfer tags: - transfer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteTransfer summary: PATCH /wpcom/v2/sites/{wpcom_site}/transfer tags: - transfer responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/transients/{name}: delete: operationId: deleteWpcomV2SitesbyWpcomSiteTransientsbyName summary: DELETE /wpcom/v2/sites/{wpcom_site}/transients/{name} tags: - transients responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 /wpcom/v2/sites/{wpcom_site}/typekit-fonts: post: operationId: postWpcomV2SitesbyWpcomSiteTypekitFonts summary: POST /wpcom/v2/sites/{wpcom_site}/typekit-fonts tags: - typekit-fonts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: domains: {} name: {} subset: {} families: {} required: - domains - name - subset - families /wpcom/v2/sites/{wpcom_site}/typekit-fonts/{domain}/previewkit: get: operationId: getWpcomV2SitesbyWpcomSiteTypekitFontsbyDomainPreviewkit summary: GET /wpcom/v2/sites/{wpcom_site}/typekit-fonts/{domain}/previewkit tags: - typekit-fonts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: domain in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/typekit-fonts/{fontId}/family: get: operationId: getWpcomV2SitesbyWpcomSiteTypekitFontsbyFontidFamily summary: GET /wpcom/v2/sites/{wpcom_site}/typekit-fonts/{fontId}/family tags: - typekit-fonts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: fontId in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/typekit-fonts/{kitId}: get: operationId: getWpcomV2SitesbyWpcomSiteTypekitFontsbyKitid summary: GET /wpcom/v2/sites/{wpcom_site}/typekit-fonts/{kitId} tags: - typekit-fonts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: kitId in: path required: true schema: type: string delete: operationId: deleteWpcomV2SitesbyWpcomSiteTypekitFontsbyKitid summary: DELETE /wpcom/v2/sites/{wpcom_site}/typekit-fonts/{kitId} tags: - typekit-fonts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: kitId in: path required: true schema: type: string post: operationId: postWpcomV2SitesbyWpcomSiteTypekitFontsbyKitid summary: POST /wpcom/v2/sites/{wpcom_site}/typekit-fonts/{kitId} tags: - typekit-fonts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: kitId in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: domains: {} name: {} subset: {} families: {} required: - domains - name - subset - families put: operationId: putWpcomV2SitesbyWpcomSiteTypekitFontsbyKitid summary: PUT /wpcom/v2/sites/{wpcom_site}/typekit-fonts/{kitId} tags: - typekit-fonts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: kitId in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: domains: {} name: {} subset: {} families: {} required: - domains - name - subset - families patch: operationId: patchWpcomV2SitesbyWpcomSiteTypekitFontsbyKitid summary: PATCH /wpcom/v2/sites/{wpcom_site}/typekit-fonts/{kitId} tags: - typekit-fonts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: kitId in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: domains: {} name: {} subset: {} families: {} required: - domains - name - subset - families /wpcom/v2/sites/{wpcom_site}/typekit-fonts/{kitId}/publish: post: operationId: postWpcomV2SitesbyWpcomSiteTypekitFontsbyKitidPublish summary: POST /wpcom/v2/sites/{wpcom_site}/typekit-fonts/{kitId}/publish tags: - typekit-fonts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: kitId in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteTypekitFontsbyKitidPublish summary: PUT /wpcom/v2/sites/{wpcom_site}/typekit-fonts/{kitId}/publish tags: - typekit-fonts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: kitId in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteTypekitFontsbyKitidPublish summary: PATCH /wpcom/v2/sites/{wpcom_site}/typekit-fonts/{kitId}/publish tags: - typekit-fonts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: kitId in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/carts: post: operationId: postWpcomV2SitesbyWpcomSiteUcpProxyV1Carts summary: POST /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/carts tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/carts/{id}: get: operationId: getWpcomV2SitesbyWpcomSiteUcpProxyV1CartsbyId summary: GET /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/carts/{id} tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: postWpcomV2SitesbyWpcomSiteUcpProxyV1CartsbyId summary: POST /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/carts/{id} tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 put: operationId: putWpcomV2SitesbyWpcomSiteUcpProxyV1CartsbyId summary: PUT /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/carts/{id} tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 patch: operationId: patchWpcomV2SitesbyWpcomSiteUcpProxyV1CartsbyId summary: PATCH /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/carts/{id} tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/carts/{id}/cancel: post: operationId: postWpcomV2SitesbyWpcomSiteUcpProxyV1CartsbyIdCancel summary: POST /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/carts/{id}/cancel tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/catalog/lookup: post: operationId: postWpcomV2SitesbyWpcomSiteUcpProxyV1CatalogLookup summary: POST /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/catalog/lookup tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/catalog/product: post: operationId: postWpcomV2SitesbyWpcomSiteUcpProxyV1CatalogProduct summary: POST /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/catalog/product tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/catalog/search: post: operationId: postWpcomV2SitesbyWpcomSiteUcpProxyV1CatalogSearch summary: POST /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/catalog/search tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/checkout-sessions: post: operationId: postWpcomV2SitesbyWpcomSiteUcpProxyV1CheckoutSessions summary: POST /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/checkout-sessions tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/checkout-sessions/{id}: get: operationId: getWpcomV2SitesbyWpcomSiteUcpProxyV1CheckoutSessionsbyId summary: GET /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/checkout-sessions/{id} tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: postWpcomV2SitesbyWpcomSiteUcpProxyV1CheckoutSessionsbyId summary: POST /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/checkout-sessions/{id} tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 put: operationId: putWpcomV2SitesbyWpcomSiteUcpProxyV1CheckoutSessionsbyId summary: PUT /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/checkout-sessions/{id} tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 patch: operationId: patchWpcomV2SitesbyWpcomSiteUcpProxyV1CheckoutSessionsbyId summary: PATCH /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/checkout-sessions/{id} tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/checkout-sessions/{id}/cancel: post: operationId: postWpcomV2SitesbyWpcomSiteUcpProxyV1CheckoutSessionsbyIdCancel summary: POST /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/checkout-sessions/{id}/cancel tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/checkout-sessions/{id}/complete: post: operationId: postWpcomV2SitesbyWpcomSiteUcpProxyV1CheckoutSessionsbyIdComplete summary: POST /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/checkout-sessions/{id}/complete tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/webhooks/order: post: operationId: postWpcomV2SitesbyWpcomSiteUcpProxyV1WebhooksOrder summary: POST /wpcom/v2/sites/{wpcom_site}/ucp/proxy/v1/webhooks/order tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/ucp/v1/checkout-sessions: post: operationId: postWpcomV2SitesbyWpcomSiteUcpV1CheckoutSessions summary: POST /wpcom/v2/sites/{wpcom_site}/ucp/v1/checkout-sessions tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/ucp/v1/checkout-sessions/{id}: get: operationId: getWpcomV2SitesbyWpcomSiteUcpV1CheckoutSessionsbyId summary: GET /wpcom/v2/sites/{wpcom_site}/ucp/v1/checkout-sessions/{id} tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: postWpcomV2SitesbyWpcomSiteUcpV1CheckoutSessionsbyId summary: POST /wpcom/v2/sites/{wpcom_site}/ucp/v1/checkout-sessions/{id} tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 put: operationId: putWpcomV2SitesbyWpcomSiteUcpV1CheckoutSessionsbyId summary: PUT /wpcom/v2/sites/{wpcom_site}/ucp/v1/checkout-sessions/{id} tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 patch: operationId: patchWpcomV2SitesbyWpcomSiteUcpV1CheckoutSessionsbyId summary: PATCH /wpcom/v2/sites/{wpcom_site}/ucp/v1/checkout-sessions/{id} tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 /wpcom/v2/sites/{wpcom_site}/ucp/v1/checkout-sessions/{id}/cancel: post: operationId: postWpcomV2SitesbyWpcomSiteUcpV1CheckoutSessionsbyIdCancel summary: POST /wpcom/v2/sites/{wpcom_site}/ucp/v1/checkout-sessions/{id}/cancel tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 /wpcom/v2/sites/{wpcom_site}/ucp/v1/checkout-sessions/{id}/complete: post: operationId: postWpcomV2SitesbyWpcomSiteUcpV1CheckoutSessionsbyIdComplete summary: POST /wpcom/v2/sites/{wpcom_site}/ucp/v1/checkout-sessions/{id}/complete tags: - ucp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 /wpcom/v2/sites/{wpcom_site}/unauth-file-upload: post: operationId: postWpcomV2SitesbyWpcomSiteUnauthFileUpload summary: POST /wpcom/v2/sites/{wpcom_site}/unauth-file-upload tags: - unauth-file-upload responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: token: type: string required: - token /wpcom/v2/sites/{wpcom_site}/unauth-file-upload/remove: post: operationId: postWpcomV2SitesbyWpcomSiteUnauthFileUploadRemove summary: POST /wpcom/v2/sites/{wpcom_site}/unauth-file-upload/remove tags: - unauth-file-upload responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: token: type: string description: The temporary upload JWT token. file_id: type: number required: - token - file_id /wpcom/v2/sites/{wpcom_site}/unauth-file-upload/token: post: operationId: postWpcomV2SitesbyWpcomSiteUnauthFileUploadToken summary: POST /wpcom/v2/sites/{wpcom_site}/unauth-file-upload/token tags: - unauth-file-upload responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: context: type: string description: The context for which the upload token is being generated. claims: type: object description: Additional claims to include in the token. required: - context /wpcom/v2/sites/{wpcom_site}/unauth-file-upload/{file_id}: get: operationId: getWpcomV2SitesbyWpcomSiteUnauthFileUploadbyFileId summary: GET /wpcom/v2/sites/{wpcom_site}/unauth-file-upload/{file_id} tags: - unauth-file-upload responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: file_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/update-schedules: get: operationId: getWpcomV2SitesbyWpcomSiteUpdateSchedules summary: GET /wpcom/v2/sites/{wpcom_site}/update-schedules tags: - update-schedules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteUpdateSchedules summary: POST /wpcom/v2/sites/{wpcom_site}/update-schedules tags: - update-schedules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: plugins: type: array items: type: string description: List of plugin slugs to update. themes: type: array items: {} description: List of theme slugs to update. schedule: type: object description: Update schedule. required: - plugins - schedule /wpcom/v2/sites/{wpcom_site}/update-schedules/capabilities: get: operationId: getWpcomV2SitesbyWpcomSiteUpdateSchedulesCapabilities summary: GET /wpcom/v2/sites/{wpcom_site}/update-schedules/capabilities tags: - update-schedules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/update-schedules/{schedule_id}: get: operationId: getWpcomV2SitesbyWpcomSiteUpdateSchedulesbyScheduleId summary: GET /wpcom/v2/sites/{wpcom_site}/update-schedules/{schedule_id} tags: - update-schedules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: schedule_id in: path required: true schema: type: string post: operationId: postWpcomV2SitesbyWpcomSiteUpdateSchedulesbyScheduleId summary: POST /wpcom/v2/sites/{wpcom_site}/update-schedules/{schedule_id} tags: - update-schedules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: schedule_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: plugins: type: array items: type: string description: List of plugin slugs to update. themes: type: array items: {} description: List of theme slugs to update. schedule: type: object description: Update schedule. put: operationId: putWpcomV2SitesbyWpcomSiteUpdateSchedulesbyScheduleId summary: PUT /wpcom/v2/sites/{wpcom_site}/update-schedules/{schedule_id} tags: - update-schedules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: schedule_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: plugins: type: array items: type: string description: List of plugin slugs to update. themes: type: array items: {} description: List of theme slugs to update. schedule: type: object description: Update schedule. patch: operationId: patchWpcomV2SitesbyWpcomSiteUpdateSchedulesbyScheduleId summary: PATCH /wpcom/v2/sites/{wpcom_site}/update-schedules/{schedule_id} tags: - update-schedules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: schedule_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: plugins: type: array items: type: string description: List of plugin slugs to update. themes: type: array items: {} description: List of theme slugs to update. schedule: type: object description: Update schedule. delete: operationId: deleteWpcomV2SitesbyWpcomSiteUpdateSchedulesbyScheduleId summary: DELETE /wpcom/v2/sites/{wpcom_site}/update-schedules/{schedule_id} tags: - update-schedules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: schedule_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/update-schedules/{schedule_id}/active: post: operationId: postWpcomV2SitesbyWpcomSiteUpdateSchedulesbyScheduleIdActive summary: POST /wpcom/v2/sites/{wpcom_site}/update-schedules/{schedule_id}/active tags: - update-schedules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: schedule_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: active: type: boolean description: Whether the schedule is active. required: - active put: operationId: putWpcomV2SitesbyWpcomSiteUpdateSchedulesbyScheduleIdActive summary: PUT /wpcom/v2/sites/{wpcom_site}/update-schedules/{schedule_id}/active tags: - update-schedules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: schedule_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: active: type: boolean description: Whether the schedule is active. required: - active patch: operationId: patchWpcomV2SitesbyWpcomSiteUpdateSchedulesbyScheduleIdActive summary: PATCH /wpcom/v2/sites/{wpcom_site}/update-schedules/{schedule_id}/active tags: - update-schedules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: schedule_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: active: type: boolean description: Whether the schedule is active. required: - active /wpcom/v2/sites/{wpcom_site}/update-schedules/{schedule_id}/logs: post: operationId: postWpcomV2SitesbyWpcomSiteUpdateSchedulesbyScheduleIdLogs summary: POST /wpcom/v2/sites/{wpcom_site}/update-schedules/{schedule_id}/logs tags: - update-schedules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: schedule_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: action: type: string enum: &id010 - PLUGIN_UPDATES_START - PLUGIN_UPDATES_SUCCESS - PLUGIN_UPDATES_FAILURE - PLUGIN_UPDATE_SUCCESS - PLUGIN_UPDATE_FAILURE - PLUGIN_SITE_HEALTH_CHECK_SUCCESS - PLUGIN_SITE_HEALTH_CHECK_FAILURE - PLUGIN_UPDATE_FAILURE_AND_ROLLBACK - PLUGIN_UPDATE_FAILURE_AND_ROLLBACK_FAIL description: The action to be logged message: type: string description: The message to be logged context: type: object description: The context to be logged required: - action put: operationId: putWpcomV2SitesbyWpcomSiteUpdateSchedulesbyScheduleIdLogs summary: PUT /wpcom/v2/sites/{wpcom_site}/update-schedules/{schedule_id}/logs tags: - update-schedules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: schedule_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: action: type: string enum: *id010 description: The action to be logged message: type: string description: The message to be logged context: type: object description: The context to be logged required: - action patch: operationId: patchWpcomV2SitesbyWpcomSiteUpdateSchedulesbyScheduleIdLogs summary: PATCH /wpcom/v2/sites/{wpcom_site}/update-schedules/{schedule_id}/logs tags: - update-schedules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: schedule_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: action: type: string enum: *id010 description: The action to be logged message: type: string description: The message to be logged context: type: object description: The context to be logged required: - action get: operationId: getWpcomV2SitesbyWpcomSiteUpdateSchedulesbyScheduleIdLogs summary: GET /wpcom/v2/sites/{wpcom_site}/update-schedules/{schedule_id}/logs tags: - update-schedules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: schedule_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/user-type: post: operationId: postWpcomV2SitesbyWpcomSiteUserType summary: POST /wpcom/v2/sites/{wpcom_site}/user-type tags: - user-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: site_user_type: type: string required: - site_user_type put: operationId: putWpcomV2SitesbyWpcomSiteUserType summary: PUT /wpcom/v2/sites/{wpcom_site}/user-type tags: - user-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: site_user_type: type: string required: - site_user_type patch: operationId: patchWpcomV2SitesbyWpcomSiteUserType summary: PATCH /wpcom/v2/sites/{wpcom_site}/user-type tags: - user-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: site_user_type: type: string required: - site_user_type /wpcom/v2/sites/{wpcom_site}/videopress/caption-tracks: get: operationId: getWpcomV2SitesbyWpcomSiteVideopressCaptionTracks summary: GET /wpcom/v2/sites/{wpcom_site}/videopress/caption-tracks tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: guid in: query required: true schema: type: string description: VideoPress GUID. post: operationId: postWpcomV2SitesbyWpcomSiteVideopressCaptionTracks summary: POST /wpcom/v2/sites/{wpcom_site}/videopress/caption-tracks tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: guid: type: string description: VideoPress GUID. title: type: string description: Caption track title. content: type: string description: Serialized caption-cue block content. status: type: string enum: - draft - publish description: Caption track status. meta: type: object description: Caption track metadata. required: - meta /wpcom/v2/sites/{wpcom_site}/videopress/caption-tracks/{id}: post: operationId: postWpcomV2SitesbyWpcomSiteVideopressCaptionTracksbyId summary: POST /wpcom/v2/sites/{wpcom_site}/videopress/caption-tracks/{id} tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: guid: type: string description: VideoPress GUID. title: type: string description: Caption track title. content: type: string description: Serialized caption-cue block content. status: type: string enum: &id011 - draft - publish description: Caption track status. meta: type: object description: Caption track metadata. required: - meta put: operationId: putWpcomV2SitesbyWpcomSiteVideopressCaptionTracksbyId summary: PUT /wpcom/v2/sites/{wpcom_site}/videopress/caption-tracks/{id} tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: guid: type: string description: VideoPress GUID. title: type: string description: Caption track title. content: type: string description: Serialized caption-cue block content. status: type: string enum: *id011 description: Caption track status. meta: type: object description: Caption track metadata. required: - meta patch: operationId: patchWpcomV2SitesbyWpcomSiteVideopressCaptionTracksbyId summary: PATCH /wpcom/v2/sites/{wpcom_site}/videopress/caption-tracks/{id} tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: guid: type: string description: VideoPress GUID. title: type: string description: Caption track title. content: type: string description: Serialized caption-cue block content. status: type: string enum: *id011 description: Caption track status. meta: type: object description: Caption track metadata. required: - meta delete: operationId: deleteWpcomV2SitesbyWpcomSiteVideopressCaptionTracksbyId summary: DELETE /wpcom/v2/sites/{wpcom_site}/videopress/caption-tracks/{id} tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 /wpcom/v2/sites/{wpcom_site}/videopress/meta: post: operationId: postWpcomV2SitesbyWpcomSiteVideopressMeta summary: POST /wpcom/v2/sites/{wpcom_site}/videopress/meta tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: integer description: The post id for the attachment. title: type: string description: The title of the video. description: type: string description: The description of the video. caption: type: string description: The caption of the video. rating: type: string description: The video content rating. One of G, PG-13 or R-17 display_embed: type: boolean description: Display the share menu in the player. allow_download: type: boolean description: Display download option and allow viewers to download this video privacy_setting: type: integer enum: &id012 - 0 - 1 - 2 description: How to determine if the video should be public or private required: - id put: operationId: putWpcomV2SitesbyWpcomSiteVideopressMeta summary: PUT /wpcom/v2/sites/{wpcom_site}/videopress/meta tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: integer description: The post id for the attachment. title: type: string description: The title of the video. description: type: string description: The description of the video. caption: type: string description: The caption of the video. rating: type: string description: The video content rating. One of G, PG-13 or R-17 display_embed: type: boolean description: Display the share menu in the player. allow_download: type: boolean description: Display download option and allow viewers to download this video privacy_setting: type: integer enum: *id012 description: How to determine if the video should be public or private required: - id patch: operationId: patchWpcomV2SitesbyWpcomSiteVideopressMeta summary: PATCH /wpcom/v2/sites/{wpcom_site}/videopress/meta tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: integer description: The post id for the attachment. title: type: string description: The title of the video. description: type: string description: The description of the video. caption: type: string description: The caption of the video. rating: type: string description: The video content rating. One of G, PG-13 or R-17 display_embed: type: boolean description: Display the share menu in the player. allow_download: type: boolean description: Display download option and allow viewers to download this video privacy_setting: type: integer enum: *id012 description: How to determine if the video should be public or private required: - id /wpcom/v2/sites/{wpcom_site}/videopress/playback-jwt/{video_guid}: post: operationId: postWpcomV2SitesbyWpcomSiteVideopressPlaybackJwtbyVideoGuid summary: POST /wpcom/v2/sites/{wpcom_site}/videopress/playback-jwt/{video_guid} tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: video_guid in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteVideopressPlaybackJwtbyVideoGuid summary: PUT /wpcom/v2/sites/{wpcom_site}/videopress/playback-jwt/{video_guid} tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: video_guid in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteVideopressPlaybackJwtbyVideoGuid summary: PATCH /wpcom/v2/sites/{wpcom_site}/videopress/playback-jwt/{video_guid} tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: video_guid in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/videopress/promote/{attachment_id}: post: operationId: postWpcomV2SitesbyWpcomSiteVideopressPromotebyAttachmentId summary: POST /wpcom/v2/sites/{wpcom_site}/videopress/promote/{attachment_id} tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: attachment_id in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteVideopressPromotebyAttachmentId summary: PUT /wpcom/v2/sites/{wpcom_site}/videopress/promote/{attachment_id} tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: attachment_id in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteVideopressPromotebyAttachmentId summary: PATCH /wpcom/v2/sites/{wpcom_site}/videopress/promote/{attachment_id} tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: attachment_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/videopress/settings: get: operationId: getWpcomV2SitesbyWpcomSiteVideopressSettings summary: GET /wpcom/v2/sites/{wpcom_site}/videopress/settings tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteVideopressSettings summary: POST /wpcom/v2/sites/{wpcom_site}/videopress/settings tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: videopress_videos_private_for_site: type: boolean description: If the VideoPress videos should be private by default videopress_auto_subtitles_disabled: type: boolean description: If auto-generated subtitles should be skipped for new videos put: operationId: putWpcomV2SitesbyWpcomSiteVideopressSettings summary: PUT /wpcom/v2/sites/{wpcom_site}/videopress/settings tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: videopress_videos_private_for_site: type: boolean description: If the VideoPress videos should be private by default videopress_auto_subtitles_disabled: type: boolean description: If auto-generated subtitles should be skipped for new videos patch: operationId: patchWpcomV2SitesbyWpcomSiteVideopressSettings summary: PATCH /wpcom/v2/sites/{wpcom_site}/videopress/settings tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: videopress_videos_private_for_site: type: boolean description: If the VideoPress videos should be private by default videopress_auto_subtitles_disabled: type: boolean description: If auto-generated subtitles should be skipped for new videos /wpcom/v2/sites/{wpcom_site}/videopress/upload-jwt: post: operationId: postWpcomV2SitesbyWpcomSiteVideopressUploadJwt summary: POST /wpcom/v2/sites/{wpcom_site}/videopress/upload-jwt tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteVideopressUploadJwt summary: PUT /wpcom/v2/sites/{wpcom_site}/videopress/upload-jwt tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteVideopressUploadJwt summary: PATCH /wpcom/v2/sites/{wpcom_site}/videopress/upload-jwt tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/videopress/{video_guid}/check-ownership/{post_id}: get: operationId: getWpcomV2SitesbyWpcomSiteVideopressbyVideoGuidCheckOwnershipbyPostId summary: GET /wpcom/v2/sites/{wpcom_site}/videopress/{video_guid}/check-ownership/{post_id} tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: video_guid in: path required: true schema: type: string - name: post_id in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/videopress/{video_guid}/poster: get: operationId: getWpcomV2SitesbyWpcomSiteVideopressbyVideoGuidPoster summary: GET /wpcom/v2/sites/{wpcom_site}/videopress/{video_guid}/poster tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: video_guid in: path required: true schema: type: string post: operationId: postWpcomV2SitesbyWpcomSiteVideopressbyVideoGuidPoster summary: POST /wpcom/v2/sites/{wpcom_site}/videopress/{video_guid}/poster tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: video_guid in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: at_time: type: integer description: The time in the video to use as the poster frame. is_millisec: type: boolean description: Whether the time is in milliseconds or seconds. poster_attachment_id: type: integer description: The attachment id of the poster image. put: operationId: putWpcomV2SitesbyWpcomSiteVideopressbyVideoGuidPoster summary: PUT /wpcom/v2/sites/{wpcom_site}/videopress/{video_guid}/poster tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: video_guid in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: at_time: type: integer description: The time in the video to use as the poster frame. is_millisec: type: boolean description: Whether the time is in milliseconds or seconds. poster_attachment_id: type: integer description: The attachment id of the poster image. patch: operationId: patchWpcomV2SitesbyWpcomSiteVideopressbyVideoGuidPoster summary: PATCH /wpcom/v2/sites/{wpcom_site}/videopress/{video_guid}/poster tags: - videopress responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: video_guid in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: at_time: type: integer description: The time in the video to use as the poster frame. is_millisec: type: boolean description: Whether the time is in milliseconds or seconds. poster_attachment_id: type: integer description: The attachment id of the poster image. /wpcom/v2/sites/{wpcom_site}/vouchers: get: operationId: getWpcomV2SitesbyWpcomSiteVouchers summary: GET /wpcom/v2/sites/{wpcom_site}/vouchers tags: - vouchers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/vouchers/{type}: get: operationId: getWpcomV2SitesbyWpcomSiteVouchersbyType summary: GET /wpcom/v2/sites/{wpcom_site}/vouchers/{type} tags: - vouchers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 /wpcom/v2/sites/{wpcom_site}/vouchers/{type}/assign: post: operationId: postWpcomV2SitesbyWpcomSiteVouchersbyTypeAssign summary: POST /wpcom/v2/sites/{wpcom_site}/vouchers/{type}/assign tags: - vouchers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 put: operationId: putWpcomV2SitesbyWpcomSiteVouchersbyTypeAssign summary: PUT /wpcom/v2/sites/{wpcom_site}/vouchers/{type}/assign tags: - vouchers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 patch: operationId: patchWpcomV2SitesbyWpcomSiteVouchersbyTypeAssign summary: PATCH /wpcom/v2/sites/{wpcom_site}/vouchers/{type}/assign tags: - vouchers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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 /wpcom/v2/sites/{wpcom_site}/waf-rules: get: operationId: getWpcomV2SitesbyWpcomSiteWafRules summary: GET /wpcom/v2/sites/{wpcom_site}/waf-rules tags: - waf-rules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/meta/connection/connect: get: operationId: getWpcomV2SitesbyWpcomSiteWcMetaConnectionConnect summary: GET /wpcom/v2/sites/{wpcom_site}/wc/meta/connection/connect tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: return_url in: query required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/meta/connection/disconnect: get: operationId: getWpcomV2SitesbyWpcomSiteWcMetaConnectionDisconnect summary: GET /wpcom/v2/sites/{wpcom_site}/wc/meta/connection/disconnect tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/meta/connection/status: get: operationId: getWpcomV2SitesbyWpcomSiteWcMetaConnectionStatus summary: GET /wpcom/v2/sites/{wpcom_site}/wc/meta/connection/status tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/meta/products-{products_token}.csv: get: operationId: getWpcomV2SitesbyWpcomSiteWcMetaProductsProductsTokenCsv summary: GET /wpcom/v2/sites/{wpcom_site}/wc/meta/products-{products_token}.csv tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: products_token in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/meta/{service}/{path}: get: operationId: getWpcomV2SitesbyWpcomSiteWcMetabyServicebyPath summary: GET /wpcom/v2/sites/{wpcom_site}/wc/meta/{service}/{path} tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: service in: path required: true schema: type: string - name: path in: path required: true schema: type: string post: operationId: postWpcomV2SitesbyWpcomSiteWcMetabyServicebyPath summary: POST /wpcom/v2/sites/{wpcom_site}/wc/meta/{service}/{path} tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: service in: path required: true schema: type: string - name: path in: path required: true schema: type: string delete: operationId: deleteWpcomV2SitesbyWpcomSiteWcMetabyServicebyPath summary: DELETE /wpcom/v2/sites/{wpcom_site}/wc/meta/{service}/{path} tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: service in: path required: true schema: type: string - name: path in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/partners/{partner}/remote-site-status: get: operationId: getWpcomV2SitesbyWpcomSiteWcPartnersbyPartnerRemoteSiteStatus summary: GET /wpcom/v2/sites/{wpcom_site}/wc/partners/{partner}/remote-site-status tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: partner in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/partners/{partner}/revoke-token: delete: operationId: deleteWpcomV2SitesbyWpcomSiteWcPartnersbyPartnerRevokeToken summary: DELETE /wpcom/v2/sites/{wpcom_site}/wc/partners/{partner}/revoke-token tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: partner in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/reddit/connection/connect: get: operationId: getWpcomV2SitesbyWpcomSiteWcRedditConnectionConnect summary: GET /wpcom/v2/sites/{wpcom_site}/wc/reddit/connection/connect tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: return_url in: query required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/reddit/connection/disconnect: get: operationId: getWpcomV2SitesbyWpcomSiteWcRedditConnectionDisconnect summary: GET /wpcom/v2/sites/{wpcom_site}/wc/reddit/connection/disconnect tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/reddit/connection/status: get: operationId: getWpcomV2SitesbyWpcomSiteWcRedditConnectionStatus summary: GET /wpcom/v2/sites/{wpcom_site}/wc/reddit/connection/status tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/reddit/products-{products_token}.csv: get: operationId: getWpcomV2SitesbyWpcomSiteWcRedditProductsProductsTokenCsv summary: GET /wpcom/v2/sites/{wpcom_site}/wc/reddit/products-{products_token}.csv tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: products_token in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/reddit/{service}/{path}: get: operationId: getWpcomV2SitesbyWpcomSiteWcRedditbyServicebyPath summary: GET /wpcom/v2/sites/{wpcom_site}/wc/reddit/{service}/{path} tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: service in: path required: true schema: type: string - name: path in: path required: true schema: type: string post: operationId: postWpcomV2SitesbyWpcomSiteWcRedditbyServicebyPath summary: POST /wpcom/v2/sites/{wpcom_site}/wc/reddit/{service}/{path} tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: service in: path required: true schema: type: string - name: path in: path required: true schema: type: string put: operationId: putWpcomV2SitesbyWpcomSiteWcRedditbyServicebyPath summary: PUT /wpcom/v2/sites/{wpcom_site}/wc/reddit/{service}/{path} tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: service in: path required: true schema: type: string - name: path in: path required: true schema: type: string patch: operationId: patchWpcomV2SitesbyWpcomSiteWcRedditbyServicebyPath summary: PATCH /wpcom/v2/sites/{wpcom_site}/wc/reddit/{service}/{path} tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: service in: path required: true schema: type: string - name: path in: path required: true schema: type: string delete: operationId: deleteWpcomV2SitesbyWpcomSiteWcRedditbyServicebyPath summary: DELETE /wpcom/v2/sites/{wpcom_site}/wc/reddit/{service}/{path} tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: service in: path required: true schema: type: string - name: path in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/snapchat/connection/connect: get: operationId: getWpcomV2SitesbyWpcomSiteWcSnapchatConnectionConnect summary: GET /wpcom/v2/sites/{wpcom_site}/wc/snapchat/connection/connect tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: return_url in: query required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/snapchat/connection/disconnect: get: operationId: getWpcomV2SitesbyWpcomSiteWcSnapchatConnectionDisconnect summary: GET /wpcom/v2/sites/{wpcom_site}/wc/snapchat/connection/disconnect tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/snapchat/connection/status: get: operationId: getWpcomV2SitesbyWpcomSiteWcSnapchatConnectionStatus summary: GET /wpcom/v2/sites/{wpcom_site}/wc/snapchat/connection/status tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/snapchat/products-{products_token}.csv: get: operationId: getWpcomV2SitesbyWpcomSiteWcSnapchatProductsProductsTokenCsv summary: GET /wpcom/v2/sites/{wpcom_site}/wc/snapchat/products-{products_token}.csv tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: products_token in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wc/snapchat/{service}/{path}: get: operationId: getWpcomV2SitesbyWpcomSiteWcSnapchatbyServicebyPath summary: GET /wpcom/v2/sites/{wpcom_site}/wc/snapchat/{service}/{path} tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: service in: path required: true schema: type: string - name: path in: path required: true schema: type: string post: operationId: postWpcomV2SitesbyWpcomSiteWcSnapchatbyServicebyPath summary: POST /wpcom/v2/sites/{wpcom_site}/wc/snapchat/{service}/{path} tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: service in: path required: true schema: type: string - name: path in: path required: true schema: type: string delete: operationId: deleteWpcomV2SitesbyWpcomSiteWcSnapchatbyServicebyPath summary: DELETE /wpcom/v2/sites/{wpcom_site}/wc/snapchat/{service}/{path} tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: service in: path required: true schema: type: string - name: path in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wcai-pa/overview: get: operationId: getWpcomV2SitesbyWpcomSiteWcaiPaOverview summary: GET /wpcom/v2/sites/{wpcom_site}/wcai-pa/overview tags: - wcai-pa responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wcai-pa/suggestions: get: operationId: getWpcomV2SitesbyWpcomSiteWcaiPaSuggestions summary: GET /wpcom/v2/sites/{wpcom_site}/wcai-pa/suggestions tags: - wcai-pa responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wcai-pa/suggestions-reviewed: get: operationId: getWpcomV2SitesbyWpcomSiteWcaiPaSuggestionsReviewed summary: GET /wpcom/v2/sites/{wpcom_site}/wcai-pa/suggestions-reviewed tags: - wcai-pa responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: count in: query required: false schema: type: integer default: 20 - name: offset in: query required: false schema: type: integer default: 0 /wpcom/v2/sites/{wpcom_site}/wcai-pa/suggestions/{id}: get: operationId: getWpcomV2SitesbyWpcomSiteWcaiPaSuggestionsbyId summary: GET /wpcom/v2/sites/{wpcom_site}/wcai-pa/suggestions/{id} tags: - wcai-pa responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: postWpcomV2SitesbyWpcomSiteWcaiPaSuggestionsbyId summary: POST /wpcom/v2/sites/{wpcom_site}/wcai-pa/suggestions/{id} tags: - wcai-pa responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '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: status: type: string enum: - approved - rejected - reverted approved_fields: type: array items: type: object required: - status /wpcom/v2/sites/{wpcom_site}/wcai-pa/tone-feel: get: operationId: getWpcomV2SitesbyWpcomSiteWcaiPaToneFeel summary: GET /wpcom/v2/sites/{wpcom_site}/wcai-pa/tone-feel tags: - wcai-pa responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteWcaiPaToneFeel summary: POST /wpcom/v2/sites/{wpcom_site}/wcai-pa/tone-feel tags: - wcai-pa responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: tone: type: object required: - tone /wpcom/v2/sites/{wpcom_site}/wcai-pa/tone-feel/analysis: post: operationId: postWpcomV2SitesbyWpcomSiteWcaiPaToneFeelAnalysis summary: POST /wpcom/v2/sites/{wpcom_site}/wcai-pa/tone-feel/analysis tags: - wcai-pa responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: sample_content: type: object required: - sample_content get: operationId: getWpcomV2SitesbyWpcomSiteWcaiPaToneFeelAnalysis summary: GET /wpcom/v2/sites/{wpcom_site}/wcai-pa/tone-feel/analysis tags: - wcai-pa responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/widget-modules: get: operationId: getWpcomV2SitesbyWpcomSiteWidgetModules summary: GET /wpcom/v2/sites/{wpcom_site}/widget-modules tags: - widget-modules responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/woocommerce/active-theme: get: operationId: getWpcomV2SitesbyWpcomSiteWoocommerceActiveTheme summary: GET /wpcom/v2/sites/{wpcom_site}/woocommerce/active-theme tags: - woocommerce responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/woocommerce/payment-methods: get: operationId: getWpcomV2SitesbyWpcomSiteWoocommercePaymentMethods summary: GET /wpcom/v2/sites/{wpcom_site}/woocommerce/payment-methods tags: - woocommerce responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/woocommerce/store-api/checkout: post: operationId: postWpcomV2SitesbyWpcomSiteWoocommerceStoreApiCheckout summary: POST /wpcom/v2/sites/{wpcom_site}/woocommerce/store-api/checkout tags: - woocommerce responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: payment_method_id: type: string description: Card id or other payment method id to pass on to Stripe / Woo. This corresponds to Stripe ID with the sources API https://stripe.com/docs/api/sources. payment_method: type: string description: Payment method associated with the payment_method_id. `stripe` or `bd-credit-card`. Defaults to `stripe` product_id: type: string description: Placeholder product_id representing subscription to a product. For now, use 27. first_name: type: string description: First name attached to the card. last_name: type: string description: Last name attached to the card. address_1: type: string description: First line of the billing address. address_2: type: string description: Second line of the billing address. company: type: string description: Company name of the billing address. city: type: string description: City name of the billing address. state: type: string description: State name of the billing address. postcode: type: string description: Postal code of the billing address. country: type: string description: Country name of the billing address. max_amount: type: string description: Amount to authorized against, in cents. This is not enforced yet. external_resource_id: type: string description: External resource id to create ad campaign for BlazePress. storefront: type: string description: Storefront running the checkout. required: - payment_method_id - product_id /wpcom/v2/sites/{wpcom_site}/wordads/site-info: get: operationId: getWpcomV2SitesbyWpcomSiteWordadsSiteInfo summary: GET /wpcom/v2/sites/{wpcom_site}/wordads/site-info tags: - wordads responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/wp-admin-sidebar/layout: get: operationId: getWpcomV2SitesbyWpcomSiteWpAdminSidebarLayout summary: GET /wpcom/v2/sites/{wpcom_site}/wp-admin-sidebar/layout tags: - wp-admin-sidebar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/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: postWpcomV2SitesbyWpcomSiteWpAdminSidebarLayout summary: POST /wpcom/v2/sites/{wpcom_site}/wp-admin-sidebar/layout tags: - wp-admin-sidebar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string /wpcom/v2/sites/{wpcom_site}/xposts: get: operationId: getWpcomV2SitesbyWpcomSiteXposts summary: GET /wpcom/v2/sites/{wpcom_site}/xposts tags: - xposts responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: wpcom_site in: path required: true schema: type: string - name: decode_html in: query required: false schema: type: boolean default: false /wpcom/v2/slack/webhook/issue-creator: post: operationId: postWpcomV2SlackWebhookIssueCreator summary: POST /wpcom/v2/slack/webhook/issue-creator tags: - slack responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' put: operationId: putWpcomV2SlackWebhookIssueCreator summary: PUT /wpcom/v2/slack/webhook/issue-creator tags: - slack responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' patch: operationId: patchWpcomV2SlackWebhookIssueCreator summary: PATCH /wpcom/v2/slack/webhook/issue-creator tags: - slack responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/starter-designs: get: operationId: getWpcomV2StarterDesigns summary: GET /wpcom/v2/starter-designs tags: - starter-designs responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: seed in: query required: false schema: type: string default: '' description: Seed for design randomization - name: goals in: query required: false schema: type: array items: type: string description: Seed for design randomization /wpcom/v2/starter-designs/{slug}: get: operationId: getWpcomV2StarterDesignsbySlug summary: GET /wpcom/v2/starter-designs/{slug} tags: - starter-designs responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: slug in: path required: true schema: type: string /wpcom/v2/studio-app/ai-assistant/chat: post: operationId: postWpcomV2StudioAppAiAssistantChat summary: POST /wpcom/v2/studio-app/ai-assistant/chat tags: - studio-app responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: messages: type: array items: {} description: The messages to send to the AI assistant. required: - messages /wpcom/v2/studio-app/ai-assistant/quota: get: operationId: getWpcomV2StudioAppAiAssistantQuota summary: GET /wpcom/v2/studio-app/ai-assistant/quota tags: - studio-app responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/studio-app/ai-assistant/welcome: get: operationId: getWpcomV2StudioAppAiAssistantWelcome summary: GET /wpcom/v2/studio-app/ai-assistant/welcome tags: - studio-app responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/studio-app/blueprints: get: operationId: getWpcomV2StudioAppBlueprints summary: GET /wpcom/v2/studio-app/blueprints tags: - studio-app responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: locale in: query required: false schema: type: string description: Locale code for translating titles and excerpts (e.g., fr, es, de) /wpcom/v2/studio-app/feature-flags: get: operationId: getWpcomV2StudioAppFeatureFlags summary: GET /wpcom/v2/studio-app/feature-flags tags: - studio-app responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/studio-app/install.ps1: get: operationId: getWpcomV2StudioAppInstallPs1 summary: GET /wpcom/v2/studio-app/install.ps1 tags: - studio-app responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/studio-app/install.sh: get: operationId: getWpcomV2StudioAppInstallSh summary: GET /wpcom/v2/studio-app/install.sh tags: - studio-app responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/studio-app/token: delete: operationId: deleteWpcomV2StudioAppToken summary: DELETE /wpcom/v2/studio-app/token tags: - studio-app responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/studio-app/updates: get: operationId: getWpcomV2StudioAppUpdates summary: GET /wpcom/v2/studio-app/updates tags: - studio-app responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: platform in: query required: true schema: type: string - name: arch in: query required: false schema: type: string - name: studioArch in: query required: false schema: type: string - name: version in: query required: true schema: type: string - name: channel in: query required: false schema: type: string enum: - nightly - name: product in: query required: false schema: type: string enum: - wordpress-com-studio - wordpress-com-studio-cli default: wordpress-com-studio /wpcom/v2/studio-app/updates/RELEASES: get: operationId: getWpcomV2StudioAppUpdatesReleases summary: GET /wpcom/v2/studio-app/updates/RELEASES tags: - studio-app responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: platform in: query required: true schema: type: string - name: arch in: query required: false schema: type: string - name: studioArch in: query required: false schema: type: string - name: version in: query required: true schema: type: string - name: channel in: query required: false schema: type: string enum: - nightly /wpcom/v2/subscribers/emails/resend/subscription-confirmation: post: operationId: postWpcomV2SubscribersEmailsResendSubscriptionConfirmation summary: POST /wpcom/v2/subscribers/emails/resend/subscription-confirmation tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: email_address: type: string format: email description: The email address used to subscribe to the blog post_id: type: string description: The post ID. Only available if the subscription was made using a subscription block in a post key: type: string description: The activation key of the original subscription confirmation email required: - email_address - key /wpcom/v2/subscribers/emails/resend/subscription-management: post: operationId: postWpcomV2SubscribersEmailsResendSubscriptionManagement summary: POST /wpcom/v2/subscribers/emails/resend/subscription-management tags: - subscribers responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: email_address: type: string format: email description: The email address used to request the manage link token: type: string description: Expired token used to check the validity of the email parameter required: - email_address - token /wpcom/v2/support-interactions: get: operationId: getWpcomV2SupportInteractions summary: GET /wpcom/v2/support-interactions tags: - support-interactions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: status in: query required: false schema: type: array default: [] items: type: string - name: is_test_mode in: query required: false schema: type: boolean default: false - name: page in: query required: false schema: type: integer default: 1 - name: per_page in: query required: false schema: type: integer default: 10 post: operationId: postWpcomV2SupportInteractions summary: POST /wpcom/v2/support-interactions tags: - support-interactions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: event_external_id: type: string is_test_mode: type: boolean default: false event_source: type: string enum: - help-center - odie - zendesk - zendesk_staging bot_slug: type: string event_metadata: type: string required: - event_external_id - event_source /wpcom/v2/support-interactions/{support_interaction_id}: get: operationId: getWpcomV2SupportInteractionsbySupportInteractionId summary: GET /wpcom/v2/support-interactions/{support_interaction_id} tags: - support-interactions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: support_interaction_id in: path required: true schema: type: string /wpcom/v2/support-interactions/{support_interaction_id}/events: post: operationId: postWpcomV2SupportInteractionsbySupportInteractionIdEvents summary: POST /wpcom/v2/support-interactions/{support_interaction_id}/events tags: - support-interactions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: support_interaction_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: event_external_id: type: string event_source: type: string enum: - help-center - odie - zendesk - zendesk_staging event_metadata: type: string is_test_mode: type: boolean default: false required: - event_external_id - event_source /wpcom/v2/support-interactions/{support_interaction_id}/status: post: operationId: postWpcomV2SupportInteractionsbySupportInteractionIdStatus summary: POST /wpcom/v2/support-interactions/{support_interaction_id}/status tags: - support-interactions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: support_interaction_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: status: type: string enum: &id013 - open - solved - closed required: - status put: operationId: putWpcomV2SupportInteractionsbySupportInteractionIdStatus summary: PUT /wpcom/v2/support-interactions/{support_interaction_id}/status tags: - support-interactions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: support_interaction_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: status: type: string enum: *id013 required: - status patch: operationId: patchWpcomV2SupportInteractionsbySupportInteractionIdStatus summary: PATCH /wpcom/v2/support-interactions/{support_interaction_id}/status tags: - support-interactions responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: support_interaction_id in: path required: true schema: type: string requestBody: content: application/json: schema: type: object properties: status: type: string enum: *id013 required: - status /wpcom/v2/tags/recommended: get: operationId: getWpcomV2TagsRecommended summary: GET /wpcom/v2/tags/recommended 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: url in: query required: true schema: type: string description: URL for the blog post. /wpcom/v2/telegram-bot/assistant-webhook/{assistant_bot}: post: operationId: postWpcomV2TelegramBotAssistantWebhookbyAssistantBot summary: POST /wpcom/v2/telegram-bot/assistant-webhook/{assistant_bot} tags: - telegram-bot responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: assistant_bot in: path required: true schema: type: string /wpcom/v2/telegram-bot/connect: post: operationId: postWpcomV2TelegramBotConnect summary: POST /wpcom/v2/telegram-bot/connect tags: - telegram-bot responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: id: type: integer auth_date: type: integer hash: type: string first_name: type: string last_name: type: string username: type: string photo_url: type: string required: - id - auth_date - hash /wpcom/v2/telegram-bot/connect-via-token: post: operationId: postWpcomV2TelegramBotConnectViaToken summary: POST /wpcom/v2/telegram-bot/connect-via-token tags: - telegram-bot responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: telegram_id: type: integer token: type: string ts: type: integer bot: type: string required: - telegram_id - token - ts /wpcom/v2/telegram-bot/disconnect: post: operationId: postWpcomV2TelegramBotDisconnect summary: POST /wpcom/v2/telegram-bot/disconnect tags: - telegram-bot responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/telegram-bot/local-agent-poll: get: operationId: getWpcomV2TelegramBotLocalAgentPoll summary: GET /wpcom/v2/telegram-bot/local-agent-poll tags: - telegram-bot responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/telegram-bot/local-agent-respond: post: operationId: postWpcomV2TelegramBotLocalAgentRespond summary: POST /wpcom/v2/telegram-bot/local-agent-respond tags: - telegram-bot responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: chat_id: type: integer text: type: string caption: type: string bot: type: string action: type: string enum: - create - edit - delete - chat_action default: create message_id: type: integer required: - chat_id - bot /wpcom/v2/telegram-bot/status: get: operationId: getWpcomV2TelegramBotStatus summary: GET /wpcom/v2/telegram-bot/status tags: - telegram-bot responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/telegram-bot/webhook/{bot}: post: operationId: postWpcomV2TelegramBotWebhookbyBot summary: POST /wpcom/v2/telegram-bot/webhook/{bot} tags: - telegram-bot responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: bot in: path required: true schema: type: string /wpcom/v2/test: get: operationId: getWpcomV2Test summary: GET /wpcom/v2/test tags: - test responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/text-completion: post: operationId: postWpcomV2TextCompletion summary: POST /wpcom/v2/text-completion tags: - text-completion responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: prompt: type: string description: A prompt to be completed by the completion service. messages: type: array items: {} description: The JSON-encoded list of messages to be completed by the completion service. token: type: string description: The JWT token to authenticate the request. feature: type: string description: A string identifier for your feature, used for logging purposes. temperature: type: number description: What sampling temperature to use, between 0 and 2. functions: type: array items: {} description: Schema for functions as specified in OpenAI docs. response_format: type: string enum: - json_object - text description: The format of the response. seed: type: number description: The seed to use for reproducible outputs, e.g. unit testing. model: type: string description: The model to use for completion. required: - token - feature /wpcom/v2/text-completion/stream: get: operationId: getWpcomV2TextCompletionStream summary: GET /wpcom/v2/text-completion/stream tags: - text-completion responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: prompt in: query required: false schema: type: string description: A prompt to be completed by the completion service. - name: messages in: query required: false schema: type: array items: {} description: The JSON-encoded list of messages to be completed by the completion service. - name: token in: query required: true schema: type: string description: The JWT token to authenticate the request. - name: feature in: query required: true schema: type: string description: A string identifier for your feature, used for logging purposes. - name: temperature in: query required: false schema: type: number description: What sampling temperature to use, between 0 and 2. - name: functions in: query required: false schema: type: array items: {} description: Schema for functions as specified in OpenAI docs. - name: response_format in: query required: false schema: type: string enum: - json_object - text description: The format of the response. - name: seed in: query required: false schema: type: number description: The seed to use for reproducible outputs, e.g. unit testing. - name: model in: query required: false schema: type: string description: The model to use for completion. /wpcom/v2/themes: get: operationId: getWpcomV2Themes summary: GET /wpcom/v2/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: page in: query required: false schema: type: integer - name: search in: query required: false schema: type: string /wpcom/v2/themes/readymade-templates: get: operationId: getWpcomV2ThemesReadymadeTemplates summary: GET /wpcom/v2/themes/readymade-templates 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' /wpcom/v2/themes/readymade-templates/{template_id}: get: operationId: getWpcomV2ThemesReadymadeTemplatesbyTemplateId summary: GET /wpcom/v2/themes/readymade-templates/{template_id} 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: template_id in: path required: true schema: type: string /wpcom/v2/themes/{theme}/premium-details: get: operationId: getWpcomV2ThemesbyThemePremiumDetails summary: GET /wpcom/v2/themes/{theme}/premium-details 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: theme in: path required: true schema: type: string /wpcom/v2/timezones: get: operationId: getWpcomV2Timezones summary: GET /wpcom/v2/timezones tags: - timezones responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/titan/redirect-info/{mode}: get: operationId: getWpcomV2TitanRedirectInfobyMode summary: GET /wpcom/v2/titan/redirect-info/{mode} tags: - titan responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: mode in: path required: true schema: type: string /wpcom/v2/tortuga/{host}: get: operationId: getWpcomV2TortugabyHost summary: GET /wpcom/v2/tortuga/{host} tags: - tortuga responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: host in: path required: true schema: type: string /wpcom/v2/traffic-guide-download: get: operationId: getWpcomV2TrafficGuideDownload summary: GET /wpcom/v2/traffic-guide-download tags: - traffic-guide-download responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/trelloCallback: get: operationId: getWpcomV2Trellocallback summary: GET /wpcom/v2/trelloCallback tags: - trelloCallback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2Trellocallback summary: POST /wpcom/v2/trelloCallback tags: - trelloCallback responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/trends-agent/ingest: post: operationId: postWpcomV2TrendsAgentIngest summary: POST /wpcom/v2/trends-agent/ingest tags: - trends-agent responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: force: type: boolean default: false description: Bypass the freshness cooldown and re-run ingest immediately. /wpcom/v2/trends-agent/run-stream: post: operationId: postWpcomV2TrendsAgentRunStream summary: POST /wpcom/v2/trends-agent/run-stream tags: - trends-agent responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: prompt: type: string prior_messages: type: array default: [] items: {} mode: type: string enum: - enrich - scan default: enrich strategy_cards: type: string description: Strategy agent output to enrich with external signals (used in enrich mode). model: type: string enum: - claude-sonnet-4-6 - claude-sonnet-4-5-20250929 - claude-opus-4-6 - claude-haiku-4-5-20251001 required: - prompt /wpcom/v2/trends-agent/signals: get: operationId: getWpcomV2TrendsAgentSignals summary: GET /wpcom/v2/trends-agent/signals tags: - trends-agent responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/tumblr-smtp/email-blocked/{email}: get: operationId: getWpcomV2TumblrSmtpEmailBlockedbyEmail summary: GET /wpcom/v2/tumblr-smtp/email-blocked/{email} tags: - tumblr-smtp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: email in: path required: true schema: type: string delete: operationId: deleteWpcomV2TumblrSmtpEmailBlockedbyEmail summary: DELETE /wpcom/v2/tumblr-smtp/email-blocked/{email} tags: - tumblr-smtp responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: email in: path required: true schema: type: string /wpcom/v2/twilio-notification: post: operationId: postWpcomV2TwilioNotification summary: POST /wpcom/v2/twilio-notification tags: - twilio-notification responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/twitter: get: operationId: getWpcomV2Twitter summary: GET /wpcom/v2/twitter tags: - twitter responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: screen_name in: query required: true schema: type: string - name: trim_user in: query required: false schema: type: string default: 'true' - name: include_entities in: query required: false schema: type: string default: 'true' - name: exclude_replies in: query required: false schema: type: string - name: count in: query required: false schema: type: integer - name: include_rts in: query required: false schema: type: string /wpcom/v2/upgrades/{subscription_id}/cancel-features: get: operationId: getWpcomV2UpgradesbySubscriptionIdCancelFeatures summary: GET /wpcom/v2/upgrades/{subscription_id}/cancel-features tags: - upgrades responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: subscription_id in: path required: true schema: type: string - name: variant in: query required: false schema: type: string default: control - name: target_product_slug in: query required: false schema: type: string /wpcom/v2/users/username/suggestions: get: operationId: getWpcomV2UsersUsernameSuggestions summary: GET /wpcom/v2/users/username/suggestions 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: name in: query required: true schema: type: string description: A string from which to derive suggestions. May be a single word, multiple words, or email address. /wpcom/v2/users/{user_id}/sites: get: operationId: getWpcomV2UsersbyUserIdSites summary: GET /wpcom/v2/users/{user_id}/sites 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: user_id in: path required: true schema: type: string - name: caller in: query required: false schema: type: string enum: - reader description: String that identifies the caller. Based on this value, the endpoint can apply additional filtering to the returned sites. - name: owner in: query required: false schema: type: boolean default: false description: Whether the requester is the profile owner. Only honored when the authenticated user matches user_id; when trusted, hidden sites are included and each site is annotated with is_hidden. /wpcom/v2/verticals: get: operationId: getWpcomV2Verticals summary: GET /wpcom/v2/verticals tags: - verticals responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: search in: query required: false schema: type: string description: Term (e.g "rest") to search for matching verticals. - name: limit in: query required: false schema: type: integer default: -1 description: Limit the number of verticals returned. -1 for no limits. - name: site_type in: query required: false schema: type: integer default: 1 description: ID of site type (e.g. "1" for "business) to use for preview. - name: allow_synonyms in: query required: false schema: type: boolean default: false description: Informs the site verticals class whether to allow matching against vertical synonyms. - name: suggest_theme in: query required: false schema: type: boolean default: false description: Whether or not to return a suggested theme for verticals. If a theme is suggested the preview may be a screenshot. /wpcom/v2/verticals/prompt: get: operationId: getWpcomV2VerticalsPrompt summary: GET /wpcom/v2/verticals/prompt tags: - verticals responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: segment_id in: query required: true schema: type: integer description: Unique ID of the segment for which the to fetch the prompt values(e.g. 1 ) /wpcom/v2/verticals/{vertical_id}/images: get: operationId: getWpcomV2VerticalsbyVerticalIdImages summary: GET /wpcom/v2/verticals/{vertical_id}/images tags: - verticals responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: vertical_id in: path required: true schema: type: string - name: orientation in: query required: false schema: type: string enum: - portrait - landscape - square description: Orientation of the pictures to retrieve. /wpcom/v2/verticals/{vertical_id}/templates: get: operationId: getWpcomV2VerticalsbyVerticalIdTemplates summary: GET /wpcom/v2/verticals/{vertical_id}/templates tags: - verticals responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: vertical_id in: path required: true schema: type: string /wpcom/v2/verticals/{vertical_id}/templates/{template_slug}: get: operationId: getWpcomV2VerticalsbyVerticalIdTemplatesbyTemplateSlug summary: GET /wpcom/v2/verticals/{vertical_id}/templates/{template_slug} tags: - verticals responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: vertical_id in: path required: true schema: type: string - name: template_slug in: path required: true schema: type: string /wpcom/v2/vibehost: get: operationId: getWpcomV2Vibehost summary: GET /wpcom/v2/vibehost tags: - vibehost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2Vibehost summary: POST /wpcom/v2/vibehost tags: - vibehost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: blueprint: type: object description: The blueprint object to validate and apply. apply: type: boolean default: false description: Whether to create the site and apply the blueprint. required: - blueprint /wpcom/v2/vibehost/export: get: operationId: getWpcomV2VibehostExport summary: GET /wpcom/v2/vibehost/export tags: - vibehost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: token in: query required: false schema: type: string description: Auth token ({blog_id}.{secret}). Alternative to X-Vibehost-Token header. /wpcom/v2/vibehost/update: post: operationId: postWpcomV2VibehostUpdate summary: POST /wpcom/v2/vibehost/update tags: - vibehost responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: blueprint: type: object description: The blueprint object to validate. apply: type: boolean default: false description: Whether to apply the blueprint after validation. token: type: string description: Auth token ({blog_id}.{secret}). Alternative to X-Vibehost-Token header. required: - blueprint /wpcom/v2/videos: post: operationId: postWpcomV2Videos summary: POST /wpcom/v2/videos tags: - videos responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: guid: type: string description: The VideoPress video guid. title: type: string description: The title of the video. description: type: string description: The description of the video. rating: type: string description: The video content rating. One of G, PG-13, or R-17 display_embed: type: boolean description: Display the share menu in the player. required: - guid put: operationId: putWpcomV2Videos summary: PUT /wpcom/v2/videos tags: - videos responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: guid: type: string description: The VideoPress video guid. title: type: string description: The title of the video. description: type: string description: The description of the video. rating: type: string description: The video content rating. One of G, PG-13, or R-17 display_embed: type: boolean description: Display the share menu in the player. required: - guid patch: operationId: patchWpcomV2Videos summary: PATCH /wpcom/v2/videos tags: - videos responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: guid: type: string description: The VideoPress video guid. title: type: string description: The title of the video. description: type: string description: The description of the video. rating: type: string description: The video content rating. One of G, PG-13, or R-17 display_embed: type: boolean description: Display the share menu in the player. required: - guid /wpcom/v2/vip/cs-services/perf/edge_cache_stats: get: operationId: getWpcomV2VipCsServicesPerfEdgeCacheStats summary: GET /wpcom/v2/vip/cs-services/perf/edge_cache_stats tags: - vip responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: site_id in: query required: true schema: {} - name: url in: query required: true schema: {} - name: date in: query required: false schema: default: '2026-07-31' /wpcom/v2/vip/cs-services/perf/upstream_response_time: get: operationId: getWpcomV2VipCsServicesPerfUpstreamResponseTime summary: GET /wpcom/v2/vip/cs-services/perf/upstream_response_time tags: - vip responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: site_id in: query required: true schema: {} - name: url in: query required: true schema: {} - name: date in: query required: false schema: default: '2026-07-31' /wpcom/v2/wc/meta/authorize: get: operationId: getWpcomV2WcMetaAuthorize summary: GET /wpcom/v2/wc/meta/authorize tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: state in: query required: true schema: type: string description: OAuth state parameter for security validation - name: code in: query required: false schema: type: string description: OAuth authorization code from Meta /wpcom/v2/wc/reddit/authorize: get: operationId: getWpcomV2WcRedditAuthorize summary: GET /wpcom/v2/wc/reddit/authorize tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: state in: query required: true schema: type: string description: OAuth state parameter for security validation - name: code in: query required: false schema: type: string description: OAuth authorization code from Reddit /wpcom/v2/wc/snapchat/authorize: get: operationId: getWpcomV2WcSnapchatAuthorize summary: GET /wpcom/v2/wc/snapchat/authorize tags: - wc responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: state in: query required: true schema: type: string description: OAuth state parameter for security validation - name: code in: query required: true schema: type: string description: OAuth authorization code from Snapchat /wpcom/v2/wcbazaar/categories-config: get: operationId: getWpcomV2WcbazaarCategoriesConfig summary: GET /wpcom/v2/wcbazaar/categories-config tags: - wcbazaar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/wcbazaar/category: get: operationId: getWpcomV2WcbazaarCategory summary: GET /wpcom/v2/wcbazaar/category tags: - wcbazaar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: category in: query required: true schema: type: string - name: subcategory in: query required: false schema: type: string - name: query in: query required: false schema: type: string - name: currency in: query required: false schema: type: string - name: currencies in: query required: false schema: type: string - name: on_sale in: query required: false schema: type: string - name: require_photo in: query required: false schema: type: string - name: sort in: query required: false schema: type: string enum: - price_asc - price_desc - name: page in: query required: false schema: type: integer default: 1 - name: per_page in: query required: false schema: type: integer default: 100 /wpcom/v2/wcbazaar/doc: get: operationId: getWpcomV2WcbazaarDoc summary: GET /wpcom/v2/wcbazaar/doc tags: - wcbazaar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: blog_id in: query required: true schema: type: integer - name: post_id in: query required: true schema: type: integer /wpcom/v2/wcbazaar/docs: get: operationId: getWpcomV2WcbazaarDocs summary: GET /wpcom/v2/wcbazaar/docs tags: - wcbazaar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: ids in: query required: true schema: type: array items: type: string /wpcom/v2/wcbazaar/recommended-for-you: get: operationId: getWpcomV2WcbazaarRecommendedForYou summary: GET /wpcom/v2/wcbazaar/recommended-for-you tags: - wcbazaar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: currency in: query required: false schema: type: string /wpcom/v2/wcbazaar/search: get: operationId: getWpcomV2WcbazaarSearch summary: GET /wpcom/v2/wcbazaar/search tags: - wcbazaar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: query in: query required: false schema: type: string default: '' - name: blog_id in: query required: false schema: type: integer - name: post_id in: query required: false schema: type: integer - name: currencies in: query required: false schema: type: array items: type: string - name: categories in: query required: false schema: type: array items: type: string - name: on_sale in: query required: false schema: type: boolean default: false - name: in_stock in: query required: false schema: type: boolean default: false - name: require_photo in: query required: false schema: type: boolean default: false - name: price_min in: query required: false schema: type: number - name: price_max in: query required: false schema: type: number - name: size in: query required: false schema: type: integer default: 24 - name: from in: query required: false schema: type: integer default: 0 - name: sort in: query required: false schema: type: string enum: - relevance - price_asc - price_desc - modified_desc - popularity default: relevance - name: facets in: query required: false schema: type: array default: [] items: type: string - name: lang in: query required: false schema: type: string default: en /wpcom/v2/wcbazaar/showcase: get: operationId: getWpcomV2WcbazaarShowcase summary: GET /wpcom/v2/wcbazaar/showcase tags: - wcbazaar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: category in: query required: true schema: type: string - name: page in: query required: false schema: type: integer default: 1 - name: per_page in: query required: false schema: type: integer default: 6 - name: products_per_store in: query required: false schema: type: integer default: 3 /wpcom/v2/wcbazaar/stores: get: operationId: getWpcomV2WcbazaarStores summary: GET /wpcom/v2/wcbazaar/stores tags: - wcbazaar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: page in: query required: false schema: type: integer default: 1 - name: per_page in: query required: false schema: type: integer default: 200 /wpcom/v2/wcbazaar/todays-deals: get: operationId: getWpcomV2WcbazaarTodaysDeals summary: GET /wpcom/v2/wcbazaar/todays-deals tags: - wcbazaar responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: currency in: query required: false schema: type: string /wpcom/v2/wccom/happiness/refresh-ssr: post: operationId: postWpcomV2WccomHappinessRefreshSsr summary: POST /wpcom/v2/wccom/happiness/refresh-ssr tags: - wccom responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: site_url: type: string format: uri description: Site URL to fetch SSR from. site_id: type: integer description: Site ID to fetch SSR from. user_id: type: integer description: User ID that owns the site connection. ticket_id: type: integer description: Zendesk ticket ID to update with SSR. /wpcom/v2/wccom/happiness/ssr-url: get: operationId: getWpcomV2WccomHappinessSsrUrl summary: GET /wpcom/v2/wccom/happiness/ssr-url tags: - wccom responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: site_url in: query required: true schema: type: string format: uri description: Site URL. /wpcom/v2/wccom/happiness/user-chat-token: get: operationId: getWpcomV2WccomHappinessUserChatToken summary: GET /wpcom/v2/wccom/happiness/user-chat-token tags: - wccom responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/wccom/happiness/vendors: get: operationId: getWpcomV2WccomHappinessVendors summary: GET /wpcom/v2/wccom/happiness/vendors tags: - wccom responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/webhook-airtable-create: post: operationId: postWpcomV2WebhookAirtableCreate summary: POST /wpcom/v2/webhook-airtable-create tags: - webhook-airtable-create responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/webhook-airtable-create/create-webhook: post: operationId: postWpcomV2WebhookAirtableCreateCreateWebhook summary: POST /wpcom/v2/webhook-airtable-create/create-webhook tags: - webhook-airtable-create responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: table_id: type: string description: Airtable table ID. base_id: type: string description: Airtable base ID. url: type: string description: URL to direct new webhook to. required: - table_id - base_id - url /wpcom/v2/webhook-airtable-create/patch: post: operationId: postWpcomV2WebhookAirtableCreatePatch summary: POST /wpcom/v2/webhook-airtable-create/patch tags: - webhook-airtable-create responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: table_id: type: string description: Airtable table ID. base_id: type: string description: Airtable base ID. records: type: array items: {} description: A record to be PATCHED. required: - table_id - base_id - records put: operationId: putWpcomV2WebhookAirtableCreatePatch summary: PUT /wpcom/v2/webhook-airtable-create/patch tags: - webhook-airtable-create responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: table_id: type: string description: Airtable table ID. base_id: type: string description: Airtable base ID. records: type: array items: {} description: A record to be PATCHED. required: - table_id - base_id - records patch: operationId: patchWpcomV2WebhookAirtableCreatePatch summary: PATCH /wpcom/v2/webhook-airtable-create/patch tags: - webhook-airtable-create responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: table_id: type: string description: Airtable table ID. base_id: type: string description: Airtable base ID. records: type: array items: {} description: A record to be PATCHED. required: - table_id - base_id - records /wpcom/v2/whats-new/list: get: operationId: getWpcomV2WhatsNewList summary: GET /wpcom/v2/whats-new/list tags: - whats-new responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: _locale in: query required: false schema: type: string description: locale of the client app, also variations are accepted but filtered out in logic - name: app_id in: query required: false schema: type: integer description: unique application id of the client app (for example getting a 1 here is WORDPRESS_ANDROID_APP_ID) - name: site_id in: query required: false schema: type: string description: id of the site for which the announcement is being requested /wpcom/v2/whats-new/seen-announcement-ids: get: operationId: getWpcomV2WhatsNewSeenAnnouncementIds summary: GET /wpcom/v2/whats-new/seen-announcement-ids tags: - whats-new responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' post: operationId: postWpcomV2WhatsNewSeenAnnouncementIds summary: POST /wpcom/v2/whats-new/seen-announcement-ids tags: - whats-new responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: seen_announcement_ids: type: array items: {} required: - seen_announcement_ids /wpcom/v2/woo-mobile-ai/chat/completions: post: operationId: postWpcomV2WooMobileAiChatCompletions summary: POST /wpcom/v2/woo-mobile-ai/chat/completions tags: - woo-mobile-ai responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: messages: type: array items: {} description: The messages to send to the AI assistant. model: type: string description: The model to use for completion. max_tokens: type: integer description: The maximum number of tokens to generate. tools: type: array items: {} description: The tools to make available to the model. response_format: type: string enum: - text - json_object default: text description: The expected response format. completion_options: type: object description: Additional completion options forwarded to the model. store: type: boolean description: Whether the upstream provider should store the conversation. stream: type: boolean description: Whether to stream the response as Server-Sent Events. required: - messages /wpcom/v2/woo/address-autocomplete/map: get: operationId: getWpcomV2WooAddressAutocompleteMap summary: GET /wpcom/v2/woo/address-autocomplete/map tags: - woo responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: token in: query required: true schema: type: string - name: locations in: query required: true schema: type: string /wpcom/v2/woo/address-autocomplete/search: get: operationId: getWpcomV2WooAddressAutocompleteSearch summary: GET /wpcom/v2/woo/address-autocomplete/search tags: - woo responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: query in: query required: true schema: type: string description: The address search query. - name: country in: query required: false schema: type: string default: '' description: The country code to bias the search results around, will be concluded from the IP address if not provided. - name: lat in: query required: false schema: type: number description: The latitude to bias the search results around, will be concluded from the IP address if not provided. - name: lng in: query required: false schema: type: number description: The longitude to bias the search results around, will be concluded from the IP address if not provided. - name: lang in: query required: false schema: type: string default: '' description: The language code to use for the search results. - name: session_id in: query required: true schema: type: string description: The session ID to use for the search operation. - name: token in: query required: true schema: type: string description: The JWT token to use for authentication. /wpcom/v2/woo/address-autocomplete/select: get: operationId: getWpcomV2WooAddressAutocompleteSelect summary: GET /wpcom/v2/woo/address-autocomplete/select tags: - woo responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: address_id in: query required: true schema: type: string - name: lang in: query required: false schema: type: string default: '' description: The language code to use for the select address operation. - name: session_id in: query required: true schema: type: string - name: token in: query required: true schema: type: string description: The JWT token to use for authentication. /wpcom/v2/woocommerce/countries/regions: get: operationId: getWpcomV2WoocommerceCountriesRegions summary: GET /wpcom/v2/woocommerce/countries/regions tags: - woocommerce responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/woocommerce/stripe/remote-config: get: operationId: getWpcomV2WoocommerceStripeRemoteConfig summary: GET /wpcom/v2/woocommerce/stripe/remote-config tags: - woocommerce responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: mode in: query required: false schema: type: string description: Plugin mode (e.g. live, test). - name: plugin_version in: query required: false schema: type: string description: Plugin version installed on the merchant site. /wpcom/v2/wordads/redirect: get: operationId: getWpcomV2WordadsRedirect summary: GET /wpcom/v2/wordads/redirect tags: - wordads responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: source in: query required: true schema: type: string description: utm_source - name: medium in: query required: true schema: type: string description: utm_medium - name: id in: query required: true schema: type: string description: utm_id - name: campaign in: query required: true schema: type: string description: utm_campaign - name: content in: query required: true schema: type: string description: utm_content - name: redirect in: query required: true schema: type: string format: uri description: Redirect URL - name: signature in: query required: true schema: type: string description: HMAC signature /wpcom/v2/wordads/send-email: post: operationId: postWpcomV2WordadsSendEmail summary: POST /wpcom/v2/wordads/send-email tags: - wordads responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: email: type: string subject: type: string content: type: string product: type: string required: - email - subject - content /wpcom/v2/wordads/send-guides-email: post: operationId: postWpcomV2WordadsSendGuidesEmail summary: POST /wpcom/v2/wordads/send-guides-email tags: - wordads responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: type: type: string wpcom_user_id: type: integer wpcom_site_id: type: integer credits_amount: type: string expire_seconds: type: integer expire_date: type: string required: - type - wpcom_user_id - wpcom_site_id - credits_amount - expire_seconds - expire_date /wpcom/v2/wordads/send-notification: post: operationId: postWpcomV2WordadsSendNotification summary: POST /wpcom/v2/wordads/send-notification tags: - wordads responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: user_id: type: number blog_id: type: number post_id: type: number campaign_id: type: number title: type: string type: type: string enum: - approved - rejected - cancelled - performed ad_type: type: string required: - user_id - blog_id - post_id - campaign_id - title - ad_type /wpcom/v2/wordcamp-coupons: post: operationId: postWpcomV2WordcampCoupons summary: POST /wpcom/v2/wordcamp-coupons tags: - wordcamp-coupons responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' requestBody: content: application/json: schema: type: object properties: email: type: string description: Email wordcamp_code: type: string description: Wordcamp Code required: - email - wordcamp_code /wpcom/v2/work-with-us: get: operationId: getWpcomV2WorkWithUs summary: GET /wpcom/v2/work-with-us tags: - work-with-us responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/work-with-us/names: get: operationId: getWpcomV2WorkWithUsNames summary: GET /wpcom/v2/work-with-us/names tags: - work-with-us responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/zendesk-notification-staging/ticket: post: operationId: postWpcomV2ZendeskNotificationStagingTicket summary: POST /wpcom/v2/zendesk-notification-staging/ticket tags: - zendesk-notification-staging responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/zendesk-notification/a8c/message: post: operationId: postWpcomV2ZendeskNotificationA8CMessage summary: POST /wpcom/v2/zendesk-notification/a8c/message tags: - zendesk-notification responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/zendesk-notification/a8c/ticket: post: operationId: postWpcomV2ZendeskNotificationA8CTicket summary: POST /wpcom/v2/zendesk-notification/a8c/ticket tags: - zendesk-notification responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/zendesk-notification/a8c/user-created: post: operationId: postWpcomV2ZendeskNotificationA8CUserCreated summary: POST /wpcom/v2/zendesk-notification/a8c/user-created tags: - zendesk-notification responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/zendesk-notification/a8c/user-deleted: post: operationId: postWpcomV2ZendeskNotificationA8CUserDeleted summary: POST /wpcom/v2/zendesk-notification/a8c/user-deleted tags: - zendesk-notification responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/zendesk-notification/a8c/user-external-id-changed: post: operationId: postWpcomV2ZendeskNotificationA8CUserExternalIdChanged summary: POST /wpcom/v2/zendesk-notification/a8c/user-external-id-changed tags: - zendesk-notification responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/zendesk-notification/tumblr/message: post: operationId: postWpcomV2ZendeskNotificationTumblrMessage summary: POST /wpcom/v2/zendesk-notification/tumblr/message tags: - zendesk-notification responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/zendesk-notification/tumblr/tos: post: operationId: postWpcomV2ZendeskNotificationTumblrTos summary: POST /wpcom/v2/zendesk-notification/tumblr/tos tags: - zendesk-notification responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/zendesk-notification/woothemes/ai-reply: post: operationId: postWpcomV2ZendeskNotificationWoothemesAiReply summary: POST /wpcom/v2/zendesk-notification/woothemes/ai-reply tags: - zendesk-notification responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/zendesk-notification/woothemes/ticket: post: operationId: postWpcomV2ZendeskNotificationWoothemesTicket summary: POST /wpcom/v2/zendesk-notification/woothemes/ticket tags: - zendesk-notification responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' /wpcom/v2/zendesk/triage/{handler}: post: operationId: postWpcomV2ZendeskTriagebyHandler summary: POST /wpcom/v2/zendesk/triage/{handler} tags: - zendesk responses: '200': description: OK '401': description: Authentication required content: application/json: schema: $ref: '#/components/schemas/WPRestError' '404': description: Not found content: application/json: schema: $ref: '#/components/schemas/WPRestError' parameters: - name: handler in: path required: true schema: type: string 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: []