---
title: "Create an interaction"
method: POST
path: "/v1/interactions"
tags: ["Interactions"]
---

# Create an interaction

`POST /v1/interactions`

Creates a new [interaction](https://help.folk.app/en/articles/7012167-log-a-new-interaction) with a person or a company.

## 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, 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.
  - `type` union — Deprecated. Use `activityType` instead.
    - string, emoji — An emoji representing the interaction type.
    - 'call' | 'meeting' | 'message' | 'coffee' | 'lunch' | 'event' | 'drink' — A predefined interaction type.
    - 'whatsapp' | 'twitter' | 'linkedin' | 'hangout' | 'skype' | 'slack' | 'iMessage' | 'fbMessenger' | 'signal' | 'discord' | 'wechat' | 'telegram' | 'viber' — A messaging app used for the interaction.
  - `activityType` union — The logged activity type. Can be a predefined activity, a messaging app, or an emoji.
    - string, emoji — An emoji representing the interaction type.
    - 'call' | 'meeting' | 'message' | 'coffee' | 'lunch' | 'event' | 'drink' — A predefined interaction type.
    - 'whatsapp' | 'twitter' | 'linkedin' | 'hangout' | 'skype' | 'slack' | 'iMessage' | 'fbMessenger' | 'signal' | 'discord' | 'wechat' | 'telegram' | 'viber' — A messaging app used for the interaction.

## Response `200`

The created 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 user.
      - 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.
    - `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 full name of the linked entity.
    - `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.
      - 'call' | 'meeting' | 'message' | 'coffee' | 'lunch' | 'event' | 'drink' — A predefined interaction type.
      - 'whatsapp' | 'twitter' | 'linkedin' | 'hangout' | 'skype' | 'slack' | 'iMessage' | 'fbMessenger' | 'signal' | 'discord' | 'wechat' | 'telegram' | 'viber' — A messaging app used for the interaction.
      - 'campaignMessage' — A campaign message sent via folk.
    - `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.
      - 'call' | 'meeting' | 'message' | 'coffee' | 'lunch' | 'event' | 'drink' — A predefined interaction type.
      - 'whatsapp' | 'twitter' | 'linkedin' | 'hangout' | 'skype' | 'slack' | 'iMessage' | 'fbMessenger' | 'signal' | 'discord' | 'wechat' | 'telegram' | 'viber' — A messaging app used for the interaction.
      - 'campaignMessage' — A campaign message sent via folk.
  - `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.
- `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.

---

[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-service-production.skmtc.workers.dev/v1/apis/folk/folk-external-api/revisions/8ecbf0ccd00a/schema)