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, Team Member, or transaction. A note includes a title and content.

API Operation

Create a Note

Steps

Send a request to the following endpoint:

POST /v1/notes

Include an Authorization header with your RocketKOR access token as a Bearer Token.
In the request body, use the entityId and entityType parameters to specify the Financial Account, Recipient, 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.

Sample Request

The following request would create a note for a Financial Account.

				
					{
  "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 are also returned. For details, see the Note object.

				
					{
  "id": "8th32z87-3845-9810-v7gu-1f827g98swk3",
  "entityType": "FINANCIAL_ACCOUNT",
  "entityId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
  "title": "Joint Account",
  "contentText": "This is a joint account.",
  "contentType": "",
  "externalUrl": "",
  "sizeInBytes": 0,
  "businessAccountId": "6a017f06-83a3-44b7-be6f-5e5cae4a9ed7",
  "createdBy": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "EMPLOYEE"
  },
  "createdAt": "2021-09-20T22:09:31.947Z",
  "updatedBy": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "type": "EMPLOYEE"
  },
  "updatedAt": "2021-09-20T22:09:31.947Z"
}

Create a Note

Overview

API Operation

Steps

Sample Request

Sample Response

ON THIS PAGE