POST communication/SendContent

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
UserId	integer	None.
TenantId	integer	None.
messages	Collection of SendMessageRequest	None.
CampaignId	integer	None.
ScheduledDate	date	None.
HoursCategory	string	None.
MessageType	string	None.
ContentTemplateId	integer	None.
TicketId	integer	None.
CommsMethodId	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "UserId": 1,
  "TenantId": 2,
  "messages": [
    {
      "Id": 1,
      "Send": true,
      "SendTo": "sample string 3",
      "Body": "sample string 4",
      "Subject": "sample string 5",
      "ObjectType": "sample string 6",
      "ObjectId": 7,
      "CustId": 8,
      "MessageType": "sample string 9",
      "GridId": 10
    },
    {
      "Id": 1,
      "Send": true,
      "SendTo": "sample string 3",
      "Body": "sample string 4",
      "Subject": "sample string 5",
      "ObjectType": "sample string 6",
      "ObjectId": 7,
      "CustId": 8,
      "MessageType": "sample string 9",
      "GridId": 10
    }
  ],
  "CampaignId": 1,
  "ScheduledDate": "2026-04-17T11:34:01.6629881+00:00",
  "HoursCategory": "sample string 3",
  "MessageType": "sample string 4",
  "ContentTemplateId": 1,
  "TicketId": 1,
  "CommsMethodId": 1
}

text/html

Sample:

{"UserId":1,"TenantId":2,"messages":[{"Id":1,"Send":true,"SendTo":"sample string 3","Body":"sample string 4","Subject":"sample string 5","ObjectType":"sample string 6","ObjectId":7,"CustId":8,"MessageType":"sample string 9","GridId":10},{"Id":1,"Send":true,"SendTo":"sample string 3","Body":"sample string 4","Subject":"sample string 5","ObjectType":"sample string 6","ObjectId":7,"CustId":8,"MessageType":"sample string 9","GridId":10}],"CampaignId":1,"ScheduledDate":"2026-04-17T11:34:01.6629881+00:00","HoursCategory":"sample string 3","MessageType":"sample string 4","ContentTemplateId":1,"TicketId":1,"CommsMethodId":1}

application/xml, text/xml

Sample:

<SendMessageRequestWrapper xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Communication">
  <CampaignId>1</CampaignId>
  <CommsMethodId>1</CommsMethodId>
  <ContentTemplateId>1</ContentTemplateId>
  <HoursCategory>sample string 3</HoursCategory>
  <MessageType>sample string 4</MessageType>
  <ScheduledDate>2026-04-17T11:34:01.6629881+00:00</ScheduledDate>
  <TenantId>2</TenantId>
  <TicketId>1</TicketId>
  <UserId>1</UserId>
  <messages>
    <SendMessageRequest>
      <Body>sample string 4</Body>
      <CustId>8</CustId>
      <GridId>10</GridId>
      <Id>1</Id>
      <MessageType>sample string 9</MessageType>
      <ObjectId>7</ObjectId>
      <ObjectType>sample string 6</ObjectType>
      <Send>true</Send>
      <SendTo>sample string 3</SendTo>
      <Subject>sample string 5</Subject>
    </SendMessageRequest>
    <SendMessageRequest>
      <Body>sample string 4</Body>
      <CustId>8</CustId>
      <GridId>10</GridId>
      <Id>1</Id>
      <MessageType>sample string 9</MessageType>
      <ObjectId>7</ObjectId>
      <ObjectType>sample string 6</ObjectType>
      <Send>true</Send>
      <SendTo>sample string 3</SendTo>
      <Subject>sample string 5</Subject>
    </SendMessageRequest>
  </messages>
</SendMessageRequestWrapper>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SendMessageRequestWrapper'.

Response Information

Resource Description

Collection of SendMessageResult

Name	Type	Additional information
CommunicationId	integer	None.
StagedId	integer	None.
Status	string	None.
GridId	integer	None.
WasSuccessful	boolean	None.
Message	string	None.
RefId	integer	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CommunicationId": 1,
    "StagedId": 1,
    "Status": "sample string 1",
    "GridId": 2,
    "WasSuccessful": true,
    "Message": "sample string 4",
    "RefId": 5
  },
  {
    "CommunicationId": 1,
    "StagedId": 1,
    "Status": "sample string 1",
    "GridId": 2,
    "WasSuccessful": true,
    "Message": "sample string 4",
    "RefId": 5
  }
]

text/html

Sample:

[{"CommunicationId":1,"StagedId":1,"Status":"sample string 1","GridId":2,"WasSuccessful":true,"Message":"sample string 4","RefId":5},{"CommunicationId":1,"StagedId":1,"Status":"sample string 1","GridId":2,"WasSuccessful":true,"Message":"sample string 4","RefId":5}]

application/xml, text/xml

Sample:

<ArrayOfSendMessageResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Communication">
  <SendMessageResult>
    <Message xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Common">sample string 4</Message>
    <RefId xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Common">5</RefId>
    <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Common">true</WasSuccessful>
    <CommunicationId>1</CommunicationId>
    <GridId>2</GridId>
    <StagedId>1</StagedId>
    <Status>sample string 1</Status>
  </SendMessageResult>
  <SendMessageResult>
    <Message xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Common">sample string 4</Message>
    <RefId xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Common">5</RefId>
    <WasSuccessful xmlns="http://schemas.datacontract.org/2004/07/ListenerOnline.BusinessEntities.Common">true</WasSuccessful>
    <CommunicationId>1</CommunicationId>
    <GridId>2</GridId>
    <StagedId>1</StagedId>
    <Status>sample string 1</Status>
  </SendMessageResult>
</ArrayOfSendMessageResult>