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

Edit an existing referral for support scheme with given information based on payload

Sample Request:

PATCH /api/v2.0/supportschemes/SP1000000004/referrals/REF1000000021

Example Payload:
{           
    "description": "Test purpose referral",
    "referralSource": "Local Authority",
    "referralDate": "01/06/2024",
    "status" : "Rejected",
    "inactive" : true
}

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

Requirements
"description"         Description must be set.  
"referralSource"      Referral Source must be set.
"referralDate"        Referral date must be set and must be in DD/MM/YYYY format.
"status"              Status must be Live - Rejected - Accepted or Waiting List.
"inactive"            Inactive status 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 referral.

Body Params

Information of the Scheme referral.

string
required
length between 1 and 250
string
required
length ≥ 1
string
required
length ≥ 1
string
required
length ≥ 1
boolean
required
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