These functions read and write information about the pipelines configured in your account. It corresponds to the Pipeline Settings page in the app.
If you want to read or edit individual items attached to contacts, use the functions for pipeline items.
This function will create a new pipeline on your account.
The name of the pipeline. This is displayed with the pipeline on your account.
The image associated with the pipeline. This is displayed with the pipeline on your account. View possible values for this parameter here.
Public
, TeamSharing
Determines whether the pipeline will be shared with all users (Public) or only certain teams of users (TeamSharing). If Permissions is set to TeamSharing, TeamIds must be defined.
If Permissions are set to TeamSharing, this is the array of Team Ids that the pipeline should be shared with. Otherwise, this field should retain its default value.
This function will edit an existing pipeline on your account.
The id of the pipeline to edit.
The name of the pipeline. This is displayed with the pipeline on your account.
The image associated with the pipeline. This is displayed with the pipeline on your account. View possible values for this parameter here.
Public
, TeamSharing
Determines whether the pipeline will be shared with all users (Public) or only certain teams of users (TeamSharing). If Permissions is set to TeamSharing, TeamIds must be defined.
If Permissions are set to TeamSharing, this is the array of Team Ids that the pipeline should be shared with. Otherwise, this field should retain its default value.
This function will delete a single pipeline on your account.
The Id of the pipeline to be deleted
This function will return the information about a single pipeline. Note: Pipeline info only includes how the pipelines are set up. This doesn't include the actual records in the pipeline. For example, this might tell you that there is a "Lead" pipeline, but it won't give you a list of all of the leads.
The Id of the pipeline to get
This function will return all of the pipelines for the account. Note: Pipeline info only includes how the pipelines are set up. This doesn't include the actual records in the pipeline. For example, this might tell you that there is a "Lead" pipeline, but it won't give you a list of all of the leads.
Whether or not to include information on pipelines that have been deleted
Whether to fetch all of the custom fields associated with each pipeline
Whether to fetch pipelines that the user does not have permission to see. For admins only