PUT
/
crm
/
v3
/
pipelines
/
{objectType}
/
{pipelineId}
Replace a 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"
    }
  ]
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubFree
Sales HubSales HubFree
Service HubService HubFree
Content HubContent HubStarter

​
Required Scopes

This API requires one of the following scopes:
  • 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 create or replace a pipeline's definition.

Response

200
application/json

successful operation

A pipeline definition.