Notes

Notes represent notes associated with a client. They can be used to store additional information about a client.

The Note object

Properties

  • idstring

    The unique identifier of the note.

  • contentstring

    The content of the note.

  • editedByUserobject

    The user that updated the note.

  • userobject

    The user that created the note.

  • createdAtdate

    The date and time the entity was created.

  • updatedAtdate

    The date and time the entity was last updated.

Client object

{
  "id": "66544909366ad2457193231f",
  "content": "<p>Internal note</p>",
  "user": { 
    "id": "6548c11c5136b418fd626e2f", 
    "name": "John Doe" 
  },
  "createdAt": "2024-05-27T08:49:13.476Z"
}
POST/v2/clients/:id/notes

Create a note

This endpoint allows you to add a new note.

Parameters

  • contentstring Required

    content

Request

POST
/v2/clients/:id/notes
curl https://api.lsp.expert/v2/clients/6548c72a13162e1d7ade0290/notes \
  -u {key}: \
  -d content="Internal note"

Response

{
  "id": "6548c72a13162e1d7ade0290",
  "name": "Microsoft",
  "address": {
    "name": "Microsoft"
  },
  "archived": false,
  "notes": [
    {
      "id": "66544909366ad2457193231f",
      "content": "<p>Internal note</p>",
      "user": { 
        "id": "6548c11c5136b418fd626e2f", 
        "name": "John Doe" 
      },
      "createdAt": "2024-05-27T08:49:13.476Z"
    }
  ]
  // ...
}
PUT/v2/clients/:id/notes/:noteId

Update a note

This endpoint allows you to perform an update on a note. Any parameters not provided will be left unchanged.

Parameters

  • contentstring Required

    content

Request

PUT
/v2/clients/:id/notes/:noteId
curl -X PUT https://api.lsp.expert/v2/clients/66f1313f9e477f90664d1ad8/notes/66544909366ad2457193231f \
  -u {key}: \
  -d content="Update content"

Response

{
  "id": "6548c72a13162e1d7ade0290",
  "name": "Microsoft",
  "address": {
    "name": "Microsoft"
  },
  "archived": false,
  "notes": [
    {
      "id": "66544909366ad2457193231f",
      "content": "<p>Update content</p>",
      "user": { 
        "id": "6548c11c5136b418fd626e2f", 
        "name": "John Doe" 
      },
      "user": { 
        "id": "6548c11c5136b418fd626e2f", 
        "name": "John Doe" 
      },
      "editedByUser": { 
        "id": "6548c11c5136b418fd626e2f", 
        "name": "John Doe" 
      },
      "createdAt": "2024-05-27T08:49:13.476Z",
      "updatedAt": "2024-05-29T08:49:13.476Z"
    }
  ]
  // ...
}
DELETE/v2/clients/:id/notes/:noteId

Delete a note

This endpoint allows you to delete a note.

Request

DELETE
/v2/clients/:id/notes/:noteId
curl -X DELETE https://api.lsp.expert/v2/clients/:66f1313f9e477f90664d1ad8/notes/66544909366ad2457193231f \
  -u {key}:

Response

{
  "id": "6548c72a13162e1d7ade0290",
  "name": "Microsoft",
  "address": {
    "name": "Microsoft"
  },
  "archived": false,
  "notes": []
  // ...
}