Documentation Index

Fetch the complete documentation index at: https://docs.restaurant365.com/llms.txt

Use this file to discover all available pages before exploring further.

/public/v1/user-management/users

  • Published on Jun 17, 2026
  • 3 minute(s) read
Prev Next
Post
/public/v1/user-management/users

Creates one or more users. Returns 207 Multi-Status when some users were created and others failed. Returns 409 Conflict for duplicate usernames or emails, and 422 for invalid field values.

Security
HTTP
Type Bearer

Put ONLY your JWT Bearer token on textbox below!

Body parameters
Array of object
object
fullName
string
username
string
defaultLocation
string (uuid)
email
string
managedByBrand
string | null
mobileNumber
string | null
allLocationsAccess
boolean | null
allBrandFranchiseeLocationAccess
boolean | null
canGrantAccessBeyondPersonalLevel
boolean
inActive
boolean | null
userRoles
Array of object (R365.Public.Models.GuidId)
object
id
string (uuid)

Unique identifier of the guid id.

locations
Array of object (R365.Public.Models.GuidId) | null
object
id
string (uuid)

Unique identifier of the guid id.

externalLocations
Array of object (R365.Netcore.Public.Contracts.Users.Models.ExternalLocationReference) | null
object
id
string (uuid)

Unique identifier of the external location.

tenant
string
reportRoles
Array of object (R365.Public.Models.GuidId) | null
object
id
string (uuid)

Unique identifier of the guid id.

optionIds
Array of object (R365.Netcore.Contracts.Users.Models.EntityReferenceLongPost) | null
object
id
integer (int64)

Unique identifier of the entity reference long post.

Responses
200

Users created successfully.

Expand All
object
success
Array of object (R365.Netcore.Public.Contracts.Users.UserCreated)
object
id
string (uuid)

Unique identifier of the user created.

username
string
userErrors
Array
Example[]
207

207 Multi-Status – Partial success: the response contains arrays of created users and of errors for those that could not be created.

Expand All
object
success
Array of object (R365.Netcore.Public.Contracts.Users.UserCreated)
object
id
string (uuid)

Unique identifier of the user created.

username
string
errors
Array of object (R365.Netcore.Public.Contracts.Users.UserErrors)
object
username
string
errors
Array of object (R365.Netcore.Public.Contracts.Users.ErrorMessage)
object
error
string | null
errorCode
string | null
400

Bad request, more than one validation errors occurred.

Expand All
object
success
Array
Example[]
userErrors
Array of object (R365.Netcore.Public.Contracts.Users.UserErrors)
object
username
string
errors
Array of object (R365.Netcore.Public.Contracts.Users.ErrorMessage)
object
error
string | null
errorCode
string | null
404

Not Found – one or more requested resources could not be located.

Expand All
object
success
Array
Example[]
userErrors
Array of object (R365.Netcore.Public.Contracts.Users.UserErrors)
Example[ { "message": "The following role IDs do not exist: [172cb15b-131e-43d3-83af-c5016c1b858f]", "errorCode": "urn:r365:user:roles-not-found" }, { "message": "The following location IDs do not exist: [172cb15b-131e-43d3-83af-c5016c1b858f]", "errorCode": "urn:r365:user:locations-not-found" }, { "message": "The following externalLocation IDs do not exist: [172cb15b-131e-43d3-83af-c5016c1b858f]", "errorCode": "urn:r365:user:external-locations-not-found" }, { "message": "The following reportRole IDs do not exist: [172cb15b-131e-43d3-83af-c5016c1b858f]", "errorCode": "urn:r365:user:report-roles-not-found" }, { "message": "The specified value for field 'defaultLocation' is unknown", "errorCode": "urn:r365:user:default-location-not-found" }, { "message": "The following Options IDs do not exist: [45, 32]", "errorCode": "urn:r365:user:options-not-found" } ]
object
username
string
errors
Array of object (R365.Netcore.Public.Contracts.Users.ErrorMessage)
object
error
string | null
errorCode
string | null
409

Conflict – the request could not be completed due to a conflict with the current state of the resource.

Expand All
object
success
Array
Example[]
userErrors
Array of object (R365.Netcore.Public.Contracts.Users.UserErrors)
Example[ { "message": "The specified value 'jack' for field 'username' already in use", "errorCode": "urn:r365:user:username-conflict" }, { "message": "The specified value 'user@email.net' for field 'email' already in use", "errorCode": "urn:r365:user:email-conflict" }, { "message": "No access to delete locations granted from option", "errorCode": "urn:r365:user:no-access-to-delete-locations-by-options" }, { "message": "Users with Full Access, All Locations and All Reports must have the grant access beyond personal level set to True", "errorCode": "urn:r365::grant-beyond-personal-level-must-be-true" }, { "message": "Cannot set grant access beyond personal level to true when user does not have permission to edit users or roles", "errorCode": "urn:r365::insufficient-permissions" } ]
object
username
string
errors
Array of object (R365.Netcore.Public.Contracts.Users.ErrorMessage)
object
error
string | null
errorCode
string | null
422

Unprocessable Entity: The request was well-formed but contains semantic errors and could not be processed.

Expand All
object
success
Array
Example[]
userErrors
Array of object (R365.Netcore.Public.Contracts.Users.UserErrors)
Example[ { "message": "Field 'fullName' is required", "errorCode": "urn:r365:user:fullname-required" }, { "message": "Field 'username' is required", "errorCode": "urn:r365:user:fullname-required" }, { "message": "Field 'email' is required", "errorCode": "urn:r365:user:email-required" }, { "message": "Field 'defaultLocation' is required", "errorCode": "urn:r365:user:default-location-required" }, { "message": "Field 'userRoles' is required", "errorCode": "urn:r365:user:role-required" }, { "message": "The specified value for field 'canGrantAccessBeyondPersonalLevel' is invalid", "errorCode": "urn:r365:user:can-grant-access-beyond-personal-level-invalid-value" } ]
object
username
string
errors
Array of object (R365.Netcore.Public.Contracts.Users.ErrorMessage)
object
error
string | null
errorCode
string | null