Create note with the Keap API

Adds a note to a contact and returns it. user_id is required, and so is title or type.

Identifier
keap_create_note

The request

POST https://connect.reportei.com/api/tools/keap_create_note/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "contact_id": "<contact_id>",
    "user_id": "<user_id>"
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
contact_idstringYesId of the contact, from List contacts.
user_idstringYesId of the user writing the note, the id field of List users (not global_user_id).
titlestringNoTitle of the note. Required when type is left out.
textstringNoContent of the note.
typestringNoKind of note, one of Appointment, Call, Email, Fax, Letter or Other in Keap Max and Pro, or a value configured by the admin in Keap Classic. Required when title is left out.
is_pinnedbooleanNoPins the note to the top of the contact.

Supported connections

Your customer connects their Keap account once, with one of the modes below. The same connection serves every tool of the toolkit.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/keap, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/keap_create_note. It becomes your agent's tool definition with no conversion.

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.