Skip to main content

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

Request Body required

Request to fetch internal notes

    dealerDepartmentUUIDList string[]
    requesterUserUUID string
    source string

    Possible values: [DEALER_APP, WEB, PND_API, EXTERNAL_CONTROLLER]

Responses

OK


Schema
    error object
    errorCode string
    errorDescription string
    metadata object
    property name* string
    messages object[]
  • Array [
  • attachments string[]
    dealerAssociateUUID string
    fromName string
    fromNumber string
    messageBody string
    messagePurpose string
    messageSubject string
    receivedOn date-time
    sentOn date-time
    toName string
    toNumber string
    uuid string
  • ]
  • statusCode int32
    warnings object[]
  • Array [
  • warningCode string
    warningDescription string
  • ]
POST /v3/department/:departmentUUID/note/:messageUUID

Request

Base URL
//api.mykaarma.com/pickupdelivery
departmentUUID — path required
messageUUID — path required
authorization — header required
Body required
{
"dealerDepartmentUUIDList": [
"string"
],
"requesterUserUUID": "string",
"source": "DEALER_APP"
}
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"
}'