HIPE icon

HIPE

Interact with HIPE API

statuses → Update

AI-generated

Summary

Update an existing status in the HIPE system identified by its Status ID, modifying any provided fields.

Inputs

  • Status ID (required) — The unique identifier of the status to update.
  • Additional Fields — Optional fields to update on the status, including background color, foreground color, entity type, external and internal labels, position, and boolean flags indicating if the status is completed, creation type, or overdue.

Output shape

a single updated status record

Returns the status data after applying the specified updates. The operation requires providing the Status ID; additional fields are optional but any included will be updated.

Examples

Example 1: Update the colors and labels of a status

Status ID set to the target status, with Additional Fields specifying new background and foreground colors, internal and external labels.

Links

Discussion