Create or update an activity

Creates a new activity or updates an existing one for the current workspace object.

POST/api/activities

Creates a new activity or updates an existing one for the current workspace object.

Request Body

application/json

Request payload for Create or update an activity.

TypeScript Definitions

Use the request body type in TypeScript.

id?|

Existing activity identifier when updating.

objectHandle*string

Object handle that owns the activity.

Example"customers"

objectId*string

Object identifier that owns the activity.

Example"customer_123"

type?|

Activity type stored for the object timeline entry.

content*string

Primary activity content stored in the feed row.

Length1 <= length <= 4000

data?|

Arbitrary JSON payload stored for the resource.

Response Body

`application/json`

curl -X POST "https://example.com/api/activities" \  -H "Content-Type: application/json" \  -d '{    "objectHandle": "customers",    "objectId": "customer_123",    "content": "Customer requested a callback next Tuesday."  }'

{  "id": "activity_123",  "objectHandle": "customers",  "objectId": "customer_123",  "type": "comment",  "content": "Customer requested a callback next Tuesday.",  "createdAt": "2026-03-20T12:00:00.000Z",  "updatedAt": "2026-03-20T12:15:00.000Z",  "createdBy": {    "id": "workspace_user_123",    "name": "Ana Torres",    "email": "ana@example.com"  },  "updatedBy": {    "id": "workspace_user_123",    "name": "Ana Torres",    "email": "ana@example.com"  },  "data": {    "title": "Follow-up call",    "description": "Customer requested updated pricing details.",    "activityDate": "2026-03-20",    "location": {      "lat": 0,      "lng": 0,      "label": "Client office"    },    "meetingStartTime": "09:30",    "meetingEndTime": "10:15",    "attachments": [],    "associations": []  }}

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Create or update an activity

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`