Straddle icon

Straddle

Interact with Straddle API

Actions81

Overview

This node operation updates the status of a specific platform by its unique identifier. It is useful in scenarios where you need to programmatically change or track the lifecycle state of platforms within your system, such as marking a platform as active after onboarding or flagging it as rejected or inactive based on compliance or operational decisions.

Practical examples include:

  • Automatically setting a platform's status to "active" once onboarding steps are completed.
  • Marking a platform as "rejected" if it fails verification checks.
  • Updating status details to reflect ongoing review or verification states.

Properties

Name Meaning
Platform Id The unique identifier of the platform whose status is being updated.
Request Id Optional client-generated identifier to trace and debug a single request (sent as HTTP header).
Correlation Id Optional client-generated identifier to trace and debug a series of related requests (header).
Status The new status of the platform. Options: Unknown, Created, Onboarding, Active, Rejected, Inactive.
Status Detail Additional detail about the status. Options: Unknown, Unverified, In Review, Pending, Stuck, Verified, Failed Verification, Disabled, Terminated.

Output

The node outputs JSON data representing the response from the API after updating the platform status. This typically includes confirmation of the updated status and any relevant metadata or messages returned by the service.

No binary data output is involved in this operation.

Dependencies

  • Requires an API key credential for authentication with the Straddle API.
  • The base URL for API requests is dynamically set based on the configured environment credential.
  • The node sends JSON-formatted PATCH requests to update platform status.

Troubleshooting

  • Common issues:
    • Invalid or missing Platform Id will cause the API call to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Providing invalid status or status detail values not in the allowed options may cause validation errors.
  • Error messages:
    • Authentication failures: Check that the API key credential is correctly configured and valid.
    • Not found errors: Verify the Platform Id exists and is correct.
    • Validation errors: Ensure the status and status detail fields use one of the predefined options.

Links and References

Discussion