An individual pipeline item in the CRM always has a status that is associated with the pipeline the item belongs to. These functions allow you to edit the list of statuses associated with a given pipeline.

The functions on this page are rarely used, because once a pipeline has been customized, you normally don't need to mess with it. If you're trying to attach pipeline items to contacts or get a report of pipeline items in the CRM, you should use the functions for pipeline items. If you want to create an entirely new pipeline, you should use the functions for pipelines.

Create a pipeline status

This function will create a status on an existing pipeline.

How to call this function

Function name

CreatePipelineStatus

Parameters

PipelineId Uid Required

Which pipeline to add the status to.

Name Text Required

The name of the status.

IsActive Bool Default: false

Whether the status indicates an active or closed step in the pipeline.

Color Text Default: NULL

A color code for the status as a hex code (like #486581).

Expand

Response

{

"StatusId": "3952680261358078340851098040604"

}

Expand

Edit a pipeline status

This function will update the properties of an existing pipeline status. This will NOT update the status of an individual pipleline item.

How to call this function

Function name

EditPipelineStatus

Parameters

StatusId Uid Required

The status to edit.

Name Text Required

The name of the status.

IsActive Bool

Whether the status indicates an active or closed step in the pipeline.

Color Text

A color code for the status as a hex code (like #486581).

Expand

Response

This function doesn't return anything. If there's no error message returned, that means the call was completed successfully.

Expand

Delete a pipeline status

This function will delete a single pipeline status on a pipeline.

How to call this function

Function name

DeletePipelineStatus

Parameters

StatusId Uid Required

The Id of the pipeline to be deleted.

Expand

Response

This function doesn't return anything. If there's no error message returned, that means the call was completed successfully.

Expand

List all pipeline statuses

This function will return all of the pipeline statuses for a single pipeline or all pipelines on a user's account.

How to call this function

Function name

GetPipelineStatuses

Parameters

PipelineId Uid Default: NULL

If included, only fetch statuses for this pipeline.

Expand

Response

[

{

"StatusId": "3952680261358078340851096945897",

"PipelineId": "3952680261358078340851097712557",

"Name": "",

"IsActive": false,

"Color": "",

"DateCreated": "2024-04-27T00:10:10-07:00"

{...},

{...}

]

Expand