POST api/email/heldEmails

Request Information

URI Parameters

None.

Body Parameters

EmailGetHeldEmailRequestDTO
NameDescriptionTypeAdditional information
SearchBy

Searchby

None.
start

date

None.
admin

boolean

None.
end

date

None.
filterBy

Filterby

None.
searchBy

Searchby

None.

Request Formats

application/json, text/json

Sample: 
{
  "SearchBy": {
    "value": "sample string 1",
    "fieldName": "sample string 2"
  },
  "start": "2025-12-17T05:48:50.9565176+02:00",
  "admin": true,
  "end": "2025-12-17T05:48:50.9565176+02:00",
  "filterBy": {
    "value": "sample string 1",
    "fieldName": "sample string 2"
  },
  "searchBy": {
    "value": "sample string 1",
    "fieldName": "sample string 2"
  }
}

application/xml, text/xml

Sample: 
<EmailGetHeldEmailRequestDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BO.EmailDTO">
  <SearchBy>
    <fieldName>sample string 2</fieldName>
    <value>sample string 1</value>
  </SearchBy>
  <admin>true</admin>
  <end>2025-12-17T05:48:50.9565176+02:00</end>
  <filterBy>
    <fieldName>sample string 2</fieldName>
    <value>sample string 1</value>
  </filterBy>
  <searchBy>
    <fieldName>sample string 2</fieldName>
    <value>sample string 1</value>
  </searchBy>
  <start>2025-12-17T05:48:50.9565176+02:00</start>
</EmailGetHeldEmailRequestDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

BaseViewModel
NameDescriptionTypeAdditional information
ResponseStatus

ResponseStatus

None.
ResponseMessage

string

None.
ResponseMessageDetail

string

None.
RowId

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "ResponseStatus": 1,
  "ResponseMessage": "sample string 1",
  "ResponseMessageDetail": "sample string 2",
  "RowId": "sample string 3"
}

application/xml, text/xml

Sample: 
<BaseViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BO.ViewModels">
  <ResponseMessage>sample string 1</ResponseMessage>
  <ResponseMessageDetail>sample string 2</ResponseMessageDetail>
  <ResponseStatus>Success</ResponseStatus>
  <RowId>sample string 3</RowId>
</BaseViewModel>