Update Activity Logs
curl --request POST \
--url https://api.velt.dev/v2/activities/update \
--header 'Content-Type: application/json' \
--header 'x-velt-api-key: <x-velt-api-key>' \
--header 'x-velt-auth-token: <x-velt-auth-token>' \
--data '
{
"data": {
"organizationId": "<string>",
"activities": [
{
"id": "<string>",
"changes": {},
"entityData": "<any>",
"entityTargetData": "<any>",
"displayMessageTemplate": "<string>",
"displayMessageTemplateData": {},
"actionIcon": "<string>"
}
]
}
}
'import requests
url = "https://api.velt.dev/v2/activities/update"
payload = { "data": {
"organizationId": "<string>",
"activities": [
{
"id": "<string>",
"changes": {},
"entityData": "<any>",
"entityTargetData": "<any>",
"displayMessageTemplate": "<string>",
"displayMessageTemplateData": {},
"actionIcon": "<string>"
}
]
} }
headers = {
"x-velt-api-key": "<x-velt-api-key>",
"x-velt-auth-token": "<x-velt-auth-token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-velt-api-key': '<x-velt-api-key>',
'x-velt-auth-token': '<x-velt-auth-token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
organizationId: '<string>',
activities: [
{
id: '<string>',
changes: {},
entityData: '<any>',
entityTargetData: '<any>',
displayMessageTemplate: '<string>',
displayMessageTemplateData: {},
actionIcon: '<string>'
}
]
}
})
};
fetch('https://api.velt.dev/v2/activities/update', 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.velt.dev/v2/activities/update",
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([
'data' => [
'organizationId' => '<string>',
'activities' => [
[
'id' => '<string>',
'changes' => [
],
'entityData' => '<any>',
'entityTargetData' => '<any>',
'displayMessageTemplate' => '<string>',
'displayMessageTemplateData' => [
],
'actionIcon' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-velt-api-key: <x-velt-api-key>",
"x-velt-auth-token: <x-velt-auth-token>"
],
]);
$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.velt.dev/v2/activities/update"
payload := strings.NewReader("{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"activities\": [\n {\n \"id\": \"<string>\",\n \"changes\": {},\n \"entityData\": \"<any>\",\n \"entityTargetData\": \"<any>\",\n \"displayMessageTemplate\": \"<string>\",\n \"displayMessageTemplateData\": {},\n \"actionIcon\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-velt-api-key", "<x-velt-api-key>")
req.Header.Add("x-velt-auth-token", "<x-velt-auth-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.post("https://api.velt.dev/v2/activities/update")
.header("x-velt-api-key", "<x-velt-api-key>")
.header("x-velt-auth-token", "<x-velt-auth-token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"activities\": [\n {\n \"id\": \"<string>\",\n \"changes\": {},\n \"entityData\": \"<any>\",\n \"entityTargetData\": \"<any>\",\n \"displayMessageTemplate\": \"<string>\",\n \"displayMessageTemplateData\": {},\n \"actionIcon\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.velt.dev/v2/activities/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-velt-api-key"] = '<x-velt-api-key>'
request["x-velt-auth-token"] = '<x-velt-auth-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"activities\": [\n {\n \"id\": \"<string>\",\n \"changes\": {},\n \"entityData\": \"<any>\",\n \"entityTargetData\": \"<any>\",\n \"displayMessageTemplate\": \"<string>\",\n \"displayMessageTemplateData\": {},\n \"actionIcon\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"result": {
"status": "success",
"message": "Activity(s) updated successfully.",
"data": {
"activity-001": {
"success": true,
"message": "Activity updated."
}
}
}
}
Activity Logs
Update Activity Logs
POST
/
v2
/
activities
/
update
Update Activity Logs
curl --request POST \
--url https://api.velt.dev/v2/activities/update \
--header 'Content-Type: application/json' \
--header 'x-velt-api-key: <x-velt-api-key>' \
--header 'x-velt-auth-token: <x-velt-auth-token>' \
--data '
{
"data": {
"organizationId": "<string>",
"activities": [
{
"id": "<string>",
"changes": {},
"entityData": "<any>",
"entityTargetData": "<any>",
"displayMessageTemplate": "<string>",
"displayMessageTemplateData": {},
"actionIcon": "<string>"
}
]
}
}
'import requests
url = "https://api.velt.dev/v2/activities/update"
payload = { "data": {
"organizationId": "<string>",
"activities": [
{
"id": "<string>",
"changes": {},
"entityData": "<any>",
"entityTargetData": "<any>",
"displayMessageTemplate": "<string>",
"displayMessageTemplateData": {},
"actionIcon": "<string>"
}
]
} }
headers = {
"x-velt-api-key": "<x-velt-api-key>",
"x-velt-auth-token": "<x-velt-auth-token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-velt-api-key': '<x-velt-api-key>',
'x-velt-auth-token': '<x-velt-auth-token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
data: {
organizationId: '<string>',
activities: [
{
id: '<string>',
changes: {},
entityData: '<any>',
entityTargetData: '<any>',
displayMessageTemplate: '<string>',
displayMessageTemplateData: {},
actionIcon: '<string>'
}
]
}
})
};
fetch('https://api.velt.dev/v2/activities/update', 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.velt.dev/v2/activities/update",
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([
'data' => [
'organizationId' => '<string>',
'activities' => [
[
'id' => '<string>',
'changes' => [
],
'entityData' => '<any>',
'entityTargetData' => '<any>',
'displayMessageTemplate' => '<string>',
'displayMessageTemplateData' => [
],
'actionIcon' => '<string>'
]
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-velt-api-key: <x-velt-api-key>",
"x-velt-auth-token: <x-velt-auth-token>"
],
]);
$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.velt.dev/v2/activities/update"
payload := strings.NewReader("{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"activities\": [\n {\n \"id\": \"<string>\",\n \"changes\": {},\n \"entityData\": \"<any>\",\n \"entityTargetData\": \"<any>\",\n \"displayMessageTemplate\": \"<string>\",\n \"displayMessageTemplateData\": {},\n \"actionIcon\": \"<string>\"\n }\n ]\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-velt-api-key", "<x-velt-api-key>")
req.Header.Add("x-velt-auth-token", "<x-velt-auth-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.post("https://api.velt.dev/v2/activities/update")
.header("x-velt-api-key", "<x-velt-api-key>")
.header("x-velt-auth-token", "<x-velt-auth-token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"activities\": [\n {\n \"id\": \"<string>\",\n \"changes\": {},\n \"entityData\": \"<any>\",\n \"entityTargetData\": \"<any>\",\n \"displayMessageTemplate\": \"<string>\",\n \"displayMessageTemplateData\": {},\n \"actionIcon\": \"<string>\"\n }\n ]\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.velt.dev/v2/activities/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-velt-api-key"] = '<x-velt-api-key>'
request["x-velt-auth-token"] = '<x-velt-auth-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {\n \"organizationId\": \"<string>\",\n \"activities\": [\n {\n \"id\": \"<string>\",\n \"changes\": {},\n \"entityData\": \"<any>\",\n \"entityTargetData\": \"<any>\",\n \"displayMessageTemplate\": \"<string>\",\n \"displayMessageTemplateData\": {},\n \"actionIcon\": \"<string>\"\n }\n ]\n }\n}"
response = http.request(request)
puts response.read_body{
"result": {
"status": "success",
"message": "Activity(s) updated successfully.",
"data": {
"activity-001": {
"success": true,
"message": "Activity updated."
}
}
}
}
Use this API to update existing activity log records within an organization.
Endpoint
POST https://api.velt.dev/v2/activities/update
Headers
string
required
Your API key.
string
required
Your Auth Token.
Body
Params
object
required
Show properties
Show properties
string
required
Organization ID
object[]
required
Array of activity log objects to update. Each must include the activity log
id.Show properties
Show properties
string
required
Activity log ID to update.
object
Map of field names to
{ from, to } objects describing what changed.any
Updated snapshot of the entity.
any
Updated snapshot of the target entity.
string
Updated message template string. Use
{{variable}} syntax for dynamic values.object
Updated key-value data to populate
displayMessageTemplate variables.string
Updated URL or identifier for the action icon.
Example Requests
Update a single activity log’s display message
{
"data": {
"organizationId": "org-123",
"activities": [
{
"id": "activity-001",
"displayMessageTemplate": "{{user}} updated the comment"
}
]
}
}
Update multiple activities
{
"data": {
"organizationId": "org-123",
"activities": [
{
"id": "activity-001",
"displayMessageTemplate": "{{user}} updated the comment",
"displayMessageTemplateData": {
"user": {
"userId": "user-1",
"name": "User Name"
}
}
},
{
"id": "activity-002",
"actionIcon": "https://example.com/icons/edit.svg"
}
]
}
}
Response
Success Response
{
"result": {
"status": "success",
"message": "Activity(s) updated successfully.",
"data": {
"activity-001": {
"success": true,
"message": "Activity updated."
}
}
}
}
When some activities are not found
{
"result": {
"status": "success",
"message": "Activity(s) updated successfully.",
"data": {
"activity-001": {
"success": false,
"message": "Failed to update activity."
},
"activity-002": {
"success": true,
"message": "Activity updated."
}
}
}
}
Failure Response
{
"error": {
"message": "ERROR_MESSAGE",
"status": "INVALID_ARGUMENT"
}
}
{
"result": {
"status": "success",
"message": "Activity(s) updated successfully.",
"data": {
"activity-001": {
"success": true,
"message": "Activity updated."
}
}
}
}
Was this page helpful?
⌘I