Keap

Achieves a goal in an automation for a contact

Achieves a WordPress Opt-In Option Goal

Creates a single Affiliate

Assigns an Affiliate to Commission Program

Creates an Affiliate Commission Program

Creates a resource for a commission program

Adds a list of contacts to an automation sequence Response contains a map of the provided list of Contact Ids and their individual result.

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.

Adds a value to the list of WordPress Opt-In Options Available

Creates a new Product Interest in an existing Bundle.

Adds product option values to a product option of type LIST

Applies a Tag to a Company.

Increase or decrease the quantity of the Product

Applies commission to an order item on an existing order.

Applies a Tag to a list of Contacts.

Calculate taxes for a single Order for a given order id

Assigns a Product Commission Program to a Product

Updates the list of products assigned to a Product Category. **Note:** The full list of product IDs that should remain assigned must be provided; any IDs omitted are removed automatically.

Assigns a Subscription Commission Program to a Subscription

Attaches an uploaded File to an Order Invoice

Bulk updates the categories of one or more automations

Bulk unpublish one or more automations

Cancels the specified subscription

Returns the total number of participants and unique contacts currently active in the given automation.

Creates a single Affiliate Custom Field

Creates a new custom field group for the Affiliate record type. If `tab_id` is omitted, the group is added to the default 'Custom Fields' tab.

Creates a single automation category

Creates a Category Discount

Creates a new Company.`country_code` is required if `region` is specified.

Creates a custom field of the specified type and options to the Company object

Creates a new custom field group for the Company record type. If `tab_id` is omitted, the group is added to the default 'Custom Fields' tab.

Creates a new Contact. *Note:* Contact must contain at least one item in `email_addresses`, `phone_numbers`, or `addresses` and `country_code` is required if `region` is specified. Optionally accepts a `duplicate_option` query parameter which performs duplicate checking by one of the following options: `Email`, `EmailAndName`, `EmailAndNameAndCompany`. 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. When `duplicate_option` is not specified, a new contact is always created.

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

Creates a new custom field group for the Contact record type. If `tab_id` is omitted, the group is added to the default 'Custom Fields' tab.

Creates a new type of Contact Link

Creates a Default Commission Program

Creates a Record of an Email sent to a Contact

Creates a set of Records of Emails sent to Contacts, maximum 1000 per transaction.

Uploads a file using multipart/form-data. The `file` part contains the binary file content; `file_name`, `is_public`, `file_association`, and optionally `contact_id` are additional text parts in the same multipart request. Sending these as URL query parameters is not supported.

Creates a Subscription Free Trial Discount

Creates a Subscription Free Trial Discount Criteria

Creates the product category image file and uploads it to the specified product category

Creates a new Lead Source

Creates a new Lead Source Category.

Creates a new Lead Source Expense

Creates a new Lead Source Recurring Expense

Creates a new Note.

Creates a custom field of the specified type and options to the Note object<br/>Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.

Creates a new custom field group for the Note record type. If `tab_id` is omitted, the group is added to the default 'Custom Fields' tab.<br/>Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.

Creates a new opportunity as the authenticated user.

Creates a new custom field group for the Opportunity record type. If `tab_id` is omitted, the group is added to the default 'Custom Fields' tab.

Creates a custom field of the specified type and options to the Opportunity object

Creates a new Opportunity Stage

Creates a one time Order with Order items

Creates a custom field of the specified type and options to the Order object

Creates a new custom field group for the Order record type. If `tab_id` is omitted, the group is added to the default 'Custom Fields' tab.

Creates an order item on an existing order

Creates an Order Total Discount

Creates an Order Total Discount Criteria

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

Creates configuration details for rendering payment method components

Creates a new product

Creates a new Product Category

Creates a Product Discount

Creates a Product Discount Criteria

Creates the Product Image file and uploads it to the specified Product

Creates a new Product Interest Bundle.

Creates a new product option

Creates a single Affiliate Link

Creates a new referral partner referral on the provided contact

Creates a Shipping Discount

Creates a Shipping Discount Criteria

Creates a subscription with the specified product and product subscription id.

Creates a custom field of the specified type and options to the Subscription object

Creates a new custom field group for the Subscription record type. If `tab_id` is omitted, the group is added to the default 'Custom Fields' tab.

Creates a Subscription Plan

Creates a new Tag

