Update a user in a workspace or organization

put

https://app.asana.com/api/1.0/workspaces/{workspace_gid}/users/{user_gid}

An existing user can be updated by making a PUT request on the URL for that user in the specified workspace or organization. Only the fields provided in the data block will be updated; any unspecified fields will remain unchanged.

Path Params

workspace_gid

string

required

Globally unique identifier for the workspace or organization.

user_gid

string

required

A string identifying a user. This can either be the string "me", an email, or the gid of a user.

Query Params

opt_fields

array of strings

This endpoint returns a resource which excludes some properties by default. To include those optional properties, set this query parameter to a comma-separated list of the properties you wish to include.

opt_fields

opt_pretty

boolean

Provides “pretty” output. Provides the response in a “pretty” format. In the case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable only to use this during debugging.

Body Params

The user to update.

data

object

A user object represents an account in Asana that can be given access to various workspaces, projects, and tasks.

Responses

Language

Credentials

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully updated the specified user.

400This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.

401A valid authentication token was not provided with the request, so the API could not associate a user with the request.

403The authentication and request syntax was valid but the server is refusing to complete the request. This can happen if you try to read or write to objects or properties that the user does not have access to.

404Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist.

500There was a problem on Asana’s end. In the event of a server error the response body should contain an error phrase. These phrases can be used by Asana support to quickly look up the incident that caused the server error. Some errors are due to server load, and will not supply an error phrase.