Update Module Management preferences

OpenAPI contract

Method

PATCH

Path

/api/v1/processors/modules/preferences

Security

jwtBearer (bearer) OR automationKey (bearer)

Response status

200 400 401 403 404 429 500

Request and response schemas

JSON

{
  "requestBody": {
    "application/json": {
      "$ref": "#/components/schemas/UpdateModulePreferencesRequest"
    }
  },
  "responses": {
    "200": {
      "description": "Updated Module Management preferences",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ModulePreferencesResponse"
        }
      }
    },
    "400": {
      "description": "Invalid request",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestError"
        }
      }
    },
    "401": {
      "description": "Authentication required or invalid",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "403": {
      "description": "Authenticated but not permitted",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "404": {
      "description": "Requested processor preset was not found",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "500": {
      "description": "Unexpected server error",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  }
}

PATCH /api/v1/processors/modules/preferences accepts a JWT or an nfy_ key with processor:write. Supply either field to update it without replacing the other. activeProfileId must identify a Profile owned by the caller.

http

PATCH /api/v1/processors/modules/preferences
Authorization: Bearer <access token>
Content-Type: application/json

{"autoSaveEnabled":false,"activeProfileId":"00000000-0000-0000-0000-000000000000"}