POST api/Subscriptions
Creates a new subscription.
Request Information
URI Parameters
None.
Body Parameters
The subscription model to create with.
SubscriptionDto| Name | Description | Type | Additional information |
|---|---|---|---|
| Id | globally unique identifier |
None. |
|
| Name | string |
Required String length: inclusive between 0 and 512 |
|
| Description | string |
None. |
|
| CreationDate | date |
None. |
|
| CreatorUserId | globally unique identifier |
None. |
|
| IsActive | boolean |
None. |
|
| IsDeleted | boolean |
None. |
|
| TriggerTypeId | globally unique identifier |
None. |
|
| TenantIds | Collection of globally unique identifier |
None. |
|
| Actions | Collection of SubscriptionActionDto |
None. |
|
| Conditions | Collection of ConditionDto |
None. |
|
| Subscribers | Collection of SubscriberDto |
None. |
Request Formats
application/json, text/json
Sample:
{
"Id": "a5610796-5cbf-4631-876f-a43993c82536",
"Name": "sample string 2",
"Description": "sample string 3",
"CreationDate": "2026-01-10T00:45:23.5881264+00:00",
"CreatorUserId": "a870ebed-941d-40c6-9e84-f1970860fa64",
"IsActive": true,
"IsDeleted": true,
"TriggerTypeId": "3961e075-c434-4bd3-b4ed-fec37249dc64",
"TenantIds": [
"f785d1ee-dd3e-4796-93a1-d8d70865e5e2",
"32a69609-4119-4ec9-b536-b471729eef2d"
],
"Actions": [
{
"Id": "1606d7e0-8cd3-4b78-98f8-00e119dc2cc5",
"Name": "sample string 2",
"Description": "sample string 3",
"Status": 0,
"CreationDate": "2026-01-10T00:45:23.5881264+00:00",
"CreatorUserId": "0e737f0f-c58c-473b-9210-0c7b82097227",
"IsDeleted": true,
"Properties": [
{
"Id": "a6af4530-26bb-4a2c-85bc-c3f43d3c60e9",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-10T00:45:23.5881264+00:00",
"ActionId": "d0b4108d-c4cf-41ca-ad48-c3421b0aa411",
"PropertyTypeId": "44f4cffa-c9d4-4274-a2f2-8e53c4b1892e",
"MapFromTriggerPropertyTypeId": "ef7ce5e6-a1e6-4c3f-96d1-953b58130c8c"
},
{
"Id": "a6af4530-26bb-4a2c-85bc-c3f43d3c60e9",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-10T00:45:23.5881264+00:00",
"ActionId": "d0b4108d-c4cf-41ca-ad48-c3421b0aa411",
"PropertyTypeId": "44f4cffa-c9d4-4274-a2f2-8e53c4b1892e",
"MapFromTriggerPropertyTypeId": "ef7ce5e6-a1e6-4c3f-96d1-953b58130c8c"
}
],
"SubscriptionId": "b59fab77-ac69-499b-b562-b47ed07d9768",
"ActionTypeId": "954c8192-24f8-44a4-8eec-8f9eb8a273de"
},
{
"Id": "1606d7e0-8cd3-4b78-98f8-00e119dc2cc5",
"Name": "sample string 2",
"Description": "sample string 3",
"Status": 0,
"CreationDate": "2026-01-10T00:45:23.5881264+00:00",
"CreatorUserId": "0e737f0f-c58c-473b-9210-0c7b82097227",
"IsDeleted": true,
"Properties": [
{
"Id": "a6af4530-26bb-4a2c-85bc-c3f43d3c60e9",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-10T00:45:23.5881264+00:00",
"ActionId": "d0b4108d-c4cf-41ca-ad48-c3421b0aa411",
"PropertyTypeId": "44f4cffa-c9d4-4274-a2f2-8e53c4b1892e",
"MapFromTriggerPropertyTypeId": "ef7ce5e6-a1e6-4c3f-96d1-953b58130c8c"
},
{
"Id": "a6af4530-26bb-4a2c-85bc-c3f43d3c60e9",
"Name": "sample string 2",
"Value": "sample string 3",
"CreationDate": "2026-01-10T00:45:23.5881264+00:00",
"ActionId": "d0b4108d-c4cf-41ca-ad48-c3421b0aa411",
"PropertyTypeId": "44f4cffa-c9d4-4274-a2f2-8e53c4b1892e",
"MapFromTriggerPropertyTypeId": "ef7ce5e6-a1e6-4c3f-96d1-953b58130c8c"
}
],
"SubscriptionId": "b59fab77-ac69-499b-b562-b47ed07d9768",
"ActionTypeId": "954c8192-24f8-44a4-8eec-8f9eb8a273de"
}
],
"Conditions": [
{
"Id": "f8c434f5-f63e-4d47-b9e4-84c02afeef82",
"CreationDate": "2026-01-10T00:45:23.5881264+00:00",
"CreatorUserId": "91baa7e7-a94d-4bcf-91a9-d7b4890cd3b6",
"Operator": 0,
"EvaluationType": 0,
"Value": "sample string 4",
"SubscriptionId": "a3c7042a-dfea-4dfa-b214-92f33fd0ae7b",
"TriggerPropertyTypeId": "16b01672-121d-4e52-be4f-128a2704c0f1"
},
{
"Id": "f8c434f5-f63e-4d47-b9e4-84c02afeef82",
"CreationDate": "2026-01-10T00:45:23.5881264+00:00",
"CreatorUserId": "91baa7e7-a94d-4bcf-91a9-d7b4890cd3b6",
"Operator": 0,
"EvaluationType": 0,
"Value": "sample string 4",
"SubscriptionId": "a3c7042a-dfea-4dfa-b214-92f33fd0ae7b",
"TriggerPropertyTypeId": "16b01672-121d-4e52-be4f-128a2704c0f1"
}
],
"Subscribers": [
{
"Id": "907e2f19-7326-48d6-a564-cfbe94a8429e",
"CreationDate": "2026-01-10T00:45:23.5881264+00:00",
"CreatorUserId": "47b38213-7d8f-4b4c-b7ee-545c1f85263e",
"UserId": "0043dc1c-5d02-4f00-a8c9-657c2d201cab",
"SecurityGroupId": "524befc8-5302-4a1a-a6a8-5f301e778689",
"EmailAddress": "sample string 4",
"SubscriptionId": "faa66594-c609-4c2f-b2b4-c7dfcb7172ba",
"MapFromTriggerPropertyTypeId": "0d60868a-a8d9-44b8-8b9e-bf1bc83ed018"
},
{
"Id": "907e2f19-7326-48d6-a564-cfbe94a8429e",
"CreationDate": "2026-01-10T00:45:23.5881264+00:00",
"CreatorUserId": "47b38213-7d8f-4b4c-b7ee-545c1f85263e",
"UserId": "0043dc1c-5d02-4f00-a8c9-657c2d201cab",
"SecurityGroupId": "524befc8-5302-4a1a-a6a8-5f301e778689",
"EmailAddress": "sample string 4",
"SubscriptionId": "faa66594-c609-4c2f-b2b4-c7dfcb7172ba",
"MapFromTriggerPropertyTypeId": "0d60868a-a8d9-44b8-8b9e-bf1bc83ed018"
}
]
}
application/xml, text/xml
Sample:
<SubscriptionDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Aardvark.Notification.Models">
<Actions>
<SubscriptionActionDto>
<ActionTypeId>954c8192-24f8-44a4-8eec-8f9eb8a273de</ActionTypeId>
<CreationDate>2026-01-10T00:45:23.5881264+00:00</CreationDate>
<CreatorUserId>0e737f0f-c58c-473b-9210-0c7b82097227</CreatorUserId>
<Description>sample string 3</Description>
<Id>1606d7e0-8cd3-4b78-98f8-00e119dc2cc5</Id>
<IsDeleted>true</IsDeleted>
<Name>sample string 2</Name>
<Properties>
<SubscriptionActionPropertyDto>
<ActionId>d0b4108d-c4cf-41ca-ad48-c3421b0aa411</ActionId>
<CreationDate>2026-01-10T00:45:23.5881264+00:00</CreationDate>
<Id>a6af4530-26bb-4a2c-85bc-c3f43d3c60e9</Id>
<MapFromTriggerPropertyTypeId>ef7ce5e6-a1e6-4c3f-96d1-953b58130c8c</MapFromTriggerPropertyTypeId>
<Name>sample string 2</Name>
<PropertyTypeId>44f4cffa-c9d4-4274-a2f2-8e53c4b1892e</PropertyTypeId>
<Value>sample string 3</Value>
</SubscriptionActionPropertyDto>
<SubscriptionActionPropertyDto>
<ActionId>d0b4108d-c4cf-41ca-ad48-c3421b0aa411</ActionId>
<CreationDate>2026-01-10T00:45:23.5881264+00:00</CreationDate>
<Id>a6af4530-26bb-4a2c-85bc-c3f43d3c60e9</Id>
<MapFromTriggerPropertyTypeId>ef7ce5e6-a1e6-4c3f-96d1-953b58130c8c</MapFromTriggerPropertyTypeId>
<Name>sample string 2</Name>
<PropertyTypeId>44f4cffa-c9d4-4274-a2f2-8e53c4b1892e</PropertyTypeId>
<Value>sample string 3</Value>
</SubscriptionActionPropertyDto>
</Properties>
<Status>Pending</Status>
<SubscriptionId>b59fab77-ac69-499b-b562-b47ed07d9768</SubscriptionId>
</SubscriptionActionDto>
<SubscriptionActionDto>
<ActionTypeId>954c8192-24f8-44a4-8eec-8f9eb8a273de</ActionTypeId>
<CreationDate>2026-01-10T00:45:23.5881264+00:00</CreationDate>
<CreatorUserId>0e737f0f-c58c-473b-9210-0c7b82097227</CreatorUserId>
<Description>sample string 3</Description>
<Id>1606d7e0-8cd3-4b78-98f8-00e119dc2cc5</Id>
<IsDeleted>true</IsDeleted>
<Name>sample string 2</Name>
<Properties>
<SubscriptionActionPropertyDto>
<ActionId>d0b4108d-c4cf-41ca-ad48-c3421b0aa411</ActionId>
<CreationDate>2026-01-10T00:45:23.5881264+00:00</CreationDate>
<Id>a6af4530-26bb-4a2c-85bc-c3f43d3c60e9</Id>
<MapFromTriggerPropertyTypeId>ef7ce5e6-a1e6-4c3f-96d1-953b58130c8c</MapFromTriggerPropertyTypeId>
<Name>sample string 2</Name>
<PropertyTypeId>44f4cffa-c9d4-4274-a2f2-8e53c4b1892e</PropertyTypeId>
<Value>sample string 3</Value>
</SubscriptionActionPropertyDto>
<SubscriptionActionPropertyDto>
<ActionId>d0b4108d-c4cf-41ca-ad48-c3421b0aa411</ActionId>
<CreationDate>2026-01-10T00:45:23.5881264+00:00</CreationDate>
<Id>a6af4530-26bb-4a2c-85bc-c3f43d3c60e9</Id>
<MapFromTriggerPropertyTypeId>ef7ce5e6-a1e6-4c3f-96d1-953b58130c8c</MapFromTriggerPropertyTypeId>
<Name>sample string 2</Name>
<PropertyTypeId>44f4cffa-c9d4-4274-a2f2-8e53c4b1892e</PropertyTypeId>
<Value>sample string 3</Value>
</SubscriptionActionPropertyDto>
</Properties>
<Status>Pending</Status>
<SubscriptionId>b59fab77-ac69-499b-b562-b47ed07d9768</SubscriptionId>
</SubscriptionActionDto>
</Actions>
<Conditions>
<ConditionDto>
<CreationDate>2026-01-10T00:45:23.5881264+00:00</CreationDate>
<CreatorUserId>91baa7e7-a94d-4bcf-91a9-d7b4890cd3b6</CreatorUserId>
<EvaluationType>Forever</EvaluationType>
<Id>f8c434f5-f63e-4d47-b9e4-84c02afeef82</Id>
<Operator>Equals</Operator>
<SubscriptionId>a3c7042a-dfea-4dfa-b214-92f33fd0ae7b</SubscriptionId>
<TriggerPropertyTypeId>16b01672-121d-4e52-be4f-128a2704c0f1</TriggerPropertyTypeId>
<Value>sample string 4</Value>
</ConditionDto>
<ConditionDto>
<CreationDate>2026-01-10T00:45:23.5881264+00:00</CreationDate>
<CreatorUserId>91baa7e7-a94d-4bcf-91a9-d7b4890cd3b6</CreatorUserId>
<EvaluationType>Forever</EvaluationType>
<Id>f8c434f5-f63e-4d47-b9e4-84c02afeef82</Id>
<Operator>Equals</Operator>
<SubscriptionId>a3c7042a-dfea-4dfa-b214-92f33fd0ae7b</SubscriptionId>
<TriggerPropertyTypeId>16b01672-121d-4e52-be4f-128a2704c0f1</TriggerPropertyTypeId>
<Value>sample string 4</Value>
</ConditionDto>
</Conditions>
<CreationDate>2026-01-10T00:45:23.5881264+00:00</CreationDate>
<CreatorUserId>a870ebed-941d-40c6-9e84-f1970860fa64</CreatorUserId>
<Description>sample string 3</Description>
<Id>a5610796-5cbf-4631-876f-a43993c82536</Id>
<IsActive>true</IsActive>
<IsDeleted>true</IsDeleted>
<Name>sample string 2</Name>
<Subscribers>
<SubscriberDto>
<CreationDate>2026-01-10T00:45:23.5881264+00:00</CreationDate>
<CreatorUserId>47b38213-7d8f-4b4c-b7ee-545c1f85263e</CreatorUserId>
<EmailAddress>sample string 4</EmailAddress>
<Id>907e2f19-7326-48d6-a564-cfbe94a8429e</Id>
<MapFromTriggerPropertyTypeId>0d60868a-a8d9-44b8-8b9e-bf1bc83ed018</MapFromTriggerPropertyTypeId>
<SecurityGroupId>524befc8-5302-4a1a-a6a8-5f301e778689</SecurityGroupId>
<SubscriptionId>faa66594-c609-4c2f-b2b4-c7dfcb7172ba</SubscriptionId>
<UserId>0043dc1c-5d02-4f00-a8c9-657c2d201cab</UserId>
</SubscriberDto>
<SubscriberDto>
<CreationDate>2026-01-10T00:45:23.5881264+00:00</CreationDate>
<CreatorUserId>47b38213-7d8f-4b4c-b7ee-545c1f85263e</CreatorUserId>
<EmailAddress>sample string 4</EmailAddress>
<Id>907e2f19-7326-48d6-a564-cfbe94a8429e</Id>
<MapFromTriggerPropertyTypeId>0d60868a-a8d9-44b8-8b9e-bf1bc83ed018</MapFromTriggerPropertyTypeId>
<SecurityGroupId>524befc8-5302-4a1a-a6a8-5f301e778689</SecurityGroupId>
<SubscriptionId>faa66594-c609-4c2f-b2b4-c7dfcb7172ba</SubscriptionId>
<UserId>0043dc1c-5d02-4f00-a8c9-657c2d201cab</UserId>
</SubscriberDto>
</Subscribers>
<TenantIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>f785d1ee-dd3e-4796-93a1-d8d70865e5e2</d2p1:guid>
<d2p1:guid>32a69609-4119-4ec9-b536-b471729eef2d</d2p1:guid>
</TenantIds>
<TriggerTypeId>3961e075-c434-4bd3-b4ed-fec37249dc64</TriggerTypeId>
</SubscriptionDto>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
IHttpActionResultNone.
Response Formats
application/json, text/json, application/xml, text/xml
Sample:
Sample not available.