POST api/Suppression

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
CRMID	string	None.
GlobalSuppress	string	None.
SuppressList	Collection of SuppressionList	None.

Request Formats

application/json, text/json

Sample:

{
  "CRMID": "sample string 1",
  "GlobalSuppress": "sample string 2",
  "SuppressList": [
    {
      "StatusCode": "sample string 1",
      "EmailAddress": "sample string 2"
    },
    {
      "StatusCode": "sample string 1",
      "EmailAddress": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<SuppressionHeader xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <CRMID>sample string 1</CRMID>
  <GlobalSuppress>sample string 2</GlobalSuppress>
  <SuppressList>
    <SuppressionList>
      <EmailAddress>sample string 2</EmailAddress>
      <StatusCode>sample string 1</StatusCode>
    </SuppressionList>
    <SuppressionList>
      <EmailAddress>sample string 2</EmailAddress>
      <StatusCode>sample string 1</StatusCode>
    </SuppressionList>
  </SuppressList>
</SuppressionHeader>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SuppressionListResponse

Name	Type	Additional information
StatusCode	string	None.
Message	string	None.
processedCount	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "StatusCode": "sample string 1",
  "Message": "sample string 2",
  "processedCount": 3
}

application/xml, text/xml

Sample:

<SuppressionListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/EngageCL.Engage">
  <Message>sample string 2</Message>
  <StatusCode>sample string 1</StatusCode>
  <processedCount>3</processedCount>
</SuppressionListResponse>