INTRODUCTION

RECIPIENT USE CASES

FINANCIAL ACCOUNT USE CASES

PAYMENT REASON USE CASES

TRANSACTION USE CASES

NOTE USE CASES

Design  /  Note Use Cases  /  Create a Note

Create a Note

Overview

In this use case, we’ll walk through creating a note for a Financial Account, Recipient Account, Team Member, or transaction. A note includes a title and content.

API Operation

Steps

Send a request to the following endpoint:

POST /api/external/v1/notes

  • In the request body, use the entityId parameter to specify the Financial Account, Recipient Account, Team Member, or transaction for which you want to create a note. Use the title and contentText parameters to add the note title and body, respectively. For details on all request parameters, see the API Reference.
  • 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 create a note for a Financial Account.

				
					{
  "businessAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "entityType": "FINANCIAL_ACCOUNT",
  "entityId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
  "title": "Joint Account",
  "contentText": "This is a joint account."
}
				
			

Sample Response

If the note is successfully created, a unique ID is returned for the note. Details about the note creation, state, and content also 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": "Joint Account",
  "contentText": "This is a joint account.",
  "contentType": "",
  "externalUrl": "",
  "sizeInBytes": 0
}
				
			
ON THIS PAGE