Creates a new Tag Category.

Creates a new task as the authenticated user.

Creates a custom field of the specified type and options to the Task object<br/>Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.

Creates a new custom field group for the Task record type. If `tab_id` is omitted, the group is added to the default 'Custom Fields' tab.<br/>Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.

Deactivate the specified payment method

Deletes the specified Affiliate

Deletes a Commission Program

Deletes a Custom Field from Affiliate.

Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.

Deletes a single automation

Deletes one or more automation categories based on the request parameters

Deletes a specified Category Discount

Removes a resource from a commission program

Deletes the specified Company

Deletes a custom field from the company model

Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.

Deletes the specified Contact

Deletes a custom field from the Contacts model

Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.

Deletes the specified Contact Link type. The Link type cannot be deleted if it is currently applied to any Linked Contacts.

Deletes a specific Email Record

Removes a set of Email Records

Deletes a specified file

Deletes a specified Subscription Free Trial Discount

Deletes a specified Subscription Free Trial Discount Criteria

Deletes the image from the specified product category

Deletes a value from the list of WordPress Opt-In Options Available

Deletes a Lead Source by ID

Deletes the specified Lead Source Category

Deletes a lead source expense by ID

Deletes a new Lead Source Recurring Expense that belongs to a Lead Source

Deletes the specified Note

Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.<br/>Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.

Deletes a Custom Field from the Note object<br/>Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.

Deletes a Custom Field from Opportunity.

Deletes the specified Opportunity

Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.

Deletes the specified Opportunity Stage

Deletes an Order<br/> Note: The Order must not have any transactions recorded to be available for deletion.

Deletes a Custom Field from the Order object

Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.

Deletes an order item on an existing order

Deletes a specified Order Total Discount

Deletes a specified Order Total Discount Criteria

Deletes the specified payment method

Deletes a single product

Deletes the specified Product Category, its sub-categories, and removes products from it

Deletes a specified Product Discount

Deletes a specified Product Discount Criteria

Deletes the Product Image from the specified Product

Deletes an existing Product Interest Bundle.

Deletes a single product option

Deletes a single option value in a Product Option of type LIST

Deletes an Affiliate Link

Deletes a specified Shipping Discount

Deletes a specified Shipping Discount Criteria

Deletes a custom field from the Subscription object

Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.

Deletes a Subscription Plan

Deletes a Tag.

Deletes the specified Tag Category

Deletes a single task

Deletes a Custom Field from the Task object<br/>Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.

Deletes a custom field group. Returns 409 Conflict if the group still contains custom fields.<br/>Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.

Detaches a File from an Order Invoice

Retrieves a Subscription Plan

Retrieves a single Affiliate

Get the Affiliate Commission Earned and View LedgerURl for portal

Retrieve a list of Affiliate's Commissions

Retrieves a single custom field group by id for the Affiliate record type.

Get the custom fields and optional properties for the Affiliate object

Get configuration values for the application instance.

Retrieves a single automation

Retrieves Business Profile information.

Retrieves a single campaign

Retrieves a list of Goals (published) for a Campaign

Retrieves a list of Sequences (published) for a Campaign

Returns information about the specified Tag Category

Retrieves a single Category Discount

Retrieves a single Commission Program

Retrieves a single Company

Retrieves a single custom field group by id for the Company record type.

Retrieves a single Contact

Retrieves a single custom field group by id for the Contact record type.

Gets a list of Contact Option types.

Gets a country by its code or name

Retrieves a single Email that has been sent

Retrieves the opt-in status for a given Email Address

Retrieve an email template

Retrieves a file

Retrieves the product's legacy image

Retrieves a file's data

Retrieves a Subscription Free Trial Discount

Returns the HTML

Retrieves information about the Lead Score of a Contact

Retrieves a Lead Source by ID

Retrieves a single Lead Source Category for a given ID

Retrieves a single Lead Source Expense for a given ID

Retrieves a Lead Source Recurring Expense using leadSourceId and leadSourceRecurringExpenseId

Retrieves the specified Note

Retrieves a single custom field group by id for the Note record type.<br/>Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.

Retrieves the specified Opportunity

Retrieves a single custom field group by id for the Opportunity record type.

Retrieves the specified Opportunity Stage

Retrieves a single historical record of an opportunity being moved from one pipeline stage to another.

Retrieves a single Order for a given order id

