POST api/PostmarkOpens

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
RecordType	string	None.
MessageStream	string	None.
Metadata	Dictionary of string [key] and Object [value]	None.
FirstOpen	boolean	None.
Recipient	string	None.
MessageID	string	None.
ReceivedAt	date	None.
Platform	string	None.
ReadSeconds	integer	None.
Tag	string	None.
UserAgent	string	None.
OS	Dictionary of string [key] and Object [value]	None.
Client	Dictionary of string [key] and Object [value]	None.
Geo	Dictionary of string [key] and Object [value]	None.

Request Formats

application/json, text/json

Sample:

{
  "RecordType": "sample string 1",
  "MessageStream": "sample string 2",
  "Metadata": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "FirstOpen": true,
  "Recipient": "sample string 4",
  "MessageID": "sample string 5",
  "ReceivedAt": "2025-12-22T13:18:54.5515517+00:00",
  "Platform": "sample string 7",
  "ReadSeconds": 8,
  "Tag": "sample string 9",
  "UserAgent": "sample string 10",
  "OS": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "Client": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "Geo": {
    "sample string 1": {},
    "sample string 3": {}
  }
}

application/xml, text/xml

Sample:

<WebhookData2 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PostmarkWebhook.Controllers">
  <Client xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Client>
  <FirstOpen>true</FirstOpen>
  <Geo xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Geo>
  <MessageID>sample string 5</MessageID>
  <MessageStream>sample string 2</MessageStream>
  <Metadata xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Metadata>
  <OS xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </OS>
  <Platform>sample string 7</Platform>
  <ReadSeconds>8</ReadSeconds>
  <ReceivedAt>2025-12-22T13:18:54.5515517+00:00</ReceivedAt>
  <Recipient>sample string 4</Recipient>
  <RecordType>sample string 1</RecordType>
  <Tag>sample string 9</Tag>
  <UserAgent>sample string 10</UserAgent>
</WebhookData2>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

PostmarkOpen

Name	Type	Additional information
ID	integer	None.
RecordType	string	None.
MessageStream	string	None.
Metadata	string	None.
FirstOpen	string	None.
Recipient	string	None.
MessageID	string	None.
ReceivedAt	string	None.
Platform	string	None.
ReadSeconds	string	None.
Tag	string	None.
UserAgent	string	None.
OS	string	None.
Client	string	None.
Geo	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ID": 1,
  "RecordType": "sample string 2",
  "MessageStream": "sample string 3",
  "Metadata": "sample string 4",
  "FirstOpen": "sample string 5",
  "Recipient": "sample string 6",
  "MessageID": "sample string 7",
  "ReceivedAt": "sample string 8",
  "Platform": "sample string 9",
  "ReadSeconds": "sample string 10",
  "Tag": "sample string 11",
  "UserAgent": "sample string 12",
  "OS": "sample string 13",
  "Client": "sample string 14",
  "Geo": "sample string 15"
}

application/xml, text/xml

Sample:

<PostmarkOpen xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PostmarkWebhook">
  <Client>sample string 14</Client>
  <FirstOpen>sample string 5</FirstOpen>
  <Geo>sample string 15</Geo>
  <ID>1</ID>
  <MessageID>sample string 7</MessageID>
  <MessageStream>sample string 3</MessageStream>
  <Metadata>sample string 4</Metadata>
  <OS>sample string 13</OS>
  <Platform>sample string 9</Platform>
  <ReadSeconds>sample string 10</ReadSeconds>
  <ReceivedAt>sample string 8</ReceivedAt>
  <Recipient>sample string 6</Recipient>
  <RecordType>sample string 2</RecordType>
  <Tag>sample string 11</Tag>
  <UserAgent>sample string 12</UserAgent>
</PostmarkOpen>