JSON API » messages » messages/text/delete
Deletes a text message.
Input parameters
Requires authentication and the texts role privilege.
Name | Type | Description | Required | Default value |
---|---|---|---|---|
auth_username | String | Authentication username. | Yes | |
auth_password | String | Authentication password. | Yes | |
uniqueid | String | Uniqueid of message to delete. | Yes |
Responses
Code | Description |
---|---|
204 | Text message successfully deleted. |
401 | The authentication details provided are invalid. |
402 | Your role does not allow this. |
404 | The text message 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/messages/text/delete/?auth_username=user;auth_password=password;uniqueid=1234567890{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }
Change history
Version | Changes |
---|---|
3.13 | Function added. |