Sending a Welcome Email

Description

Sends a welcome email with a link to set a password. The email provides personal data about the initiator of the recovery/registration completion operation:

• Platform (UserAgent of the request)
• Device location (Geo-decoding of IP, if data is available in GeoDB)
• Operation time (approximate time of request execution)

Example of a welcome email

URL Address

Method: POST

https://example.com/api/v1.1/admin/accounts/users/send_welcome

Request Parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
account_id	int	1	Yes	Account identifier
name	string	"example"	Yes	Username for personalization

Request Example

JSON

{
"token": "abcdefghijklmnqrstuvwxyz",
"account_id": 7,
"name": "example"
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <account_id>Successful operation</account_id>
  <name>example<name>
</xml>

Response Example

JSON

{
  "error": 0,
  "error_text": "Successful operation"
}

XML

<xml>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Response Parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error message text