Skip to main content
PATCH
/
notes
/
{note_id}
Patch Note
curl --request PATCH \
  --url https://api.synctera.com/v2/notes/{note_id} \
  --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": "ACCOUNT",
  "status": "RESOLVED",
  "tenant": "abcdef_ghijkl",
  "type": "NOTE"
}

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,
BUSINESS,
CUSTOMER,
EDD,
INVOICE,
REVENUE_STATEMENT

Body

application/json
​
status
enum<string>

The state of the FEEDBACK, use this field to mark fields as RESOLVED or UNRESOLVED. This is required when creating a note with type FEEDBACK. Providing a status with note type NOTE will result in a Bad Request error.

Available options:
UNRESOLVED,
RESOLVED
Example:

"RESOLVED"

Response

Updated Note representation.

​
author
string
required

The note's author.

Example:

"Jane Smith jane@example.com"

​
content
string
required

The note's text content.

Example:

"Customer was frozen to investigate fraud."

​
creation_time
string<date-time>
required

The date and time the note was created.

Example:

"2010-05-06T12:23:34.321Z"

​
id
string<uuid>
required

note ID

Example:

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

​
last_updated_time
string<date-time>
required

The date and time the note was last updated.

Example:

"2010-05-06T12:23:34.321Z"

​
related_resource_id
string
required

The id of the resource that is associated with the note. This is typically a UUID. For TENANT it is a string tenant ID.

Example:

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

​
related_resource_type
enum<string>
required

The type of the resource related to the document

Available options:
ACCOUNT,
BUSINESS,
CUSTOMER,
EDD,
INVOICE,
REVENUE_STATEMENT
​
tenant
string
required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

Example:

"abcdef_ghijkl"

​
metadata
object

Optional field to store additional information about the resource. Intended to be used by the integrator to store non-sensitive data.

​
related_resource_field
string

🚧 Beta This is a Beta property. Feedback from the community is welcome. We may make breaking changes to this property. Path to the field in the related resource that the note pertains to. This uses a dot notation like the following: Examples:

  • a field in the resource: first_name
  • a sub-field: legal_address.city
  • nested arrays: application_details.sections[1].pages[2].items[0].answer
Example:

"/legal_address/city"

​
status
enum<string>

The state of the FEEDBACK, use this field to mark fields as RESOLVED or UNRESOLVED. This is required when creating a note with type FEEDBACK. Providing a status with note type NOTE will result in a Bad Request error.

Available options:
UNRESOLVED,
RESOLVED
Example:

"RESOLVED"

​
type
enum<string>
default:NOTE

The type of note.

  • FEEDBACK: User feedback that can be marked resolved/unresolved
  • NOTE: General note
  • ACCOUNT_FROZEN: Automatically created when an account is frozen
  • ACCOUNT_SUSPENDED: Automatically created when an account is suspended
  • CUSTOMER_SUSPENDED: Automatically created when a customer is suspended
Available options:
FEEDBACK,
NOTE,
ACCOUNT_FROZEN,
ACCOUNT_SUSPENDED,
CUSTOMER_SUSPENDED
Example:

"NOTE"