Passer au contenu principal
PUT
/
crm
/
pipelines
/
2026-03
/
{objectType}
/
{pipelineId}
/
stages
/
{stageId}
Remplacer une étape de pipeline
curl --request PUT \
  --url https://api.hubapi.com/crm/pipelines/2026-03/{objectType}/{pipelineId}/stages/{stageId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayOrder": 123,
  "label": "<string>",
  "metadata": {}
}
'
{
  "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"
}

Supported products

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
pipelineId
string
requis
stageId
string
requis

Corps

application/json
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é.

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.

metadata
object
requis

Un objet JSON contenant des propriétés qui ne sont pas présentes sur tous les pipelines d'objets.

Pour les pipelines « transactions », le champ « probabilité »est requis (« { "probability": 0.5 } »), et représente la probabilité qu'un accord soit conclu. Les valeurs possibles sont comprises entre 0.0 et 1.0 par incréments de 0.1.

Pour les pipelines « tickets », le champ « état du ticket » est optionnel (« { "ticketState": "OPEN" } »), et représente si le ticket reste ouvert ou a été fermé par un membre de votre équipe de support. Les valeurs possibles sont « OUVERT » ou « FERMÉ ».

Réponse

successful operation

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.

metadata
object
requis

Un objet JSON contenant des propriétés qui ne sont pas présentes sur tous les pipelines d'objets.

Pour les pipelines « transactions », le champ « probabilité »est requis (« { "probability": 0.5 } »), et représente la probabilité qu'un accord soit conclu. Les valeurs possibles sont comprises entre 0.0 et 1.0 par incréments de 0.1.

Pour les pipelines « tickets », le champ « état du ticket » est optionnel (« { "ticketState": "OPEN" } »), et représente si le ticket reste ouvert ou a été fermé par un membre de votre équipe de support. Les valeurs possibles sont « OUVERT » ou « FERMÉ ».

updatedAt
string<date-time>
requis

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

writePermissions
enum<string>
requis

Définit le niveau d'accès en écriture pour l'étape du pipeline, les valeurs possibles étant CRM_PERMISSIONS_ENFORCEMENT, READ_ONLY ou INTERNAL_ONLY.

Options disponibles:
CRM_PERMISSIONS_ENFORCEMENT,
INTERNAL_ONLY,
READ_ONLY
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 April 13, 2026