Access Token

Refresh Token

Keap

Appointments

Companies

Contacts by Tag

Contacts

Emails

Notes

Opportunities

Opportunity Stages

Tasks

Users

Keap REST API

Retrieves profile/company info for an account.

Retrieve account profile

Updates profile/company info for an account.

Updates an account profile

List Affiliates

Create an affiliate

Retrieve a list of Commissions based on Affiliate or Date Range

List Commissions

Get the custom fields for the Affiliate object

Retrieve Affiliate Model

List Commission Programs

Retrieves a list of all affiliate redirects

List Affiliate Redirects

List affiliate summaries

Retrieves a list of all affiliate clawbacks

List Affiliate clawbacks

Retrieves a list of all affiliate payments

List Affiliate payments

Retrieve an affiliate

Retrieves all appointments for the authenticated user

List Appointments

Creates a new appointment as the authenticated user

Create an Appointment

Get the custom fields for the Appointment object

Retrieve Appointment Model

Adds a custom field of the specified type and options to the Appointment object.

Create a Custom Field

Retrieves a specific appointment with respect to user permissions. The authenticated user will need the "can view all records" permission for Task/Appt/Notes

Retrieve an Appointment

Replaces all values of a given appointment

Replace an Appointment

Delete an Appointment

Updates the provided values of a given appointment

Update an Appointment

Retrieves all campaigns for the authenticated user

List Campaigns

Achieves API goal for campaigns with matching integration, callName for a given contactId

Achieve API Goal

Retrieve a Campaign

Adds a list of contacts to a campaign sequence
Response contains a map of the provided list of Contact Ids related to their individual result.

Add Multiple to Campaign Sequence

Removes a list of contacts from a campaign sequence

Remove Multiple from Campaign Sequence

Adds a single contact to a campaign sequence

Add to Campaign Sequence

Removes a single contact from a campaign sequence

Remove from Campaign Sequence

List Companies

Creates a new company as the authenticated user. NB: Company must contain at least the company name. The `country_code` is required if `region` is specified.

You may opt-in or mark a Company as _Marketable_ by including the following field in the request JSON with an opt-in reason. (This field is also shown in the complete request body sample.) The reason you provide here will help with compliance. Example reasons: "Customer opted-in through webform", "Company gave explicit permission."

```json
"opt_in_reason": "your reason for opt-in"
```
Note that the email address status will only be updated to unconfirmed (marketable) for email addresses that are currently in the following states:
Unengaged Marketable
Unengaged Non-Marketable
Non-Marketable
Opt-Out: Manual
All other existing statuses e.g. List Unsubscribe, Opt-Out System etc will remain non-marketable and in their existing state.

Create a Company

Get the custom fields and optional properties for the Company object

Retrieve Company Model

Retrieve a Company

Updates a company with only the values provided in the request.

You may opt-in or mark a Company as _Marketable_ by including the following field in the request JSON with an opt-in reason. (This field is also shown in the complete request body sample.) The reason you provide here will help with compliance. Example reasons: "Customer opted-in through webform", "Company gave explicit permission."

```json
"opt_in_reason": "your reason for opt-in"
```
Note that the email address status will only be updated to unconfirmed (marketable) for email addresses that are currently in the following states:
Unengaged Marketable
Unengaged Non-Marketable
Non-Marketable
Opt-Out: Manual
All other existing statuses e.g. List Unsubscribe, Opt-Out System etc will remain non-marketable and in their existing state.

Update a Company

List Contacts

Creates a new contact as the authenticated user. NB: Contact must contain at least one item in `email_addresses` or `phone_numbers` and `country_code` is required if `region` is specified.

Please see the body schema for updates to the postal code field.

You may opt-in or mark a Contact as _Marketable_ by including the following field in the request JSON with an opt-in reason. (This field is also shown in the complete request body sample.) The reason you provide here will help with compliance. Example reasons: "Customer opted-in through webform", "Contact gave explicit permission."

