🚧

This endpoint uses the w_reviews scope, which must be enabled through the Integrations section found within the Settings menu.

Requires a user token, or an account token together with the member_id query parameter (the edit is recorded against that member). An account token without member_id gets 403 Account tokens need a member_id for this operation. member_id is ignored for user tokens. The caller must be one of the following:

• the reviewee's manager, directly or higher up the reporting line
• the manager assigned to the review aggregate
• a member with permission to manage review cycles

Sets the questionnaire that reviewers of one review type answer for this employee. The first update creates a per-employee follower template of the cycle's master template for that review type, and later updates change it. The master template's own sections are always kept: the sections you send are added to them, and each call replaces the sections added by the previous call. Use GET /review-cycles/:reviewCycleId/tasks/:id/forms/:reviewType to read the current form.

Preconditions:

• The cycle must allow customization of reviewType, and the task must contain at least one review of that type.
• In an active cycle, you cannot edit a form that has already been marked as ready.

After the update, the task is marked as ready automatically once every customizable review type of the task has a customized form. Otherwise it stays in draft, and you can mark it ready with PUT /review-cycles/:reviewCycleId/tasks/:id.

Path parameters

Request body

{
  "questionnaire": {
    "sections": [
      {
        "body": "Goals",
        "position": 0,
        "questions": [
          {
            "body": "What progress has the employee made toward their goals?",
            "position": 0,
            "type": "paragraph"
          },
          {
            "body": "Overall rating",
            "position": 1,
            "type": "star_rated",
            "metadata": {
              "mandatory": true,
              "semantic_type": "overall_rating"
            }
          }
        ]
      }
    ]
  }
}

The request rejects unknown keys.

Results

Returns 200 with the updated reviews of the requested type and the resulting task status.

{
  "reviews": [
    {
      "id": "4d6",
      "type": "manager",
      "status": "ready",
      "master_template_id": "3001",
      "follower_template_id": "spi-manager-follower-template",
      "update_form_url": "/spi/v3/review-cycles/4d6/tasks/4d4/forms/manager"
    }
  ],
  "status": "ready"
}

Error responses