# MCP tool reference

1 callable tools.

Use tools/call at https://mcp.schedulerzero.com/mcp with the exact tool name and arguments below. The /tools/ paths in this view are documentation identifiers, not HTTP endpoints. Request execution is disabled for this reference.

Inputs are shown for personal API keys (bound) and for OAuth/delegated agents. Output schemas describe MCP structuredContent: native objects pass through; arrays, scalars and null use a data wrapper. Text content retains the native JSON result.

[Connect a client](/mcp/connect) · [Authentication and authorization](/authentication) · [Generated auth guide](/auth.md) · [Download tool catalog](/mcp-catalog.json) · [Agent documentation](/llms.txt)

## update_lead_details

Patch descriptive lead fields, add an email contact point, or add/remove notes; action selects patch, add_email, add_note, or remove_note.

Use for descriptive updates and notes; identity fields change only through the contact-point lane.

addEmail conflicts when another lead owns the address; same-lead re-adds keep bad state.

Obtain the user's explicit authorization before invoking a write or destructive action. This is a client interaction requirement, not a server-issued approval token.

Scopes: lead:update

Risk: write; confirmation: explicit; idempotency: supported.

### Input schema (personal API key)

```json
{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
      "format": "uuid"
    },
    "leadId": {
      "type": "string",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
      "format": "uuid"
    },
    "action": {
      "type": "string",
      "enum": [
        "patch",
        "add_email",
        "add_note",
        "remove_note"
      ]
    },
    "patch": {
      "type": "object",
      "properties": {
        "firstName": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 255
            },
            {
              "type": "null"
            }
          ]
        },
        "lastName": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 255
            },
            {
              "type": "null"
            }
          ]
        },
        "companyName": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 500
            },
            {
              "type": "null"
            }
          ]
        },
        "companyWebsiteUrl": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 2048
            },
            {
              "type": "null"
            }
          ]
        },
        "jobTitle": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 500
            },
            {
              "type": "null"
            }
          ]
        },
        "locality": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 255
            },
            {
              "type": "null"
            }
          ]
        },
        "region": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 255
            },
            {
              "type": "null"
            }
          ]
        },
        "country": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 255
            },
            {
              "type": "null"
            }
          ]
        },
        "timezone": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 255
            },
            {
              "type": "null"
            }
          ]
        },
        "personalLinkedInUrl": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 2048
            },
            {
              "type": "null"
            }
          ]
        },
        "companyLinkedInUrl": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 2048
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "patternProperties": {
        "^(?!(?:firstName|lastName|companyName|companyWebsiteUrl|jobTitle|locality|region|country|timezone|personalLinkedInUrl|companyLinkedInUrl)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "firstName",
          "lastName",
          "companyName",
          "companyWebsiteUrl",
          "jobTitle",
          "locality",
          "region",
          "country",
          "timezone",
          "personalLinkedInUrl",
          "companyLinkedInUrl"
        ]
      },
      "minProperties": 1,
      "maxProperties": 11
    },
    "email": {
      "$ref": "#/$defs/EmailAddress"
    },
    "noteId": {
      "type": "string",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
      "format": "uuid"
    },
    "body": {
      "type": "string"
    }
  },
  "required": [
    "workspaceId",
    "leadId",
    "action"
  ],
  "patternProperties": {
    "^(?!(?:workspaceId|leadId|action|patch|email|noteId|body)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "workspaceId",
      "leadId",
      "action",
      "patch",
      "email",
      "noteId",
      "body"
    ]
  },
  "$defs": {
    "EmailAddress": {
      "type": "string",
      "minLength": 3,
      "maxLength": 320,
      "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"
    }
  }
}
```

### Input schema (OAuth / delegated agent)

