RocketKOR

Introduction

Authentication

Sorting and Pagination

Errors

Create a Note

Create a note for a Business or Recipient Financial Account, Recipient Account, Team Member, or transaction. A note includes a title (title) and body (contentText).

Endpoint

POST /notes

Authorization Header

Authorization: Bearer <access_token>

where <access_token> is your RocketKOR access token.

Request Body

entityId  REQUIRED

string (UUID)

ID of the entity to which the note is attached. A note can be attached to a Financial Account, Recipient Account, Team Member, or transaction.

entityType  REQUIRED

string enum, values: FINANCIAL_ACCOUNT, RECIPIENT, TEAM_MEMBER, TRANSACTION

Type of entity to which the note is attached. A note can be attached to a Financial Account, Recipient Account, Team Member, or transaction.

title

string, max length: 128

Note title.

contentText

string, max length: 1000

Note content.

Returns

Returns the note details, including a unique ID for the note. For details, see the Note object.

SAMPLE REQUEST

				
					{
  "entityType": "FINANCIAL_ACCOUNT",
  "entityId": "4py56a34-4686-1539-c2ga-1a723g55dlq3",
  "title": "Joint Account",
  "contentText": "This is a joint account."
}
				
			

SAMPLE RESPONSE

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