add_lead_note

This reference is generated from the published tool contract.

Behavior and boundaries

Adds a note to a lead’s history (1–4000 characters). Every member of the workspace sees it. A lead with a note is kept until someone deletes it in Ridian.

Permissions

Granted scopes, accounts, calendars and visibility rules limit access. Workspace administrators do not automatically gain access to other users’ accounts.

leads:write

Consent and boundaries

Input

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "lead_id": {
      "type": "string",
      "minLength": 1,
      "maxLength": 64,
      "description": "lead_id from list_leads."
    },
    "note": {
      "type": "string",
      "minLength": 1,
      "maxLength": 4000
    }
  },
  "required": [
    "lead_id",
    "note"
  ],
  "additionalProperties": false
}

Output

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "lead_id": {
      "type": "string"
    },
    "added": {
      "type": "boolean"
    }
  },
  "required": [
    "lead_id",
    "added"
  ],
  "additionalProperties": false
}

Errors and retries

Check the tool result for errors. Do not blindly retry writes after a timeout. Check the current resource or send status first.

Error handling