Users

Invite user to investor

Invite a new user to join an investor account.

If the user already has a Spiko account, they will be added directly to the investor with the specified role.
If the user does not have a Spiko account, an invitation email will be sent.
Returns either the created invitation or the added user depending on the scenario.

post/v0/investors/{investorId}/users

Request

Base URL
https://distributor-api.spiko.io
Auth
HTTP basic
TypeScript
https://skmtc.dev/spiko/apis/spiko-distributor-api/docs/v0/investors/:investorId/users/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

investorIdstring uuid required

a Universally Unique Identifier

Request body

emailstring required

Email address of the user to invite

firstNamestring required

First name of the user to invite

lastNamestring required

Last name of the user to invite

role'admin' | 'manager' | 'viewer' required

Role to assign to the invited user: "admin" for full access, "manager" to place and manage orders without administrative access, "viewer" for read-only access.

Response

Success

Changes

No recorded changes to this operation across all 4 revisions of this API.