Deal

An opportunity in your sales pipeline, sitting in one stage of the deal board.

  • archived_at
    Type: string | nullFormat: date-time
    required

    When the deal was archived, or null while it is active.

  • assignee_member_id
    Type: integer | null
    required

    Team member id of the deal owner, or null when the deal is unassigned.

  • assignee_member_name
    Type: string | null
    required

    Name of the deal owner, or null when the deal is unassigned.

  • board_group_id
    Type: string | nullFormat: uuid
    required

    Id of the pipeline stage the deal sits in, or null when it is not on a board.

  • close_date
    Type: string | nullFormat: date
    required

    Date the deal is expected to close, or null when unset.

  • company_name
    Type: string | null
    required

    Name of the client the deal is with, or null.

  • contact_ids
    Type: array of integer
    required

    Ids of the contacts attached to the deal.

  • currency
    Type: string
    required

    Three-letter ISO 4217 currency code for deal_value.

  • deal_number
    Type: string
    required

    Human-readable deal reference, unique within your account and assigned on creation.

  • deal_value
    Type: string | null
    required

    What the deal is worth, as a decimal string in currency. null when no value has been set.

  • id
    Type: integer
    required

    Unique identifier for the deal.

  • probability
    Type: integer | null
    required

    Chance of winning the deal, as a whole percentage from 0 to 100. null when unset.

  • status
    Type: string
    required

    Name of the pipeline stage the deal sits in — the label form of board_group_id. Stages are configurable per account, so this is free text rather than a fixed set of values, and it is an empty string when the deal is not on a board.

  • title
    Type: string
    required

    Deal title.

  • url
    Type: string
    required

    Absolute link to the deal in the Bonsai app. Opens the pipeline with the deal expanded.