Skip to content
FacilydevelopersDashboard
Build with Facily
DocsREST APIsLog Lead Contact
Search the full API reference Esc to close

Log Lead Contact

Leads · REST API reference

Get support
POST/v1/leads/{lead_id}/contacts
Record that staff contacted the prospect.

Authentication

Bearer API key or Facily session, subject to permissions and facility scope.

Authentication and scope

Request example

Replace bracketed path values with real IDs from your environment. The body, where shown, is generated from the schema and uses illustrative values.

cURL
curl --request POST \
  --url 'https://api.staging.facily.ai/v1/leads/<LEAD_ID>/contacts' \
  --header "Authorization: Bearer $FACILY_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "channel": "call",
  "outcome": "reached",
  "note": "string"
}'
An example for building your request, not an executed call. Check required fields, allowed values, and environment configuration before sending.

Parameters

lead_idpath · stringrequired

Format: uuid

Request body

application/json · Required

channelstringrequired

How the prospect was contacted.

Values: "call", "email", "text", "in_person"

notestring | null

Free-text note on the contact.

Max length: 1000

Show note schema
string | null

Free-text note on the contact.

Variant 1: string
string
Variant 2: null
null
outcomestringrequired

What came of the contact.

Values: "reached", "left_message", "no_answer", "wrong_number"

Responses

Expand a status to inspect its schema. Generated examples show structure and synthetic values.

201Successful Response
JSON · generated example
{
  "data": {
    "details": {},
    "event_type": "string",
    "id": "00000000-0000-4000-8000-000000000001",
    "lead_id": "00000000-0000-4000-8000-000000000001",
    "occurred_at": "2026-10-29T12:00:00Z",
    "created_by": "00000000-0000-4000-8000-000000000001",
    "from_status": "string",
    "to_status": "string"
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

dataLeadEventResponserequired
Show data schema
created_bystring | null

The staff member who did it.

Format: uuid

Show created_by schema
string | null

The staff member who did it.

Variant 1: string
string
Variant 2: null
null
detailsobjectrequired

Facts about the change, such as the fields edited.

event_typestringrequired

What happened, for example created, updated, closed or contact_logged.

from_statusstring | null

The status before, for a status change.

Show from_status schema
string | null

The status before, for a status change.

Variant 1: string
string
Variant 2: null
null
idstringrequired

Unique identifier for this history entry.

Format: uuid

lead_idstringrequired

The lead the entry belongs to.

Format: uuid

occurred_atstringrequired

When it happened.

Format: date-time

to_statusstring | null

The status after, for a status change.

Show to_status schema
string | null

The status after, for a status change.

Variant 1: string
string
Variant 2: null
null
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
400Validation error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
401Unauthenticated
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
403Permission denied
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
404Not found
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
409Business logic error
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
503Temporary failure
JSON · generated example
{
  "error": {
    "code": "string",
    "message": "string",
    "details": {}
  },
  "meta": {
    "request_id": "string"
  }
}

application/json

errorErrorBodyrequired

The shape of error.* in an error response.

Show error schema
codestringrequired
detailsobject | null
Show details schema
object | null
Variant 1: object
object
Variant 2: null
null
messagestringrequired
metaMetarequired

Envelope metadata. Every response carries one.

Show meta schema
request_idstringrequired
Continue exploringAll leads operations
Build something that works beautifully.

Facily API · Contract v1.200 · Reviewed October 29, 2026

Log Lead Contact | Facily Developers