Replace a pipeline

PUT /crm/pipelines/2026-03/{objectType}/{pipelineId}

Eine Pipeline ersetzen

cURL

curl --request PUT \
  --url https://api.hubapi.com/crm/pipelines/2026-03/{objectType}/{pipelineId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayOrder": 123,
  "label": "<string>",
  "stages": [
    {
      "displayOrder": 123,
      "label": "<string>",
      "metadata": {},
      "stageId": "<string>"
    }
  ]
}
'

200

{
  "archived": true,
  "createdAt": "2023-11-07T05:31:56Z",
  "displayOrder": 123,
  "id": "<string>",
  "label": "<string>",
  "stages": [
    {
      "archived": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "displayOrder": 123,
      "id": "<string>",
      "label": "<string>",
      "metadata": {},
      "updatedAt": "2023-11-07T05:31:56Z",
      "writePermissions": "CRM_PERMISSIONS_ENFORCEMENT",
      "archivedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "updatedAt": "2023-11-07T05:31:56Z",
  "archivedAt": "2023-11-07T05:31:56Z"
}

Supported products

Required Scopes

Autorisierungen

Authorization · string · header · erforderlich

The access token received from the authorization server in the OAuth 2.0 flow.

Pfadparameter

objectType · string · erforderlich

pipelineId · string · erforderlich

Abfrageparameter

validateDealStageUsagesBeforeDelete · boolean · Standard: false

validateReferencesBeforeDelete · boolean · Standard: false

Body

application/json

displayOrder · integer<int32> · erforderlich

Die Reihenfolge, in der diese Pipeline-Phase angezeigt wird. Wenn „displayOrder“ bei zwei Pipeline-Phasen übereinstimmt, werden sie alphabetisch nach Label sortiert.

label · string · erforderlich

Ein Label zum Organisieren von Pipeline-Phasen in der HubSpot-Benutzeroberfläche. Das Label jeder Pipeline-Phase muss innerhalb dieser Pipeline eindeutig sein.

stages · object[] · erforderlich

Die der Pipeline zugeordneten Phasen. Diese können über die Pipeline-Phasen-Endpunkte abgerufen und aktualisiert werden.

Show child attributes

Antwort

200

application/json

successful operation

archived · boolean · erforderlich

Ob die Pipeline archiviert ist.

createdAt · string<date-time> · erforderlich

Das Datum, an dem die Pipeline erstellt wurde. Für Standard-Pipelines gilt: createdAt = 0.

displayOrder · integer<int32> · erforderlich

Die Reihenfolge, in der diese Pipeline angezeigt wird. Wenn „displayOrder“ bei zwei Pipelines übereinstimmt, werden sie alphabetisch nach Label sortiert.

id · string · erforderlich

Eine von HubSpot generierte eindeutige ID, die zum Abrufen und Aktualisieren der Pipeline verwendet werden kann

label · string · erforderlich

Ein eindeutiges Label zur Organisation von Pipelines in der HubSpot-UI.

stages · object[] · erforderlich

Die der Pipeline zugeordneten Phasen. Diese können über die Pipeline-Phasen-Endpunkte abgerufen und aktualisiert werden.

Show child attributes

updatedAt · string<date-time> · erforderlich

Das Datum, an dem die Pipeline zuletzt aktualisiert wurde

archivedAt · string<date-time>

Das Datum, an dem die Pipeline archiviert ist. „archivedAt“ ist nur vorhanden, wenn die Pipeline archiviert ist.