Sign in
latestOpenAPI 3.0.32026-08-227451,2751.8 MB

d0fc0114da66

CustomFailureReason

Rename a custom failure reason

Renames an existing custom failure reason. Requires Owner role. Cannot be used on default failure reasons.

patch/customFailureReason/{custom_failure_reason_id}

Path parameters

custom_failure_reason_idstring required

The ID of the custom failure reason to rename

Request body

display_namestring required

The new display name for the failure reason

descriptionstring

Optional short description of the failure reason

agent_guidelinesstring

Optional guidance prompt that helps result analysis decide when a failure should be assigned this reason.

Response

The renamed custom failure reason

custom_failure_reason_idstring

Unique identifier for the custom failure reason

workspace_idstring

The workspace this failure reason belongs to. Null for default failure reasons.

display_namestring

The human-readable name displayed in the failure reason picker

descriptionstring

Optional short description of the failure reason

agent_guidelinesstring

Optional guidance prompt that helps result analysis decide when a failure should be assigned this reason.

is_defaultboolean

Whether this is one of the nine built-in default failure reasons

disabledboolean

Whether this failure reason is disabled. Disabled reasons are hidden from the picker but preserve historical assignments.

created_by_idstring

The user who created this failure reason

created_timeinteger

Creation timestamp in epoch milliseconds

last_updated_by_idstring

The user who last updated this failure reason

last_updated_timeinteger

Last update timestamp in epoch milliseconds