inDeal API: create and update leads via the interface

With the inDeal API you create leads from other systems, read them, keep them in sync and write activities such as notes or calls to the timeline. Everything you need lives under Settings -> API & Webhooks.

Contents

• Create a key
• Basics
• Create a lead
• Read a lead
• Update a lead
• List leads
• Activities
• Fields
• Duplicate leads
• Error codes
• Next

Create a key

1. Open Settings -> API & Webhooks.
2. Click Create new key and pick a name that describes the connected system.
3. Copy the key right away. Copy the key now. It is shown only once and cannot be retrieved again later.

Afterwards the list only shows the last four characters. If you need the key again, revoke the old one with Revoke and create a new one. Up to 10 active keys are possible, so you can give each system its own and revoke them individually.

Basics

Above the limit the API responds with status 429 and the header Retry-After: 60 - wait a minute in that case.

Create a lead

POST /leads creates a lead. At least one of email or linkedin_url (the contact's profile URL) is required.

curl -X POST https://app.indeal.ai/api/v1/leads \
  -H "Authorization: Bearer indeal_..." \
  -H "Content-Type: application/json" \
  -d '{
    "full_name": "Julia Weber",
    "email": "julia.weber@muster.de",
    "company_name": "Muster GmbH",
    "role_title": "Managing Director"
  }'

Response on success (status 201):

{
  "status": "created",
  "lead": {
    "id": "0b0e...",
    "stage": "qualifying",
    "full_name": "Julia Weber",
    "email": "julia.weber@muster.de",
    "company_name": "Muster GmbH"
  }
}

If the lead already exists you get status 200 with "status": "duplicate" and the existing lead - see Duplicate leads.

Read a lead

GET /leads/{id} returns a single lead.

curl https://app.indeal.ai/api/v1/leads/0b0e... \
  -H "Authorization: Bearer indeal_..."

Response (status 200): { "lead": { ... } }. An unknown id returns status 404.

Update a lead

PATCH /leads/{id} changes only the fields you send. null clears a field. stage moves the lead to another phase - the history in inDeal is written automatically. custom_data is merged, not replaced: null as a value deletes a key, all other keys stay.

curl -X PATCH https://app.indeal.ai/api/v1/leads/0b0e... \
  -H "Authorization: Bearer indeal_..." \
  -H "Content-Type: application/json" \
  -d '{ "stage": "meeting_scheduled", "next_step": "Prepare demo" }'

Response (status 200): { "lead": { ... } }. If the change collides with an existing lead (email or profile URL already taken), you get status 409.

List leads

GET /leads returns leads page by page, sorted by last change.

curl "https://app.indeal.ai/api/v1/leads?updated_since=2026-09-01T00:00:00Z&limit=100" \
  -H "Authorization: Bearer indeal_..."

Response: { "leads": [...], "next_cursor": "..." }. When next_cursor is null you have reached the end. The cursor remembers the sort direction, so you do not have to repeat order while paging. For ongoing sync: query regularly with updated_since and page with cursor.

Find a lead by email or profile URL

You know the email address or the profile URL and need the id? Pass it as a parameter. inDeal then searches exactly as when creating: upper and lower case do not matter, and for the profile URL neither do https://, www or a trailing slash.

curl "https://app.indeal.ai/api/v1/leads?email=julia.weber@muster.de" \
  -H "Authorization: Bearer indeal_..."

If you pass both, you get every lead that matches at least one of them. The response is { "leads": [...] } without next_cursor, since there can never be more than two matches. If nothing matches, the list is empty. updated_since and cursor are ignored for this search. An invalid email address or URL returns status 400 with the field name.

Activities

Every lead has a timeline. Via the API you add entries to it and read them.

Create an activity

POST /leads/{id}/activities adds a timeline entry to the lead. Writable types are note, call, email and meeting_scheduled. At least one of title or body is required. If title is missing, inDeal builds it from the first 80 characters of body.

curl -X POST https://app.indeal.ai/api/v1/leads/0b0e.../activities \
  -H "Authorization: Bearer indeal_..." \
  -H "Content-Type: application/json" \
  -d '{ "type": "call", "body": "Short call, demo next week", "channel": "call" }'

Response on success (status 201):

{
  "activity": {
    "id": "9f3a...",
    "type": "call",
    "title": "Short call, demo next week",
    "body": "Short call, demo next week",
    "quote": null,
    "channel": "call",
    "occurred_at": "2026-09-03T14:00:00+00:00",
    "created_at": "2026-09-03T14:00:01+00:00",
    "pinned": false,
    "edited_at": null
  }
}

The entry appears in the lead's timeline right away, and calls as well as emails count as touchpoints. The types reply (a reply from a campaign) and stage_change (a stage change) are written by inDeal itself; sending them returns status 400. An unknown lead id returns status 404.

Read the timeline

GET /leads/{id}/activities returns all entries of the lead, newest first, including the read-only types reply and stage_change.

curl "https://app.indeal.ai/api/v1/leads/0b0e.../activities?type=reply&limit=50" \
  -H "Authorization: Bearer indeal_..."

Response: { "activities": [...], "next_cursor": "..." }. For replies from campaigns the text is in quote. edited_at shows that an entry was edited later. There is no update or delete via the API.

If you want to be notified about new entries right away instead of polling the timeline, subscribe to the webhook event activity.created - see inDeal Webhooks.

Fields

Required rule: at least one of email / linkedin_url when creating. Everything else is optional.

Every response also contains url, the link to the lead page in inDeal (read-only). Unknown fields are rejected - the error message names the field. Internal fields (such as enrichment status) are neither returned nor accepted.

Custom fields

You create custom fields in inDeal under Customizing the layout, separately for leads and deals. Their values are in the custom_data object, the key is the field's API name.

Listing the fields

curl "https://app.indeal.ai/api/v1/custom-fields?entity=lead" \
  -H "Authorization: Bearer indeal_..."

entity is required (lead or deal). The response contains all active fields in layout order, each with key (API name), label, type, options for dropdowns, currency_code for currency and the section. Hidden fields are not included.

Value format per type

null deletes a value, so does an empty text or an empty list. Each request allows at most 50 keys in custom_data.

Checks when writing

POST and PATCH on leads and deals check custom_data against the fields of that module:

• Unknown keys and keys of hidden fields are ignored and reported in warnings. That is not an error, the rest is saved.

{ "lead": { ... }, "warnings": [{ "key": "partner_id", "code": "unknown_key" }, { "key": "old", "code": "deleted_field" }] }

• Invalid values for known fields return status 422 with validation_error and details. Nothing is written then, not even other fields from the same request.

{
  "error": {
    "code": "validation_error",
    "message": "custom_data: invalid values.",
    "details": [
      { "key": "plan", "code": "invalid_option" },
      { "key": "budget", "code": "invalid_type" }
    ]
  }
}

Possible values for details.code: invalid_type, invalid_option, invalid_date, invalid_url, too_long, readonly_field. warnings is part of every write response, as an empty list if nothing was ignored.

Duplicate leads

When creating, inDeal first checks the profile URL, then the email address - both case-insensitively. If a matching lead already exists, NO new one is created: you get status 200 with "status": "duplicate" and the existing lead including its id.

This makes the endpoint safe to repeat: sending the same request twice never creates two leads. To change the existing lead, use the id from the response with PATCH /leads/{id}.

Error codes

All errors share the same shape: { "error": { "code": "...", "message": "..." } }. The message is always in English and meant for humans, check the code in your code.

{ "error": { "code": "not_found", "message": "Lead not found." } }

Next

• inDeal API: deals and reports
• inDeal Webhooks: send lead and deal changes to other systems