create_company | Create a company; returns the record with its id. Arguments: name (string, required); domainName (object {primaryLinkUrl: string}); address (object {addressStreet1, addressStreet2, addressCity, addressPostcode, addressState, addressCountry}, all strings); linkedinLink (object {primaryLinkUrl: string}); annualRevenue (object {amountMicros: integer, amount × 1 000 000; currencyCode: string ISO 4217}); accountOwnerId (UUID string from list_workspace_members). |
create_note | Create a note; returns the record with its id (then attach it with link_note). Arguments, all optional: title (string); bodyV2 (object {markdown: string}). |
create_opportunity | Create an opportunity; returns the record with its id. Arguments: name (string, required); amount (object {amountMicros: integer, amount × 1 000 000; currencyCode: string ISO 4217}); closeDate (string, ISO 8601); stage (one of NEW, SCREENING, MEETING, PROPOSAL, CUSTOMER); companyId, pointOfContactId (UUID strings from list_companies / list_people); ownerId (UUID string from list_workspace_members). |
create_person | Create a person; returns the record with its id. Arguments, all optional: name (object {firstName: string, lastName: string}); emails (object {primaryEmail: string, additionalEmails: array of strings}); phones (object {primaryPhoneNumber: string, primaryPhoneCountryCode: string e.g. “FR”, primaryPhoneCallingCode: string e.g. “+33”}); jobTitle (string); linkedinLink (object {primaryLinkUrl: string}); companyId (UUID string from list_companies). |
create_task | Create a task; returns the record with its id (then attach it with link_task). Arguments: title (string, required); bodyV2 (object {markdown: string}); dueAt (string, ISO 8601); status (one of TODO, IN_PROGRESS, DONE); assigneeId (UUID string from list_workspace_members). |
link_note | Attach a note to a record. Arguments: noteId (UUID string from create_note or list_notes, required) and EXACTLY ONE of targetPersonId, targetCompanyId, targetOpportunityId (UUID strings). |
link_task | Attach a task to a record. Arguments: taskId (UUID string from create_task or list_tasks, required) and EXACTLY ONE of targetPersonId, targetCompanyId, targetOpportunityId (UUID strings). |
update_company | Update a company: only the arguments sent change. id (UUID string, required, from list_companies); then any of name (string); domainName (object {primaryLinkUrl: string}); address (object {addressStreet1, addressStreet2, addressCity, addressPostcode, addressState, addressCountry}); linkedinLink (object {primaryLinkUrl: string}); annualRevenue (object {amountMicros: integer, currencyCode: string}); accountOwnerId (UUID string). |
update_opportunity | Update an opportunity: only the arguments sent change. id (UUID string, required, from list_opportunities); then any of name (string); amount (object {amountMicros: integer, amount × 1 000 000; currencyCode: string ISO 4217}); closeDate (string, ISO 8601); stage (one of NEW, SCREENING, MEETING, PROPOSAL, CUSTOMER); companyId, pointOfContactId, ownerId (UUID strings). |
update_person | Update a person: only the arguments sent change. id (UUID string, required, from list_people); then any of name (object {firstName: string, lastName: string}); emails (object {primaryEmail: string, additionalEmails: array of strings}); phones (object {primaryPhoneNumber: string, primaryPhoneCountryCode: string, primaryPhoneCallingCode: string}); jobTitle (string); linkedinLink (object {primaryLinkUrl: string}); companyId (UUID string). |
update_task | Update a task: only the arguments sent change. id (UUID string, required, from list_tasks); then any of title (string); bodyV2 (object {markdown: string}); dueAt (string, ISO 8601); status (one of TODO, IN_PROGRESS, DONE); assigneeId (UUID string). |