Keap tools
The 14 Keap operations your product runs on your customer's account through Connect. All of them use the same endpoint, POST /api/tools/{tool}/execute.
- List contactsGETLists the contacts of the Keap app in contacts, with next_page_token for the following page. Without fields, each contact comes with a default set of properties. Filter by email, name, ids and other fields with filter.
- Create contactPOSTCreates a contact and returns it. It needs at least one item in email_addresses, phone_numbers or addresses. With duplicate_option, a matching contact is updated instead of a new one being created.
- Update contactPATCHUpdates the fields sent and returns the contact. Fields left out keep their values, but each list sent (email_addresses, phone_numbers, addresses) replaces the whole list.
- List tagsGETLists the tags of the Keap app in tags, with id, name, description and category, and next_page_token for the following page.
- Create tagPOSTCreates a tag and returns it with its id. The tag is not applied to anyone until Apply tag.
- Apply tagPOSTApplies a tag to one or more contacts. Applying a tag can start the automations of the Keap app that listen to it, such as email sequences.
- Remove tagPOSTRemoves a tag from one or more contacts. The tag itself stays in the Keap app.
- List opportunitiesGETLists the opportunities of the sales pipeline in opportunities, each with its contact, stage and user, and next_page_token for the following page.
- Create opportunityPOSTCreates an opportunity for a contact in a pipeline stage and returns it. opportunity_title, contact_id and stage_id are required.
- Update opportunityPATCHUpdates the fields sent and returns the opportunity. Fields left out keep their values. Moving the opportunity to another stage is a change of stage_id.
- Create notePOSTAdds a note to a contact and returns it. user_id is required, and so is title or type.
- Create taskPOSTCreates a task assigned to a user, optionally about a contact or an opportunity, and returns it. title and assigned_to_user_id are required.
- List opportunity stagesGETLists the stages of the sales pipeline in stages, with id, name, order and win probability. The ids are the stage_id the opportunity tools take.
- List usersGETLists the users of the Keap app in users, with id, names, email addresses, admin and status, and next_page_token for the following page. Their id is the owner_id, user_id and assigned_to_user_id the other tools take.
Toolkits in the same category
See all 100 toolkitsSee Connect applied to your product.
Try it for 15 days with no card, or walk our team through your use case.
