/review-cycles/templates

Changed on

Creates a performance review master template for the account. Required scope: w_reviews. Requires a user token with permission to manage performance templates, or an account token with the member_id of such a member; an account token without member_id gets 403.

The questionnaire is normalised before being persisted — position is auto-assigned when omitted, and type and metadata.semantic_type accept either snake_case (e.g. star_rated) or PascalCase (e.g. StarRated). Unknown keys are rejected. The response is returned in snake_case.

post/review-cycles/templates

Request

  • Base URL
    https://subdomain.workable.com/spi/v3
  • URL
    https://subdomain.workable.com/spi/v3/review-cycles/templates
  • Auth
    API key in header Authorization

Query parameters

member_idstring

Required when using an account token: the member (SPI key, from GET /members) to act as. The request is evaluated with that member's permissions; without it the request gets 403. Ignored for user tokens.

Request body

titlestring required

Title of the template

Response

201

idstring

Master template id

titlestring
updated_atstring nullable

ISO 8601 timestamp of the last update in the template registry

versioninteger
defaultboolean

Whether this is one of Workable's default templates

sampleboolean

Whether this is a sample template. Not returned by the create endpoint

disabledboolean

Whether the template is disabled

Example response

{
  "id": "template-spi-review-1",
  "title": "SPI Review Q1",
  "version": 1
}

Changes

    • info

      added the new optional query request parameter member_id

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status