Delete a subscriber from an account
Request
|
Parameter |
In |
Type |
Required |
Description |
|---|---|---|---|---|
|
|
header |
string |
true |
Determines the expected format and data type to retrieve the response data. Value: |
|
|
path |
string |
true |
The supported file format for getting a response. Possible values: |
|
|
query |
string |
true |
The API key of your account. |
|
|
body |
string |
true |
The email address of the subscriber. |
|
|
body |
boolean |
false |
Determines whether to delete the subscriber from all subaccounts. |
POST https://{hostname}/v3/subscribers/delete.{format}?apikey=
Request body:
{
"Email": "[email protected]",
"IncludeAllSubAccounts": true
}
Response
|
Status |
Description |
Headers |
Schema |
|---|---|---|---|
|
|
The request is successful. |
|
N/A |
{
"Code": 0,
"Error": null,
"Context": null
}-
Code- the response code. This is0if successful. -
Error- the response error message. This isnullif successful.-
VALIDATION_ERROR- input validation error occurred. -
MEMBER_NOT_FOUND- a specified email address was not found in the email list. -
MEMBER_DELETION_FAILED- failed to delete one or more members.
-
-
Context- this isnullif successful.