TRANXACT.AI Help

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.

Type REST6 operationsBase path /api/crm/lead-contactsPublished as /api/v1/lead-contacts

Download specification (OpenAPI 3.1) Screen: Lead Contacts

Overview

PackageCRM
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe 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.
Tablecrm.lead_contacts · kept per company (and organisational unit where it has one)
RecordCreated, changed and (where the screen allows) deleted; key id
RulesThe 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

NameDescriptionExample
limitRows per page (50 by default, at most 200)limit=100
offsetRows to skipoffset=200
qFree-text search over the search columnsq=acme
sortcolumn:asc or column:desc, several separated by commassort=created_at:desc
filterA JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sortedfilter={"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

NameTypeDescription
idstring (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.

FieldTypeRequiredDescription
lead_iduuidNoLead — Or give the lead name below, as an import does.
lead_nametextNoLead name
first_nametextNoFirst name
last_nametextNoLast name
emailtextNoEmail
mobiletextNoMobile number
office_phonetextNoOffice number
extensiontextNoExtension
job_titletextNoJob title
countrytextNoCountry
statetextNoState / province — Chosen from the country’s own list where there is one, typed where there is not.
citytextNoCity
areatextNoArea
postal_codetextNoPostal / ZIP code
address_line1textNoAddress line 1
address_line2textNoAddress line 2
linkedin_urltextNoLinkedIn profile
business_cardtextNoBusiness card
statustextNoContact status
owner_nametextNoOwner
ownership_typetextNoOwnership type
Allowed: Public Private Subsidiary Government Partnership Non-profit Other
lead_grouptextNoLead group
abouttextNoAbout the contact
notestextNoNotes
is_activebooleanNoActive

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

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

Only the fields to change; fields left out keep their value.

FieldTypeRequiredDescription
lead_iduuidNoLead — Or give the lead name below, as an import does.
lead_nametextNoLead name
first_nametextNoFirst name
last_nametextNoLast name
emailtextNoEmail
mobiletextNoMobile number
office_phonetextNoOffice number
extensiontextNoExtension
job_titletextNoJob title
countrytextNoCountry
statetextNoState / province — Chosen from the country’s own list where there is one, typed where there is not.
citytextNoCity
areatextNoArea
postal_codetextNoPostal / ZIP code
address_line1textNoAddress line 1
address_line2textNoAddress line 2
linkedin_urltextNoLinkedIn profile
business_cardtextNoBusiness card
statustextNoContact status
owner_nametextNoOwner
ownership_typetextNoOwnership type
Allowed: Public Private Subsidiary Government Partnership Non-profit Other
lead_grouptextNoLead group
abouttextNoAbout the contact
notestextNoNotes
is_activebooleanNoActive

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

NameTypeDescription
idstring (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

NameTypeDescription
idstring (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, withLines

Response

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.

FieldTypeAccessDescription
iduuidread onlyId
org_iduuidread onlyOrg id
org_unit_iduuidread onlyOrg unit id
lead_iduuidread, writeLead — Or give the lead name below, as an import does.
lead_nametextread, writeLead name
first_nametextread, writeFirst name
last_nametextread, writeLast name
emailtextread, writeEmail
mobiletextread, writeMobile number
office_phonetextread, writeOffice number
extensiontextread, writeExtension
job_titletextread, writeJob title
countrytextread, writeCountry
statetextread, writeState / province — Chosen from the country’s own list where there is one, typed where there is not.
citytextread, writeCity
areatextread, writeArea
postal_codetextread, writePostal / ZIP code
address_line1textread, writeAddress line 1
address_line2textread, writeAddress line 2
linkedin_urltextread, writeLinkedIn profile
business_cardtextread, writeBusiness card
statustextread, writeContact status
owner_nametextread, writeOwner
ownership_typetextread, writeOwnership type
Allowed: Public Private Subsidiary Government Partnership Non-profit Other
lead_grouptextread, writeLead group
abouttextread, writeAbout the contact
notestextread, writeNotes
is_activebooleanread, writeActive
created_attimestamp with time zoneread onlyCreated at
xf_text_1textread onlyXf text 1
xf_text_2textread onlyXf text 2
xf_text_3textread onlyXf text 3
xf_text_4textread onlyXf text 4
xf_text_5textread onlyXf text 5
xf_num_1numericread onlyXf num 1
xf_num_2numericread onlyXf num 2
xf_num_3numericread onlyXf num 3
xf_date_1dateread onlyXf date 1
xf_date_2dateread onlyXf date 2
created_byuuidread onlyCreated by
updated_attimestamp with time zoneread onlyUpdated at
updated_byuuidread onlyUpdated by

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold CRM › Lead Contacts for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.