API.addSubscriber - 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.addSubscriber

From Calaméo Knowledge Base

This action allows you to add a subscriber.

<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 Subscriber login (must be unique in a subscription).
password string Subscriber password (if empty a 8 character password will be generated).
lastname string Subscriber last name.
firstname string Subscriber first name.
email string Subscriber e-mail.
language string Subscriber language. Either EN (default), FR, ES, DE, IT, PT, RU.
full_access boolean Subscriber access to the full scription. Either 0 (inactive) or 1 (active).
is_active boolean Subscriber activation status. Either 0 (inactive) or 1 (active).
extras string Free field up to 255 characters.

Response

This request sends a Subscriber.

Example responses

JSON

{
  response: {
    requestid: ...,
    requests: ...,
    status: ok,
    content: {
      AccountID: ...,
      SubscriptionID: ...,
      LastName: ...,
      FirstName: ...,
      Email: ...,
      Login: ...,
      Password: ...,
      HasFullAccess: ...,
      IsActive: ...,
      Creation: ...,
      Modification: ...,
      LastLogin: ...,
      Extras: ...
    }
  }
}


Error codes

See the Error Code Section.