> ## Documentation Index
> Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

---
id: c84de414-69f9-4612-9ef1-fd5d11f55916
---

# Replace a pipeline

export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => {
  if (!scopes || scopes.length === 0) {
    return null;
  }
  const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
  return <div>
      <div className="text-sm mb-2">{description}</div>
      <div>
        {sortedScopes.map((scope, index) => <div key={index}>
            <code>
              <span className="text-xs">{scope}</span>
            </code>
          </div>)}
      </div>
    </div>;
};

export const SupportedProducts = ({marketing, sales, service, cms, data, commerce, marketingLevel, salesLevel, serviceLevel, cmsLevel, dataLevel, commerceLevel}) => {
  const translations = {
    description: "Requires one of the following products or higher.",
    productNames: {
      marketing: "Marketing Hub",
      sales: "Sales Hub",
      service: "Service Hub",
      cms: "Content Hub",
      data: "Data Hub",
      commerce: "Revenue Hub"
    },
    tiers: {
      free: "Free",
      starter: "Starter",
      professional: "Professional",
      enterprise: "Enterprise"
    }
  };
  const translateTier = tier => {
    if (!tier) return '';
    const lowerTier = tier.toLowerCase();
    return translations.tiers[lowerTier] || tier;
  };
  const products = [{
    name: marketing ? translations.productNames.marketing : '',
    level: translateTier(marketingLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/marketing-bolt.svg",
    alt: "Marketing Hub"
  }, {
    name: sales ? translations.productNames.sales : '',
    level: translateTier(salesLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/sales-star.svg",
    alt: "Sales Hub"
  }, {
    name: service ? translations.productNames.service : '',
    level: translateTier(serviceLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/service-heart.svg",
    alt: "Service Hub"
  }, {
    name: cms ? translations.productNames.cms : '',
    level: translateTier(cmsLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/content-play.svg",
    alt: "Content Hub"
  }, {
    name: data ? translations.productNames.data : '',
    level: translateTier(dataLevel),
    icon: "https://developers.hubspot.com/hubfs/Knowledge_Base_2023-24-25/subscription_key_icons/operations_icon.svg",
    alt: "Data Hub"
  }, {
    name: commerce ? translations.productNames.commerce : '',
    level: translateTier(commerceLevel),
    icon: "https://developers.hubspot.com/hubfs/Knowledge_Base/subscription_key_icons/commerce_icon.svg",
    alt: "Revenue Hub"
  }].filter(product => product.name && product.level);
  if (products.length === 0) return null;
  return <div>
      <div className="text-sm mb-2">{translations.description}</div>
      <div className={`grid ${products.length === 1 ? 'grid-cols-1' : 'grid-cols-2'} gap-1.5`}>
        {products.map((product, index) => <div key={index} style={{
    display: 'flex',
    alignItems: 'center'
  }}>
            <img src={product.icon} alt={product.alt} className="w-3.5 h-3.5 mr-1.5 mt-2.5 mb-2.5 flex-shrink-0 align-middle" />
            <span className="font-medium mr-1 text-sm">{product.name} -</span>
            <span className="text-sm">{product.level}</span>
          </div>)}
      </div>
    </div>;
};

<AccordionGroup>
  <Accordion title="Supported products" defaultOpen="true" icon="cubes">
    <SupportedProducts marketing={true} sales={true} service={true} cms={true} marketingLevel="FREE" salesLevel="FREE" serviceLevel="FREE" cmsLevel="FREE" />
  </Accordion>

  <Accordion title="Required Scopes" icon="key">
    <ScopesList
      scopes={[
  'crm.schemas.quotes.write',
  'crm.schemas.deals.write',
  'crm.objects.users.write',
  'crm.schemas.custom.write',
  'crm.schemas.subscriptions.write',
  'crm.objects.carts.write',
  'crm.schemas.invoices.write',
  'crm.schemas.orders.write',
  'crm.schemas.commercepayments.write',
  'crm.objects.orders.write',
  'crm.schemas.contacts.write',
  'tickets',
  'tickets.sensitive.v2',
  'e-commerce',
  'crm.schemas.appointments.write',
  'crm.schemas.courses.write',
  'crm.schemas.carts.write',
  'tickets.highly_sensitive.v2',
  'crm.schemas.services.write',
  'crm.pipelines.orders.write',
  'crm.schemas.companies.write',
  'crm.schemas.listings.write',
  'crm.schemas.projects.write'
]}
    />
  </Accordion>
</AccordionGroup>


## OpenAPI

````yaml specs/legacy/v3/crm-pipelines-v3.json PUT /crm/v3/pipelines/{objectType}/{pipelineId}
openapi: 3.0.1
info:
  title: Pipelines
  description: >-
    Pipelines represent distinct stages in a workflow, like closing a deal or
    servicing a support ticket. These endpoints provide access to read and
    modify pipelines in HubSpot. Pipelines support `deals` and `tickets` object
    types.


    ## Pipeline ID validation


    When calling endpoints that take pipelineId as a parameter, that ID must
    correspond to an existing, un-archived pipeline. Otherwise the request will
    fail with a `404 Not Found` response.
  version: v3
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-api-use-case: >-
    To streamline customer support processes, use this API to retrieve your
    existing ticket pipelines and add new stages based on your business needs.
    Support reps can then assign tickets to those pipeline stages to track
    progress on customer issues.
  x-hubspot-related-documentation:
    - name: Pipelines Guide
      url: https://developers.hubspot.com/docs/guides/api/crm/pipelines
  x-hubspot-introduction: >-
    Use the pipelines API to create and manage deal and ticket pipelines.
    Pipelines enable you to track the status or progress of deals and tickets,
    such as closing deals and opening support tickets.
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
paths:
  /crm/v3/pipelines/{objectType}/{pipelineId}:
    put:
      tags:
        - Basic
      summary: Replace a pipeline
      operationId: put-/crm/v3/pipelines/{objectType}/{pipelineId}_replace
      parameters:
        - name: objectType
          in: path
          description: ''
          required: true
          style: simple
          explode: false
          schema:
            type: string
        - name: pipelineId
          in: path
          description: ''
          required: true
          style: simple
          explode: false
          schema:
            type: string
        - name: validateDealStageUsagesBeforeDelete
          in: query
          description: ''
          required: false
          style: form
          explode: true
          schema:
            type: boolean
            default: false
        - name: validateReferencesBeforeDelete
          in: query
          description: ''
          required: false
          style: form
          explode: true
          schema:
            type: boolean
            default: false
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PipelineReplaceInput'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pipeline'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - crm.schemas.quotes.write
        - oauth2:
            - tickets
        - oauth2:
            - crm.schemas.subscriptions.write
        - oauth2:
            - crm.schemas.custom.write
        - oauth2:
            - crm.schemas.listings.write
        - oauth2:
            - crm.schemas.invoices.write
        - oauth2:
            - crm.schemas.orders.write
        - oauth2:
            - crm.pipelines.orders.write
        - oauth2:
            - crm.schemas.commercepayments.write
        - oauth2:
            - crm.objects.users.write
        - oauth2:
            - tickets.highly_sensitive.v2
        - oauth2:
            - crm.schemas.services.write
        - oauth2:
            - crm.objects.orders.write
        - oauth2:
            - crm.schemas.courses.write
        - oauth2:
            - crm.schemas.projects.write
        - oauth2:
            - crm.schemas.deals.write
        - oauth2:
            - tickets.sensitive.v2
        - oauth2:
            - e-commerce
        - oauth2:
            - crm.objects.carts.write
        - oauth2:
            - crm.schemas.appointments.write
        - oauth2:
            - crm.schemas.contacts.write
        - oauth2:
            - crm.schemas.carts.write
        - oauth2:
            - crm.schemas.companies.write
components:
  schemas:
    PipelineReplaceInput:
      required:
        - displayOrder
        - label
        - stages
      type: object
      properties:
        displayOrder:
          type: integer
          description: >-
            The order for displaying this pipeline stage. If two pipeline stages
            have a matching `displayOrder`, they will be sorted alphabetically
            by label.
          format: int32
        label:
          type: string
          description: >-
            A label used to organize pipeline stages in HubSpot's UI. Each
            pipeline stage's label must be unique within that pipeline.
        stages:
          type: array
          description: >-
            The stages associated with the pipeline. They can be retrieved and
            updated via the pipeline stages endpoints.
          items:
            $ref: '#/components/schemas/PipelineStageInput'
    Pipeline:
      required:
        - archived
        - createdAt
        - displayOrder
        - id
        - label
        - stages
        - updatedAt
      type: object
      properties:
        archived:
          type: boolean
          description: Whether the pipeline is archived.
        archivedAt:
          type: string
          description: >-
            The date the pipeline was archived. `archivedAt` will only be
            present if the pipeline is archived.
          format: date-time
        createdAt:
          type: string
          description: >-
            The date the pipeline was created. The default pipelines will have
            createdAt = 0.
          format: date-time
        displayOrder:
          type: integer
          description: >-
            The order for displaying this pipeline. If two pipelines have a
            matching `displayOrder`, they will be sorted alphabetically by
            label.
          format: int32
        id:
          type: string
          description: >-
            A unique identifier generated by HubSpot that can be used to
            retrieve and update the pipeline.
        label:
          type: string
          description: A unique label used to organize pipelines in HubSpot's UI
        stages:
          type: array
          description: >-
            The stages associated with the pipeline. They can be retrieved and
            updated via the pipeline stages endpoints.
          items:
            $ref: '#/components/schemas/PipelineStage'
        updatedAt:
          type: string
          description: The date the pipeline was last updated.
          format: date-time
      description: A pipeline definition.
      example:
        archived: false
        createdAt: '2019-10-30T03:30:17.883Z'
        displayOrder: 0
        id: '812723471'
        label: My ticket pipeline
        stages:
          - archived: false
            createdAt: '2019-10-30T03:30:17.883Z'
            displayOrder: 0
            id: '1234912'
            label: In Progress
            metadata:
              ticketState: OPEN
            updatedAt: '2019-12-07T16:50:06.678Z'
          - archived: false
            createdAt: '2019-10-30T03:30:17.883Z'
            displayOrder: 0
            id: '1234914'
            label: Done
            metadata:
              ticketState: CLOSED
            updatedAt: '2019-12-07T16:50:06.678Z'
        updatedAt: '2019-12-07T16:50:06.678Z'
    PipelineStageInput:
      required:
        - displayOrder
        - label
        - metadata
      type: object
      properties:
        displayOrder:
          type: integer
          description: >-
            The order for displaying this pipeline stage. If two pipeline stages
            have a matching `displayOrder`, they will be sorted alphabetically
            by label.
          format: int32
        label:
          type: string
          description: >-
            A label used to organize pipeline stages in HubSpot's UI. Each
            pipeline stage's label must be unique within that pipeline.
        metadata:
          type: object
          additionalProperties:
            type: string
          description: >-
            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`.
        stageId:
          type: string
      description: An input used to create or replace a pipeline stage's definition.
      example:
        displayOrder: 1
        label: Done
        metadata:
          ticketState: CLOSED
    PipelineStage:
      required:
        - archived
        - createdAt
        - displayOrder
        - id
        - label
        - metadata
        - updatedAt
      type: object
      properties:
        archived:
          type: boolean
          description: Whether the pipeline is archived.
        archivedAt:
          type: string
          description: >-
            The date the pipeline was archived. `archivedAt` will only be
            present if the pipeline is archived.
          format: date-time
        createdAt:
          type: string
          description: >-
            The date the pipeline stage was created. The stages on default
            pipelines will have createdAt = 0.
          format: date-time
        displayOrder:
          type: integer
          description: >-
            The order for displaying this pipeline stage. If two pipeline stages
            have a matching `displayOrder`, they will be sorted alphabetically
            by label.
          format: int32
        id:
          type: string
          description: >-
            A unique identifier generated by HubSpot that can be used to
            retrieve and update the pipeline stage.
        label:
          type: string
          description: >-
            A label used to organize pipeline stages in HubSpot's UI. Each
            pipeline stage's label must be unique within that pipeline.
        metadata:
          type: object
          additionalProperties:
            type: string
          description: >-
            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`.
        updatedAt:
          type: string
          description: The date the pipeline stage was last updated.
          format: date-time
        writePermissions:
          type: string
          description: >-
            Defines the level of write access for the pipeline stage, with
            possible values being CRM_PERMISSIONS_ENFORCEMENT, READ_ONLY, or
            INTERNAL_ONLY.
          enum:
            - CRM_PERMISSIONS_ENFORCEMENT
            - INTERNAL_ONLY
            - READ_ONLY
      description: A pipeline stage definition.
      example:
        archived: false
        createdAt: '2019-10-30T03:30:17.883Z'
        displayOrder: 0
        id: '1234912'
        label: In Progress
        metadata:
          ticketState: OPEN
        updatedAt: '2019-12-07T16:50:06.678Z'
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: The error category
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            A unique identifier for the request. Include this value with any
            error reports or support tickets
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: further information about the error
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            A map of link names to associated URIs containing documentation
            about the error or recommended remediation steps
        message:
          type: string
          description: >-
            A human readable message describing the error along with remediation
            steps where appropriate
          example: An error occurred
        subCategory:
          type: string
          description: >-
            A specific category that contains more specific detail about the
            error
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: The status code associated with the error detail
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: The name of the field or parameter in which the error was found.
        message:
          type: string
          description: >-
            A human readable message describing the error along with remediation
            steps where appropriate
        subCategory:
          type: string
          description: >-
            A specific category that contains more specific detail about the
            error
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            automation: ''
            cpq.quotes.read: ''
            cpq.quotes.write: ''
            crm.objects.appointments.read: ''
            crm.objects.appointments.sensitive.read.v2: ''
            crm.objects.appointments.sensitive.write.v2: ''
            crm.objects.appointments.write: ''
            crm.objects.calls.read: ''
            crm.objects.carts.read: ''
            crm.objects.carts.write: ''
            crm.objects.commercepayments.write: ''
            crm.objects.companies.highly_sensitive.read.v2: ''
            crm.objects.companies.highly_sensitive.write.v2: ''
            crm.objects.companies.read: ''
            crm.objects.companies.sensitive.read.v2: ''
            crm.objects.companies.sensitive.write.v2: ''
            crm.objects.companies.write: ''
            crm.objects.contacts.highly_sensitive.read.v2: ''
            crm.objects.contacts.highly_sensitive.write.v2: ''
            crm.objects.contacts.read: ''
            crm.objects.contacts.sensitive.read.v2: ''
            crm.objects.contacts.sensitive.write.v2: ''
            crm.objects.contacts.write: ''
            crm.objects.courses.read: ''
            crm.objects.courses.write: ''
            crm.objects.custom.highly_sensitive.read.v2: ''
            crm.objects.custom.highly_sensitive.write.v2: ''
            crm.objects.custom.read: ''
            crm.objects.custom.sensitive.read.v2: ''
            crm.objects.custom.sensitive.write.v2: ''
            crm.objects.custom.write: ''
            crm.objects.deals.highly_sensitive.read.v2: ''
            crm.objects.deals.highly_sensitive.write.v2: ''
            crm.objects.deals.read: ''
            crm.objects.deals.sensitive.read.v2: ''
            crm.objects.deals.sensitive.write.v2: ''
            crm.objects.deals.write: ''
            crm.objects.emails.read: ''
            crm.objects.feedback_submissions.read: ''
            crm.objects.goals.read: ''
            crm.objects.goals.write: ''
            crm.objects.invoices.read: ''
            crm.objects.invoices.write: ''
            crm.objects.leads.read: ''
            crm.objects.leads.write: ''
            crm.objects.line_items.read: ''
            crm.objects.line_items.write: ''
            crm.objects.listings.read: ''
            crm.objects.listings.write: ''
            crm.objects.marketing_events.read: ''
            crm.objects.marketing_events.write: ''
            crm.objects.meetings.read: ''
            crm.objects.notes.read: ''
            crm.objects.orders.read: ''
            crm.objects.orders.write: ''
            crm.objects.owners.read: ''
            crm.objects.products.write: ''
            crm.objects.projects.highly_sensitive.read: ''
            crm.objects.projects.highly_sensitive.write: ''
            crm.objects.projects.read: ''
            crm.objects.projects.sensitive.read: ''
            crm.objects.projects.sensitive.write: ''
            crm.objects.projects.write: ''
            crm.objects.quotes.read: ''
            crm.objects.quotes.write: ''
            crm.objects.services.read: ''
            crm.objects.services.write: ''
            crm.objects.subscriptions.read: ''
            crm.objects.subscriptions.write: ''
            crm.objects.tasks.read: ''
            crm.objects.users.read: ''
            crm.objects.users.write: ''
            crm.pipelines.orders.read: ''
            crm.pipelines.orders.write: ''
            crm.schemas.appointments.read: ''
            crm.schemas.appointments.write: ''
            crm.schemas.calls.read: ''
            crm.schemas.carts.read: ''
            crm.schemas.carts.write: ''
            crm.schemas.commercepayments.read: ''
            crm.schemas.commercepayments.write: ''
            crm.schemas.companies.read: ''
            crm.schemas.companies.write: ''
            crm.schemas.contacts.read: ''
            crm.schemas.contacts.write: ''
            crm.schemas.courses.read: ''
            crm.schemas.courses.write: ''
            crm.schemas.custom.read: ''
            crm.schemas.custom.write: ''
            crm.schemas.deals.read: ''
            crm.schemas.deals.write: ''
            crm.schemas.emails.read: ''
            crm.schemas.invoices.read: ''
            crm.schemas.invoices.write: ''
            crm.schemas.line_items.read: ''
            crm.schemas.listings.read: ''
            crm.schemas.listings.write: ''
            crm.schemas.meetings.read: ''
            crm.schemas.notes.read: ''
            crm.schemas.orders.read: ''
            crm.schemas.orders.write: ''
            crm.schemas.projects.read: ''
            crm.schemas.projects.write: ''
            crm.schemas.quotes.read: ''
            crm.schemas.quotes.write: ''
            crm.schemas.services.read: ''
            crm.schemas.services.write: ''
            crm.schemas.subscriptions.read: ''
            crm.schemas.subscriptions.write: ''
            crm.schemas.tasks.read: ''
            e-commerce: ''
            media_bridge.read: ''
            tickets: ''
            tickets.highly_sensitive.v2: ''
            tickets.sensitive.v2: ''
            timeline: ''

````