Retrieves a single custom field group by id for the Order record type.

Retrieves a single order item from an existing order

Retrieves an Order Total Discount

Gets a single Product

Gets a single Product Category

Retrieves a Product Discount

Gets a single Product Interest Bundle.

Retrieves a Product Option

Get a province by its code or name

Retrieves information about a single Affiliate Link

Retrieves all referrals belonging to the given affiliate

Retrieves a Shipping Discount

Retrieves a single subscription

Retrieves a single custom field group by id for the Subscription record type.

Retrieves information about the specified Tag

Retrieves a single task

Retrieves a single custom field group by id for the Task record type.<br/>Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.

Retrieves a specific User

Retrieves a single user group by its ID.

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).

Retrieves a HTML snippet that contains the user's email signature.

Generates invoices from all cycles of a subscription that are due. Returns the most recently billed invoice.

Check if the application is enabled or not

Links two Contacts together using the provided Link type

Retrieves a list of Affiliates

Retrieves a list of Affiliate Commission Programs

Retrieves a list of custom field groups for the Affiliate record type. Optionally filter by tab_id to scope to a specific tab.

Retrieves a list of Affiliate Links

Retrieves a list of affiliate payments

Retrieves a list of automations IDs

Retrieves a list of all notes

Retrieves a list of Products assigned to Product Categories

Retrieves a list of automations

Retrieves a list of campaigns for the authenticated user

Retrieves a list of automation categories

Retrieves a list of Category Discounts

Retrieves resources for a commission program

Retrieves a list of all Companies.<br/><br/>

Retrieves a list of Companies that have the given Tag applied. To search for `null` or empty fields use `filter==NONE`

Retrieves a list of custom field groups for the Company record type. Optionally filter by tab_id to scope to a specific tab.

Retrieves a list of custom field groups for the Contact record type. Optionally filter by tab_id to scope to a specific tab.

Retrieves a list of Contact Link types.

Retrieves a list of Linked Contacts for a given Contact

Retrieves a list of Contacts

Retrieves a list of Contacts with the specified Tag To search for `null` or empty fields use `filter==NONE`

Retrieves a list of countries

Retrieve a list of the Status of Email Addresses

Retrieves a list of emails that have been sent

Retrieves a list of expenses incurred from a recurring expense

Retrieves a list of files

Retrieves a list of Subscription Free Trial Discounts

Retrieves the list of WordPress Opt-In Options available

Retrieves a list of Lead Source Categories

Retrieves a list of lead source expenses

Retrieves a list of recurring expenses with lead_source_id and optional 'filter' query param

Retrieves a list of Lead Sources

Retrieves a list of Merchant accounts

Retrieves a list of custom field groups for the Note record type. Optionally filter by tab_id to scope to a specific tab.<br/>Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.

Retrieves a list of Note Templates

Retrieves a list of Notes for a given contact

Retrieves a list of all Opportunities.

Retrieves a list of custom field groups for the Opportunity record type. Optionally filter by tab_id to scope to a specific tab.

Returns a paginated list of historical stage-move records.

Retrieves a list of Opportunity Stages.

Retrieves a list of custom field groups for the Order record type. Optionally filter by tab_id to scope to a specific tab.

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

Retrieves a list of Order Total Discounts

Retrieves a list of orders

Retrieves a list of users

Retrieves a list of Payment Methods

Retrieves a list of Contact Payment Methods

Retrieves a list of payments

Retrieves a list of Product Categories

Retrieves a list of Product Discounts

Retrieves a list of Product Interest Bundles

Retrieves all options of a Product

Retrieves a list of Products

Retrieves a list of provinces for a given country

Retrieves a list of all referrals with optional filtering and sorting

Retrieves a list of Reports as defined in the application (identified as Saved Search)<br/><span style='color:red'>Deprecated as of v2</span>

Retrieves a list of Shipping Discounts

Retrieves a list of Shipping methods

Retrieves a list of custom field groups for the Subscription record type. Optionally filter by tab_id to scope to a specific tab.

Retrieves a list of Subscription Plans

Retrieves a list of subscriptions using the specified search criteria.

Retrieves a list of Affiliate Summaries

Retrieves a list of defined Tag Categories To search for `null` or empty fields use `filter==NONE`

Retrieves a list of Tags defined in the application To search for `null` or empty fields use `filter==NONE`

