Actions20
- Claim (Case Management API) Actions
- Debtor (Case Management API) Actions
- Info (Case Management API) Actions
- Company (Partner API) Actions
- User (Partner API) Actions
- User Invite (Partner API) Actions
Overview
This node integrates with the Partner API to create user invitations. It allows you to invite a new user by specifying their email, company association, and optional personal details. The node supports two input methods: either through individual form fields or by providing a JSON object containing all necessary data.
Common scenarios include onboarding new users into a company's system, automating invitation workflows, or integrating user management with other business processes. For example, after registering a new client in your CRM, you could automatically send them an invite to join your platform using this node.
Properties
| Name | Meaning |
|---|---|
| Input Method | Choose how to provide user invite data: - Form Fields: Enter properties individually. - JSON: Provide all data as a JSON object. |
| JSON Data | (Required if Input Method is JSON) A JSON object containing user invite details. Required fields are: - email: Email address of the user to invite.- company: Company ID to associate the user with.- success_url: URL to redirect after successful acceptance.- failure_url: URL to redirect if acceptance fails.Optional fields include first_name and last_name. |
| (Required if Input Method is Form Fields) Email address of the user to invite. | |
| Company ID | (Required if Input Method is Form Fields) Identifier of the company to add the user to. |
| First Name | (Optional if Input Method is Form Fields) First name of the user. |
| Last Name | (Optional if Input Method is Form Fields) Last name of the user. |
| Success URL | (Required if Input Method is Form Fields) URL to redirect the user to after successful invitation acceptance. |
| Failure URL | (Required if Input Method is Form Fields) URL to redirect the user to if invitation acceptance fails. |
Output
The node outputs an array of JSON objects, each representing the response from the API for the created user invite. The exact structure depends on the API response but typically includes confirmation details about the invitation sent.
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating with the Partner API.
- The node depends on the external Partner API service to create user invites.
- Proper network connectivity and valid credentials are necessary for successful operation.
Troubleshooting
- Missing required fields: Ensure that all required fields (
email,company,success_url,failure_url) are provided either via form fields or JSON input. - Invalid URLs: The success and failure URLs must be valid and reachable; otherwise, redirection may fail.
- API authentication errors: Verify that the API key credential is correctly configured and has sufficient permissions.
- Network issues: Check internet connectivity and firewall settings if requests time out or fail.
- Error messages from API: These will typically indicate invalid input or permission issues; review the error message details and adjust inputs accordingly.
Links and References
- Partner API Documentation
- Refer to the official API docs for detailed information on user invite payloads and expected responses.