POST Unsubscribe

Modified on: Fri, 25 Jan, 2019 at 11:48 AM


Introduction

This API will add a customer to the “stop list” and prevent subsequent emailing to that address.


Good to know

API response format:

Our APIs return data in either JSON or XML format (depending on request by .json or .xml).


About this API

Resource Information

Response formats
JSON (default), XML
HTTP Method
POST
Response family
Lists
Header
Authorization: api_key XXXXX


Resource URL

Europe Production Server: https://api.eu.customergauge.com/v4.1/lists/unsubscribe.json

US Production Server: https://api.us.customergauge.com/v4.1/lists/unsubscribe.json

Australia Production Server: https://api.au.customergauge.com/v4.1/lists/unsubscribe.json


How to call

POST Data

Post data as key value based on upload mapping.


Parameters

Key
Data
email (required)
lee_klameth@directness.net


Example Request

curl -H "Authorization: api_key XXXXX" -X POST https://api.eu.customergauge.com/v4.1/lists/unsubscribe.json -d email=lee_klameth@directness.net


Example Result

Message reported on successful operation:

{
  "Data": {
    "Message": "Record added"
  }
}


Message reported on failed operation:

{
  "Error": {
    "Message": "Email address is required",
    "Code": 400402
  }
}


Not the API you're looking for?

Related APIs:


Or view:



Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.