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

Edit scheme engagement with engagement reference and given information based on payload

Sample Request:

PATCH /api/v2/supportschemes/SP1000000006/engagements/SE1000000011

Example Payload:
{           
    "startDate": "01/02/2025",
    "owner": "Jack Brown",
    "safeToTalkWord": "word",
    "notSafeToTalkWord": "word"  
    "address": {
        "addressLineOne": "12 Test road",
        "addressLineTwo": "",
        "addressLineThree": "",
        "addressLineFour": "",
        "addressLineFive": "",
        "postcode": "ST145DL"
    }
}

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

Requirements
"startDate"                   Start date must be set.  
"owner"                       [Optional] Owner can be null or a scheme member
"safeToTalkWord"              [Optional] Safe to talk word can be null
"notSafeToTalkWord"           [Optional] Not ssafe to talk word can be null
"address"                     [Conditional] If engagement person have an occupancy, address section must be null. 
                              But if the person does not have an occupancy, than address section must be set.
"addressLineOne"              [Conditional] If address is required addressLineOne must be set.              
"addressLineTwo"              [Optional - Conditional] If address is required addressLineTwo is optional.              
"addressLineThree"            [Optional - Conditional] If address is required addressLineThree is optional.              
"addressLineFour"             [Optional - Conditional] If address is required addressLineFour is optional.              
"addressLineFive"             [Optional - Conditional] If address is required addressLineFive is optional.             
"postcode"                    [Conditional] If address is required postCode must be set.

Required Permission(s): SupportPlans.EditSupportSchemes

Log in to see full request history
Path Params
string
required

Reference of the Support Scheme.

string
required

Reference of the Scheme engagement.

Body Params

Information of the new scheme engagement.

string
required
length ≥ 1
string | null
string | null
string | null
address
object
Responses
204

On Success

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