> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.cloudraker.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cloudraker.com/_mcp/server.

# Update a template

PATCH /api/templates/{id}
Content-Type: application/json

Patches a template's name, description, binding, or sample data (the slug is immutable). A binding change on a DOCX/Liquid template re-lints and bumps the version. Requires `playbook:create`.

Reference: https://docs.cloudraker.com/api/raker-one-api/templates/patch-templates-by-id

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: RakerOne API
  version: 1.0.0
paths:
  /templates/{id}:
    patch:
      operationId: patch-templates-by-id
      summary: Update a template
      description: >-
        Patches a template's name, description, binding, or sample data (the
        slug is immutable). A binding change on a DOCX/Liquid template re-lints
        and bumps the version. Requires `playbook:create`.
      tags:
        - subpackage_templates
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: Authorization
          in: header
          description: >-
            WorkOS session JWT or an organization API key, sent as
            `Authorization: Bearer <token>`.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: The updated template.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TemplateResponse'
        '400':
          description: Bad request — the body or parameters failed validation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized — missing or invalid bearer token.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden — the caller lacks the required permission.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '409':
          description: The template is archived — restore it before editing.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonObject'
        '422':
          description: The binding didn't resolve or the engine rejected the template.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonObject'
        '503':
          description: The document engine is temporarily unavailable.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/JsonObject'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                description:
                  type: string
                binding:
                  $ref: >-
                    #/components/schemas/TemplatesIdPatchRequestBodyContentApplicationJsonSchemaBinding
                sampleData:
                  type:
                    - object
                    - 'null'
                  additionalProperties:
                    description: Any type
servers:
  - url: /api
    description: Current origin
  - url: https://app.raker.one/api
    description: Production
components:
  schemas:
    TemplatesIdPatchRequestBodyContentApplicationJsonSchemaBinding0:
      type: object
      properties:
        kind:
          type: string
          enum:
            - record-type
        objectDefinitionId:
          type: string
      required:
        - kind
        - objectDefinitionId
      title: TemplatesIdPatchRequestBodyContentApplicationJsonSchemaBinding0
    TemplatesIdPatchRequestBodyContentApplicationJsonSchemaBinding1:
      type: object
      properties:
        kind:
          type: string
          enum:
            - unbound
      required:
        - kind
      title: TemplatesIdPatchRequestBodyContentApplicationJsonSchemaBinding1
    TemplatesIdPatchRequestBodyContentApplicationJsonSchemaBinding:
      oneOf:
        - $ref: >-
            #/components/schemas/TemplatesIdPatchRequestBodyContentApplicationJsonSchemaBinding0
        - $ref: >-
            #/components/schemas/TemplatesIdPatchRequestBodyContentApplicationJsonSchemaBinding1
      title: TemplatesIdPatchRequestBodyContentApplicationJsonSchemaBinding
    TemplateKind:
      type: string
      enum:
        - docx-liquid
        - pdf-form
      title: TemplateKind
    TemplateFormModality:
      type: string
      enum:
        - pdf-acroform
        - pdf-flat
        - image
      title: TemplateFormModality
    JsonObject:
      type: object
      additionalProperties:
        description: Any type
      description: An arbitrary JSON object.
      title: JsonObject
    TemplateScope:
      type: string
      enum:
        - library
        - action
      title: TemplateScope
    TemplateStatus:
      type: string
      enum:
        - draft
        - active
        - archived
      title: TemplateStatus
    TemplateLint:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/JsonObject'
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/JsonObject'
      required:
        - errors
        - warnings
      title: TemplateLint
    Template:
      type: object
      properties:
        _id:
          type: string
        kind:
          $ref: '#/components/schemas/TemplateKind'
        formModality:
          oneOf:
            - $ref: '#/components/schemas/TemplateFormModality'
            - type: 'null'
        formFields:
          type: array
          items:
            $ref: '#/components/schemas/JsonObject'
        detection:
          oneOf:
            - $ref: '#/components/schemas/JsonObject'
            - type: 'null'
        scope:
          $ref: '#/components/schemas/TemplateScope'
        actionDefinitionId:
          type:
            - string
            - 'null'
        slug:
          type: string
        name:
          type: string
        description:
          type: string
        status:
          $ref: '#/components/schemas/TemplateStatus'
        version:
          type: number
          format: double
        file:
          $ref: '#/components/schemas/JsonObject'
        binding:
          $ref: '#/components/schemas/JsonObject'
        variables:
          type: array
          items:
            $ref: '#/components/schemas/JsonObject'
        lint:
          $ref: '#/components/schemas/TemplateLint'
        sampleData:
          oneOf:
            - $ref: '#/components/schemas/JsonObject'
            - type: 'null'
        archivedAt:
          type:
            - string
            - 'null'
        createdAt:
          type: string
        updatedAt:
          type: string
        createdBy:
          type: string
      required:
        - _id
        - kind
        - formModality
        - formFields
        - detection
        - scope
        - actionDefinitionId
        - slug
        - name
        - description
        - status
        - version
        - file
        - binding
        - variables
        - lint
        - sampleData
        - archivedAt
        - createdAt
        - updatedAt
        - createdBy
      title: Template
    TemplateResponse:
      type: object
      properties:
        template:
          $ref: '#/components/schemas/Template'
      required:
        - template
      title: TemplateResponse
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
          description: Machine-readable error code (e.g. `invalid_body`, `not_found`).
        issues:
          type: array
          items:
            description: Any type
          description: Schema-validation issues, present when `error` is `invalid_body`.
      required:
        - error
      description: Standard API error response.
      title: ErrorResponse
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        WorkOS session JWT or an organization API key, sent as `Authorization:
        Bearer <token>`.

```

## Examples



**Request**

```json
{}
```

**Response**

```json
{
  "template": {
    "_id": "tmpl_9f8b7c6d5e4a3b2c1d0e",
    "kind": "docx-liquid",
    "formModality": "pdf-acroform",
    "formFields": [
      {}
    ],
    "detection": {},
    "scope": "library",
    "actionDefinitionId": "act_1234567890abcdef",
    "slug": "employee-onboarding-template",
    "name": "Employee Onboarding Document",
    "description": "Template for onboarding new employees, including contract and policy acknowledgments.",
    "status": "draft",
    "version": 1.1,
    "file": {},
    "binding": {},
    "variables": [
      {}
    ],
    "lint": {
      "errors": [
        {}
      ],
      "warnings": [
        {}
      ]
    },
    "sampleData": {},
    "archivedAt": "null",
    "createdAt": "2024-05-10T09:15:00Z",
    "updatedAt": "2024-06-01T12:00:00Z",
    "createdBy": "user_7a8b9c0d1e2f3g4h5i6j"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api/templates/id"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api/templates/id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api/templates/id"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api/templates/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api/templates/id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api/templates/id', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api/templates/id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api/templates/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```