Skip to main content

Invite user​

Invite users to an organization, if the user doesn't exists, it will be created and notified. Invitations expire in 7 days

Path Parameters
    orgId string required

    unique id of the organization to which user is invited

Request Body required
    userId string required

    user_id is email id of user who are invited inside the organization. If user is not registered on the platform, it will be notified

    groupIds string[]

    list of group ids to which user needs to be added as a member.

Responses

A successful response.

Schema
    invitation object
    id string

    The unique invitation identifier.

    userId string

    The user email of the invited user.

    orgId string

    The organization id to which the user is invited.

    groupIds string[]

    The list of group ids to which the user is invited.

    metadata object

    The metadata of the invitation.

    createdAt date-time

    The time when the invitation was created.

    expiresAt date-time

    The time when the invitation expires.

Loading...