Users API

Update a user

PUT /api/v1/users/:id

Parameters
NameDescription
id *

Numeric ID of the user

first_name

First name of the user

last_name

Last name of the user

email

Email of the user

enabled

Sets whether the user is enabled

administrator

Sets all administrator roles for the user. Must be 'true' or 'false'.

administrator_roles

Sets individual administrator roles for the user. Options are: 'administer_account', 'administer_billing', 'administer_configuration'. Must be 'true' or 'false'.

Example request

PUT /api/v1/users/1020675218

Example CURL command

curl "https://company.aha.io/api/v1/users/1020675218" -d '{"user":{"first_name":"Sarah","enabled":false}}' -X PUT \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76"

Request

contentType: application/json
accept: application/json
authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76

Request body

Response

Status: 200 OK
contentType: application/json; charset=utf-8

Response body