```json
{
  "type": "object",
  "properties": {
    "workspaceId": {
      "type": "string",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
      "format": "uuid"
    },
    "leadId": {
      "type": "string",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
      "format": "uuid"
    },
    "action": {
      "type": "string",
      "enum": [
        "patch",
        "add_email",
        "add_note",
        "remove_note"
      ]
    },
    "patch": {
      "type": "object",
      "properties": {
        "firstName": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 255
            },
            {
              "type": "null"
            }
          ]
        },
        "lastName": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 255
            },
            {
              "type": "null"
            }
          ]
        },
        "companyName": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 500
            },
            {
              "type": "null"
            }
          ]
        },
        "companyWebsiteUrl": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 2048
            },
            {
              "type": "null"
            }
          ]
        },
        "jobTitle": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 500
            },
            {
              "type": "null"
            }
          ]
        },
        "locality": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 255
            },
            {
              "type": "null"
            }
          ]
        },
        "region": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 255
            },
            {
              "type": "null"
            }
          ]
        },
        "country": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 255
            },
            {
              "type": "null"
            }
          ]
        },
        "timezone": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 255
            },
            {
              "type": "null"
            }
          ]
        },
        "personalLinkedInUrl": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 2048
            },
            {
              "type": "null"
            }
          ]
        },
        "companyLinkedInUrl": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 2048
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "patternProperties": {
        "^(?!(?:firstName|lastName|companyName|companyWebsiteUrl|jobTitle|locality|region|country|timezone|personalLinkedInUrl|companyLinkedInUrl)$)[\\s\\S]*$": false
      },
      "additionalProperties": true,
      "propertyNames": {
        "type": "string",
        "enum": [
          "firstName",
          "lastName",
          "companyName",
          "companyWebsiteUrl",
          "jobTitle",
          "locality",
          "region",
          "country",
          "timezone",
          "personalLinkedInUrl",
          "companyLinkedInUrl"
        ]
      },
      "minProperties": 1,
      "maxProperties": 11
    },
    "email": {
      "$ref": "#/$defs/EmailAddress"
    },
    "noteId": {
      "type": "string",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
      "format": "uuid"
    },
    "body": {
      "type": "string"
    }
  },
  "required": [
    "workspaceId",
    "leadId",
    "action"
  ],
  "patternProperties": {
    "^(?!(?:workspaceId|leadId|action|patch|email|noteId|body)$)[\\s\\S]*$": false
  },
  "additionalProperties": true,
  "propertyNames": {
    "type": "string",
    "enum": [
      "workspaceId",
      "leadId",
      "action",
      "patch",
      "email",
      "noteId",
      "body"
    ]
  },
  "$defs": {
    "EmailAddress": {
      "type": "string",
      "minLength": 3,
      "maxLength": 320,
      "pattern": "^[^\\s@]+@[^\\s@]+\\.[^\\s@]+$"
    }
  }
}
```

### Output schema (structuredContent)

