API.deleteSubscriber
This action allows you to delete a subscriber.
Request
The API key must have the subscribers_delete access right.
| Name | Type | Description |
|---|---|---|
| apikey[required] | string | API public key |
| signature[required] | string | Signature of the request. See how to sign your requests. |
| expires | timestamp | UNIX timestamp for request expiration. |
| output | string | Format of the response. Either XML (default), JSON or PHP. |
| subscription_id[required] | integer | ID of the subscription. |
| login[required] | string | Login of the subscriber you wish to delete. |
Response
This request sends the character string ok if successful.
Example responses
<response>
<requestid>...</requestid>
<requests>...</requests>
<status>ok</status>
</response>
{
"response": {
"requestid": ...,
"requests": ...,
"status": "ok"
}
}
[
"response" => [
"requestid" => ...,
"requests" => ...,
"status" => "ok"
]
]
Error codes
See the error code section.
