Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.keenpartner.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Action-based design

The Keen API is not a traditional REST API with separate URLs per resource. Instead, every request is a POST to a single URL. The action field in the JSON body determines the operation.

​
Authentication

The lead_external action is the only exception — it does not require an API key. Instead, it relies on a channel-level setting that enables public lead submission.

​
Request format

Every request must be POST with a Content-Type: application/json header. The body must include an action field and any additional fields required by that action. 
curl -X POST https://data.keenpartner.com/functions/v1/keen-api \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -d '{"action": "get_channels"}'

​
Available actions

ActionPurpose
get_channelsList channels accessible to your company
get_leadsList leads for a channel
get_lead_by_legacy_idLook up a single lead by its legacy integer ID
create_leadCreate a new lead in a channel
update_statusUpdate a lead’s status by name
update_status_idUpdate a lead’s status by ID
create_purchaseRecord a purchase against a lead and optionally control which reward triggers fire
lead_externalCreate a lead without authentication

​
Channel access

Your API key is scoped to a single company. You can only interact with channels where your company is the creator, partner, referring company, or receiving company. If you attempt to access a channel your company is not part of, the API returns a 403 error.

​
Error responses

All errors return JSON with an error field: 
{
  "error": "Channel not accessible"
}
Status codeMeaning
400Bad request — missing or invalid fields
401Invalid API key
403Your company does not have access to the requested resource
404Resource not found (e.g. status name does not exist on the channel)
500Internal server error