Skip to main content

Create a user

POST 
/api/v1/domains/:domain_uuid/users

Creates a local FS PBX user in the specified account. Use this endpoint to add a staff member or administrator who will sign in to the FS PBX web interface. Returns the created user's profile and user_uuid, which can be used to retrieve, update, or delete the user.

Only first_name and user_email are required. You can also assign an existing extension and roles to configure the user's access. No role is assigned automatically. If groups is supplied, it must contain at least one existing role UUID. The domain in the URL owns the new user. Password setup is a separate step: call Send a password reset email for the new user_uuid to let the user choose their password. Creating the user does not send an email or set or return a password.

Requires domain access and user_add. Role assignments require user_group_edit and cannot exceed the caller's role level. Only superadmins may assign the superadmin role. Disabled creation requires user_status. Account assignments require their corresponding management permissions. The domain's user limit is enforced.

Request​

Responses​