Asana API
Getting access, Developing, Testing
Back to Asana
Update A Team
Updates a team within the current workspace.
Input
type: object
properties:
parameters:
type: object
properties:
opt_pretty:
type: boolean
description: >-
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.
opt_fields:
type: array
items:
type: string
description: >-
Defines fields to return.
Some requests return *compact* representations of objects in order to
conserve resources and complete the request more efficiently. Other
times requests return more information than you may need. This option
allows you to list the exact set of fields that the API should be sure
to return for the objects. The field names should be provided as
paths, described below.
The id of included objects will always be returned, regardless of the
field options.
limit:
type: integer
description: >-
Results per page.
The number of objects to return per page. The value must be between 1
and 100.
offset:
type: string
description: >-
Offset token.
An offset to the next page returned by the API. A pagination request
will return an offset token, which can be used as an input parameter
to the next request. If an offset is not passed in, the API will
return the first page of results.
'Note: You can only pass in an offset that was returned to you via a
previously paginated request.'
title: Parameters
data:
type: object
properties:
data:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: The name of the team.
type: string
example: Marketing
description:
description: |
The description of the team.
type: string
example: All developers should be members of this team.
html_description:
description: |
The description of the team with formatting as HTML.
type: string
example: >-
<body><em>All</em> developers should be members of this
team.</body>
organization:
type: string
description: >
The organization/workspace the team belongs to. This must be the
same organization you are in and cannot be changed once set.
example: '123456789'
visibility:
description: |
The visibility of the team to users in the same organization
type: string
enum:
- secret
- request_to_join
- public
edit_team_name_or_description_access_level:
description: |
Controls who can edit team name and description
type: string
enum:
- all_team_members
- only_team_admins
edit_team_visibility_or_trash_team_access_level:
description: |
Controls who can edit team visibility and trash teams
type: string
enum:
- all_team_members
- only_team_admins
member_invite_management_access_level:
description: |
Controls who can accept or deny member invites for a given team
type: string
enum:
- all_team_members
- only_team_admins
guest_invite_management_access_level:
description: |
Controls who can accept or deny guest invites for a given team
type: string
enum:
- all_team_members
- only_team_admins
join_request_management_access_level:
description: >
Controls who can accept or deny join team requests for a
Membership by Request team
type: string
enum:
- all_team_members
- only_team_admins
team_member_removal_access_level:
description: |
Controls who can remove team members
type: string
enum:
- all_team_members
- only_team_admins
title: Data
Output
type: object
properties:
data:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: The name of the team.
type: string
example: Marketing
description:
description: |
[Opt In](/docs/inputoutput-options). The description of the team.
type: string
example: All developers should be members of this team.
html_description:
description: >
[Opt In](/docs/inputoutput-options). The description of the team with
formatting as HTML.
type: string
example: <body><em>All</em> developers should be members of this team.</body>
organization:
type: object
properties:
gid:
description: Globally unique identifier of the resource, as a string.
type: string
readOnly: true
example: '12345'
x-insert-after: false
resource_type:
description: The base type of this resource.
type: string
readOnly: true
example: task
x-insert-after: gid
name:
description: The name of the workspace.
type: string
example: My Company Workspace
permalink_url:
type: string
readOnly: true
description: A url that points directly to the object within Asana.
example: https://app.asana.com/0/resource/123456789/list
visibility:
description: |
The visibility of the team to users in the same organization
type: string
enum:
- secret
- request_to_join
- public
edit_team_name_or_description_access_level:
description: |
Controls who can edit team name and description
type: string
enum:
- all_team_members
- only_team_admins
edit_team_visibility_or_trash_team_access_level:
description: |
Controls who can edit team visibility and trash teams
type: string
enum:
- all_team_members
- only_team_admins
member_invite_management_access_level:
description: |
Controls who can accept or deny member invites for a given team
type: string
enum:
- all_team_members
- only_team_admins
guest_invite_management_access_level:
description: |
Controls who can accept or deny guest invites for a given team
type: string
enum:
- all_team_members
- only_team_admins
join_request_management_access_level:
description: >
Controls who can accept or deny join team requests for a Membership by
Request team
type: string
enum:
- all_team_members
- only_team_admins
team_member_removal_access_level:
description: |
Controls who can remove team members
type: string
enum:
- all_team_members
- only_team_admins