/v1/leads/{lead_id}/contactsAuthentication
Bearer API key or Facily session, subject to permissions and facility scope.
Authentication and scopeRequest 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 --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"
}'Parameters
lead_idpath · stringrequiredFormat: uuid
Request body
application/json · Required
channelstringrequiredHow the prospect was contacted.
Values: "call", "email", "text", "in_person"
notestring | nullFree-text note on the contact.
Max length: 1000
Show note schema
string | nullFree-text note on the contact.
Variant 1: string
stringVariant 2: null
nulloutcomestringrequiredWhat 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
{
"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
dataLeadEventResponserequiredShow data schema
created_bystring | nullThe staff member who did it.
Format: uuid
Show created_by schema
string | nullThe staff member who did it.
Variant 1: string
stringVariant 2: null
nulldetailsobjectrequiredFacts about the change, such as the fields edited.
event_typestringrequiredWhat happened, for example created, updated, closed or contact_logged.
from_statusstring | nullThe status before, for a status change.
Show from_status schema
string | nullThe status before, for a status change.
Variant 1: string
stringVariant 2: null
nullidstringrequiredUnique identifier for this history entry.
Format: uuid
lead_idstringrequiredThe lead the entry belongs to.
Format: uuid
occurred_atstringrequiredWhen it happened.
Format: date-time
to_statusstring | nullThe status after, for a status change.
Show to_status schema
string | nullThe status after, for a status change.
Variant 1: string
stringVariant 2: null
nullmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired400Validation error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired401Unauthenticated
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired403Permission denied
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired404Not found
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired409Business logic error
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired503Temporary failure
{
"error": {
"code": "string",
"message": "string",
"details": {}
},
"meta": {
"request_id": "string"
}
}application/json
errorErrorBodyrequiredThe shape of error.* in an error response.
Show error schema
codestringrequireddetailsobject | nullShow details schema
object | nullVariant 1: object
objectVariant 2: null
nullmessagestringrequiredmetaMetarequiredEnvelope metadata. Every response carries one.
Show meta schema
request_idstringrequired