This resource sends action plan email to recipients of a TOE.

This API sends action plan findings to internal and external recipients. The end-user needs to input the TOE ID (toe_id) for a given action plan in the API request.

Recipients and frequency are optional. If recipients are not provided, the action plan will be shared with previously shared recipients. If frequency is not provided, the action plan will be shared manually.

Users can retrieve action plan configuration from (GET) /v1/action_plan/{toe_id} API.

  • recipients: An Array of first_name, last_name, email, internal (true/false) for each recipient. See schema for more details.
  • frequency: 0 (default) is for manual/one-off, where 30/60/90 sets periodic automated action plan emails.
Path Params
string
required

Filter by the Toe ID.

Body Params
recipients
array of objects

A collection of recipients.

recipients
integer
enum
Defaults to 0

The frequency of the action plan.

Allowed:
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json