Skip to content

users_touches_update

Correct a touch you logged — its text, when it happened, or both.

Tool

users_touches_update

Correct a touch you logged — its text, when it happened, or both.

Correct a touch you logged — its text, when it happened, or both. A touch somebody ELSE logged answers 404, exactly as a touch that does not exist does: the refusal must not tell you the row is there. Pass `force: true` to edit it anyway, which is recorded in the audit trail along with the original author.

Behavior

HTTP
PATCH /users/users/:userId/touches/:touchId

Arguments

Name
Type
Required
Description
body
string
—
Replacement text, 1-8192 characters. Omit to leave it unchanged.
force
boolean
—
Act on a touch somebody else logged. Without it a touch you did not author answers 404, exactly as a touch that does not exist does — the refusal must not tell you the row is there. Every forced call is recorded in the audit trail.
userId
string
•
The end user the touch belongs to.
touchId
string
•
The touch to edit, from users_touches_list.
occurredAt
string
—
Correct when it happened (ISO 8601). Omit to leave it unchanged.

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

Correct a touch you logged — its text, when it happened, or both.

When to use

Correct a touch you logged — its text, when it happened, or both. A touch somebody ELSE logged answers 404, exactly as a touch that does not exist does: the refusal must not tell you the row is there. Pass `force: true` to edit it anyway, which is recorded in the audit trail along with the original author.

Example

Ask your agent something like this:

Correct a touch you logged — its text, when it happened, or both.

The agent will invoke users_touches_update with these arguments:

{
  "userId": "<userId>",
  "touchId": "<touchId>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select