Add Private Note

Add internal notes

POST {baseUrl}/drops/internalNotes

Add private notes on deliveries by providing an array of dropIds.

Headers

Name
Type
Description

app_id*

String

app_secret*

String

Request Body

Name
Type
Description

dropIds*

Array<String>

note*

String

// Sample Request Information
Url: https://sandbox.sendstack.africa/api/v1/drops/internalNotes
Method: POST
Headers: 
 - app_id: "your app_id"
 - app_secret: "your app_secret"

Sample Success Data

// Sample Request Body
{ 
    "dropIds": ["65b8c2c734d8cd1be099fd45"], 
    "note": "This is a sample note"
}
//Sample Response Body - 200 OK
{ 
    "status": true, 
    "message": "Note added successfully", 
    "data": {} 
}

Sample Error Data

//Sample Request Body
{ 
    "dropIds": ["invalidDropId"], 
    "note": "This is a sample note"
}
//Sample Response Body - 400 Bad Request
{
    "status": false,
    "message": "Invalid drop Id"
}

Last updated