JSON API » messages » messages/text/delete

Deletes a text message.

Input parameters

Requires authentication and the texts role privilege.

NameTypeDescriptionRequiredDefault value
auth_usernameStringAuthentication username.Yes
auth_passwordStringAuthentication password.Yes
uniqueidStringUniqueid of message to delete.Yes

Responses

CodeDescription
204Text message successfully deleted.
401The authentication details provided are invalid.
402Your role does not allow this.
404The 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

VersionChanges
3.13Function added.