Class PipelineStagePatchInput

An input used to update some properties on a pipeline definition.

Constructors

constructor

Properties

archived? displayOrder? label? metadata? attributeTypeMap discriminator mapping

Methods

getAttributeTypeMap

Constructors

constructor

Properties

Optionalarchived

archived?: boolean

Whether the pipeline is archived.

OptionaldisplayOrder

displayOrder?: number

The order for displaying this pipeline stage. If two pipeline stages have a matching displayOrder, they will be sorted alphabetically by label.

Optionallabel

label?: string

A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.

Optionalmetadata

metadata?: {
    [key: string]: string;
}

A JSON object containing properties that are not present on all object pipelines. For deals pipelines, the probability field is required ({ \"probability\": 0.5 }), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1. For tickets pipelines, the ticketState field is optional ({ \"ticketState\": \"OPEN\" }), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are OPEN or CLOSED.

Static ReadonlyattributeTypeMap

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...

Static Readonlydiscriminator

discriminator: undefined | string = undefined

Static Readonlymapping

mapping: undefined | {
    [index: string]: string;
} = undefined

Methods

StaticgetAttributeTypeMap

  • getAttributeTypeMap(): {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]

Settings

Member Visibility

On This Page

Constructors
Properties
Methods