WorkspaceWorkspaceInvites

Invitar usuario

Envía una invitación por correo electrónico para unirse a tu espacio de trabajo a la dirección proporcionada. Si el usuario no tiene una cuenta, se le pedirá que cree una. Si acepta esta invitación, se añadirá como usuario a tu espacio de trabajo y a tu suscripción, utilizando una de tus plazas. Esta ruta de API solo puede ser llamada por miembros del espacio de trabajo con el permiso WORKSPACE_MEMBERS_INVITE. Si el usuario ya está en el espacio de trabajo, se devolverá un error 400.

Encabezados

xi-api-keystringOpcional

Solicitud

This endpoint expects an object.
emailstringRequerido

El correo electrónico del cliente

seat_typeenum or nullOpcional
El tipo de puesto del usuario
Valores permitidos:
group_idslist of strings or nullOpcional
Los ID de grupo del usuario
usage_limitinteger or nullOpcional>=0

Límite mensual de uso de créditos para la persona invitada. Omítelo o establécelo en null para no aplicar un límite personalizado.

workspace_permissionstring or nullOpcionalDeprecated

El permiso del espacio de trabajo del usuario. Está obsoleto; utiliza seat_type en su lugar.

Respuesta

Respuesta correcta.
statusstring

El estado de la solicitud de invitación al espacio de trabajo. Si la solicitud se realiza correctamente, el estado será ‘ok’. De lo contrario, se devolverá un mensaje de error con estado 500.

Errores

422
Unprocessable Entity Error