Send email based on template

Xsolla Developers

或

前往发布商帐户

Send email based on template

post/templates/email/send

Sends an email based on a custom template and data that you provided to the specified email address.

SecurityServer

Request

query Parameters

projectId

required

string <uuid>

发布商帐户中的登录管理器项目ID。

Request Body schema: application/json

required

string [ 1 .. 255 ] characters

用户邮箱地址。

required

object

required

string

Name of the template created by the Create custom email template call.

locale

string = 5 characters

Region of the texts that you provided in the template in the <language code>_<country code> format, where:

language code: language code in the ISO 639-1 format;
country code: country/region code in the ISO 3166-1 alpha-2 format.

object

JSON object with texts for all variables that you specified in the email template created by the Create custom email template call.

// If you created body of the template with

Hi {{first_name}} {{last_name}}!
We will be glad to see you on the {{site_link}} page.

// Pass the following JSON here

"params": {
  "first_name": "John",
  "last_name": "Smith",
  "site_link": "https://example.com/"
}

property name*

additional property

string

Responses

204

无内容

401

未授权

404

未找到

422

无法处理的实体

Request samples

application/json

{"email": "john_smith@gmail.com",
"template": {"id": "Welcome email template",
"locale": "en_US",
"params": {"first_name": "John",
"last_name": "Smith",
"site_link": "https://example.com/"
}
}
}

Response samples

{"error": {"code": "003-061",
"description": "Object not found.",
"details": { }
}
}