TwentyDEV icon

TwentyDEV

Consume the Twenty API
Join our community

Actions252

Overview

This node operation updates a single Timeline Activity object in the connected service. It allows users to modify various details of an existing timeline event, such as its name, associated records, timestamps, and custom properties. This is useful for keeping timeline data accurate and up-to-date, reflecting changes in related entities or event details.

Practical examples include:

  • Updating the event name or timestamp after receiving new information.
  • Linking the timeline activity to different related records like persons, companies, or tasks.
  • Adding or modifying detailed JSON properties describing the event.
  • Adjusting cached names or metadata to improve display or integration consistency.

Properties

Name Meaning
Id The unique identifier of the timeline activity to update (required).
Depth Level of nested related objects to include in the response: 0 (primary only), 1 (primary + direct), 2 (primary + direct + nested).
Person Id Identifier of the person associated with this timeline activity.
Properties JSON object containing detailed event information.
Name The name/title of the event.
Happens At The creation date/time of the event.
Workspace Member Id Identifier of the workspace member linked to this activity.
Linked Record Cached Name Cached name of the linked record for quick reference/display.
Company Id Identifier of the company associated with this timeline activity.
Opportunity Id Identifier of the opportunity linked to this event.
Note Id Identifier of the note linked to this timeline activity.
Task Id Identifier of the task associated with this timeline activity.
Workflow Id Identifier of the workflow linked to this timeline activity.
Workflow Version Id Identifier of the specific version of the workflow.
Workflow Run Id Identifier of the workflow run associated with this event.
Linked Object Metadata Id Identifier for linked object metadata.
Linked Record Id Identifier of the linked record.

Output

The output JSON contains the updated timeline activity object, including all fields sent in the update plus any additional related objects depending on the depth parameter. The structure reflects the timeline activity's current state after modification.

If binary data were involved (not indicated here), it would typically represent attachments or media related to the timeline activity, but this operation focuses on JSON data only.

Dependencies

  • Requires an API key credential for authenticating requests to the external Twenty API service.
  • The node uses the base URL and headers configured via credentials.
  • No other external dependencies are indicated.

Troubleshooting

  • Missing or invalid Id: The update requires a valid timeline activity ID. Ensure the "Id" property is correctly set.
  • Invalid JSON in Properties: The "Properties" field expects valid JSON. Malformed JSON will cause errors; validate JSON syntax before input.
  • Permission errors: Insufficient permissions or invalid API keys may result in authorization errors. Verify API credentials and access rights.
  • Incorrect depth value: Using unsupported depth values might lead to unexpected responses. Use only 0, 1, or 2.
  • Empty required fields: Required fields must not be empty; ensure mandatory inputs are provided.

Links and References

Discussion