Send Unified Communications Welcome Email #
Sends a welcome email to a user when they are enabled to use a unified communications client.
POST /v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/sendUConnectActivationEmail
note
This will be done automatically if the sendConnectWelcomeEmail property is enabled on the customer account.
Example #
This request will get send an activations link to this User within the Customer tenant.
warning
Activation emails can only be sent from the User's primary tenant.
Request #
POST <https://api.na.myreports.cloud/api/v1.0/accounts/{ACCOUNT_TENANT_ID}/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}/sendUConnectActivationEmail> HTTP/1.1
Authorisation: Bearer {TOKEN}
Response #
HTTP/1.1 204 No Content
Date: Fri, 07 Feb 2020 13:40:24 GMT
Errors #
Unauthorised #
When the token is not provided, invalid or expired
HTTP/1.1 401 Unauthorised
Bad Request #
When the provided tenant id is not in the correct format
HTTP/1.1 400 Bad Request
Date: Thu, 06 Feb 2020 12:45:27 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 149
{
"error": 400,
"message": "The value '<tenant id>' is not valid.",
"status": "error",
"timestamp": "2020-02-06T12:45:27.5903465Z"
}
When this tenant is not the Users primary tenant
HTTP/1.1 400 Bad Request
Date: Fri, 07 Feb 2020 13:33:16 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 162
{
"error": 400,
"errorCode": "TenantNotPrimary",
"message": "This is not the primary tenant for this User.",
"status": "error",
"timestamp": "2020-02-07T13:33:16.0582281Z"
}
Not Found #
When there are no Customers that have a matching tenant id, or Users within this tenant that have a matching user id
HTTP/1.1 404 Not Found
Date: Thu, 06 Feb 2020 12:46:58 GMT
Content-Type: application/json; charset=utf-8
Content-Length: 95
{
"error": 404,
"message": "Not Found",
"status": "error",
"timestamp": "2020-02-06T12:46:58.7669535Z"
}