REQUEST
Full name of the user. Required.Example:
"John Doe"
, "Sarah Johnson"
Username for login, typically an email address. Required.Must be unique across the platform. If this username already exists in your company, the existing member will be reactivated instead of creating a duplicate.Example:
"worker@company.com"
Initial password for the account. Optional.
- If provided: Member can log in immediately with this password
- If omitted: Member receives an invitation via email or SMS to set their own password
Role determines the user’s permissions. Optional, defaults to “worker”.Available roles:
"worker"
- Field worker with basic permissions (default)"operator"
or"dispatcher"
- Dispatcher with management capabilities"administrator"
or"admin"
- Full administrative access
Phone number for the user. Optional.Used for SMS invitations (if password not set) and contact purposes.Format: Include country code, e.g.,
"+14155551234"
Account Reactivation
If you create a member with ausername
that already exists and was previously part of your company:
- The existing account will be reactivated instead of creating a new one
- Previous data and history are preserved
- The member is automatically re-added to your organization
Automatic Invitation
After creating a member:- If
password
was not provided: An invitation is automatically sent via email (if email username) or SMS (if phone provided) - The invitation allows the new member to set their own password and complete onboarding
- Company members list is automatically updated via push notifications
Permissions
- Only administrators and company owners can create new members
- Workers and dispatchers cannot create accounts
RESPONSE
Status code.
0
indicates success.Unique identifier of the newly created (or reactivated) member. Use this UID for subsequent API calls.
Complete member object with all properties initialized. See the Member API Object for full structure.
Examples
Complete Field Reference: See the Member API Object for documentation of all properties in the returned member object.
Best Practice: Don’t set the
password
field. Let new members receive an invitation and set their own password for better security and user experience.Related Endpoints
- Get Members - Retrieve member information
- Edit Member - Update member properties
- Delete Member - Remove members