Update Activity Logs

POST /v2/activities/update

Update Activity Logs

cURL

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>"
      }
    ]
  }
}
'

{
  "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

x-velt-api-key · string · required

Your API key.

x-velt-auth-token · string · required

Your Auth Token.

Body

Params

data · object · required

Show properties

organizationId · string · required

Organization ID

activities · object[] · required

Array of activity log objects to update. Each must include the activity log id.

Show properties

id · string · required

Activity log ID to update.

changes · object

Map of field names to { from, to } objects describing what changed.

entityData · any

Updated snapshot of the entity.

entityTargetData · any

Updated snapshot of the target entity.

displayMessageTemplate · string

Updated message template string. Use {{variable}} syntax for dynamic values.

displayMessageTemplateData · object

Updated key-value data to populate displayMessageTemplate variables.

actionIcon · 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."
      }
    }
  }
}