Update a goal

PUT

/goals/{goal_gid}

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

Returns the complete updated goal record.

Request

Path Params

Body Params application/json

Examples

Responses

🟢200Successfully updated the goal.

application/json

Body

🟠400400

🟠401401

🟠403403

🟠404404

🔴500500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://app.asana.com/api/1.0/goals/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "name": "Grow web traffic by 30%",
        "owner": {
            "name": "Greg Sanchez"
        },
        "due_on": "2019-09-15",
        "followers": [
            {
                "name": "Greg Sanchez"
            }
        ],
        "html_notes": "<body>Start building brand awareness.</body>",
        "is_workspace_level": true,
        "liked": false,
        "metric": {
            "currency_code": "EUR",
            "current_display_value": "8.12",
            "current_number_value": 8.12,
            "initial_number_value": 5.2,
            "precision": 2,
            "target_number_value": 10.2,
            "unit": "none"
        },
        "notes": "Start building brand awareness.",
        "start_on": "2019-09-14",
        "status": "string",
        "team": {
            "name": "Marketing"
        },
        "time_period": {
            "end_on": "2019-09-14",
            "period": "Q1",
            "start_on": "2019-09-13"
        },
        "workspace": {
            "name": "My Company Workspace"
        }
    }
}'

Response Example

200 - Example 1

{
    "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
    }
}

Modified at 2022-09-13 02:00:31

Get a goal

Add a collaborator to a goal