Generic selectors
Exact matches only
Search in title
Search in content
Search in posts
Search in pages

register method

The method allows both resellers and ordinary users to register users. It is useful for partner sites that want to create their own registration page. In this case, the registered user is automatically linked to the partner. An ordinary user can also use the register method in a number of cases.

For example, while he is using plug-ins for CMS. As a result, the user can install a plug-in without being even registered with UniSender, since the plug-in sends a registration request on its own. Since this is not a secure action, there are some restrictions for ordinary users on the number and frequency of registrations.

Ordinary users can register a user from the same IP once in a minute.

The user can register one account per minute and he does not even need to be a UniSender user for this, he just needs to pass the need_confirm = 1 parameter (and do not pass the api_key).

Principle of use

Syntax and URL to call the method
register (string email, string login)
email * Email address of the user being registered.
login * Login consisting of 1 to 20 Latin characters and numbers.
api_key Access key to the current user’s API (the user must have the reseller right).
need_confirm Registration confirmation (registration confirmation message for a new user), obtains the values of 0 and 1. 0 by default (confirmation is not required). The value 0 is available only for resellers. If the value is 1, all users can use the method.
password Password for the new user. If not specified, it is generated randomly.
notify 0 or 1 (0 by default) — whether the new user shall be sent a welcome message with the password.
extra Associative array of additional fields. The following additional fields are supported: «firstname», «channel», если need_confirm = 1 then extra can obtain another 3 parameters «lastname», «company», «phone».
timezone User time zone in the format described here: If the time zone is not specified, UTC will be used.

Also there will be the following warning if the time zone is not found:

{"warning": "Unknown timezone, set to UTC"}

and the value «ZZZ» is set.

country_code Three-letter country code according to ISO 3166-1 alpha-3. If not specified, the value will be set to «ZZZ».
currency_code Three-letter code of the user’s account currency. Currently RUB, USD, EUR and UAH are possible.

If not specified or no currency is found, the USD is substituted (with exception for the Russian localization, where RUB is substituted).

Also, there will be the following warning if the specified currency is not found:

{"warning": "Unknown currency code"}
 ip The IP address from which the registration request was received, in the format «NNN.NNN.NNN.NNN».
test_mode Test creation of a user, takes values of 0 (off), 1 (on) 0 by default.
Return value
In case of a successful completion – an object with one api_key field, in which the key is returned for requests to the API on behalf of the newly registered user.

"result": {
"api_key": "5skfgjkhfgdfgdhfgkhdkg"

In test mode, api_key is always returned with the value 12345678.