Skip to content
API reference/
API Reference
/
/
Create a note

Create a note

Request

Create a note for an episode in inbox.

Security
apiKeyAuth and practiceGroupId
Bodyapplication/jsonrequired
episode_idstring^\d+$required
descriptionstring, non-emptyrequired

The content of the note to add to the episode.

Example:"Patient reported improved symptoms today."
curl -i -X POST \
  https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/notes \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "episode_id": "string",
    "description": "Patient reported improved symptoms today."
  }'

Responses

Note created successfully

Bodyapplication/json
idnumberrequired
descriptionstringrequired
adminobjectrequired
practice_group_idnumberrequired
archived_atstring or nullrequired
created_atstringrequired
updated_atstringrequired
Response
{
  "id": 0,
  "description": "string",
  "admin": {
    "id": 0,
    "first_name": "string",
    "last_name": "string",
    "full_name": "string"
  },
  "practice_group_id": 0,
  "archived_at": "string",
  "created_at": "string",
  "updated_at": "string"
}