Create a note on an entity
/entities/{entity_uuid}/notes
Create a new note attached to the specified entity. The note inherits the entity's
program and account.
Notes created via this endpoint are attributed to the calling API key (the response
created_by carries { type: "api_key", uuid, label }). They cannot be edited or
deleted from the portal. Any API key on the same account can manage these notes via the
PATCH and DELETE endpoints.
Example Request
POSTRequest Schema
entity_uuid
The entity UUID
Idempotency-Key
Optional client-generated key (typically a UUID) that lets you safely retry a write request without risk of duplicate work or duplicate billing. A retry with the same key and body returns the original response verbatim, with the `Idempotent-Replay: true` response header. Honoured on `POST` requests
note_text
Free-text content of the note. Max 5000 characters.
Available Response Data
12 Data Pointsuuid uuid
The note's UUID
note_number string (A short obfuscated public identifier for the note (e.g. "N-A1-B2C-3D4"))
note_text string (The free-text content of the note (max 5000 characters))
created_by object
Identifies who created the note
is_immutable boolean
When true, the note is an immutable audit-trail entry and cannot be edited or
entity_uuid uuid
UUID of the entity this note is attached to
program_uuid uuid
UUID of the program the entity belongs to
event_uuid uuid
UUID of the event this note is attached to, if any
archived_at timestamp (ISO 8601 timestamp at which the note was archived in the portal (null if not archived))
created_at timestamp
updated_at timestamp
api_reference uuid
unique request identifier for log tracing and audit
API Data Scale & Coverage tag
Unmatched data depth to power your compliance and verification workflows.
Sandbox Environment
Build and test against a sandbox account. Sandbox is a separate account with its own UUID and its own API keys, and the environment is fixed at the account level, so you cannot switch an existing key between live and sandbox with a parameter or header. Both share the same base URL, so the account behind your key is what determines which environment you are in. GET /v1/account returns an environment field of live or sandbox, and that is the authoritative answer.
Calls on a sandbox key are not billed. Every endpoint, response shape, error envelope, idempotency and rate-limit behaviour mirrors live, so the only change when you move to production should be the credentials. Sandbox accounts are provisioned by your Global Data account manager.
Technical Use Cases tag
Onboarding straight from your system
Create the note as part of your own onboarding flow, so WatchEye is populated at the moment the customer is captured instead of by a later import.
Bulk migration
Load an existing book into WatchEye programmatically. Spread the calls evenly instead of bursting, and send an Idempotency-Key so a retried request cannot create a duplicate.
Keeping two systems in step
Mirror creations from your CRM or core system so the monitored population matches the customers you hold.
Compliance & Security tag
Enterprise-grade infrastructure audited against the standards your regulators require.
Common Questions tag
Everything you need to know about implementation details and compliance infrastructure.
rocket_launch Implementation
Is it safe to retry this call?
add
Is it safe to retry this call?
Yes, if you send an Idempotency-Key header. A connection can drop after WatchEye has processed a request but before the response reaches you, and a blind retry would risk a duplicate record or a double charge.
The key is any string of your choosing up to 255 characters, unique per logical operation, and a fresh UUID per request is the usual approach. Sending the same key again returns the original response byte for byte, with no new database changes and no new billable charge.
The header is honoured on POST only. It is silently ignored on GET, PATCH and DELETE, which are already idempotent at the HTTP level.
rocket_launch Implementation
What are the rate limits?
add
What are the rate limits?
600 requests per minute by default, enforced with a 60-second fixed window. Every response carries X-RateLimit-Limit and X-RateLimit-Remaining.
Exceeding the limit returns 429 Too Many Requests with a Retry-After header giving the number of seconds to wait, and X-RateLimit-Reset giving the reset timestamp. Schedule retries from Retry-After instead of a fixed sleep, and slow down before you hit zero, not after.
Higher limits can be arranged case by case through WatchEye support.
Ready to integrate Create a note on an entity?
Talk to our team about credentials, sandbox access and the right combination of endpoints for your workflow.