Create | Candid | API Reference

Adds a new note.

This endpoint expects an object.

valuestringRequired

author_emailstringOptional

author_namestringOptional

This endpoint returns an object.

created_atdatetime

deactivatedboolean

True if the object is deactivated. Deactivated objects are not returned in search results but are returned in all other endpoints including scan.

idstring

The unique identifier for a Note.

organization_idstring

The organization that owns this object.

updated_atdatetime

updating_user_idstring

The user ID of the user who last updated the object.

valuestring

versioninteger

The version of the object. Any update to any property of an object object will create a new version.

author_emailstring or null

author_namestring or null

1	from candid import CandidApiClient
2	from candid.resources.pre_encounter.resources.notes.resources.v_1 import (
3	MutableNote,
4	)
5
6	client = CandidApiClient(
7	client_id="YOUR_CLIENT_ID",
8	client_secret="YOUR_CLIENT_SECRET",
9	)
10	client.pre_encounter.notes.v_1.create(
11	request=MutableNote(
12	value="value",
13	),
14	)

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"deactivated": true,
4	"id": "id",
5	"organization_id": "organization_id",
6	"updated_at": "2024-01-15T09:30:00Z",
7	"updating_user_id": "updating_user_id",
8	"value": "value",
9	"version": 1,
10	"author_email": "author_email",
11	"author_name": "author_name"
12	}