Connect Secure icon

Connect Secure

Consume Connect Secure API

Actions222

Overview

The "Update Scheduler" operation in the Scheduler resource allows users to update an existing scheduler configuration by specifying its ID and providing new data for various scheduler parameters. This node is useful when you need to programmatically modify scheduler settings such as activation status, associated users or companies, tags, integrations, and other custom filters.

Practical examples include:

  • Activating or deactivating a scheduled task.
  • Changing which agents or companies are included or excluded from the schedule.
  • Updating email notification lists or integration settings dynamically based on workflow conditions.

Properties

Name Meaning
X USER ID The user identifier header required for authentication or tracking purposes in the API request.
Data JSON object containing the scheduler's updated properties such as activation flags, filters, and related entities. Example keys include is_active, email, agent_ids, include_tags, etc.
Id Numeric identifier of the scheduler to be updated.

Output

The node outputs JSON data representing the response from the scheduler update API call. This typically includes confirmation of the update, the updated scheduler details, or error information if the update failed.

No binary data output is involved.

Dependencies

  • Requires an API key credential for authenticating with the Connect Secure API.
  • Depends on the external Connect Secure API service endpoint to perform scheduler updates.
  • The node expects the environment to have network access to the API.

Troubleshooting

  • Missing or invalid X USER ID: The API may reject requests without a valid user ID header. Ensure this property is correctly set.
  • Invalid scheduler ID: Providing a non-existent or incorrect scheduler ID will cause update failures.
  • Malformed JSON in Data: The Data property must be valid JSON; otherwise, the request body will be rejected.
  • API authentication errors: Verify that the API key credential is configured properly and has sufficient permissions.
  • Network issues: Connectivity problems to the API endpoint can cause timeouts or failures.

Links and References

Discussion