These docs are for v2.3. Click to read the latest docs for v3.0.

Creates new action for engagement goal with given information based on payload

Sample Request:

POST /api/v2/supportschemes/SP1000000006/engagements/SE1000000012/goals/8e0d3b9f-0e58-4c23-986f-08dcde26ade7/actions

Example Payload:
{
"dateIdentified": "01/02/2025",
"actionDescription": "Test action description"
}

This endpoint requires all data to be in the body of the request

Requirements
"dateIdentified" Date Identified must be set and in correct format (DD/MM/YYY).
"actionDescription" Description must be set and max allowed character limit 1250.

Required Permission(s): SupportPlans.EditSupportSchemes

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Reference of the Support Scheme.

string
required

Reference of the Scheme engagement.

uuid
required

The Engagement goal id

Body Params

Information of the new referral task.

string
required
length ≥ 1
string
required
length between 1 and 1250
Responses
201

On Success

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