Create Device Note

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

This endpoint attaches a new note to a device. It sends an HTTP POST request to https://hub.xyte.io/core/v1/organization/devices/{device_id}/notes.

Notes created through the API have a null created_by, since API calls carry no user context.

Authorization

This endpoint requires Authorization.

Path Parameters

ParameterTypeDescription
device_idstringUnique identifier of the device (UUID).

Request Body

KeyTypeDescriptionRequired
contentstringNote content. Supports markdown.Yes
{
  "content": "Replaced PSU on 2026-06-01. Next maintenance due in 12 months."
}

Response

Returns the created note:

KeyTypeDescription
idstringUnique identifier of the note (UUID).
contentstringNote content.
notable_typestringAlways Device for this endpoint.
notable_idstringUnique identifier of the device the note is attached to.
created_bystringAlways null for notes created through the API.
created_atstringDate and time the note was created, in ISO 8601 format.
updated_atstringDate and time the note was last updated, in ISO 8601 format.

Errors

StatusDescription
404The device does not exist or does not belong to your organization.
422The content field is missing or blank.
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!