> ## Documentation Index
> Fetch the complete documentation index at: https://docs.automate.ax/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Automate.ax automations are TypeScript programs.
> Use Bun for installation and command examples.
> Use Automate.ax for the product name and automate.ax for the package, CLI, and domain.
> Treat documented public APIs as current; do not invent transitional or deprecated names.

# Close

> Use Close OAuth or single-organization API keys for CRM records, tasks, sequences, and Smart View changes.

```ts automations/qualify-close-leads.automation.ts theme={null}
import { automation } from "automate.ax"
import { close } from "automate.ax/close"

export default automation("Qualify Close leads", () => {
  const lead = close.onLeadCreated()
  close.createTask({
    type: "lead",
    leadId: lead.data.id,
    text: "Qualify this lead",
  })
})
```

Connect Close with OAuth or a Close API key. OAuth requests `all.full_access` and `offline_access`; API keys are scoped by Close to one user and organization. You can select a named binding with the optional second argument `{ account }` on actions or the `account` trigger option.

List actions use offset pagination: `limit` defaults to 100 and `skip` defaults to 0. Close dates become JavaScript `Date` values, provider keys use public TypeScript field names, and custom fields appear under `customFields` using their `cf_...` IDs.

Close Smart View definition triggers use provider webhooks. Lead entry and exit triggers maintain a durable per-account membership baseline because Close does not emit native membership events. They support structured lead Smart Views with up to 10,000 results and emit only changes observed after the initial baseline.

## Exports

```ts theme={null}
import { close, closeAccount, getCloseApi } from "automate.ax/close"
```

* `close` contains the packaged Close actions and triggers.
* `closeAccount("name")` selects a named Close connection.
* `getCloseApi` creates the authenticated Close API helper for a custom account-backed action.

## Triggers

* [On Close event](/reference/integrations/close/triggers/on-close-event)
* [On Close Smart View created](/reference/integrations/close/triggers/on-close-smart-view-created)
* [On Close Smart View updated](/reference/integrations/close/triggers/on-close-smart-view-updated)
* [On Close lead entered Smart View](/reference/integrations/close/triggers/on-close-lead-entered-smart-view)
* [On Close lead exited Smart View](/reference/integrations/close/triggers/on-close-lead-exited-smart-view)
* [On Close call answered](/reference/integrations/close/triggers/on-close-call-answered)
* [On Close call completed](/reference/integrations/close/triggers/on-close-call-completed)
* [On Close email received](/reference/integrations/close/triggers/on-close-email-received)
* [On Close email sent](/reference/integrations/close/triggers/on-close-email-sent)
* [On Close SMS received](/reference/integrations/close/triggers/on-close-sms-received)
* [On Close SMS sent](/reference/integrations/close/triggers/on-close-sms-sent)
* [On Close meeting scheduled](/reference/integrations/close/triggers/on-close-meeting-scheduled)
* [On Close meeting started](/reference/integrations/close/triggers/on-close-meeting-started)
* [On Close meeting completed](/reference/integrations/close/triggers/on-close-meeting-completed)
* [On Close meeting canceled](/reference/integrations/close/triggers/on-close-meeting-canceled)
* [On Close comment created](/reference/integrations/close/triggers/on-close-comment-created)
* [On Close comment updated](/reference/integrations/close/triggers/on-close-comment-updated)
* [On Close comment deleted](/reference/integrations/close/triggers/on-close-comment-deleted)
* [On Close sequence subscription created](/reference/integrations/close/triggers/on-close-sequence-subscription-created)
* [On Close sequence subscription updated](/reference/integrations/close/triggers/on-close-sequence-subscription-updated)
* [On Close sequence subscription paused](/reference/integrations/close/triggers/on-close-sequence-subscription-paused)
* [On Close sequence subscription resumed](/reference/integrations/close/triggers/on-close-sequence-subscription-resumed)
* [On Close sequence subscription finished](/reference/integrations/close/triggers/on-close-sequence-subscription-finished)
* [On Close sequence subscription goal reached](/reference/integrations/close/triggers/on-close-sequence-subscription-goal-reached)
* [On Close sequence subscription errored](/reference/integrations/close/triggers/on-close-sequence-subscription-errored)
* [On Close sequence subscription deleted](/reference/integrations/close/triggers/on-close-sequence-subscription-deleted)
* [On Close lead created](/reference/integrations/close/triggers/on-close-lead-created)
* [On Close lead updated](/reference/integrations/close/triggers/on-close-lead-updated)
* [On Close lead deleted](/reference/integrations/close/triggers/on-close-lead-deleted)
* [On Close lead merged](/reference/integrations/close/triggers/on-close-lead-merged)
* [On Close contact created](/reference/integrations/close/triggers/on-close-contact-created)
* [On Close contact updated](/reference/integrations/close/triggers/on-close-contact-updated)
* [On Close contact deleted](/reference/integrations/close/triggers/on-close-contact-deleted)
* [On Close opportunity created](/reference/integrations/close/triggers/on-close-opportunity-created)
* [On Close opportunity updated](/reference/integrations/close/triggers/on-close-opportunity-updated)
* [On Close opportunity won](/reference/integrations/close/triggers/on-close-opportunity-won)
* [On Close opportunity lost](/reference/integrations/close/triggers/on-close-opportunity-lost)
* [On Close opportunity deleted](/reference/integrations/close/triggers/on-close-opportunity-deleted)
* [On Close task created](/reference/integrations/close/triggers/on-close-task-created)
* [On Close task updated](/reference/integrations/close/triggers/on-close-task-updated)
* [On Close task completed](/reference/integrations/close/triggers/on-close-task-completed)
* [On Close task deleted](/reference/integrations/close/triggers/on-close-task-deleted)

