TicketUserServices

OutboundCampaignCreateRequest

**Requires Authentication**
Required role:	Admin

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

**OutboundCampaignCreateRequest** Parameters:
Name	Parameter	Data Type	Required
OwnerId	body	int	No
Name	body	string	No
Lane	body	string	No
TemplateKey	body	string	No
PayloadJson	body	string	No
ChannelOrder	body	string	No
HoldoutPercent	body	int?	No
GuardKey	body	string	No
GuardSubject	body	string	No
SendAt	body	DateTime?	No
ExpiresAt	body	DateTime?	No
AudienceSource	body	string	No
People	body	List<OutboundCampaignPerson>	No

**OutboundCampaignPerson** Parameters:
Name	Parameter	Data Type	Required
Phone	form	string	No
Email	form	string	No
Devices	form	List<OutboundCampaignDevice>	No
PushConsent	form	bool?	No
SmsConsent	form	bool?	No
EmailConsent	form	bool?	No
PayloadJson	form	string	No

**OutboundCampaignDevice** Parameters:
Name	Parameter	Data Type	Required	Description
Token	form	string	No
Platform	form	string	No

**OutboundCampaignResult** Parameters:
Name	Parameter	Data Type	Required
CampaignId	form	int	No
Decisions	form	Dictionary<string, int>	No
QueuedByChannel	form	Dictionary<string, int>	No
MessageStatuses	form	Dictionary<string, int>	No
Duplicates	form	int	No
NoIdentity	form	int	No
StatusCode	form	int	No
Message	form	string	No

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

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