Notes

Get notes

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
caseId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The case object unique identifier.

query Parameters

limit	integer [ 1 .. 100 ] Default: 25 The maximum count of results to retrieve.
startingAfter	string Return results starting after the provided object identifier.
endingBefore	string Return results ending before the provided object identifier.
categories	Array of strings (NoteCategory) Filters by the given note categories Items Enum: "generic" "escalationCreateReason" "escalationUpdateReason" "escalationCancelReason"
sortBy	Array of strings The data attributes by which to sort the results.
includeArchived	boolean Default: false Include archived notes into the result
pinned	boolean or null Default: null If `true`, show only pinned notes. If `false`, exclude them. If `null`, do no filtering.

Responses

200

get/people/{personId}/cases/{caseId}/notes

Response samples

application/json

{"status": 0,
"total": 0,
"count": 0,
"nextUrl": "string",
"previousUrl": "string",
"data": [{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"object": "note",
"caseId": "string",
"supercaseId": "string",
"interactionId": "string",
"status": "active",
"type": "borrowerNote",
"content": "string",
"oldContent": [ ],
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"edited": false,
"archived": false,
"taskableInstruction": false,
"createdBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"updatedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedAt": "2019-08-24T14:15:22Z",
"deletedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
}
}
]
}

Create note

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
caseId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The case object unique identifier.

Request Body schema: application/json
required

createdAt	string <date-time>
updatedAt	string or null <date-time>
status	string Enum: "active" "inactive"
content	string The content of the note.
important	boolean Default: false Set to `true` if the note is important.
pinned	boolean Default: false Specify that this note should be sorted to the top of the list by default.
category	string (NoteCategory) Default: "generic" Specifies the nature of a Note Enum: "generic" "escalationCreateReason" "escalationUpdateReason" "escalationCancelReason"
sensitiveData	boolean Default: false Indicates whether the note contains sensitive information.
archived	boolean Default: false Set to `true` if the note has been archived.
taskableInstruction	boolean Default: false Set to `true` if the note is intended to be an instruction which creates a review task.

Responses

200

Success

post/people/{personId}/cases/{caseId}/notes

Request samples

Payload

application/json

{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"status": "active",
"content": "string",
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"archived": false,
"taskableInstruction": false
}

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"object": "note",
"caseId": "string",
"supercaseId": "string",
"interactionId": "string",
"status": "active",
"type": "borrowerNote",
"content": "string",
"oldContent": [ ],
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"edited": false,
"archived": false,
"taskableInstruction": false,
"createdBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"updatedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedAt": "2019-08-24T14:15:22Z",
"deletedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
}
}
}

Get note by ID

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
caseId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The case object unique identifier.
noteId required	string The note identifier.

Responses

200

Success

get/people/{personId}/cases/{caseId}/notes/{noteId}

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"object": "note",
"caseId": "string",
"supercaseId": "string",
"interactionId": "string",
"status": "active",
"type": "borrowerNote",
"content": "string",
"oldContent": [ ],
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"edited": false,
"archived": false,
"taskableInstruction": false,
"createdBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"updatedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedAt": "2019-08-24T14:15:22Z",
"deletedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
}
}
}

Update note

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
caseId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... The case object unique identifier.
noteId required	string The note identifier.

Request Body schema: application/json
required

createdAt	string <date-time>
updatedAt	string or null <date-time>
status	string Enum: "active" "inactive"
content	string The content of the note.
important	boolean Default: false Set to `true` if the note is important.
pinned	boolean Default: false Specify that this note should be sorted to the top of the list by default.
category	string (NoteCategory) Default: "generic" Specifies the nature of a Note Enum: "generic" "escalationCreateReason" "escalationUpdateReason" "escalationCancelReason"
sensitiveData	boolean Default: false Indicates whether the note contains sensitive information.
archived	boolean Default: false Set to `true` if the note has been archived.
taskableInstruction	boolean Default: false Set to `true` if the note is intended to be an instruction which creates a review task.

Responses

200

Success

put/people/{personId}/cases/{caseId}/notes/{noteId}

Request samples

Payload

application/json

