v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB

Goals

Public API

Update Goal Sharing

Replaces the full list of employees this goal is shared with. The provided sharedWithEmployeeIds array must include the goal owner's internal employee ID. Returns the updated goal object.

OAuth Scopes: goal.write

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

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

sharedWithEmployeeIdsinteger[]

List of internal employee IDs with whom the goal is shared. Must include the internal employee ID of the goal owner.

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": {
      "canEditGoalMilestoneProgressBar": true
    }
  }
}