Star or unstar a website

PATCH

https://api.modulards.com/api/public/v1/sites/:site/favorite

PATCH

/api/public/v1/sites/:site/favorite

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

200Star or unstar a website

{
  "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_favorite": true,
      "is_main_site": true,
      "is_multisite": false,
      "locale": "en_US",
      "name": "Acme Corp",
      "path": null,
      "provider": "wp",
      "scheme": "https",
      "slug": "acme-corp",
      "synced_at": "2026-09-16T08:12:00.000000Z",
      "timezone": "Europe/Madrid",
      "updated_at": "2026-09-21T09:30: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"
  }
}

Stars or unstars a website for the member who owns the token. Stars are personal, not shared with the rest of the organization; list starred websites first with sort=-is_favorite on “List websites”. Returns the website with its is_favorite flag.

Your role must be allowed to star websites; without it the request answers 404.

Body

favorite (boolean, required): true stars the website, false unstars it. It sets the state and never toggles it, so repeating the call is safe.

Authentication

AuthorizationBearer

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

Path parameters

sitestringRequired

Request

This endpoint expects an object.

favoritebooleanOptional

Response

200 - Favorite updated

dataobjectOptional

jsonapiobjectOptional