Send Welcome Email to Company
You can send a welcome email to a company with the specified UID.
Required Privileges
To perform this task, a user must have one of the following roles assigned: Portal Administrator, Service Provider Global Administrator, Service Provider Administrator.
Request
To send a welcome email to a company, send the POST HTTP request to the URL of the /organizations/companies/{companyUid}/welcomeEmail resource.
HTTP Request
POST https://<hostname>:1280/api/v3/organizations/companies/{companyUid}/welcomeEmail |
Request Headers
The request contains the following headers.
Header | Required/Optional | Value | Description |
Authorization | Required | Bearer <Access-Token> | Authenticates a client who sends the request to the server. Must contain the access token for the current logon session in the Bearer <Access-Token> format. |
Content-Type | Required | application/json | Identifies a media type that is used in the body of the request. |
Accept | Optional | application/json | Specifies a media type of representation that is required in the response message. If the requested type is not supported, the server will return the response in the application/json media type. |
Request parameters
A list of parameters that are applicable for this operation:
Name | In | Type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|---|
companyUid | Path | String (uuid) | Yes | — | — | Company UID |
Body | Body | No | — | — | Password for created account |
Response
The server returns the following response to the client.
Response Code
A successfully completed operation returns response code 200 OK.
Response Headers
The response to this request contains the following headers. The response may also include additional standard HTTP headers.
Header | Description |
Content-length | The length of the response body. |
Content-type | The media type and syntax of the request body message: application/json; charset=utf-8 |
Example 
The following request sends a welcome email message to a company with UID debcdb55-afbd-4772-bf99-5ea6a3249f43.
Request: POST https://localhost:1280/api/v3/organizations/companies/debcdb55-afbd-4772-bf99-5ea6a3249f43/welcomeEmail
Request Header: Content-type: application/json Authorization: Bearer <Access-Token>
Request Body: { "password": "Password1" }
Response Code: 200 OK |
