Add a collaborator to a goal

Adds followers to a goal. Returns the goal the followers were added to.
Each goal can be associated with zero or more followers in the system.
Requests to add/remove followers, if successful, will return the complete updated goal record, described above.

curl --location --request POST 'https://app.asana.com/api/1.0/goals//addFollowers' \ --header 'Content-Type: application/json' \ --data-raw '{ "data": { "followers": [ "13579", "321654" ] } }'

{ "data": { "gid": "12345", "resource_type": "task", "name": "Grow web traffic by 30%", "owner": { "gid": "12345", "resource_type": "task", "name": "Greg Sanchez" }, "due_on": "2019-09-15", "followers": [ { "gid": "12345", "resource_type": "task", "name": "Greg Sanchez" } ], "html_notes": "<body>Start building brand awareness.</body>", "is_workspace_level": true, "liked": false, "metric": { "gid": "12345", "resource_type": "task", "currency_code": "EUR", "current_display_value": "8.12", "current_number_value": 8.12, "initial_number_value": 5.2, "precision": 2, "resource_subtype": "number", "target_number_value": 10.2, "unit": "none" }, "notes": "Start building brand awareness.", "start_on": "2019-09-14", "status": "string", "team": { "gid": "12345", "resource_type": "task", "name": "Marketing" }, "time_period": { "gid": "12345", "resource_type": "task", "end_on": "2019-09-14", "period": "Q1", "start_on": "2019-09-13" }, "workspace": { "gid": "12345", "resource_type": "task", "name": "My Company Workspace" }, "likes": [ { "gid": "12345", "user": { "gid": "12345", "resource_type": "task", "name": "Greg Sanchez" } } ], "num_likes": 5 } }

Request

Path Params

goal_gid

string

required

Automatically added

Body Params application/json

data

object (TaskAddFollowersRequest)

optional

followers

array[string]

required

An array of strings identifying users. These can either be the string "me", an email, or the gid of a user.

Example:

["13579","321654"]

Examples

Responses

🟢201Successfully added users as collaborators.

application/json

Body

data

object (GoalResponse)

optional

A generic Asana Resource, containing a globally unique identifier.

likes

array[object (Like) {2}]

read-onlyoptional

Array of likes for users who have liked this goal.

num_likes

integer

read-onlyoptional

The number of users who have liked this goal.

Example:

due_on

string | null

optional

The localized day on which this goal is due. This takes a date with format YYYY-MM-DD.

Example:

2019-09-15

followers

array[object (UserCompact) {3}]

optional

Array of users following this goal.

html_notes

string

optional

The notes of the goal with formatting as HTML.

Example:

<body>Start building brand awareness.</body>

is_workspace_level

boolean

optional

Conditional. This property is only present when the workspace provided is an organization. Whether the goal belongs to the workspace (and is listed as part of the workspace’s goals) or not. If it isn’t a workspace-level goal, it is a team-level goal, and is associated with the goal’s team.

Example:

true

liked

boolean

optional

True if the goal is liked by the authorized user, false if not.

Example:

false

metric

object

optional

A generic Asana Resource, containing a globally unique identifier.

notes

string

optional

Free-form textual information associated with the goal (i.e. its description).

Example:

Start building brand awareness.

start_on

string | null

optional

The day on which work for this goal begins, or null if the goal has no start date. This takes a date with YYYY-MM-DD format, and cannot be set unless there is an accompanying due date.

Example:

2019-09-14

status

string | null

optional

The current status of this goal. When the goal is open, its status can be green, yellow, and red to reflect "On Track", "At Risk", and "Off Track", respectively. When the goal is closed, the value can be missed, achieved, partial, or dropped.

team

object

optional

Conditional. This property is only present when the workspace provided is an organization.

time_period

object

optional

A generic Asana Resource, containing a globally unique identifier.

workspace

object

optional

A workspace is the highest-level organizational unit in Asana. All projects and tasks have an associated workspace.

gid

string

read-onlyoptional

Globally unique identifier of the resource, as a string.

Example:

12345

resource_type

string

read-onlyoptional

The base type of this resource.

Example:

task

name

string

optional

The name of the goal.

Example:

Grow web traffic by 30%

owner

object

optional

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

🟠400400

🟠401401

🟠402402

🟠403403

🟠404404

🔴500500