Pause or resume WooCommerce statistics

PATCH

https://api.modulards.com/api/public/v1/sites/:site/services/:type/status

PATCH

/api/public/v1/sites/:site/services/:type/status

curl -X PATCH https://api.modulards.com/api/public/v1/sites/site/services/type/status \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "status": "inactive"
}'

{
  "data": {
    "attributes": {
      "connection_status": "established",
      "connector_version": "3.4.2",
      "core_version": "6.6.2",
      "created_at": "2026-01-14T09:30:00.000000Z",
      "created_by": 42,
      "db_engine": "mysql",
      "db_engine_version": "8.0.36",
      "deleted_at": null,
      "display_host": "acme-corp.com",
      "ecommerce_engine": "woocommerce",
      "ecommerce_version": "9.2.3",
      "engine": "php",
      "engine_version": "8.3.10",
      "host": "acme-corp.com",
      "is_connected": true,
      "is_main_site": true,
      "is_multisite": false,
      "locale": "en_US",
      "name": "Acme Corp",
      "path": null,
      "provider": "wp",
      "scheme": "https",
      "service_is_active": false,
      "service_is_configured": true,
      "service_status": "inactive",
      "service_type": "woocommerce",
      "slug": "acme-corp",
      "synced_at": "2026-09-16T08:12:00.000000Z",
      "timezone": "Europe/Madrid",
      "updated_at": "2026-09-21T09:45:00.000000Z",
      "uri": "https://acme-corp.com"
    },
    "id": "101",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/sites/101"
    },
    "type": "sites"
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Pauses or resumes the collection of a website’s WooCommerce store statistics. Today WooCommerce is the only kind of data you can pause; any other type in the path answers 404.

Returns the website with service_type, service_status, service_is_active and service_is_configured. Resuming is a request, not a promise: a website without WooCommerce, or with a version below the minimum supported, answers 200 with service_status inactive.

Body

status (active or inactive, required): active resumes the collection, inactive pauses it. It sets the state and never toggles it, so repeating the call is safe.

Errors

400: the website is not connected (code site_incomplete_connection, see Errors).
404: the website has no WooCommerce statistics set up.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Path parameters

sitestringRequired

typestringRequired

Request

This endpoint expects an object.

statusstringOptional

Response

200 - Service status updated

dataobjectOptional

jsonapiobjectOptional

Errors

400

Bad Request Error