Support
 
Phone Live Chat
 
Support
 
US: +1 888 720 9500
US: +1 800 443 6694
Intl: +1 925 924 9500
Aus: +1 800 631 268
UK: 0800 028 6590
CN: +86 400 660 8680

Direct Inward Dialing: +1 408 916 9393

 
 
 
 
 
Create mailbox
 

Create mailbox API

This API helps you raise a workflow request to create an Exchange mailbox using your application. 

Request URL (JSON) Format: http://<hostname>:<port>/RestAPI/CreateWorkFlowRequest

Request Parameters:

Parameters Mandatory Description
AuthToken Yes Authentication token that is generated either from the Delegation tab (Delegation > Configuration > Technician Authtokens) or from the My account tab (My Account > Active Authtokens) in the top right corner of the product.
domainName Yes Domain in which this operation must be performed. 
inputData Details about the workflow request to be raised. It must also contain the details about the mailboxes that are to be created.
Yes Specify the title of the request under Subject.
Yes Specify the action as CREATE_MAILBOX under RequestAction. 
Yes Specify the user accounts for which you wish to create the mailboxes.
Optional Specify the priority of the task.
Optional Provide a suitable Description.
Yes Specify only the allowed values for MailAliasFormat. URL encode the + symbol. 
Yes Specify the values for the ExchangeServer, and MailBoxStore names. 
PRODUCT_NAME Yes Product name/module name from which the request is being sent; will be needed for auditing.

Response Parameters:

Parameters Description
Subject Subject of the request
requestId RequestId of the request raised. This is not displayed in the response, if the operation has failed.
status Status of the operation, where 1 stands for Success and 0 stands for Failure.
statusMessage The response message to be displayed in case of success or failure.

Sample Input / Output

Request:

http://admanager:8080/RestAPI/CreateWorkFlowRequest?AuthToken=244f8f17-041d-4c85-9924-02f7351a6fbb&domainName=admp.local&PRODUCT_NAME=RESTAPI&inputData=[{"RequestAction":"CREATE_MAILBOX", "Subject":"Create Mailbox", "accounts":[{"sAMAccountName":"test1"}], "MailAliasFormat":"FirstName %2B.%2B LastName", "ExchangeServer":"First Organization/Exchange Administrative Group (FYDIBOHF23SPDLT)/ADMP-CASMBX131", "MailBoxStore":"Mailbox Database 1404519014"}]

Response:

[{"Subject":"Create Mailbox","requestId":6314,"statusMessage":"Successfully created the request.","status":"1"}]

ADManager Plus Trusted By

The one-stop solution to Active Directory Management and Reporting
Email Download Link