Update client notes

URL

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

Sample URLs

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

Parameters

All fields are required:

Field	Data Type	Description
subject	String	Subject of note.
description	String	Summary describing the note.
expiryDateType	Integer	Type of expiry. If expiryDateType is set as 1, it indicates Never Expire. If expiryDateType is set as 2, it indicates Validity period.
startTime	String	Date and time from which the note is valid. This is applicable only if expiryDateType is set as 2.
expiryTime	String	Date 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"
}

The sample request if set for Expire Now:

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

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-09T06:19:01+0000",
	"startTime": "2016-09-08T00:00:00+0000",
	"expiryTime": "2016-09-14T00:00:00+0000",
	"createdBy": {
		"loginName": "john.smith",
		"lastName": "Smith",
		"firstName": "John",
		"email": "john.smith@gmail.com"
	}
}