Zum Hauptinhalt springen
PUT
/
crm
/
v3
/
pipelines
/
{objectType}
/
{pipelineId}
Substituir um pipeline
curl --request PUT \
  --url https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "label": "My replaced pipeline",
  "displayOrder": 0,
  "stages": [
    {
      "label": "In Progress",
      "displayOrder": 0,
      "metadata": {
        "ticketState": "OPEN"
      }
    },
    {
      "label": "Done",
      "displayOrder": 1,
      "metadata": {
        "ticketState": "CLOSED"
      }
    }
  ]
}'
{
  "label": "My ticket pipeline",
  "displayOrder": 0,
  "createdAt": "2019-10-30T03:30:17.883Z",
  "updatedAt": "2019-12-07T16:50:06.678Z",
  "archived": false,
  "id": "812723471",
  "stages": [
    {
      "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"
    },
    {
      "label": "Done",
      "displayOrder": 0,
      "metadata": {
        "ticketState": "CLOSED"
      },
      "createdAt": "2019-10-30T03:30:17.883Z",
      "updatedAt": "2019-12-07T16:50:06.678Z",
      "archived": false,
      "id": "1234914"
    }
  ]
}

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 -Starter
Esta API requer um dos seguintes escopos:
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

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

pipelineId
string
required

O identificador exclusivo do pipeline a ser substituído.

Query Parameters

validateDealStageUsagesBeforeDelete
boolean
default:false

Indica se é necessário validar o uso das fases de negócio antes de excluir o pipeline.

validateReferencesBeforeDelete
boolean
default:false

Indica se é necessário validar as referências antes de excluir o pipeline.

Body

application/json

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

displayOrder
integer
required

A ordem para exibir este pipeline. Se dois pipelines tiverem um "displayOrder" correspondente, eles serão classificados em ordem alfabética pelo rótulo de associação.

label
string
required

Um rótulo de associação exclusivo usado para organizar pipelines na UI do HubSpot.

stages
object[]
required

Entradas de fase do pipeline usadas para criar o pipeline novo ou de substituição.

Response

successful operation

A pipeline definition.

archived
boolean
required

Se o pipeline está arquivado ou não.

createdAt
string<date-time>
required

The date the pipeline was created. The default pipelines will have createdAt = 0.

displayOrder
integer
required

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

id
string
required

A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline.

label
string
required

A unique label used to organize pipelines in HubSpot's UI

stages
object[]
required

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

updatedAt
string<date-time>
required

A data em que o pipeline foi atualizado pela última vez.

archivedAt
string<date-time>

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