Enable or disable a module (PATCH)

PATCH

/wp-json/wp2/modules/v1/modules/{id}

curl --request PATCH \
  --url https://example.com/wp-json/wp2/modules/v1/modules/example \
  --header 'Content-Type: application/json' \
  --header 'X-WP-Nonce: <X-WP-Nonce>' \
  --data '{ "enabled": true, "scope": "network" }'

Same as PUT.

Authorizations

• cookie
• applicationPassword
• bearerToken

Parameters

Path Parameters

id

required

string

Request Body^required

Media typeapplication/json

object

enabled

required

boolean

scope

string

default: network

Allowed values: network site

Responses

200

Toggle result

Media typeapplication/json

object

id

string

enabled

boolean

scope

string

Allowed values: network site

locked

boolean

Example

{
  "scope": "network"
}

400

Invalid enabled or scope

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

403

Module_toggle_refused or insufficient capability

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}

404

Module_not_found

Media typeapplication/json

object

code

Machine-readable error or event code.

string

message

Message text (log, PIN, or password reset).

string

data

Extra WP_Error or license payload.

object

Example^generated

{
  "code": "example",
  "message": "example",
  "data": {}
}