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

# Create an interaction

`POST /interactions`

## Request

- Base URL: `https://api.klipy.ai/api/v1`
- URL: `https://api.klipy.ai/api/v1/interactions`
- Auth: one of:
  - API key in header `X-Klipy-Api-Key`
  - HTTP bearer

## Request body

- union
  - object
    - `type` 'DIRECT_MESSAGE' | 'EMAIL' | 'MEETING' | 'MEMO' | 'BOOKING_CREATED' | 'BOOKING_CANCELLED' | 'MANUAL' | 'API_EVENT' | 'VOICE_NOTE', required
    - `direction` 'INBOUND' | 'OUTBOUND' | 'HYBRID' | 'INTERNAL' | 'EVENT', required
    - `title` string, required
    - `summary` string
    - `primaryId` string
    - `secondaryId` string
    - `interactionDate` number: Unix timestamp in milliseconds.
    - `mainContact` string, required
    - `mainContactEmail` string, email
  - object
    - `type` 'DIRECT_MESSAGE' | 'EMAIL' | 'MEETING' | 'MEMO' | 'BOOKING_CREATED' | 'BOOKING_CANCELLED' | 'MANUAL' | 'API_EVENT' | 'VOICE_NOTE', required
    - `direction` 'INBOUND' | 'OUTBOUND' | 'HYBRID' | 'INTERNAL' | 'EVENT', required
    - `title` string, required
    - `summary` string
    - `primaryId` string
    - `secondaryId` string
    - `interactionDate` number: Unix timestamp in milliseconds.
    - `mainContact` string
    - `mainContactEmail` string, email, required

## Response `201`

Interaction created

- InteractionCreateSuccessResponse
  - `object` string, required
  - `data` object, required: The returned resource
    - `id` string, required
    - `isDuplicate` boolean, required
  - `meta` ApiMeta, required
    - `request_id` string, required
    - `api_version` string, required
    - `timestamp` string, date-time, required

## Other responses

- `401`: Missing or invalid API key
- `403`: Insufficient scope for this operation
- `422`: Validation error - request body failed validation
- `429`: Rate limit exceeded
- `500`: Internal server error

---

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