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

Creates new task for scheme engagement with given information based on payload

Sample Request:

POST /api/v2/supportschemes/SP1000000006/referrals/SE0000000006/tasks

Example Payload:
{           
    "owner": "Ben Holt",
    "taskType": "Contact Customer",
    "priority": "Standard Task",
    "description": "Test task create operation", 
    "startDate": "26/09/2024",
    "isRecurringTask": true,
    "triggerDate": "26/09/2024",
    "daysToRecur": 5
}

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

Requirements
"owner"               Owner must be set.  
"taskType"            Task type must be set.
"priority"            Priority must be set.
"description"         Description must be set.
"startDate"           [optional] Set if it is a future task. Defaults to DateTime.Now
"isRecurringTask"     [optional] Defaults to false
"triggerDate"         [conditional] if "isRecurringTask" set true, Trigger Date must be set
"daysToRecur"         [conditional] if "isRecurringTask" set true, Days to Occur must be set
                      and must be greater than or equal to 1.

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 referral task.

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