Sample - Asana API
PUT/roles/{role_gid}

Update a role

Updates an existing role in a workspace. Send only the role fields you want to change and use opt_fields to include additional properties in the response.

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

1 parameter · 1 body field
opt_fieldsarray<string>optional
Comma-separated list of response properties to include, including nested properties such as `permissions.assign_roles`; omit it to use the default response fields.

The updated fields for the role.

dataobjectoptional
Role fields to update; send only the properties you want to change.

6 status codes
200Returns the updated role object.
dataobjectoptional
400Returned when the request is missing required information or contains malformed input.
errorsarray<object>optional
401Returned when the request does not include a valid authentication token.
errorsarray<object>optional
403Returned when the authenticated user does not have permission to update the role.
errorsarray<object>optional
404Returned when the role or requested action does not exist for the specified `role_gid`.
errorsarray<object>optional
500Returned when a server-side problem prevents the role from being updated.
errorsarray<object>optional

Error handling

The request must identify the role with role_gid and include a valid request body. A 400 is returned for missing or malformed data, a 401 when no valid authentication token is provided, and a 403 when the authenticated user lacks access. A 404 indicates that the role or requested action does not exist; 500 indicates a server-side failure.