SDK Code Examples — WhatsAppNoteController

Base URL: https://{tenant}.shumoul.app · Token variable: $TOKEN (bash) / %TOKEN% (cmd) / token (JS/C#/Dart), obtained per §19 SDK Usage Guide.

---

1. GET /api/v1/whatsapp/notes/GetNotes/{conversationId}

Permission: WhatsAppInbox.Note

cURL — Linux/macOS:

curl -X GET "https://{tenant}.shumoul.app/api/v1/whatsapp/notes/GetNotes/c1a2b3c4-0000-0000-0000-000000000001" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json"

cURL — Windows (cmd.exe):

curl -X GET "https://{tenant}.shumoul.app/api/v1/whatsapp/notes/GetNotes/c1a2b3c4-0000-0000-0000-000000000001" ^
  -H "Authorization: Bearer %TOKEN%" ^
  -H "Content-Type: application/json"

JavaScript — fetch():

const response = await fetch("https://{tenant}.shumoul.app/api/v1/whatsapp/notes/GetNotes/c1a2b3c4-0000-0000-0000-000000000001", {
  method: "GET",
  headers: { "Authorization": `Bearer ${token}`, "Content-Type": "application/json" }
});
const result = await response.json();

JavaScript — Axios:

const { data } = await axios.get("https://{tenant}.shumoul.app/api/v1/whatsapp/notes/GetNotes/c1a2b3c4-0000-0000-0000-000000000001", { headers: { Authorization: `Bearer ${token}` } });

C# — HttpClient:

var client = httpClientFactory.CreateClient("Shumoul"); // BaseAddress = "https://{tenant}.shumoul.app"
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);
var response = await client.GetAsync("/api/v1/whatsapp/notes/GetNotes/c1a2b3c4-0000-0000-0000-000000000001");
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadFromJsonAsync<Result<object>>();

Flutter — Dio:

final response = await dio.get(
  "/api/v1/whatsapp/notes/GetNotes/c1a2b3c4-0000-0000-0000-000000000001",
  options: Options(headers: {"Authorization": "Bearer $token"}),
);

---

2. POST /api/v1/whatsapp/notes/AddNote/{conversationId}

Permission: WhatsAppInbox.Note

cURL — Linux/macOS:

curl -X POST "https://{tenant}.shumoul.app/api/v1/whatsapp/notes/AddNote/c1a2b3c4-0000-0000-0000-000000000001" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"body":"Escalated to billing team"}'

cURL — Windows (cmd.exe):

curl -X POST "https://{tenant}.shumoul.app/api/v1/whatsapp/notes/AddNote/c1a2b3c4-0000-0000-0000-000000000001" ^
  -H "Authorization: Bearer %TOKEN%" ^
  -H "Content-Type: application/json" ^
  -d "{\"body\":\"Escalated to billing team\"}"

JavaScript — fetch():

const response = await fetch("https://{tenant}.shumoul.app/api/v1/whatsapp/notes/AddNote/c1a2b3c4-0000-0000-0000-000000000001", {
  method: "POST",
  headers: { "Authorization": `Bearer ${token}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "body": "Escalated to billing team"
  })
});
const result = await response.json();

JavaScript — Axios:

const { data } = await axios.post(
  "https://{tenant}.shumoul.app/api/v1/whatsapp/notes/AddNote/c1a2b3c4-0000-0000-0000-000000000001",
  {
    "body": "Escalated to billing team"
  },
  { headers: { Authorization: `Bearer ${token}` } }
);

C# — HttpClient:

var client = httpClientFactory.CreateClient("Shumoul"); // BaseAddress = "https://{tenant}.shumoul.app"
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);
var payload = new { body = "Escalated to billing team" };
var response = await client.PostAsJsonAsync("/api/v1/whatsapp/notes/AddNote/c1a2b3c4-0000-0000-0000-000000000001", payload);
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadFromJsonAsync<Result<object>>();

Flutter — Dio:

final response = await dio.post(
  "/api/v1/whatsapp/notes/AddNote/c1a2b3c4-0000-0000-0000-000000000001",
  data: {
    "body": "Escalated to billing team"
  },
  options: Options(headers: {"Authorization": "Bearer $token"}),
);

---

3. PUT /api/v1/whatsapp/notes/UpdateNote/{noteId}

Permission: WhatsAppInbox.Note

cURL — Linux/macOS:

curl -X PUT "https://{tenant}.shumoul.app/api/v1/whatsapp/notes/UpdateNote/n1a2b3c4-0000-0000-0000-000000000001" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"id":"n1a2b3c4-0000-0000-0000-000000000001","body":"Escalated to billing team — awaiting response"}'

cURL — Windows (cmd.exe):

curl -X PUT "https://{tenant}.shumoul.app/api/v1/whatsapp/notes/UpdateNote/n1a2b3c4-0000-0000-0000-000000000001" ^
  -H "Authorization: Bearer %TOKEN%" ^
  -H "Content-Type: application/json" ^
  -d "{\"id\":\"n1a2b3c4-0000-0000-0000-000000000001\",\"body\":\"Escalated to billing team — awaiting response\"}"

JavaScript — fetch():

const response = await fetch("https://{tenant}.shumoul.app/api/v1/whatsapp/notes/UpdateNote/n1a2b3c4-0000-0000-0000-000000000001", {
  method: "PUT",
  headers: { "Authorization": `Bearer ${token}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "id": "n1a2b3c4-0000-0000-0000-000000000001",
    "body": "Escalated to billing team — awaiting response"
  })
});
const result = await response.json();

