Skip to main content
Sitecore Documentation
Send logo
Users
Developers
  • Powered byPowered by
Introduction to the Sitecore Send API
Getting started with the Sitecore Send API
API reference
  • Sitecore Send API documentation
  • API reference
  • Subscribers
  • Unsubscribe a subscriber from a mailing list
Edit in Paligo

Unsubscribe a subscriber from a mailing list

Abstract

Describes the request and response details of this Sitecore Send API endpoint to unsubscribe a subscriber from an email list.

POST /subscribers/{MailingListID}/unsubscribe.{Format}

Unsubscribes a subscriber from a specific email list in your Sitecore Send account.

Request

Parameter

In

Type

Required

Description

Accept

header

string

true

Determines the expected format and data type to retrieve the response data.

Value: application/json

MailingListID

path

string

true

The ID of the email list from which you want to unsubscribe a subscriber.

Format

path

string

true

The supported file format for getting a response.

Possible values: json and xml.

apikey

query

string

true

The API key of your account.

Email

body

string

true

The email address of the subscriber.

RequestResponsehttp
POST https://{hostname}/v3/subscribers/{MailingListID}/unsubscribe.{Format}?apikey=

Request body:
{
  "Email": "test1@test.com"
}

Response

Status

Description

Headers

Schema

200 OK

The request is successful.

Content-Type:application/json

N/A

RequestResponsejson
{
  "Code": 0,
  "Error": null,
  "Context": null
}
  • Code - the response code. This is 0 if successful.

  • Error - the response error message. This is null if successful.

  • Context - this is null if successful.

Do you have some feedback for us?

If you have suggestions for improving this article,

Privacy policySitecore Trust CenterCopyright © 1999-2023 Sitecore