Send Welcome Email
Sends a welcome email to the specified users.
Request URL
POST {base_url}/uc-cconfig/api/v1/users/send-welcome-emailRequest parameters
- Headers
-
Parameter Required Type Description Authorization Yes String The access token used for authentication. Format: Bearer
{access_token}.x-tenant-code Yes String The tenant name. Note: You can obtain tenant name using the Query Tenants interface.
- Body parameters
-
Parameter Required Type Description userIds No Array<String> The list of IDs of the users to send the welcome email to.
Response parameters
| Parameter | Type | Description |
|---|---|---|
| requestId | String | The unique ID of the request, which can be used to quickly locate the request. |
| code | String | The HTTP status code of the request.
|
| message | String | The status message of the request. |
| detailMessage | String | The detailed error information. When the request is successful, this parameter returns empty. |
| result | Object<Send_Result> | The result of the request. |
- Send_Result
-
Parameter Type Description batchId String The ID of the email sending batch. accepted Integer The number of emails that are accepted for sending.