Sign in

v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Goals
Public API

Update Goal (v1)

Deprecated. Use "Update Goal (v1.1)" instead. Update a goal. This version will not update a goal to contain milestones, that functionality is added in version 1.1.

OAuth Scopes: goal.write

put/api/v1/performance/employees/{employeeId}/goals/{goalId}

Path parameters

employeeIdstring required

The internal employee ID of the employee the goal is associated with.

goalIdstring required

goalId is the goal ID for the specified employee.

Request body

titlestring required

[Required] The goal title.

descriptionstring

[Optional] The goal description. If omitted, the existing value will be overwritten with an empty string.

percentCompleteinteger

[Optional] The goal completion percentage (0-100). If omitted, the existing value will be overwritten with 0.

alignsWithOptionIdstring nullable

[Optional] The option ID that aligns with this goal. If omitted, the existing value will be overwritten with null.

sharedWithEmployeeIdsinteger[] required

[Required] Internal employee IDs of employees with whom the goal is shared. All goal owners are considered "shared with". This must include the employee for whom the goal is created.

dueDatestring date required

[Required] The goal due date in YYYY-MM-DD format.

completionDatestring date nullable

[Optional] The date the goal was completed, in YYYY-MM-DD format. Required when percentComplete is 100. If omitted, the existing value will be overwritten with null.

Response

A successful response indicates that all the requested changes were made. The content of the response will be the goal response object for the specified goalId.

Example response

{
  "goal": {
    "id": "4",
    "title": "Complete Documentation Epic",
    "description": "Document every endpoint for the goals API.",
    "percentComplete": 78,
    "dueDate": "2025-12-31",
    "completionDate": "2025-12-17T10:30:00Z",
    "lastChangedDateTime": "2025-12-17T10:30:00Z",
    "status": "in_progress",
    "milestones": [
      {
        "id": 2,
        "employeeGoalId": 12,
        "title": "Sell 15 Doohickeys",
        "completedDateTime": "2025-04-10T15:36:38Z",
        "lastUpdateDateTime": "2025-04-10T15:36:38Z",
        "lastUpdateUserId": 24
      }
    ],
    "actions": {
      "canEditGoalProgressBar": true
    }
  }
}