JSON API » notes » notes/create

Creates a new 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
stype	String	Object type.	Yes
snumber	String	Object number.	Yes
body	String	Note body.	Recommended	Empty string.
customer	Integer	ID of customer to create in.	No	Customer of authentication user.
subject	String	Note subject.	No	Empty string.
validation	Integer	1 to validate input then return, 0 for full action.	No	0

Responses

Code	Description
200	Success.
201	Input passed validation. Only returned if validation=1.
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.

Data returned

The ID of the created note.

Example: With required and recommended parameters

http://enswitch.example.com/api/json/notes/create/?auth_username=user;auth_password=password;stype=phone;snumber=1234567;body=Example+note

{ "responses":[ { "code":"200", "key":"", "message":"OK" } ], "data":{ "id":123 } }

Change history

Version	Changes
3.13	Function added.