Sign in
Goals

Create Goal

Add a new Goal to a Workspace.

post/v2/team/{team_id}/goal

Path parameters

team_idnumber required
Example:123

Workspace ID

Request body

namestring required
due_dateinteger required
descriptionstring required
multiple_ownersboolean required
ownersinteger[] required

Array of user IDs.

colorstring required

Example request

{
  "name": "Goal Name",
  "due_date": 1568036964079,
  "description": "Goal Description",
  "multiple_owners": true,
  "owners": [
    183
  ],
  "color": "#32a852"
}

Response

goalGoal required— unresolved $ref

Example response

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

Changes