users_touches_create
Log an interaction with a person — a message, a call, a meeting, a note, or an email sent OUTSIDE the platform.
Log an interaction with a person — a message, a call, a meeting, a note, or an email sent OUTSIDE the platform. Email this toolkit sent is NOT logged here; read those from the mail toolkit. `occurredAt` is when it HAPPENED and may be backdated; omit it to mean now. A 'note' or a 'meeting' takes direction 'none'. Who logged it is taken from your identity and can never be set from the body.
Behavior
- HTTP
POST /users/users/:userId/touches
Arguments
Name | Type | Required | Description |
|---|---|---|---|
body | string | • | What was said or done, free text, 1-8192 characters. Personal data: it is whatever an operator typed about this person. |
userId | string | • | The end user this interaction was with. |
channel | string | • | How the person was touched: 'message', 'call', 'meeting', 'note' (an internal observation nobody sent) or 'email' sent OUTSIDE the platform. Email this toolkit sent is not logged here — read those from the mail toolkit. |
direction | string | • | Which way it went: 'outbound' (you reached them), 'inbound' (they reached you) or 'none'. A 'note' or a 'meeting' must be 'none'. |
occurredAt | string | — | When it happened (ISO 8601). Omit to mean now — pass it when logging after the fact, which may be any time in the past. |
Response
Field | Type | Always | Description |
|---|---|---|---|
id | string | • | Id of this touch. Pass it to users_touches_update or _delete. |
body | string | • | What was said or done, free text, 1-8192 characters. Personal data: it is whatever an operator typed about this person. |
userId | string | • | The end user this interaction was with. |
actorId | string | • | Id of the operator or agent that logged it, verbatim. |
channel | string | • | How the person was touched: 'message', 'call', 'meeting', 'note' (an internal observation nobody sent) or 'email' sent OUTSIDE the platform. Email this toolkit sent is not logged here — read those from the mail toolkit. |
actorType | string | • | Who logged it: 'operator' (a human) or 'agent' (a workflow or agent principal). |
createdAt | string | • | When the touch was logged (ISO 8601). |
direction | string | • | Which way it went: 'outbound' (you reached them), 'inbound' (they reached you) or 'none'. A 'note' or a 'meeting' must be 'none'. |
productId | string | • | Product this touch belongs to. Never an input — it comes from the calling identity. |
updatedAt | string | • | When the touch was last edited (ISO 8601). |
occurredAt | string | • | When the interaction happened (ISO 8601) — not when it was logged. |
Try it
Log an interaction with a person — a message, a call, a meeting, a note, or an email sent OUTSIDE the platform.