API ReferenceReference
Capture one person
POST
/personCreates or updates one canonical person through the API client's source, ownership, duplicate, and field-mapping rules.
Authorization
ApiKey ApiSecret X-API-Key<token>
The API client key shown in Sakhaa.
In: header
X-API-Secret<token>
The one-time API client secret. Keep it in a server-side secret store.
In: header
Header Parameters
Idempotency-Key*string
A stable key for one logical request. Reuse it only when retrying the same request.
Length
1 <= length <= 512Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/person" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{ "name": "API Test Person", "email": "api-test@example.invalid", "company": "Example Test Company", "notes": "Synthetic documentation verification record" }'{ "success": true, "statusCode": 0, "timestamp": "2019-08-24T14:15:22Z", "message": "string", "data": { "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550", "status": "string", "action": "string", "duplicate_detected": true, "idempotent_replay": true }}