Okta Partners

Edit a template your app authored

PATCH https://getokta.io/api/apps/reports/templates/{id}

Edit a template your app authored (revokes approval).

  • Rate Limit: MODERATE
    How heavily this call counts against your quota: LIGHT < MODERATE < HEAVY.
  • Permission needed: reports.builder.write
    The scope the tenant must grant your app before this call is allowed.
  • Reference Code: srv_1937
    A stable identifier for this endpoint — quote it to support to speed up tracing.

Path Params

id string required

The opaque template id exactly as the listing returned it — not a number.

Body Params

name_ar string

Template name in Arabic.

name_en string

Template name in English.

description string

A description shown to whoever picks the template.

type enum

administrative | general.

orientation enum

portrait | landscape.

paper_size enum

a4 | a3 | letter.

header_enabled boolean

Show the header band.

footer_enabled boolean

Show the footer band.

header_right_content string

Right header slot — text accepting {{variables}}.

header_center_content string

Center header slot.

header_left_content string

Left header slot.

footer_right_content string

Right footer slot.

footer_center_content string

Center footer slot.

footer_left_content string

Left footer slot.

watermark_text string

Watermark text.

watermark_opacity integer

Watermark opacity (0–100).

margin_top_mm integer

Top margin in mm (0–40).

margin_right_mm integer

Right margin in mm (0–40).

margin_bottom_mm integer

Bottom margin in mm (0–40).

margin_left_mm integer

Left margin in mm (0–40).

signatures_enabled boolean

Print the signature block at the foot.

signatures_columns integer

Signature block columns (1–4).

signatures_title string

Signature block title.

signatures array

Signatories: title_ar (required), title_en, name, show_line. An empty array removes them all; omitting the key leaves them alone.

variables array

Template fields: key (required), label_ar (required), label_en, type (text|date|number|currency), required, default_value. A key shadowing a platform variable is dropped silently.