TicketUserServices

OutboundEnqueueBatchRequest

**Requires Authentication**
Required role:	Admin

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

**OutboundEnqueueBatchRequest** Parameters:
Name	Parameter	Data Type	Required	Description
Messages	body	List<OutboundEnqueueRequest>	No

**OutboundEnqueueRequest** Parameters:
Name	Parameter	Data Type	Required
Channel	form	string	No
Lane	form	string	No
Priority	form	int	No
Address	form	string	No
Platform	form	string	No
RecipientKey	form	string	No
TemplateKey	form	string	No
Language	form	string	No
PayloadJson	form	string	No
DedupKey	form	string	No
CampaignId	form	int?	No
OwnerId	form	int?	No
GuardKey	form	string	No
GuardSubject	form	string	No
NotBefore	form	DateTime?	No
ExpiresAt	form	DateTime?	No

**OutboundEnqueueBatchResult** Parameters:
Name	Parameter	Data Type	Required
Enqueued	form	int	No
Duplicate	form	int	No
Rejected	form	int	No
Rejections	form	List<OutboundEnqueueBatchRejection>	No
StatusCode	form	int	No
Message	form	string	No

**OutboundEnqueueBatchRejection** Parameters:
Name	Parameter	Data Type	Required
Index	form	int	No
DedupKey	form	string	No
Reason	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/EnqueueBatch HTTP/1.1 
Host: stubbur-app.azurewebsites.net 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<OutboundEnqueueBatchRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Messages>
    <OutboundEnqueueRequest>
      <Address>String</Address>
      <CampaignId>0</CampaignId>
      <Channel>String</Channel>
      <DedupKey>String</DedupKey>
      <ExpiresAt>0001-01-01T00:00:00</ExpiresAt>
      <GuardKey>String</GuardKey>
      <GuardSubject>String</GuardSubject>
      <Lane>String</Lane>
      <Language>String</Language>
      <NotBefore>0001-01-01T00:00:00</NotBefore>
      <OwnerId>0</OwnerId>
      <PayloadJson>String</PayloadJson>
      <Platform>String</Platform>
      <Priority>0</Priority>
      <RecipientKey>String</RecipientKey>
      <TemplateKey>String</TemplateKey>
    </OutboundEnqueueRequest>
  </Messages>
</OutboundEnqueueBatchRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OutboundEnqueueBatchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TicketUserServices.ServiceModel">
  <Duplicate>0</Duplicate>
  <Enqueued>0</Enqueued>
  <Message>String</Message>
  <Rejected>0</Rejected>
  <Rejections>
    <OutboundEnqueueBatchRejection>
      <DedupKey>String</DedupKey>
      <Index>0</Index>
      <Reason>String</Reason>
    </OutboundEnqueueBatchRejection>
  </Rejections>
  <StatusCode>0</StatusCode>
</OutboundEnqueueBatchResult>