PATCH
/
notes
/
{note_id}
Patch Note
curl --request PATCH \
  --url https://api-sandbox.synctera.com/v0/notes/{note_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "RESOLVED"
}'
{
  "author": "Jane Smith jane@example.com",
  "content": "Customer was frozen to investigate fraud.",
  "creation_time": "2010-05-06T12:23:34.321Z",
  "id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "last_updated_time": "2010-05-06T12:23:34.321Z",
  "metadata": {},
  "related_resource_field": "/legal_address/city",
  "related_resource_id": "7d943c51-e4ff-4e57-9558-08cab6b963c7",
  "related_resource_type": "CUSTOMER",
  "status": "RESOLVED",
  "tenant": "abcdef_ghijkl",
  "type": "NOTE"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
Idempotency-Key
string

An idempotency key is an arbitrary unique value generated by client to detect subsequent retries of the same request. It is recommended that a UUID or a similar random identifier be used as an idempotency key. A different key must be used for each request, unless it is a retry.

Example:

"7d943c51-e4ff-4e57-9558-08cab6b963c7"

Path Parameters

​
note_id
string<uuid>
required

The unique identifier of a note

Example:

"64438afd-fa20-4010-a573-2bbdca77cdb6"

Query Parameters

​
related_resource_type
enum<string>

Only return notes that have a related resource with the specified type.

Available options:
ACCOUNT,
APPLICATION,
BUSINESS,
CUSTOMER,
FILE,
SHADOW_TRANSACTION,
SNAPSHOT,
TENANT,
TRANSACTION,
USER
Example:

"CUSTOMER"

Body

application/json

Response

200
application/json

Updated Note representation.

The response is of type object.