Users

Invite a new user

Creates a new user (if they don't exist yet) and adds them to your organization. If the email already belongs to a user, that user is added and their given/family names are updated to the supplied values.

post/org/users/invite

Request

  • Base URL
    https://apiv2.senso.ai/api/v1
  • Auth
    API key in header X-API-Key

Request body

emailstring email required
given_namestring required
family_namestring required
role_idstring uuid required

The role to assign. Get valid role ids from GET /org/roles.

is_currentboolean

Whether to make this the user's current org. Forced true if the user has no current org.

Response

The created membership.

org_user_idstring uuid required
org_idstring uuid required
user_idstring uuid required
role_idstring uuid required

The role assigned to the user in this org.

is_currentboolean required

Whether this org is the user's currently selected org.

namestring

Org name — populated only by org-switcher list endpoints, absent here.

slugstring

Org slug — populated only by org-switcher list endpoints, absent here.

logo_urlstring

Org logo URL — populated only by org-switcher list endpoints, absent here.

created_atstring date-time required
updated_atstring date-time required
deleted_atstring date-time

When the membership was deleted; absent while it is active.

Changes

No recorded changes to this operation across all 1 revision of this API.