Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
Notes

Patch Note

Update a Note by ID.

patch/notes/{note_id}

Path parameters

note_idstring uuid required
Example:64438afd-fa20-4010-a573-2bbdca77cdb6

The unique identifier of a note

Query parameters

related_resource_type'ACCOUNT' | 'APPLICATION' | 'BILLING' | 'BUSINESS' | 'CUSTOMER' | 'FILE' | 'SHADOW_TRANSACTION' | 'SNAPSHOT' | 'TENANT' | 'TRANSACTION' | 'USER'

Type of the resource associated with the note.

Example:CUSTOMER

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

Headers

Idempotency-Keystring
Example:7d943c51-e4ff-4e57-9558-08cab6b963c7

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.

Request body

status'RESOLVED' | 'UNRESOLVED'

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.

Example request

{
  "status": "RESOLVED"
}

Response

Updated Note representation.

authorstring required

The note's author.

contentstring required

The note's text content.

creation_timestring date-time required

The date and time the note was created.

idstring uuid required

note ID

last_updated_timestring date-time required

The date and time the note was last updated.

metadataMetadata

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

related_resource_fieldstring

🚧 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
related_resource_idstring 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.

related_resource_type'ACCOUNT' | 'APPLICATION' | 'BILLING' | 'BUSINESS' | 'CUSTOMER' | 'FILE' | 'SHADOW_TRANSACTION' | 'SNAPSHOT' | 'TENANT' | 'TRANSACTION' | 'USER' required

Type of the resource associated with the note.

status'RESOLVED' | 'UNRESOLVED'

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.

tenantstring required

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

type'ACCOUNT_FROZEN' | 'ACCOUNT_SUSPENDED' | 'CUSTOMER_SUSPENDED' | 'FEEDBACK' | '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

Example response

{
  "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",
  "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"
}