POST example/api/mailstatistics/GetNotSentDueToPreviousOptOutByPreviousOptOutId

https://app.bwz.se/bedrock/example/api/mailstatistics/GetNotSentDueToPreviousOptOutByPreviousOptOutId

Gets the recipients an email message was not sent to due to previous optout.

Request Information

URI Parameters

None.

Body Parameters

Max number of recipients to get.

Name	Description	Type	Additional information
FromId	Id of the first recipient to be returned.	integer	Required
BatchSize	Max number of recipients to get.	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "FromId": 1,
  "BatchSize": 2
}

application/xml, text/xml

Sample:

<GetNotSentDueToPreviousOptOutArgs xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailStatistics">
  <BatchSize>2</BatchSize>
  <FromId>1</FromId>
</GetNotSentDueToPreviousOptOutArgs>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

An array of MailMessageNotSentDueToPreviousBounceModels.

Collection of MailMessageNotSentDueToPreviousBounceModel

Name	Description	Type	Additional information
Id	Gets or sets the id.	integer	None.
MailRecipientModel	Gets or sets the MailRecipientModel the email message was not sent to.	MailRecipientModel	None.
MailMessageQueueId	Gets or sets the id of the MailMessageQueue.	integer	None.
CreationDate	Gets or sets the date and time the email message was not sent to the recipient.	date	None.
NotSentStatus	Gets or sets the reason the email message was not sent to the recipient.	MailMessageSendInfoStatus	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "MailRecipientModel": {
      "CreatedByUserId": 1,
      "CreationDate": "2024-11-21T17:04:31.3724546+01:00",
      "Email": "sample string 3",
      "Id": 4,
      "RecipientEntrySource": "sample string 5",
      "Properties": [
        {
          "Name": "sample string 1",
          "Value": {}
        },
        {
          "Name": "sample string 1",
          "Value": {}
        }
      ]
    },
    "MailMessageQueueId": 2,
    "CreationDate": "2024-11-21T17:04:31.3724546+01:00",
    "NotSentStatus": 0
  },
  {
    "Id": 1,
    "MailRecipientModel": {
      "CreatedByUserId": 1,
      "CreationDate": "2024-11-21T17:04:31.3724546+01:00",
      "Email": "sample string 3",
      "Id": 4,
      "RecipientEntrySource": "sample string 5",
      "Properties": [
        {
          "Name": "sample string 1",
          "Value": {}
        },
        {
          "Name": "sample string 1",
          "Value": {}
        }
      ]
    },
    "MailMessageQueueId": 2,
    "CreationDate": "2024-11-21T17:04:31.3724546+01:00",
    "NotSentStatus": 0
  }
]

application/xml, text/xml

Sample:

<ArrayOfMailMessageNotSentDueToPreviousBounceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailStatistics">
  <MailMessageNotSentDueToPreviousBounceModel>
    <CreationDate>2024-11-21T17:04:31.3724546+01:00</CreationDate>
    <Id>1</Id>
    <MailMessageQueueId>2</MailMessageQueueId>
    <MailRecipientModel xmlns:d3p1="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailRecipient">
      <d3p1:CreatedByUserId>1</d3p1:CreatedByUserId>
      <d3p1:CreationDate>2024-11-21T17:04:31.3724546+01:00</d3p1:CreationDate>
      <d3p1:Email>sample string 3</d3p1:Email>
      <d3p1:Id>4</d3p1:Id>
      <d3p1:Properties>
        <d3p1:PropertyValueModel>
          <d3p1:Name>sample string 1</d3p1:Name>
          <d3p1:Value />
        </d3p1:PropertyValueModel>
        <d3p1:PropertyValueModel>
          <d3p1:Name>sample string 1</d3p1:Name>
          <d3p1:Value />
        </d3p1:PropertyValueModel>
      </d3p1:Properties>
      <d3p1:RecipientEntrySource>sample string 5</d3p1:RecipientEntrySource>
    </MailRecipientModel>
    <NotSentStatus>UNPROCESSED</NotSentStatus>
  </MailMessageNotSentDueToPreviousBounceModel>
  <MailMessageNotSentDueToPreviousBounceModel>
    <CreationDate>2024-11-21T17:04:31.3724546+01:00</CreationDate>
    <Id>1</Id>
    <MailMessageQueueId>2</MailMessageQueueId>
    <MailRecipientModel xmlns:d3p1="http://schemas.datacontract.org/2004/07/Netoptions.BizWizard.Api.Common.Models.MailRecipient">
      <d3p1:CreatedByUserId>1</d3p1:CreatedByUserId>
      <d3p1:CreationDate>2024-11-21T17:04:31.3724546+01:00</d3p1:CreationDate>
      <d3p1:Email>sample string 3</d3p1:Email>
      <d3p1:Id>4</d3p1:Id>
      <d3p1:Properties>
        <d3p1:PropertyValueModel>
          <d3p1:Name>sample string 1</d3p1:Name>
          <d3p1:Value />
        </d3p1:PropertyValueModel>
        <d3p1:PropertyValueModel>
          <d3p1:Name>sample string 1</d3p1:Name>
          <d3p1:Value />
        </d3p1:PropertyValueModel>
      </d3p1:Properties>
      <d3p1:RecipientEntrySource>sample string 5</d3p1:RecipientEntrySource>
    </MailRecipientModel>
    <NotSentStatus>UNPROCESSED</NotSentStatus>
  </MailMessageNotSentDueToPreviousBounceModel>
</ArrayOfMailMessageNotSentDueToPreviousBounceModel>