TicketUserServices

OutboundCampaignCreateRequest

**Requires Authentication**
Required role:	Admin

The following routes are available for this service:
POST	/Outbound/Campaigns

import Foundation
import ServiceStack

public class OutboundCampaignCreateRequest : Codable
{
    public var ownerId:Int?
    public var name:String?
    public var lane:String?
    public var templateKey:String?
    public var payloadJson:String?
    public var channelOrder:String?
    public var holdoutPercent:Int?
    public var guardKey:String?
    public var guardSubject:String?
    public var sendAt:Date?
    public var expiresAt:Date?
    public var audienceSource:String?
    public var people:[OutboundCampaignPerson] = []

    required public init(){}
}

public class OutboundCampaignPerson : Codable
{
    public var phone:String?
    public var email:String?
    public var devices:[OutboundCampaignDevice] = []
    public var pushConsent:Bool?
    public var smsConsent:Bool?
    public var emailConsent:Bool?
    public var payloadJson:String?

    required public init(){}
}

public class OutboundCampaignDevice : Codable
{
    public var token:String?
    public var platform:String?

    required public init(){}
}

public class OutboundCampaignResult : Codable
{
    public var campaignId:Int?
    public var decisions:[String:Int] = [:]
    public var queuedByChannel:[String:Int] = [:]
    public var messageStatuses:[String:Int] = [:]
    public var duplicates:Int?
    public var noIdentity:Int?
    public var statusCode:Int?
    public var message:String?

    required public init(){}
}

Swift OutboundCampaignCreateRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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
}