Passer au contenu principal
PATCH
/
crm
/
v3
/
pipelines
/
{objectType}
/
{pipelineId}
Effectuer une mise à jour partielle du pipeline identifié par pipelineId.
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"
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Gratuit
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Gratuit

Autorisations

​
Authorization
string
header
requis

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

Paramètres de chemin

​
objectType
string
requis

Le type d'objet du pipeline en cours de mise à jour (par exemple, transactions ou tickets)

​
pipelineId
string
requis

Identifiant unique du pipeline à mettre à jour.

Paramètres de requête

​
validateDealStageUsagesBeforeDelete
boolean
défaut:false

Indique s'il faut valider les utilisations des étapes de transaction avant de supprimer le pipeline.

​
validateReferencesBeforeDelete
boolean
défaut:false

Indique s'il faut valider les références avant de supprimer le pipeline.

Corps

application/json

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

​
archived
boolean

Si le pipeline est archivé.

​
displayOrder
integer<int32>

L'ordre d'affichage de cette étape de pipeline. Si deux étapes de pipeline ont un « displayOrder » correspondant, elles seront triées par ordre alphabétique par libellé.

​
label
string

Un libellé utilisé pour organiser les phases du pipeline dans l'interface de HubSpot. Chaque libellé de phase de pipeline doit être unique dans ce pipeline.

Réponse

successful operation

A pipeline definition.

​
archived
boolean
requis

Si le pipeline est archivé.

​
createdAt
string<date-time>
requis

La date de création de l'étape du pipeline. Les étapes des pipelines par défaut auront createdAt = 0.

​
displayOrder
integer<int32>
requis

L'ordre d'affichage de cette étape de pipeline. Si deux étapes de pipeline ont un « displayOrder » correspondant, elles seront triées par ordre alphabétique par libellé.

​
id
string
requis

Un identifiant unique généré par HubSpot qui peut être utilisé pour récupérer et mettre à jour l'étape du pipeline.

​
label
string
requis

Un libellé utilisé pour organiser les phases du pipeline dans l'interface de HubSpot. Chaque libellé de phase de pipeline doit être unique dans ce pipeline.

​
stages
object[]
requis

Les étapes associées au pipeline. Elles peuvent être récupérées et mises à jour via les points de terminaison des étapes du pipeline.

​
updatedAt
string<date-time>
requis

La date de la dernière mise à jour de l'étape du pipeline.

​
archivedAt
string<date-time>

La date à laquelle le pipeline a été archivé. archivedAt ne sera présent que si le pipeline est archivé.

Last modified on February 12, 2026