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

Creates new scheme handover note with given information based on payload

Sample Request:

POST /api/v2/supportschemes/SP1000000006/handovernotes

Example Payload:
{          
    "title": "Handover note title",
    "description": "Handover note description",
    "recordType": "Manuel record",
    "priority": "High Level",  
    "closedDate": "01/01/2026",
    "linkedEngagementReference": "SE1000000012"
}

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

Requirements  
"title"                      Description must be set.
"description"                Description must be set and max allowed charachter is 5000
"recordType"                 Note Type must be set and need axact match with existing types
"priority"                   Note priority must be set and need exact match with existing priorities
"closedDate"                 [Optional] Close date must be a future date
"linkedEngagementReference"  [Optional] Engagemet reference must be belong to given scheme

Required Permission(s): SupportPlans.EditSupportSchemes

Log in to see full request history
Path Params
string
required

Reference of the Support Scheme.

Body Params

Information of the new scheme handover note.

string
required
length ≥ 1
string
required
length between 1 and 5000
string
required
length ≥ 1
string
required
length ≥ 1
string | null
string | null
Responses
201

On Success

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