Admin Management - Users

Invite Users

Invite users to a tenant. Accepts JSON array of users. Requires tenant_id in HashID format.

post/admin/users/invite

Request

  • Base URL: https://ai.hatz.ai/v1
  • URL: https://ai.hatz.ai/v1/admin/users/invite
  • Auth: API key in header X-API-Key

Request body

tenant_idstring required

Tenant HashID

Response

Successful Response

messagestring required

Success message

total_new_users_createdinteger nullable

Number of new users successfully created

total_existing_users_addedinteger

Number of users who already had a Hatz account and were added to the entity

total_new_users_failedinteger nullable

Number of new users that failed to create

new_users_failed_emailsstring[] nullable

Email addresses of users that failed

resultsobject[] nullable

Per-user results with any errors

Changes

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