Create Guest User

Create a new invitation that adds an external guest user to the organization.

Unless otherwise indicated, field types are text.

Input

  • User

    • Invited User Display Name: The display name of the user being invited.

    • Invited User Email Address: The email address of the user being invited. Required.

    • Send Invitation Message (true/false): true if the an email should be sent to the user; false, otherwise. The default is false.

    • Invite Redirect Url: The URL user should be redirected to once the invitation is redeemed. Required.

    • Invited User Type: The type of the user being invited. By default, this is Guest. You can invite as Member if you are a company administrator.

  • Invited User Message Info

    • Cc Recipient Address: Additional recipient the invitation message should be sent to. The email address of the person or entity. Currently only 1 additional recipient is supported.

    • Cc Recipient Name: Additional recipient the invitation message should be sent to. The display name of the person or entity.

    • Customized Message Body: Customized message body you want to send if you don't want the default message.

    • Message Language: The language you want to send the default message in. If the customizedMessageBody is specified, this property is ignored, and the message is sent using the customizedMessageBody. The language format should be in ISO 639. The default is en-US. Other language codes include: ja, sp, and en. See ISO 639-1 language codes.

Output

  • User

    • Invited User Id: The unique identifier for the invited user.

    • Invitation Id: The unique identifier for the invitation.

    • Invite Redeem Url: The URL that the user can use to redeem their invitation.

    • Invited User Display Name: The display name of the user being invited.

    • Invited User Type: The type of the user being invited. By default, this is Guest.

    • Invited User Email Address: The email address of the user being invited.

    • Send Invitation Message (true/false): true if the an email should be sent to the user; false, otherwise.

    • Invite Redirect Url: The URL that the user should be redirected to once the invitation is redeemed.

    • Status: The status of the invitation. Possible values: PendingAcceptance, Completed, InProgress, and Error

    • Invited User Message Info (object): Additional configuration for the message being sent to the invited user, including customizing message text, language and cc recipient list.

  • Invited User Message Info

    • Cc Recipients (list of objects): Additional recipients that the invitation message should be sent to. Includes the email address and name of the recipients. Currently only 1 additional recipient is supported.

    • Customized Message Body: Customized message body you want to send if you don't want the default message.

    • Message Language: The language you want to send the default message in. If the customizedMessageBody is specified, this property is ignored, and the message is sent using the customizedMessageBody. The language format should be in ISO 639. The default is en-US.

See also