JavaScript — Axios:

const { data } = await axios.put(
  "https://{tenant}.shumoul.app/api/v1/whatsapp/notes/UpdateNote/n1a2b3c4-0000-0000-0000-000000000001",
  {
    "id": "n1a2b3c4-0000-0000-0000-000000000001",
    "body": "Escalated to billing team — awaiting response"
  },
  { headers: { Authorization: `Bearer ${token}` } }
);

C# — HttpClient:

var client = httpClientFactory.CreateClient("Shumoul"); // BaseAddress = "https://{tenant}.shumoul.app"
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);
var payload = new { id = "n1a2b3c4-0000-0000-0000-000000000001", body = "Escalated to billing team — awaiting response" };
var response = await client.PutAsJsonAsync("/api/v1/whatsapp/notes/UpdateNote/n1a2b3c4-0000-0000-0000-000000000001", payload);
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadFromJsonAsync<Result<object>>();

Flutter — Dio:

final response = await dio.put(
  "/api/v1/whatsapp/notes/UpdateNote/n1a2b3c4-0000-0000-0000-000000000001",
  data: {
    "id": "n1a2b3c4-0000-0000-0000-000000000001",
    "body": "Escalated to billing team — awaiting response"
  },
  options: Options(headers: {"Authorization": "Bearer $token"}),
);

---

4. DELETE /api/v1/whatsapp/notes/DeleteNote/{noteId}

Permission: WhatsAppInbox.Note

cURL — Linux/macOS:

curl -X DELETE "https://{tenant}.shumoul.app/api/v1/whatsapp/notes/DeleteNote/n1a2b3c4-0000-0000-0000-000000000001" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json"

cURL — Windows (cmd.exe):

curl -X DELETE "https://{tenant}.shumoul.app/api/v1/whatsapp/notes/DeleteNote/n1a2b3c4-0000-0000-0000-000000000001" ^
  -H "Authorization: Bearer %TOKEN%" ^
  -H "Content-Type: application/json"

JavaScript — fetch():

const response = await fetch("https://{tenant}.shumoul.app/api/v1/whatsapp/notes/DeleteNote/n1a2b3c4-0000-0000-0000-000000000001", {
  method: "DELETE",
  headers: { "Authorization": `Bearer ${token}`, "Content-Type": "application/json" }
});
const result = await response.json();

JavaScript — Axios:

const { data } = await axios.delete("https://{tenant}.shumoul.app/api/v1/whatsapp/notes/DeleteNote/n1a2b3c4-0000-0000-0000-000000000001", { headers: { Authorization: `Bearer ${token}` } });

C# — HttpClient:

var client = httpClientFactory.CreateClient("Shumoul"); // BaseAddress = "https://{tenant}.shumoul.app"
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Bearer", token);
var response = await client.DeleteAsync("/api/v1/whatsapp/notes/DeleteNote/n1a2b3c4-0000-0000-0000-000000000001");
response.EnsureSuccessStatusCode();
var result = await response.Content.ReadFromJsonAsync<Result<object>>();

Flutter — Dio:

final response = await dio.delete(
  "/api/v1/whatsapp/notes/DeleteNote/n1a2b3c4-0000-0000-0000-000000000001",
  options: Options(headers: {"Authorization": "Bearer $token"}),
);

---