Documentation is now available for the Fall 2020 Update release!

Create client notes

This endpoint is used to create client notes.

Leave Feedback

URL

POST https://{api-url}/api/v2/tenants/{tenantId}/notes

Sample URLs

https://{api-url}/api/v2/tenants/client_7/notes

Parameters

All fields are required:

FieldData TypeDescription
subjectStringSubject of note.
descriptionStringSummary describing the note.
expiryDateTypeIntegerType of expiry. If expiryDateType is set as 1, it indicates Never Expire. If expiryDateType is set as 2, it indicates Validity period.
startTimeStringDate and time from which the note is valid. This is applicable only if expiryDateType is set as 2.
expiryTimeStringDate and time on which the note expires. This field is mandatory if expiryDateType is set as 2.

Status code

200 OK

Sample request

The sample request if set for Never Expire:

{
	"subject": "Rest Applications Client",
	"description": "This client is using for Rest applications",
	"expiryDateType": 1
}

The sample request if set for Validity period:

{
	"subject": "Rest Applications Client",
	"description": "This client is using for Rest applications",
	"expiryDateType": 2,
	"startTime": "2016-09-08T05:57:32+0000",
	"expiryTime": "2016-09-30T05:57:32+0000"
}

Sample response

{
	"id": 17,
	"subject": "Rest Applications Client",
	"description": "This client is using for Rest applications",
	"createdTime": "2016-09-09T05:57:32+0000",
	"updatedTime": "2016-09-09T05:57:32+0000",
	"startTime": "",
	"expiryTime": "",
	"createdBy": {
		"loginName": "john.smith",
		"lastName": "Smith",
		"firstName": "John",
		"email": "john.smith@gmail.com"
	}
}