Skip to main content
PATCH
/
crm
/
v3
/
pipelines
/
{objectType}
/
{pipelineId}
/
stages
/
{stageId}
cURL
curl --request PATCH \
  --url https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "label": "Done",
  "displayOrder": 1,
  "metadata": {
    "ticketState": "CLOSED"
  }
}'
{
  "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"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Gratuito
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Starter
Esta API requiere uno de los siguientes ámbitos:
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
​
pipelineId
string
required
​
stageId
string
required

Body

application/json

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

​
metadata
object
required

A JSON object containing properties that are not present on all object pipelines.

For deals pipelines, the probability field is required ({ "probability": 0.5 }), and represents the likelihood a deal will close. Possible values are between 0.0 and 1.0 in increments of 0.1.

For tickets pipelines, the ticketState field is optional ({ "ticketState": "OPEN" }), and represents whether the ticket remains open or has been closed by a member of your Support team. Possible values are OPEN or CLOSED.

​
archived
boolean

Si se archiva o no el pipeline.

​
displayOrder
integer

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

​
label
string

Una etiqueta que se utiliza para organizar las etapas de pipeline en la UI de HubSpot. Cada etiqueta de etapa de pipeline debe ser única dentro de ese pipeline.

Response

successful operation

A pipeline stage definition.

​
createdAt
string<date-time>
required

La fecha en que se creó la etapa de pipeline. Las etapas de los pipelines predeterminados tendrán createdAt = 0.

​
archived
boolean
required

Whether the pipeline is archived.

​
metadata
object
required

Un objeto JSON que contiene propiedades que no están presentes en todos los pipelines de objetos.

Para los pipelines de "negocios", el campo "probabilidad" es obligatorio ("{ "probability": 0.5 }"), y representa la probabilidad de que un negocio se cierre. Los valores posibles están entre 0.0 y 1.0 en incrementos de 0.1.

Para los pipelines de "tickets", el campo "ticketState" es opcional ("{ "ticketState": "OPEN" }"), y representa si el ticket permanece abierto o si ha sido cerrado por un miembro de tu equipo de Asistencia técnica. Los valores posibles son "ABIERTO" o "CERRADO".

​
displayOrder
integer
required

El orden en que se mostrará esta etapa de pipeline. Si dos etapas de pipeline tienen un "displayOrder" coincidente, se ordenarán alfabéticamente según la etiqueta.

​
label
string
required

Una etiqueta que se utiliza para organizar las etapas de pipeline en la UI de HubSpot. Cada etiqueta de etapa de pipeline debe ser única dentro de ese pipeline.

​
id
string
required

Un identificador único generado por HubSpot que se puede utilizar para recuperar y actualizar la etapa de pipeline.

​
updatedAt
string<date-time>
required

La fecha en que se actualizó por última vez la etapa de pipeline.

​
archivedAt
string<date-time>

La fecha en que se archivó el pipeline. "archivedAt" solo estará presente si se archiva el pipeline.

​
writePermissions
enum<string>

Define el nivel de acceso de escritura para la etapa del pipeline, y los valores posibles son CRM_PERMISSIONS_ENFORCEMENT, READ_ONLY o INTERNAL_ONLY.

Available options:
CRM_PERMISSIONS_ENFORCEMENT,
READ_ONLY,
INTERNAL_ONLY