JSON API » notes » notes/delete
Deletes a note.
Input parameters
Requires authentication and the user role privilege, or commerce role if the object type is customer or rate plan, or administrator role if the object is not owned by the user.
| Name | Type | Description | Required | Default value |
|---|---|---|---|---|
| auth_username | String | Authentication username. | Yes | |
| auth_password | String | Authentication password. | Yes | |
| id | Integer | ID of note to delete. | Yes |
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 note 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/notes/delete/?auth_username=user;auth_password=password;id=123{ "responses":[ { "code":"204", "key":"", "message":"OK" } ] }
Change history
| Version | Changes |
|---|---|
| 3.13 | Function added. |