cancel Action With Id
DELETE {{baseUrl}}/api/user/action/:actionId
Cancels the user action.
Request Body
{"action"=>{"actioneeUserId"=>"<uuid>", "actionerUserId"=>"<uuid>", "applicationIds"=>["<uuid>", "<uuid>"], "comment"=>"<string>", "emailUser"=>"<boolean>", "expiry"=>"<long>", "notifyUser"=>"<boolean>", "option"=>"<string>", "reasonId"=>"<uuid>", "userActionId"=>"<uuid>"}, "broadcast"=>"<boolean>", "eventInfo"=>{"deviceDescription"=>"<string>", "deviceName"=>"<string>", "deviceType"=>"<string>", "ipAddress"=>"<string>", "location"=>{"city"=>"<string>", "country"=>"<string>", "latitude"=>"<double>", "longitude"=>"<double>", "region"=>"<string>", "zipcode"=>"<string>", "displayString"=>"<string>"}, "os"=>"<string>", "userAgent"=>"<string>"}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"action":{"actioneeUserId":"\u003cuuid\u003e","actionerUserId":"\u003cuuid\u003e","applicationIds":["\u003cuuid\u003e","\u003cuuid\u003e"],"comment":"\u003cstring\u003e","emailUserOnEnd":"\u003cboolean\u003e","endEventSent":"\u003cboolean\u003e","expiry":"\u003clong\u003e","history":{"historyItems":[{"actionerUserId":"\u003cuuid\u003e","comment":"\u003cstring\u003e","createInstant":"\u003clong\u003e","expiry":"\u003clong\u003e"},{"actionerUserId":"\u003cuuid\u003e","comment":"\u003cstring\u003e","createInstant":"\u003clong\u003e","expiry":"\u003clong\u003e"}]},"id":"\u003cuuid\u003e","insertInstant":"\u003clong\u003e","localizedName":"\u003cstring\u003e","localizedOption":"\u003cstring\u003e","localizedReason":"\u003cstring\u003e","name":"\u003cstring\u003e","notifyUserOnEnd":"\u003cboolean\u003e","option":"\u003cstring\u003e","reason":"\u003cstring\u003e","reasonCode":"\u003cstring\u003e","userActionId":"\u003cuuid\u003e"},"actions":[{"actioneeUserId":"\u003cuuid\u003e","actionerUserId":"\u003cuuid\u003e","applicationIds":["\u003cuuid\u003e","\u003cuuid\u003e"],"comment":"\u003cstring\u003e","emailUserOnEnd":"\u003cboolean\u003e","endEventSent":"\u003cboolean\u003e","expiry":"\u003clong\u003e","history":{"historyItems":[{"actionerUserId":"\u003cuuid\u003e","comment":"\u003cstring\u003e","createInstant":"\u003clong\u003e","expiry":"\u003clong\u003e"},{"actionerUserId":"\u003cuuid\u003e","comment":"\u003cstring\u003e","createInstant":"\u003clong\u003e","expiry":"\u003clong\u003e"}]},"id":"\u003cuuid\u003e","insertInstant":"\u003clong\u003e","localizedName":"\u003cstring\u003e","localizedOption":"\u003cstring\u003e","localizedReason":"\u003cstring\u003e","name":"\u003cstring\u003e","notifyUserOnEnd":"\u003cboolean\u003e","option":"\u003cstring\u003e","reason":"\u003cstring\u003e","reasonCode":"\u003cstring\u003e","userActionId":"\u003cuuid\u003e"},{"actioneeUserId":"\u003cuuid\u003e","actionerUserId":"\u003cuuid\u003e","applicationIds":["\u003cuuid\u003e","\u003cuuid\u003e"],"comment":"\u003cstring\u003e","emailUserOnEnd":"\u003cboolean\u003e","endEventSent":"\u003cboolean\u003e","expiry":"\u003clong\u003e","history":{"historyItems":[{"actionerUserId":"\u003cuuid\u003e","comment":"\u003cstring\u003e","createInstant":"\u003clong\u003e","expiry":"\u003clong\u003e"},{"actionerUserId":"\u003cuuid\u003e","comment":"\u003cstring\u003e","createInstant":"\u003clong\u003e","expiry":"\u003clong\u003e"}]},"id":"\u003cuuid\u003e","insertInstant":"\u003clong\u003e","localizedName":"\u003cstring\u003e","localizedOption":"\u003cstring\u003e","localizedReason":"\u003cstring\u003e","name":"\u003cstring\u003e","notifyUserOnEnd":"\u003cboolean\u003e","option":"\u003cstring\u003e","reason":"\u003cstring\u003e","reasonCode":"\u003cstring\u003e","userActionId":"\u003cuuid\u003e"}]}