API.deactivateSubscriber - Calaméo Knowledge Base
Not a Calaméo member yet?
Sign up now! It's FREE!
Get the latest news on Calaméo
Follow us on Facebook
Get Calaméo updates in real-time
Follow us on Twitter

API.deactivateSubscriber

From Calaméo Knowledge Base

This action allows to deactivate an activated subscriber. Once deactivated, the subscriber can no longer access his publications.

<toc>

Request

Note: This feature is only available to PREMIUM and PLATINUM users. Click Here To Upgrade.
The API key must have the subscribers_write access right.
Name Required Type Description
apikey yes string API public key
signature yes string Signature of the request. See How To Sign Your Requests.
expires yes timestamp UNIX timestamp for request expiration (GMT).
output string Format of the response. Either XML (default), JSON or PHP.
subscription_id yes integer ID of the subscription.
login yes string Login of the subscriber.

Response

This request sends the character string ok if successful.

Example responses

JSON

{
  response: {
    requestid: ...,
    requests: ...,
    status: ok
  }
}

Error codes

See the Error Code Section.