```json
{
  "$defs": {
    "LeadStoredText": {
      "type": "string",
      "maxLength": 65536
    },
    "ShortText": {
      "type": "string",
      "minLength": 1,
      "maxLength": 256
    },
    "Union_": {
      "anyOf": [
        {
          "type": "null"
        },
        {
          "type": "boolean"
        },
        {
          "type": "number"
        },
        {
          "type": "string"
        },
        {
          "type": "array",
          "items": {
            "$ref": "#/$defs/Union_"
          }
        },
        {
          "type": "object",
          "additionalProperties": {
            "$ref": "#/$defs/Union_"
          }
        }
      ]
    },
    "UtcDateTimeEncoded": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
    }
  },
  "type": "object",
  "anyOf": [
    {
      "allOf": [
        {
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
                  "format": "uuid"
                },
                "organizationId": {
                  "type": "string"
                },
                "emailAddress": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/LeadStoredText"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "phoneNumber": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/LeadStoredText"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "phoneBase": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/LeadStoredText"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "phoneExtension": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/LeadStoredText"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "firstName": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/LeadStoredText"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "lastName": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/LeadStoredText"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "companyName": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/LeadStoredText"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "companyWebsiteUrl": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/LeadStoredText"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "jobTitle": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/LeadStoredText"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "locality": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/LeadStoredText"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "region": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/LeadStoredText"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "country": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/LeadStoredText"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "timezone": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/LeadStoredText"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "personalLinkedInUrl": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/LeadStoredText"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "companyLinkedInUrl": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/LeadStoredText"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "source": {
                  "anyOf": [
                    {
                      "$ref": "#/$defs/LeadStoredText"
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "customFieldValues": {
                  "anyOf": [
                    {
                      "type": "object",
                      "additionalProperties": true
                    },
                    {
                      "type": "null"
                    }
                  ]
                },
                "createdAt": {
                  "$ref": "#/$defs/UtcDateTimeEncoded"
                },
                "updatedAt": {
                  "$ref": "#/$defs/UtcDateTimeEncoded"
                }
              },
              "required": [
                "id",
                "organizationId",
                "emailAddress",
                "phoneNumber",
                "phoneBase",
                "phoneExtension",
                "firstName",
                "lastName",
                "companyName",
                "companyWebsiteUrl",
                "jobTitle",
                "locality",
                "region",
                "country",
                "timezone",
                "personalLinkedInUrl",
                "companyLinkedInUrl",
                "source",
                "customFieldValues",
                "createdAt",
                "updatedAt"
              ],
              "patternProperties": {
                "^(?!(?:id|organizationId|emailAddress|phoneNumber|phoneBase|phoneExtension|firstName|lastName|companyName|companyWebsiteUrl|jobTitle|locality|region|country|timezone|personalLinkedInUrl|companyLinkedInUrl|source|customFieldValues|createdAt|updatedAt)$)[\\s\\S]*$": false
              },
              "additionalProperties": true,
              "propertyNames": {
                "type": "string",
                "enum": [
                  "id",
                  "organizationId",
                  "emailAddress",
                  "phoneNumber",
                  "phoneBase",
                  "phoneExtension",
                  "firstName",
                  "lastName",
                  "companyName",
                  "companyWebsiteUrl",
                  "jobTitle",
                  "locality",
                  "region",
                  "country",
                  "timezone",
                  "personalLinkedInUrl",
                  "companyLinkedInUrl",
                  "source",
                  "customFieldValues",
                  "createdAt",
                  "updatedAt"
                ]
              }
            },
            {
              "type": "object",
              "properties": {
                "success": {
                  "anyOf": [
                    {
                      "type": "boolean",
                      "enum": [
                        true
                      ]
                    }
                  ]
                }
              },
              "required": [
                "success"
              ],
              "patternProperties": {
                "^(?!(?:success)$)[\\s\\S]*$": false
              },
              "additionalProperties": true,
              "propertyNames": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "success"
                    ]
                  }
                ]
              }
            },
            {
              "type": "object",
              "properties": {
                "note": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
                      "format": "uuid"
                    },
                    "leadId": {
                      "type": "string",
                      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
                      "format": "uuid"
                    },
                    "body": {
                      "type": "string"
                    },
                    "authorUserId": {
                      "anyOf": [
                        {
                          "type": "string"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "authorName": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "createdAt": {
                      "$ref": "#/$defs/UtcDateTimeEncoded"
                    }
                  },
                  "required": [
                    "id",
                    "leadId",
                    "body",
                    "authorUserId",
                    "authorName",
                    "createdAt"
                  ],
                  "patternProperties": {
                    "^(?!(?:id|leadId|body|authorUserId|authorName|createdAt)$)[\\s\\S]*$": false
                  },
                  "additionalProperties": true,
                  "propertyNames": {
                    "type": "string",
                    "enum": [
                      "id",
                      "leadId",
                      "body",
                      "authorUserId",
                      "authorName",
                      "createdAt"
                    ]
                  }
                }
              },
              "required": [
                "note"
              ],
              "patternProperties": {
                "^(?!(?:note)$)[\\s\\S]*$": false
              },
              "additionalProperties": true,
              "propertyNames": {
                "anyOf": [
                  {
                    "type": "string",
                    "enum": [
                      "note"
                    ]
                  }
                ]
              }
            }
          ]
        },
        {
          "type": "object"
        }
      ]
    },
    {
      "type": "object",
      "properties": {
        "data": {
          "allOf": [
            {
              "anyOf": [
                {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "string",
                      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
                      "format": "uuid"
                    },
                    "organizationId": {
                      "type": "string"
                    },
                    "emailAddress": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "phoneNumber": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "phoneBase": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "phoneExtension": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "firstName": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "lastName": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "companyName": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "companyWebsiteUrl": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "jobTitle": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "locality": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "region": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "country": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "timezone": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "personalLinkedInUrl": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "companyLinkedInUrl": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "source": {
                      "anyOf": [
                        {
                          "$ref": "#/$defs/LeadStoredText"
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "customFieldValues": {
                      "anyOf": [
                        {
                          "type": "object",
                          "additionalProperties": true
                        },
                        {
                          "type": "null"
                        }
                      ]
                    },
                    "createdAt": {
                      "$ref": "#/$defs/UtcDateTimeEncoded"
                    },
                    "updatedAt": {
                      "$ref": "#/$defs/UtcDateTimeEncoded"
                    }
                  },
                  "required": [
                    "id",
                    "organizationId",
                    "emailAddress",
                    "phoneNumber",
                    "phoneBase",
                    "phoneExtension",
                    "firstName",
                    "lastName",
                    "companyName",
                    "companyWebsiteUrl",
                    "jobTitle",
                    "locality",
                    "region",
                    "country",
                    "timezone",
                    "personalLinkedInUrl",
                    "companyLinkedInUrl",
                    "source",
                    "customFieldValues",
                    "createdAt",
                    "updatedAt"
                  ],
                  "patternProperties": {
                    "^(?!(?:id|organizationId|emailAddress|phoneNumber|phoneBase|phoneExtension|firstName|lastName|companyName|companyWebsiteUrl|jobTitle|locality|region|country|timezone|personalLinkedInUrl|companyLinkedInUrl|source|customFieldValues|createdAt|updatedAt)$)[\\s\\S]*$": false
                  },
                  "additionalProperties": true,
                  "propertyNames": {
                    "type": "string",
                    "enum": [
                      "id",
                      "organizationId",
                      "emailAddress",
                      "phoneNumber",
                      "phoneBase",
                      "phoneExtension",
                      "firstName",
                      "lastName",
                      "companyName",
                      "companyWebsiteUrl",
                      "jobTitle",
                      "locality",
                      "region",
                      "country",
                      "timezone",
                      "personalLinkedInUrl",
                      "companyLinkedInUrl",
                      "source",
                      "customFieldValues",
                      "createdAt",
                      "updatedAt"
                    ]
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "success": {
                      "anyOf": [
                        {
                          "type": "boolean",
                          "enum": [
                            true
                          ]
                        }
                      ]
                    }
                  },
                  "required": [
                    "success"
                  ],
                  "patternProperties": {
                    "^(?!(?:success)$)[\\s\\S]*$": false
                  },
                  "additionalProperties": true,
                  "propertyNames": {
                    "anyOf": [
                      {
                        "type": "string",
                        "enum": [
                          "success"
                        ]
                      }
                    ]
                  }
                },
                {
                  "type": "object",
                  "properties": {
                    "note": {
                      "type": "object",
                      "properties": {
                        "id": {
                          "type": "string",
                          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
                          "format": "uuid"
                        },
                        "leadId": {
                          "type": "string",
                          "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|[fF]{8}-[fF]{4}-[fF]{4}-[fF]{4}-[fF]{12})$",
                          "format": "uuid"
                        },
                        "body": {
                          "type": "string"
                        },
                        "authorUserId": {
                          "anyOf": [
                            {
                              "type": "string"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "authorName": {
                          "anyOf": [
                            {
                              "$ref": "#/$defs/LeadStoredText"
                            },
                            {
                              "type": "null"
                            }
                          ]
                        },
                        "createdAt": {
                          "$ref": "#/$defs/UtcDateTimeEncoded"
                        }
                      },
                      "required": [
                        "id",
                        "leadId",
                        "body",
                        "authorUserId",
                        "authorName",
                        "createdAt"
                      ],
                      "patternProperties": {
                        "^(?!(?:id|leadId|body|authorUserId|authorName|createdAt)$)[\\s\\S]*$": false
                      },
                      "additionalProperties": true,
                      "propertyNames": {
                        "type": "string",
                        "enum": [
                          "id",
                          "leadId",
                          "body",
                          "authorUserId",
                          "authorName",
                          "createdAt"
                        ]
                      }
                    }
                  },
                  "required": [
                    "note"
                  ],
                  "patternProperties": {
                    "^(?!(?:note)$)[\\s\\S]*$": false
                  },
                  "additionalProperties": true,
                  "propertyNames": {
                    "anyOf": [
                      {
                        "type": "string",
                        "enum": [
                          "note"
                        ]
                      }
                    ]
                  }
                }
              ]
            },
            {
              "not": {
                "type": "object"
              }
            }
          ]
        }
      },
      "required": [
        "data"
      ],
      "additionalProperties": false
    }
  ]
}
```

### Underlying API operations

- `leads.update`: `PATCH /v1/workspaces/:workspaceId/leads/:leadId`
- `leads.addEmail`: `POST /v1/workspaces/:workspaceId/leads/:leadId/emails`
- `leads.notes.add`: `POST /v1/workspaces/:workspaceId/leads/:leadId/notes`
- `leads.notes.remove`: `DELETE /v1/workspaces/:workspaceId/leads/:leadId/notes/:noteId`