Less Annoying CRM logo Less Annoying CRM LACRM
Settings Functions

Pipelines

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.

Create a pipeline

This function will create a new pipeline on your account.

How to call this function
Function name
CreatePipeline
Parameters
Name Text Required

The name of the pipeline. This is displayed with the pipeline on your account.

Image Text Required

The image associated with the pipeline. This is displayed with the pipeline on your account.

Permissions Enum Default: Public
Valid options: 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.

SharingTeamIds Array of Uids Default: Array

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.

Response
{
"PipelineId": "3862512804396718093878557687903"
}

Edit a pipeline

This function will edit an existing pipeline on your account.

How to call this function
Function name
EditPipeline
Parameters
PipelineId Uid Required

The id of the pipeline to edit.

Name Text

The name of the pipeline. This is displayed with the pipeline on your account.

Image Text

The image associated with the pipeline. This is displayed with the pipeline on your account.

Permissions Enum
Valid options: 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.

SharingTeamIds Array of Uids Default: Array

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.

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

Delete a pipeline

This function will delete a single pipeline on your account.

How to call this function
Function name
DeletePipeline
Parameters
PipelineId Uid Required

The Id of the pipeline to be deleted

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

Get a pipeline

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.

How to call this function
Function name
GetPipeline
Parameters
PipelineId Uid Required

The Id of the pipeline to get

Response
{
"PipelineId": "3862512804399023936887772773696",
"Name": "",
"Image": "",
"DateCreated": "2023-01-30T08:58:29-08:00",
"DateArchived": "2023-01-30T08:58:29-08:00",
"Statuses": [
{
"StatusId": "3862512804399023936887772606247",
"Name": "",
"IsActive": false
},
{...},
{...}
]
"Permissions": "",
"SharingTeamIds": [
3862512804401329779896986133136,
3862512804401329779896985343293,
3862512804401329779896986355248
]
}

Get all pipelines

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.

How to call this function
Function name
GetPipelines
Parameters
IncludeArchivedPipelines Bool Default: false

Whether or not to include information on pipelines that have been deleted

IncludeCustomFields Bool Default: false

Whether to fetch all of the custom fields associated with each pipeline

IncludeHiddenPipelines Bool Default: false

Whether to fetch pipelines that the user does not have permission to see. For admins only

Response
[
{
"PipelineId": "3862512804405941465915414229066",
"Name": "",
"Image": "",
"DateCreated": "2023-01-30T08:58:29-08:00",
"DateArchived": "2023-01-30T08:58:29-08:00",
"Statuses": [
{
"StatusId": "3862512804405941465915412760511",
"Name": "",
"IsActive": false,
"Color": ""
},
{...},
{...}
]
"Fields": [
{
"CustomFieldId": "3862512804405941465915413137002",
"Name": "",
"RecordType": "",
"IsDefaultField": false,
"DateArchived": "2023-01-30T08:58:29-08:00",
"Type": "",
"IsRequired": false,
"IsMultiField": false,
"CompanyAutoComplete": false,
"SectionId": "3862512804405941465915413457493",
"SectionDisplaySettings": [
{
"Icon": "",
"Color": "",
"IsCollapsedByDefault": false
},
{...},
{...}
]
"SortOrder": 10,
"FormColumn": 10,
"Options": [
{
"Option": "",
"OptionId": "3862512804405941465915412650459"
},
{...},
{...}
]
"UsesInternationalFormat": false,
"IsTitle": false,
"PipelineId": "3862512804405941465915412678706",
"ShowOnCalendar": false,
"DateDisplaySettings": [
{
"Display": "",
"Icon": "",
"Label": ""
},
{...},
{...}
]
"AnnualDate": false,
"IsSingleLink": false,
"CurrencyDisplaySettings": [
{
"CurrencyType": "",
"CurrencySymbol": "",
"NumberOfDecimalPlaces": 10,
"SymbolPlacement": ""
},
{...},
{...}
]
"MultiFieldType": [
{
"Value": "",
"TypeId": "3862512804408247308924628040730"
},
{...},
{...}
]
},
{...},
{...}
]
"IsHidden": false,
"Permissions": "",
"SharingTeamIds": [
3862512804408247308924627327822,
3862512804408247308924627760050,
3862512804408247308924627232483
]
},
{...},
{...}
]
Next page: Teams