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 wholeshown →POST/subjects/{subject_id}/deactivateDeactivate · no delete
PATCHUpdate a subject
Requires subjects:write. Send only the fields you are changing — except attributes, which is replaced whole. To change one attribute, send them all.
Path parameters
subject_iduuid · required
The subject id.
Body parameters
display_namestring · optional
external_refstring · optional · max 200
Changed here, never emptied: blank leaves the one on file alone.
attributesobject · optionalVaries by pack
Checked against the instance's pack: its subject_schema. Choose a pack to see the keys. PATCH replaces the whole object; it does not merge.
The Standard lens has no pack behind it, so there are no keys to list.
Returns
200 with the updated subject. 400 if attributes contains an unknown key.
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.