JSON API » mailboxes » mailboxes/files/delete

Deletes a mailbox greeting.

Input parameters

Requires authentication and the administrator, residential, or user role privileges.

Name	Type	Description	Required	Default value
auth_username	String	Authentication username.	Yes
auth_password	String	Authentication password.	Yes
mailbox	String	Mailbox.	Yes
file	String	Which greeting to delete. "busy", "greet" (for mailbox name), "temp", or "unavail".	Yes
customer	Integer	ID of customer owning mailbox.	No	Customer of authentication user.

Responses

Code	Description
204	Success.
400	Invalid file specified.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The mailbox or file does not exist, or you do not have permission to delete it.

Data returned

No data is returned.

Example: With required parameters

http://enswitch.example.com/api/json/mailboxes/files/delete/?auth_username=user;auth_password=password;mailbox=1234;file=busy

{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }

Change history

Version	Changes
3.13	Function added.