v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB

Performance > ReviewProcess

Create from templates a Review process

Create a new review process from a template.

post/api/2026-07-01/resources/performance/review_processes/create_from_template

Request body

author_access_idstring required

Access ID to be set as author of the new review process

template_idstring required

Review process template ID

template_type'predefined' | 'custom' required

Type of the template, custom or predefined

namestring

Name of the new review process

Example request

{
  "author_access_id": "1",
  "template_id": "1",
  "template_type": "predefined",
  "name": "Performance Review - Q2 2024"
}

Response

idstring required

Review process ID

company_idstring required

Company ID

namestring

Review process name

descriptionstring

A brief description of the review process

status'draft' | 'scheduled' | 'starting' | 'active' | 'finished' required

Review process status

target_strategyobject

Condition that defines the employees that will be evaluated (participants). Calculated when the review process starts

reviewer_strategiesstring[]

Review types that will be assigned to the review process. It'll be used to create the evaluations when the process starts

starts_atstring

Date when the review process should start

ends_atstring

Date when the review process should end

start_validation_errorsstring[] required

Missing or invalid information to be able to start the review process

archivedboolean required

Whether the review process is archived or not

agreements_configurationobject required

Action plans help track goal progress, and facilitate performance review discussions.

competencies_assessments_configurationobject required

Assess employees based on their assigned competencies through both manager and self-reviews. Ensure roles with designated competencies are properly set up.

last_bulk_reminderstring

Date when the last bulk reminder was sent

cycle_idstring

Performance cycle ID

Example response

{
  "id": "1",
  "company_id": "1",
  "name": "Performance Review - Q1 2024",
  "description": "The performance review for the first quarter of 2024 has started!",
  "status": "draft",
  "target_strategy": {
    "arguments": [],
    "strategy": "all_employees"
  },
  "reviewer_strategies": [
    "self",
    "manager"
  ],
  "starts_at": "2024-01-01T00:00:00.000Z",
  "ends_at": "2024-04-01T00:00:00.000Z",
  "start_validation_errors": [
    "invalid_deadline",
    "missing_target_strategy_members"
  ],
  "agreements_configuration": {
    "enabled": true
  },
  "competencies_assessments_configuration": {
    "enabled": false
  },
  "last_bulk_reminder": "2024-03-01T00:00:00.000Z",
  "cycle_id": "5"
}