{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"status": "active",
"content": "string",
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"archived": false,
"taskableInstruction": false
}

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"object": "note",
"caseId": "string",
"supercaseId": "string",
"interactionId": "string",
"status": "active",
"type": "borrowerNote",
"content": "string",
"oldContent": [ ],
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"edited": false,
"archived": false,
"taskableInstruction": false,
"createdBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"updatedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedAt": "2019-08-24T14:15:22Z",
"deletedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
}
}
}

Get notes

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

interactionId

required

string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

Interaction's unique identifier to track interactions for. Can be Peach or lender's external identifier.

query Parameters

limit	integer [ 1 .. 100 ] Default: 25 The maximum count of results to retrieve.
startingAfter	string Return results starting after the provided object identifier.
endingBefore	string Return results ending before the provided object identifier.
categories	Array of strings (NoteCategory) Filters by the given note categories Items Enum: "generic" "escalationCreateReason" "escalationUpdateReason" "escalationCancelReason"
sortBy	Array of strings The data attributes by which to sort the results.
includeArchived	boolean Default: false Include archived notes into the result
pinned	boolean or null Default: null If `true`, show only pinned notes. If `false`, exclude them. If `null`, do no filtering.

Responses

200

get/interactions/{interactionId}/notes

Response samples

application/json

{"status": 0,
"total": 0,
"count": 0,
"nextUrl": "string",
"previousUrl": "string",
"data": [{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"object": "note",
"caseId": "string",
"supercaseId": "string",
"interactionId": "string",
"status": "active",
"type": "borrowerNote",
"content": "string",
"oldContent": [ ],
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"edited": false,
"archived": false,
"taskableInstruction": false,
"createdBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"updatedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedAt": "2019-08-24T14:15:22Z",
"deletedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
}
}
]
}

Create note

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

interactionId

required

string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

Interaction's unique identifier to track interactions for. Can be Peach or lender's external identifier.

Request Body schema: application/json
required

createdAt	string <date-time>
updatedAt	string or null <date-time>
status	string Enum: "active" "inactive"
content	string The content of the note.
important	boolean Default: false Set to `true` if the note is important.
pinned	boolean Default: false Specify that this note should be sorted to the top of the list by default.
category	string (NoteCategory) Default: "generic" Specifies the nature of a Note Enum: "generic" "escalationCreateReason" "escalationUpdateReason" "escalationCancelReason"
sensitiveData	boolean Default: false Indicates whether the note contains sensitive information.
archived	boolean Default: false Set to `true` if the note has been archived.
taskableInstruction	boolean Default: false Set to `true` if the note is intended to be an instruction which creates a review task.

Responses

200

Success

post/interactions/{interactionId}/notes

Request samples

Payload

application/json

{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"status": "active",
"content": "string",
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"archived": false,
"taskableInstruction": false
}

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"object": "note",
"caseId": "string",
"supercaseId": "string",
"interactionId": "string",
"status": "active",
"type": "borrowerNote",
"content": "string",
"oldContent": [ ],
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"edited": false,
"archived": false,
"taskableInstruction": false,
"createdBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"updatedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedAt": "2019-08-24T14:15:22Z",
"deletedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
}
}
}

Get note by ID

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

interactionId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... Interaction's unique identifier to track interactions for. Can be Peach or lender's external identifier.
noteId required	string The note identifier.

Responses

200

Success

get/interactions/{interactionId}/notes/{noteId}

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"object": "note",
"caseId": "string",
"supercaseId": "string",
"interactionId": "string",
"status": "active",
"type": "borrowerNote",
"content": "string",
"oldContent": [ ],
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"edited": false,
"archived": false,
"taskableInstruction": false,
"createdBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"updatedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedAt": "2019-08-24T14:15:22Z",
"deletedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
}
}
}

Update note

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

interactionId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... Interaction's unique identifier to track interactions for. Can be Peach or lender's external identifier.
noteId required	string The note identifier.

Request Body schema: application/json
required

