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

Creates a new support scheme based on payload

Sample Request:

POST /api/v2.0/supportschemes

Example Payload:
{
    "description":"Example Scheme Description",
    "floating" : false,
    "inactive" : false,
    "capacity" : 6,
    "maxGoalScore" : 16
}

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

Requirements
"description"         A description of the Scheme must be set. Max allowed character is 250.
"maxGoalScore"        Max Goal Score must be greater than or equal to 1.
"capacity"            Capacity must be greater than or equal to 1.
"floating"            Defaults to set false.
"inactive"            Defaults to set false.

Required Permission(s): SupportPlans.CreateSupportSchemes

Log in to see full request history
Body Params
string
required
length between 1 and 250
boolean
boolean
int32
required
1 to 2147483647
int32
required
1 to 2147483647
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