Skip to main content

Update invitation

PATCH 
/invitation/:invitationId

Updates the information about the invitation.

Request​

Path Parameters

    invitationId stringrequired

    The invitation ID.

    Example: invite-100001

Query Parameters

    autoSend boolean

    Default value: true

    Whether to automatically send the invitation ID by email. If you set it to true, you also need to configure the inviteLink 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.

    Example: true
    inviteLink 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 autoSend parameter is set to true.

    Example: https://zbyte.com/acceptInvitation/${invitationId}

Header Parameters

    x-maxone-role-id string

Responses​

OK

Schema

    code int32

    The response code.

    data object

    The wrapped responding data.

    msg string

    The response message.

Loading...