ZRM Docs
API ReferenceUser

user.createWithInvite

Type: Mutation · Auth: Admin only

Input

FieldTypeRequiredDefaultDescription
emailstring.emailYesEmail
namestringYesName
globalRoleenum(admin, field_supervisor, sales_rep, technician, accounting, customer_service, tech_support, viewer)YesGlobal role
phonestringNoPhone
notesstringNoNotes
avatarS3KeystringNoAvatar s3key
workspaceIdsstring[]YesWorkspace ids
defaultWorkspaceIdstring.uuidYesID of the associated default workspace

Example

{
  "email": "user@example.com",
  "name": "Example Name",
  "globalRole": "admin",
  "phone": "(555) 555-0100",
  "notes": "Additional notes",
  "avatarS3Key": "example",
  "workspaceIds": [],
  "defaultWorkspaceId": "550e8400-e29b-41d4-a716-446655440000"
}

On this page