Skip to content

Deletes an signal profile when its references permit removal.

DELETE
/api/workspace/tasks/configuration/signal-profiles/{profileId}
curl --request DELETE \
--url https://example.com/api/workspace/tasks/configuration/signal-profiles/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "ExpectedRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "OperationId": "example" }'
profileId
required
string
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

object
ExpectedRowVersion
required
string format: uuid
OperationId
string
nullable
Examplegenerated
{
"ExpectedRowVersion": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"OperationId": "example"
}

OK

Media typeapplication/json
object
Data
object
ProfileId
string
nullable
Profile
object
Id
string
nullable
Key
string
nullable
DisplayName
string
nullable
Description
string
nullable
Settings
object
Enabled
required
boolean
WarningBeforeDueMinutes
integer format: int32
nullable
DangerBeforeDueMinutes
integer format: int32
nullable
SignalPolicies
required
Array<object>
nullable
object
SignalTypeKey
string
nullable
Audience
integer format: int32
Allowed values: 0 1 2 4 8 16
AdditionalSubjects
Array<object>
nullable
object
Kind
integer format: int32
Allowed values: 0 1 2
Id
string
nullable
RequiresAcknowledgement
boolean
NotifyOn
integer format: int32
Allowed values: 0 1 2 4
RowVersion
string format: uuid
CanManage
boolean
Replayed
boolean
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Data": {
"Profile": {
"Settings": {
"SignalPolicies": [
{
"Audience": 0,
"AdditionalSubjects": [
{
"Kind": 0
}
],
"NotifyOn": 0
}
]
}
}
},
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}