Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
assessment

Update an existing assessment

patch/v1/org/{orgId}/assessment/{assessmentId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

assessmentIdstring required

Assessment id

Query parameters

silentboolean required

Suppress notification emails

Request body

labelstring

human-readable label of assessment

slugstring

unique slug of assessment

type'REVIEW' | 'COMP_REVIEW' | 'SURVEY'

type of assessment

fieldsobject

assessment fields (description)

sensitive'GLOBAL' | 'ORG' | 'SENSITIVE' | 'PERSONAL' | 'MANAGER' | 'HIGH' | 'PRIVATE'

view sensitivity of this assessment

colorstring

color of assessment

startDatestring date

Date this assessment begins. In the context of REVIEW goals, the date the review cycle begins.

endDatestring date

Date this assessment ends, or is completed. In the context of REVIEW assessment, the date the review cycle ends.

status'DRAFT' | 'ACTIVE' | 'DONE'

status of this assessment - DRAFT, ACTIVE, DONE

doneAtstring

timestamp when the status of this assessment was set to done

taskCountinteger

number of tasks associated with this assessment

taskDoneCountinteger

number of tasks associated with this assessment that are done

peopleIncludedCountinteger

number of people included in this assessment

querystring

Query for which people/jobs can be included in the review.

showDatesInCalendarboolean

True if user wants dates to show on company calendar

calibrationHighlightedQuestionIdsstring[]

Form questions to highlight during calibration. Only applies to REVIEW assessments.

Example request

{
  "label": "Engineering Budget Q2 2019",
  "slug": "engineering-budget-q2-2019",
  "shareAccess": [
    {
      "userId": "5887a7718f138b6a2a0041a7",
      "groupId": "5887a7718f138b6a2a0041a7",
      "fields": "name,image,title"
    }
  ],
  "doneAt": "2017-01-24T13:57:52Z",
  "calibrationHighlightedQuestionIds": [
    "588f7ee98f138b19220041a7"
  ]
}