Zum Hauptinhalt springen
PATCH
/
crm
/
v3
/
pipelines
/
{objectType}
/
{pipelineId}
Update a pipeline
curl --request PATCH \
  --url https://api.hubapi.com/crm/v3/pipelines/{objectType}/{pipelineId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "label": "My updated pipeline",
  "displayOrder": 0
}'
{
  "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 HubGrátis
Sales HubSales HubGrátis
Service HubService HubGrátis
Content HubContent HubStarter

​
Escopos Necessários

Esta API requer um dos seguintes escopos:
  • crm.schemas.invoices.write
  • crm.schemas.orders.write
  • crm.schemas.commercepayments.write
  • crm.objects.orders.write
  • crm.schemas.contacts.write
  • tickets
  • tickets.sensitive.v2
  • e-commerce
  • crm.schemas.appointments.write
  • crm.schemas.courses.write
  • crm.schemas.carts.write
  • tickets.highly_sensitive.v2
  • crm.schemas.services.write
  • crm.schemas.deals.write
  • crm.pipelines.orders.write
  • crm.objects.users.write
  • crm.schemas.companies.write
  • crm.schemas.subscriptions.write
  • crm.schemas.listings.write
  • crm.objects.carts.write

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

Query Parameters

​
validateReferencesBeforeDelete
boolean
default:false
​
validateDealStageUsagesBeforeDelete
boolean
default:false

Body

application/json

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

​
archived
boolean

Se o pipeline está arquivado. Esta propriedade deve ser fornecida apenas ao restaurar um pipeline arquivado. Se for fornecida em qualquer outra chamada, a solicitação falhará e um erro "400 Bad Request" será retornado.

​
displayOrder
integer

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

Example:

0

​
label
string

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

Example:

"My updated pipeline"

Response

successful operation

A pipeline definition.

​
createdAt
string<date-time>
required

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

Example:

"2019-10-30T03:30:17.883+00:00"

​
archived
boolean
required

Se o pipeline está arquivado ou não.

Example:

false

​
displayOrder
integer
required

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

Example:

0

​
stages
object[]
required

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

Example:

"[{\"id\":\"1234912\",\"label\":\"In Progress\",\"archived\":false,\"metadata\":{\"ticketState\":\"OPEN\"},\"createdAt\":\"2019-10-30T03:30:17.883Z\",\"updatedAt\":\"2019-12-07T16:50:06.678Z\",\"displayOrder\":0},{\"id\":\"1234914\",\"label\":\"Done\",\"archived\":false,\"metadata\":{\"ticketState\":\"CLOSED\"},\"createdAt\":\"2019-10-30T03:30:17.883Z\",\"updatedAt\":\"2019-12-07T16:50:06.678Z\",\"displayOrder\":0}]"

​
label
string
required

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

Example:

"My ticket pipeline"

​
id
string
required

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

Example:

"812723471"

​
updatedAt
string<date-time>
required

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

Example:

"2019-12-07T16:50:06.678+00:00"

​
archivedAt
string<date-time>

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

⌘I