REregdoor
internal-notes

Create Internal Note

Create an internal note.

Args:

  • company_uuid: The UUID of the company
  • internal_note: The internal note to create
  • text: The text of the internal note
  • parent_pk: The primary key of the parent entity (id or UUID)
  • parent_type: The type of the parent entity (Jurisdiction, Organization, Contact, Interaction, Project)
post/api/companies/{company_uuid}/internal-notes/

Request

  • Base URL
    https://api.regdoor.com (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

company_uuidstring uuid required

Headers

X-User-Emailstring nullable
X-User-Namestring nullable

Request body

textstring required
parent_pkstring required
parent_type'Jurisdiction' | 'Organization' | 'Contact' | 'Interaction' | 'Project' | 'Event' | 'Task' required

Response

Successful Response

uuidstring uuid4 required
parent_type'Jurisdiction' | 'Organization' | 'Contact' | 'Interaction' | 'Project' | 'Event' | 'Task' required
parent_pkstring required
company_uuidstring uuid4 required
textstring required
author_type'Human' | 'System' required

Who wrote the note. SYSTEM notes are automatic audit entries (e.g. a Task status-transition log) — they have no created_by_uuid and are, by construction, never editable/deletable via update()/soft_delete() since those check created_by_uuid == current_user.

created_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.