## Actions

* [List leads](/reference/integrations/close/actions/list-leads)
* [Get lead](/reference/integrations/close/actions/get-lead)
* [Create lead](/reference/integrations/close/actions/create-lead)
* [Update lead](/reference/integrations/close/actions/update-lead)
* [Merge leads](/reference/integrations/close/actions/merge-leads)
* [Delete lead](/reference/integrations/close/actions/delete-lead)
* [List contacts](/reference/integrations/close/actions/list-contacts)
* [Get contact](/reference/integrations/close/actions/get-contact)
* [Create contact](/reference/integrations/close/actions/create-contact)
* [Update contact](/reference/integrations/close/actions/update-contact)
* [Delete contact](/reference/integrations/close/actions/delete-contact)
* [List opportunities](/reference/integrations/close/actions/list-opportunities)
* [Get opportunity](/reference/integrations/close/actions/get-opportunity)
* [Create opportunity](/reference/integrations/close/actions/create-opportunity)
* [Update opportunity](/reference/integrations/close/actions/update-opportunity)
* [Delete opportunity](/reference/integrations/close/actions/delete-opportunity)
* [List tasks](/reference/integrations/close/actions/list-tasks)
* [Get task](/reference/integrations/close/actions/get-task)
* [Create task](/reference/integrations/close/actions/create-task)
* [Update task](/reference/integrations/close/actions/update-task)
* [Delete task](/reference/integrations/close/actions/delete-task)
* [List activities](/reference/integrations/close/actions/list-activities)
* [Upload file](/reference/integrations/close/actions/upload-file)
* [Get note](/reference/integrations/close/actions/get-note)
* [Create note](/reference/integrations/close/actions/create-note)
* [Update note](/reference/integrations/close/actions/update-note)
* [Delete note](/reference/integrations/close/actions/delete-note)
* [List calls](/reference/integrations/close/actions/list-calls)
* [Get call](/reference/integrations/close/actions/get-call)
* [Log call](/reference/integrations/close/actions/log-call)
* [Update call](/reference/integrations/close/actions/update-call)
* [Delete call](/reference/integrations/close/actions/delete-call)
* [List emails](/reference/integrations/close/actions/list-emails)
* [Get email](/reference/integrations/close/actions/get-email)
* [Create email](/reference/integrations/close/actions/create-email)
* [Update email](/reference/integrations/close/actions/update-email)
* [Delete email](/reference/integrations/close/actions/delete-email)
* [List SMS messages](/reference/integrations/close/actions/list-sms-messages)
* [Get SMS](/reference/integrations/close/actions/get-sms)
* [Create SMS](/reference/integrations/close/actions/create-sms)
* [Update SMS](/reference/integrations/close/actions/update-sms)
* [Delete SMS](/reference/integrations/close/actions/delete-sms)
* [List comments](/reference/integrations/close/actions/list-comments)
* [Get comment](/reference/integrations/close/actions/get-comment)
* [Create comment](/reference/integrations/close/actions/create-comment)
* [Update comment](/reference/integrations/close/actions/update-comment)
* [Delete comment](/reference/integrations/close/actions/delete-comment)
* [List sequences](/reference/integrations/close/actions/list-sequences)
* [Get sequence](/reference/integrations/close/actions/get-sequence)
* [List sequence subscriptions](/reference/integrations/close/actions/list-sequence-subscriptions)
* [Get sequence subscription](/reference/integrations/close/actions/get-sequence-subscription)
* [Subscribe contact to sequence](/reference/integrations/close/actions/subscribe-contact-to-sequence)
* [Update sequence subscription](/reference/integrations/close/actions/update-sequence-subscription)
* [Delete sequence subscription](/reference/integrations/close/actions/delete-sequence-subscription)
* [Get current user](/reference/integrations/close/actions/get-current-user)
* [List users](/reference/integrations/close/actions/list-users)
* [List lead statuses](/reference/integrations/close/actions/list-lead-statuses)
* [List pipelines](/reference/integrations/close/actions/list-pipelines)
* [List opportunity statuses](/reference/integrations/close/actions/list-opportunity-statuses)