Skip to main content

Create invitations

POST 
/unit/invitation

Invites others to create DW users in the service unit.

Request​

Query Parameters

    notify boolean

    Whether to automatically send the invitation ID by email. If you set it to true, you also need to configure the landingPage parameter to include the invitation ID in the invitation link. If you set it to false, you can send the invitation ID to the invitee through any means that suits your needs.

    landingPage string

    The invitation link. The default value is "https://zbyte.com/acceptInvitation/${invitationId}", where ${invitationId} is a placeholder that will be automatically replaced with the invitation ID upon the invitation email sending. You can place ${invitationId} in any part of the URL. This parameter is required only when the notify parameter is set to true.

Body

array

required

  • Array [

    • email stringrequired

    The email address.

  • ]

Responses​

OK

Schema

    code int32

    The response code.

    data string[]

    The wrapped responding data.

    msg string

    The response message.

Loading...