HIPE icon

HIPE

Interact with HIPE API

statuses → Create

AI-generated

Summary

Create a new status for a specified entity within the HIPE platform with customizable labels, position, completion and overdue flags, and colors.

Inputs

  • Entity (required) — Select the entity type the status applies to (e.g., Quotes, Tasks, Briefs, Projects, Companies, Orders, File, and others).
  • Position (required) — Set the numerical position of the status for ordering purposes.
  • Internal Label (required) — Define the status's internal label as a JSON object to support multiple languages (e.g., English and French).
  • External Label (required) — Set the external label visible to end users, also as a JSON object supporting multiple languages.
  • External ID — Optionally provide an external identifier for the status.
  • Is Completed (required) — Flag indicating whether this status marks a completed state.
  • Is Creation (required) — Flag indicating whether this status marks a creation state.
  • Is Overdue (required) — Flag indicating whether this status marks an overdue condition.
  • Additional Fields — Optionally specify foreground and background colors for the status display using color pickers.

Output shape

a single object representing the created status resource.

The output object includes the newly created status attributes as accepted by the HIPE system. There is no pagination or bulk creation for this operation.

Links

Discussion