# Asterisk Project : Asterisk 13 Mailboxes REST API

Created by wikibot on Aug 08, 2014

# Mailboxes

Method | Path | Return Model | Summary
--- | --- | --- | ---
GET | /mailboxes | List[Mailbox] | List all mailboxes.
GET | /mailboxes/{mailboxName} | Mailbox | Retrieve the current state of a mailbox.
PUT | /mailboxes/{mailboxName} | void | Change the state of a mailbox. (Note - implicitly creates the mailbox).
DELETE | /mailboxes/{mailboxName} | void | Destroy a mailbox.

## GET /mailboxes

List all mailboxes.

## GET /mailboxes/{mailboxName}

Retrieve the current state of a mailbox.

### Path parameters

- mailboxName: string - Name of the mailbox

### Error Responses

- 404 - Mailbox not found

## PUT /mailboxes/{mailboxName}

Change the state of a mailbox. (Note - implicitly creates the mailbox).

### Path parameters

- mailboxName: string - Name of the mailbox

### Query parameters

- oldMessages: int - (required) Count of old messages in the mailbox
- newMessages: int - (required) Count of new messages in the mailbox

### Error Responses

- 404 - Mailbox not found

## DELETE /mailboxes/{mailboxName}

Destroy a mailbox.

### Path parameters

- mailboxName: string - Name of the mailbox

### Error Responses

- 404 - Mailbox not found