addSubscriber

This action allows you to add a subscriber.

info

The API key must have access rights to subscribers_write.

Request

Name		Type	Description
apikey	Required	string	API public key
signature	Required	string	Signature of the request.
expires		timestamp	UNIX timestamp for request expiration (GMT)
output		string	Format of the response. Either XML (default), JSON or PHP
subscription_id	Required	integer	ID of the folder
login	Required	string	Subscriber login (must be unique in a folder)
password		string	Subscriber password (if empty an 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 has access to all subscriber enabled private publications of the subscription. Either 0 ((disabled)) or 1 ((enabled))
is_active		boolean	Subscriber activation status. Either 0 ((inactive)) or 1 ((active))
extras		string	Free field up to 255 characters

Response

This method returns a Subscriber.

Name	Type	Description
AccountID	integer	Subscriber's owner account ID (should be your account ID)
SubscriptionID	integer	Subscriber's folder ID
LastName	string	Last name of the subscriber
FirstName	string	First name of the subscriber
Email	string	Email address of the subscriber
Login	string	Login of the subscriber
Password	string	Password of the subscriber
IsActive	boolean	Activation status of the subscriber. Either "1" ((activated)), "0" ((deactivated))
HasFullAccess	boolean	Full access to the subscription. Either "1" ((activated)), "0" ((deactivated))
LastLogin	datetime	Date of the subscriber's last login
Creation	datetime	Date the subscriber was created
Modification	datetime	Date the subscriber was last edited
Extras	string	Additional information on the subscriber, in varchar format up to 255 characters in size

Example response

JSON

{
  "response": {
    "status": "ok",
    "version": 2,
    "requestid": "mTE0c0",
    "requests": 160,
    "content": {
      "AccountID": 4516825,
      "SubscriptionID": 4540112,
      "LastName": "",
      "FirstName": "",
      "Email": "",
      "Login": "leia",
      "Password": "syCo3hJN",
      "IsActive": 0,
      "HasFullAccess": 0,
      "LastLogin": false,
      "Creation": "2015-10-16 11:31:05",
      "Modification": "2015-10-16 11:31:05",
      "Extras": ""
    }
  }
}