Connect Keap to your AI

List Contacts

filter

Filter to apply, allowed fields are: - (String) email - supports wildcard (e.g.

order_by

Attribute and direction to order items.

page_size

Total number of items to return per page

fields

Comma-delimited list of Contact properties to include in the response.

Create a Contact

duplicate_option

Duplicate check strategy.

fields

Comma-delimited list of Contact properties to include in the response.

addresses

Any item not listed here will be removed if it already exists.

prefix

Name prefix

List Tagged Contacts

tag_idrequired

filter

Filter to apply, allowed fields are: - (String) givenname - (String) familyname - (String) email - (String) sinceappliedtime - (String) untilappliedtime You will need to apply t...

order_by

Attribute and direction to order items.

page_size

Total number of items to return per page

Create a Contact Custom Field

labelrequired

field_typerequired

group_id

An optional tab group to place the field under in the interface.

user_group_id

An optional user group to choose from when selecting values for User or UserListBox fields.

List Contact Link types

filter

Filter to apply, allowed fields are: - (String) name You will need to apply the == operator to check the equality of one of the filters with your searched word, in the encoded f...

order_by

Attribute and direction to order items.

page_size

Total number of items to return per page

Create a Contact Link type

name

Link type name

max_links

Maximum number of links allowed (must be > 0)

List Linked Contacts

contact_idrequired

List Contact Custom Field Tabs

Create a Contact Custom Field Tab

List Contact Custom Field Groups

tab_id

Optional tab id to scope groups to a single tab

List all Product Discounts

filter

Filter to apply, allowed fields are: - (Boolean) applytocommissions - (DiscountType) discounttype: AMOUNT or PERCENT - (Double) discountvalue - (String) productid You will need...

order_by

Attribute and direction to order items.

page_size

Total number of items to return per page

Create a Product Discount

namerequired

Name of the discount

product_idrequired

ID of the product this discount applies to

discount_typerequired

Type of discount: AMOUNT (fixed amount) or PERCENT (percentage)

discount_valuerequired

Value of the discount (amount or percentage depending on discounttype)

Retrieve a Product Discount

discount_idrequired

Update a Product Discount

discount_idrequired

update_mask

An optional list of properties to be updated.

name

Name of the discount

description

Description of the discount

Delete a Product Discount

discount_idrequired

Create a Product Discount Criteria

discount_idrequired

type

Type of criteria: DATERANGE, PROMOCODE, PRODUCT, SUBSCRIPTIONPLAN, or ORDERTOTAL

code

Promotional code for PROMOCODE criteria

range_start_time

Start date/time for DATERANGE criteria (ISO-8601 format)

List Notes

contact_idrequired

filter

Filter to apply.

order_by

Attribute and direction to order items.

page_size

Total number of items to return per page

Create a Note

contact_idrequired

user_idrequired

ID of user creating the note

fields

Comma-delimited list of optional Note properties to include in the response.

title

A value for either title or type is required.

Retrieve a Note

contact_idrequired

note_idrequired

fields

Comma-delimited list of optional Note properties to include in the response.

Update a Note

contact_idrequired

note_idrequired

user_idrequired

ID of user creating the note

update_mask

An optional list of properties to be updated.

List orders

filter

Filter to apply, allowed fields are: - (String) id - Allowable operators: "=="," =", ">", "!=" - (List[String]) ids - (String) productid - (String) contactid - (String) invoicei...

order_by

Attribute and direction to order items.

page_size

Total number of items to return per page

Create an Order

contact_idrequired

ID of the contact for this order

order_titlerequired

Title for the order

order_timerequired

The date and time of the order.

order_typerequired

The order type.