Unsubscribe a subscriber from an account

POST /subscribers/unsubscribe.{Format}

Unsubscribes a specific subscriber from all email lists they belong to 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
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.

http

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

Request body:
{
  "Email": "[email protected]"
}

curl

curl --include \\
     --request POST \\
     --header "Content-Type: application/json" \\
     --header "Accept: application/json" \\
     --data-raw '{
    "Email": "[email protected]"
}' \\
'https://{hostname}/v3/subscribers/unsubscribe.{Format}?apikey='

Response

Status	Description	Headers	Schema
200 OK	The request is successful.	Content-Type /json	N/A

json

{
  "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.

If you have suggestions for improving this article, let us know!