Post internal note

End-point to post an internal note for a trip. Notes are pushed in mobile app for the driver and are added to customer's thread as well.

Path Parameters

trip_uuid string required

Unique identifier for a trip

Header Parameters

authorization string required

Base64 encoded basic auth

application/json

Request Body required

Request to post internal note

dealerDepartmentUUIDList string[]
messageDetails object
attachmentList string[]
customerId int64
customerUUID string
dealerAssociateId int64
messageText string
recipientDAs object[]
Array [
dealerAssociateID int64
dealerAssociateName string
dealerAssociateUserUuid string
isAssignee boolean
]
removedDAs object[]
Array [
dealerAssociateID int64
dealerAssociateName string
dealerAssociateUserUuid string
isAssignee boolean
]
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
errorCode string
errorDescription string
metadata object
property name* string
messageUUID string
statusCode int32
warnings object[]
Array [
warningCode string
warningDescription string
]

{
  "error": {
    "errorCode": "string",
    "errorDescription": "string",
    "metadata": {}
  },
  "messageUUID": "string",
  "statusCode": 0,
  "warnings": [
    {
      "warningCode": "string",
      "warningDescription": "string"
    }
  ]
}

Created

Unauthorized

Forbidden

Not Found

POST /v3/trip/:trip_uuid/note

Request

Base URL

//api.mykaarma.com/pickupdelivery

trip_uuid — path required

authorization — header required

Body required

{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "messageDetails": {
    "attachmentList": [
      "string"
    ],
    "customerId": 0,
    "customerUUID": "string",
    "dealerAssociateId": 0,
    "messageText": "string",
    "recipientDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ],
    "removedDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ]
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}

curl / cURL

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:trip_uuid/note' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "messageDetails": {
    "attachmentList": [
      "string"
    ],
    "customerId": 0,
    "customerUUID": "string",
    "dealerAssociateId": 0,
    "messageText": "string",
    "recipientDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ],
    "removedDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ]
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

python / requests

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:trip_uuid/note' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "messageDetails": {
    "attachmentList": [
      "string"
    ],
    "customerId": 0,
    "customerUUID": "string",
    "dealerAssociateId": 0,
    "messageText": "string",
    "recipientDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ],
    "removedDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ]
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

go / native

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:trip_uuid/note' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "messageDetails": {
    "attachmentList": [
      "string"
    ],
    "customerId": 0,
    "customerUUID": "string",
    "dealerAssociateId": 0,
    "messageText": "string",
    "recipientDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ],
    "removedDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ]
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

nodejs / axios

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:trip_uuid/note' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "messageDetails": {
    "attachmentList": [
      "string"
    ],
    "customerId": 0,
    "customerUUID": "string",
    "dealerAssociateId": 0,
    "messageText": "string",
    "recipientDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ],
    "removedDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ]
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

ruby / Net::HTTP

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:trip_uuid/note' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "messageDetails": {
    "attachmentList": [
      "string"
    ],
    "customerId": 0,
    "customerUUID": "string",
    "dealerAssociateId": 0,
    "messageText": "string",
    "recipientDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ],
    "removedDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ]
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

csharp / RestSharp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:trip_uuid/note' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "messageDetails": {
    "attachmentList": [
      "string"
    ],
    "customerId": 0,
    "customerUUID": "string",
    "dealerAssociateId": 0,
    "messageText": "string",
    "recipientDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ],
    "removedDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ]
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

php / cURL

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:trip_uuid/note' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "messageDetails": {
    "attachmentList": [
      "string"
    ],
    "customerId": 0,
    "customerUUID": "string",
    "dealerAssociateId": 0,
    "messageText": "string",
    "recipientDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ],
    "removedDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ]
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

java / OkHttp

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:trip_uuid/note' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "messageDetails": {
    "attachmentList": [
      "string"
    ],
    "customerId": 0,
    "customerUUID": "string",
    "dealerAssociateId": 0,
    "messageText": "string",
    "recipientDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ],
    "removedDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ]
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'

powershell / RestMethod

curl -L -X POST '//api.mykaarma.com/pickupdelivery/v3/trip/:trip_uuid/note' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerDepartmentUUIDList": [
    "string"
  ],
  "messageDetails": {
    "attachmentList": [
      "string"
    ],
    "customerId": 0,
    "customerUUID": "string",
    "dealerAssociateId": 0,
    "messageText": "string",
    "recipientDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ],
    "removedDAs": [
      {
        "dealerAssociateID": 0,
        "dealerAssociateName": "string",
        "dealerAssociateUserUuid": "string",
        "isAssignee": true
      }
    ]
  },
  "requesterUserUUID": "string",
  "source": "DEALER_APP"
}'