Pular para o conteúdo principal
POST
/
crm
/
v3
/
pipelines
/
{objectType}
Criar um pipeline
curl --request POST \
  --url https://api.hubapi.com/crm/v3/pipelines/{objectType} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayOrder": 0,
  "label": "My replaced pipeline",
  "stages": [
    {
      "displayOrder": 0,
      "label": "In Progress",
      "metadata": {
        "ticketState": "OPEN"
      }
    },
    {
      "displayOrder": 1,
      "label": "Done",
      "metadata": {
        "ticketState": "CLOSED"
      }
    }
  ]
}
'
{
  "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"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Grátis
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Grátis

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

objectType
string
obrigatório

O tipo de objeto do pipeline que está sendo criado (ex.: negócios ou tickets)

Corpo

application/json

An input used to create or replace a pipeline's definition.

displayOrder
integer<int32>
obrigatório

A ordem para exibir esta fase do pipeline. Se duas fases do pipeline tiverem um "displayOrder" correspondente, elas serão classificadas em ordem alfabética pelo rótulo de associação.

label
string
obrigatório

Um rótulo usado para organizar fases de pipeline na UI do HubSpot. Cada rótulo de fase deve ser exclusivo dentro do pipeline.

stages
object[]
obrigatório

As fases associadas ao pipeline. Podem ser recuperadas e atualizadas através dos pontos de extremidade de fases do pipeline.

pipelineId
string

Resposta

successful operation

A pipeline definition.

archived
boolean
obrigatório

Se o pipeline está arquivado ou não.

createdAt
string<date-time>
obrigatório

A data em que a fase do pipeline foi criada. As fases nos pipelines padrão terão createdAt = 0.

displayOrder
integer<int32>
obrigatório

A ordem para exibir esta fase do pipeline. Se duas fases do pipeline tiverem um "displayOrder" correspondente, elas serão classificadas em ordem alfabética pelo rótulo de associação.

id
string
obrigatório

Um identificador exclusivo gerado pelo HubSpot que pode ser usado para recuperar e atualizar a fase do pipeline.

label
string
obrigatório

Um rótulo usado para organizar fases de pipeline na UI do HubSpot. Cada rótulo de fase deve ser exclusivo dentro do pipeline.

stages
object[]
obrigatório

As fases associadas ao pipeline. Podem ser recuperadas e atualizadas através dos pontos de extremidade de fases do pipeline.

updatedAt
string<date-time>
obrigatório

A data em que a fase do pipeline foi atualizada pela última vez.

archivedAt
string<date-time>

A data em que o pipeline foi arquivado. "archivedAt" somente estará presente se o pipeline estiver arquivado.

Last modified on February 12, 2026