Get started

Quickstart

Create a sandbox key, send your first lead and read its status. Nothing you do here reaches a real sales team.

1

Create a project and a sandbox key

Open the Console, create a project and add a secret key for the sandbox. New keys get two scopes by default: leads:write to send leads and leads.status:read to read their status.

The key is shown once

Copy it into your secret store right away. Place keeps only a hash and the last four characters, so a lost key cannot be recovered. Create a new one and revoke the old one instead.
export PLACE_SECRET_KEY="sk_place_test_…"
2

Send a lead

A lead needs an external_id, which is your own id for it, and at least one way to reach the person: phone or email. Everything else is optional.

curl -X POST "https://6a6fb10b3ae9e8ded7cd73ef.base44.app/functions/placeApi" \
  -H "Authorization: Bearer $PLACE_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 5f1c9e2a-lead_82716" \
  -d '{
    "route": "POST /v1/leads",
    "body": {
      "external_id": "lead_82716",
      "first_name": "Max",
      "last_name": "Mustermann",
      "phone": "+4917612345678",
      "postal_code": "40789",
      "product": "solar"
    }
  }'
3

Read the response

Place answers with 201 Created and the lead. Store the id. It starts with pl_lead_ and never changes.

{
  "id": "pl_lead_8a1f3c",
  "object": "lead",
  "external_id": "lead_82716",
  "status": "received",
  "environment": "sandbox",
  "created_at": "2026-09-11T09:41:00.000Z"
}
4

Send the same lead again

Run the request a second time. You get the same lead back with 200 OK and a replay header, and no second lead is created. This is what makes retries after a timeout safe.

HTTP/1.1 200 OK
Place-Idempotent-Replay: true
Place-Request-Id: req_4mT0q9…
5

Check the status

Read the lead by its id. In the sandbox the status stays received. In production it follows the lead through assignment to won or lost.

curl -X POST "https://6a6fb10b3ae9e8ded7cd73ef.base44.app/functions/placeApi" \
  -H "Authorization: Bearer $PLACE_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "route": "GET /v1/leads/pl_lead_8a1f3c" }'
6

Find the request in the Console

Every call appears in the project's request log with method, route, status and latency. Search for the Place-Request-Id from the response header when something looks wrong. Phone numbers and email addresses are masked in the log.

7

Go to production

When your integration works in the sandbox, ask for production to be enabled for the project. Then create a sk_place_live_… key and swap it in. Nothing else changes.

Before you do, read Leads for the validation rules and Webhooks for status events.