Mailbox Create
Availability
Available as of Sept. 12th, 2017. Version 1.6.3
Protocol
POST
URL
https://api.helpmonks.com/api/v1/mailbox/create
Parameters
Name | Required | Value | Comment |
---|---|---|---|
name | Yes | Name of the mailbox | String |
Yes | Email-address of the mailbox | String | |
from | No | Define from whom to send replies: mailbox or user | String |
users | No | An array of users of the mailbox | Array with ObjectId |
active | No | If mailbox should be active. Value is true or false. | Boolean |
Important Note
In order to see the newly created mailbox, users need to sign out of Helpmonks!
Example
{
"name" : "Support Mailbox",
"email" : "support@domain.com"
}
Returned data
Please refer to the Mailbox Data Model to see the data structure being returned