POST
/
interactions
curl --request POST \
  --url https://api.klipycrm.com/api/v1/interactions \
  --header 'Content-Type: application/json' \
  --header 'X-KLIPY-API-KEY: <api-key>' \
  --data '{
  "type": "<string>",
  "direction": "INBOUND",
  "primaryId": "<string>",
  "secondaryId": "<string>",
  "title": "<string>",
  "summary": "<string>",
  "interactionDate": 123,
  "mainContact": "<string>",
  "mainContactEmail": "<string>"
}'
{
  "success": true,
  "data": {
    "id": "<string>"
  }
}

Authorizations

​
X-KLIPY-API-KEY
string
header
required

Body

application/json
Interaction record to create
​
type
string
required

Type of interaction

​
direction
enum<string>
required

Direction of the interaction

Available options:
INBOUND,
OUTBOUND,
HYBRID,
INTERNAL,
EVENT
​
title
string
required

Title of the interaction

​
mainContact
string | null
required

ID of the main contact for this interaction. Either mainContact or mainContactEmail is required, but not both.

​
primaryId
string | null

Primary ID associated with this interaction

​
secondaryId
string | null

Secondary ID associated with this interaction

​
summary
string

Summary of the interaction

​
interactionDate
number | null

Date of the interaction (timestamp) in miliseconds. Defaults to current timestamp if not provided.

​
mainContactEmail
string | null

Email of the main contact. Either mainContact or mainContactEmail is required, but not both.

Response

200
application/json
Success
​
success
boolean
​
data
object