createdAt	string <date-time>
updatedAt	string or null <date-time>
status	string Enum: "active" "inactive"
content	string The content of the note.
important	boolean Default: false Set to `true` if the note is important.
pinned	boolean Default: false Specify that this note should be sorted to the top of the list by default.
category	string (NoteCategory) Default: "generic" Specifies the nature of a Note Enum: "generic" "escalationCreateReason" "escalationUpdateReason" "escalationCancelReason"
sensitiveData	boolean Default: false Indicates whether the note contains sensitive information.
archived	boolean Default: false Set to `true` if the note has been archived.
taskableInstruction	boolean Default: false Set to `true` if the note is intended to be an instruction which creates a review task.

Responses

200

Success

put/interactions/{interactionId}/notes/{noteId}

Request samples

Payload

application/json

{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"status": "active",
"content": "string",
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"archived": false,
"taskableInstruction": false
}

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"object": "note",
"caseId": "string",
"supercaseId": "string",
"interactionId": "string",
"status": "active",
"type": "borrowerNote",
"content": "string",
"oldContent": [ ],
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"edited": false,
"archived": false,
"taskableInstruction": false,
"createdBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"updatedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedAt": "2019-08-24T14:15:22Z",
"deletedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
}
}
}

Get notes

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId

required

string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

query Parameters

limit	integer [ 1 .. 100 ] Default: 25 The maximum count of results to retrieve.
startingAfter	string Return results starting after the provided object identifier.
endingBefore	string Return results ending before the provided object identifier.
categories	Array of strings (NoteCategory) Filters by the given note categories Items Enum: "generic" "escalationCreateReason" "escalationUpdateReason" "escalationCancelReason"
sortBy	Array of strings The data attributes by which to sort the results.
includeArchived	boolean Default: false Include archived notes into the result
pinned	boolean or null Default: null If `true`, show only pinned notes. If `false`, exclude them. If `null`, do no filtering.

Responses

200

get/people/{personId}/notes

Response samples

application/json

{"status": 0,
"total": 0,
"count": 0,
"nextUrl": "string",
"previousUrl": "string",
"data": [{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"object": "note",
"caseId": "string",
"supercaseId": "string",
"interactionId": "string",
"status": "active",
"type": "borrowerNote",
"content": "string",
"oldContent": [ ],
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"edited": false,
"archived": false,
"taskableInstruction": false,
"createdBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"updatedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedAt": "2019-08-24T14:15:22Z",
"deletedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
}
}
]
}

Create note

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId

required

string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

Request Body schema: application/json
required

createdAt	string <date-time>
updatedAt	string or null <date-time>
status	string Enum: "active" "inactive"
content	string The content of the note.
important	boolean Default: false Set to `true` if the note is important.
pinned	boolean Default: false Specify that this note should be sorted to the top of the list by default.
category	string (NoteCategory) Default: "generic" Specifies the nature of a Note Enum: "generic" "escalationCreateReason" "escalationUpdateReason" "escalationCancelReason"
sensitiveData	boolean Default: false Indicates whether the note contains sensitive information.
archived	boolean Default: false Set to `true` if the note has been archived.
taskableInstruction	boolean Default: false Set to `true` if the note is intended to be an instruction which creates a review task.

Responses

200

Success

post/people/{personId}/notes

Request samples

Payload

application/json

{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"status": "active",
"content": "string",
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"archived": false,
"taskableInstruction": false
}

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"object": "note",
"caseId": "string",
"supercaseId": "string",
"interactionId": "string",
"status": "active",
"type": "borrowerNote",
"content": "string",
"oldContent": [ ],
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"edited": false,
"archived": false,
"taskableInstruction": false,
"createdBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"updatedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedAt": "2019-08-24T14:15:22Z",
"deletedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
}
}
}

Get note by ID

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
noteId required	string The note identifier.

Responses

200

Success

get/people/{personId}/notes/{noteId}

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"object": "note",
"caseId": "string",
"supercaseId": "string",
"interactionId": "string",
"status": "active",
"type": "borrowerNote",
"content": "string",
"oldContent": [ ],
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"edited": false,
"archived": false,
"taskableInstruction": false,
"createdBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"updatedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedAt": "2019-08-24T14:15:22Z",
"deletedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
}
}
}

