prospect/patch_by_id

Tool: update

partially update a prospect's fields.

Updates only the fields you supply. Returns the full updated prospect object. Use this for targeted field updates on existing prospects (preferred over prospect/post_bulk for updates).

Editing many prospects? There is no multi-prospect update — loop this call, and pace the loop against the shared budget of 60 requests/min per API key; a blocked call spends one too (call-contract).

Never send null — rejected with 422. To CLEAR a string field send ""; to leave a field unchanged, OMIT it entirely. Full rules: call-contract.

Arguments

name	type	req	notes
id	integer	✓	Prospect ID — the object's `prospectId` (int64)

Body

All fields optional. Omitted fields are unchanged.

field	type	req	constraints	description
baseListId	integer	–		Primary-list pointer; not list membership
sendingStatus	string	–	see schemas/prospect	Campaign participation state
sendingActive	boolean	–		Whether eligible for campaign sending
firstName	string	–	≤512 chars
lastName	string	–	≤512 chars
company	string	–	≤512 chars
industry	string	–	≤512 chars
city	string	–	≤512 chars
website	string	–	≤512 chars
phone	string	–	≤512 chars
country	string	–	≤512 chars
domain	string	–	≤180 chars
companySocial	string	–	≤512 chars
companySize	string	–	≤32 chars
jobPosition	string	–	≤512 chars
location	string	–	≤512 chars
personalSocial	string	–	≤512 chars
customImageUrl	string	–	≤256 chars
screenshotUrl	string	–	≤256 chars
logoUrl	string	–	≤256 chars
state	string	–	≤128 chars
icebreaker	string	–	≤4000 chars
custom1–custom20	string	–	≤2000 chars each	Free-text custom fields
notes	string	–		Internal notes

Response

200 — updated prospect object: see schemas/prospect. Deltas: none (full schema).

Errors: 400, 401, 404, 406, 415, 422, 429, 500 — shared schema: schemas/errors. 422 = null value rejected; 404 = prospect not found.

Invoke

Call update with name: "prospect/patch_by_id".