mittwald icon

mittwald

Interact with mittwald mStudio API

Actions409

Overview

This node operation creates a Customer Invite for a specified Customer in the mittwald mStudio API. It is useful when you want to invite a new user to join a customer's account with a specific role and optional message. Typical scenarios include onboarding new team members, granting access to accountants, or assigning ownership roles within a customer organization.

For example, you might use this node to send an invitation email to a new member of a customer's team, specifying their role as "Member" and including a personalized welcome message. You can also set an expiration time for the membership, after which the invite or membership will no longer be valid.

Properties

Name Meaning
Customer Id ID of the Customer to create a CustomerInvite for.
Mail Address Email address of the person to be invited.
Membership Expires At Optional expiration time for the resulting CustomerMembership (date/time string).
Message Optional message included in the CustomerInvite.
Role Role assigned to the invited user. Options: Notset, Owner, Member, Accountant.

Output

The node outputs JSON data representing the created Customer Invite object returned by the mittwald mStudio API. This typically includes details such as the invite status, invitee email, assigned role, expiration time, and any other metadata related to the invite.

No binary data output is indicated for this operation.

Dependencies

  • Requires an API key credential for authentication with the mittwald mStudio API.
  • The base URL for API requests is https://api.mittwald.de.
  • The node uses standard HTTP headers for JSON content (Accept: application/json, Content-Type: application/json).

Troubleshooting

  • Missing Required Fields: Ensure that Customer Id, Mail Address, and Role are provided; these are mandatory.
  • Invalid Email Format: The mail address should be a valid email format; otherwise, the API may reject the request.
  • Expired or Invalid API Key: Authentication errors may occur if the API key credential is missing, expired, or invalid.
  • Role Value Errors: Only the predefined roles ("notset", "owner", "member", "accountant") are accepted; using other values will cause errors.
  • Date Format Issues: If Membership Expires At is provided, ensure it is in a valid date-time string format recognized by the API.

Links and References

Discussion