POST api/Subscriptions

Creates a new subscription.

Request Information

URI Parameters

None.

Body Parameters

The subscription model to create with.

Name	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": "52e64669-d99d-4d90-a8cd-c61c813399ec",
  "Name": "sample string 2",
  "Description": "sample string 3",
  "CreationDate": "2025-12-11T20:16:37.3032647+00:00",
  "CreatorUserId": "461fbb39-d886-4aec-bb03-753020285f54",
  "IsActive": true,
  "IsDeleted": true,
  "TriggerTypeId": "b1c9740b-ca5f-4506-a54c-62b75c837482",
  "TenantIds": [
    "bec1a664-a389-4460-9a6d-9bd0f485e36f",
    "c109cc3e-e1b3-4cc9-9d52-a50ecf4fa5e8"
  ],
  "Actions": [
    {
      "Id": "9437ff2d-11e9-425a-9531-06244f10b2ec",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Status": 0,
      "CreationDate": "2025-12-11T20:16:37.3032647+00:00",
      "CreatorUserId": "a491d257-729d-4224-997d-a7146787e9d5",
      "IsDeleted": true,
      "Properties": [
        {
          "Id": "b2401a80-2317-41f7-9fc3-906d230b8609",
          "Name": "sample string 2",
          "Value": "sample string 3",
          "CreationDate": "2025-12-11T20:16:37.3032647+00:00",
          "ActionId": "78b2e492-7f50-4443-8789-464a79ff9100",
          "PropertyTypeId": "4c3ec70d-2436-4758-af28-c88e258fed72",
          "MapFromTriggerPropertyTypeId": "54ce5880-2fc3-4ef7-86d1-960d9b3e0688"
        },
        {
          "Id": "b2401a80-2317-41f7-9fc3-906d230b8609",
          "Name": "sample string 2",
          "Value": "sample string 3",
          "CreationDate": "2025-12-11T20:16:37.3032647+00:00",
          "ActionId": "78b2e492-7f50-4443-8789-464a79ff9100",
          "PropertyTypeId": "4c3ec70d-2436-4758-af28-c88e258fed72",
          "MapFromTriggerPropertyTypeId": "54ce5880-2fc3-4ef7-86d1-960d9b3e0688"
        }
      ],
      "SubscriptionId": "a1c2c07c-0f53-4359-b05e-c18a929203c5",
      "ActionTypeId": "f09446a8-6a7a-4891-86fb-4cb9465e0249"
    },
    {
      "Id": "9437ff2d-11e9-425a-9531-06244f10b2ec",
      "Name": "sample string 2",
      "Description": "sample string 3",
      "Status": 0,
      "CreationDate": "2025-12-11T20:16:37.3032647+00:00",
      "CreatorUserId": "a491d257-729d-4224-997d-a7146787e9d5",
      "IsDeleted": true,
      "Properties": [
        {
          "Id": "b2401a80-2317-41f7-9fc3-906d230b8609",
          "Name": "sample string 2",
          "Value": "sample string 3",
          "CreationDate": "2025-12-11T20:16:37.3032647+00:00",
          "ActionId": "78b2e492-7f50-4443-8789-464a79ff9100",
          "PropertyTypeId": "4c3ec70d-2436-4758-af28-c88e258fed72",
          "MapFromTriggerPropertyTypeId": "54ce5880-2fc3-4ef7-86d1-960d9b3e0688"
        },
        {
          "Id": "b2401a80-2317-41f7-9fc3-906d230b8609",
          "Name": "sample string 2",
          "Value": "sample string 3",
          "CreationDate": "2025-12-11T20:16:37.3032647+00:00",
          "ActionId": "78b2e492-7f50-4443-8789-464a79ff9100",
          "PropertyTypeId": "4c3ec70d-2436-4758-af28-c88e258fed72",
          "MapFromTriggerPropertyTypeId": "54ce5880-2fc3-4ef7-86d1-960d9b3e0688"
        }
      ],
      "SubscriptionId": "a1c2c07c-0f53-4359-b05e-c18a929203c5",
      "ActionTypeId": "f09446a8-6a7a-4891-86fb-4cb9465e0249"
    }
  ],
  "Conditions": [
    {
      "Id": "9c5ab030-b3f2-409f-b2c9-cfd8d26f05f9",
      "CreationDate": "2025-12-11T20:16:37.3032647+00:00",
      "CreatorUserId": "7e3324dc-7018-40b6-a073-a529e17876fd",
      "Operator": 0,
      "EvaluationType": 0,
      "Value": "sample string 4",
      "SubscriptionId": "58b18966-be28-4ab1-992c-23c6c9d19dfa",
      "TriggerPropertyTypeId": "6a8c88e5-0be4-48ce-8254-79782ee4518f"
    },
    {
      "Id": "9c5ab030-b3f2-409f-b2c9-cfd8d26f05f9",
      "CreationDate": "2025-12-11T20:16:37.3032647+00:00",
      "CreatorUserId": "7e3324dc-7018-40b6-a073-a529e17876fd",
      "Operator": 0,
      "EvaluationType": 0,
      "Value": "sample string 4",
      "SubscriptionId": "58b18966-be28-4ab1-992c-23c6c9d19dfa",
      "TriggerPropertyTypeId": "6a8c88e5-0be4-48ce-8254-79782ee4518f"
    }
  ],
  "Subscribers": [
    {
      "Id": "6c0c9fc1-2ff6-4d23-aeba-a47ddbb45e2e",
      "CreationDate": "2025-12-11T20:16:37.3032647+00:00",
      "CreatorUserId": "dc63da0d-7534-42cd-8bc2-7f2c6ec2c674",
      "UserId": "b03a28cc-fe91-4eb0-a6c8-63592fb1a5c8",
      "SecurityGroupId": "bcc2d92b-8929-4176-a8c0-85caca534c61",
      "EmailAddress": "sample string 4",
      "SubscriptionId": "8ea301a9-4a19-480c-b190-7025d54191e2",
      "MapFromTriggerPropertyTypeId": "dfa6dae1-4667-4ba8-b3b0-49f88ad9e656"
    },
    {
      "Id": "6c0c9fc1-2ff6-4d23-aeba-a47ddbb45e2e",
      "CreationDate": "2025-12-11T20:16:37.3032647+00:00",
      "CreatorUserId": "dc63da0d-7534-42cd-8bc2-7f2c6ec2c674",
      "UserId": "b03a28cc-fe91-4eb0-a6c8-63592fb1a5c8",
      "SecurityGroupId": "bcc2d92b-8929-4176-a8c0-85caca534c61",
      "EmailAddress": "sample string 4",
      "SubscriptionId": "8ea301a9-4a19-480c-b190-7025d54191e2",
      "MapFromTriggerPropertyTypeId": "dfa6dae1-4667-4ba8-b3b0-49f88ad9e656"
    }
  ]
}

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>f09446a8-6a7a-4891-86fb-4cb9465e0249</ActionTypeId>
      <CreationDate>2025-12-11T20:16:37.3032647+00:00</CreationDate>
      <CreatorUserId>a491d257-729d-4224-997d-a7146787e9d5</CreatorUserId>
      <Description>sample string 3</Description>
      <Id>9437ff2d-11e9-425a-9531-06244f10b2ec</Id>
      <IsDeleted>true</IsDeleted>
      <Name>sample string 2</Name>
      <Properties>
        <SubscriptionActionPropertyDto>
          <ActionId>78b2e492-7f50-4443-8789-464a79ff9100</ActionId>
          <CreationDate>2025-12-11T20:16:37.3032647+00:00</CreationDate>
          <Id>b2401a80-2317-41f7-9fc3-906d230b8609</Id>
          <MapFromTriggerPropertyTypeId>54ce5880-2fc3-4ef7-86d1-960d9b3e0688</MapFromTriggerPropertyTypeId>
          <Name>sample string 2</Name>
          <PropertyTypeId>4c3ec70d-2436-4758-af28-c88e258fed72</PropertyTypeId>
          <Value>sample string 3</Value>
        </SubscriptionActionPropertyDto>
        <SubscriptionActionPropertyDto>
          <ActionId>78b2e492-7f50-4443-8789-464a79ff9100</ActionId>
          <CreationDate>2025-12-11T20:16:37.3032647+00:00</CreationDate>
          <Id>b2401a80-2317-41f7-9fc3-906d230b8609</Id>
          <MapFromTriggerPropertyTypeId>54ce5880-2fc3-4ef7-86d1-960d9b3e0688</MapFromTriggerPropertyTypeId>
          <Name>sample string 2</Name>
          <PropertyTypeId>4c3ec70d-2436-4758-af28-c88e258fed72</PropertyTypeId>
          <Value>sample string 3</Value>
        </SubscriptionActionPropertyDto>
      </Properties>
      <Status>Pending</Status>
      <SubscriptionId>a1c2c07c-0f53-4359-b05e-c18a929203c5</SubscriptionId>
    </SubscriptionActionDto>
    <SubscriptionActionDto>
      <ActionTypeId>f09446a8-6a7a-4891-86fb-4cb9465e0249</ActionTypeId>
      <CreationDate>2025-12-11T20:16:37.3032647+00:00</CreationDate>
      <CreatorUserId>a491d257-729d-4224-997d-a7146787e9d5</CreatorUserId>
      <Description>sample string 3</Description>
      <Id>9437ff2d-11e9-425a-9531-06244f10b2ec</Id>
      <IsDeleted>true</IsDeleted>
      <Name>sample string 2</Name>
      <Properties>
        <SubscriptionActionPropertyDto>
          <ActionId>78b2e492-7f50-4443-8789-464a79ff9100</ActionId>
          <CreationDate>2025-12-11T20:16:37.3032647+00:00</CreationDate>
          <Id>b2401a80-2317-41f7-9fc3-906d230b8609</Id>
          <MapFromTriggerPropertyTypeId>54ce5880-2fc3-4ef7-86d1-960d9b3e0688</MapFromTriggerPropertyTypeId>
          <Name>sample string 2</Name>
          <PropertyTypeId>4c3ec70d-2436-4758-af28-c88e258fed72</PropertyTypeId>
          <Value>sample string 3</Value>
        </SubscriptionActionPropertyDto>
        <SubscriptionActionPropertyDto>
          <ActionId>78b2e492-7f50-4443-8789-464a79ff9100</ActionId>
          <CreationDate>2025-12-11T20:16:37.3032647+00:00</CreationDate>
          <Id>b2401a80-2317-41f7-9fc3-906d230b8609</Id>
          <MapFromTriggerPropertyTypeId>54ce5880-2fc3-4ef7-86d1-960d9b3e0688</MapFromTriggerPropertyTypeId>
          <Name>sample string 2</Name>
          <PropertyTypeId>4c3ec70d-2436-4758-af28-c88e258fed72</PropertyTypeId>
          <Value>sample string 3</Value>
        </SubscriptionActionPropertyDto>
      </Properties>
      <Status>Pending</Status>
      <SubscriptionId>a1c2c07c-0f53-4359-b05e-c18a929203c5</SubscriptionId>
    </SubscriptionActionDto>
  </Actions>
  <Conditions>
    <ConditionDto>
      <CreationDate>2025-12-11T20:16:37.3032647+00:00</CreationDate>
      <CreatorUserId>7e3324dc-7018-40b6-a073-a529e17876fd</CreatorUserId>
      <EvaluationType>Forever</EvaluationType>
      <Id>9c5ab030-b3f2-409f-b2c9-cfd8d26f05f9</Id>
      <Operator>Equals</Operator>
      <SubscriptionId>58b18966-be28-4ab1-992c-23c6c9d19dfa</SubscriptionId>
      <TriggerPropertyTypeId>6a8c88e5-0be4-48ce-8254-79782ee4518f</TriggerPropertyTypeId>
      <Value>sample string 4</Value>
    </ConditionDto>
    <ConditionDto>
      <CreationDate>2025-12-11T20:16:37.3032647+00:00</CreationDate>
      <CreatorUserId>7e3324dc-7018-40b6-a073-a529e17876fd</CreatorUserId>
      <EvaluationType>Forever</EvaluationType>
      <Id>9c5ab030-b3f2-409f-b2c9-cfd8d26f05f9</Id>
      <Operator>Equals</Operator>
      <SubscriptionId>58b18966-be28-4ab1-992c-23c6c9d19dfa</SubscriptionId>
      <TriggerPropertyTypeId>6a8c88e5-0be4-48ce-8254-79782ee4518f</TriggerPropertyTypeId>
      <Value>sample string 4</Value>
    </ConditionDto>
  </Conditions>
  <CreationDate>2025-12-11T20:16:37.3032647+00:00</CreationDate>
  <CreatorUserId>461fbb39-d886-4aec-bb03-753020285f54</CreatorUserId>
  <Description>sample string 3</Description>
  <Id>52e64669-d99d-4d90-a8cd-c61c813399ec</Id>
  <IsActive>true</IsActive>
  <IsDeleted>true</IsDeleted>
  <Name>sample string 2</Name>
  <Subscribers>
    <SubscriberDto>
      <CreationDate>2025-12-11T20:16:37.3032647+00:00</CreationDate>
      <CreatorUserId>dc63da0d-7534-42cd-8bc2-7f2c6ec2c674</CreatorUserId>
      <EmailAddress>sample string 4</EmailAddress>
      <Id>6c0c9fc1-2ff6-4d23-aeba-a47ddbb45e2e</Id>
      <MapFromTriggerPropertyTypeId>dfa6dae1-4667-4ba8-b3b0-49f88ad9e656</MapFromTriggerPropertyTypeId>
      <SecurityGroupId>bcc2d92b-8929-4176-a8c0-85caca534c61</SecurityGroupId>
      <SubscriptionId>8ea301a9-4a19-480c-b190-7025d54191e2</SubscriptionId>
      <UserId>b03a28cc-fe91-4eb0-a6c8-63592fb1a5c8</UserId>
    </SubscriberDto>
    <SubscriberDto>
      <CreationDate>2025-12-11T20:16:37.3032647+00:00</CreationDate>
      <CreatorUserId>dc63da0d-7534-42cd-8bc2-7f2c6ec2c674</CreatorUserId>
      <EmailAddress>sample string 4</EmailAddress>
      <Id>6c0c9fc1-2ff6-4d23-aeba-a47ddbb45e2e</Id>
      <MapFromTriggerPropertyTypeId>dfa6dae1-4667-4ba8-b3b0-49f88ad9e656</MapFromTriggerPropertyTypeId>
      <SecurityGroupId>bcc2d92b-8929-4176-a8c0-85caca534c61</SecurityGroupId>
      <SubscriptionId>8ea301a9-4a19-480c-b190-7025d54191e2</SubscriptionId>
      <UserId>b03a28cc-fe91-4eb0-a6c8-63592fb1a5c8</UserId>
    </SubscriberDto>
  </Subscribers>
  <TenantIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>bec1a664-a389-4460-9a6d-9bd0f485e36f</d2p1:guid>
    <d2p1:guid>c109cc3e-e1b3-4cc9-9d52-a50ecf4fa5e8</d2p1:guid>
  </TenantIds>
  <TriggerTypeId>b1c9740b-ca5f-4506-a54c-62b75c837482</TriggerTypeId>
</SubscriptionDto>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.