Sign in

v2

latestOpenAPI 3.0.02026-08-0793108394.2 KB
Property Claim

Update a note

patch/v1/property_claims/{property_claim_id}/notes/{note_id}

Headers

X-Encircle-Attributionstring

String used to internally identify which integrator made this request on behalf of their users.

Integrators should reuse the same 'X-Encircle-Attribution' value for all their users.

This attribution enables Encircle to provide better assistance to integrators if they encounter any issues.

If not specified, the request will not be associated with any integration services.

X-Encircle-Requeststring

Unique string used to identify each specific request.

Any retries due to connection failures should reuse the same 'X-Encircle-Request' value. This helps prevent duplicate requests from unintentionally being processed again.

If not specified, the request will be treated as unique and it will be processed normally.

Request body

titlestring nullable

The title of the Note.

textstring nullable

The contents of the Note.

Response

The Note that was updated successfully.

idinteger required
client_createdstring date-time nullable required

client_created is the timestamp at which a user's client created the model. It is typically earlier than the server_created timestamp, but since this timestamp is provided by the client and not verified, it could have been altered to any time in the past or future.

The Encircle mobile app allows users to work offline. This timestamp captures the time that the model was created locally, regardless of when the client goes back online.

Encircle web and mobile applications typically display the earlier of the client_created and server_created timestamps.

Refer to server_created for the timestamp recorded by Encircle servers.

A RFC 3339 compliant date-time string.

server_createdstring date-time required

server_created is the timestamp at which Encircle servers created the model. It is typically later than the client_created timestamp (unless the client had provided an inaccurate timestamp). This unbounded delay depends on how long the client took to sync with the server.

The Encircle mobile app allows users to work offline, which means that a client can create a model, wait a day, then go online and sync with Encircle servers. The server's timestamp would be delayed by about a day after the model's creation on the client.

Refer to client_created for the client provided timestamp.

A RFC 3339 compliant date-time string.

titlestring nullable required

The title of the Note.

textstring nullable required

The contents of the Note.

Example response

{
  "client_created": "1969-07-20T20:17:40Z",
  "server_created": "1969-07-20T20:17:40Z"
}