INTRODUCTION

RECIPIENT USE CASES

FINANCIAL ACCOUNT USE CASES

PAYMENT REASON USE CASES

TRANSACTION USE CASES

NOTE USE CASES

Design  /  Note Use Cases  /  Update a Note

Update a Note

Overview

In this use case, we’ll walk through updating a note belonging to a Financial Account, Recipient Account, Team Member, or transaction. You can update the note title (title) and body (contentText).

API Operation

Steps

Send a request to the following endpoint:

PATCH /api/external/v1/notes/{id}

  • Use the {id} path parameter to specify the ID of the note to be updated.
  • Include the fields you want to update in the request body. You can update the note title (title) and body (contentText).
  • Include a Basic Auth Authorization header where the username is your API key ID and the password is your API key secret.

Sample Request

The following request would update the note title and body.

				
					{
  "title": "USD",
  "contentText": "Account uses USD funds."
}
				
			

Sample Response

The updated note details are returned.

				
					{
  "id": "8th32z87-3845-9810-v7gu-1f827g98swk3",
  "createdAt": "2021-09-20T22:09:31.947Z",
  "updatedAt": "2021-09-20T22:09:31.947Z",
  "createdBy": "7wu45p35-2178-3098-x6wg-2s749k37alk2",
  "state": "ACTIVE",
  "businessAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "entityType": "FINANCIAL_ACCOUNT",
  "entityId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
  "title": "USD",
  "contentText": "Account uses USD funds.",
  "contentType": "",
  "externalUrl": "",
  "sizeInBytes": 0
}
				
			
ON THIS PAGE