CRM · Sales
Lead Contacts
The people at each lead: names, email, mobile and office numbers, titles and addresses. Import a contacts sheet after its leads sheet; each row is attached to its lead by the Lead Name it carries.
/api/crm/lead-contactsPublished as /api/v1/lead-contactsOverview
| Package | CRM |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold CRM › Lead Contacts on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | crm.lead_contacts · kept per company (and organisational unit where it has one) |
| Record | Created, changed and (where the screen allows) deleted; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/crm/lead-contactsList lead contacts
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lead_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lead_name": "Example",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"mobile": "+1 555 0100",
"office_phone": "+1 555 0100",
"extension": "text",
"job_title": "Example",
"country": "US",
"state": "text",
"city": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/crm/lead-contacts?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/crm/lead-contacts/{id}Read one lead contacts
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lead_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lead_name": "Example",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"mobile": "+1 555 0100",
"office_phone": "+1 555 0100",
"extension": "text",
"job_title": "Example",
"country": "US",
"state": "text",
"city": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/crm/lead-contacts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/lead-contactsCreate a lead contacts
Request body
The record as JSON. Fields marked Yes are required.
| Field | Type | Required | Description |
|---|---|---|---|
lead_id | uuid | No | Lead — Or give the lead name below, as an import does. |
lead_name | text | No | Lead name |
first_name | text | No | First name |
last_name | text | No | Last name |
email | text | No | |
mobile | text | No | Mobile number |
office_phone | text | No | Office number |
extension | text | No | Extension |
job_title | text | No | Job title |
country | text | No | Country |
state | text | No | State / province — Chosen from the country’s own list where there is one, typed where there is not. |
city | text | No | City |
area | text | No | Area |
postal_code | text | No | Postal / ZIP code |
address_line1 | text | No | Address line 1 |
address_line2 | text | No | Address line 2 |
linkedin_url | text | No | LinkedIn profile |
business_card | text | No | Business card |
status | text | No | Contact status |
owner_name | text | No | Owner |
ownership_type | text | No | Ownership type Allowed: Public Private Subsidiary Government Partnership Non-profit Other |
lead_group | text | No | Lead group |
about | text | No | About the contact |
notes | text | No | Notes |
is_active | boolean | No | Active |
Sample body
{
"lead_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lead_name": "Example",
"first_name": "Example",
"last_name": "Example"
}Response 201
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lead_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lead_name": "Example",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"mobile": "+1 555 0100",
"office_phone": "+1 555 0100",
"extension": "text",
"job_title": "Example",
"country": "US",
"state": "text",
"city": "text"
}Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/lead-contacts" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"lead_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","lead_name":"Example","first_name":"Example","last_name":"Example"}'PUT/api/crm/lead-contacts/{id}Change a lead contacts
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
Only the fields to change; fields left out keep their value.
| Field | Type | Required | Description |
|---|---|---|---|
lead_id | uuid | No | Lead — Or give the lead name below, as an import does. |
lead_name | text | No | Lead name |
first_name | text | No | First name |
last_name | text | No | Last name |
email | text | No | |
mobile | text | No | Mobile number |
office_phone | text | No | Office number |
extension | text | No | Extension |
job_title | text | No | Job title |
country | text | No | Country |
state | text | No | State / province — Chosen from the country’s own list where there is one, typed where there is not. |
city | text | No | City |
area | text | No | Area |
postal_code | text | No | Postal / ZIP code |
address_line1 | text | No | Address line 1 |
address_line2 | text | No | Address line 2 |
linkedin_url | text | No | LinkedIn profile |
business_card | text | No | Business card |
status | text | No | Contact status |
owner_name | text | No | Owner |
ownership_type | text | No | Ownership type Allowed: Public Private Subsidiary Government Partnership Non-profit Other |
lead_group | text | No | Lead group |
about | text | No | About the contact |
notes | text | No | Notes |
is_active | boolean | No | Active |
Sample body
{
"lead_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lead_name": "Example"
}Response 200
{
"id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lead_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"lead_name": "Example",
"first_name": "Example",
"last_name": "Example",
"email": "someone@example.com",
"mobile": "+1 555 0100",
"office_phone": "+1 555 0100",
"extension": "text",
"job_title": "Example",
"country": "US",
"state": "text",
"city": "text"
}Sample request
curl -X PUT "https://demo.tranxact.ai/api/crm/lead-contacts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"lead_id":"3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73","lead_name":"Example"}'DELETE/api/crm/lead-contacts/{id}Delete a lead contacts
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{ "deleted": true }Many documents are cancelled or reversed instead; the API refuses a delete the screen would refuse.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/crm/lead-contacts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/crm/lead-contacts/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/crm/lead-contacts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'Data model
Every field of a lead contacts, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | uuid | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
lead_id | uuid | read, write | Lead — Or give the lead name below, as an import does. |
lead_name | text | read, write | Lead name |
first_name | text | read, write | First name |
last_name | text | read, write | Last name |
email | text | read, write | |
mobile | text | read, write | Mobile number |
office_phone | text | read, write | Office number |
extension | text | read, write | Extension |
job_title | text | read, write | Job title |
country | text | read, write | Country |
state | text | read, write | State / province — Chosen from the country’s own list where there is one, typed where there is not. |
city | text | read, write | City |
area | text | read, write | Area |
postal_code | text | read, write | Postal / ZIP code |
address_line1 | text | read, write | Address line 1 |
address_line2 | text | read, write | Address line 2 |
linkedin_url | text | read, write | LinkedIn profile |
business_card | text | read, write | Business card |
status | text | read, write | Contact status |
owner_name | text | read, write | Owner |
ownership_type | text | read, write | Ownership type Allowed: Public Private Subsidiary Government Partnership Non-profit Other |
lead_group | text | read, write | Lead group |
about | text | read, write | About the contact |
notes | text | read, write | Notes |
is_active | boolean | read, write | Active |
created_at | timestamp with time zone | read only | Created at |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold CRM › Lead Contacts for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.