BoardGroup

A stage of your deal or project board. Deals and project cards move between stages as work progresses.

  • color
    Type: string
    required

    Hex color the stage is drawn in.

  • deal_probability
    Type: string | null
    required

    Default win probability applied to deals that reach this stage, as a decimal string percentage.

  • id
    Type: stringFormat: uuid
    required

    Unique identifier for the stage. Pass this value as board_group_id when creating or updating a deal.

  • name
    Type: string
    required

    Stage name as it appears on the board.

  • position
    Type: integer
    required

    Position of the stage on its board, ordered left to right.

  • resource_type
    Type: "Deal" or "Project"enum
    required

    Which pipeline the stage belongs to — the deal board or the project board.

  • state
    Type: "active" or "complete"enum
    required

    Whether the stage holds work in progress (active) or is a closed-out stage (complete).