Add a note to a record

POST

/api/nova/journal/{recordId}

Creates a timeline note against the record given by the recordId path parameter, which may be a candidate, contact, company, lead, job or placement. Only the note field is required; HTML is sanitized server-side. activityTypeId is resolved against the account's activity types and falls back to Comment when omitted or unknown, createdByUserId attributes the note to another user and defaults to the API key's own user, reminderDate accepts dd/MM/yyyy HH:mm:ss, and linkedRecordIds attaches the note to further records in addition to the one in the path so it appears on each of their timelines. Returns the created note id. Responds with 400 when the note is empty or any record - the one in the path or a linked one - cannot be found, and 401 for an invalid API key.

Authorizations

privateApiKey

Type

API Key (query: apiKey)

Parameters

Path Parameters

recordId*

recordId

Type

string

Required

Query Parameters

apiKey*

apiKey

Type

string

Required

Request Body

application/json

{

  

"activityTypeId": "string",

  

"createdByUserId": "string",

  

"linkedRecordIds": [

  

  

"string"

  

],

  

"note": "string",

  

"reminderDate": "string"

}

Responses

OK

Content-Type

application/json

{

  

"data": {

  

},

  

"error": "string",

  

"message": "string",

  

"requestId": "string",

  

"success": true

}

POST

/api/nova/journal/{recordId}

Playground

Authorization

privateApiKey

Variables

Key

Value

recordId*

apiKey*

Body

Samples