Class PipelinePatchInput

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

Constructors

constructor

Properties

archived? displayOrder? label? attributeTypeMap discriminator

Methods

getAttributeTypeMap

Constructors

constructor

Properties

Optionalarchived

archived?: boolean

Whether the pipeline is archived. This property should only be provided when restoring an archived pipeline. If it's provided in any other call, the request will fail and a 400 Bad Request will be returned.

OptionaldisplayOrder

displayOrder?: number

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

Optionallabel

label?: string

A unique label used to organize pipelines in HubSpot's UI

Static ReadonlyattributeTypeMap

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

Static Readonlydiscriminator

discriminator: undefined | 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