Fetch internal notes
End-point to fetch internal notes
Path Parameters
departmentUUID string required
Dealer department uuid
messageUUID string required
Unique identifier for a messsage
Header Parameters
authorization string required
Base64 encoded basic auth
application/json
Request Body required
Request to fetch internal notes
dealerDepartmentUUIDList string[]
requesterUserUUID string
source string
Possible values: [DEALER_APP
, WEB
, PND_API
, EXTERNAL_CONTROLLER
]
Responses
- 200
- 201
- 401
- 403
- 404
OK
application/json
Schema
Example (from schema)
Schema
error object
messages object[]
statusCode int32
warnings object[]
{
"error": {
"errorCode": "string",
"errorDescription": "string",
"metadata": {}
},
"messages": [
{
"attachments": [
"string"
],
"dealerAssociateUUID": "string",
"fromName": "string",
"fromNumber": "string",
"messageBody": "string",
"messagePurpose": "string",
"messageSubject": "string",
"receivedOn": "2025-04-07T07:51:25.432Z",
"sentOn": "2025-04-07T07:51:25.432Z",
"toName": "string",
"toNumber": "string",
"uuid": "string"
}
],
"statusCode": 0,
"warnings": [
{
"warningCode": "string",
"warningDescription": "string"
}
]
}
Created
Unauthorized
Forbidden
Not Found
POST /v3/department/:departmentUUID/note/:messageUUID
Request
Request
curl / cURL
curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:departmentUUID/note/:messageUUID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerDepartmentUUIDList": [
"string"
],
"requesterUserUUID": "string",
"source": "DEALER_APP"
}'
python / requests
curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:departmentUUID/note/:messageUUID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerDepartmentUUIDList": [
"string"
],
"requesterUserUUID": "string",
"source": "DEALER_APP"
}'
go / native
curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:departmentUUID/note/:messageUUID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerDepartmentUUIDList": [
"string"
],
"requesterUserUUID": "string",
"source": "DEALER_APP"
}'
nodejs / axios
curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:departmentUUID/note/:messageUUID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerDepartmentUUIDList": [
"string"
],
"requesterUserUUID": "string",
"source": "DEALER_APP"
}'
ruby / Net::HTTP
curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:departmentUUID/note/:messageUUID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerDepartmentUUIDList": [
"string"
],
"requesterUserUUID": "string",
"source": "DEALER_APP"
}'
csharp / RestSharp
curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:departmentUUID/note/:messageUUID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerDepartmentUUIDList": [
"string"
],
"requesterUserUUID": "string",
"source": "DEALER_APP"
}'
php / cURL
curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:departmentUUID/note/:messageUUID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerDepartmentUUIDList": [
"string"
],
"requesterUserUUID": "string",
"source": "DEALER_APP"
}'
java / OkHttp
curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:departmentUUID/note/:messageUUID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerDepartmentUUIDList": [
"string"
],
"requesterUserUUID": "string",
"source": "DEALER_APP"
}'
powershell / RestMethod
curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/department/:departmentUUID/note/:messageUUID' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
"dealerDepartmentUUIDList": [
"string"
],
"requesterUserUUID": "string",
"source": "DEALER_APP"
}'