POST api/v1/SetMailMetadata

Request Information

URI Parameters

None.

Body Parameters

SetMailMetadataParameter
NameDescriptionTypeAdditional information
MailIDs

Collection of MailID

None.

MailMetadataList

Collection of MailMetadata

None.

Request Formats

application/json, text/json

Sample:
{
  "MailIDs": [
    {
      "ConversationID": "sample string 1",
      "MessageID": "sample string 2"
    },
    {
      "ConversationID": "sample string 1",
      "MessageID": "sample string 2"
    }
  ],
  "MailMetadataList": [
    {
      "Metadata": {
        "ID": 1,
        "Name": "sample string 2",
        "Type": 10,
        "SortOrder": 3,
        "Mandatory": true,
        "Hidden": true,
        "Settings": "sample string 6"
      },
      "Value": "sample string 1",
      "MetadataValues": [
        {
          "ID": 1,
          "MetadataID": 2,
          "Name": "sample string 3",
          "SortOrder": 4
        },
        {
          "ID": 1,
          "MetadataID": 2,
          "Name": "sample string 3",
          "SortOrder": 4
        }
      ]
    },
    {
      "Metadata": {
        "ID": 1,
        "Name": "sample string 2",
        "Type": 10,
        "SortOrder": 3,
        "Mandatory": true,
        "Hidden": true,
        "Settings": "sample string 6"
      },
      "Value": "sample string 1",
      "MetadataValues": [
        {
          "ID": 1,
          "MetadataID": 2,
          "Name": "sample string 3",
          "SortOrder": 4
        },
        {
          "ID": 1,
          "MetadataID": 2,
          "Name": "sample string 3",
          "SortOrder": 4
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<SetMailMetadataParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPointEMM.API.Model">
  <MailIDs>
    <MailID>
      <ConversationID>sample string 1</ConversationID>
      <MessageID>sample string 2</MessageID>
    </MailID>
    <MailID>
      <ConversationID>sample string 1</ConversationID>
      <MessageID>sample string 2</MessageID>
    </MailID>
  </MailIDs>
  <MailMetadataList>
    <MailMetadata>
      <Metadata>
        <Hidden>true</Hidden>
        <ID>1</ID>
        <Mandatory>true</Mandatory>
        <Name>sample string 2</Name>
        <Settings>sample string 6</Settings>
        <SortOrder>3</SortOrder>
        <Type>ShortText</Type>
      </Metadata>
      <MetadataValues>
        <MetadataValue>
          <ID>1</ID>
          <MetadataID>2</MetadataID>
          <Name>sample string 3</Name>
          <SortOrder>4</SortOrder>
        </MetadataValue>
        <MetadataValue>
          <ID>1</ID>
          <MetadataID>2</MetadataID>
          <Name>sample string 3</Name>
          <SortOrder>4</SortOrder>
        </MetadataValue>
      </MetadataValues>
      <Value>sample string 1</Value>
    </MailMetadata>
    <MailMetadata>
      <Metadata>
        <Hidden>true</Hidden>
        <ID>1</ID>
        <Mandatory>true</Mandatory>
        <Name>sample string 2</Name>
        <Settings>sample string 6</Settings>
        <SortOrder>3</SortOrder>
        <Type>ShortText</Type>
      </Metadata>
      <MetadataValues>
        <MetadataValue>
          <ID>1</ID>
          <MetadataID>2</MetadataID>
          <Name>sample string 3</Name>
          <SortOrder>4</SortOrder>
        </MetadataValue>
        <MetadataValue>
          <ID>1</ID>
          <MetadataID>2</MetadataID>
          <Name>sample string 3</Name>
          <SortOrder>4</SortOrder>
        </MetadataValue>
      </MetadataValues>
      <Value>sample string 1</Value>
    </MailMetadata>
  </MailMetadataList>
</SetMailMetadataParameter>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

integer

Response Formats

application/json, text/json

Sample:
1

application/xml, text/xml

Sample:
<int xmlns="http://schemas.microsoft.com/2003/10/Serialization/">1</int>