Add a note to a lead.

Write a free-text note on the lead, for example a call summary or the reasoning behind a score. Shown with who wrote it.

POSThttps://app.softsolz.uk/api/v1/services/my-leads/leads/{id}/notes

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: `Bearer sk_live_...` (or `sk_test_...` for sandbox). A login token will not work here.

Idempotency-Keystring

Optional idempotency key for safe retries.

Body Params

bodystring

Note text, up to 8000 characters.

Response

Response Body

idintegerNote id.

lead_idintegerLead the note belongs to.

bodystringNote text.

author_idinteger | nullMember who wrote it.

author_namestring | nullAuthor display name.

viastring | nullapi, connected_app or null.

via_labelstring | nullApp or key name.

created_atstringWhen it was written.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.myLeads.createLeadNote('<id>', {});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 201

{
  "data": {
    "id": 0,
    "lead_id": 0,
    "body": "string",
    "author_id": 0,
    "author_name": "string",
    "via": "string",
    "via_label": "string",
    "created_at": "string"
  }
}