---
title: "Update an interaction"
method: PATCH
path: "/v1/interactions/{interactionId}"
tags: ["Interactions"]
---

# Update an interaction

`PATCH /v1/interactions/{interactionId}`

## Request

- Base URL: `https://api.folk.app`
- URL: `https://api.folk.app/v1/interactions/{interactionId}`
- Auth: HTTP bearer

Partially update an existing logged interaction (title, content, date-time, activityType). Imported interactions cannot be updated.<br/><Warning>This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.</Warning>

## Path parameters

- `interactionId` string, required

## Headers

- `Idempotency-Key` string: A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.

## Request body

- object
  - `entity` object, required: The entity connected to the interaction. You can link people or companies.
    - `id` string, required
  - `dateTime` string, date-time: The date and time of the interaction.
  - `title` string: The title of the interaction.
  - `content` string: The multi-line content of the interaction.
  - `activityType` union
    - string, emoji: An emoji representing the interaction type.
    - 'call' | 'meeting' | 'message' | 'coffee' | 'lunch' | 'event' | 'drink': A predefined interaction type.
    - 'whatsapp' | 'twitter' | 'linkedin' | 'instagram' | 'hangout' | 'tiktok' | 'skype' | 'slack' | 'iMessage' | 'fbMessenger' | 'signal' | 'discord' | 'wechat' | 'telegram' | 'viber': A messaging app used for the interaction.

## Response `200`

The updated interaction.

- object
  - `data` LoggedInteraction, required: A manually logged interaction linked to an entity.
    - `id` string, required
    - `interactionType` 'logged', required: The interaction is a manually logged interaction.
    - `from` union, required: Who logged the interaction. Can be a workspace user or an email sender.
      - object
        - `type` 'user', required: The interaction was logged by a workspace member.
        - `value` string, required
        - `name` string: The display name of the participant. Falls back to the email address or phone number. Omitted only on a logged interaction whose member was deleted or whose person is gone or unnamed.
        - `picture` string: The picture URL of the matching workspace member or person, if any.
        - `userId` string: The workspace member this participant resolves to, if any.
      - object
        - `type` 'sender', required: The interaction was logged on behalf of an email sender, such as a campaign message.
        - `name` string, required: The display name of the sender.
        - `value` string, required: The email address of the sender.
        - `picture` string: The picture URL of the matching workspace member or person, if any.
        - `userId` string: The workspace member this participant resolves to, if any.
    - `to` object, required: The entity the interaction is linked to.
      - `type` union, required: The type of the entity the interaction is linked to.
        - 'person'
        - 'company'
      - `value` string, required: The ID of the person or company the interaction is linked to.
      - `name` string: The display name of the participant. Falls back to the email address or phone number. Omitted only on a logged interaction whose member was deleted or whose person is gone or unnamed.
      - `picture` string: The picture URL of the matching workspace member or person, if any.
      - `userId` string: The workspace member this participant resolves to, if any.
    - `entity` object, required: The entity connected to the interaction.
      - `entityType` 'person' | 'company', required: The type of the entity connected to the interaction. Can be `person` or `company`.
      - `id` string, required: The ID of the entity connected to the interaction.
      - `fullName` string, required: The full name of the entity connected to the interaction.
    - `dateTime` string, date-time, required: The date and time of the interaction.
    - `title` string, required: The title of the interaction.
    - `content` string, required: The multi-line content of the interaction.
    - `privacyLevel` 'sharedFull', required: Logged interactions always expose their content to authorized users.
    - `type` union, required: Deprecated. Use `activityType` instead.
      - string, emoji: An emoji representing the interaction type.
      - 'campaignMessage': A campaign message sent via folk.
      - string: A predefined interaction type. Known values may grow over time; clients should handle unknown values.
      - string: A messaging app used for the interaction. Known values may grow over time; clients should handle unknown values.
    - `activityType` union, required: The logged activity type. Can be a predefined activity, a messaging app, or an emoji.
      - string, emoji: An emoji representing the interaction type.
      - 'campaignMessage': A campaign message sent via folk.
      - string: A predefined interaction type. Known values may grow over time; clients should handle unknown values.
      - string: A messaging app used for the interaction. Known values may grow over time; clients should handle unknown values.
  - `deprecations` string[]

## Other responses

- `400`: The request was unacceptable, often due to missing an invalid parameter.
- `401`: No valid API key provided.
- `403`: The API key doesn’t have permissions to perform the request.
- `404`: The requested resource doesn’t exist.
- `409`: A request with the same `Idempotency-Key` is still being processed, or the resource is in a state that does not allow the operation.
- `422`: The request was unacceptable, often due to missing or invalid parameters.
- `429`: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.
- `500`: Something went wrong on our end.
- `503`: The server is overloaded or down for maintenance.

## Changes

- **2026-11-03** `c6818f3ba60d`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/folk/apis/folk-external-api/changes/v1/interactions/:interactionId/patch.md)

---

[API](https://skmtc.dev/folk/apis/folk-external-api.md) - [All operations](https://skmtc.dev/folk/apis/folk-external-api/llms.txt) - [OpenAPI document](https://skmtc.dev/folk/apis/folk-external-api/revisions/c6818f3ba60d?raw)