Post /crm/v3/pipelines/{object Type} Create

Create a pipeline

POST/crm/v3/pipelines/{objectType}

Use it in a workflow

Add a step and choose the HubSpot connector.
Pick the Post /crm/v3/pipelines/{object Type} Create action (under Pipelines).
Fill in the fields below, then reference the result from later steps as {{postCrmV3PipelinesObjectTypeCreate.response.data}}.

Request

Path parameters

objectTypestringrequired

Request body

Enter the body as JSON in the step's Body field.

displayOrderinteger (int32)required

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

labelstringrequired

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

pipelineIdstring

stagesarray<object>required

Pipeline stage inputs used to create the new or replacement pipeline.

displayOrderinteger (int32)required

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

labelstringrequired

A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.

metadataobjectrequired

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`.

stageIdstring

json

{
  "displayOrder": 0,
  "label": "string",
  "stages": [
    {
      "displayOrder": 1,
      "label": "Done",
      "metadata": {
        "ticketState": "CLOSED"
      }
    }
  ],
  "pipelineId": "string"
}

Response

Returns 201 with an object. Read it in later steps with {{postCrmV3PipelinesObjectTypeCreate.response.data.<field>}}.

archivedboolean

Whether the pipeline is archived.

archivedAtstring (date-time)

The date the pipeline was archived. `archivedAt` will only be present if the pipeline is archived.

createdAtstring (date-time)

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

displayOrderinteger (int32)

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

idstring

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

labelstring

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

stagesarray<object>

The stages associated with the pipeline. They can be retrieved and updated via the pipeline stages endpoints.

archivedbooleanrequired

Whether the pipeline is archived.

archivedAtstring (date-time)

The date the pipeline was archived. `archivedAt` will only be present if the pipeline is archived.

createdAtstring (date-time)required

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

displayOrderinteger (int32)required

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

idstringrequired

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

labelstringrequired

A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline.

metadataobjectrequired

updatedAtstring (date-time)required

The date the pipeline stage was last updated.

writePermissionsstring

Defines the level of write access for the pipeline stage, with possible values being CRM_PERMISSIONS_ENFORCEMENT, READ_ONLY, or INTERNAL_ONLY.

One ofCRM_PERMISSIONS_ENFORCEMENTINTERNAL_ONLYREAD_ONLY

updatedAtstring (date-time)

The date the pipeline was last updated.

json

{
  "archived": false,
  "createdAt": "2025-01-01T00:00:00Z",
  "displayOrder": 0,
  "id": "string",
  "label": "string",
  "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"
    }
  ],
  "updatedAt": "2025-01-01T00:00:00Z",
  "archivedAt": "2025-01-01T00:00:00Z"
}

Need more? See the HubSpot guide for connection setup and behaviour shared by every action.

Was this page helpful?