POST api/AdminService/GetBouncedMails

Documentation for 'GetBouncedMails'.

Request Information

Parameters

Name	Description	Additional information
request	Documentation for 'request'.	Define this parameter in the request body.

Request body formats

application/json, text/json

Sample:

{
  "EmailTo": "sample string 1",
  "StartRow": 2,
  "EndRow": 3
}

application/xml, text/xml

Sample:

<MailHistoryRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.Messages.Admin">
  <EmailTo>sample string 1</EmailTo>
  <EndRow>3</EndRow>
  <StartRow>2</StartRow>
</MailHistoryRequest>

application/x-www-form-urlencoded

Sample:

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

Response Information

Response body formats

application/json, text/json

Sample:

{
  "status": "sample string 1",
  "Message": {
    "bouncedMailItemsList": [
      {
        "EmailId": 1,
        "Email": "sample string 2",
        "ReceivedDate": "2026-01-11T19:30:08.9337688+00:00",
        "Reason": "sample string 4",
        "ErrorID": "sample string 5",
        "Description": "sample string 6",
        "Status": "sample string 7",
        "IsSendGridBlocked": true,
        "Event": "sample string 9",
        "Message_id": "sample string 10",
        "Subject": "sample string 11",
        "Tag": "sample string 12",
        "Processed": 64
      },
      {
        "EmailId": 1,
        "Email": "sample string 2",
        "ReceivedDate": "2026-01-11T19:30:08.9337688+00:00",
        "Reason": "sample string 4",
        "ErrorID": "sample string 5",
        "Description": "sample string 6",
        "Status": "sample string 7",
        "IsSendGridBlocked": true,
        "Event": "sample string 9",
        "Message_id": "sample string 10",
        "Subject": "sample string 11",
        "Tag": "sample string 12",
        "Processed": 64
      },
      {
        "EmailId": 1,
        "Email": "sample string 2",
        "ReceivedDate": "2026-01-11T19:30:08.9337688+00:00",
        "Reason": "sample string 4",
        "ErrorID": "sample string 5",
        "Description": "sample string 6",
        "Status": "sample string 7",
        "IsSendGridBlocked": true,
        "Event": "sample string 9",
        "Message_id": "sample string 10",
        "Subject": "sample string 11",
        "Tag": "sample string 12",
        "Processed": 64
      }
    ],
    "TotalCount": {
      "RecordCount": 1
    }
  }
}

application/xml, text/xml

Sample:

<ResponseBaseOfBouncedMailHistoryResponseraCNGjCh xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.MessageBase">
  <Message xmlns:d2p1="http://schemas.datacontract.org/2004/07/PartyMusic.BusinessObject.Messages.Admin">
    <d2p1:TotalCount>
      <d2p1:RecordCount>1</d2p1:RecordCount>
    </d2p1:TotalCount>
    <d2p1:bouncedMailItemsList>
      <d2p1:BouncedEmailEntity>
        <d2p1:Description>sample string 6</d2p1:Description>
        <d2p1:Email>sample string 2</d2p1:Email>
        <d2p1:EmailId>1</d2p1:EmailId>
        <d2p1:ErrorID>sample string 5</d2p1:ErrorID>
        <d2p1:Event>sample string 9</d2p1:Event>
        <d2p1:IsSendGridBlocked>true</d2p1:IsSendGridBlocked>
        <d2p1:Message_id>sample string 10</d2p1:Message_id>
        <d2p1:Processed>64</d2p1:Processed>
        <d2p1:Reason>sample string 4</d2p1:Reason>
        <d2p1:ReceivedDate>2026-01-11T19:30:08.9337688+00:00</d2p1:ReceivedDate>
        <d2p1:Status>sample string 7</d2p1:Status>
        <d2p1:Subject>sample string 11</d2p1:Subject>
        <d2p1:Tag>sample string 12</d2p1:Tag>
      </d2p1:BouncedEmailEntity>
      <d2p1:BouncedEmailEntity>
        <d2p1:Description>sample string 6</d2p1:Description>
        <d2p1:Email>sample string 2</d2p1:Email>
        <d2p1:EmailId>1</d2p1:EmailId>
        <d2p1:ErrorID>sample string 5</d2p1:ErrorID>
        <d2p1:Event>sample string 9</d2p1:Event>
        <d2p1:IsSendGridBlocked>true</d2p1:IsSendGridBlocked>
        <d2p1:Message_id>sample string 10</d2p1:Message_id>
        <d2p1:Processed>64</d2p1:Processed>
        <d2p1:Reason>sample string 4</d2p1:Reason>
        <d2p1:ReceivedDate>2026-01-11T19:30:08.9337688+00:00</d2p1:ReceivedDate>
        <d2p1:Status>sample string 7</d2p1:Status>
        <d2p1:Subject>sample string 11</d2p1:Subject>
        <d2p1:Tag>sample string 12</d2p1:Tag>
      </d2p1:BouncedEmailEntity>
      <d2p1:BouncedEmailEntity>
        <d2p1:Description>sample string 6</d2p1:Description>
        <d2p1:Email>sample string 2</d2p1:Email>
        <d2p1:EmailId>1</d2p1:EmailId>
        <d2p1:ErrorID>sample string 5</d2p1:ErrorID>
        <d2p1:Event>sample string 9</d2p1:Event>
        <d2p1:IsSendGridBlocked>true</d2p1:IsSendGridBlocked>
        <d2p1:Message_id>sample string 10</d2p1:Message_id>
        <d2p1:Processed>64</d2p1:Processed>
        <d2p1:Reason>sample string 4</d2p1:Reason>
        <d2p1:ReceivedDate>2026-01-11T19:30:08.9337688+00:00</d2p1:ReceivedDate>
        <d2p1:Status>sample string 7</d2p1:Status>
        <d2p1:Subject>sample string 11</d2p1:Subject>
        <d2p1:Tag>sample string 12</d2p1:Tag>
      </d2p1:BouncedEmailEntity>
    </d2p1:bouncedMailItemsList>
  </Message>
  <status>sample string 1</status>
</ResponseBaseOfBouncedMailHistoryResponseraCNGjCh>