POST api/v1/notificationConfigs

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	globally unique identifier	None.
Name	string	None.
Code	string	None.
Subject	string	None.
Body	string	None.
BodyHtml	string	None.
IsActive	boolean	None.
DefaultRecipient	string	None.
TemplateCommunicationCode	string	None.
TemplateCommunicationUrl	string	None.
ChannelCommunicationCode	string	None.
OrganizationCode	string	None.
MaxDeliveries	integer	None.
MaxGroupDeliveries	integer	None.
MaxDeliveriesTimesSpan	integer	None.
MaxGroupDeliveriesTimesSpan	integer	None.
ActiveOnVisitTimeSpan	integer	None.
ActiveOnVisitUpper	integer	None.
ActiveOnVisitLower	integer	None.
ActiveOnVisitEqual	integer	None.
ActiveOnVisitDuration	integer	None.
NotificationConfigType	NotificationConfigType	None.
NotificationConfigGroupCode	string	None.
SegmentCodes	Collection of string	None.
ZoneCodes	Collection of string	None.
ZoneGroupCodes	Collection of string	None.
PlaceCodes	Collection of string	None.

Request Formats

application/json, text/json

Sample:

{
  "id": "026cbf03-744e-496f-a5b0-4cf861fdb425",
  "name": "sample string 2",
  "code": "sample string 3",
  "subject": "sample string 4",
  "body": "sample string 5",
  "bodyHtml": "sample string 6",
  "isActive": true,
  "defaultRecipient": "sample string 8",
  "templateCommunicationCode": "sample string 9",
  "templateCommunicationUrl": "sample string 10",
  "channelCommunicationCode": "sample string 11",
  "organizationCode": "sample string 12",
  "maxDeliveries": 1,
  "maxGroupDeliveries": 1,
  "maxDeliveriesTimesSpan": 1,
  "maxGroupDeliveriesTimesSpan": 1,
  "activeOnVisitTimeSpan": 1,
  "activeOnVisitUpper": 1,
  "activeOnVisitLower": 1,
  "activeOnVisitEqual": 1,
  "activeOnVisitDuration": 1,
  "notificationConfigType": 0,
  "notificationConfigGroupCode": "sample string 13",
  "segmentCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "zoneCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "zoneGroupCodes": [
    "sample string 1",
    "sample string 2"
  ],
  "placeCodes": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:

<NotificationConfigDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Domain.Dtos">
  <ActiveOnVisitDuration>1</ActiveOnVisitDuration>
  <ActiveOnVisitEqual>1</ActiveOnVisitEqual>
  <ActiveOnVisitLower>1</ActiveOnVisitLower>
  <ActiveOnVisitTimeSpan>1</ActiveOnVisitTimeSpan>
  <ActiveOnVisitUpper>1</ActiveOnVisitUpper>
  <Body>sample string 5</Body>
  <BodyHtml>sample string 6</BodyHtml>
  <ChannelCommunicationCode>sample string 11</ChannelCommunicationCode>
  <Code>sample string 3</Code>
  <DefaultRecipient>sample string 8</DefaultRecipient>
  <Id>026cbf03-744e-496f-a5b0-4cf861fdb425</Id>
  <IsActive>true</IsActive>
  <MaxDeliveries>1</MaxDeliveries>
  <MaxDeliveriesTimesSpan>1</MaxDeliveriesTimesSpan>
  <MaxGroupDeliveries>1</MaxGroupDeliveries>
  <MaxGroupDeliveriesTimesSpan>1</MaxGroupDeliveriesTimesSpan>
  <Name>sample string 2</Name>
  <NotificationConfigGroupCode>sample string 13</NotificationConfigGroupCode>
  <NotificationConfigType>Default</NotificationConfigType>
  <OrganizationCode>sample string 12</OrganizationCode>
  <PlaceCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PlaceCodes>
  <SegmentCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </SegmentCodes>
  <Subject>sample string 4</Subject>
  <TemplateCommunicationCode>sample string 9</TemplateCommunicationCode>
  <TemplateCommunicationUrl>sample string 10</TemplateCommunicationUrl>
  <ZoneCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ZoneCodes>
  <ZoneGroupCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ZoneGroupCodes>
</NotificationConfigDto>

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.