Update a user
PUT/v1/businesses/{businessId}/users
Updates a user on the business. The user is identified by the email
in the body. The email itself is fixed and can't be changed.
This is a full replace of the editable fields (name and role) — send them all; omitting one is not a partial update.
The business must have completed verification (ACTIVE or
INACTIVE); one still UNDER_REVIEW or in NEEDS_ATTENTION, or one
being shut down, returns 409.
Path Parameters
The ID of the business, assigned by Hiya.
9b8a1c4e-2c0f-4f3d-9a1e-7b3a2b4c6d8fHeader Parameters
Your own correlation ID for this call, returned as
requestId
400
INVALID_HEADER
Possible values: <= 200 characters, Value must match regular expression ^[A-Za-z0-9._:/+=@-]+$
job-2f9c1a7e-0042Body
required
Responses
- 200
- 400
- 401
- 404
- 409
- 500
User updated. Returns the updated user.
Response Body
The request is invalid — a missing required field, a field that
fails validation (such as an unknown role or a name longer than
100 characters), or an X-Hiya-Request-Id header that doesn't
match its pattern.
Response Body
The API key is missing or invalid.
Response Body
No business with that ID exists, or it isn't one of yours — the two
are indistinguishable by design — or no user with that email is
on the business.
Response Body
The business isn't in a state that allows this change — it hasn't
completed verification, or it is being shut down. Returned as
CONFLICT; the message says which case applies.
Response Body
Something went wrong on our side.
Response Body