action plans

Update partially the factor score improvement plan by ID

Changed on Nov 3, 2026

Update partially the factor score improvement plan by id

patch/plans/factor-score-improvement/{id}

Request

Base URL
https://api.securityscorecard.io
URL
https://api.securityscorecard.io/plans/factor-score-improvement/{id}
Auth
API key in header Authorization

Path parameters

idstring uuid required

action plan id

Request body

namestring

action plan name

descriptionstring

description

due_datestring date-time

due date

guestsstring[]

list of emails of guest users

Example request

{
  "name": "Example action plan",
  "description": "Example description",
  "due_date": "2020-01-01T00:00:00.000Z",
  "scorecard": "example.com",
  "target": {
    "factor_score_targets": [
      {
        "factor": "network_security",
        "score": 95
      }
    ]
  },
  "criteria": {
    "factors": [
      "network_security"
    ]
  }
}

Response

No Content

Changes

Nov 3, 2026b465b4846039 Revision changes
- breaking
  request body became required
- breaking
  added the pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ to the path request parameter id
- breaking
  added the pattern ^\d{4}-\d{2}-\d{2}[T ]\d{2}:\d{2}:\d{2}\.{0,1}[0-9]*Z$ to the request property
- breaking
  the /// request property type changed from number to integer
- info
  added the new optional request property
- info
  added the new optional request property
- info
  the request property / became optional
- info
  the request property / became optional
- info
  the request property /// became optional
- info
  the request property /// became optional
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status

Operation history