Documentation

API Reference

activities

List all activities.

get

Create a new activity.

activity-types

List all activity types

get

Create an activity type

post

Retrieve an activity type

get

Update an activity type

patch

Delete an activity type

apps

Update an app setting

companies

contacts

countries

currencies

custom-fields

List all custom fields

get

Create a new custom field

post

Update a custom field

patch

Delete a custom field

delete

Retrieve a custom field

deals

exports

files

Attach an uploaded file to an entity

imports

lost-reasons

List all lost reasons

get

Create a new lost reason

post

Retrieve a lost reason

notes

phone-codes

pipelines

Create a new pipeline

products

Search text in entities

search-filters

stages

timezones

users

Retrieve current user

get

Retrieve a user

get

Updates a user and returns it

patch

Delete a user

delete

webhook-events

List all webhook events

get

webhook-requests

List all webhook requests

get

Retrieve a webhook request

get

Redeliver a webhook-request

webhooks

won-reasons

Create a new won reason

post

Retrieve a won reason

Models

AgeReportWithIncludes

ConversionPagedReportMeta

ConversionReportData

ConversionReportWithIncludes

CreatePipelineRequest

CustomFilterCondition

DealReportMetaStatuses

DealReportStatus

DealReportStatuses

DealReportWithIncludes

EmailProviderSettings

EmailReportData

EmailReportWithIncludes

FileUploadRequestFile

Follower

ForecastUnit

ForeignItemLink

ForeignItemLinkCounts

OvertimeReportDataMeta

OvertimeReportWithIncludes

ResourceIdentifierRequest

VelocityPagedReportMeta

VelocityReportAge

VelocityReportAges

VelocityReportData

VelocityReportWithIncludes

VelocityStageReportAge

activitiesListResponse

activitiesResponse

activityPositionResponse

activityResponse

activityTypeResponse

activityTypesResponse

appsResponse

bulkUpdateActivityRequestWithOptions

bulkUpdateCompanyFollowers

bulkUpdateCompanyFollowersRequest

bulkUpdateCompanyRequestWithOptions

bulkUpdateContactFollowers

bulkUpdateContactFollowersRequest

bulkUpdateContactRequestWithOptions

bulkUpdateDealFollowers

bulkUpdateDealFollowersRequest

bulkUpdateDealRequestWithOptions

bulkUpdateEmailThreadsRequest

bulkUpdateMailboxes

bulkUpdatePipelineFollowers

bulkUpdatePipelineFollowersRequest

bulkUpdateProductRequestWithOptions

bulkUpdateResponse

bulkUpdateRetryRequest

bulkUpdateUserRequestWithOptions

companiesListResponse

companiesResponse

companyFollowerRequest

companyFollowerResponse

companyFollowersResponse

companyPositionResponse

companyResponse

completeInviteRequest

connectEmailRequest

connectMessageResponse

connectToManyMessageResponse

contactFollowerRequest

contactFollowerResponse

contactFollowersResponse

contactPositionResponse

createActivityRequest

createActivityTypeRequest

createAndConnectMessageRequest

createCompanyRequest

createContactRequest

createCustomFieldRequest

createCustomFilterRequest

createLostReasonRequest

createWonReasonRequest

customFilterColumnRequest

customFilterConditionRequest

customFilterResponse

customFiltersResponse

dealFollowerRequest

dealFollowerResponse

dealFollowersResponse

deleteEmailThreadsRequest

disconnectDealForeignLinksRequest

docErrorResp

duplicateContactRequest

emailAccountResponse

emailAccountsResponse

emailConnectionRequest

emailConnectionResponse

emailConnectionsResponse

emailContactMetaResponse

emailContactResponse

emailCreateManyConnectionsRequest

emailCreateManyConnectionsResponse

emailProvidersResponse

featureAnnouncementsResponse

installationSettingsResponse

patchActivityTypeRequest

patchCompanyRequest

patchContactRequest

patchCustomFieldRequest

patchCustomFilterRequest

patchDealRequest

patchDraftRequest

patchEmailAccount

patchEmailAccountRequest

patchEmailMessageRequest

patchEmailThreadRequest

patchFileRequest

patchInstallationSettingsRequest

patchLostReason

patchLostReasonRequest

patchWonReasonRequest

phoneCodesResponse

pipelineBoardMetaResponse

pipelineBoardResponse

pipelineFollowerRequest

pipelineFollowerResponse

pipelineFollowersResponse

subscriptionURLSResponse

trashCanItemsResponse

unreadCountResponse

updateAppSettingRequest

uploadEmailFileRequest

uploadEmailFileResponse

webhookEventsResponse

webhookRequestResponse

webhookRequestsResponse

bulkUpdateCompanyFollowersRequest

object

all

boolean

Add all users from installation as followers

followers

array[object]

Followers to create or update. Will override preferences if all is set to true

following

string

Preferences for followers if all is set to true

1 validation