latestOpenAPI 3.1.02026-07-24172151607.6 KB

72216f55b952

Goals

Update Goal

Rename a Goal, set the due date, replace the description, add or remove owners, and set the Goal color.

put/v2/goal/{goal_id}

Path parameters

goal_idstring required

Example:e53a033c

900e-462d-a849-4a216b06d930 (uuid)

Request body

namestring required

due_dateinteger required

descriptionstring required

rem_ownersinteger[] required

Array of user IDs.

add_ownersinteger[] required

Array of user IDs.

colorstring required

Example request

{
  "name": "Updated Goal Name",
  "due_date": 1568036964079,
  "description": "Updated Goal Description",
  "rem_owners": [
    183
  ],
  "add_owners": [
    184
  ],
  "color": "#32a852"
}

Response

goalGoal required— unresolved $ref

Example response

{
  "goal": {
    "id": "e53a033c-900e-462d-a849-4a216b06d930",
    "name": "Updated Goal Name",
    "team_id": "512",
    "date_created": "1568044355026",
    "start_date": null,
    "due_date": "1568036964079",
    "description": "Updated Goal Description",
    "private": false,
    "archived": false,
    "creator": 183,
    "color": "#32a852",
    "pretty_id": "6",
    "multiple_owners": true,
    "folder_id": null,
    "members": [],
    "owners": [
      {
        "id": 182,
        "username": "Jane Doe",
        "initials": "JD",
        "email": "janedoe@gmail.com",
        "color": "#827718",
        "profilePicture": "https://attachments-public.clickup.com/profilePictures/182_abc.jpg"
      }
    ],
    "key_results": [],
    "percent_completed": 0,
    "history": [],
    "pretty_url": "https://app.clickup.com/512/goals/6"
  }
}