Parameter name | Value | Description |
---|---|---|
id |
string |
Identifier of the note. |
clientId |
string |
Identifier of the client. Max length: 16. |
html |
string |
Html content of the note. Max length: 65535. |
date |
object |
The date time of the note. |
start.dateTime |
string |
The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). |
start.timeZone |
string |
The time zone. Possible values can be found here. The default value is the time zone of the company. |
writer |
object |
Writer of the notes. |
writer.email |
string |
Account email of the user. Max length: 255. |
writer.firstName |
string |
First Name of the user. Max length: 255. |
writer.lastName |
string |
Last Name of the user. Max length: 255. |
selfLink |
string |
URL link to the note resource description. |
contactedByClient |
boolean |
Manual update of the last consent date |
Authentication is required to execute this request. Please refer to Authentication for more.
{noteId}
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
noteId |
string |
Note identifier. |
Required query parameters | ||
apiKey |
string |
API Key |
Do not supply a request body with this method.
If successful, this method returns an empty response body.
Authentication is required to execute this request. Please refer to Authentication for more.
{noteId}
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
noteId |
string |
Note identifier. |
Required query parameters | ||
apiKey |
string |
API Key |
Do not supply a request body with this method.
If successful, this method returns a Note resource in the response body.
Authentication is required to execute this request. Please refer to Authentication for more.
Parameter name | Value | Description |
---|---|---|
Required query parameters | ||
apiKey |
string |
API Key |
Optional query parameters | ||
clientId |
string |
Identifier of the client. |
Do not supply a request body with this method.
If successful, this method returns a response body with the following structure:
Authentication is required to execute this request. Please refer to Authentication for more.
Parameter name | Value | Description |
---|---|---|
Required query parameters | ||
apiKey |
string |
API Key |
In the request body, supply a Note Resource with the following properties:
Parameter name | Value | Description |
---|---|---|
Required Properties | ||
clientId |
string |
Identifier of the client. |
html |
string |
Html content of the note. |
Optional Properties | ||
writer |
object |
Writer of the notes. |
writer.email |
string |
Account email of the user. |
contactedByClient |
boolean |
Manual update of the last consent date |
If successful, this method returns a Note resource in the response body.
Authentication is required to execute this request. Please refer to Authentication for more.
{noteId}
Parameter name | Value | Description |
---|---|---|
Path parameters | ||
noteId |
string |
Note identifier. |
Required query parameters | ||
apiKey |
string |
API Key |
In the request body, supply a Note resource with the following properties:
Parameter name | Value | Description |
---|---|---|
Optional Properties | ||
html |
string |
Html content of the note. |
writer |
object |
Writer of the notes. |
writer.email |
string |
Account email of the user. |
If successful, this method returns a Note resource in the response body.
Watch for changes to notes.
Authentication is required to execute this request. Please refer to Authentication for more.
The watch send a Note resource in the request body
Required Properties | ||
address |
string |
The address where notifications are delivered for this watch. |
Optional Properties | ||
name |
string |
Name of the watch. |
basicAuth |
string |
Credentials parameters for HTTP Basic authentication on the destination watch address. Only if you use this authentication method. |
basicAuth.username |
string |
Username. |
basicAuth.password |
string |
Password. |
httpRequestHeader |
string |
Custom header parameters to send with the http request on the destination watch address. |
httpRequestHeader.name |
string |
header parameter name. |
schema |
object |
Custom json schema to apply for resource properties. |
method |
string |
HTTP Method to use for sending content. DELETE Method doesn't accept body content. |
status |
string |
Status of the watcher. Values: "enabled", "disabled" |
oauth2Auth |
string |
Credentials parameters for HTTP OAuth2 authentication on the destination watch address. Only if you use this authentication method. |
oauth2Auth.clientId |
string |
OAuth2 client id. |
oauth2Auth.refreshToken |
string |
OAuth2 refresh token. |
oauth2Auth.authUrl |
string |
OAuth2 interactive end point to initiate the generation of the refresh token. |
oauth2Auth.accessTokenUrl |
string |
OAuth2 end point to generation an access token from the refresh token. |
oauth2Auth.scope |
string |
OAuth2 api scope. |
signature |
object |
Produces a crypto signature of the watched content. |
signature.enabled |
boolean |
Sets if the signature is enabled or not. |
signature.cryptoKeyIds |
list |
Arrays of string of crypto keys identifier. |
If successful, this method returns a watch resource in the response body.
With JSON, only for string value:
With string to support typed values:
Replacement string can by defined with jsonpath expressions.