---
title: "Create an honeytoken note"
method: POST
path: "/v1/honeytokens/{honeytoken_id}/notes"
tags: ["Honeytoken Notes"]
---

# Create an honeytoken note

`POST /v1/honeytokens/{honeytoken_id}/notes`

Add a note on a honeytoken.

## Path parameters

- `honeytoken_id` string, uuid, required

## Request body

- object
  - `comment` string, required — Content of the honeytoken note

## Response `201`

The note was created successfully.

- object
  - `id` string, uuid
  - `honeytoken_id` string, uuid — Id of the related Honeytoken
  - `member_id` integer, nullable — Id of the member who created this note. Can be null if the note was not created by a member or if the member was deleted.
  - `api_token_id` string, uuid, nullable — ID of the API key which created this note. Can be null if the note was not created via the API.
  - `created_at` string, date-time — Creation date of the note
  - `updated_at` string, date-time — Last time the content of the note was updated. Null if the comment was never modified.
  - `comment` string

## Other responses

- `400` — Invalid data
- `401` — Invalid API key
- `404` — Honeytoken not found.
- `503` — API under maintenance

---

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