Skip to main content
POST
Créer une étape

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

Le type d'objet pour lequel l'étape de pipeline est créée, tel que les transactions ou les tickets.

pipelineId
string
requis

L'identifiant unique du pipeline auquel la nouvelle étape sera ajoutée.

Corps

application/json
displayOrder
integer<int32>
requis

Un entier indiquant la position de cette étape dans le pipeline. Les nombres inférieurs indiquent les étapes antérieures.

label
string
requis

Le nom de l'étape du pipeline. Il s'agit d'une chaîne de caractères qui fournit un identifiant lisible par l'utilisateur pour l'étape.

metadata
object
requis

Un objet contenant des propriétés supplémentaires pour l'étape. Chaque propriété est une paire clé-valeur où la clé et la valeur sont des chaînes de caractères.

stageId
string

Une chaîne de caractères qui identifie de manière unique l'étape au sein du pipeline.

Réponse

successful operation

archived
boolean
requis

Un booléen indiquant si l'étape est archivée.

createdAt
string<date-time>
requis

La date et l'heure de création de l'étape, au format ISO 8601.

displayOrder
integer<int32>
requis

Un entier indiquant la position de cette étape dans le pipeline, déterminant son ordre par rapport aux autres étapes.

id
string
requis

Un identifiant de chaîne unique pour l'étape du pipeline.

label
string
requis

Le nom ou le titre de l'étape du pipeline, représenté sous forme de chaîne de caractères.

metadata
object
requis

Un objet contenant des métadonnées supplémentaires pour l'étape, avec des valeurs de chaîne pour chaque propriété.

updatedAt
string<date-time>
requis

La date et l'heure de la dernière mise à jour de l'étape, au format ISO 8601.

writePermissions
enum<string>
requis

Une chaîne indiquant les permissions d'écriture pour l'étape. Les valeurs valides incluent « CRM_PERMISSIONS_ENFORCEMENT », « READ_ONLY » et « INTERNAL_ONLY ».

Options disponibles:
CRM_PERMISSIONS_ENFORCEMENT,
INTERNAL_ONLY,
READ_ONLY
archivedAt
string<date-time>

La date et l'heure d'archivage de l'étape, au format ISO 8601.

Dernière modification le 6 octobre 2026