Retrieves a list of tags applied to the specified Company

Retrieves a list of tags applied to the specified Contact

Retrieves a list of custom field groups for the Task record type. Optionally filter by tab_id to scope to a specific tab.<br/>Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.

Retrieves a list of tasks based on the provided filter. Tasks which are not assigned to a User may be queried with user_id==UNASSIGNED.

Retrieves a list of sales transactions

Retrieves a list of all user groups in the application.

Retrieves a list of webforms

Merges two Contacts together. The duplicate contact will be merged into the primary contact.

Updates part of a single automation category

Removes an Affiliate from a Commission Program

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

Removes a Product from a Commission Program

Deletes an existing Product Interest from an existing Bundle.

Removes a Subscription from a Commission Program

Remove a Tag from a Company.

Removes a Tag from a list of Contacts.

Get the custom fields for the Company object

Get the custom fields and optional properties for the Contact object

Gets the custom fields for the Note object<br/>Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.

Get the custom fields for the Opportunity object

Gets the custom fields for the Order object

Retrieves information about a Report as defined in the application (identified as Saved Search)<br/><span style='color:red'>Deprecated as of v2</span>

Retrieves the list of fields available for a Report (Saved Search). The returned field `name` values can be used in the `fields` parameter when running the report.

Get the custom fields for the Subscription object

Get the custom fields for the Task object<br/>Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.

Runs a report as defined in the application (identified as Saved Search)<br/><span style='color:red'>Deprecated as of v2</span>

Sends an Email to a list of Contacts

Send an email based on a template

Sets the specified Merchant Account as the default Merchant Account.

Deletes Link between two Contacts

Unpublishes a single automation

Updates a single Affiliate

Updates a custom field of the specified type and options to the Affiliate object.

Updates an existing custom field group. Only fields listed in `update_mask` are applied.

Updates Business Profile information.

Updates a Category Discount

Updates the properties of an Affiliate Commission Program

Updates a resource for a commission program

Updates a Company with the values provided in the request

Updates a custom field of the specified type and options to the Company object

Updates an existing custom field group. Only fields listed in `update_mask` are applied.

Updates a Contact

Updates an existing custom field group. Only fields listed in `update_mask` are applied.

Updates the specified Contact Link type. Only fields listed in `update_mask` are applied. Reducing `max_links` below the current number of Linked Contacts of this type returns 409 Conflict.

Updates a Default Commission Program

Updates an Email Address opt-in status 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.

Updates a file using multipart/form-data. Note that this endpoint uses POST instead of PATCH.

Updates a Subscription Free Trial Discount

Updates a Lead Source with only the values provided in the request

Updates a Lead Source Category

Updates a new Lead Source Expense

Updates a Lead Source Recurring Expense

Updates a Note for a Contact

Updates an existing custom field group. Only fields listed in `update_mask` are applied.<br/>Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.

Updates a custom field of the specified type and options to the Note object<br/>Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.

Updates specified values of a given opportunity

Updates a custom field of the specified type and options to the Opportunity object.

Updates an existing custom field group. Only fields listed in `update_mask` are applied.

Updates specified values of a given Opportunity Stage

Updates an Order

Updates a custom field of the specified type and options to the Order object

Updates an existing custom field group. Only fields listed in `update_mask` are applied.

Updates an Order Item

Updates an Order Total Discount

Updates a product

Updates a single Product Category

Updates a Product Commission Program

Updates a Product Discount

Updates an existing Product Interest in an existing Bundle.

Updates an existing Product Interest Bundle.

Updates a product option

Updates a single product option value

Updates an Affiliate Link

Updates a Shipping Discount

Updates the lifecycle state of an existing Easy Automation. Supported states: `disabled`, `enabled`.

Updates a Subscription

Updates a Subscription Commission Program

Updates a custom field of the specified type and options to the Subscription object

Updates an existing custom field group. Only fields listed in `update_mask` are applied.

Updates a Subscription Plan

Updates a Tag with only the values provided in the request

Updates a Tag Category with only the values provided in the request

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

Updates a custom field of the specified type and options to the Task object.<br/>Note: Custom Fields for Tasks, Classic Appointments and Notes are combined.

Updates an existing custom field group. Only fields listed in `update_mask` are applied.<br/>Note: Custom Field Groups for Tasks, Classic Appointments and Notes are combined.

Updates information on a specific User