Zum Hauptinhalt springen
PATCH
/
crm
/
v3
/
pipelines
/
{objectType}
/
{pipelineId}
cURL
curl --request PATCH \
  --url https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayOrder": 0,
  "label": "My updated pipeline"
}
'
{
  "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"
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Kostenlos
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Kostenlos

Autorisierungen

​
Authorization
string
header
erforderlich

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

Pfadparameter

​
objectType
string
erforderlich

Der Objekttyp der Pipeline, die aktualisiert wird (z. B. Deals oder Tickets)

​
pipelineId
string
erforderlich

Die eindeutige ID für die zu aktualisierende Pipeline.

Abfrageparameter

​
validateDealStageUsagesBeforeDelete
boolean
Standard:false

Gibt an, ob Dealphasennutzungen vor dem Löschen der Pipeline validiert werden soll.

​
validateReferencesBeforeDelete
boolean
Standard:false

Gibt an, ob Referenzen vor dem Löschen der Pipeline validiert werden sollen.

Body

application/json

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

​
archived
boolean

Ob die Pipeline archiviert ist.

​
displayOrder
integer<int32>

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

​
label
string

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

Antwort

successful operation

A pipeline definition.

​
archived
boolean
erforderlich

Ob die Pipeline archiviert ist.

​
createdAt
string<date-time>
erforderlich

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

​
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.

​
id
string
erforderlich

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

​
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.

​
updatedAt
string<date-time>
erforderlich

Das Datum, an dem die Pipeline-Phase zuletzt aktualisiert wurde

​
archivedAt
string<date-time>

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

Last modified on March 24, 2026