COcontextualai
/users

Invite Users

Changed on

Invite users to the tenant. This checks if the user is already in the tenant and if not, creates the user. We will return a list of user emails that were successfully created (including existing users).

post/users

Request

  • Base URL
    https://api.contextual.ai/v1
  • URL
    https://api.contextual.ai/v1/users
  • Auth
    HTTP bearer

Request body

tenant_short_namestring required

The short name of the tenant

Response

Successful Response

invited_user_emailsstring[] required

List of emails of the invited users

error_detailsobject required

Details of the errors occurred while inviting users, where keys are the emails and values are the error messages

Changes

  • 4abdda722de9Revision changes
    • warning

      removed the request property //

    • warning

      removed the request property //

  • c8152db45500Revision changes
    • info

      added the new CONTEXTUAL_ADMIN enum value to the request property ///

    • info

      added the new CUSTOMER_ADMIN enum value to the request property ///

    • info

      added the new CUSTOMER_USER enum value to the request property ///