JSON API » messages » messages/update

Updates an existing message. Only affects voicemails left using Enswitch voicemail.

Input parameters

Requires authentication and the features, messages, 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 containing message.	Yes
folder	String	Folder containing message. Most commonly "INBOX".	Yes
message	String	Message to update.	Yes
body	String	Message body.	No	Empty string.
customer	Integer	ID of customer owning mailbox.	No	Customer of authentication user.
notify	Integer	1 to send notifications for message, 0 not to.	No	0

Responses

Code	Description
204	Success.
400	Invalid input parameters specified. Check the key and message fields for more details.
401	The authentication details provided are invalid.
402	Your role does not allow this.
404	The mailbox or message does not exist.

Data returned

No data is returned.

Example: Setting the body and sending notifications

http://enswitch.example.com/api/json/messages/update/?auth_username=user;auth_password=password;mailbox=1234;folder=INBOX;message=msg0001;body=This+is+a+test+voicemail;notify=1

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

Change history

Version	Changes
3.14	Function added.