Create a note for a Financial Account, Recipient, Team Member, or transaction. A note includes a title (title) and body (contentText).
POST /v1/notes
Authorization: Bearer <access_token>
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 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-10-20T22:09:31.947Z"
}
© 2022 Rocket Financial. All rights reserved. RocketFNCL, RocketKOR, RocketBNK are trade names of Rocket Financial Inc.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL | © 2023 by Rocket Financial Inc. All rights reserved.
Services Agreement | Privacy Policy | RocketFNCL
© 2023 by Rocket Financial Inc. All rights reserved.