SEsecurityscorecard
action plans

Add guests to plan by ID

Changed on

Add guests to plan by id

post/plans/{id}/guests

Request

  • Base URL
    https://api.securityscorecard.io
  • URL
    https://api.securityscorecard.io/plans/{id}/guests
  • Auth
    API key in header Authorization

Path parameters

idstring uuid required

action plan id

Request body

guestsstring[]

Example request

{
  "guests": [
    "user@example.com"
  ]
}

Response

Message containing the amount of guests added

messagestring required

Changes

  • b465b4846039Revision 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

    • info

      the request property became optional

    • info

      media type application/json; charset=utf-8 was changed to application/json for the response 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

    • info

      added the non-success response with the status