API reference
Subjects
/subjects
A subject is what events are about. Contacts are linked to subjects through /links. In the Standard lens a subject is, for example, “Subject 001” with reference SUB-2026-001.
GET/subjectsList · ?q ?external_refPOST/subjectsCreateGET/subjects/{subject_id}ReadPATCH/subjects/{subject_id}Update · attributes replaced wholePOST/subjects/{subject_id}/deactivateDeactivate · no deleteshown →
POSTDeactivate a subject
Requires subjects:write. There is no delete. An inactive subject keeps its history and drops out of every group and every rule. It is reversible.
Path parameters
subject_iduuid · required
The subject id.
Body parameters
reasonstring · optional · max 500
Kept on the record.
Returns
200 with the subject, status: inactive.
Response body
One subject: the same fields in every pack. Press Response on the sample to see one whole.
FieldTypeDescription
iduuid
tenant_iduuidThe instance.
external_refstring | nullYour own id, as you sent it.
display_namestring
attributesobjectShaped by the instance's pack's subject_schema.Varies by pack
statusactive | inactive
created_atdatetime
updated_atdatetime
On failure the body is { error, code } instead.