```json
"opt_in_reason": "your reason for opt-in"
```
Note that the email address status will only be updated to unconfirmed (marketable) for email addresses that are currently in the following states:
Unengaged Marketable
Unengaged Non-Marketable
Non-Marketable
Opt-Out: Manual
All other existing statuses e.g. List Unsubscribe, Opt-Out System etc will remain non-marketable and in their existing state.

This API only supports a subset of valid timezones. A list of the supported timezones can be found [here](https://developer.infusionsoft.com/faqs/what-timezones-do-contact-calls-accept/).

Create a Contact

Creates a new contact or updates a contact as the authenticated user. NB: New Contacts must contain at least one item in `email_addresses` or `phone_numbers` and `country_code` is required if `region` is specified. Existing Contacts are updated with only the values provided in the request. Accepts a `duplicate_option` which performs duplicate checking by one of the following options: `Email`, `EmailAndName`, if a match is found using the option provided, the existing contact will be updated. If an existing contact was not found using the `duplicate_option` provided, a new contact record will be created.

You may opt-in or mark a Contact as _Marketable_ by including the following field in the request JSON with an opt-in reason. (This field is also shown in the complete request body sample.) The reason you provide here will help with compliance. Example reasons: "Customer opted-in through webform", "Contact gave explicit permission."

```json
"opt_in_reason": "your reason for opt-in"
```
Note that the email address status will only be updated to unconfirmed (marketable) for email addresses that are currently in the following states:
Unengaged Marketable
Unengaged Non-Marketable
Non-Marketable
Opt-Out: Manual
All other existing statuses e.g. List Unsubscribe, Opt-Out System etc will remain non-marketable and in their existing state.

This API only supports a subset of valid timezones. A list of the supported timezones can be found [here](https://developer.infusionsoft.com/faqs/what-timezones-do-contact-calls-accept/).

Create or Update a Contact

Get the custom fields and optional properties for the Contact object

Retrieve Contact Model

Adds a custom field of the specified type and options to the Contact object.

Delete a Contact

Updates a contact with only the values provided in the request.

You may opt-in or mark a Contact as _Marketable_ by including the following field in the request JSON with an opt-in reason. (This field is also shown in the complete request body sample.) The reason you provide here will help with compliance. Example reasons: "Customer opted-in through webform", "Contact gave explicit permission."

```json
"opt_in_reason": "your reason for opt-in"
```
Note that the email address status will only be updated to unconfirmed (marketable) for email addresses that are currently in the following states:
Unengaged Marketable
Unengaged Non-Marketable
Non-Marketable
Opt-Out: Manual
All other existing statuses e.g. List Unsubscribe, Opt-Out System etc will remain non-marketable and in their existing state.

Update a Contact

Retrieve Credit Cards

Creates a new credit card associated to a contact

Create a Credit Card

List Emails that have been sent to a Contact

List Emails

Create a record of an email sent to a contact

Create an Email Record

Retrieves a list of tags applied to a given contact

List Applied Tags

Apply a list of tags to a given contact record

Apply Tags

Removes a list of tags from the given contact. Provide one or more tag ids in the querystring as a comma-separated URIencoded list (%2C is a comma). E.g. DELETE /contacts/{contact_id}/tags?ids=1%2C2%2C3

Remove Applied Tags

Remove Applied Tag

Retrieve a Contact

Replaces all of the values of a given email address

You may opt-in or mark an email address as _Marketable_ by including the following field in the request JSON with an opt-in reason. (This field is also shown in the complete request body sample.) The reason you provide here will help with compliance. Example reasons: "Customer opted-in through webform", "Company gave explicit permission."

```json
"opt_in_reason": "your reason for opt-in"
```
Note that the email address status will only be updated to unconfirmed (marketable) for email addresses that are currently in the following states:
Unengaged Marketable
Unengaged Non-Marketable
Non-Marketable
Opt-Out: Manual
All other existing statuses e.g. List Unsubscribe, Opt-Out System etc will remain non-marketable and in their existing state.

Replace an Email Address

Retrieve a list of emails that have been sent

Keap is currently investigating an issue with degraded performance
of this endpoint with very large (millions of records) record sets

Send an Email

Create a set of records of emails sent to contacts, maximum 1000 per transaction.

Create a set of Email Records

Un-sync a batch of Email Records

Retrieves a single email that has been sent

Retrieve an Email

Delete an Email Record

List Files

Upload a base64 encoded file. `contact_id` is required only when `file_association` is `CONTACT`.

Upload File

Retrieves metadata about a specific file. Optionally returns the base64 encoded file data.

Retrieve File

Upload a base64 encoded file to replace an existing one. `contact_id` is required only when `file_association` is `CONTACT`.

Replace File

Delete File

List Stored Hook Subscriptions

To receive hooks, you'll first need to subscribe to events one at a time *and* individually verify each subscription.

This operation is used to create hook subscriptions. During this process, Infusionsoft will attempt to verify your subscription. Continue reading to learn how that works.

To verify or reactivate a hook subscription, Infusionsoft will make a `POST` request with a temporary secret to the `hookUrl` you provided during creation. The secret is passed as the value of a header named `X-Hook-Secret`. Your response to that `POST` *must* have a status code of `200` and return the same `X-Hook-Secret` header and value pair. Once you've done that, you'll begin receiving hooks. Don't worry if verification fails; you can always [request another verification attempt](#!/REST_Hooks/verify_a_hook_subscription).

NB: You will not receive events until the subscription is verified.

If the verification process seems confusing, head over to [RESTHooks.org](http://resthooks.org/docs/security/) for more on the concept.

Create a Hook Subscription

List the available types of Events that can be listened to

List Hook Event Types

Retrieves an existing hook subscription and its status.

If your hook subscription becomes inactive, you may request an activation attempt via [Verify a Hook Subscription](#!/REST_Hooks/verify_a_hook_subscription).

Retrieve a Hook Subscription

Modify an existing hook subscription using the provided values.

Update a Hook Subscription

Stop receiving hooks by deleting an existing hook subscription.

Delete a Hook Subscription

This operation is used to verify or reactivate a hook subscription out-of-band using RESTHooks.org's [Delayed Confirmation](http://resthooks.org/docs/security/) pattern.

Use this verification method if you're not able to use the Immediate Confirmation provided through [Create a Hook Subscription](#!/REST_Hooks/create_a_hook_subscription) or [Verify a Hook Subscription](#!/REST_Hooks/verify_a_hook_subscription). This operation allows you to confirm a subscription by manually sending us the `X-Hook-Secret` you received.

NB: **The `X-Hook-Secret` _must_ be passed as a _header_.**

Don't worry if verification fails; you can always [request another verification attempt](#!/REST_Hooks/verify_a_hook_subscription).

NB: You will not receive events until the subscription is verified.

If the verification process seems confusing, head over to [RESTHooks.org](http://resthooks.org/docs/security/) for more on the concept.

Verify a Hook Subscription, Delayed

This operation is used to verify or reactivate a hook subscription using RESTHooks.org's [Immediate Confirmation](http://resthooks.org/docs/security/) pattern.

To verify or reactivate a hook subscription, Infusionsoft will make a `POST` request with a temporary secret to the `hookUrl` you provided during creation. The secret is passed as the value of a header named `X-Hook-Secret`. Your response to that `POST` *must* have a status code of `200` and return the same `X-Hook-Secret` header and value pair. Once you've done that, you'll begin receiving hooks. Don't worry if verification fails; you can always [request another verification attempt](#!/REST_Hooks/verify_a_hook_subscription).

NB: You will not receive events until the subscription is verified.

If the verification process seems confusing, head over to [RESTHooks.org](http://resthooks.org/docs/security/) for more on the concept.

Verify a Hook Subscription

List Countries

List a Country's Provinces

List dropdown default options

Retrieves a list of all merchant accounts

List Merchants

List Notes

Creates a new note as the authenticated user. Either a "title" or "body" is required

Create a Note

Get the custom fields for the Note object

Retrieve Note Model

Adds a custom field of the specified type and options to the Note object.

Retrieve a Note

Replace a Note

Delete a Note

Updates a note with only the values provided in the request

Update a Note

Retrieves information for the current authenticated end-user, as outlined by the [OpenID Connect specification](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo).

Retrieve User Info

Retrieves a list of all opportunities.

Please note: the sample response erroneously shows properties, such as _stage reasons_, that are unavailable through the list endpoint. Such properties are only available through the retrieve operation. Future versions of the Opportunity resource will correct the oversight.

List Opportunities

Creates a new opportunity as the authenticated user.

Create an Opportunity

Replaces all values of a given opportunity

Replace an Opportunity

Get the custom fields for the Opportunity object

Retrieve Opportunity Model

Retrieve an Opportunity

Updates an opportunity with only the values provided in the request.  
  
*Note:* The POST payload for this request is identical to ['Replace an Opportunity'](https://developer.infusionsoft.com/docs/rest/#operation/updateOpportunityUsingPUT) operation.

Update an Opportunity

Retrieves a list of all opportunity stages with pipeline details

List Opportunity Stage Pipeline

Retrieves a list of all orders using the specified search criteria. Each order may or may not have items.

Potential values for order status:`DRAFT`, `SENT`, `VIEWED`, `PAID`

List Orders

Create a one time order with order items.

Create an Order

Get the custom fields for the Order object

Retrieve Custom Order Model

Retrieves a single order. The order may or may not have items.

Potential values for order status:`DRAFT`, `SENT`, `VIEWED`, `PAID`

Retrieve an Order

Delete an order that does not have a payment

Delete an Order

Creates an order item on an existing order.

Create an Order Item

Delete an Order Item

Replaces the order's payment plan with the given values.

Replace an Order Pay Plan

Retrieves a list of payments made against a given order, including historical or external payments of cash or credit card.

Retrieve Order Payments

Creates a payment record that can charge a credit card. Alternatively, adds a record of historical or external payment of cash or credit card.

Create a Payment

Retrieves a list of all transactions on a given order using the specified search criteria

Retrieve Order Transactions

Salesforce

HubSpot

Zoho CRM

Microsoft Dynamics 365

Pipedrive

Attio

Xero

Freshsales

SugarCRM

Outreach

ActiveCampaign

Capsule CRM

Salesloft

Zendesk

Sage Accounting

Zoho Books

Agile CRM

SalesForce Pardot

SharpSpring

Teamleader

Insightly

# Realtime Full two-way Sync of Companies

This scenario enables your application to fully sync Companies between your app and any external application in both directions. It handles the initial import/export of Companies and then sends events when a Company is created, updated, or deleted on any side, as close to real-time as possible.

Company fields will be mapped from your application's schema to the application-specific schema.

## How It Works

1. **Initial Sync**:
   - Perform the initial import by calling the Integration.app REST API or SDK in a loop from your code to retrieve data page by page. Integration.app transforms the output into a consistent format compatible with your API, allowing you to save and match data efficiently.
   - Make another set of requests to create Companies in external app, if needed.

2. **Continuous Sync from External App**:
   - Enable subscription via a single API or SDK call to continuously receive created, updated, or deleted events from external applications.
   - Integration.app manages all integration-specific logic, including subscribing to/unsubscribing from webhooks, custom polling of events, or performing periodic full syncs.
   - You will only receive the necessary events as real-time as supported by the external application's API.


2. **Continuous Sync from Your App**:
   - You will get a single webhook URI that you will use to send events about created, updated, or deleted Companies to Integration.app.
   - Once send, Integration.app will map the webhook payload to the format supported by external application and send the correct request


Two-way realtime sync of Companies

Bi-directional realtime sync of Companies with records deduplication

Keap API Integration Profile

Data Collections

Operations

Integration Scenarios

Two-way realtime sync of Companies

Continuously Import Contacts to my App

Continuously Import Users to my App

Create Note

Continuously Import Tasks to my App

Get all Notes

Similar Integrations

Build every single integration your customers need with AI