performance
goal

Update a goal

Changed on
patch/performance/{connection_id}/goal/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/performance/{connection_id}/goal/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Goal

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
descriptionstring
user_idsstring[]

HR Employees that own or share this goal; the first element is the primary owner

company_idstring
parent_idstring

id of the parent goal, for goal alignment / OKR trees

cycle_idstring

pointer to the Performance Cycle object (goal cycle or timeframe)

type'INDIVIDUAL' | 'TEAM' | 'DEPARTMENT' | 'COMPANY' | 'OTHER'
status'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'CLOSED' | 'OTHER'
progressnumber

progress percentage from 0 to 100

weightnumber

the weight of this goal when the provider weighs goals in reviews

start_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

due_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

completed_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rawobject

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
descriptionstring
user_idsstring[]

HR Employees that own or share this goal; the first element is the primary owner

company_idstring
parent_idstring

id of the parent goal, for goal alignment / OKR trees

cycle_idstring

pointer to the Performance Cycle object (goal cycle or timeframe)

type'INDIVIDUAL' | 'TEAM' | 'DEPARTMENT' | 'COMPANY' | 'OTHER'
status'NOT_STARTED' | 'IN_PROGRESS' | 'COMPLETED' | 'CLOSED' | 'OTHER'
progressnumber

progress percentage from 0 to 100

weightnumber

the weight of this goal when the provider weighs goals in reviews

start_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

due_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

completed_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

rawobject

Changes

  • 39502239a975Revision changes
    • info

      added the new optional request property

    • info

      added the enum value metadata to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status

  • 021e9b45420aRevision changes
    • info

      endpoint added