Create Note

POST /v1/participants/{participant_id}/notes

Path parameters

participant_id string Required

Participant ID

application/json

Body

New Note Params

note object Required

A note on a participant

Additional properties are allowed.
Hide note attributes Show note attributes object
- author_id string
  
  Author ID
- content string
  
  Note content (HTML formatted)
- date string(date-time)
  
  Note date
- id integer
  
  Note ID
- is_pinned boolean
  
  Whether the note is pinned
- title string
  
  Note title

Responses

201 application/json

Note response
Hide response attribute Show response attribute object
- data object
  
  A note on a participant
  
  Additional properties are allowed.
  
  Hide data attributes Show data attributes object
  
  author_id string
  
  Author ID
  
  content string
  
  Note content (HTML formatted)
  
  date string(date-time)
  
  Note date
  
  id integer
  
  Note ID
  
  is_pinned boolean
  
  Whether the note is pinned
  
  title string
  
  Note title

POST /v1/participants/{participant_id}/notes

curl \
 -X POST http://localhost:4000/v1/participants/uuidv4/notes \
 -H "Content-Type: application/json" \
 -d '{"note":{"id":0,"date":"","title":"","content":"","author_id":"","is_pinned":false}}'

Request example

{
  "note": {
    "id": 0,
    "date": "",
    "title": "",
    "content": "",
    "author_id": "",
    "is_pinned": false
  }
}

Response examples (201)

{
  "data": {
    "id": 0,
    "date": "",
    "title": "",
    "content": "",
    "author_id": "",
    "is_pinned": false
  }
}