1. v3
  2. Contacts
  3. POST - 3/contacts/optouts

Definition

POST - 3/contacts/optouts

Add new opt-outs for your account

Required roles: Contacts (write)

Request information

The email addresses and/or phone numbers that should be opted out.

EmailAddresses

The email addresses to opt out


Type Collection of string
PhoneNumbers

The phone numbers to opt out


Type Collection of string

Sample: 
{
  "EmailAddresses": [
    "sample string 1",
    "sample string 2"
  ],
  "PhoneNumbers": [
    "sample string 1",
    "sample string 2"
  ]
}
Sample: 
<OptOutRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <EmailAddresses xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </EmailAddresses>
  <PhoneNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </PhoneNumbers>
</OptOutRequest>

Response information

test


Meta

The metadata such as paging parameters, status code, timestamp,... which are related to this request.


Type MetaData
Data

The actual data returned by the request.


Type ManipulationResult
Links

HATEOAS related to this object. It wil contain relevant url's such as previous and next page for paged results, create/update/delete action. These url's can be used in your application for the next steps in your application logic.


Type Hateoas

Sample: 
{
  "Meta": {
    "Status": 1,
    "TotalRowCount": 1,
    "Limit": 1,
    "Offset": 1,
    "TotalPageCount": 1,
    "StartRec": 1,
    "StopRec": 1,
    "Timestamp": "2024-04-25T13:48:50.6589363Z",
    "IsFiltered": true
  },
  "Data": {
    "Succeeded": true,
    "FailureMessage": "sample string 2"
  }
}
Sample: 
<Payload xmlns:i="http://www.w3.org/2001/XMLSchema-instance" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
  <Data>
    <FailureMessage>sample string 2</FailureMessage>
    <Succeeded>true</Succeeded>
  </Data>
  <Meta>
    <IsFiltered>true</IsFiltered>
    <Limit>1</Limit>
    <Offset>1</Offset>
    <StartRec>1</StartRec>
    <Status>1</Status>
    <StopRec>1</StopRec>
    <Timestamp>2024-04-25T14:48:50.6589363+01:00</Timestamp>
    <TotalPageCount>1</TotalPageCount>
    <TotalRowCount>1</TotalRowCount>
  </Meta>
</Payload>

Related Examples

Title
Retrieving and adding opt-outs