Zum Hauptinhalt springen
PATCH
/
crm
/
v3
/
pipelines
/
{objectType}
/
{pipelineId}
Führen Sie eine teilweise Aktualisierung der durch pipelineId identifizierten Pipeline durch.
curl --request PATCH \
  --url https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "label": "My updated pipeline",
  "displayOrder": 0
}'
{
  "label": "My ticket pipeline",
  "displayOrder": 0,
  "createdAt": "2019-10-30T03:30:17.883Z",
  "updatedAt": "2019-12-07T16:50:06.678Z",
  "archived": false,
  "id": "812723471",
  "stages": [
    {
      "label": "In Progress",
      "displayOrder": 0,
      "metadata": {
        "ticketState": "OPEN"
      },
      "createdAt": "2019-10-30T03:30:17.883Z",
      "updatedAt": "2019-12-07T16:50:06.678Z",
      "archived": false,
      "id": "1234912"
    },
    {
      "label": "Done",
      "displayOrder": 0,
      "metadata": {
        "ticketState": "CLOSED"
      },
      "createdAt": "2019-10-30T03:30:17.883Z",
      "updatedAt": "2019-12-07T16:50:06.678Z",
      "archived": false,
      "id": "1234914"
    }
  ]
}

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 -Starter
Diese API erfordert einen der folgenden Bereiche:
crm.objects.carts.write
crm.objects.orders.write
crm.objects.users.write
crm.pipelines.orders.write
crm.schemas.appointments.write
crm.schemas.carts.write
crm.schemas.commercepayments.write
crm.schemas.companies.write
crm.schemas.contacts.write
crm.schemas.courses.write
crm.schemas.deals.write
crm.schemas.invoices.write
crm.schemas.listings.write
crm.schemas.orders.write
crm.schemas.services.write
crm.schemas.subscriptions.write
e-commerce
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
objectType
string
required

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

​
pipelineId
string
required

Die eindeutige ID für die zu aktualisierende Pipeline.

Query Parameters

​
validateDealStageUsagesBeforeDelete
boolean
default:false

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

​
validateReferencesBeforeDelete
boolean
default: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. Diese Eigenschaft sollte nur bei der Wiederherstellung einer archivierten Pipeline angegeben werden. Wenn sie bei einem anderen Aufruf angegeben wird, schlägt die Anfrage fehl, und es wird „400 Bad Request“ zurückgegeben.

​
displayOrder
integer

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

​
label
string

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

Response

successful operation

A pipeline definition.

​
archived
boolean
required

Ob die Pipeline archiviert wurde.

​
createdAt
string<date-time>
required

The date the pipeline was created. The default pipelines will have createdAt = 0.

​
displayOrder
integer
required

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

​
id
string
required

A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline.

​
label
string
required

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

​
stages
object[]
required

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

​
updatedAt
string<date-time>
required

Das Datum, an dem die Pipeline zuletzt aktualisiert wurde

​
archivedAt
string<date-time>

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