| Required role: | Admin |
| POST | /Outbound/Campaigns |
|---|
namespace TicketUserServices.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type OutboundCampaignResult() =
member val CampaignId:Int32 = new Int32() with get,set
member val Decisions:Dictionary<String, Int32> = new Dictionary<String, Int32>() with get,set
member val QueuedByChannel:Dictionary<String, Int32> = new Dictionary<String, Int32>() with get,set
member val MessageStatuses:Dictionary<String, Int32> = new Dictionary<String, Int32>() with get,set
member val Duplicates:Int32 = new Int32() with get,set
member val NoIdentity:Int32 = new Int32() with get,set
member val StatusCode:Int32 = new Int32() with get,set
member val Message:String = null with get,set
[<AllowNullLiteral>]
type OutboundCampaignDevice() =
member val Token:String = null with get,set
member val Platform:String = null with get,set
[<AllowNullLiteral>]
type OutboundCampaignPerson() =
member val Phone:String = null with get,set
member val Email:String = null with get,set
member val Devices:ResizeArray<OutboundCampaignDevice> = new ResizeArray<OutboundCampaignDevice>() with get,set
member val PushConsent:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val SmsConsent:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val EmailConsent:Nullable<Boolean> = new Nullable<Boolean>() with get,set
member val PayloadJson:String = null with get,set
[<AllowNullLiteral>]
type OutboundCampaignCreateRequest() =
member val OwnerId:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val Lane:String = null with get,set
member val TemplateKey:String = null with get,set
member val PayloadJson:String = null with get,set
member val ChannelOrder:String = null with get,set
member val HoldoutPercent:Nullable<Int32> = new Nullable<Int32>() with get,set
member val GuardKey:String = null with get,set
member val GuardSubject:String = null with get,set
member val SendAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val ExpiresAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val AudienceSource:String = null with get,set
member val People:ResizeArray<OutboundCampaignPerson> = new ResizeArray<OutboundCampaignPerson>() with get,set
F# OutboundCampaignCreateRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Outbound/Campaigns HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ownerId: 0,
name: String,
lane: String,
templateKey: String,
payloadJson: String,
channelOrder: String,
holdoutPercent: 0,
guardKey: String,
guardSubject: String,
sendAt: 0001-01-01,
expiresAt: 0001-01-01,
audienceSource: String,
people:
[
{
phone: String,
email: String,
devices:
[
{
token: String,
platform: String
}
],
pushConsent: False,
smsConsent: False,
emailConsent: False,
payloadJson: String
}
]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
campaignId: 0,
decisions:
{
String: 0
},
queuedByChannel:
{
String: 0
},
messageStatuses:
{
String: 0
},
duplicates: 0,
noIdentity: 0,
statusCode: 0,
message: String
}