(Beta) Update an interaction

Partially update an existing logged interaction (title, content, date-time, activityType). Imported interactions cannot be updated.

This endpoint is currently in open beta. The API surface may change as we iterate based on feedback.

PATCH /v1/interactions/{interactionId}

Update an interaction

cURL

curl --request PATCH \
  --url https://api.folk.app/v1/interactions/{interactionId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity": {
    "id": "per_55175e81-9a52-4ac3-930e-82792c23499b"
  },
  "dateTime": "2025-07-17T09:00:00.000Z",
  "title": "Coffee with John Doe",
  "content": "Had a coffee with John Doe\nDiscussed the new project.",
  "activityType": "☕️"
}
'

200

{
  "data": {
    "id": "lit_b049db09-c03d-4f32-96d6-d314760add5d",
    "interactionType": "logged",
    "from": {
      "type": "user",
      "value": "usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
      "name": "John Doe"
    },
    "to": {
      "type": "person",
      "value": "per_55175e81-9a52-4ac3-930e-82792c23499b",
      "name": "John Doe"
    },
    "title": "Coffee with John Doe",
    "content": "Had a coffee with John Doe\nDiscussed the new project.",
    "entity": {
      "id": "per_55175e81-9a52-4ac3-930e-82792c23499b",
      "entityType": "person",
      "fullName": "John Doe"
    },
    "dateTime": "2025-07-17T09:00:00.000Z",
    "privacyLevel": "sharedFull",
    "type": "coffee",
    "activityType": "coffee"
  }
}

Authorizations

Authorization · string · header · required

API key for authentication

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.

Maximum string length: 255

Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Path Parameters

interactionId · string · required

The ID of the interaction to update.

Required string length: 40

Body

application/json

entity · object · required

The entity connected to the interaction. You can link people or companies.

Show child attributes

Example:

{
  "id": "per_55175e81-9a52-4ac3-930e-82792c23499b"
}

dateTime · string<date-time>

The date and time of the interaction.

Maximum string length: 24

Example:

"2025-07-17T09:00:00.000Z"

title · string

The title of the interaction.

Maximum string length: 255

Example:

"Coffee with John Doe"

content · string

The multi-line content of the interaction.

Maximum string length: 100000

Example:

"Had a coffee with John Doe\nDiscussed the new project."

activityType · Option 1 · string<emoji> Option 2 · enum<string> Option 3 · enum<string>

An emoji representing the interaction type.

Maximum string length: 50

Example:

"☕️"

Response

200

application/json

The updated interaction.

data · object · required

A manually logged interaction linked to an entity.

Show child attributes

Example:

{
  "id": "lit_b049db09-c03d-4f32-96d6-d314760add5d",
  "interactionType": "logged",
  "from": {
    "type": "user",
    "value": "usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
    "name": "John Doe"
  },
  "to": {
    "type": "person",
    "value": "per_55175e81-9a52-4ac3-930e-82792c23499b",
    "name": "John Doe"
  },
  "title": "Coffee with John Doe",
  "content": "Had a coffee with John Doe\nDiscussed the new project.",
  "entity": {
    "id": "per_55175e81-9a52-4ac3-930e-82792c23499b",
    "entityType": "person",
    "fullName": "John Doe"
  },
  "dateTime": "2025-07-17T09:00:00.000Z",
  "privacyLevel": "sharedFull",
  "type": "coffee",
  "activityType": "coffee"
}

deprecations · string[]

Example:

["This field is deprecated"]