Update a firm template

PATCH /api/v1/advisory-firms/{firm_id}/templates/{template_id}

Operation ID: update_firm_template_api_v1_advisory_firms__firm_id__templates__template_id__patch · View as markdown · OpenAPI slice

Authentication

Bearer token authentication. Pass your DayZero API token in the Authorization header and the target business UUID in x-business-id.

Parameters

Path

firm_id string required
template_id string required

Request body

Schema: FirmTemplateUpdate

name string
description string
payload object

Responses

200 Successful Response

Schema: FirmTemplateResponse

id string required
advisory_firm_id string required
kind string required
name string required
description string
payload object required
created_by string
created_at string · date-time required
updated_at string · date-time required

401 Unauthorized - Authentication required

403 Forbidden - Insufficient permissions

404 Not Found - Resource does not exist

409 Conflict - Resource already exists

422 Validation Error - Invalid data format

Code samples

PATCH /api/v1/advisory-firms/{firm_id}/templates/{template_id}

bash

curl -X PATCH 'https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/templates/{template_id}' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string",
  "payload": {}
}'

javascript

const response = await fetch('https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/templates/{template_id}', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "name": "string",
  "description": "string",
  "payload": {}
}),
});
const data = await response.json();

python

import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {
  "name": "string",
  "description": "string",
  "payload": {}
}

response = httpx.patch("https://api.ondayzero.com/api/v1/advisory-firms/{firm_id}/templates/{template_id}", headers=headers, json=payload)
data = response.json()