API.addSubscriber
This action allows you to add a subscriber.
Request
Note: This action is only available to PREMIUM and PLATINUM members.
The API key must have the subscribers_write 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 | 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. |
| string | Subscriber e-mail. | |
| language | string | Subscriber language. Either EN (default), FR, ES, DE, IT, PT, JP, CN, KR, RU. |
| 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
<response>
<requestid>...</requestid>
<requests>...</requests>
<status>ok</status>
<content>
<AccountID>...</AccountID>
<SubscriptionID>...</SubscriptionID>
<LastName>...</LastName>
<FirstName>...</FirstName>
<Email>...</Email>
<Login>...</Login>
<Password>...</Password>
<IsActive>...</IsActive>
<Creation>...</Creation>
<Modification>...</Modification>
<LastLogin>...</LastLogin>
<Extras>...</Extras>
</content>
</response>
{
"response": {
"requestid": ...,
"requests": ...,
"status": "ok",
"content": {
"AccountID": ...,
"SubscriptionID": ...,
"LastName": ...,
"FirstName": ...,
"Email": ...,
"Login": ...,
"Password": ...,
"IsActive": ...,
"Creation": ...,
"Modification": ...,
"LastLogin": ...,
"Extras": ...
}
}
}
[
"response" => [
"requestid" => ...,
"requests" => ...,
"status" => "ok",
"content" => [
"AccountID" => ...,
"SubscriptionID" => ...,
"LastName" => ...,
"FirstName" => ...,
"Email" => ...,
"Login" => ...,
"Password" => ...,
"IsActive" => ...,
"Creation" => ...,
"Modification" => ...,
"LastLogin" => ...,
"Extras" => ...
]
]
]
Error codes
See the error code section.
