| Required role: | Admin |
| POST | /Outbound/Campaigns |
|---|
import java.math.*
import java.util.*
import net.servicestack.client.*
open class OutboundCampaignCreateRequest
{
var ownerId:Int? = null
var name:String? = null
var lane:String? = null
var templateKey:String? = null
var payloadJson:String? = null
var channelOrder:String? = null
var holdoutPercent:Int? = null
var guardKey:String? = null
var guardSubject:String? = null
var sendAt:Date? = null
var expiresAt:Date? = null
var audienceSource:String? = null
var people:ArrayList<OutboundCampaignPerson> = ArrayList<OutboundCampaignPerson>()
}
open class OutboundCampaignPerson
{
var phone:String? = null
var email:String? = null
var devices:ArrayList<OutboundCampaignDevice> = ArrayList<OutboundCampaignDevice>()
var pushConsent:Boolean? = null
var smsConsent:Boolean? = null
var emailConsent:Boolean? = null
var payloadJson:String? = null
}
open class OutboundCampaignDevice
{
var token:String? = null
var platform:String? = null
}
open class OutboundCampaignResult
{
var campaignId:Int? = null
var decisions:HashMap<String,Int> = HashMap<String,Int>()
var queuedByChannel:HashMap<String,Int> = HashMap<String,Int>()
var messageStatuses:HashMap<String,Int> = HashMap<String,Int>()
var duplicates:Int? = null
var noIdentity:Int? = null
var statusCode:Int? = null
var message:String? = null
}
Kotlin OutboundCampaignCreateRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<OutboundCampaignCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
<AudienceSource>String</AudienceSource>
<ChannelOrder>String</ChannelOrder>
<ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
<GuardKey>String</GuardKey>
<GuardSubject>String</GuardSubject>
<HoldoutPercent>0</HoldoutPercent>
<Lane>String</Lane>
<Name>String</Name>
<OwnerId>0</OwnerId>
<PayloadJson>String</PayloadJson>
<People>
<OutboundCampaignPerson>
<Devices>
<OutboundCampaignDevice>
<Platform>String</Platform>
<Token>String</Token>
</OutboundCampaignDevice>
</Devices>
<Email>String</Email>
<EmailConsent>false</EmailConsent>
<PayloadJson>String</PayloadJson>
<Phone>String</Phone>
<PushConsent>false</PushConsent>
<SmsConsent>false</SmsConsent>
</OutboundCampaignPerson>
</People>
<SendAt>0001-01-01T00:00:00</SendAt>
<TemplateKey>String</TemplateKey>
</OutboundCampaignCreateRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<OutboundCampaignResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
<CampaignId>0</CampaignId>
<Decisions xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringint>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>0</d2p1:Value>
</d2p1:KeyValueOfstringint>
</Decisions>
<Duplicates>0</Duplicates>
<Message>String</Message>
<MessageStatuses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringint>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>0</d2p1:Value>
</d2p1:KeyValueOfstringint>
</MessageStatuses>
<NoIdentity>0</NoIdentity>
<QueuedByChannel xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringint>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>0</d2p1:Value>
</d2p1:KeyValueOfstringint>
</QueuedByChannel>
<StatusCode>0</StatusCode>
</OutboundCampaignResult>