Update note

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId required	string (AnyId) ^ext-\|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+\|^\d+... A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.
noteId required	string The note identifier.

Request Body schema: application/json
required

createdAt	string <date-time>
updatedAt	string or null <date-time>
status	string Enum: "active" "inactive"
content	string The content of the note.
important	boolean Default: false Set to `true` if the note is important.
pinned	boolean Default: false Specify that this note should be sorted to the top of the list by default.
category	string (NoteCategory) Default: "generic" Specifies the nature of a Note Enum: "generic" "escalationCreateReason" "escalationUpdateReason" "escalationCancelReason"
sensitiveData	boolean Default: false Indicates whether the note contains sensitive information.
archived	boolean Default: false Set to `true` if the note has been archived.
taskableInstruction	boolean Default: false Set to `true` if the note is intended to be an instruction which creates a review task.

Responses

200

Success

put/people/{personId}/notes/{noteId}

Request samples

Payload

application/json

{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"status": "active",
"content": "string",
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"archived": false,
"taskableInstruction": false
}

Response samples

application/json

{"status": 0,
"message": "string",
"data": {"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"object": "note",
"caseId": "string",
"supercaseId": "string",
"interactionId": "string",
"status": "active",
"type": "borrowerNote",
"content": "string",
"oldContent": [ ],
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"edited": false,
"archived": false,
"taskableInstruction": false,
"createdBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"updatedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedAt": "2019-08-24T14:15:22Z",
"deletedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
}
}
}

Get interaction notes for a person

Securityoauth2 or bearerAuth or apiKeyHeader

Request

path Parameters

personId

required

string (AnyId) ^ext-|^[A-Z][A-Z0-9]-[A-Z0-9]+-[A-Z0-9]+|^\d+...

A Borrower's unique identifier, tied to a person or a business. Can be Peach or a lender's external identifier.

query Parameters

limit	integer [ 1 .. 100 ] Default: 25 The maximum count of results to retrieve.
startingAfter	string Return results starting after the provided object identifier.
endingBefore	string Return results ending before the provided object identifier.
sortBy	Array of strings The data attributes by which to sort the results.
includeArchived	boolean Default: false Include archived notes into the result
pinned	boolean or null Default: null If `true`, show only pinned notes. If `false`, exclude them. If `null`, do no filtering.
channels	Array of strings or null (InteractionChannel) Only include notes for the interactions with the specified channels. Items Enum: "voice" "email" "fax" "text" "chat" "mail" "gui" "document"

Responses

200

get/people/{personId}/interaction-notes

Response samples

application/json

{"status": 0,
"total": 0,
"count": 0,
"nextUrl": "string",
"previousUrl": "string",
"data": [{"id": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"deletedAt": "2019-08-24T14:15:22Z",
"object": "note",
"caseId": "string",
"supercaseId": "string",
"interactionId": "string",
"status": "active",
"type": "borrowerNote",
"content": "string",
"oldContent": [ ],
"important": false,
"pinned": false,
"category": "generic",
"sensitiveData": false,
"edited": false,
"archived": false,
"taskableInstruction": false,
"createdBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"updatedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
},
"archivedAt": "2019-08-24T14:15:22Z",
"deletedBy": {"id": "string",
"name": "string",
"userType": "agent",
"descriptor": "Agent bob@acme.com",
"employee": {"id": "string"
}
}
}
]
}

➔ Next to Workflows

Notes

Get notes

path Parameters

query Parameters

Create note

path Parameters

Request Body schema: application/jsonrequired

Get note by ID

path Parameters

Update note

path Parameters

Request Body schema: application/jsonrequired

Get notes

path Parameters

query Parameters

Create note

path Parameters

Request Body schema: application/jsonrequired

Get note by ID

path Parameters

Update note

path Parameters

Request Body schema: application/jsonrequired

Get notes

path Parameters

query Parameters

Create note

path Parameters

Request Body schema: application/jsonrequired

Get note by ID

path Parameters

Update note

path Parameters

Request Body schema: application/jsonrequired

Get interaction notes for a person

path Parameters

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required