CRM · Services and actions
Contact finder
The contact finder service of CRM: 3 operation(s).
Type REST3 operationsBase path
/api/crm/contact-finderOverview
| 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 › Contact finder 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. |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
3 operations. Open one for its parameters, bodies, responses and a sample request.
POST/api/crm/contact-finder/lookupLookup
Request body
The keys this action reads (* = required; "one of" lists the only values):
entity, id, freshResponse
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/contact-finder/lookup" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"entity":"value","id":"value","fresh":"value"}'POST/api/crm/contact-finder/acceptAccept
Request body
The keys this action reads (* = required; "one of" lists the only values):
entity, id, values, lawfulBasis, basisNoteResponse
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/contact-finder/accept" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"entity":"value","id":"value","values":"value","lawfulBasis":"value","basisNote":"value"}'GET/api/crm/contact-finder/usageUsage
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/crm/contact-finder/usage" \
-H "Authorization: Bearer $TOKEN"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 › Contact finder 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.