Skip to main content
POST
/
interactions
create interaction
curl --request POST \
  --url https://api.klipy.ai/api/v2/interactions \
  --header 'Content-Type: application/json' \
  --header 'X-Klipy-Api-Key: <api-key>' \
  --data '
{
  "contact_ids": [
    "<string>"
  ],
  "interaction_date": 123,
  "title": "<string>",
  "summary": "<string>"
}
'
import requests

url = "https://api.klipy.ai/api/v2/interactions"

payload = {
"contact_ids": ["<string>"],
"interaction_date": 123,
"title": "<string>",
"summary": "<string>"
}
headers = {
"X-Klipy-Api-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-Klipy-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_ids: ['<string>'],
interaction_date: 123,
title: '<string>',
summary: '<string>'
})
};

fetch('https://api.klipy.ai/api/v2/interactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.klipy.ai/api/v2/interactions",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contact_ids' => [
'<string>'
],
'interaction_date' => 123,
'title' => '<string>',
'summary' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Klipy-Api-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.klipy.ai/api/v2/interactions"

payload := strings.NewReader("{\n \"contact_ids\": [\n \"<string>\"\n ],\n \"interaction_date\": 123,\n \"title\": \"<string>\",\n \"summary\": \"<string>\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-Klipy-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.klipy.ai/api/v2/interactions")
.header("X-Klipy-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"contact_ids\": [\n \"<string>\"\n ],\n \"interaction_date\": 123,\n \"title\": \"<string>\",\n \"summary\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.klipy.ai/api/v2/interactions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Klipy-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact_ids\": [\n \"<string>\"\n ],\n \"interaction_date\": 123,\n \"title\": \"<string>\",\n \"summary\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {},
  "meta": {
    "api_version": "<string>",
    "request_id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z"
  },
  "object": "<string>"
}
{
"error": {
"code": "<string>",
"details": [
{}
],
"message": "<string>"
},
"meta": {
"api_version": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
},
"object": "<string>"
}
{
"error": {
"code": "<string>",
"details": [
{}
],
"message": "<string>"
},
"meta": {
"api_version": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
},
"object": "<string>"
}
{
"error": {
"code": "<string>",
"details": [
{}
],
"message": "<string>"
},
"meta": {
"api_version": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
},
"object": "<string>"
}
{
"error": {
"code": "<string>",
"details": [
{}
],
"message": "<string>"
},
"meta": {
"api_version": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
},
"object": "<string>"
}
{
"error": {
"code": "<string>",
"details": [
{}
],
"message": "<string>"
},
"meta": {
"api_version": "<string>",
"request_id": "<string>",
"timestamp": "2023-11-07T05:31:56Z"
},
"object": "<string>"
}

Authorizations

X-Klipy-Api-Key
string
header
required

Body

application/json
contact_ids
string[]
required
direction
enum<string>
required
Available options:
INBOUND,
OUTBOUND,
HYBRID,
INTERNAL,
EVENT
interaction_date
number
required
title
string
required
type
enum<string>
required
Available options:
MANUAL,
MEMO,
DIRECT_MESSAGE
summary
string

Response

Resource created.

data
object
meta
object
object
string
Last modified on July 11, 2026