Interactions
Update an interaction
Fully replaces an existing interaction. Any field not included in the payload (including tags) is cleared.
PUT
/
v1
/
contacts
/
{contactId}
/
interactions
/
{interactionId}
Update an interaction
curl --request PUT \
--url https://incoming.qomon.app/v1/contacts/{contactId}/interactions/{interactionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"date_of_event": "2023-11-07T05:31:56Z",
"address": "<string>",
"comments": "<string>",
"date_end": "2023-11-07T05:31:56Z",
"only_super_admin": true,
"tags": [
{
"color": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"id": 1,
"name": "<string>"
}
],
"title": "<string>"
}
'import requests
url = "https://incoming.qomon.app/v1/contacts/{contactId}/interactions/{interactionId}"
payload = {
"date_of_event": "2023-11-07T05:31:56Z",
"address": "<string>",
"comments": "<string>",
"date_end": "2023-11-07T05:31:56Z",
"only_super_admin": True,
"tags": [
{
"color": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"id": 1,
"name": "<string>"
}
],
"title": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
date_of_event: '2023-11-07T05:31:56Z',
address: '<string>',
comments: '<string>',
date_end: '2023-11-07T05:31:56Z',
only_super_admin: true,
tags: [
{color: '<string>', created_at: '2023-11-07T05:31:56Z', id: 1, name: '<string>'}
],
title: '<string>'
})
};
fetch('https://incoming.qomon.app/v1/contacts/{contactId}/interactions/{interactionId}', 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://incoming.qomon.app/v1/contacts/{contactId}/interactions/{interactionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'date_of_event' => '2023-11-07T05:31:56Z',
'address' => '<string>',
'comments' => '<string>',
'date_end' => '2023-11-07T05:31:56Z',
'only_super_admin' => true,
'tags' => [
[
'color' => '<string>',
'created_at' => '2023-11-07T05:31:56Z',
'id' => 1,
'name' => '<string>'
]
],
'title' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://incoming.qomon.app/v1/contacts/{contactId}/interactions/{interactionId}"
payload := strings.NewReader("{\n \"date_of_event\": \"2023-11-07T05:31:56Z\",\n \"address\": \"<string>\",\n \"comments\": \"<string>\",\n \"date_end\": \"2023-11-07T05:31:56Z\",\n \"only_super_admin\": true,\n \"tags\": [\n {\n \"color\": \"<string>\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"id\": 1,\n \"name\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://incoming.qomon.app/v1/contacts/{contactId}/interactions/{interactionId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"date_of_event\": \"2023-11-07T05:31:56Z\",\n \"address\": \"<string>\",\n \"comments\": \"<string>\",\n \"date_end\": \"2023-11-07T05:31:56Z\",\n \"only_super_admin\": true,\n \"tags\": [\n {\n \"color\": \"<string>\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"id\": 1,\n \"name\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://incoming.qomon.app/v1/contacts/{contactId}/interactions/{interactionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"date_of_event\": \"2023-11-07T05:31:56Z\",\n \"address\": \"<string>\",\n \"comments\": \"<string>\",\n \"date_end\": \"2023-11-07T05:31:56Z\",\n \"only_super_admin\": true,\n \"tags\": [\n {\n \"color\": \"<string>\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"id\": 1,\n \"name\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"address": "<string>",
"comments": "<string>",
"contact_id": 1,
"created_at": "2023-11-07T05:31:56Z",
"date_end": "2023-11-07T05:31:56Z",
"date_of_event": "2023-11-07T05:31:56Z",
"files": [
{
"created_at": "2023-11-07T05:31:56Z",
"folder": "<string>",
"group_id": 1,
"id": 1,
"mime": "<string>",
"name": "<string>",
"owner_id": 123,
"type": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"url": "<string>"
}
],
"group_id": 1,
"id": 1,
"only_super_admin": true,
"sub_type": "incoming",
"tags": [
{
"color": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"id": 1,
"name": "<string>"
}
],
"title": "<string>",
"type": "email",
"updated_at": "2023-11-07T05:31:56Z",
"user": {
"CreatedAt": "2023-11-07T05:31:56Z",
"UpdatedAt": "2023-11-07T05:31:56Z",
"address": "1 rue de la paix",
"avatar": "https://example.com/avatar.png",
"birthdate": "2023-11-07T05:31:56Z",
"city": "Paris",
"created": "2023-11-07T05:31:56Z",
"firstname": "John",
"group_id": [
123
],
"id": 101,
"locale": "en",
"location": "1.826483,-1.549486",
"mail": "john.doe@example.com",
"phone": "0123456789",
"postal": "75000",
"status": "available_week_morning,available_weekend",
"surname": "Doe",
"two_factor_enable": true,
"two_factor_method": "email"
},
"user_id": 1
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}Authorizations
OAuth2 access token. Pass the token in the Authorization header as Bearer <token>. The token is looked up in Redis to resolve the caller identity.
Path Parameters
Contact ID.
Required range:
x >= 0Example:
42
Interaction ID.
Required range:
x >= 0Example:
501
Body
application/json
When the interaction took place. Required — undated interactions are not shown in the Qomon UI.
Physical address related to the interaction, if applicable (e.g., meeting location).
If true, only users with the private-interactions permission can see this interaction.
Available options:
incoming, outgoing Tags to attach to the interaction. Provide an existing tag's id to reuse it, or omit id (with a name) to create a new tag. This list fully replaces the interaction's tags on update.
Show child attributes
Show child attributes
Available options:
email, letter, call, meeting, sms, donation Response
OK
Physical address related to the interaction, if applicable. (e.g., meeting location)
ID of the contact associated with this interaction.
Required range:
x >= 0List of files attached to the interaction.
Show child attributes
Show child attributes
Required range:
x >= 0Required range:
x >= 0If true, only user with specific permissions can see this interaction.
Available options:
incoming, outgoing Tags attached to the interaction.
Show child attributes
Show child attributes
Available options:
email, letter, call, meeting, sms, donation User who logged the interaction.
Show child attributes
Show child attributes
ID of the user who logged the interaction.
Required range:
x >= 0Was this page helpful?
⌘I
Update an interaction
curl --request PUT \
--url https://incoming.qomon.app/v1/contacts/{contactId}/interactions/{interactionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"date_of_event": "2023-11-07T05:31:56Z",
"address": "<string>",
"comments": "<string>",
"date_end": "2023-11-07T05:31:56Z",
"only_super_admin": true,
"tags": [
{
"color": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"id": 1,
"name": "<string>"
}
],
"title": "<string>"
}
'import requests
url = "https://incoming.qomon.app/v1/contacts/{contactId}/interactions/{interactionId}"
payload = {
"date_of_event": "2023-11-07T05:31:56Z",
"address": "<string>",
"comments": "<string>",
"date_end": "2023-11-07T05:31:56Z",
"only_super_admin": True,
"tags": [
{
"color": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"id": 1,
"name": "<string>"
}
],
"title": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
date_of_event: '2023-11-07T05:31:56Z',
address: '<string>',
comments: '<string>',
date_end: '2023-11-07T05:31:56Z',
only_super_admin: true,
tags: [
{color: '<string>', created_at: '2023-11-07T05:31:56Z', id: 1, name: '<string>'}
],
title: '<string>'
})
};
fetch('https://incoming.qomon.app/v1/contacts/{contactId}/interactions/{interactionId}', 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://incoming.qomon.app/v1/contacts/{contactId}/interactions/{interactionId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'date_of_event' => '2023-11-07T05:31:56Z',
'address' => '<string>',
'comments' => '<string>',
'date_end' => '2023-11-07T05:31:56Z',
'only_super_admin' => true,
'tags' => [
[
'color' => '<string>',
'created_at' => '2023-11-07T05:31:56Z',
'id' => 1,
'name' => '<string>'
]
],
'title' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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://incoming.qomon.app/v1/contacts/{contactId}/interactions/{interactionId}"
payload := strings.NewReader("{\n \"date_of_event\": \"2023-11-07T05:31:56Z\",\n \"address\": \"<string>\",\n \"comments\": \"<string>\",\n \"date_end\": \"2023-11-07T05:31:56Z\",\n \"only_super_admin\": true,\n \"tags\": [\n {\n \"color\": \"<string>\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"id\": 1,\n \"name\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.put("https://incoming.qomon.app/v1/contacts/{contactId}/interactions/{interactionId}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"date_of_event\": \"2023-11-07T05:31:56Z\",\n \"address\": \"<string>\",\n \"comments\": \"<string>\",\n \"date_end\": \"2023-11-07T05:31:56Z\",\n \"only_super_admin\": true,\n \"tags\": [\n {\n \"color\": \"<string>\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"id\": 1,\n \"name\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://incoming.qomon.app/v1/contacts/{contactId}/interactions/{interactionId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"date_of_event\": \"2023-11-07T05:31:56Z\",\n \"address\": \"<string>\",\n \"comments\": \"<string>\",\n \"date_end\": \"2023-11-07T05:31:56Z\",\n \"only_super_admin\": true,\n \"tags\": [\n {\n \"color\": \"<string>\",\n \"created_at\": \"2023-11-07T05:31:56Z\",\n \"id\": 1,\n \"name\": \"<string>\"\n }\n ],\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"address": "<string>",
"comments": "<string>",
"contact_id": 1,
"created_at": "2023-11-07T05:31:56Z",
"date_end": "2023-11-07T05:31:56Z",
"date_of_event": "2023-11-07T05:31:56Z",
"files": [
{
"created_at": "2023-11-07T05:31:56Z",
"folder": "<string>",
"group_id": 1,
"id": 1,
"mime": "<string>",
"name": "<string>",
"owner_id": 123,
"type": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"url": "<string>"
}
],
"group_id": 1,
"id": 1,
"only_super_admin": true,
"sub_type": "incoming",
"tags": [
{
"color": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"id": 1,
"name": "<string>"
}
],
"title": "<string>",
"type": "email",
"updated_at": "2023-11-07T05:31:56Z",
"user": {
"CreatedAt": "2023-11-07T05:31:56Z",
"UpdatedAt": "2023-11-07T05:31:56Z",
"address": "1 rue de la paix",
"avatar": "https://example.com/avatar.png",
"birthdate": "2023-11-07T05:31:56Z",
"city": "Paris",
"created": "2023-11-07T05:31:56Z",
"firstname": "John",
"group_id": [
123
],
"id": 101,
"locale": "en",
"location": "1.826483,-1.549486",
"mail": "john.doe@example.com",
"phone": "0123456789",
"postal": "75000",
"status": "available_week_morning,available_weekend",
"surname": "Doe",
"two_factor_enable": true,
"two_factor_method": "email"
},
"user_id": 1
}{
"detail": "Property foo is required but is missing.",
"errors": [
{
"location": "<string>",
"message": "<string>",
"value": "<unknown>"
}
],
"instance": "https://example.com/error-log/abc123",
"status": 400,
"title": "Bad Request",
"type": "https://example.com/errors/example"
}