Invite investor

Create a new order in a Fund with the supplied fundId.

If the order is created successfully, the response will contain an OrderId, which is used to identify the Order and query Order details (e.g. form filling progress, commitment amount, etc.) via the Graphql API.

To create multiple orders at the same time, the asynchronous version of this API, which is "Create Multiple Orders", is recommended.

A customer-defined ID can be entered into the customId field and linked to an order, allowing for future identification without the necessity of storing the Anduin orderId.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The Anduin ID of the Fund object, or your custom ID

Body Params
enum

The type of the order, which is used to determine whether to invite the order contacts or not. There can be 2 values, you can use either number or string (case sensitive) for selecting type:

  • 0/"NORMAL": Contacts will be invited
  • 1/"OFFLINE": Contacts will not be invited

The default value is 0/"NORMAL".

string

The Id of the close to associate with the order

order
object
required

Parameters to create orders

emailTemplate
object

LP Invitation Email Template, for more information, please visit our documentation. If you do not specify the template, the default one will be applied.

string

Id of the form data template to pre-fill subscription documents

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json