Close

Sales CRM: leads, contacts, opportunities and notes.

7 actions API key 5 read2 write Calls api.close.com

Connect

TypeScript

const conn = await setu.connections.initiate({ userId: "user_1", toolkit: "close" });
console.log(conn.connectUrl); // show this to your user
await conn.waitUntilActive();

Permissions requested

This toolkit uses a single credential and requests no scopes.

Actions

Create leadwriteclose.create_leadCreate a lead (company) in Close with a name, description, website and status. Contacts, opportunities and tasks are created separately.

Input	Type		Description
`name`	string	Required	Lead (company) name
`description`	string	Optional	Lead description
`url`	string	Optional	Lead website
`status_id`	string	Optional	Lead status id; defaults to the first status

TypeScript

await setu.execute({
  userId: "user_1",
  action: "close.create_lead",
  input: {
    "name": "<name>"
  },
});

Create notewriteclose.create_noteAdd a note to a lead (plain text or HTML).

Input	Type		Description
`lead_id`	string	Required	Lead id to attach the note to
`note`	string	Optional	Note text
`note_html`	string	Optional	Note as HTML (use instead of note)
`pinned`	boolean	Optional	Pin the note

TypeScript

await setu.execute({
  userId: "user_1",
  action: "close.create_note",
  input: {
    "lead_id": "<lead_id>"
  },
});

Get leadreadclose.get_leadGet one lead by id with its contacts, opportunities and tasks.

Input	Type		Description
`lead_id`	string	Required	Lead id, e.g. lead_...

TypeScript

await setu.execute({
  userId: "user_1",
  action: "close.get_lead",
  input: {
    "lead_id": "<lead_id>"
  },
});

List contactsreadclose.list_contactsList contacts, optionally for one lead.

Input	Type		Description
`_limit`	integer	Optional	Number of results (default 100)
`_skip`	integer	Optional	Number of results to skip, for paging
`lead_id`	string	Optional	Only contacts of this lead

TypeScript

await setu.execute({
  userId: "user_1",
  action: "close.list_contacts",
  input: {},
});

List leadsreadclose.list_leadsList leads (companies) in Close, newest first, with paging.

Input	Type		Description
`_limit`	integer	Optional	Number of results (default 100)
`_skip`	integer	Optional	Number of results to skip, for paging
`_fields`	string	Optional	Comma-separated fields to include

TypeScript

await setu.execute({
  userId: "user_1",
  action: "close.list_leads",
  input: {},
});

List notesreadclose.list_notesList note activities, optionally for one lead.

Input	Type		Description
`_limit`	integer	Optional	Number of results (default 100)
`_skip`	integer	Optional	Number of results to skip, for paging
`lead_id`	string	Optional	Only notes of this lead

TypeScript

await setu.execute({
  userId: "user_1",
  action: "close.list_notes",
  input: {},
});

List opportunitiesreadclose.list_opportunitiesList opportunities, optionally for one lead or status type, with value and confidence.

Input	Type		Description
`_limit`	integer	Optional	Number of results (default 100)
`_skip`	integer	Optional	Number of results to skip, for paging
`lead_id`	string	Optional	Only opportunities of this lead
`status_type`	string	Optional	Status type

TypeScript

await setu.execute({
  userId: "user_1",
  action: "close.list_opportunities",
  input: {},
});