mailbox.alias.create

Mailbox aliases are used to group the mailboxes of multiple things thus simplifying the mailbox.send command. This command creates a new alias.

TR50 Request


                        {
  "cmd": {
    "command": "mailbox.alias.create",
    "params": {
      "key": "@MYALIAS",
      "name": "Alias test",
      "things": [
        "54934bae74e00c110f000043",
        "55c0d177681fdc3ccb0e6ccc"
      ]
    }
  }
}

Request Parameters


Name	Type	Required	Description
key	String	Yes	Alias key begins with the @ character followed by uppercase alphabets. It is possible to use any characters that are valid in a key. For more information, see Field Formats and Limitations.
name	String	Yes	Alias name.
things	Array	Yes	Array of things IDs.

TR50 Response


                        {
  "auth": null,
  "data": {
    "success": true,
    "params": {
      "id": "56dddc9b681fdc646f0eaaef"
    }
  }
}

Response Parameters


Name	Type	Description
id	String	ID of the new alias.