Straddle icon

Straddle

Interact with Straddle API
Join our community

Actions81

Overview

This node updates an existing customer record in the Straddle system by sending a PUT request to the /v1/customers/{id} endpoint. It is useful for scenarios where you need to modify customer details such as name, email, phone number, status, and other related information. For example, you might use this node to update a customer's contact information after they have provided new details or to change their verification status.

Properties

Name Meaning
Id The unique identifier of the customer to update (required).
Straddle Account Id Optional header to specify an account ID and set the scope of the request (for platform use).
Request Id Optional client-generated identifier to trace and debug the request (sent as a header).
Correlation Id Optional client-generated identifier to trace and debug a series of requests (sent as a header).
Name The customer's full name or business name (required).
Email The customer's email address (required).
Address JSON object containing address information (e.g., line1, city, state, postal_code, country).
Phone The customer's phone number in E.164 format (required).
Compliance Profile JSON object with compliance-related information about the customer.
External Id Unique identifier for the customer in your own database, used for cross-referencing.
Device JSON object describing device information such as IP address and user agent (required).
Status Customer status; options are: Verified, Inactive, Rejected (required).
Metadata JSON object containing user-defined key-value pairs for custom metadata.

Output

The node outputs the response from the Straddle API after updating the customer. The output is a JSON object representing the updated customer resource, including all fields sent and any additional data returned by the API. This typically includes identifiers, status details, compliance information, and metadata.

No binary data output is indicated.

Dependencies

  • Requires an API authentication token credential configured in n8n to authenticate requests to the Straddle API.
  • The base URL for the API is dynamically constructed based on the environment credential parameter.
  • The node expects JSON-formatted input for complex fields like address, compliance_profile, device, and metadata.

Troubleshooting

  • Missing Required Fields: Ensure that all required properties (Id, Name, Email, Phone, Device, and Status) are provided; otherwise, the API will reject the request.
  • Invalid JSON Format: For JSON-type fields (address, compliance_profile, device, metadata), ensure valid JSON strings are provided; parsing errors will cause failures.
  • Authentication Errors: Verify that the API key credential is correctly configured and has sufficient permissions.
  • Incorrect Phone Format: The phone number must be in E.164 format; invalid formats may cause validation errors.
  • API Endpoint Errors: If the customer ID does not exist or is incorrect, the API will return an error indicating the resource was not found.

Links and References

Discussion