Sample - Asana API
PUT/users/{user_gid}

Update a user

Updates an existing user's account fields. Supply the fields to change inside the data object; fields you omit remain unchanged. A successful response contains the complete updated user record.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter · 1 body field
opt_fieldsarray<string>optional
Comma-separated properties to include in the response, including supported nested custom-field properties such as `custom_fields.date_value.date` and `custom_fields.enum_value.name`; omit this parameter to use the default response fields.

User fields to update. Only properties supplied in the data object are changed; omitted properties retain their existing values.

dataobjectoptional
The user attributes to update, including supported fields such as `name` and `custom_fields`.

6 status codes
200Returns the complete updated user record.
dataobjectoptional
400Returned when a parameter is missing or malformed.
errorsarray<object>optional
401Returned when a valid authentication token was not provided with the request.
errorsarray<object>optional
403Returned when the authenticated user does not have access to the specified user or requested properties.
errorsarray<object>optional
404Returned when the request method and path do not specify a known action or the specified user does not exist.
errorsarray<object>optional
500Returned when the API encounters a server-side problem; the response may include an error phrase for support investigation.
errorsarray<object>optional

Error handling

A 400 is returned when a parameter is missing or malformed. A 401 is returned when the request does not include a valid authentication token, a 403 when the authenticated user cannot access the user or requested properties, a 404 when the user or request action does not exist, and a 500 when the API encounters a server-side problem. Use supported property names in opt_fields, including the documented nested custom-field properties, when requesting additional response fields.