Skip to main content
POST
/
interactions
Create an interaction
curl --request POST \
  --url https://api.klipy.ai/api/v1/interactions \
  --header 'Content-Type: application/json' \
  --header 'X-Klipy-Api-Key: <api-key>' \
  --data '
{
  "type": "DIRECT_MESSAGE",
  "direction": "INBOUND",
  "title": "<string>",
  "mainContact": "<string>",
  "summary": "<string>",
  "primaryId": "<string>",
  "secondaryId": "<string>",
  "interactionDate": 123,
  "mainContactEmail": "jsmith@example.com"
}
'
{
  "object": "success",
  "data": {
    "id": "<string>",
    "isDuplicate": true
  },
  "meta": {
    "request_id": "req_abc123",
    "api_version": "1",
    "timestamp": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-Klipy-Api-Key
string
header
required

API key passed as a header

Body

application/json
type
enum<string>
required
Available options:
DIRECT_MESSAGE,
EMAIL,
MEETING,
MEMO,
BOOKING_CREATED,
BOOKING_CANCELLED,
MANUAL,
API_EVENT,
VOICE_NOTE
direction
enum<string>
required
Available options:
INBOUND,
OUTBOUND,
HYBRID,
INTERNAL,
EVENT
title
string
required
Maximum string length: 1000
mainContact
string
required
summary
string
Maximum string length: 10000
primaryId
string
secondaryId
string
interactionDate
number

Unix timestamp in milliseconds.

mainContactEmail
string<email>

Response

Interaction created

object
string
required
Example:

"success"

data
object
required

The returned resource

meta
object
required
Last modified on April 5, 2026