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

# Create note

`POST /notes`

Creates a new note in [VTEX DO](https://help.vtex.com/en/tutorial/vtex-do--7KMbRL4OslN8DTX9oiuCiu). Be aware of the following limitations:


- The maximum number of notes for an order is 30.


- The maximum number of characters in a note's description is 2000.

## Permissions

This endpoint does not require [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3).

## Headers

- `Content-Type` string, required
- `Accept` string, required

## Request body

- object
  - `target` object, required — Target.
    - `id` string — Target ID.
    - `type` string — Target type.
    - `url` string — You can choose between using the complete target URL or only `/orders/{OrderID}`.
  - `domain` string, required — Domain identification.
  - `description` string, required — Note description. Maximum number of characters: 2000.
  - `createdBy` object — Object with information about the user that created the note.
    - `id` string — Identification code of the user that created the note.
    - `name` string — Name of the user that created the note.

## Response `200`

OK

- object
  - `id` string — Note ID.
  - `domain` string — VTEX module `oms`.
  - `owner` string — Owner ID.
  - `target` object — Target object information.
    - `id` string — Order ID.
    - `type` string — Target type.
    - `url` string — Target URL.
  - `description` string — Note description.
  - `creationDate` string — Creation date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.
  - `lastUpdate` string — Last update date in [UTC time format](https://learn.microsoft.com/en-us/rest/api/storageservices/formatting-datetime-values), as in `YYYY-MM-DDThh:mm:ssZ`.
  - `createdBy` object, nullable — Identification of the user who created the note.
    - `id` string — User ID.
    - `name` string — User name.
    - `email` string — User email.
    - `key` string, nullable — Authentication key used.

## Changes

> 53 revisions in range; 18 could not be searched.

- **2024-06-21** `a297dc0d5d17` — 4 breaking, 1 warning
  - the `createdBy/email` response's property type/format changed from `string`/`` to `object`/`` for status `200`
  - the `createdBy/id` response's property type/format changed from `string`/`` to `object`/`` for status `200`
  - the `createdBy/key` response's property type/format changed from `string`/`` to `object`/`` for status `200`
  - the `createdBy/name` response's property type/format changed from `string`/`` to `object`/`` for status `200`
  - …1 more

[Change history](https://skmtc.dev/vtex/apis/vtex-do-api/changes/notes/post.md)

---

[API](https://skmtc.dev/vtex/apis/vtex-do-api.md) · [All operations](https://skmtc.dev/vtex/apis/vtex-do-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/vtex/vtex-do-api/revisions/606bdad07f53/schema)