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

# Keap

> How to set up the Keap connector, plus the actions and events that are available.

![Keap](https://stackone-logos.com/api/keap/filled/svg)

Betav1.1.0[See changelog](https://docs.stackone.com/connectors/keap/changelog.md)

[158 actions](#actions) · [34 events](#events) · 2 auth methods

CRM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/keap/guides/connector-profile/oauth-2-0.md)
>
> Connect your Keap account using OAuth 2.0. You will need to create a developer application in the Keap Developer Portal...

> [card] [API Key (PAT / SAK) · Connector Profile](https://docs.stackone.com/connectors/keap/guides/connector-profile/api-key-pat-sak.md)
>
> Authenticate using a Personal Access Token (PAT) or Service Account Key (SAK) from your Keap account settings. Intended...

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/keap/guides/link-account/oauth-2-0.md)

> [card] [API Key (PAT / SAK) · Link Account](https://docs.stackone.com/connectors/keap/guides/link-account/api-key-pat-sak.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key (PAT / SAK)

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

full

No scopes found

158 actions

ActionDescriptionRequired scopes

List Users`keap_list_users`

Retrieve a paginated list of users from Keap

`full`

Get User Info`keap_get_user_info`

Retrieve information for the current authenticated user from Keap

`full`

Get User`keap_get_user`

Retrieve a specific user by ID from Keap

`full`

Update User`keap_update_user`

Update information on a specific user in Keap

`full`

Get User Email Signature`keap_get_user_signature`

Retrieve the email signature for a specific user in Keap

`full`

List Contacts`keap_list_contacts`

Retrieve a paginated list of contacts from Keap

`full`

Get Contact`keap_get_contact`

Retrieve a single contact by ID from Keap

`full`

Create Contact`keap_create_contact`

Create a new contact in Keap

`full`

Update Contact`keap_update_contact`

Update an existing contact in Keap

`full`

Delete Contact`keap_delete_contact`

Delete a contact from Keap by ID

`full`

List Linked Contacts`keap_list_contact_links`

Retrieve all contacts linked to a given contact in Keap

`full`

List Tags For Contact`keap_list_contact_tags`

Retrieve all tags applied to a specific contact in Keap

`full`

Link Contacts`keap_link_contacts`

Link two contacts together using a specified link type in Keap

`full`

Unlink Contacts`keap_unlink_contacts`

Remove the link between two contacts in Keap

`full`

List Contact Link Types`keap_list_contact_link_types`

Retrieve a paginated list of contact link types from Keap

`full`

Create Contact Link Type`keap_create_contact_link_type`

Create a new contact link type in Keap

`full`

Retrieve Contact Model`keap_get_contact_model`

Retrieve the custom fields and optional properties for the Contact object in Keap

`full`

Create Contact Custom Field`keap_create_contact_custom_field`

Create a custom field on the Contact object in Keap

`full`

List Companies`keap_list_companies`

Retrieve a paginated list of companies from Keap

`full`

Get Company`keap_get_company`

Retrieve a single company by ID from Keap

`full`

Create Company`keap_create_company`

Create a new company in Keap

`full`

Update Company`keap_update_company`

Update an existing company in Keap

`full`

Delete Company`keap_delete_company`

Delete a company from Keap by ID

`full`

Retrieve Company Custom Field Model`keap_get_company_custom_field_model`

Retrieve the custom fields and optional properties for the Company object in Keap

`full`

Create Company Custom Field`keap_create_company_custom_field`

Create a custom field on the Company object in Keap

`full`

Update Company Custom Field`keap_update_company_custom_field`

Update a custom field on the Company object in Keap

`full`

List Tags For Company`keap_list_company_tags`

Retrieve all tags applied to a specific company in Keap

`full`

Add Tag To Company`keap_add_tag_to_company`

Apply a tag to a company in Keap

`full`

Remove Tag From Company`keap_remove_tag_from_company`

Remove a tag from a company in Keap

`full`

List Opportunities`keap_list_opportunities`

Retrieve a paginated list of opportunities from Keap

`full`

Get Opportunity`keap_get_opportunity`

Retrieve a single opportunity by ID from Keap

`full`

Create Opportunity`keap_create_opportunity`

Create a new opportunity in Keap

`full`

Update Opportunity`keap_update_opportunity`

Update an existing opportunity in Keap

`full`

Delete Opportunity`keap_delete_opportunity`

Delete an opportunity from Keap

`full`

List Opportunity Stages`keap_list_opportunity_stages`

Retrieve a paginated list of opportunity stages from Keap

`full`

Get Opportunity Stage`keap_get_opportunity_stage`

Retrieve a single opportunity stage by ID from Keap

`full`

Create Opportunity Stage`keap_create_opportunity_stage`

Create a new opportunity stage in Keap

`full`

Update Opportunity Stage`keap_update_opportunity_stage`

Update an existing opportunity stage in Keap

`full`

Delete Opportunity Stage`keap_delete_opportunity_stage`

Delete an opportunity stage from Keap

`full`

Retrieve Opportunity Custom Field Model`keap_get_opportunity_custom_field_model`

Get the custom field model for opportunities in Keap

`full`

Create Opportunity Custom Field`keap_create_opportunity_custom_field`

Create a custom field for opportunities in Keap

`full`

Update Opportunity Custom Field`keap_update_opportunity_custom_field`

Update a custom field for opportunities in Keap

`full`

Delete Opportunity Custom Field`keap_delete_opportunity_custom_field`

Delete a custom field from opportunities in Keap

`full`

List Tags`keap_list_tags`

Retrieve a paginated list of tags from Keap

`full`

Get Tag`keap_get_tag`

Retrieve a single tag by ID from Keap

`full`

Create Tag`keap_create_tag`

Create a new tag in Keap

`full`

Update Tag`keap_update_tag`

Update an existing tag in Keap

`full`

Delete Tag`keap_delete_tag`

Delete a tag from Keap by ID

`full`

List Tag Categories`keap_list_tag_categories`

Retrieve a paginated list of tag categories from Keap

`full`

Get Tag Category`keap_get_tag_category`

Retrieve a single tag category by ID from Keap

`full`

Create Tag Category`keap_create_tag_category`

Create a new tag category in Keap

`full`

Update Tag Category`keap_update_tag_category`

Update an existing tag category in Keap

`full`

Delete Tag Category`keap_delete_tag_category`

Delete a tag category from Keap by ID

`full`

List Tagged Companies`keap_list_tag_companies`

Retrieve all companies that have a given tag applied in Keap

`full`

List Tagged Contacts`keap_list_tag_contacts`

Retrieve all contacts with a given tag applied in Keap

`full`

Apply Tag To Contacts`keap_apply_tags`

Apply a tag to a list of contacts in Keap

`full`

Remove Tag From Contacts`keap_remove_tags`

Remove a tag from a list of contacts in Keap

`full`

List Notes`keap_list_contact_notes`

Retrieve a paginated list of notes for a specific contact in Keap

`full`

List All Notes`keap_list_notes`

Retrieve a paginated list of all notes across all contacts in Keap

`full`

Get Note`keap_get_note`

Retrieve a single note for a specific contact in Keap

`full`

Create Note`keap_create_note`

Create a new note for a specific contact in Keap

`full`

Update Note`keap_update_note`

Update a specific note for a contact in Keap

`full`

Delete Note`keap_delete_note`

Delete a specific note for a contact in Keap

`full`

Retrieve Note Model`keap_get_note_model`

Retrieve the custom field model for Notes in Keap

`full`

Create Note Custom Field`keap_create_note_custom_field`

Create a custom field on the Note object in Keap

`full`

Update Note Custom Field`keap_update_note_custom_field`

Update a custom field definition in the Note model in Keap

`full`

Delete Note Custom Field`keap_delete_note_custom_field`

Delete a custom field from the Note model in Keap

`full`

List Note Templates`keap_list_note_templates`

Retrieve a paginated list of note templates from Keap

`full`

List Campaigns`keap_list_campaigns`

Retrieve a paginated list of campaigns from Keap

`full`

Get Campaign`keap_get_campaign`

Retrieve a single campaign by ID from Keap

`full`

Get Campaign Goals`keap_get_campaign_goals`

Retrieve a list of published goals for a campaign in Keap

`full`

Get Campaign Sequences`keap_get_campaign_sequences`

Retrieve a list of published sequences for a campaign in Keap

`full`

Add Contacts To Campaign Sequence`keap_add_contacts_to_campaign_sequence`

Add a list of contacts to a campaign sequence in Keap

`full`

Remove Contacts From Campaign Sequence`keap_remove_contacts_from_campaign_sequence`

Remove a list of contacts from a campaign sequence in Keap

`full`

List Automations`keap_list_automations`

Retrieve a paginated list of automations from Keap

`full`

List Automation IDs`keap_list_automation_ids`

Retrieve a paginated list of automation IDs from Keap

`full`

Get Automation`keap_get_automation`

Retrieve a single automation by ID from Keap

`full`

Delete Automation`keap_delete_automation`

Delete one or more automations from Keap

`full`

Bulk Unpublish Automations`keap_bulk_unpublish_automations`

Bulk unpublish one or more automations in Keap

`full`

Bulk Assign Automation Categories`keap_bulk_assign_automation_categories`

Bulk update the categories of one or more automations in Keap

`full`

Achieve Automation Goal`keap_achieve_goal`

Achieve a goal in an automation for a contact in Keap

`full`

Add Contacts To Automation Sequence`keap_add_contacts_to_automation_sequence`

Add a list of contacts to an automation sequence in Keap

`full`

Unpublish Automation`keap_unpublish_automation`

Unpublish a single automation in Keap

`full`

List Emails`keap_list_emails`

Retrieve a paginated list of sent emails from Keap

`full`

Get Email`keap_get_email`

Retrieve a single sent email record by ID from Keap

`full`

Create Email Record`keap_create_email`

Create a record of an email sent to a contact in Keap

`full`

Delete Email Record`keap_delete_email`

Delete a specific email record from Keap

`full`

Get Email Template`keap_get_email_template`

Retrieve an email template by ID from Keap

`full`

Create Email Records (Batch)`keap_create_emails`

Create a set of email records in Keap in a single transaction

`full`

Delete Email Records (Batch)`keap_delete_emails`

Remove a set of email records from Keap in a single transaction

`full`

Send Email`keap_send_email`

Send an email to a list of contacts in Keap

`full`

Send Email From Template`keap_send_email_template`

Send an email based on a template to contacts in Keap

`full`

List Orders`keap_list_orders`

Retrieve a paginated list of orders from Keap

`full`

Get Order`keap_get_order`

Retrieve a single order by ID from Keap

`full`

Create Order`keap_create_order`

Create a new one-time order with order items in Keap

`full`

Update Order`keap_update_order`

Update an existing order in Keap

`full`

Delete Order`keap_delete_order`

Delete an order from Keap by ID

`full`

Get Order Item`keap_get_order_item`

Retrieve a specific item from an order in Keap

`full`

Create Order Item`keap_create_order_item`

Add a new item to an existing order in Keap

`full`

Update Order Item`keap_update_order_item`

Update a specific item on an existing order in Keap

`full`

Delete Order Item`keap_delete_order_item`

Delete a specific item from an order in Keap

`full`

Apply Commission To Order Item`keap_apply_order_commission`

Apply a commission to a specific order item in Keap

`full`

List Order Payments`keap_list_order_payments`

Retrieve a paginated list of payments for an order in Keap

`full`

Create Payment For Order`keap_create_order_payment`

Create a payment or record a historical payment for an order in Keap

`full`

Apply Tax To Order`keap_apply_tax`

Calculate and apply taxes to an order in Keap

`full`

Attach File To Order Invoice`keap_attach_file_to_order`

Attach an uploaded file to an order invoice in Keap

`full`

Detach File From Order Invoice`keap_detach_file_from_order`

Detach a file from an order invoice in Keap

`full`

Retrieve Order Custom Field Model`keap_get_order_custom_field_model`

Retrieve the custom field model for Order objects in Keap

`full`

Create Order Custom Field`keap_create_order_custom_field`

Create a custom field on the Order object in Keap

`full`

Update Order Custom Field`keap_update_order_custom_field`

Update a custom field on the Order object in Keap

`full`

Delete Order Custom Field`keap_delete_order_custom_field`

Delete a custom field from the Order object in Keap

`full`

List Products`keap_list_products`

Retrieve a paginated list of products from Keap

`full`

Get Product`keap_get_product`

Retrieve a single product by ID from Keap

`full`

Create Product`keap_create_product`

Create a new product in Keap

`full`

Update Product`keap_update_product`

Update an existing product in Keap

`full`

Delete Product`keap_delete_product`

Delete a product from Keap by ID

`full`

Adjust Product Inventory`keap_adjust_inventory`

Increase or decrease the inventory quantity of a product in Keap

`full`

List Product Options`keap_list_product_options`

Retrieve all options for a product in Keap

`full`

Get Product Option`keap_get_product_option`

Retrieve a specific option for a product in Keap

`full`

Create Product Option`keap_create_product_option`

Create a new option for a product in Keap

`full`

Update Product Option`keap_update_product_option`

Update a specific product option in Keap

`full`

Delete Product Option`keap_delete_product_option`

Delete a specific option from a product in Keap

`full`

Add Product Option List Item`keap_create_product_option_value`

Add list item values to a LIST-type product option in Keap

`full`

Update Product Option List Item`keap_update_product_option_value`

Update a specific list item in a LIST-type product option in Keap

`full`

Delete Product Option List Item`keap_delete_product_option_value`

Delete a specific list item from a LIST-type product option in Keap

`full`

Create Product Image`keap_create_product_image`

Upload an image file to a product in Keap

`full`

Delete Product Image`keap_delete_product_image`

Delete the image from a product in Keap

`full`

Get Product Legacy Image Data`keap_get_product_file`

Retrieve legacy image data for a product in Keap

`full`

List Subscriptions`keap_list_subscriptions`

Retrieve a paginated list of subscriptions from Keap

`full`

Create Subscription`keap_create_subscription`

Create a new subscription in Keap

`full`

Retrieve Subscription Custom Field Model`keap_get_subscription_custom_field_model`

Retrieve the custom field model for Subscription objects in Keap

`full`

Create Subscription Custom Field`keap_create_subscription_custom_field`

Create a custom field on the Subscription object in Keap

`full`

Delete Subscription Custom Field`keap_delete_subscription_custom_field`

Delete a custom field from the Subscription object in Keap

`full`

Update Subscription Custom Field`keap_update_subscription_custom_field`

Update a custom field on the Subscription object in Keap

`full`

Get Subscription`keap_get_subscription`

Retrieve a single subscription by ID from Keap

`full`

Update Subscription`keap_update_subscription`

Update an existing subscription in Keap

`full`

Cancel Subscription`keap_cancel_subscription`

Cancel a subscription in Keap

`full`

List Subscription Plans`keap_list_subscription_plans`

Retrieve a paginated list of subscription plans for a product in Keap

`full`

Create Subscription Plan`keap_create_subscription_plan`

Create a new subscription plan for a product in Keap

`full`

Get Subscription Plan`keap_get_subscription_plan`

Retrieve a single subscription plan by ID from Keap

`full`

Delete Subscription Plan`keap_delete_subscription_plan`

Delete a subscription plan from a product in Keap

`full`

Update Subscription Plan`keap_update_subscription_plan`

Update an existing subscription plan in Keap

`full`

List Payment Methods`keap_list_payment_methods`

Retrieve a paginated list of payment methods from Keap

`full`

List Contact Payment Methods`keap_list_contact_payment_methods`

Retrieve a paginated list of payment methods for a specific contact in Keap

`full`

Delete Contact Payment Method`keap_delete_payment_method`

Delete a payment method for a specific contact in Keap

`full`

Deactivate Contact Payment Method`keap_deactivate_payment_method`

Deactivate a payment method for a specific contact in Keap

`full`

List Tasks`keap_list_tasks`

Retrieve a paginated list of tasks from Keap

`full`

Get Task`keap_get_task`

Retrieve a single task by ID from Keap

`full`

Create Task`keap_create_task`

Create a new task in Keap

`full`

Update Task`keap_update_task`

Update an existing task in Keap

`full`

Delete Task`keap_delete_task`

Delete a task from Keap by ID

`full`

Retrieve Task Model`keap_get_task_model`

Retrieve the custom field model for Task objects in Keap

`full`

Create Task Custom Field`keap_create_task_custom_field`

Create a custom field on the Task object in Keap

`full`

Update Task Custom Field`keap_update_task_custom_field`

Update a custom field on the Task object in Keap

`full`

Delete Task Custom Field`keap_delete_task_custom_field`

Delete a custom field from the Task object in Keap

`full`

Get Lead Score Details`keap_get_contact_lead_score`

Retrieve the lead score for a specific contact in Keap

`full`

Get Business Profile`keap_get_business_profile`

Retrieve the business profile information from Keap

`full`

Update Business Profile`keap_update_business_profile`

Update the business profile information in Keap

`full`

## Events

Tags

Select all
|
Clear

Appointments

Companies

Contacts

Invoices

Notes

Opportunities

Payments

Products

Subscriptions

Tags

Tasks

Webhooks

No tags found

34 events

EventDescriptionTags

Webhook Verification`keap_webhook_verification`

Responds to Keap REST Hooks verification handshake. Keap sends a GET request with the x-hookdata-delivery header when a...

Webhooks

Contact Added`keap_webhook_contact_add`

Processes Keap contact.add webhook events fired when a new contact is created.

ContactsWebhooks

Contact Updated`keap_webhook_contact_edit`

Processes Keap contact.edit webhook events fired when a contact is updated.

ContactsWebhooks

Contact Deleted`keap_webhook_contact_delete`

Processes Keap contact.delete webhook events fired when a contact is deleted.

ContactsWebhooks

Contact Merged`keap_webhook_contact_merge`

Processes Keap contact.merge webhook events fired when two contacts are merged.

ContactsWebhooks

Contact Tag Applied`keap_webhook_contact_tag_applied`

Processes Keap contact.tag\_applied webhook events fired when a tag is applied to a contact.

ContactsTagsWebhooks

Contact Tag Removed`keap_webhook_contact_tag_removed`

Processes Keap contact.tag\_removed webhook events fired when a tag is removed from a contact.

ContactsTagsWebhooks

Opportunity Added`keap_webhook_opportunity_add`

Processes Keap opportunity.add webhook events fired when a new opportunity is created.

OpportunitiesWebhooks

Opportunity Updated`keap_webhook_opportunity_edit`

Processes Keap opportunity.edit webhook events fired when an opportunity is updated.

OpportunitiesWebhooks

Opportunity Deleted`keap_webhook_opportunity_delete`

Processes Keap opportunity.delete webhook events fired when an opportunity is deleted.

OpportunitiesWebhooks

Invoice Added`keap_webhook_invoice_add`

Processes Keap invoice.add webhook events fired when a new invoice is created.

InvoicesWebhooks

Invoice Updated`keap_webhook_invoice_edit`

Processes Keap invoice.edit webhook events fired when an invoice is updated.

InvoicesWebhooks

Invoice Deleted`keap_webhook_invoice_delete`

Processes Keap invoice.delete webhook events fired when an invoice is deleted.

InvoicesWebhooks

Invoice Paid`keap_webhook_invoice_paid`

Processes Keap invoice.paid webhook events fired when an invoice is marked as paid.

InvoicesWebhooks

Product Added`keap_webhook_product_add`

Processes Keap product.add webhook events fired when a new product is created.

ProductsWebhooks

Product Updated`keap_webhook_product_edit`

Processes Keap product.edit webhook events fired when a product is updated.

ProductsWebhooks

Product Deleted`keap_webhook_product_delete`

Processes Keap product.delete webhook events fired when a product is deleted.

ProductsWebhooks

Payment Added`keap_webhook_payment_add`

Processes Keap payment.add webhook events fired when a new payment is recorded.

PaymentsWebhooks

Subscription Added`keap_webhook_subscription_add`

Processes Keap subscription.add webhook events fired when a new subscription is created.

SubscriptionsWebhooks

Subscription Updated`keap_webhook_subscription_edit`

Processes Keap subscription.edit webhook events fired when a subscription is updated.

SubscriptionsWebhooks

Subscription Deleted`keap_webhook_subscription_delete`

Processes Keap subscription.delete webhook events fired when a subscription is deleted.

SubscriptionsWebhooks

Task Added`keap_webhook_task_add`

Processes Keap task.add webhook events fired when a new task is created.

TasksWebhooks

Task Updated`keap_webhook_task_edit`

Processes Keap task.edit webhook events fired when a task is updated.

TasksWebhooks

Task Deleted`keap_webhook_task_delete`

Processes Keap task.delete webhook events fired when a task is deleted.

TasksWebhooks

Task Completed`keap_webhook_task_complete`

Processes Keap task.complete webhook events fired when a task is marked complete.

TasksWebhooks

Note Added`keap_webhook_note_add`

Processes Keap note.add webhook events fired when a new note is created.

NotesWebhooks

Note Updated`keap_webhook_note_edit`

Processes Keap note.edit webhook events fired when a note is updated.

NotesWebhooks

Note Deleted`keap_webhook_note_delete`

Processes Keap note.delete webhook events fired when a note is deleted.

NotesWebhooks

Company Added`keap_webhook_company_add`

Processes Keap company.add webhook events fired when a new company is created.

CompaniesWebhooks

Company Updated`keap_webhook_company_edit`

Processes Keap company.edit webhook events fired when a company is updated.

CompaniesWebhooks

Company Deleted`keap_webhook_company_delete`

Processes Keap company.delete webhook events fired when a company is deleted.

CompaniesWebhooks

Appointment Added`keap_webhook_appointment_add`

Processes Keap appointment.add webhook events fired when a new appointment is created.

AppointmentsWebhooks

Appointment Updated`keap_webhook_appointment_edit`

Processes Keap appointment.edit webhook events fired when an appointment is updated.

AppointmentsWebhooks

Appointment Deleted`keap_webhook_appointment_delete`

Processes Keap appointment.delete webhook events fired when an appointment is deleted.

AppointmentsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.