Skip to content
HeyX API

Create Problem Template

POST /public-api/publicapi.v1.ProblemTemplate/CreateProblemTemplate

Required scope: problem_template:create. The creator needs settings write access; operational template discovery alone does not permit authoring.

{
  "name": "Inspection follow-up",
  "description": "Follow up after an inspection",
  "severity": 2,
  "tasks": [{ "body": "Contact the customer" }]
}

name must be nonblank and at most 200 characters. Description is limited to 20,000 characters. Omitted severity defaults to 2; explicit values are 1 through 5. Up to 100 manual text tasks are supported, with nonblank bodies of at most 20,000 characters, ordered as supplied.

Returns problemTemplate, with bounded task detail. This creates a template, not a problem. It does not assign principals, block journeys, or configure/run automation. Advanced tasks, linked actions, arbitrary JSON, and editor configuration are not accepted. Duplicate active names fail.

This operation is not idempotent. Inspect resulting state before retrying after a timeout; do not blindly create a duplicate.

Generated Reference
POST /public-api/publicapi.v1.ProblemTemplate/CreateProblemTemplate

Creates a reusable template of manual text tasks. Does not create a problem, assign principals, block journeys, or run automation. Not idempotent.

Request CreateProblemTemplateRequest
Response CreateProblemTemplateResponse

CreateProblemTemplateRequest

Field Type Description
name string
description string
severity optional int32 Omission defaults to medium (2).
tasks repeated CreateProblemTaskInput

CreateProblemTemplateResponse

Field Type
problem_template ProblemTemplate

Related Types

CreateProblemTaskInput

Field Type
body string

ProblemTemplate

Field Type Description
id string
name string
description string
severity int32
requires_customer bool
task_count int32
advanced_task_count int32
tasks repeated ProblemTemplateTask Populated by detail, not list. These are inherited, not replaceable by CreateProblem.tasks. Linked execution configuration is deliberately omitted.
assignees repeated ProblemTemplateAssignee
journey_track_blocks repeated ProblemTemplateBlock
label_options repeated ProblemLabel
allow_free_solo_labels bool
details_included bool
truncated bool

ProblemTemplateTask

Field Type
id string
body string
position int32
has_linked_action bool

ProblemTemplateAssignee

Field Type
account_id string
required bool

ProblemTemplateBlock

Field Type
journey_track_id string
required bool

ProblemLabel

Field Type
id optional string
name string
color_hex string
HeyX API