---
title: "Create a note"
method: POST
path: "/notes"
tags: ["Notes"]
---

# Create a note

`POST /notes`

Create a note

## Request body

- NoteCreate
  - `content` string, required — The note's text content.
  - `metadata` Metadata — Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
  - `related_resource_field` string — 🚧 Beta This is a Beta property. Feedback from the community is welcome. We may make breaking changes to this property. Path to the field in the related resource that the note pertains to. This uses a dot notation like the following: Examples: * a field in the resource: first_name * a sub-field: legal_address.city * nested arrays: application_details.sections[1].pages[2].items[0].answer
  - `related_resource_id` string, required — The id of the resource that is associated with the note. This is typically a UUID. For TENANT it is a string tenant ID.
  - `related_resource_type` 'ACCOUNT' | 'APPLICATION' | 'BILLING' | 'BUSINESS' | 'CUSTOMER' | 'FILE' | 'SHADOW_TRANSACTION' | 'SNAPSHOT' | 'TENANT' | 'TRANSACTION' | 'USER', required — Type of the resource associated with the note.
  - `status` 'RESOLVED' | 'UNRESOLVED' — The state of the FEEDBACK, use this field to mark fields as RESOLVED or UNRESOLVED. This is required when creating a note with type FEEDBACK. Providing a status with note type NOTE will result in a Bad Request error.
  - `tenant` string — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
  - `type` 'ACCOUNT_FROZEN' | 'ACCOUNT_SUSPENDED' | 'CUSTOMER_SUSPENDED' | 'FEEDBACK' | 'NOTE' — The type of note. - FEEDBACK: User feedback that can be marked resolved/unresolved - NOTE: General note - ACCOUNT_FROZEN: Automatically created when an account is frozen - ACCOUNT_SUSPENDED: Automatically created when an account is suspended - CUSTOMER_SUSPENDED: Automatically created when a customer is suspended

## Response `201`

Created note

- NoteResponse
  - `author` string, required — The note's author.
  - `content` string, required — The note's text content.
  - `creation_time` string, date-time, required — The date and time the note was created.
  - `id` string, uuid, required — note ID
  - `last_updated_time` string, date-time, required — The date and time the note was last updated.
  - `metadata` Metadata — Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.
  - `related_resource_field` string — 🚧 Beta This is a Beta property. Feedback from the community is welcome. We may make breaking changes to this property. Path to the field in the related resource that the note pertains to. This uses a dot notation like the following: Examples: * a field in the resource: first_name * a sub-field: legal_address.city * nested arrays: application_details.sections[1].pages[2].items[0].answer
  - `related_resource_id` string, required — The id of the resource that is associated with the note. This is typically a UUID. For TENANT it is a string tenant ID.
  - `related_resource_type` 'ACCOUNT' | 'APPLICATION' | 'BILLING' | 'BUSINESS' | 'CUSTOMER' | 'FILE' | 'SHADOW_TRANSACTION' | 'SNAPSHOT' | 'TENANT' | 'TRANSACTION' | 'USER', required — Type of the resource associated with the note.
  - `status` 'RESOLVED' | 'UNRESOLVED' — The state of the FEEDBACK, use this field to mark fields as RESOLVED or UNRESOLVED. This is required when creating a note with type FEEDBACK. Providing a status with note type NOTE will result in a Bad Request error.
  - `tenant` string, required — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
  - `type` 'ACCOUNT_FROZEN' | 'ACCOUNT_SUSPENDED' | 'CUSTOMER_SUSPENDED' | 'FEEDBACK' | 'NOTE' — The type of note. - FEEDBACK: User feedback that can be marked resolved/unresolved - NOTE: General note - ACCOUNT_FROZEN: Automatically created when an account is frozen - ACCOUNT_SUSPENDED: Automatically created when an account is suspended - CUSTOMER_SUSPENDED: Automatically created when a customer is suspended

## Other responses

- `400` — BadRequest
- `401` — Unauthorized
- `403` — Forbidden error
- `409` — Resource already exists error
- `500` — Internal server error

---

[API](https://skmtc.net/synctera/apis/synctera-api.md) · [All operations](https://skmtc.net/synctera/apis/synctera-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/synctera/synctera-api/revisions/b0d812e6cdd0/schema)