Unipile icon

Unipile

Interact with Unipile API

Overview

The node interacts with the Unipile API to manage user-related actions, specifically allowing cancellation of a user invitation. This operation is useful in scenarios where an invitation sent to a user needs to be revoked before acceptance, such as when an incorrect email was used or the invitation is no longer relevant.

For example, if you have invited a user to join a platform or service via Unipile and want to cancel that invitation programmatically, this node operation enables you to do so by specifying the invitation ID and associated account ID.

Properties

Name Meaning
Invitation ID The unique identifier of the invitation you want to cancel.
Account ID The identifier of the account related to the invitation; sent as a query parameter.

Output

The node outputs JSON data representing the result of the cancel invitation request. This typically includes confirmation of the cancellation status or any error messages returned by the Unipile API. There is no indication that binary data is output by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Unipile API.
  • The base URL for API requests is configured dynamically from the provided credentials.
  • Proper network access to the Unipile API endpoint is necessary.

Troubleshooting

  • Invalid Invitation ID: If the invitation ID does not exist or is malformed, the API may return an error indicating the invitation cannot be found. Verify the ID before retrying.
  • Unauthorized Access: Missing or invalid API credentials will cause authentication failures. Ensure the API key is correctly configured.
  • Account ID Mismatch: Providing an incorrect account ID may lead to failure in locating the invitation. Confirm the account ID matches the invitation's context.
  • Network Issues: Connectivity problems can prevent the API call from succeeding. Check your network and proxy settings if applicable.

Links and References

Discussion