This article provides a guide on how to add notes programmatically using the new customer profile page via API.
Prerequisites
- Access to the Powered By Jumbo Admin Platform
- User with “customer.add_note” capability enabled
API
Authentication
Before proceeding, you need to need to authenticate the API user.
URL
POST: {your-pbj-website}/api-admin/loginHeader
"accept: application/json"
"Content-Type: application/json"Request Body
{
"username": "yourusername",
"password": "yourpassword"
}Adding A Note
URL
POST: {your-pbj-website}/api-admin/customer/{encoded_customer_id}/noteHeader
You will need to pass the access_token fetched as part of the authentication step to authorise this request.
"accept: application/json"
"authorization: Bearer {access_token}"Request Body
This request supports “JSON”
{
note: "...note to add..."
}Response
200 OK
{
"result":{
"notes":[
{"admin":"Admin","note":"...note to add...","status":"COMPLETED","date":"2020-10-27T02:56:22+0000"}
]
},
"messages":[]
}