Creates an signal profile with validated recipient and timing rules.

POST

/api/workspace/tasks/configuration/signal-profiles

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://example.com/api/workspace/tasks/configuration/signal-profiles"),
    Headers =
    {
        { "Authorization", "Bearer <token>" },
    },
    Content = new StringContent("{ \"Key\": \"example\", \"DisplayName\": \"example\", \"Description\": \"example\", \"Settings\": { \"Enabled\": true, \"WarningBeforeDueMinutes\": 1, \"DangerBeforeDueMinutes\": 1, \"SignalPolicies\": [ { \"SignalTypeKey\": \"example\", \"Audience\": 0, \"AdditionalSubjects\": [ { \"Kind\": 0, \"Id\": \"example\" } ], \"RequiresAcknowledgement\": true, \"NotifyOn\": 0 } ] }, \"OperationId\": \"example\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://example.com/api/workspace/tasks/configuration/signal-profiles';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"Key":"example","DisplayName":"example","Description":"example","Settings":{"Enabled":true,"WarningBeforeDueMinutes":1,"DangerBeforeDueMinutes":1,"SignalPolicies":[{"SignalTypeKey":"example","Audience":0,"AdditionalSubjects":[{"Kind":0,"Id":"example"}],"RequiresAcknowledgement":true,"NotifyOn":0}]},"OperationId":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/workspace/tasks/configuration/signal-profiles \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "Key": "example", "DisplayName": "example", "Description": "example", "Settings": { "Enabled": true, "WarningBeforeDueMinutes": 1, "DangerBeforeDueMinutes": 1, "SignalPolicies": [ { "SignalTypeKey": "example", "Audience": 0, "AdditionalSubjects": [ { "Kind": 0, "Id": "example" } ], "RequiresAcknowledgement": true, "NotifyOn": 0 } ] }, "OperationId": "example" }'

Authorizations

WorkspaceBearer

Parameters

Query Parameters

access_token

string

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

Request Body

object

Key

string

nullable

DisplayName

string

nullable

Description

string

nullable

Settings

required

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

string

nullable

RequiresAcknowledgement

boolean

NotifyOn

integer format: int32

Allowed values: 0 1 2 4

OperationId

string

nullable

Responses

200

application/json

object

Data

object

ProfileId

string

nullable

Profile

object

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

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
    }
  ]
}