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

delete https://{tenant}.rubixx.app/api/v2/supportschemes/{supportSchemeReference}/engagements/{engagementReference}

Sample Request:

DELETE /api/v2/supportschemes/SP1000000006/engagements/SE1000000011

Example Payload:
{           
    "outcome": "Success - All goals Achieved",
    "endRecurringTasks": true       
}

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

Requirements
"outcome"            Must be set and %100 match with one of outcome in engagement outcome settings
"endRecurringTasks"  Must be set.

Required Permission(s): SupportPlans.EditSupportSchemes

Responses

204

On Success

Language

Credentials

Header

URL


xxxxxxxxxx
1
curl --request DELETE \
2
     --url https://.rubixx.app/api/v2/supportschemes/supportSchemeReference/engagements/engagementReference \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "endRecurringTasks": true
8
}
9
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

400If the request is malformed or incorrect

401If the supplied token is not correct

403If the provided bearer token cannot perform the current request due to a lack of permissions

404If the requested resource cannot be found

500An internal server error