POST api/Administration/v1/RegisterIncomingEmail

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
body	Email	None.
method	string	None.
OrganizationCode	string	None.
UserName	string	None.
Password	string	None.

Request Formats

application/json, text/json

Sample:

{
  "body": {
    "From": "sample string 1",
    "To": "sample string 2",
    "Cc": {},
    "Bcc": {},
    "Subject": "sample string 5",
    "Importance": "sample string 6",
    "BodyPreview": "sample string 7",
    "HasAttachment": true,
    "Id": "sample string 9",
    "ConversationId": "sample string 10",
    "DateTimeReceived": "2026-01-27T19:03:21.9038724+00:00",
    "IsRead": true,
    "Attachments": [
      {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "ContentBytes": "sample string 3",
        "ContentType": "sample string 4",
        "Size": 5
      },
      {
        "Id": "sample string 1",
        "Name": "sample string 2",
        "ContentBytes": "sample string 3",
        "ContentType": "sample string 4",
        "Size": 5
      }
    ],
    "IsHtml": true,
    "body": "sample string 14"
  },
  "method": "sample string 1",
  "OrganizationCode": "sample string 2",
  "UserName": "sample string 3",
  "Password": "sample string 4"
}

application/xml, text/xml

Sample:

<RegisterIncomingEmailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">
  <OrganizationCode>sample string 2</OrganizationCode>
  <Password>sample string 4</Password>
  <UserName>sample string 3</UserName>
  <body>
    <Attachments>
      <Attachment>
        <ContentBytes>sample string 3</ContentBytes>
        <ContentType>sample string 4</ContentType>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
        <Size>5</Size>
      </Attachment>
      <Attachment>
        <ContentBytes>sample string 3</ContentBytes>
        <ContentType>sample string 4</ContentType>
        <Id>sample string 1</Id>
        <Name>sample string 2</Name>
        <Size>5</Size>
      </Attachment>
    </Attachments>
    <Bcc />
    <BodyPreview>sample string 7</BodyPreview>
    <Cc />
    <ConversationId>sample string 10</ConversationId>
    <DateTimeReceived>2026-01-27T19:03:21.9038724+00:00</DateTimeReceived>
    <From>sample string 1</From>
    <HasAttachment>true</HasAttachment>
    <Id>sample string 9</Id>
    <Importance>sample string 6</Importance>
    <IsHtml>true</IsHtml>
    <IsRead>true</IsRead>
    <Subject>sample string 5</Subject>
    <To>sample string 2</To>
    <body>sample string 14</body>
  </body>
  <method>sample string 1</method>
</RegisterIncomingEmailRequest>

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 'RegisterIncomingEmailRequest'.

Response Information

Resource Description

RegisterIncomingEmailReply

Name	Type	Additional information
Reply	ServiceReply	None.
Ok	boolean	None.
ErrorMessage	string	None.
ErrorCode	string	None.
Message	string	None.

Response Formats

application/json, text/json

Sample:

{
  "Reply": {
    "ReceivedEmail": {
      "From": "sample string 1",
      "To": "sample string 2",
      "Cc": {},
      "Bcc": {},
      "Subject": "sample string 5",
      "Importance": "sample string 6",
      "BodyPreview": "sample string 7",
      "HasAttachment": true,
      "Id": "sample string 9",
      "ConversationId": "sample string 10",
      "DateTimeReceived": "2026-01-27T19:03:21.9351062+00:00",
      "IsRead": true,
      "Attachments": [
        {
          "Id": "sample string 1",
          "Name": "sample string 2",
          "ContentBytes": "sample string 3",
          "ContentType": "sample string 4",
          "Size": 5
        },
        {
          "Id": "sample string 1",
          "Name": "sample string 2",
          "ContentBytes": "sample string 3",
          "ContentType": "sample string 4",
          "Size": 5
        }
      ],
      "IsHtml": true,
      "body": "sample string 14"
    },
    "ErrorMessage": "sample string 1",
    "ActionCode": "sample string 2",
    "ActionTargetCode": "sample string 3"
  },
  "Ok": true,
  "ErrorMessage": "sample string 2",
  "ErrorCode": "sample string 3",
  "Message": "sample string 4"
}

application/xml, text/xml

Sample:

<RegisterIncomingEmailReply xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/FfApi.Controllers">
  <ErrorCode>sample string 3</ErrorCode>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Message>sample string 4</Message>
  <Ok>true</Ok>
  <Reply>
    <ActionCode>sample string 2</ActionCode>
    <ActionTargetCode>sample string 3</ActionTargetCode>
    <ErrorMessage>sample string 1</ErrorMessage>
    <ReceivedEmail>
      <Attachments>
        <Attachment>
          <ContentBytes>sample string 3</ContentBytes>
          <ContentType>sample string 4</ContentType>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
          <Size>5</Size>
        </Attachment>
        <Attachment>
          <ContentBytes>sample string 3</ContentBytes>
          <ContentType>sample string 4</ContentType>
          <Id>sample string 1</Id>
          <Name>sample string 2</Name>
          <Size>5</Size>
        </Attachment>
      </Attachments>
      <Bcc />
      <BodyPreview>sample string 7</BodyPreview>
      <Cc />
      <ConversationId>sample string 10</ConversationId>
      <DateTimeReceived>2026-01-27T19:03:21.9351062+00:00</DateTimeReceived>
      <From>sample string 1</From>
      <HasAttachment>true</HasAttachment>
      <Id>sample string 9</Id>
      <Importance>sample string 6</Importance>
      <IsHtml>true</IsHtml>
      <IsRead>true</IsRead>
      <Subject>sample string 5</Subject>
      <To>sample string 2</To>
      <body>sample string 14</body>
    </ReceivedEmail>
  </Reply>
</RegisterIncomingEmailReply>