Skip to main content
PATCH
Update an interaction
This endpoint uses the PATCH verb but behaves like a PUT (full replacement). Any fields that are NOT included in the payload will be cleared/removed, including tags. Always send the full interaction object if you don’t want to lose existing data.

Authorizations

Authorization
string
header
required

OAuth2 access token. Pass the token in the Authorization header as Bearer <token>. The token is looked up in Redis to resolve the caller identity.

Path Parameters

contactId
integer<int64>
required

Contact ID.

Required range: x >= 0
Example:

42

interactionId
integer<int64>
required

Interaction ID.

Required range: x >= 0
Example:

501

Body

application/json
address
string

Physical address related to the interaction, if applicable (e.g., meeting location).

comments
string
date_end
string<date-time>
date_of_event
string<date-time>

When the interaction actually took place, if different from when it was logged.

only_super_admin
boolean

If true, only users with the private-interactions permission can see this interaction.

sub_type
enum<string>
Available options:
incoming,
outgoing
tags
object[] | null

Tags to attach to the interaction. Provide an existing tag's id to reuse it, or omit id (with a name) to create a new tag. This list fully replaces the interaction's tags on update.

title
string
type
enum<string>
Available options:
email,
letter,
call,
meeting,
sms,
donation

Response

OK

address
string

Physical address related to the interaction, if applicable. (e.g., meeting location)

comments
string
contact_id
integer<int64>

ID of the contact associated with this interaction.

Required range: x >= 0
created_at
string<date-time>
date_end
string<date-time>
date_of_event
string<date-time> | null
files
object[] | null

List of files attached to the interaction.

group_id
integer<int64>
Required range: x >= 0
id
integer<int64>
Required range: x >= 0
only_super_admin
boolean

If true, only user with specific permissions can see this interaction.

sub_type
enum<string>
Available options:
incoming,
outgoing
tags
object[] | null

Tags attached to the interaction.

title
string
type
enum<string>
Available options:
email,
letter,
call,
meeting,
sms,
donation
updated_at
string<date-time>
user
object

User who logged the interaction.

user_id
integer<int64>

ID of the user who logged the interaction.

Required range: x >= 0
Last modified on August 5, 2026