Skip to main content
PUT
Update User

Headers

Accept
string
default:application/json

e.g. application/json

x-api-key
string

e.g. [Required] Partner specific API key provided by Birdeye for data exchange.

x-business-number
string

e.g. [Required] User assosiated businessNumber

Content-Type
string
default:application/json

Media type of the JSON request body.

Query Parameters

userEmailId
string
required

Email id of the user to be updated

entUser
boolean
required

true if the user needs to provide enterprise level access in case of all locations. entUser needs to be passed as true if user needs to be provided access to all locations otherwise by default its false.

Body

application/json
locationsNumberAccess
any[]

Location Numbers list of which the user has access. Must provide full list each time, empty list grants access to all locations.

user
object

user details

userRole
string

Role to assign within the application.

notification
object

user details

Response

OK