Skip to main content
POST
/
v1
/
interactions
Create an interaction
curl --request POST \
  --url https://api.folk.app/v1/interactions \
  --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.",
  "type": "☕️"
}'
{
  "data": {
    "id": "lit_b049db09-c03d-4f32-96d6-d314760add5d",
    "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",
    "type": "coffee"
  }
}

Authorizations

​
Authorization
string
header
required

API key for authentication

Body

application/json
​
entity
object
required

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

Example:
{
  "id": "per_55175e81-9a52-4ac3-930e-82792c23499b"
}
​
dateTime
string<date-time>
required

The date and time of the interaction.

Maximum length: 24
Example:

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

​
title
string
required

The title of the interaction.

Maximum length: 255
Example:

"Coffee with John Doe"

​
content
string
required

The multi-line content of the interaction.

Maximum length: 100000
Example:

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

​
type
required

An emoji representing the interaction type.

Maximum length: 50
Example:

"☕️"

Response

The created interaction.

​
data
object
required

An interaction linked to an entity.

Example:
{
  "id": "lit_b049db09-c03d-4f32-96d6-d314760add5d",
  "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",
  "type": "coffee"
}
​
deprecations
string[]
Example:
["This field is deprecated"]